目录

HdrVividRender

Class Info

public class HdrVividRender implements SurfaceTexture.OnFrameAvailableListener

渲染实例。

Nested Class Summary

Qualifier and Type

Class Name and Description

public final static class

HdrVividRender.BufferInfo

描述存储视频图像数据缓冲的相关信息。

public interface

HdrVividRender.InputCallback

渲染实例数据来源于一个Surface时的回调方法,用于异步通知App获取纹理图像的相关信息。

public interface

HdrVividRender.LogCallBack

输出日志的回调方法,用于通知用户日志信息。

public interface

HdrVividRender.OutputCallback

渲染实例工作在转码模式时的回调方法,用于异步通知用户渲染事件。

public final static class

HdrVividRender.StaticMetaData

静态元数据。

Public Field Summary

Qualifier and Type

Field and Description

public static final int

BUFFER_FLAG_END_OF_STREAM

表示流结束,即在此之后没有可用的缓冲区。

public static final int

COLORFORMAT_R8G8B8A8

RGBA格式,每个向量用8比特存储。

public static final int

COLORFORMAT_NV12

NV12格式,每个向量用8比特存储。

public static final int

COLORFORMAT_YUV420_888

YUV420格式,每个向量用8比特存储。

public static final int

COLORFORMAT_YUV420P10

YUV420格式,每个向量10比特存储。

public static final int

COLORSPACE_BT709

BT.709,也称作sRGB。

public static final int

COLORSPACE_BT2020

BT.2020。

public static final int

COLORSPACE_P3

Display P3。

public static final int

HDRVIVID_ERROR_BUFFER_IN_USE

渲染实例工作在缓冲输入或输出时,缓冲区正被App占用。

public static final int

HDRVIVID_ERROR_ILLEGAL_ARGUMENT

函数参数是无效的。

public static final int

HDRVIVID_ERROR_ILLEGAL_STATE

当前函数不在规定的状态下调用。

public static final int

HDRVIVID_ERROR_NULL_OBJECT

指针类型的函数参数的值为空。

public static final int

HDRVIVID_ERROR_UNKNOWN

内部出现未明确定义类型的错误。

public static final int

HDRVIVID_ERROR_UNSUPPORTED

参数或能力不支持。

public static final int

HDRVIVID_SUCCESS

方法调用成功。

public static final int

TRANSFUNC_PQ

PQ电光转换函数。

public static final int

TRANSFUNC_HLG

HLG电光转换函数。

public static final int

HDRVIVID_LOG_DEBUG

日志诊断级别。

public static final int

HDRVIVID_LOG_INFO

日志信息级别。

public static final int

HDRVIVID_LOG_WARN

日志告警级别。

public static final int

HDRVIVID_LOG_ERROR

日志错误级别。

Public Constructor Summary

Constructor Name

HdrVividRender()

渲染实例构造方法。

Public Method Summary

Qualifier and Type

Method Name and Description

public int

configure(Surface inputSurface, HdrVividRender.InputCallback inputCallback, Surface outputSurface, HdrVividRender.OutputCallback outputCallback)

配置渲染实例的工作模式,渲染实例的生命周期内仅需要配置一次,在调用start前必须调用此函数完成相关配置。

public Surface

createInputSurface()

创建输入渲染实例。

public static String

getVersion()

获取版本信息,格式如"1.0.12.300"。

public boolean

init()

初始化渲染实例。

public native ByteBuffer

read(HdrVividRender.BufferInfo bufferInfo, int timeoutMs)

渲染实例工作在转码模式时,App通过此方法读取处理后的视频图像数据。

public native int

setBrightness(int brightness)

设置渲染实例的输出视频图像数据的白点的最大峰值亮度。

注意:

已废弃,可以使用HdrAbility类中setBrightness方法替代。

public native int

setColorFormat(int colorFormat)

渲染实例工作在转码模式时,设置输出视频图像数据的颜色格式。

public native int

setColorSpace(int colorSpace)

渲染实例工作在转码模式时,设置输出视频图像数据的颜色空间。

public native int

setDynamicMetaData(long ptsUs, ByteBuffer metaData)

设置渲染实例的输入视频图像的动态元数据。

public native int

setInputVideoSize(int width, int height)

设置当前输入视频图像的宽高尺寸。

public native int

setOutputSurface(Surface surface)

渲染实例工作在渲染模式时,设置输出Surface。

public native int

setOutputSurfaceSize(int width, int height)

渲染实例工作在渲染模式时,设置输出视频源的宽高。

public native void

setScreenHdr(boolean isScreenHdr)

设置屏幕是否支持HDR。

注意:

已废弃,可以使用HdrAbility类中init方法来替代。

public native int

setStaticMetaData(HdrVividRender.StaticMetaData metaData)

设置渲染实例的输入视频图像的静态元数据,从视频源中获取。

public native int

setTransFunc(int transFunc)

设置渲染实例的输入视频图像数据的电光转换函数。

public native int

start()

在配置好渲染实例后,调用该方法,渲染实例开启工作。

public native int

stop()

停止渲染实例当前工作,渲染实例保持活动状态并且可以通过start再次开启工作。

public native int

write(ByteBuffer yuvData, HdrVividRender.BufferInfo bufferInfo, ByteBuffer dynamicMetaData)

App调用此函数向渲染实例写入视频图像数据。

public void

release()

释放指定的渲染实例。

public void

setLogCallBack(HdrVividRender.LogCallBack logCallback)

设置日志回调处理函数。

Public Fields

[h2]BUFFER_FLAG_END_OF_STREAM

Fields

public static final int BUFFER_FLAG_END_OF_STREAM

表示流结束,即在此之后没有可用的缓冲区。

另请参阅:Constant-values

[h2]COLORFORMAT_R8G8B8A8

Fields

public static final int COLORFORMAT_R8G8B8A8

RGBA格式,每个向量用8比特存储。

另请参阅:Constant-values

[h2]COLORFORMAT_NV12

Fields

public static final int COLORFORMAT_NV12

NV12格式,每个向量用8比特存储。

另请参阅:Constant-values

[h2]COLORFORMAT_YUV420_888

Fields

public static final int COLORFORMAT_YUV420_888

YUV420格式,每个向量用8比特存储。

另请参阅:Constant-values

[h2]COLORFORMAT_YUV420P10

Fields

public static final int COLORFORMAT_YUV420P10

YUV420格式,每个向量10比特存储。

另请参阅:Constant-values

[h2]COLORSPACE_BT709

Fields

public static final int COLORSPACE_BT709

BT.709,也称作sRGB。

另请参阅:Constant-values

[h2]COLORSPACE_BT2020

Fields

public static final int COLORSPACE_BT2020

BT.2020。

另请参阅:Constant-values

[h2]COLORSPACE_P3

Fields

public static final int COLORSPACE_P3

Display P3。

另请参阅:Constant-values

[h2]HDRVIVID_ERROR_BUFFER_IN_USE

Fields

public static final int HDRVIVID_ERROR_BUFFER_IN_USE

渲染实例工作在缓冲输入或输出时,缓冲区正被App占用。

另请参阅:Constant-values

[h2]HDRVIVID_ERROR_ILLEGAL_ARGUMENT

Fields

public static final int HDRVIVID_ERROR_ILLEGAL_ARGUMENT

函数参数是无效的。

另请参阅:Constant-values

[h2]HDRVIVID_ERROR_ILLEGAL_STATE

Fields

public static final int HDRVIVID_ERROR_ILLEGAL_STATE

当前函数不在规定的状态下调用。

另请参阅:Constant-values

[h2]HDRVIVID_ERROR_NULL_OBJECT

Fields

public static final int HDRVIVID_ERROR_NULL_OBJECT

指针类型的函数参数的值为空。

另请参阅:Constant-values

[h2]HDRVIVID_ERROR_UNKNOWN

Fields

public static final int HDRVIVID_ERROR_UNKNOWN

内部出现未明确定义类型的错误。

另请参阅:Constant-values

[h2]HDRVIVID_ERROR_UNSUPPORTED

Fields

public static final int HDRVIVID_ERROR_UNSUPPORTED

参数或能力不支持。

另请参阅:Constant-values

[h2]HDRVIVID_SUCCESS

Fields

public static final int HDRVIVID_SUCCESS

方法调用成功。

另请参阅:Constant-values

[h2]TRANSFUNC_PQ

Fields

public static final int TRANSFUNC_PQ

PQ电光转换函数。

另请参阅:Constant-values

[h2]TRANSFUNC_HLG

Fields

public static final int TRANSFUNC_HLG

HLG电光转换函数。

另请参阅:Constant-values

[h2]HDRVIVID_LOG_DEBUG

Fields

public static final int HDRVIVID_LOG_DEBUG

日志诊断级别。

另请参阅:Constant-values

[h2]HDRVIVID_LOG_INFO

Fields

public static final int HDRVIVID_LOG_INFO

日志信息级别。

另请参阅:Constant-values

[h2]HDRVIVID_LOG_WARN

Fields

public static final int HDRVIVID_LOG_WARN

日志告警级别。

另请参阅:Constant-values

[h2]HDRVIVID_LOG_ERROR

Fields

public static final int HDRVIVID_LOG_ERROR

日志错误级别。

另请参阅:Constant-values

Public Constructors

[h2]HdrVividRender

Constructor

public HdrVividRender()

渲染实例构造方法。

Public Methods

[h2]configure

Method

public int configure(Surface inputSurface, HdrVividRender.InputCallback inputCallback, Surface outputSurface, HdrVividRender.OutputCallback outputCallback)

配置渲染实例的工作模式,渲染实例的生命周期内仅需要配置一次,在调用HdrVividStart前必须调用此函数完成相关配置。

Parameters

Name

Description

inputSurface

非空值标识渲染实例的数据来源于一个Surface实例,当前仅支持由纹理创建的Surface实例,空值标识用户使用write给渲染实例提供数据。

inputCallback

在inputSurface非空值时,用于获取每帧纹理图像的相关信息。

outputSurface

非空值标识,渲染实例的数据是一个Surface实例。

outputCallback

在outputSurface为空值时,渲染实例将工作在转码模式,此参数是一个异步通知回调。

Returns

Type

Description

int

设置成功,返回HDRVIVID_SUCCESS,否则返回相应的错误码。

错误码取值范围:

[h2]createInputSurface

Method

public Surface createInputSurface()

创建输入渲染实例。当输入模式为渲染模式时,需要调用该接口创建输入渲染实例,并将该渲染实例作为configure的inputSurface参数传入。

Returns

Type

Description

Surface

输入渲染实例。

[h2]getVersion

Method

public static String getVersion()

获取版本信息,格式如"1.0.12.300"。

Returns

Type

Description

String

版本信息,格式如"1.0.12.300"。

[h2]init

Method

public boolean init()

初始化渲染实例。

Returns

Type

Description

boolean

设置成功,返回HDRVIVID_SUCCESS,否则返回相应的错误码。

错误码取值范围:

[h2]read

Method

public native ByteBuffer read(HdrVividRender bufferInfo, int timeoutMs)

渲染实例工作在转码模式时,App通过此方法读取处理后的视频图像数据,在用户处理完后,需要将ByteBuffer缓冲长度清空。

Parameters

Name

Description

bufferInfo

转码模式下,缓冲的相应信息。

timeoutMs

读取超时等待时间,单位毫秒。

Returns

Type

Description

ByteBuffer

读取有效时,返回一个非空缓冲值,否则返回空值。

  • 当输出模式为转码输出模式时,可以调用该接口,读取接口输出图像。
  • 当输出模式为渲染输出模式时,调用该接口无效。
  • 如果configure接口设置了outputCallback参数,不需要再调用该接口。

[h2]setBrightness

Method

public native int setBrightness(int brightness)

设置渲染实例的输出视频图像数据的白点的最大峰值亮度。

Parameters

Name

Description

brightness

白点的最大峰值亮度,PQ电光转化函数时,范围[1~10000],HLQ电光转化函数时,范围[1~1000]。

Returns

Type

Description

int

设置成功,返回HDRVIVID_SUCCESS,否则返回相应的错误码。

错误码取值范围:

[h2]setColorFormat

Method

public native int setColorFormat(int colorFormat)

渲染实例工作在转码模式时,设置输出视频图像数据的颜色格式。

Parameters

Name

Description

colorFormat

输出视频图像数据的颜色格式。

取值范围:

Returns

Type

Description

int

设置成功,返回HDRVIVID_SUCCESS,否则返回相应的错误码。

错误码取值范围:

[h2]setColorSpace

Method

public native int setColorSpace(int colorSpace)

渲染实例工作在转码模式时,设置输出视频图像数据的颜色空间。

Parameters

Name

Description

colorSpace

输出视频图像数据的颜色空间。

取值范围:

Returns

Type

Description

int

