openharmony 鸿蒙 capi-native-avcodec-videoencoder-h

2026-08-25 浏览 (1)

native_avcodec_videoencoder.h

概述

声明用于视频编码的接口。

引用文件： <multimedia/player_framework/native_avcodec_videoencoder.h>

库： libnative_media_venc.so

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

相关模块： VideoEncoder

相关示例： AVCodec

接口在每个版本，对每种模式的支持情况说明，如下图所示。

meaning

description of encode api history

汇总

枚举

名称typedef关键字描述
OH_VideoEncodeBitrateModeOH_VideoEncodeBitrateMode视频编码器的码率控制模式。(API14废弃)

函数

名称typedef关键字描述
typedef void (*OH_VideoEncoder_OnNeedInputParameter)(OH_AVCodec *codec, uint32_t index, OH_AVFormat *parameter, void *userData)OH_VideoEncoder_OnNeedInputParameter配置随帧参数，当需要设置index对应帧的编码参数时，可以通过该接口设置。只在Surface模式生效。
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_AVCodecCallback回调函数，让应用可以响应视频编码器生成的事件。在调用OH_VideoEncoder_Prepare接口之前，必须调用此接口。(API11废弃)
OH_AVErrCode OH_VideoEncoder_RegisterCallback(OH_AVCodec *codec, OH_AVCodecCallback callback, void *userData)-注册OH_AVCodecCallback回调函数，让应用可以响应视频编码器生成的事件。在调用OH_VideoEncoder_Prepare接口之前，必须调用此接口。
OH_AVErrCode OH_VideoEncoder_RegisterParameterCallback(OH_AVCodec *codec, OH_VideoEncoder_OnNeedInputParameter onInputParameter, void *userData)-注册OH_AVCodecCallback输入参数回调函数，让应用可以响应视频编码器生成的事件。编码Surface模式，需要设置随帧参数时，须使用该接口。
如果使用该接口，必须在OH_VideoEncoder_Configure之前调用该接口。
OH_AVErrCode OH_VideoEncoder_Configure(OH_AVCodec *codec, OH_AVFormat *format)-配置视频编码器的编码参数，通常需要配置输入视频帧的描述信息，如帧的宽、高、像素格式等。必须在调用OH_VideoEncoder_Prepare接口之前，调用此接口。
OH_AVErrCode OH_VideoEncoder_Prepare(OH_AVCodec *codec)-准备编码器的内部资源，在OH_VideoEncoder_Configure接口后调用。
OH_AVErrCode OH_VideoEncoder_Start(OH_AVCodec *codec)-调用OH_VideoEncoder_Prepare接口成功后调用此接口启动编码器。成功启动后，编码器将开始报告注册的回调事件。
OH_AVErrCode OH_VideoEncoder_Stop(OH_AVCodec *codec)-停止编码器，释放输入输出buffer。停止之后，可以通过调用OH_VideoEncoder_Start接口重新进入Running状态。
OH_AVErrCode OH_VideoEncoder_Flush(OH_AVCodec *codec)-清除编码器中缓存的输入和输出数据及参数集如H.264格式的PPS/SPS。
调用此接口后，以前通过异步回调上报的所有缓冲区index都将失效，请确保不要访问这些index对应的缓冲区。该接口不能连续调用。
OH_AVErrCode OH_VideoEncoder_Reset(OH_AVCodec *codec)-重置编码器，编码器回到初始化状态。如果要继续编码，需要再次调用OH_VideoEncoder_Configure接口配置编码器实例。
OH_AVFormat *OH_VideoEncoder_GetOutputDescription(OH_AVCodec *codec)-获取编码器输出数据的OH_AVFormat信息。
需要注意的是，返回值指向的OH_AVFormat实例的生命周期需要开发者通过调用接口OH_AVFormat_Destroy释放。
OH_AVErrCode OH_VideoEncoder_SetParameter(OH_AVCodec *codec, OH_AVFormat *format)-在编码器运行时设置编码器参数。
注意，此接口只有在编码器启动后才能调用。同时，不正确的参数设置可能会导致编码失败。
OH_AVErrCode OH_VideoEncoder_GetSurface(OH_AVCodec *codec, OHNativeWindow **window)-从视频编码器获取输入surface，必须在调用OH_VideoEncoder_Configure接口之后OH_VideoEncoder_Prepare接口之前调用此接口。
OH_AVErrCode OH_VideoEncoder_FreeOutputData(OH_AVCodec *codec, uint32_t index)-将处理后的输出缓冲区返回给编码器。(API11废弃)
OH_AVErrCode OH_VideoEncoder_NotifyEndOfStream(OH_AVCodec *codec)-通知视频编码器输入流已结束。建议使用此接口进行通知。该接口只在Surface模式下使用，Buffer模式通过OH_AVBuffer携带EOS信息，通知输入流的结束。
OH_AVErrCode OH_VideoEncoder_PushInputData(OH_AVCodec *codec, uint32_t index, OH_AVCodecBufferAttr attr)-将填入数据的输入缓冲区提交给视频编码器。(API11废弃)
OH_AVErrCode OH_VideoEncoder_PushInputBuffer(OH_AVCodec *codec, uint32_t index)-Buffer模式下，将index对应的OH_AVBuffer送入编码器编码。
OH_AVErrCode OH_VideoEncoder_PushInputParameter(OH_AVCodec *codec, uint32_t index)-Surface模式下，将index对应帧的编码参数送入编码器编码。
OH_AVErrCode OH_VideoEncoder_FreeOutputBuffer(OH_AVCodec *codec, uint32_t index)-将处理后的index对应的OH_AVBuffer退回给编码器。开发者使用完需要及时调用此接口释放输出缓存区，否则会阻塞编码流程。
OH_AVFormat *OH_VideoEncoder_GetInputDescription(OH_AVCodec *codec)-编码器接收到的图像的描述信息。调用OH_VideoEncoder_Configure后调用此接口。
需要注意的是，返回指针所指向的OH_AVFormat实例的生命周期需要由开发者通过调用OH_AVFormat_Destroy接口释放。
OH_AVErrCode OH_VideoEncoder_IsValid(OH_AVCodec *codec, bool *isValid)-在编码器实例存在的情况下，检查当前编码器服务是否有效。
OH_AVErrCode OH_VideoEncoder_QueryInputBuffer(struct OH_AVCodec *codec, uint32_t *index, int64_t timeoutUs)-查询下一个可用输入缓冲区的索引。
调用此接口后需要接着调用OH_VideoEncoder_GetInputBuffer接口获取缓冲区实例，并通过OH_VideoEncoder_PushInputBuffer接口传递给编码器。
需要注意的是，上述操作仅在同步模式下支持。
OH_AVBuffer *OH_VideoEncoder_GetInputBuffer(struct OH_AVCodec *codec, uint32_t index)-获取可用输入缓冲区的实例。
需要注意的是，此接口仅适用于同步模式。
OH_AVErrCode OH_VideoEncoder_QueryOutputBuffer(struct OH_AVCodec *codec, uint32_t *index, int64_t timeoutUs)-查询下一个可用输出缓冲区的索引。通过OH_VideoEncoder_GetOutputBuffer接口获取的缓冲区实例可以通过OH_VideoEncoder_FreeOutputBuffer接口将处理后的输出缓冲区返回到编码器。
需要注意的是，上述操作仅在同步模式下支持。
OH_AVBuffer *OH_VideoEncoder_GetOutputBuffer(struct OH_AVCodec *codec, uint32_t index)-获取可用输出缓冲区的实例。
需要注意的是，此接口仅适用于同步模式。

枚举类型说明

OH_VideoEncodeBitrateMode

enum OH_VideoEncodeBitrateMode

描述

视频编码器的码率控制模式。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

废弃版本： 14

替代接口： OH_BitrateMode

枚举项描述
CBR = 0恒定码率模式。
替代接口： BITRATE_MODE_CBR
VBR = 1可变码率模式。
替代接口： BITRATE_MODE_VBR
CQ = 2恒定QP模式。
替代接口： BITRATE_MODE_CQ

函数说明

OH_VideoEncoder_OnNeedInputParameter()

typedef void (*OH_VideoEncoder_OnNeedInputParameter)(OH_AVCodec *codec, uint32_t index, OH_AVFormat *parameter, void *userData)

描述

配置随帧参数，当需要设置index对应帧的编码参数时，可以通过该接口设置。只在Surface模式生效。
该接口只能在Surface模式下使用，使用前需要调用OH_VideoEncoder_RegisterParameterCallback接口注册。
在Buffer模式下，OH_AVBuffer可以直接携带帧的编码参数，当前可以支持的随帧参数有帧级QPMin/QPMax，指定LTR设置参考帧。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 12

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。
uint32_t index对应编码帧的index。
OH_AVFormat *parameter编码参数。
void *userData开发者执行回调所依赖的数据。

OH_VideoEncoder_CreateByMime()

OH_AVCodec *OH_VideoEncoder_CreateByMime(const char *mime)

描述

根据MIME类型创建视频编码器实例，推荐使用。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

参数：

参数项描述
const char *mimeMIME类型描述字符串，请参阅AVCODEC_MIME_TYPE。

返回：

类型说明
OH_AVCodec *成功则返回一个指向视频编码实例的指针。
如果输入为不支持的编码器类型或内存不足时，则返回NULL。

OH_VideoEncoder_CreateByName()

OH_AVCodec *OH_VideoEncoder_CreateByName(const char *name)

描述

根据视频编码器名称创建视频编码器实例。使用此接口的前提是知道编码器的确切名称，编码器的名称可以通过能力查询获取。
详情请参见：获取支持的编解码能力。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

参数：

参数项描述
const char *name视频编码器名称。

返回：

类型说明
OH_AVCodec *成功则返回一个指向视频编码实例的指针。
如果输入是不支持编码器名称或者内存资源不足，则返回NULL。

OH_VideoEncoder_Destroy()

OH_AVErrCode OH_VideoEncoder_Destroy(OH_AVCodec *codec)

描述

清理编码器内部资源，销毁编码器实例。不能重复销毁。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。

OH_VideoEncoder_SetCallback()

OH_AVErrCode OH_VideoEncoder_SetCallback(OH_AVCodec *codec, OH_AVCodecAsyncCallback callback, void *userData)

描述

设置OH_AVCodecCallback回调函数，让应用可以响应视频编码器生成的事件。在调用OH_VideoEncoder_Prepare接口之前，必须调用此接口。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

废弃版本： 11

替代接口： OH_VideoEncoder_RegisterCallback

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。
OH_AVCodecAsyncCallback callback所有回调函数的集合。
void *userData开发者执行回调所依赖的数据。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。

OH_VideoEncoder_RegisterCallback()

OH_AVErrCode OH_VideoEncoder_RegisterCallback(OH_AVCodec *codec, OH_AVCodecCallback callback, void *userData)

描述

注册OH_AVCodecCallback回调函数，让应用可以响应视频编码器生成的事件。在调用OH_VideoEncoder_Prepare接口之前，必须调用此接口。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 11

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。
OH_AVCodecCallback callback所有回调函数的集合。
void *userData开发者执行回调所依赖的数据。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。

OH_VideoEncoder_RegisterParameterCallback()

OH_AVErrCode OH_VideoEncoder_RegisterParameterCallback(OH_AVCodec *codec, OH_VideoEncoder_OnNeedInputParameter onInputParameter, void *userData)

描述

注册OH_AVCodecCallback输入参数回调函数，让应用可以响应视频编码器生成的事件。编码Surface模式，需要设置随帧参数时，须使用该接口。
如果使用该接口，必须在OH_VideoEncoder_Configure之前调用该接口。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 12

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。
OH_VideoEncoder_OnNeedInputParameter onInputParameter输入参数回调指针。
void *userData开发者执行回调所依赖的数据。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。
AV_ERR_INVALID_STATE：本接口必须在OH_VideoEncoder_Prepare接口前调用，如果在其他状态时调用，则返回此错误码。

OH_VideoEncoder_Configure()

