1# VideoEncoder 2 3 4## 概述 5 6VideoEncoder模块提供用于视频编码的接口。 7 8开发者可根据实际的开发需求，参考对应的开发指南及样例： 9 10- [视频编码](../../media/avcodec/video-encoding.md) 11- [时域可分层视频编码](../../media/avcodec/video-encoding-temporal-scalability.md) 12 13**系统能力：** SystemCapability.Multimedia.VideoEncoder 14 15**起始版本：** 9 16 17接口在每个版本，对每种模式的支持情况说明，如下图所示。 18 19 20 21 22 23## 汇总 24 25 26### 文件 27 28| 名称 | 描述 | 29| -------- | -------- | 30| [native_avcodec_videoencoder.h](native__avcodec__videoencoder_8h.md) | 声明用于视频编码的接口。 | 31 32 33### 类型定义 34 35| 名称 | 描述 | 36| -------- | -------- | 37| typedef void(\* [OH_VideoEncoder_OnNeedInputParameter](#oh_videoencoder_onneedinputparameter)) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec, uint32_t index, OH_AVFormat \*parameter, void \*userData) | 配置随帧参数，当需要设置index对应帧的编码参数时，可以通过该接口设置。只在Surface模式生效。 | 38 39### 枚举 40 41| 名称 | 描述 | 42| -------- | -------- | 43| [OH_VideoEncodeBitrateMode](#oh_videoencodebitratemode) { CBR = 0, VBR = 1, CQ = 2 } | 视频编码器的码率控制模式。（API14废弃） | 44 45 46### 函数 47 48| 名称 | 描述 | 49| -------- | -------- | 50| [OH_AVCodec](_codec_base.md#oh_avcodec) \* [OH_VideoEncoder_CreateByMime](#oh_videoencoder_createbymime) (const char \*mime) | 根据[MIME](_codec_base.md#媒体编解码格式)类型创建视频编码器实例，推荐使用。 | 51| [OH_AVCodec](_codec_base.md#oh_avcodec) \* [OH_VideoEncoder_CreateByName](#oh_videoencoder_createbyname) (const char \*name) | 根据视频编码器名称创建视频编码器实例。 | 52| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_Destroy](#oh_videoencoder_destroy) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec) | 清理编码器内部资源，销毁编码器实例。 | 53| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_SetCallback](#oh_videoencoder_setcallback) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec, [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) callback, void \*userData) | 设置OH_AVCodecCallback回调函数，让应用可以响应视频编码器生成的事件。（API11废弃） | 54| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_RegisterCallback](#oh_videoencoder_registercallback) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec, [OH_AVCodecCallback](_o_h___a_v_codec_callback.md) callback, void \*userData) | 注册OH_AVCodecCallback回调函数，让应用可以响应视频编码器生成的事件。 | 55| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_RegisterParameterCallback](#oh_videoencoder_registerparametercallback) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec, [OH_VideoEncoder_OnNeedInputParameter](#oh_videoencoder_onneedinputparameter) onInputParameter, void \*userData) | 注册OH_AVCodecCallback输入参数回调函数，让应用可以响应视频编码器生成的事件。 | 56| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_Configure](#oh_videoencoder_configure) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec, OH_AVFormat \*format) | 配置视频编码器的编码参数，通常需要配置要编码的视频轨的描述信息，如宽、高、像素格式等。 | 57| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_Prepare](#oh_videoencoder_prepare) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec) | 准备编码器的内部资源。 | 58| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_Start](#oh_videoencoder_start) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec) | 调用OH_VideoEncoder_Prepare接口成功后调用此接口启动编码器。 | 59| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_Stop](#oh_videoencoder_stop) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec) | 停止编码器，释放输入输出buffer。 | 60| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_Flush](#oh_videoencoder_flush) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec) | 清除编码器中缓存的输入和输出数据及参数集如H.264格式的PPS/SPS。 | 61| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_Reset](#oh_videoencoder_reset) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec) | 重置编码器，编码器回到初始化状态。 | 62| OH_AVFormat \* [OH_VideoEncoder_GetOutputDescription](#oh_videoencoder_getoutputdescription) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec) | 获取编码器输出数据的OH_AVFormat信息。 | 63| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_SetParameter](#oh_videoencoder_setparameter) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec, OH_AVFormat \*format) | 在编码器运行时设置编码器参数。 | 64| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_GetSurface](#oh_videoencoder_getsurface) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec, [OHNativeWindow](_codec_base.md#ohnativewindow) \*\*window) | 从视频编码器获取输入surface。 | 65| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_FreeOutputData](#oh_videoencoder_freeoutputdata) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec, uint32_t index) | 将处理后的输出缓冲区返回给编码器。（API11废弃） | 66| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_NotifyEndOfStream](#oh_videoencoder_notifyendofstream) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec) | 通知视频编码器输入流已结束。 | 67| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_PushInputData](#oh_videoencoder_pushinputdata) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec, uint32_t index, [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) attr) | 将填入数据的输入缓冲区提交给视频编码器。（API11废弃） | 68| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_PushInputBuffer](#oh_videoencoder_pushinputbuffer) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec, uint32_t index) | Buffer模式下，将index对应的OH_AVBuffer送入编码器编码。 | 69| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_PushInputParameter](#oh_videoencoder_pushinputparameter) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec, uint32_t index) | Surface模式下，将index对应帧的编码参数送入编码器编码。 | 70| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_FreeOutputBuffer](#oh_videoencoder_freeoutputbuffer) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec, uint32_t index) | 将处理后的index对应的OH_AVBuffer返回给编码器。 | 71| OH_AVFormat \* [OH_VideoEncoder_GetInputDescription](#oh_videoencoder_getinputdescription) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec) | 编码器接收到的图像的描述信息。 | 72| [OH_AVErrCode](_core.md#oh_averrcode) [OH_VideoEncoder_IsValid](#oh_videoencoder_isvalid) ([OH_AVCodec](_codec_base.md#oh_avcodec) \*codec, bool \*isValid) | 检查当前编码实例是否有效。 | 73 74 75## 类型定义说明 76 77### OH_VideoEncoder_OnNeedInputParameter 78 79``` 80typedef void(* OH_VideoEncoder_OnNeedInputParameter) (OH_AVCodec *codec, uint32_t index, OH_AVFormat *parameter, void *userData) 81``` 82**描述** 83配置随帧参数，当需要设置index对应帧的编码参数时，可以通过该接口设置。只在Surface模式生效。 84 85该接口只能在Surface模式下使用，使用前需要调用OH_VideoEncoder_RegisterParameterCallback接口注册。 86 87在Buffer模式下，OH_AVBuffer可以直接携带帧的编码参数，当前可以支持的随帧参数有帧级QPMin/QPMax，指定LTR设置参考帧。 88 89**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 90 91**起始版本：** 12 92 93**参数:** 94 95| 名称 | 描述 | 96| -------- | -------- | 97| codec | 指向视频编码实例的指针。 | 98| index | 对应编码帧的index。 | 99| parameter | 编码参数。 | 100| userData | 开发者执行回调所依赖的数据。 | 101 102 103## 枚举类型说明 104 105 106### OH_VideoEncodeBitrateMode 107 108``` 109enum OH_VideoEncodeBitrateMode 110``` 111**描述** 112视频编码器的码率控制模式。 113 114**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 115 116**起始版本：** 9 117 118**废弃版本：** 14 119 120**替代接口：** [OH_BitrateMode](_codec_base.md#oh_bitratemode-1) 121 122| 枚举值 | 描述 | 123| -------- | -------- | 124| CBR | 恒定码率模式。 | 125| VBR | 可变码率模式。 | 126| CQ | 恒定QP模式。 | 127 128 129## 函数说明 130 131 132### OH_VideoEncoder_Configure() 133 134``` 135OH_AVErrCode OH_VideoEncoder_Configure (OH_AVCodec *codec, OH_AVFormat *format ) 136``` 137**描述** 138配置视频编码器的编码参数，通常需要配置要编码的视频轨的描述信息，如宽、高、像素格式等。必须在调用OH_VideoEncoder_Prepare接口之前，调用此接口。 139 140该接口对配置参数进行合法性校验，部分非法参数不会强校验，使用默认值或直接丢弃。部分非法参数会强校验，具体规则如下： 141 142以下参数的配置范围可通过[能力查询](../../media/avcodec/obtain-supported-codecs.md)获取，OH_MD_KEY_I_FRAME_INTERVAL暂不支持。 143 144设置OH_MD_KEY_VIDEO_ENCODER_ENABLE_TEMPORAL_SCALABILITY、OH_MD_KEY_VIDEO_ENCODER_LTR_FRAME_COUNT接口时如果当前平台不支持，不报错，走正常编码流程。 145 146参数校验： 147 148| Key | 配置正常范围的值 | 配置超出范围的值 | 不配置该参数 | 149| ------------------------------------------------------------------------- | -------- | -------- | ------ | 150| OH_MD_KEY_WIDTH | AV_ERR_OK | AV_ERR_INVALID_VAL | AV_ERR_INVALID_VAL | 151| OH_MD_KEY_HEIGHT | AV_ERR_OK | AV_ERR_INVALID_VAL | AV_ERR_INVALID_VAL | 152| OH_MD_KEY_PIXEL_FORMAT 请参阅[OH_AVPixelFormat](_core.md#oh_avpixelformat-1) | AV_ERR_OK | AV_ERR_UNSUPPORT | AV_ERR_OK | 153| OH_MD_KEY_FRAME_RATE | AV_ERR_OK | AV_ERR_INVALID_VAL |AV_ERR_OK | 154| OH_MD_KEY_PROFILE 请参阅[OH_MD_KEY_PROFILE](_codec_base.md#oh_md_key_profile) | AV_ERR_OK | AV_ERR_INVALID_VAL |AV_ERR_OK | 155| OH_MD_KEY_I_FRAME_INTERVAL | AV_ERR_OK | \\ | AV_ERR_OK | 156 157| OH_MD_KEY_<br>BITRATE | OH_MD_KEY_<br>QUALITY | OH_MD_KEY_<br>VIDEO_ENCODER_BITRATE_MODE | 返回值 | 说明 | 158| :-------------------- | :-------------------- | :--------------------------------------- | ---- | ---------------------- | 159| \\ | \\ | \\ | AV_ERR_OK | 使用编码器默认值 | 160| 超出范围 | 超出范围 | 不支持的模式 | AV_ERR_INVALID_VAL | 异常值均报错 | 161| 正常值 | 正常值 | \\ | AV_ERR_INVALID_VAL | Bitrate 与 Quality 冲突 | 162| 正常值 | \\ | \\ | AV_ERR_OK | 使能默认码控模式 | 163| 正常值 | \\ | BITRATE_MODE_VBR、BITRATE_MODE_CBR | AV_ERR_OK | | 164| 正常值 | \\ | BITRATE_MODE_CQ | AV_ERR_INVALID_VAL | Bitrate 与 CQ 模式冲突 | 165| \\ | 正常值 | \\ | AV_ERR_OK | 使能 CQ 模式 | 166| \\ | 正常值 | BITRATE_MODE_CQ | AV_ERR_OK | | 167| \\ | 正常值 | BITRATE_MODE_VBR、BITRATE_MODE_CBR | AV_ERR_INVALID_VAL | Quality 与 VBR、CBR 模式冲突 | 168| \\ | \\ | BITRATE_MODE_VBR、BITRATE_MODE_CBR | AV_ERR_OK | 使用编码器默认码率 | 169| \\ | \\ | BITRATE_MODE_CQ | AV_ERR_OK | 使用默认quality | 170 171 172**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 173 174**起始版本：** 9 175 176**参数:** 177 178| 名称 | 描述 | 179| -------- | -------- | 180| codec | 指向视频编码实例的指针。 | 181| format | 指向OH_AVFormat的指针，用于给出要编码的视频轨的描述。 | 182 183**返回：** 184 185返回接口结果： 186 187AV_ERR_OK：执行成功。 188 189AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 190 191AV_ERR_INVALID_VAL： 192 193 1. 输入的codec指针为非编码器实例，或者为空指针； 194 2. 输入format参数不支持。 195 196AV_ERR_UNKNOWN：未知错误。 197 198AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 199 200AV_ERR_INVALID_STATE：本接口必须在OH_VideoEncoder_Prepare接口前调用，如果在其他状态时调用，则返回此错误码。 201 202AV_ERR_UNSUPPORT：未支持的功能。 203 204 205### OH_VideoEncoder_CreateByMime() 206 207``` 208OH_AVCodec* OH_VideoEncoder_CreateByMime (const char *mime) 209``` 210**描述** 211根据MIME类型创建视频编码器实例，推荐使用。 212 213**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 214 215**起始版本：** 9 216 217**参数:** 218 219| 名称 | 描述 | 220| -------- | -------- | 221| mime | MIME类型描述字符串，请参阅[AVCODEC_MIMETYPE](_codec_base.md#变量)。 | 222 223**返回：** 224 225成功则返回一个指向视频编码实例的指针。如果输入为不支持的编码器类型或内存不足时，则返回NULL。 226 227 228### OH_VideoEncoder_CreateByName() 229 230``` 231OH_AVCodec* OH_VideoEncoder_CreateByName (const char *name) 232``` 233**描述** 234根据视频编码器名称创建视频编码器实例。使用此接口的前提是知道编码器的确切名称，编码器的名称可以通过能力查询获取。 235 236详情请参见：[获取支持的编解码能力](../../media/avcodec/obtain-supported-codecs.md#创建指定名称的编解码器)。 237 238**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 239 240**起始版本：** 9 241 242**参数:** 243 244| 名称 | 描述 | 245| -------- | -------- | 246| name | 视频编码器名称。 | 247 248**返回：** 249 250成功则返回一个指向视频编码实例的指针。如果输入是不支持编码器名称或者内存资源不足，则返回NULL。 251 252 253### OH_VideoEncoder_Destroy() 254 255``` 256OH_AVErrCode OH_VideoEncoder_Destroy (OH_AVCodec *codec) 257``` 258**描述** 259清理编码器内部资源，销毁编码器实例。不能重复销毁。 260 261**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 262 263**起始版本：** 9 264 265**参数:** 266 267| 名称 | 描述 | 268| -------- | -------- | 269| codec | 指向视频编码实例的指针。 | 270 271**返回：** 272 273返回接口结果： 274 275AV_ERR_OK：执行成功。 276 277AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 278 279AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 280 281AV_ERR_UNKNOWN：未知错误。 282 283AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 284 285 286### OH_VideoEncoder_Flush() 287 288``` 289OH_AVErrCode OH_VideoEncoder_Flush (OH_AVCodec *codec) 290``` 291**描述** 292 293清除编码器中缓存的输入和输出数据及参数集如H.264格式的PPS/SPS。 294 295调用此接口后，以前通过异步回调上报的所有缓冲区index都将失效，请确保不要访问这些index对应的缓冲区。该接口不能连续调用。 296 297**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 298 299**起始版本：** 9 300 301**参数:** 302 303| 名称 | 描述 | 304| -------- | -------- | 305| codec | 指向视频编码实例的指针。 | 306 307**返回：** 308 309返回接口结果： 310 311AV_ERR_OK：执行成功。 312 313AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 314 315AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 316 317AV_ERR_UNKNOWN：未知错误。 318 319AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 320 321AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 322 323 324### OH_VideoEncoder_FreeOutputBuffer() 325 326``` 327OH_AVErrCode OH_VideoEncoder_FreeOutputBuffer (OH_AVCodec *codec, uint32_t index ) 328``` 329**描述** 330将处理后的index对应的OH_AVBuffer退回给编码器。开发者使用完需要及时调用此接口释放输出缓存区，否则会阻塞编码流程。 331 332详情请参见：[视频编码](../../media/avcodec/video-encoding.md) “Surface模式的步骤-13或Buffer模式步骤-10”。 333 334**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 335 336**起始版本：** 11 337 338**参数:** 339 340| 名称 | 描述 | 341| -------- | -------- | 342| codec | 指向视频编码实例的指针。 | 343| index | 输出缓冲区对应的索引值。 由[OH_AVCodecOnNewOutputBuffer](_codec_base.md#oh_avcodeconnewoutputbuffer)给出。 | 344 345**返回：** 346 347返回接口结果： 348 349AV_ERR_OK：执行成功。 350 351AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 352 353AV_ERR_INVALID_VAL： 354 355 1. 输入的codec指针为非编码器实例，或者为空指针； 356 2. 输入format参数不支持； 357 3. index非法或者连续给同一个index，该错误不影响后续编码流程。 358 359AV_ERR_UNKNOWN：未知错误。 360 361AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 362 363AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 364 365 366### OH_VideoEncoder_GetInputDescription() 367 368``` 369OH_AVFormat* OH_VideoEncoder_GetInputDescription (OH_AVCodec *codec) 370``` 371**描述** 372编码器接收到的图像的描述信息。调用[OH_VideoEncoder_Configure](#oh_videoencoder_configure)后调用此接口。 373 374需要注意的是，返回指针所指向的OH_AVFormat实例的生命周期需要由开发者通过调用OH_AVFormat_Destroy接口释放，请参阅[OH_AVFormat_Destroy](_core.md#oh_avformat_destroy)。 375 376**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 377 378**起始版本：** 10 379 380**参数:** 381 382| 名称 | 描述 | 383| -------- | -------- | 384| codec | 指向视频编码实例的指针。 | 385 386**返回：** 387 388返回指向OH_AVFormat实例的指针。当codec指针非编码实例，或者为空指针，则返回NULL。 389 390 391### OH_VideoEncoder_GetOutputDescription() 392 393``` 394OH_AVFormat* OH_VideoEncoder_GetOutputDescription (OH_AVCodec *codec) 395``` 396**描述** 397获取编码器输出数据的OH_AVFormat信息。 398 399需要注意的是，返回值指向的OH_AVFormat实例的生命周期需要开发者通过调用接口[OH_AVFormat_Destroy](_core.md#oh_avformat_destroy)释放。 400 401**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 402 403**起始版本：** 9 404 405**参数:** 406 407| 名称 | 描述 | 408| -------- | -------- | 409| codec | 指向视频编码实例的指针。 | 410 411**返回：** 412 413返回指向OH_AVFormat实例的指针。当输入的codec指针非编码实例，或者为空指针，则返回NULL。 414 415 416### OH_VideoEncoder_GetSurface() 417 418``` 419OH_AVErrCode OH_VideoEncoder_GetSurface (OH_AVCodec *codec, OHNativeWindow ** window ) 420``` 421**描述** 422从视频编码器获取输入surface，必须在调用OH_VideoEncoder_Configure接口之后OH_VideoEncoder_Prepare接口之前调用此接口。 423 424**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 425 426**起始版本：** 9 427 428**参数:** 429 430| 名称 | 描述 | 431| -------- | -------- | 432| codec | 指向视频编码实例的指针。 | 433| window | 指向OHNativeWindow实例的指针，请参阅[OHNativeWindow](_codec_base.md#ohnativewindow)。 应用负责管理window的生命周期，结束时调用OH_NativeWindow_DestroyNativeWindow释放。 | 434 435**返回：** 436 437返回接口结果： 438 439AV_ERR_OK：执行成功。 440 441AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 442 443AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 444 445 446### OH_VideoEncoder_IsValid() 447 448``` 449OH_AVErrCode OH_VideoEncoder_IsValid (OH_AVCodec *codec, bool *isValid ) 450``` 451**描述** 452在编码器实例存在的情况下，检查当前编码器服务是否有效。 453 454**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 455 456**起始版本：** 10 457 458**参数:** 459 460| 名称 | 描述 | 461| -------- | -------- | 462| codec | 指向视频编码实例的指针。 | 463| isValid | 输出参数，指向布尔类型的指针。只有当接口返回AV_ERR_OK时，该值表示编码器服务的有效性（true为有效，false为无效）。建议开发者将isValid初始化为false。 | 464 465**返回：** 466 467返回接口结果： 468 469AV_ERR_OK：执行成功。 470 471AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 472 473 474### OH_VideoEncoder_NotifyEndOfStream() 475 476``` 477OH_AVErrCode OH_VideoEncoder_NotifyEndOfStream (OH_AVCodec *codec) 478``` 479**描述** 480通知视频编码器输入流已结束。建议使用此接口进行通知。该接口只在Surface模式下使用，Buffer模式通过OH_AVBuffer携带EOS信息，通知输入流的结束。 481 482**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 483 484**起始版本：** 9 485 486**参数:** 487 488| 名称 | 描述 | 489| -------- | -------- | 490| codec | 指向视频编码实例的指针。 | 491 492**返回：** 493 494返回接口结果： 495 496AV_ERR_OK：执行成功。 497 498AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 499 500AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 501 502AV_ERR_UNKNOWN：未知错误。 503 504AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 505 506AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 507 508 509### OH_VideoEncoder_Prepare() 510 511``` 512OH_AVErrCode OH_VideoEncoder_Prepare (OH_AVCodec *codec) 513``` 514**描述** 515准备编码器的内部资源，在OH_VideoEncoder_Configure接口后调用。 516 517**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 518 519**起始版本：** 9 520 521**参数:** 522 523| 名称 | 描述 | 524| -------- | -------- | 525| codec | 指向视频编码实例的指针。 | 526 527**返回：** 528 529返回接口结果： 530 531AV_ERR_OK：执行成功。 532 533AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 534 535AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 536 537 538### OH_VideoEncoder_PushInputBuffer() 539 540``` 541OH_AVErrCode OH_VideoEncoder_PushInputBuffer (OH_AVCodec *codec, uint32_t index ) 542``` 543**描述** 544Buffer模式下，将index对应的OH_AVBuffer送入编码器编码。 545 546**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 547 548**起始版本：** 11 549 550**参数:** 551 552| 名称 | 描述 | 553| -------- | -------- | 554| codec | 指向视频编码实例的指针。 | 555| index | 输入缓冲区对应的索引值。由[OH_AVCodecOnNeedInputBuffer](_codec_base.md#oh_avcodeconneedinputbuffer)给出。 | 556 557**返回：** 558 559返回接口结果： 560 561AV_ERR_OK：执行成功。 562 563AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 564 565AV_ERR_INVALID_VAL： 566 567 1. 输入的codec指针为非编码器实例，或者为空指针； 568 2. 输入format参数不支持。 569 570AV_ERR_UNKNOWN：未知错误。 571 572AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 573 574AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 575 576 577### OH_VideoEncoder_PushInputParameter() 578 579``` 580OH_AVErrCode OH_VideoEncoder_PushInputParameter (OH_AVCodec *codec, uint32_t index) 581``` 582**描述** 583Surface模式下，将index对应帧的编码参数送入编码器编码。 584 585**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 586 587**起始版本：** 12 588 589**参数:** 590 591| 名称 | 描述 | 592| -------- | -------- | 593| codec | 指向视频编码实例的指针。 | 594| index | 输入参数缓冲区对应的索引值。由[OH_VideoEncoder_OnNeedInputParameter](#oh_videoencoder_onneedinputparameter)给出。 | 595 596**返回：** 597 598返回接口结果： 599 600AV_ERR_OK：执行成功。 601 602AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 603 604AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 605 606AV_ERR_UNKNOWN：未知错误。 607 608AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 609 610AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 611 612 613### OH_VideoEncoder_RegisterCallback() 614 615``` 616OH_AVErrCode OH_VideoEncoder_RegisterCallback (OH_AVCodec *codec, OH_AVCodecCallback callback, void *userData ) 617``` 618**描述** 619注册OH_AVCodecCallback回调函数，让应用可以响应视频编码器生成的事件。在调用OH_VideoEncoder_Prepare接口之前，必须调用此接口。 620 621**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 622 623**起始版本：** 11 624 625**参数:** 626 627| 名称 | 描述 | 628| -------- | -------- | 629| codec | 指向视频编码实例的指针。 | 630| callback | 所有回调函数的集合，请参阅[OH_AVCodecCallback](_o_h___a_v_codec_callback.md)。 | 631| userData | 开发者执行回调所依赖的数据。 | 632 633**返回：** 634 635返回接口结果： 636 637AV_ERR_OK：执行成功。 638 639AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 640 641AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 642 643AV_ERR_UNKNOWN：未知错误。 644 645AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 646 647AV_ERR_INVALID_STATE：本接口必须在OH_VideoEncoder_Prepare接口前调用，如果在其他状态时调用，则返回此错误码。 648 649 650### OH_VideoEncoder_RegisterParameterCallback() 651 652``` 653OH_AVErrCode OH_VideoEncoder_RegisterParameterCallback (OH_AVCodec *codec, OH_VideoEncoder_OnNeedInputParameter onInputParameter, void *userData) 654``` 655**描述** 656注册OH_AVCodecCallback输入参数回调函数，让应用可以响应视频编码器生成的事件。编码Surface模式，需要设置随帧参数时，须使用该接口。 657 658如果使用该接口，必须在[OH_VideoEncoder_Configure](#oh_videoencoder_configure)之前调用该接口。 659 660**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 661 662**起始版本：** 12 663 664**参数:** 665 666| 名称 | 描述 | 667| -------- | -------- | 668| codec | 指向视频编码实例的指针。 | 669| onInputParameter | 输入参数回调指针，请参阅[OH_VideoEncoder_OnNeedInputParameter](#oh_videoencoder_onneedinputparameter)。 | 670| userData | 开发者执行回调所依赖的数据。 | 671 672**返回：** 673 674返回接口结果： 675 676AV_ERR_OK：执行成功。 677 678AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 679 680AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 681 682AV_ERR_UNKNOWN：未知错误。 683 684AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 685 686AV_ERR_INVALID_STATE：本接口必须在OH_VideoEncoder_Prepare接口前调用，如果在其他状态时调用，则返回此错误码。 687 688 689### OH_VideoEncoder_Reset() 690 691``` 692OH_AVErrCode OH_VideoEncoder_Reset (OH_AVCodec *codec) 693``` 694**描述** 695重置编码器，编码器回到初始化状态。如果要继续编码，需要再次调用OH_VideoEncoder_Configure接口配置编码器实例。 696 697**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 698 699**起始版本：** 9 700 701**参数:** 702 703| 名称 | 描述 | 704| -------- | -------- | 705| codec | 指向视频编码实例的指针。 | 706 707**返回：** 708 709返回接口结果： 710 711AV_ERR_OK：执行成功。 712 713AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 714 715AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 716 717AV_ERR_UNKNOWN：未知错误。 718 719AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 720 721 722### OH_VideoEncoder_SetParameter() 723 724``` 725OH_AVErrCode OH_VideoEncoder_SetParameter (OH_AVCodec *codec, OH_AVFormat *format ) 726``` 727**描述** 728在编码器运行时设置编码器参数。 729 730注意，此接口只有在编码器启动后才能调用。 同时，不正确的参数设置可能会导致编码失败。 731 732**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 733 734**起始版本：** 9 735 736**参数:** 737 738| 名称 | 描述 | 739| -------- | -------- | 740| codec | 指向视频编码实例的指针。 | 741| format | 指向OH_AVFormat实例的指针。 | 742 743**返回：** 744 745返回接口结果： 746 747AV_ERR_OK：执行成功。 748 749AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 750 751AV_ERR_INVALID_VAL： 752 753 1. 输入的codec指针为非编码器实例，或者为空指针； 754 2. 输入format参数不支持。 755 756AV_ERR_UNKNOWN：未知错误。 757 758AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 759 760AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 761 762 763### OH_VideoEncoder_Start() 764 765``` 766OH_AVErrCode OH_VideoEncoder_Start (OH_AVCodec *codec) 767``` 768**描述** 769调用OH_VideoEncoder_Prepare接口成功后调用此接口启动解码器。成功启动后，编码器将开始报告注册的回调事件。 770 771Surface模式下，在surface中有正确的输入后，每完成一帧编码会触发OnNewOutputBuffer。 772 773Buffer模式下，编码器会立即触发输入回调，开发者每完成一次输入，编码器执行编码，每完成一帧编码会触发OnNewOutputBuffer。 774 775**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 776 777**起始版本：** 9 778 779**参数:** 780 781| 名称 | 描述 | 782| -------- | -------- | 783| codec | 指向视频编码实例的指针。 | 784 785**返回：** 786 787返回接口结果： 788 789AV_ERR_OK：执行成功。 790 791AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 792 793AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 794 795AV_ERR_UNKNOWN：未知错误。 796 797AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 798 799AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 800 801 802### OH_VideoEncoder_Stop() 803 804``` 805OH_AVErrCode OH_VideoEncoder_Stop (OH_AVCodec *codec) 806``` 807**描述** 808停止编码器，释放输入输出buffer。停止之后，可以通过调用OH_VideoEncoder_Start接口重新进入Running状态。 809 810**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 811 812**起始版本：** 9 813 814**参数:** 815 816| 名称 | 描述 | 817| -------- | -------- | 818| codec | 指向视频编码实例的指针。 | 819 820**返回：** 821 822返回接口结果： 823 824AV_ERR_OK：执行成功。 825 826AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 827 828AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 829 830AV_ERR_UNKNOWN：未知错误。 831 832AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 833 834AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 835 836 837## 废弃函数说明 838 839 840### OH_VideoEncoder_SetCallback() 841 842``` 843OH_AVErrCode OH_VideoEncoder_SetCallback (OH_AVCodec *codec, OH_AVCodecAsyncCallback callback, void *userData ) 844``` 845**描述** 846设置OH_AVCodecCallback回调函数，让应用可以响应视频编码器生成的事件。在调用OH_VideoEncoder_Prepare接口之前，必须调用此接口。 847 848**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 849 850**起始版本：** 9 851 852**废弃版本：** 11 853 854**替代接口：**[OH_VideoEncoder_RegisterCallback](#oh_videoencoder_registercallback) 855 856**参数:** 857 858| 名称 | 描述 | 859| -------- | -------- | 860| codec | 指向视频编码实例的指针。 | 861| callback | 所有回调函数的集合，请参阅[OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md)。 | 862| userData | 开发者执行回调所依赖的数据。 | 863 864**返回：** 865 866返回接口结果： 867 868AV_ERR_OK：执行成功。 869 870AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 871 872AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 873 874AV_ERR_UNKNOWN：未知错误。 875 876AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 877 878AV_ERR_INVALID_STATE：本接口必须在OH_VideoEncoder_Prepare接口前调用，如果在其他状态时调用，则返回此错误码。 879 880 881### OH_VideoEncoder_PushInputData() 882 883``` 884OH_AVErrCode OH_VideoEncoder_PushInputData (OH_AVCodec *codec, uint32_t index, OH_AVCodecBufferAttr attr ) 885``` 886**描述** 887将填入数据的输入缓冲区提交给视频编码器。 888 889**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 890 891**起始版本：** 10 892 893**废弃版本：** 11 894 895**替代接口：**[OH_VideoEncoder_PushInputBuffer](#oh_videoencoder_pushinputbuffer) 896 897**参数:** 898 899| 名称 | 描述 | 900| -------- | -------- | 901| codec | 指向视频编码实例的指针。 | 902| index | 输入缓冲区对应的索引值。由[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)给出。 | 903| attr | 缓冲区中包含数据的描述信息。 | 904 905**返回：** 906 907返回接口结果： 908 909AV_ERR_OK：执行成功。 910 911AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 912 913AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 914 915AV_ERR_UNKNOWN：未知错误。 916 917AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 918 919AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 920 921 922### OH_VideoEncoder_FreeOutputData() 923 924``` 925OH_AVErrCode OH_VideoEncoder_FreeOutputData (OH_AVCodec *codec, uint32_t index ) 926``` 927**描述** 928将处理后的输出缓冲区返回给编码器。 929 930**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 931 932**起始版本：** 9 933 934**废弃版本：** 11 935 936**替代接口：**[OH_VideoEncoder_FreeOutputBuffer](#oh_videoencoder_freeoutputbuffer) 937 938**参数:** 939 940| 名称 | 描述 | 941| -------- | -------- | 942| codec | 指向视频编码实例的指针。 | 943| index | 输出缓冲区对应的索引值。由[OH_AVCodecOnNewOutputData](_codec_base.md#oh_avcodeconnewoutputdata)给出。 | 944 945**返回：** 946 947返回接口结果： 948 949AV_ERR_OK：执行成功。 950 951AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 952 953AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 954 955AV_ERR_UNKNOWN：未知错误。 956 957AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 958 959AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。