设置成功,返回HDRVIVID_SUCCESS,否则返回相应的错误码。

错误码取值范围:

[h2]setDynamicMetaData

Method

public native int setDynamicMetaData(long ptsUs, ByteBuffer metaData)

设置渲染实例的输入视频图像的动态元数据,此方法推荐放在配置的HdrVividRender.InputCallback的onGetDynamicMetaData中调用。

Parameters

Name

Description

ptsUs

当前视频图像的呈现时间戳,单位毫秒。

metaData

动态元数据,从视频源中获取。

Returns

Type

Description

int

设置成功,返回HDRVIVID_SUCCESS,否则返回相应的错误码。

错误码取值范围:

[h2]setInputVideoSize

Method

public native int setInputVideoSize(int width, int height)

设置当前输入视频图像的宽高尺寸。

Parameters

Name

Description

width

视频图像的宽。

height

视频图像的高。

Returns

Type

Description

int

设置成功,返回HDRVIVID_SUCCESS,否则返回相应的错误码。

错误码取值范围:

[h2]setOutputSurface

Method

public native int setOutputSurface(Surface surface)

渲染实例工作在渲染模式时,设置输出Surface。

Parameters

Name

Description

surface

Surface实例。

Returns

Type

Description

int

设置成功,返回HDRVIVID_SUCCESS,否则返回相应的错误码。

错误码取值范围:

  • 如果要设置一个空值,先调用stop停止当前渲染实例的工作。
  • 当Surface重新创建时,可以不用销毁HdrVividRender实例,重新设置Surface。

[h2]setOutputSurfaceSize

Method

public native int setOutputSurfaceSize(int width, int height)

渲染实例工作在渲染模式时,设置输出视频源的宽高。

Parameters

Name

Description

width

视频源的宽。

height

视频源的高。

Returns

Type

Description

int

设置成功,返回HDRVIVID_SUCCESS,否则返回相应的错误码。

错误码取值范围:

[h2]setScreenHdr

Method

public native void setScreenHdr(boolean isScreenHdr)

设置屏幕是否支持HDR。

Parameters

Name

Description

isScreenHdr

屏幕是否支持HDR。

  • true:屏幕支持HDR
  • false:屏幕不支持HDR

[h2]setStaticMetaData

Method

public native int setStaticMetaData(HdrVividRender.StaticMetaData metaData)

设置渲染实例的输入视频图像的静态元数据,从视频源中获取。

Parameters

Name

Description

metaData

静态元数据。

Returns

Type

Description

int

设置成功,返回HDRVIVID_SUCCESS,否则返回相应的错误码。

错误码取值范围:

[h2]setTransFunc

Method

public native int setTransFunc(int transFunc)

设置渲染实例的输入视频图像数据的电光转换函数。

Parameters

Name

Description

transFunc

转换函数。

取值范围:

Returns

Type

Description

int

设置成功,返回HDRVIVID_SUCCESS,否则返回相应的错误码。

错误码取值范围:

[h2]start

Method

public native int start()

在配置好渲染实例后,调用该方法,渲染实例开启工作。

Returns

Type

Description

int

渲染实例开启成功,返回HDRVIVID_SUCCESS,否则返回相应的错误码。

错误码取值范围:

[h2]stop

Method

public native int stop()

停止渲染实例当前工作,渲染实例保持活动状态并且可以通过start再次开启工作。

Returns

Type

Description

int

停止渲染实例当前工作成功时,返回HDRVIVID_SUCCESS,否则返回相应的错误码。

错误码取值范围:

[h2]write

Method

public native int write(ByteBuffer yuvData, HdrVividRender.BufferInfo bufferInfo, ByteBuffer dynamicMetaData)

App调用此函数向渲染实例写入视频图像数据。

Parameters

Name

Description

yuvData

存储视频图像的缓冲数据。

bufferInfo

视频图像相关的信息。

dynamicMetaData

视频图像数据相关的HDR动态元数据。

Returns

Type

Description

int

写入视频图像数据成功时,返回HDRVIVID_SUCCESS,否则返回相应的错误码。

错误码取值范围:

[h2]release

Method

public void release()

释放指定的渲染实例。

[h2]setLogCallBack

Method

public void setLogCallBack(HdrVividRender.LogCallBack logCallback)

设置日志回调处理函数。

Parameters

Name

Description

logCallback

输出日志的回调方法,用于通知用户日志信息。