OH_AVErrCode OH_VideoEncoder_Configure(OH_AVCodec *codec, OH_AVFormat *format)

描述

配置视频编码器的编码参数，通常需要配置输入视频帧的描述信息，如帧的宽、高、像素格式等。必须在调用OH_VideoEncoder_Prepare接口之前，调用此接口。
该接口对配置参数进行合法性校验，部分非法参数不会强校验，使用默认值或直接丢弃。部分非法参数会强校验，具体规则如下：
以下参数的配置范围可通过能力查询获取，OH_MD_KEY_I_FRAME_INTERVAL暂不支持能力查询。
设置OH_MD_KEY_VIDEO_ENCODER_ENABLE_TEMPORAL_SCALABILITY、OH_MD_KEY_VIDEO_ENCODER_LTR_FRAME_COUNT参数时，如果当前平台不支持这些功能，该接口不会报错，而是继续按照正常编码流程执行。

参数校验：

Key配置正常范围的值配置超出范围的值不配置该参数
OH_MD_KEY_WIDTHAV_ERR_OKAV_ERR_INVALID_VALAV_ERR_INVALID_VAL
OH_MD_KEY_HEIGHTAV_ERR_OKAV_ERR_INVALID_VALAV_ERR_INVALID_VAL
OH_MD_KEY_PIXEL_FORMAT 请参阅OH_AVPixelFormatAV_ERR_OKAV_ERR_UNSUPPORTAV_ERR_OK
OH_MD_KEY_FRAME_RATEAV_ERR_OKAV_ERR_INVALID_VALAV_ERR_OK
OH_MD_KEY_PROFILE 请参阅OH_MD_KEY_PROFILEAV_ERR_OKAV_ERR_INVALID_VALAV_ERR_OK
OH_MD_KEY_I_FRAME_INTERVALAV_ERR_OK\AV_ERR_OK
OH_MD_KEY_
BITRATE		OH_MD_KEY_
QUALITY		OH_MD_KEY_
VIDEO_ENCODER_BITRATE_MODE		返回值说明
\\\AV_ERR_OK使用编码器默认值
超出范围超出范围不支持的模式AV_ERR_INVALID_VAL异常值均报错
正常值正常值\AV_ERR_INVALID_VALBitrate 与 Quality 冲突
正常值\\AV_ERR_OK使能默认码控模式
正常值\BITRATE_MODE_VBR、BITRATE_MODE_CBRAV_ERR_OK-
正常值\BITRATE_MODE_CQAV_ERR_INVALID_VALBitrate 与 CQ 模式冲突
\正常值\AV_ERR_OK使能 CQ 模式
\正常值BITRATE_MODE_CQAV_ERR_OK-
\正常值BITRATE_MODE_VBR、BITRATE_MODE_CBRAV_ERR_INVALID_VALQuality 与 VBR、CBR 模式冲突
\\BITRATE_MODE_VBR、BITRATE_MODE_CBRAV_ERR_OK使用编码器默认码率
\\BITRATE_MODE_CQAV_ERR_OK使用默认quality

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。
OH_AVFormat *format指向OH_AVFormat的指针，用于给出要编码的视频轨的描述。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。
AV_ERR_INVALID_VAL：1. 输入的codec指针为非编码器实例，或者为空指针；2. 输入format参数不支持。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。
AV_ERR_INVALID_STATE：本接口必须在OH_VideoEncoder_Prepare接口前调用，如果在其他状态时调用，则返回此错误码。

OH_VideoEncoder_Prepare()

OH_AVErrCode OH_VideoEncoder_Prepare(OH_AVCodec *codec)

描述

准备编码器的内部资源，在OH_VideoEncoder_Configure接口后调用。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。
AV_ERR_INVALID_STATE：当前编码器状态不支持调用本接口。

OH_VideoEncoder_Start()

OH_AVErrCode OH_VideoEncoder_Start(OH_AVCodec *codec)

描述

调用OH_VideoEncoder_Prepare接口成功后调用此接口启动编码器。成功启动后，编码器将开始报告注册的回调事件。
Surface模式下，在surface中有正确的输入后，每完成一帧编码会触发OnNewOutputBuffer。
Buffer模式下，编码器会立即触发输入回调，开发者每完成一次输入，编码器执行编码，每完成一帧编码会触发OnNewOutputBuffer。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。
AV_ERR_INVALID_STATE：当前编码器状态不支持调用本接口。

OH_VideoEncoder_Stop()

OH_AVErrCode OH_VideoEncoder_Stop(OH_AVCodec *codec)

描述

停止编码器，释放输入输出buffer。停止之后，可以通过调用OH_VideoEncoder_Start接口重新进入Running状态。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。
AV_ERR_INVALID_STATE：当前编码器状态不支持调用本接口。

OH_VideoEncoder_Flush()

OH_AVErrCode OH_VideoEncoder_Flush(OH_AVCodec *codec)

描述

清除编码器中缓存的输入和输出数据及参数集如H.264格式的PPS/SPS。
调用此接口后，以前通过异步回调上报的所有缓冲区index都将失效，请确保不要访问这些index对应的缓冲区。该接口不能连续调用。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。
AV_ERR_INVALID_STATE：当前编码器状态不支持调用本接口。

OH_VideoEncoder_Reset()

OH_AVErrCode OH_VideoEncoder_Reset(OH_AVCodec *codec)

描述

重置编码器，编码器回到初始化状态。如果要继续编码，需要再次调用OH_VideoEncoder_Configure接口配置编码器实例。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。

OH_VideoEncoder_GetOutputDescription()

OH_AVFormat *OH_VideoEncoder_GetOutputDescription(OH_AVCodec *codec)

描述

获取编码器输出数据的OH_AVFormat信息。
需要注意的是，返回值指向的OH_AVFormat实例的生命周期需要开发者通过调用接口OH_AVFormat_Destroy释放。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。

返回：

类型说明
OH_AVFormat *返回指向OH_AVFormat实例的指针。
当输入的codec指针非编码实例，或者为空指针，则返回NULL。

OH_VideoEncoder_SetParameter()

OH_AVErrCode OH_VideoEncoder_SetParameter(OH_AVCodec *codec, OH_AVFormat *format)

描述

在编码器运行时设置编码器参数。
注意，此接口只有在编码器启动后才能调用。同时，不正确的参数设置可能会导致编码失败。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。
OH_AVFormat *format指向OH_AVFormat实例的指针。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。
AV_ERR_INVALID_VAL：1. 输入的codec指针为非编码器实例，或者为空指针；2. 输入format参数不支持。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。
AV_ERR_INVALID_STATE：当前编码器状态不支持调用本接口。

OH_VideoEncoder_GetSurface()

OH_AVErrCode OH_VideoEncoder_GetSurface(OH_AVCodec *codec, OHNativeWindow **window)

描述

从视频编码器获取输入surface，必须在调用OH_VideoEncoder_Configure接口之后OH_VideoEncoder_Prepare接口之前调用此接口。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。
OHNativeWindow **window指向OHNativeWindow实例的指针。应用负责管理window的生命周期，结束时调用OH_NativeWindow_DestroyNativeWindow释放。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。

OH_VideoEncoder_FreeOutputData()

OH_AVErrCode OH_VideoEncoder_FreeOutputData(OH_AVCodec *codec, uint32_t index)

描述

将处理后的输出缓冲区返回给编码器。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

废弃版本： 11

替代接口： OH_VideoEncoder_FreeOutputBuffer

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。
uint32_t index输出缓冲区对应的索引值。由OH_AVCodecOnNewOutputData给出。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。
AV_ERR_INVALID_STATE：当前编码器状态不支持调用本接口。

OH_VideoEncoder_NotifyEndOfStream()

OH_AVErrCode OH_VideoEncoder_NotifyEndOfStream(OH_AVCodec *codec)

描述

通知视频编码器输入流已结束。建议使用此接口进行通知。该接口只在Surface模式下使用，Buffer模式通过OH_AVBuffer携带EOS信息，通知输入流的结束。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 9

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。
AV_ERR_INVALID_STATE：当前编码器状态不支持调用本接口。

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

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。
uint32_t index输入缓冲区对应的索引值。由OH_AVCodecOnNeedInputData给出。
OH_AVCodecBufferAttr attr缓冲区中包含数据的描述信息。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。
AV_ERR_INVALID_STATE：当前编码器状态不支持调用本接口。

OH_VideoEncoder_PushInputBuffer()

OH_AVErrCode OH_VideoEncoder_PushInputBuffer(OH_AVCodec *codec, uint32_t index)

描述

Buffer模式下，将index对应的OH_AVBuffer送入编码器编码。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 11

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。
uint32_t index输入缓冲区对应的索引值。由OH_AVCodecOnNeedInputBuffer给出。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。
AV_ERR_INVALID_VAL：1. 输入的codec指针为非编码器实例，或者为空指针；2. 输入format参数不支持。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。
AV_ERR_INVALID_STATE：当前编码器状态不支持调用本接口。

OH_VideoEncoder_PushInputParameter()

OH_AVErrCode OH_VideoEncoder_PushInputParameter(OH_AVCodec *codec, uint32_t index)

描述

Surface模式下，将index对应帧的编码参数送入编码器编码。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 12

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。
uint32_t index输入参数缓冲区对应的索引值。由OH_AVCodecOnNeedInputBuffer给出。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。
AV_ERR_INVALID_STATE：当前编码器状态不支持调用本接口。

OH_VideoEncoder_FreeOutputBuffer()

OH_AVErrCode OH_VideoEncoder_FreeOutputBuffer(OH_AVCodec *codec, uint32_t index)

描述

将处理后的index对应的OH_AVBuffer退回给编码器。开发者使用完需要及时调用此接口释放输出缓存区，否则会阻塞编码流程。
详情请参见：视频编码 “Surface模式的步骤-13或Buffer模式步骤-11”。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 11

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。
uint32_t index输出缓冲区对应的索引值。由OH_AVCodecOnNeedInputBuffer给出。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。
AV_ERR_INVALID_VAL：
1. 输入的 codec 指针为非编码器实例，或者为空指针；
2. 输入format参数不支持；
3. index非法或者连续给同一个index，该错误不影响后续编码流程。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。
AV_ERR_INVALID_STATE：当前编码器状态不支持调用本接口。

OH_VideoEncoder_GetInputDescription()

OH_AVFormat *OH_VideoEncoder_GetInputDescription(OH_AVCodec *codec)

描述

编码器接收到的图像的描述信息。调用OH_VideoEncoder_Configure后调用此接口。
需要注意的是，返回指针所指向的OH_AVFormat实例的生命周期需要由开发者通过调用OH_AVFormat_Destroy接口释放。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 10

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。

返回：

类型说明
OH_AVFormat *返回指向OH_AVFormat实例的指针。
当codec指针非编码实例，或者为空指针，则返回NULL。

OH_VideoEncoder_IsValid()

OH_AVErrCode OH_VideoEncoder_IsValid(OH_AVCodec *codec, bool *isValid)

描述

在编码器实例存在的情况下，检查当前编码器服务是否有效。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 10

参数：

参数项描述
OH_AVCodec *codec指向视频编码实例的指针。
bool *isValid输出参数，指向布尔类型的指针。只有当接口返回AV_ERR_OK时，该值表示编码器服务的有效性（true为有效，false为无效）。建议开发者将isValid初始化为false。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。

OH_VideoEncoder_QueryInputBuffer()

OH_AVErrCode OH_VideoEncoder_QueryInputBuffer(struct OH_AVCodec *codec, uint32_t *index, int64_t timeoutUs)

描述

查询下一个可用输入缓冲区的索引。
调用此接口后需要接着调用OH_VideoEncoder_GetInputBuffer接口获取缓冲区实例，并通过OH_VideoEncoder_PushInputBuffer接口传递给编码器。
需要注意的是，上述操作仅在同步模式下支持。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 20

参数：

