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) | 清除编码器中缓存的输入和输出数据及参数集如H264格式的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) | 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| 正常值 | \\ | VBR、CBR | AV_ERR_OK | | 164| 正常值 | \\ | CQ | AV_ERR_INVALID_VAL | Bitrate 与 CQ 模式冲突 | 165| \\ | 正常值 | \\ | AV_ERR_OK | 使能 CQ 模式 | 166| \\ | 正常值 | CQ | AV_ERR_OK | | 167| \\ | 正常值 | VBR、CBR | AV_ERR_INVALID_VAL | Quality 与 VBR、CBR 模式冲突 | 168| \\ | \\ | VBR、CBR | AV_ERR_OK | 使用编码器默认码率 | 169| \\ | \\ | 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 202 203### OH_VideoEncoder_CreateByMime() 204 205``` 206OH_AVCodec* OH_VideoEncoder_CreateByMime (const char *mime) 207``` 208**描述** 209根据MIME类型创建视频编码器实例，推荐使用。 210 211**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 212 213**起始版本：** 9 214 215**参数:** 216 217| 名称 | 描述 | 218| -------- | -------- | 219| mime | MIME类型描述字符串，请参阅[AVCODEC_MIMETYPE](_codec_base.md#变量)。 | 220 221**返回：** 222 223成功则返回一个指向视频编码实例的指针。如果输入为不支持的编码器类型或内存不足时，则返回NULL。 224 225 226### OH_VideoEncoder_CreateByName() 227 228``` 229OH_AVCodec* OH_VideoEncoder_CreateByName (const char *name) 230``` 231**描述** 232根据视频编码器名称创建视频编码器实例。使用此接口的前提是知道编码器的确切名称，编码器的名称可以通过能力查询获取。 233 234详情请参见：[获取支持的编解码能力](../../media/avcodec/obtain-supported-codecs.md#创建指定名称的编解码器)。 235 236**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 237 238**起始版本：** 9 239 240**参数:** 241 242| 名称 | 描述 | 243| -------- | -------- | 244| name | 视频编码器名称。 | 245 246**返回：** 247 248成功则返回一个指向视频编码实例的指针。如果输入是不支持编码器名称或者内存资源不足，则返回NULL。 249 250 251### OH_VideoEncoder_Destroy() 252 253``` 254OH_AVErrCode OH_VideoEncoder_Destroy (OH_AVCodec *codec) 255``` 256**描述** 257清理编码器内部资源，销毁编码器实例。不能重复销毁。 258 259**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 260 261**起始版本：** 9 262 263**参数:** 264 265| 名称 | 描述 | 266| -------- | -------- | 267| codec | 指向视频编码实例的指针。 | 268 269**返回：** 270 271返回接口结果： 272 273AV_ERR_OK：执行成功。 274 275AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 276 277AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 278 279AV_ERR_UNKNOWN：未知错误。 280 281AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 282 283 284### OH_VideoEncoder_Flush() 285 286``` 287OH_AVErrCode OH_VideoEncoder_Flush (OH_AVCodec *codec) 288``` 289**描述** 290 291清除编码器中缓存的输入和输出数据及参数集如H264格式的PPS/SPS。 292 293调用此接口后，以前通过异步回调上报的所有缓冲区index都将失效，请确保不要访问这些index对应的缓冲区。该接口不能连续调用。 294 295**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 296 297**起始版本：** 9 298 299**参数:** 300 301| 名称 | 描述 | 302| -------- | -------- | 303| codec | 指向视频编码实例的指针。 | 304 305**返回：** 306 307返回接口结果： 308 309AV_ERR_OK：执行成功。 310 311AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 312 313AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 314 315AV_ERR_UNKNOWN：未知错误。 316 317AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 318 319AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 320 321 322### OH_VideoEncoder_FreeOutputBuffer() 323 324``` 325OH_AVErrCode OH_VideoEncoder_FreeOutputBuffer (OH_AVCodec *codec, uint32_t index ) 326``` 327**描述** 328将处理后的index对应的OH_AVBuffer退回给编码器。调用者使用完需要及时调用此接口释放输出缓存区，否则会阻塞编码流程。 329 330详情请参见：[视频编码](../../media/avcodec/video-encoding.md) “Surface模式的步骤-14或Buffer模式步骤-10”。 331 332**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 333 334**起始版本：** 11 335 336**参数:** 337 338| 名称 | 描述 | 339| -------- | -------- | 340| codec | 指向视频编码实例的指针。 | 341| index | 输出缓冲区对应的索引值。 由[OH_AVCodecOnNewOutputBuffer](_codec_base.md#oh_avcodeconnewoutputbuffer)给出。 | 342 343**返回：** 344 345返回接口结果： 346 347AV_ERR_OK：执行成功。 348 349AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 350 351AV_ERR_INVALID_VAL： 352 353 1. 输入的codec指针为非编码器实例，或者为空指针； 354 2. 输入format参数不支持； 355 3. index非法或者连续给同一个index，该错误不影响后续编码流程 356 357AV_ERR_UNKNOWN：未知错误。 358 359AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 360 361AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 362 363 364### OH_VideoEncoder_GetInputDescription() 365 366``` 367OH_AVFormat* OH_VideoEncoder_GetInputDescription (OH_AVCodec *codec) 368``` 369**描述** 370编码器接收到的图像的描述信息。调用[OH_VideoEncoder_Configure](#oh_videoencoder_configure)后调用此接口。 371 372需要注意的是，返回指针所指向的OH_AVFormat实例的生命周期需要由调用者通过调用OH_AVFormat_Destroy接口释放，请参阅[OH_AVFormat_Destroy](_core.md#oh_avformat_destroy)。 373 374**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 375 376**起始版本：** 10 377 378**参数:** 379 380| 名称 | 描述 | 381| -------- | -------- | 382| codec | 指向视频编码实例的指针。 | 383 384**返回：** 385 386返回指向OH_AVFormat实例的指针。当codec指针非编码实例，或者为空指针，则返回NULL。 387 388 389### OH_VideoEncoder_GetOutputDescription() 390 391``` 392OH_AVFormat* OH_VideoEncoder_GetOutputDescription (OH_AVCodec *codec) 393``` 394**描述** 395获取编码器输出数据的OH_AVFormat信息。 396 397需要注意的是，返回值指向的OH_AVFormat实例的生命周期需要调用者通过调用接口[OH_AVFormat_Destroy](_core.md#oh_avformat_destroy)释放。 398 399**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 400 401**起始版本：** 9 402 403**参数:** 404 405| 名称 | 描述 | 406| -------- | -------- | 407| codec | 指向视频编码实例的指针。 | 408 409**返回：** 410 411返回指向OH_AVFormat实例的指针。当输入的codec指针非编码实例，或者为空指针，则返回NULL。 412 413 414### OH_VideoEncoder_GetSurface() 415 416``` 417OH_AVErrCode OH_VideoEncoder_GetSurface (OH_AVCodec *codec, OHNativeWindow ** window ) 418``` 419**描述** 420从视频编码器获取输入surface，必须在调用OH_VideoEncoder_Configure接口之后OH_VideoEncoder_Prepare接口之前调用此接口。 421 422**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 423 424**起始版本：** 9 425 426**参数:** 427 428| 名称 | 描述 | 429| -------- | -------- | 430| codec | 指向视频编码实例的指针。 | 431| window | 指向OHNativeWindow实例的指针, 请参阅[OHNativeWindow](_codec_base.md#ohnativewindow)。 应用负责管理window的生命周期，结束时调用OH_NativeWindow_DestroyNativeWindow释放。 | 432 433**返回：** 434 435返回接口结果： 436 437AV_ERR_OK：执行成功。 438 439AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 440 441AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 442 443 444### OH_VideoEncoder_IsValid() 445 446``` 447OH_AVErrCode OH_VideoEncoder_IsValid (OH_AVCodec *codec, bool *isValid ) 448``` 449**描述** 450检查当前编码实例是否有效。 451 452**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 453 454**起始版本：** 10 455 456**参数:** 457 458| 名称 | 描述 | 459| -------- | -------- | 460| codec | 指向视频编码实例的指针。 | 461| isValid | 输出参数，指向布尔类型的指针。指向布尔实例的指针，如果编码器实例有效，则为true，如果编码器实例无效，则为false。建议调用者将isValid初始化为false。 | 462 463**返回：** 464 465返回接口结果： 466 467AV_ERR_OK：执行成功。 468 469AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 470 471 472### OH_VideoEncoder_NotifyEndOfStream() 473 474``` 475OH_AVErrCode OH_VideoEncoder_NotifyEndOfStream (OH_AVCodec *codec) 476``` 477**描述** 478通知视频编码器输入流已结束。建议使用此接口进行通知。该接口只在Surface模式下使用，Buffer模式通过OH_AVBuffer携带EOS信息，通知输入流的结束。 479 480**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 481 482**起始版本：** 9 483 484**参数:** 485 486| 名称 | 描述 | 487| -------- | -------- | 488| codec | 指向视频编码实例的指针。 | 489 490**返回：** 491 492返回接口结果： 493 494AV_ERR_OK：执行成功。 495 496AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 497 498AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 499 500AV_ERR_UNKNOWN：未知错误。 501 502AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 503 504AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 505 506 507### OH_VideoEncoder_Prepare() 508 509``` 510OH_AVErrCode OH_VideoEncoder_Prepare (OH_AVCodec *codec) 511``` 512**描述** 513准备编码器的内部资源，在OH_VideoEncoder_Configure接口后调用。 514 515**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 516 517**起始版本：** 9 518 519**参数:** 520 521| 名称 | 描述 | 522| -------- | -------- | 523| codec | 指向视频编码实例的指针。 | 524 525**返回：** 526 527返回接口结果： 528 529AV_ERR_OK：执行成功。 530 531AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 532 533AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 534 535 536### OH_VideoEncoder_PushInputBuffer() 537 538``` 539OH_AVErrCode OH_VideoEncoder_PushInputBuffer (OH_AVCodec *codec, uint32_t index ) 540``` 541**描述** 542Buffer模式下，将index对应的OH_AVBuffer送入编码器编码。 543 544**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 545 546**起始版本：** 11 547 548**参数:** 549 550| 名称 | 描述 | 551| -------- | -------- | 552| codec | 指向视频编码实例的指针。 | 553| index | 输入缓冲区对应的索引值。由[OH_AVCodecOnNeedInputBuffer](_codec_base.md#oh_avcodeconneedinputbuffer)给出。 | 554 555**返回：** 556 557返回接口结果： 558 559AV_ERR_OK：执行成功。 560 561AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 562 563AV_ERR_INVALID_VAL： 564 565 1. 输入的codec指针为非编码器实例，或者为空指针； 566 2. 输入format参数不支持。 567 568AV_ERR_UNKNOWN：未知错误。 569 570AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 571 572AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 573 574 575### OH_VideoEncoder_PushInputParameter() 576 577``` 578OH_AVErrCode OH_VideoEncoder_PushInputParameter (OH_AVCodec *codec, uint32_t index) 579``` 580**描述** 581Surface模式下，将index对应帧的编码参数送入编码器编码。 582 583**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 584 585**起始版本：** 12 586 587**参数:** 588 589| 名称 | 描述 | 590| -------- | -------- | 591| codec | 指向视频编码实例的指针。 | 592| index | 输入参数缓冲区对应的索引值。由[OH_VideoEncoder_OnNeedInputParameter](#oh_videoencoder_onneedinputparameter)给出。 | 593 594**返回：** 595 596返回接口结果： 597 598AV_ERR_OK：执行成功。 599 600AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 601 602AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 603 604AV_ERR_UNKNOWN：未知错误。 605 606AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 607 608AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 609 610 611### OH_VideoEncoder_RegisterCallback() 612 613``` 614OH_AVErrCode OH_VideoEncoder_RegisterCallback (OH_AVCodec *codec, OH_AVCodecCallback callback, void *userData ) 615``` 616**描述** 617注册OH_AVCodecCallback回调函数，让应用可以响应视频编码器生成的事件。在调用OH_VideoEncoder_Prepare接口之前，必须调用此接口。 618 619**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 620 621**起始版本：** 11 622 623**参数:** 624 625| 名称 | 描述 | 626| -------- | -------- | 627| codec | 指向视频编码实例的指针。 | 628| callback | 所有回调函数的集合，请参阅[OH_AVCodecCallback](_o_h___a_v_codec_callback.md)。 | 629| userData | 调用者执行回调所依赖的数据。 | 630 631**返回：** 632 633返回接口结果： 634 635AV_ERR_OK：执行成功。 636 637AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 638 639AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 640 641AV_ERR_UNKNOWN：未知错误。 642 643AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 644 645AV_ERR_INVALID_STATE：本接口必须在OH_VideoEncoder_Prepare接口前调用，如果在其他状态时调用，则返回此错误码。 646 647 648### OH_VideoEncoder_RegisterParameterCallback() 649 650``` 651OH_AVErrCode OH_VideoEncoder_RegisterParameterCallback (OH_AVCodec *codec, OH_VideoEncoder_OnNeedInputParameter onInputParameter, void *userData) 652``` 653**描述** 654注册OH_AVCodecCallback输入参数回调函数，让应用可以响应视频编码器生成的事件。编码Surface模式，需要设置随帧参数时，须使用该接口。 655 656如果使用该接口，必须在[OH_VideoEncoder_Configure](#oh_videoencoder_configure)之前调用该接口。 657 658**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 659 660**起始版本：** 12 661 662**参数:** 663 664| 名称 | 描述 | 665| -------- | -------- | 666| codec | 指向视频编码实例的指针。 | 667| onInputParameter | 输入参数回调指针, 请参阅[OH_VideoEncoder_OnNeedInputParameter](#oh_videoencoder_onneedinputparameter)。 | 668| userData | 调用者执行回调所依赖的数据。 | 669 670**返回：** 671 672返回接口结果： 673 674AV_ERR_OK：执行成功。 675 676AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 677 678AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 679 680AV_ERR_UNKNOWN：未知错误。 681 682AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 683 684AV_ERR_INVALID_STATE：本接口必须在OH_VideoEncoder_Prepare接口前调用，如果在其他状态时调用，则返回此错误码。 685 686 687### OH_VideoEncoder_Reset() 688 689``` 690OH_AVErrCode OH_VideoEncoder_Reset (OH_AVCodec *codec) 691``` 692**描述** 693重置编码器，编码器回到初始化状态。如果要继续编码，需要再次调用OH_VideoEncoder_Configure接口配置编码器实例。 694 695**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 696 697**起始版本：** 9 698 699**参数:** 700 701| 名称 | 描述 | 702| -------- | -------- | 703| codec | 指向视频编码实例的指针。 | 704 705**返回：** 706 707返回接口结果： 708 709AV_ERR_OK：执行成功。 710 711AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 712 713AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 714 715AV_ERR_UNKNOWN：未知错误。 716 717AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 718 719 720### OH_VideoEncoder_SetParameter() 721 722``` 723OH_AVErrCode OH_VideoEncoder_SetParameter (OH_AVCodec *codec, OH_AVFormat *format ) 724``` 725**描述** 726在编码器运行时设置编码器参数。 727 728注意，此接口只有在编码器启动后才能调用。 同时，不正确的参数设置可能会导致编码失败。 729 730**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 731 732**起始版本：** 9 733 734**参数:** 735 736| 名称 | 描述 | 737| -------- | -------- | 738| codec | 指向视频编码实例的指针。 | 739| format | 指向OH_AVFormat实例的指针。 | 740 741**返回：** 742 743返回接口结果： 744 745AV_ERR_OK：执行成功。 746 747AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 748 749AV_ERR_INVALID_VAL： 750 751 1. 输入的codec指针为非编码器实例，或者为空指针； 752 2. 输入format参数不支持。 753 754AV_ERR_UNKNOWN：未知错误。 755 756AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 757 758AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 759 760 761### OH_VideoEncoder_Start() 762 763``` 764OH_AVErrCode OH_VideoEncoder_Start (OH_AVCodec *codec) 765``` 766**描述** 767调用OH_VideoEncoder_Prepare接口成功后调用此接口启动解码器。成功启动后，编码器将开始报告注册的回调事件。 768 769Surface模式下，在surface中有正确的输入后，每完成一帧编码会触发OnNewOutputBuffer。 770 771Buffer模式下，编码器会立即触发输入回调，调用者每完成一次输入，编码器执行编码，每完成一帧编码会触发OnNewOutputBuffer。 772 773**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 774 775**起始版本：** 9 776 777**参数:** 778 779| 名称 | 描述 | 780| -------- | -------- | 781| codec | 指向视频编码实例的指针。 | 782 783**返回：** 784 785返回接口结果： 786 787AV_ERR_OK：执行成功。 788 789AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 790 791AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 792 793AV_ERR_UNKNOWN：未知错误。 794 795AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 796 797AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 798 799 800### OH_VideoEncoder_Stop() 801 802``` 803OH_AVErrCode OH_VideoEncoder_Stop (OH_AVCodec *codec) 804``` 805**描述** 806停止编码器，释放输入输出buffer。停止之后，可以通过调用OH_VideoEncoder_Start接口重新进入Running状态。 807 808**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 809 810**起始版本：** 9 811 812**参数:** 813 814| 名称 | 描述 | 815| -------- | -------- | 816| codec | 指向视频编码实例的指针。 | 817 818**返回：** 819 820返回接口结果： 821 822AV_ERR_OK：执行成功。 823 824AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 825 826AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 827 828AV_ERR_UNKNOWN：未知错误。 829 830AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 831 832AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 833 834 835## 废弃函数说明 836 837 838### OH_VideoEncoder_SetCallback() 839 840``` 841OH_AVErrCode OH_VideoEncoder_SetCallback (OH_AVCodec *codec, OH_AVCodecAsyncCallback callback, void *userData ) 842``` 843**描述** 844设置OH_AVCodecCallback回调函数，让应用可以响应视频编码器生成的事件。在调用OH_VideoEncoder_Prepare接口之前，必须调用此接口。 845 846**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 847 848**起始版本：** 9 849 850**废弃版本：** 11 851 852**替代接口：**[OH_VideoEncoder_RegisterCallback](#oh_videoencoder_registercallback) 853 854**参数:** 855 856| 名称 | 描述 | 857| -------- | -------- | 858| codec | 指向视频编码实例的指针。 | 859| callback | 所有回调函数的集合，请参阅[OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md)。 | 860| userData | 调用者执行回调所依赖的数据。 | 861 862**返回：** 863 864返回接口结果： 865 866AV_ERR_OK：执行成功。 867 868AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 869 870AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 871 872AV_ERR_UNKNOWN：未知错误。 873 874AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 875 876AV_ERR_INVALID_STATE：本接口必须在OH_VideoEncoder_Prepare接口前调用，如果在其他状态时调用，则返回此错误码。 877 878 879### OH_VideoEncoder_PushInputData() 880 881``` 882OH_AVErrCode OH_VideoEncoder_PushInputData (OH_AVCodec *codec, uint32_t index, OH_AVCodecBufferAttr attr ) 883``` 884**描述** 885将填入数据的输入缓冲区提交给视频编码器。 886 887**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 888 889**起始版本：** 10 890 891**废弃版本：** 11 892 893**替代接口：**[OH_VideoEncoder_PushInputBuffer](#oh_videoencoder_pushinputbuffer) 894 895**参数:** 896 897| 名称 | 描述 | 898| -------- | -------- | 899| codec | 指向视频编码实例的指针。 | 900| index | 输入缓冲区对应的索引值。由[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)给出。 | 901| attr | 缓冲区中包含数据的描述信息。 | 902 903**返回：** 904 905返回接口结果： 906 907AV_ERR_OK：执行成功。 908 909AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 910 911AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 912 913AV_ERR_UNKNOWN：未知错误。 914 915AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 916 917AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 918 919 920### OH_VideoEncoder_FreeOutputData() 921 922``` 923OH_AVErrCode OH_VideoEncoder_FreeOutputData (OH_AVCodec *codec, uint32_t index ) 924``` 925**描述** 926将处理后的输出缓冲区返回给编码器。 927 928**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 929 930**起始版本：** 9 931 932**废弃版本：** 11 933 934**替代接口：**[OH_VideoEncoder_FreeOutputBuffer](#oh_videoencoder_freeoutputbuffer) 935 936**参数:** 937 938| 名称 | 描述 | 939| -------- | -------- | 940| codec | 指向视频编码实例的指针。 | 941| index | 输出缓冲区对应的索引值。由[OH_AVCodecOnNewOutputData](_codec_base.md#oh_avcodeconnewoutputdata)给出。 | 942 943**返回：** 944 945返回接口结果： 946 947AV_ERR_OK：执行成功。 948 949AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。 950 951AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 952 953AV_ERR_UNKNOWN：未知错误。 954 955AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 956 957AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。
