1# VideoDecoder 2 3 4## 概述 5 6VideoDecoder模块提供用于视频解码的函数。 7 8\@syscap SystemCapability.Multimedia.Media.VideoDecoder 9 10**起始版本：** 11 129 13 14 15## 汇总 16 17 18### 文件 19 20| 名称 | 描述 | 21| -------- | -------- | 22| [native_avcodec_videodecoder.h](native__avcodec__videodecoder_8h.md) | 声明用于视频解码的Native API。<br>**引用文件**：<multimedia/player_framework/native_avcodec_videodecoder.h><br>**库**：libnative_media_vdec.so | 23 24 25### 函数 26 27| 名称 | 描述 | 28| -------- | -------- | 29| \*[OH_VideoDecoder_CreateByMime](#oh_videodecoder_createbymime) (const char \*mime) | 从MIME类型创建视频解码器实例，大多数情况下建议使用。 | 30| \*[OH_VideoDecoder_CreateByName](#oh_videodecoder_createbyname) (const char \*name) | 通过视频解码器名称创建视频解码器实例。 使用此接口的前提是知道解码器的确切名称。 | 31| [OH_VideoDecoder_Destroy](#oh_videodecoder_destroy) (OH_AVCodec \*codec) | 清理解码器内部资源，销毁解码器实例。 | 32| [OH_VideoDecoder_SetCallback](#oh_videodecoder_setcallback) (OH_AVCodec \*codec, OH_AVCodecAsyncCallback callback, void \*userData) | 设置异步回调函数，以便您的应用程序可以响应视频解码器生成的事件。 | 33| [OH_VideoDecoder_SetSurface](#oh_videodecoder_setsurface) (OH_AVCodec \*codec, OHNativeWindow \*window) | 指定输出表面以提供视频解码输出，必须在调用Prepare之前调用此接口。 | 34| [OH_VideoDecoder_Configure](#oh_videodecoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | 配置视频解码器，通常需要配置解码视频轨迹的描述信息，这些信息可以从容器中提取。 | 35| [OH_VideoDecoder_Prepare](#oh_videodecoder_prepare) (OH_AVCodec \*codec) | 要准备解码器的内部资源，在调用该接口之前，必须调用Configure接口。 | 36| [OH_VideoDecoder_Start](#oh_videodecoder_start) (OH_AVCodec \*codec) | 启动解码器，准备成功后必须调用此接口。 | 37| [OH_VideoDecoder_Stop](#oh_videodecoder_stop) (OH_AVCodec \*codec) | 停止解码器。 | 38| [OH_VideoDecoder_Flush](#oh_videodecoder_flush) (OH_AVCodec \*codec) | 清除解码器中缓存的输入和输出数据。 | 39| [OH_VideoDecoder_Reset](#oh_videodecoder_reset) (OH_AVCodec \*codec) | 重置解码器。 | 40| \*[OH_VideoDecoder_GetOutputDescription](#oh_videodecoder_getoutputdescription) (OH_AVCodec \*codec) | 获取解码器输出数据的描述信息。 | 41| [OH_VideoDecoder_SetParameter](#oh_videodecoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | 设置解码器的动态参数。 | 42| [OH_VideoDecoder_PushInputData](#oh_videodecoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, OH_AVCodecBufferAttr attr) | 将填充数据的输入缓冲区提交给视频解码器。 | 43| [OH_VideoDecoder_RenderOutputData](#oh_videodecoder_renderoutputdata) (OH_AVCodec \*codec, uint32_t index) | 将处理后的输出Buffer返回给解码器，并通知解码器完成在输出表面上渲染Buffer中包含的解码数据。 | 44| [OH_VideoDecoder_FreeOutputData](#oh_videodecoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | 将处理后的输出缓冲区返回到解码器。 | 45| [OH_VideoDecoder_IsValid](#oh_videodecoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前编解码实例是否有效。 | 46 47 48## 函数说明 49 50 51### OH_VideoDecoder_Configure() 52 53 54``` 55OH_AVErrCode OH_VideoDecoder_Configure (OH_AVCodec *codec, OH_AVFormat *format) 56``` 57 58**描述：** 59 60配置视频解码器，通常需要配置解码视频轨迹的描述信息，这些信息可以从容器中提取。 61 62在调用准备之前，必须调用此接口。 63 64\@syscap SystemCapability.Multimedia.Media.VideoDecoder 65 66**参数：** 67 68| 名称 | 描述 | 69| -------- | -------- | 70| codec | 指向OH_AVCodec实例的指针 | 71| format | 指向OH_AVFormat的指针，用于给出要解码的视频轨道的描述 | 72 73**返回：** 74 75如果执行成功，则返回AV_ERR_OK， 否则返回特定错误代码，请参阅[OH_AVErrCode](_core.md#oh_averrcode)。 76 77**起始版本：** 78 799 80 81 82### OH_VideoDecoder_CreateByMime() 83 84 85``` 86OH_AVCodec* OH_VideoDecoder_CreateByMime (const char *mime) 87``` 88 89**描述：** 90 91从MIME类型创建视频解码器实例，大多数情况下建议使用。 92 93\@syscap SystemCapability.Multimedia.Media.VideoDecoder 94 95**参数：** 96 97| 名称 | 描述 | 98| -------- | -------- | 99| mime | MIME类型描述字符串，请参阅 [AVCODEC_MIMETYPE](_codec_base.md#变量)。 | 100 101**返回：** 102 103返回一个指向OH_AVCodec实例的指针。 104 105**起始版本：** 106 1079 108 109 110### OH_VideoDecoder_CreateByName() 111 112 113``` 114OH_AVCodec* OH_VideoDecoder_CreateByName (const char *name) 115``` 116 117**描述：** 118 119通过视频解码器名称创建视频解码器实例。 使用此接口的前提是知道解码器的确切名称。 120 121\@syscap SystemCapability.Multimedia.Media.VideoDecoder 122 123**参数：** 124 125| 名称 | 描述 | 126| -------- | -------- | 127| name | 视频编解码器名称。 | 128 129**返回：** 130 131返回指向OH_AVCodec实例的指针。 132 133**起始版本：** 134 1359 136 137 138### OH_VideoDecoder_Destroy() 139 140 141``` 142OH_AVErrCode OH_VideoDecoder_Destroy (OH_AVCodec *codec) 143``` 144 145**描述：** 146 147清理解码器内部资源，销毁解码器实例。 148 149\@syscap SystemCapability.Multimedia.Media.VideoDecoder 150 151**参数：** 152 153| 名称 | 描述 | 154| -------- | -------- | 155| codec | 指向OH_AVCodec实例的指针。 | 156 157**返回：** 158 159如果执行成功，则返回AV_ERR_OK， 否则返回特定错误代码，请参阅[OH_AVErrCode](_core.md#oh_averrcode)。 160 161**起始版本：** 162 1639 164 165 166### OH_VideoDecoder_Flush() 167 168 169``` 170OH_AVErrCode OH_VideoDecoder_Flush (OH_AVCodec *codec) 171``` 172 173**描述：** 174 175清除解码器中缓存的输入和输出数据。 176 177调用此接口后，以前通过异步回调上报的所有缓冲区索引都将失效， 请确保不要访问这些索引对应的缓冲区。 178 179\@syscap SystemCapability.Multimedia.Media.VideoDecoder 180 181**参数：** 182 183| 名称 | 描述 | 184| -------- | -------- | 185| codec | 指向OH_AVCodec实例的指针。 | 186 187**返回：** 188 189如果执行成功，则返回AV_ERR_OK， 否则返回特定错误代码，请参阅[OH_AVErrCode](_core.md#oh_averrcode)。 190 191**起始版本：** 192 1939 194 195 196### OH_VideoDecoder_FreeOutputData() 197 198 199``` 200OH_AVErrCode OH_VideoDecoder_FreeOutputData (OH_AVCodec *codec, uint32_t index) 201``` 202 203**描述：** 204 205将处理后的输出缓冲区返回到解码器。 206 207\@syscap SystemCapability.Multimedia.Media.VideoDecoder 208 209**参数：** 210 211| 名称 | 描述 | 212| -------- | -------- | 213| codec | 指向OH_AVCodec实例的指针。 | 214| index | 输出Buffer对应的索引值。 | 215 216**返回：** 217 218如果执行成功，则返回AV_ERR_OK， 否则返回特定错误代码，请参阅[OH_AVErrCode](_core.md#oh_averrcode)。 219 220**起始版本：** 221 2229 223 224 225### OH_VideoDecoder_GetOutputDescription() 226 227 228``` 229OH_AVFormat* OH_VideoDecoder_GetOutputDescription (OH_AVCodec *codec) 230``` 231 232**描述：** 233 234获取解码器输出数据的描述信息，参见**OH_AVFormat**。 235 236需要注意的是，返回值指向的OH_AVFormat实例的生命周期需要调用者手动释放。 237 238\@syscap SystemCapability.Multimedia.Media.VideoDecoder 239 240**参数：** 241 242| 名称 | 描述 | 243| -------- | -------- | 244| codec | 指向OH_AVCodec实例的指针。 | 245 246**返回：** 247 248返回指向OH_AVFormat实例的指针。 249 250**起始版本：** 251 2529 253 254 255### OH_VideoDecoder_IsValid() 256 257 258``` 259OH_AVErrCode OH_VideoDecoder_IsValid (OH_AVCodec *codec, bool *isValid) 260``` 261 262**描述：** 263 264检查当前编解码实例是否有效。 265 266\@syscap SystemCapability.Multimedia.Media.VideoDecoder 267 268**参数：** 269 270| 名称 | 描述 | 271| -------- | -------- | 272| codec | 指向OH_AVCodec实例的指针。 | 273| isVaild | 输出参数。指向布尔实例的指针，如果编解码器实例有效，则为true，如果编解码器实例无效，则为false。 | 274 275**返回：** 276 277如果执行成功，则返回AV_ERR_OK， 否则返回特定错误代码，请参阅[OH_AVErrCode](_core.md#oh_averrcode)。 278 279**起始版本：** 280 28110 282 283 284### OH_VideoDecoder_Prepare() 285 286 287``` 288OH_AVErrCode OH_VideoDecoder_Prepare (OH_AVCodec *codec) 289``` 290 291**描述：** 292 293要准备解码器的内部资源，在调用该接口之前，必须调用Configure接口。 294 295\@syscap SystemCapability.Multimedia.Media.VideoDecoder 296 297**参数：** 298 299| 名称 | 描述 | 300| -------- | -------- | 301| codec | 指向OH_AVCodec实例的指针。 | 302 303**返回：** 304 305如果执行成功，则返回AV_ERR_OK， 否则返回特定错误代码，请参阅[OH_AVErrCode](_core.md#oh_averrcode)。 306 307**起始版本：** 308 3099 310 311 312### OH_VideoDecoder_PushInputData() 313 314 315``` 316OH_AVErrCode OH_VideoDecoder_PushInputData (OH_AVCodec *codec, uint32_t index, OH_AVCodecBufferAttr attr) 317``` 318 319**描述：** 320 321将填充数据的输入缓冲区提交给视频解码器。 322 323**OH_AVCodecOnNeedInputData**回调将报告可用的输入缓冲区和相应的索引值。 324 325一旦具有指定索引的缓冲区提交到视频解码器，则无法再次访问缓冲区，直到再次收到**OH_AVCodecOnNeedInputData**回调，报告具有相同索引的缓冲区可用。 326 327此外，对于某些解码器，需要在开始时向解码器输入编解码特定数据，以初始化解码器的解码过程，如H264格式的PPS/SPS数据。 328 329\@syscap SystemCapability.Multimedia.Media.VideoDecoder 330 331**参数：** 332 333| 名称 | 描述 | 334| -------- | -------- | 335| codec | 指向OH_AVCodec实例的指针。 | 336| index | 输入Buffer对应的索引值。 | 337| attr | 描述缓冲区中包含的数据的信息。 | 338 339**返回：** 340 341如果执行成功，则返回AV_ERR_OK， 否则返回特定错误代码，请参阅[OH_AVErrCode](_core.md#oh_averrcode)。 342 343**起始版本：** 344 3459 346 347 348### OH_VideoDecoder_RenderOutputData() 349 350 351``` 352OH_AVErrCode OH_VideoDecoder_RenderOutputData (OH_AVCodec *codec, uint32_t index) 353``` 354 355**描述：** 356 357将处理后的输出Buffer返回给解码器，并通知解码器完成在输出表面上渲染Buffer中包含的解码数据。 358 359如果之前没有配置输出表面，则调用此接口仅将指定索引对应的输出缓冲区返回给解码器。 360 361\@syscap SystemCapability.Multimedia.Media.VideoDecoder 362 363**参数：** 364 365| 名称 | 描述 | 366| -------- | -------- | 367| codec | 指向OH_AVCodec实例的指针。 | 368| index | 输出Buffer对应的索引值。 | 369 370**返回：** 371 372如果执行成功，则返回AV_ERR_OK， 否则返回特定错误代码，请参阅[OH_AVErrCode](_core.md#oh_averrcode)。 373 374**起始版本：** 375 3769 377 378 379### OH_VideoDecoder_Reset() 380 381 382``` 383OH_AVErrCode OH_VideoDecoder_Reset (OH_AVCodec *codec) 384``` 385 386**描述：** 387 388重置解码器。如果要继续解码，需要再次调用Configure接口配置解码器实例。 389 390\@syscap SystemCapability.Multimedia.Media.VideoDecoder 391 392**参数：** 393 394| 名称 | 描述 | 395| -------- | -------- | 396| codec | 指向OH_AVCodec实例的指针。 | 397 398**返回：** 399 400如果执行成功，则返回AV_ERR_OK， 否则返回特定错误代码，请参阅[OH_AVErrCode](_core.md#oh_averrcode)。 401 402**起始版本：** 403 4049 405 406 407### OH_VideoDecoder_SetCallback() 408 409 410``` 411OH_AVErrCode OH_VideoDecoder_SetCallback (OH_AVCodec *codec, OH_AVCodecAsyncCallback callback, void *userData) 412``` 413 414**描述：** 415 416设置异步回调函数，以便您的应用程序可以响应视频解码器生成的事件。 417 418在调用Prepare之前，必须调用此接口。 419 420\@syscap SystemCapability.Multimedia.Media.VideoDecoder 421 422**参数：** 423 424| 名称 | 描述 | 425| -------- | -------- | 426| codec | 指向OH_AVCodec实例的指针。 | 427| callback | 所有回调函数的集合，请参见 [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md)。 | 428| userData | 用户特定数据。 | 429 430**返回：** 431 432如果执行成功，则返回AV_ERR_OK， 否则返回特定错误代码，请参阅[OH_AVErrCode](_core.md#oh_averrcode)。 433 434**起始版本：** 435 4369 437 438 439### OH_VideoDecoder_SetParameter() 440 441 442``` 443OH_AVErrCode OH_VideoDecoder_SetParameter (OH_AVCodec *codec, OH_AVFormat *format) 444``` 445 446**描述：** 447 448设置解码器的动态参数。 449 450注意，该接口只能在解码器启动后调用。 同时，参数配置错误可能会导致解码失败。 451 452\@syscap SystemCapability.Multimedia.Media.VideoDecoder 453 454**参数：** 455 456| 名称 | 描述 | 457| -------- | -------- | 458| codec | 指向OH_AVCodec实例的指针。 | 459| format | 指向OH_AVFormat实例的指针。 | 460 461**返回：** 462 463如果执行成功，则返回AV_ERR_OK， 否则返回特定错误代码，请参阅[OH_AVErrCode](_core.md#oh_averrcode)。 464 465**起始版本：** 466 4679 468 469 470### OH_VideoDecoder_SetSurface() 471 472 473``` 474OH_AVErrCode OH_VideoDecoder_SetSurface (OH_AVCodec *codec, OHNativeWindow *window) 475``` 476 477**描述：** 478 479指定输出表面以提供视频解码输出，必须在调用Prepare之前调用此接口。 480 481\@syscap SystemCapability.Multimedia.Media.VideoDecoder 482 483**参数：** 484 485| 名称 | 描述 | 486| -------- | -------- | 487| codec | 指向OH_AVCodec实例的指针。 | 488| window | 指向OHNativeWindow实例的指针，请参见{\@链接OHNativeWindow}。 | 489 490**返回：** 491 492如果执行成功，则返回AV_ERR_OK， 否则返回特定错误代码，请参阅[OH_AVErrCode](_core.md#oh_averrcode)。 493 494**起始版本：** 495 4969 497 498 499### OH_VideoDecoder_Start() 500 501 502``` 503OH_AVErrCode OH_VideoDecoder_Start (OH_AVCodec *codec) 504``` 505 506**描述：** 507 508启动解码器，准备成功后必须调用此接口。 509 510成功启动后，解码器将开始报告NeedInputData事件。 511 512\@syscap SystemCapability.Multimedia.Media.VideoDecoder 513 514**参数：** 515 516| 名称 | 描述 | 517| -------- | -------- | 518| codec | 指向OH_AVCodec实例的指针。 | 519 520**返回：** 521 522如果执行成功，则返回AV_ERR_OK， 否则返回特定错误代码，请参阅[OH_AVErrCode](_core.md#oh_averrcode)。 523 524**起始版本：** 525 5269 527 528 529### OH_VideoDecoder_Stop() 530 531 532``` 533OH_AVErrCode OH_VideoDecoder_Stop (OH_AVCodec *codec) 534``` 535 536**描述：** 537 538停止解码器。停止后，您可以通过Start重新进入Started状态。 539 540但需要注意的是，如果编解码器特定数据以前已输入到解码器，则需要再次输入。 541 542\@syscap SystemCapability.Multimedia.Media.VideoDecoder 543 544**参数：** 545 546| 名称 | 描述 | 547| -------- | -------- | 548| codec | 指向OH_AVCodec实例的指针。 | 549 550**返回：** 551 552如果执行成功，则返回AV_ERR_OK， 否则返回特定错误代码，请参阅[OH_AVErrCode](_core.md#oh_averrcode)。 553 554**起始版本：** 555 5569 557