参数项描述
struct OH_AVCodec *codec指向视频编码实例的指针。
uint32_t *index输入buffer对应的索引值。
int64_t timeoutUs超时时长，单位为微秒。负值：无限等待；0：立即退出；正值：等待指定时长后退出。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码器实例已经销毁。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_INVALID_STATE：当前编码器状态不支持调用本接口。
AV_ERR_OPERATE_NOT_PERMIT：禁止异步模式下使用。
AV_ERR_TRY_AGAIN_LATER：查询失败，建议等待短暂间隔后重试。

OH_VideoEncoder_GetInputBuffer()

OH_AVBuffer *OH_VideoEncoder_GetInputBuffer(struct OH_AVCodec *codec, uint32_t index)

描述

获取可用输入缓冲区的实例。
需要注意的是，此接口仅适用于同步模式。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 20

参数：

参数项描述
struct OH_AVCodec *codec指向视频编码实例的指针。
uint32_t index输入buffer对应的索引值，可通过OH_VideoEncoder_QueryInputBuffer 接口获取。

返回：

类型说明
OH_AVBuffer *如果执行成功，则返回一个指向OH_AVBuffer实例的指针，否则返回NULL。

OH_VideoEncoder_QueryOutputBuffer()

OH_AVErrCode OH_VideoEncoder_QueryOutputBuffer(struct OH_AVCodec *codec, uint32_t *index, int64_t timeoutUs)

描述

查询下一个可用输出缓冲区的索引。通过OH_VideoEncoder_GetOutputBuffer接口获取的缓冲区实例可以通过OH_VideoEncoder_FreeOutputBuffer接口将处理后的输出缓冲区返回到编码器。
需要注意的是，上述操作仅在同步模式下支持。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 20

参数：

参数项描述
struct OH_AVCodec *codec指向视频编码实例的指针。
uint32_t *index输出buffer对应的索引值。
int64_t timeoutUs超时时长，单位为微秒。负值：无限等待；0：立即退出；正值：等待指定时长后退出。

返回：

类型说明
OH_AVErrCodeAV_ERR_OK：执行成功。
AV_ERR_NO_MEMORY：输入的编码器实例已经销毁。
AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。
AV_ERR_UNKNOWN：未知错误。
AV_ERR_INVALID_STATE：当前编码器状态不支持调用本接口。
AV_ERR_OPERATE_NOT_PERMIT：禁止异步模式下使用。
AV_ERR_STREAM_CHANGED：流格式已变更，可以通过调用OH_VideoEncoder_GetOutputDescription接口获取新的流信息。
AV_ERR_TRY_AGAIN_LATER：查询失败，建议等待短暂间隔后重试。

OH_VideoEncoder_GetOutputBuffer()

OH_AVBuffer *OH_VideoEncoder_GetOutputBuffer(struct OH_AVCodec *codec, uint32_t index)

描述

获取可用输出缓冲区的实例。
需要注意的是，此接口仅适用于同步模式。

系统能力： SystemCapability.Multimedia.Media.VideoEncoder

起始版本： 20

参数：

参数项描述
struct OH_AVCodec *codec指向视频编码实例的指针。
uint32_t index输出buffer对应的索引值，可通过OH_VideoEncoder_QueryOutputBuffer接口获取。

返回：

类型说明
OH_AVBuffer *如果执行成功，则返回一个指向OH_AVBuffer实例的指针，否则返回NULL。

你可能感兴趣的鸿蒙文章

openharmony 鸿蒙 capi-native-avcodec-audiocodec-h

openharmony 鸿蒙 capi-avsource-oh-avsource

openharmony 鸿蒙 capi-native-cencinfo-h

openharmony 鸿蒙 capi-avmuxer

openharmony 鸿蒙 capi-multimedia-drm-oh-avcencinfo

openharmony 鸿蒙 capi-native-avdemuxer-h

openharmony 鸿蒙 capi-media-types-h

openharmony 鸿蒙 capi-native-audio-channel-layout-h

openharmony 鸿蒙 capi-native-avbuffer-info-h

openharmony 鸿蒙 capi-codecbase-oh-avcodecasynccallback

  • 所属分类： 后端技术
  • 本文标签： 鸿蒙 软件
  • 版权声明： 本文链接 https://seaxiang.com/blog/zyyJ9gqv