VideoEncoder
概述
VideoEncoder模块提供用于视频编码的函数。
系统能力: SystemCapability.Multimedia.VideoEncoder
起始版本: 9
汇总
文件
名称 | 描述 |
---|---|
native_avcodec_videoencoder.h | 声明用于视频编码的Native API。 |
类型定义
名称 | 描述 |
---|---|
typedef enum OH_VideoEncodeBitrateMode OH_VideoEncodeBitrateMode | 视频编码器的比特率模式。 |
枚举
名称 | 描述 |
---|---|
OH_VideoEncodeBitrateMode { CBR = 0, VBR = 1, CQ = 2 } | 视频编码器的比特率模式。 |
函数
名称 | 描述 |
---|---|
OH_AVCodec * OH_VideoEncoder_CreateByMime (const char *mime) | 从MIME类型创建视频编码器实例。 |
OH_AVCodec * OH_VideoEncoder_CreateByName (const char *name) | 通过视频编码器名称创建视频编码器实例。 |
OH_AVErrCode OH_VideoEncoder_Destroy (OH_AVCodec *codec) | 清理编码器内部资源,销毁编码器实例。 |
OH_AVErrCode OH_VideoEncoder_SetCallback (OH_AVCodec *codec, OH_AVCodecAsyncCallback callback, void *userData) | 设置异步回调函数,让应用可以响应视频编码器生成的事件。 |
OH_AVErrCode OH_VideoEncoder_RegisterCallback (OH_AVCodec *codec, OH_AVCodecCallback callback, void *userData) | 注册异步回调函数,让应用可以响应视频编码器生成的事件。 |
OH_AVErrCode OH_VideoEncoder_Configure (OH_AVCodec *codec, OH_AVFormat *format) | 配置视频编码器,通常需要配置要编码的视频轨的描述信息。 |
OH_AVErrCode OH_VideoEncoder_Prepare (OH_AVCodec *codec) | 准备编码器的内部资源。 |
OH_AVErrCode OH_VideoEncoder_Start (OH_AVCodec *codec) | 启动编码器,准备成功后必须调用此接口。 |
OH_AVErrCode OH_VideoEncoder_Stop (OH_AVCodec *codec) | 停止编码器。 |
OH_AVErrCode OH_VideoEncoder_Flush (OH_AVCodec *codec) | 清除编码器中缓存的输入和输出数据。 |
OH_AVErrCode OH_VideoEncoder_Reset (OH_AVCodec *codec) | 重置编码器。 |
OH_AVFormat * OH_VideoEncoder_GetOutputDescription (OH_AVCodec *codec) | 获取编码器输出数据的描述信息。 |
OH_AVErrCode OH_VideoEncoder_SetParameter (OH_AVCodec *codec, OH_AVFormat *format) | 为编码器设置动态参数。 |
OH_AVErrCode OH_VideoEncoder_GetSurface (OH_AVCodec *codec, OHNativeWindow **window) | 从视频编码器获取输入Surface。 |
OH_AVErrCode OH_VideoEncoder_FreeOutputData (OH_AVCodec *codec, uint32_t index) | 将处理后的输出缓冲区返回给编码器。 |
OH_AVErrCode OH_VideoEncoder_NotifyEndOfStream (OH_AVCodec *codec) | 通知视频编码器输入流已结束。 |
OH_AVErrCode OH_VideoEncoder_PushInputData (OH_AVCodec *codec, uint32_t index, OH_AVCodecBufferAttr attr) | 将填入数据的输入缓冲区提交给视频编码器。 |
OH_AVErrCode OH_VideoEncoder_PushInputBuffer (OH_AVCodec *codec, uint32_t index) | 将填入数据的输入缓冲区提交给视频编码器。 |
OH_AVErrCode OH_VideoEncoder_FreeOutputBuffer (OH_AVCodec *codec, uint32_t index) | 将处理后的输出缓冲区返回给编码器。 |
OH_AVFormat * OH_VideoEncoder_GetInputDescription (OH_AVCodec *codec) | 获取视频编码器接收的描述信息。 |
OH_AVErrCode OH_VideoEncoder_IsValid (OH_AVCodec *codec, bool *isValid) | 检查当前编码实例是否有效。 |
类型定义说明
OH_VideoEncodeBitrateMode
typedef enum OH_VideoEncodeBitrateMode OH_VideoEncodeBitrateMode
描述
视频编码器的比特率模式。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
枚举类型说明
OH_VideoEncodeBitrateMode
enum OH_VideoEncodeBitrateMode
描述
视频编码器的比特率模式。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
枚举值 | 描述 |
---|---|
CBR | 恒定比特率模式。 |
VBR | 可变比特率模式。 |
CQ | 恒定质量模式。 |
函数说明
OH_VideoEncoder_Configure()
OH_AVErrCode OH_VideoEncoder_Configure (OH_AVCodec *codec, OH_AVFormat *format )
描述
配置视频编码器,通常需要配置要编码的视频轨的描述信息。必须在调用Prepare之前,调用此接口。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
format | 指向OH_AVFormat的指针,用于给出要编码的视频轨的描述。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。
OH_VideoEncoder_CreateByMime()
OH_AVCodec* OH_VideoEncoder_CreateByMime (const char *mime)
描述
从MIME类型创建视频编码器实例,大多数情况下建议使用。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
参数:
名称 | 描述 |
---|---|
mime | MIME类型描述字符串,请参阅AVCODEC_MIMETYPE。 |
返回:
成功则返回一个指向视频编码实例的指针,失败则返回nullptr。
OH_VideoEncoder_CreateByName()
OH_AVCodec* OH_VideoEncoder_CreateByName (const char *name)
描述
通过视频编码器名称创建视频编码器实例。使用此接口的前提是知道编码器的确切名称。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
参数:
名称 | 描述 |
---|---|
name | 视频编码器名称。 |
返回:
成功则返回一个指向视频编码实例的指针,失败则返回nullptr。
OH_VideoEncoder_Destroy()
OH_AVErrCode OH_VideoEncoder_Destroy (OH_AVCodec *codec)
描述
清理编码器内部资源,销毁编码器实例。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。
OH_VideoEncoder_Flush()
OH_AVErrCode OH_VideoEncoder_Flush (OH_AVCodec *codec)
描述
清除编码器中缓存的输入和输出数据。
调用此接口后,以前通过异步回调上报的所有缓冲区索引都将失效,请确保不要访问这些索引对应的缓冲区。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。
OH_VideoEncoder_FreeOutputBuffer()
OH_AVErrCode OH_VideoEncoder_FreeOutputBuffer (OH_AVCodec *codec, uint32_t index )
描述
将处理后的输出缓冲区返回给编码器。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 11
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
index | 输出缓冲区对应的索引值。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。
OH_VideoEncoder_FreeOutputData()
OH_AVErrCode OH_VideoEncoder_FreeOutputData (OH_AVCodec *codec, uint32_t index )
描述
将处理后的输出缓冲区返回给编码器。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
废弃版本: 11
替代接口:OH_VideoEncoder_FreeOutputBuffer
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
index | 输出缓冲区对应的索引值。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。
OH_VideoEncoder_GetInputDescription()
OH_AVFormat* OH_VideoEncoder_GetInputDescription (OH_AVCodec *codec)
描述
获取视频编码器接收的描述信息,调用OH_VideoEncoder_Configure后调用此接口。 应该注意的是,返回指针所指向的OH_AVFormat实例的生命周期需要由调用者手动释放,请参阅OH_AVFormat_Destroy。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 10
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
返回:
返回指向OH_AVFormat实例的指针。
OH_VideoEncoder_GetOutputDescription()
OH_AVFormat* OH_VideoEncoder_GetOutputDescription (OH_AVCodec *codec)
描述
获取编码器输出数据的描述信息。
需要注意的是,返回值指向的OH_AVFormat实例的生命周期需要调用者手动释放。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
返回:
返回指向OH_AVFormat实例的指针。
OH_VideoEncoder_GetSurface()
OH_AVErrCode OH_VideoEncoder_GetSurface (OH_AVCodec *codec, OHNativeWindow ** window )
描述
从视频编码器获取输入Surface,必须在调用Prepare之前调用此接口。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
window | 指向OHNativeWindow实例的指针。 应用负责管理window的生命周期,结束时调用OH_NativeWindow_DestroyNativeWindow释放。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。
OH_VideoEncoder_IsValid()
OH_AVErrCode OH_VideoEncoder_IsValid (OH_AVCodec *codec, bool *isValid )
描述
检查当前编码实例是否有效。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 10
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
isValid | 输出参数。指向布尔实例的指针,如果编码器实例有效,则为true,如果编码器实例无效,则为false。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。
OH_VideoEncoder_NotifyEndOfStream()
OH_AVErrCode OH_VideoEncoder_NotifyEndOfStream (OH_AVCodec *codec)
描述
通知视频编码器输入流已结束。建议使用此接口进行通知。编码器surface模式下,输入流的结束通知。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。
OH_VideoEncoder_Prepare()
OH_AVErrCode OH_VideoEncoder_Prepare (OH_AVCodec *codec)
描述
若要准备编码器的内部资源,必须先调用Configure接口,再调用此接口。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。
OH_VideoEncoder_PushInputBuffer()
OH_AVErrCode OH_VideoEncoder_PushInputBuffer (OH_AVCodec *codec, uint32_t index )
描述
将填入数据的输入缓冲区提交给视频编码器。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 11
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
index | 输入缓冲区对应的索引值。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。
OH_VideoEncoder_PushInputData()
OH_AVErrCode OH_VideoEncoder_PushInputData (OH_AVCodec *codec, uint32_t index, OH_AVCodecBufferAttr attr )
描述
将填入数据的输入缓冲区提交给视频编码器。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 10
废弃版本: 11
替代接口:OH_VideoEncoder_PushInputBuffer
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
index | 输入缓冲区对应的索引值。 |
attr | 缓冲区中包含数据的描述信息。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。
OH_VideoEncoder_RegisterCallback()
OH_AVErrCode OH_VideoEncoder_RegisterCallback (OH_AVCodec *codec, OH_AVCodecCallback callback, void *userData )
描述
注册异步回调函数,让应用可以响应视频编码器生成的事件。在调用Prepare之前,必须调用此接口。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 11
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
callback | 所有回调函数的集合,请参阅OH_AVCodecCallback。 |
userData | 用户特定数据。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。
OH_VideoEncoder_Reset()
OH_AVErrCode OH_VideoEncoder_Reset (OH_AVCodec *codec)
描述
重置编码器。如果要继续编码,需要再次调用Configure接口配置编码器实例。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。
OH_VideoEncoder_SetCallback()
OH_AVErrCode OH_VideoEncoder_SetCallback (OH_AVCodec *codec, OH_AVCodecAsyncCallback callback, void *userData )
描述
设置异步回调函数,让应用可以响应视频编码器生成的事件。在调用Prepare之前,必须调用此接口。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
废弃版本: 11
替代接口:OH_VideoEncoder_RegisterCallback
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
callback | 所有回调函数的集合,请参阅OH_AVCodecAsyncCallback。 |
userData | 用户特定数据。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。
OH_VideoEncoder_SetParameter()
OH_AVErrCode OH_VideoEncoder_SetParameter (OH_AVCodec *codec, OH_AVFormat *format )
描述
为编码器设置动态参数。 注意,此接口只有在编码器启动后才能调用。 同时,不正确的参数设置可能会导致编码失败。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
format | 指向OH_AVFormat实例的指针。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。
OH_VideoEncoder_Start()
OH_AVErrCode OH_VideoEncoder_Start (OH_AVCodec *codec)
描述
启动编码器,准备成功后必须调用此接口。成功启动后,编码器将开始报告注册的回调事件。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。
OH_VideoEncoder_Stop()
OH_AVErrCode OH_VideoEncoder_Stop (OH_AVCodec *codec)
描述
停止编码器。停止之后,你可以通过Start接口进入Started状态。
系统能力: SystemCapability.Multimedia.Media.VideoEncoder
起始版本: 9
参数:
名称 | 描述 |
---|---|
codec | 指向视频编码实例的指针。 |
返回:
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅OH_AVErrCode。