_audio_decoder.md 12.4 KB
Newer Older
Z
zengyawen 已提交
1 2 3 4 5
# AudioDecoder


## 概述

Z
zengyawen 已提交
6
AudioDecoder模块提供用于音频解码功能的函数。该模块在部分设备上可能不支持,可以通过[CanIUse](../syscap.md)接口确认。
Z
zengyawen 已提交
7 8 9

@syscap SystemCapability.Multimedia.Media.AudioDecoder

Z
zengyawen 已提交
10
**起始版本:**
Z
zengyawen 已提交
11 12 13 14 15 16 17 18 19
9

## 汇总


### 文件

  | 名称 | 描述 | 
| -------- | -------- |
Z
zengyawen 已提交
20
| [native_avcodec_audiodecoder.h](native__avcodec__audiodecoder_8h.md) | 声明用于音频解码的Native API。<br>引用文件:<multimedia/player_framework/native_avcodec_audiodecoder.h>  |
Z
zengyawen 已提交
21 22 23 24 25 26


### 函数

  | 名称 | 描述 | 
| -------- | -------- |
Z
zengyawen 已提交
27 28 29 30 31 32 33 34 35 36 37 38 39 40
| [OH_AudioDecoder_CreateByMime](#oh_audiodecoder_createbymime) (const char \*mime) | 通过mime类型创建一个音频解码器实例,大多数情况下推荐使用该接口。  | 
| [OH_AudioDecoder_CreateByName](#oh_audiodecoder_createbyname) (const char \*name) | 通过音频解码器名称创建一个音频解码器实例,使用这个接口的前提是必须清楚解码器准确的名称。  | 
| [OH_AudioDecoder_Destroy](#oh_audiodecoder_destroy) (OH_AVCodec \*codec) | 清空解码器内部资源,并销毁解码器实例  | 
| [OH_AudioDecoder_SetCallback](#oh_audiodecoder_setcallback) (OH_AVCodec \*codec, [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) callback, void \*userData) | 设置异步回调函数,使得你的应用能够响应音频解码器产生的事件,该接口被调用必须是在Prepare被调用前。  | 
| [OH_AudioDecoder_Configure](#oh_audiodecoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | 配置音频解码器,典型地,需要配置被解码音频轨道的描述信息,这些信息能够从容器中提取出来, 该接口被调用必须是在Prepare被调用前。  | 
| [OH_AudioDecoder_Prepare](#oh_audiodecoder_prepare) (OH_AVCodec \*codec) | 准备解码器内部资源,调用该接口前必须先调用Configure接口。  | 
| [OH_AudioDecoder_Start](#oh_audiodecoder_start) (OH_AVCodec \*codec) | 启动解码器,该接口必须在已经Prepare成功后调用。 在启动成功后,解码器将开始报告[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)事件。  | 
| [OH_AudioDecoder_Stop](#oh_audiodecoder_stop) (OH_AVCodec \*codec) | 停止解码器。在停止后可通过Start重新进入Started状态,但需要注意的是,若先前给解码器输入过 Codec-Specific-Data,则需要重新输入。  | 
| [OH_AudioDecoder_Flush](#oh_audiodecoder_flush) (OH_AVCodec \*codec) | 清空解码器内部缓存的输入输出数据。在该接口被调用后,所有先前通过异步回调报告的Buffer的索引都将 失效,确保不要再访问这些索引对应的Buffers。  | 
| [OH_AudioDecoder_Reset](#oh_audiodecoder_reset) (OH_AVCodec \*codec) | 重置解码器。如需继续解码工作,需要重新调用Configure接口以配置该解码器实例。  | 
| [OH_AudioDecoder_GetOutputDescription](#oh_audiodecoder_getoutputdescription) (OH_AVCodec \*codec) | 获取该解码器输出数据的描述信息,需要注意的是,返回值所指向的OH_AVFormat实例需调用者手动释放。  | 
| [OH_AudioDecoder_SetParameter](#oh_audiodecoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | 向解码器设置动态参数,注意:该接口仅能在解码器被启动后调用,同时错误的参数设置,可能会导致解码失败。  | 
| [OH_AudioDecoder_PushInputData](#oh_audiodecoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) attr) | 将填充好数据的输入Buffer提交给音频解码器。[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)回调会报告可用的输入 Buffer及对应的索引值。一旦指定索引的Buffer被提交给解码器,直到再一次收到[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) 回调报告相同索引的Buffer可用前,该Buffer都不可以再次被访问。另外,对于部分解码器,要求在最开始给解码器输入 Codec-Specific-Data,用以初始化解码器的解码过程。  | 
| [OH_AudioDecoder_FreeOutputData](#oh_audiodecoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | 将处理结束的输出Buffer交还给解码器。  | 
Z
zengyawen 已提交
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60


## 函数说明


### OH_AudioDecoder_Configure()

  
```
OH_AVErrCode OH_AudioDecoder_Configure (OH_AVCodec * codec, OH_AVFormat * format )
```
**描述:**
配置音频解码器,典型地,需要配置被解码音频轨道的描述信息,这些信息能够从容器中提取出来, 该接口被调用必须是在Prepare被调用前。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
zengyawen 已提交
61 62
| codec | 指向OH_AVCodec实例的指针  | 
| format | 指向OH_AVFormat的指针,用以给出待解码音频轨道的描述信息  | 
Z
zengyawen 已提交
63 64 65 66 67

**返回:**

执行成功返回AV_ERR_OK

Z
zengyawen 已提交
68
执行失败返回具体错误码,参考[OH_AVErrCode](_core.md#oh_averrcode)
Z
zengyawen 已提交
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85


### OH_AudioDecoder_CreateByMime()

  
```
OH_AVCodec* OH_AudioDecoder_CreateByMime (const char * mime)
```
**描述:**
通过mime类型创建一个音频解码器实例,大多数情况下推荐使用该接口。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
zengyawen 已提交
86
| mime | mime类型描述字符串,参考[OH_AVCODEC_MIMETYPE_AUDIO_AAC](_codec_base.md#oh_avcodec_mimetype_audio_aac) | 
Z
zengyawen 已提交
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107

**返回:**

返回一个指向OH_AVCodec实例的指针


### OH_AudioDecoder_CreateByName()

  
```
OH_AVCodec* OH_AudioDecoder_CreateByName (const char * name)
```
**描述:**
通过音频解码器名称创建一个音频解码器实例,使用这个接口的前提是必须清楚解码器准确的名称。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
zengyawen 已提交
108
| name | 音频解码器名称  | 
Z
zengyawen 已提交
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129

**返回:**

返回一个指向OH_AVCodec实例的指针


### OH_AudioDecoder_Destroy()

  
```
OH_AVErrCode OH_AudioDecoder_Destroy (OH_AVCodec * codec)
```
**描述:**
清空解码器内部资源,并销毁解码器实例

@syscap SystemCapability.Multimedia.Media.AudioDecoder

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
zengyawen 已提交
130
| codec | 指向OH_AVCodec实例的指针  | 
Z
zengyawen 已提交
131 132 133 134 135

**返回:**

执行成功返回AV_ERR_OK

Z
zengyawen 已提交
136
执行失败返回具体错误码,参考[OH_AVErrCode](_core.md#oh_averrcode)
Z
zengyawen 已提交
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153


### OH_AudioDecoder_Flush()

  
```
OH_AVErrCode OH_AudioDecoder_Flush (OH_AVCodec * codec)
```
**描述:**
清空解码器内部缓存的输入输出数据。在该接口被调用后,所有先前通过异步回调报告的Buffer的索引都将 失效,确保不要再访问这些索引对应的Buffers。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
zengyawen 已提交
154
| codec | 指向OH_AVCodec实例的指针  | 
Z
zengyawen 已提交
155 156 157 158 159

**返回:**

执行成功返回AV_ERR_OK

Z
zengyawen 已提交
160
执行失败返回具体错误码,参考[OH_AVErrCode](_core.md#oh_averrcode)
Z
zengyawen 已提交
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177


### OH_AudioDecoder_FreeOutputData()

  
```
OH_AVErrCode OH_AudioDecoder_FreeOutputData (OH_AVCodec * codec, uint32_t index )
```
**描述:**
将处理结束的输出Buffer交还给解码器。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
zengyawen 已提交
178 179
| codec | 指向OH_AVCodec实例的指针  | 
| index | 输出Buffer对应的索引值  | 
Z
zengyawen 已提交
180 181 182 183 184

**返回:**

执行成功返回AV_ERR_OK

Z
zengyawen 已提交
185
执行失败返回具体错误码,参考[OH_AVErrCode](_core.md#oh_averrcode)
Z
zengyawen 已提交
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202


### OH_AudioDecoder_GetOutputDescription()

  
```
OH_AVFormat* OH_AudioDecoder_GetOutputDescription (OH_AVCodec * codec)
```
**描述:**
获取该解码器输出数据的描述信息,需要注意的是,返回值所指向的OH_AVFormat实例需调用者手动释放。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
zengyawen 已提交
203
| codec | 指向OH_AVCodec实例的指针  | 
Z
zengyawen 已提交
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224

**返回:**

返回OH_AVFormat句柄指针,需调用者手动释放;


### OH_AudioDecoder_Prepare()

  
```
OH_AVErrCode OH_AudioDecoder_Prepare (OH_AVCodec * codec)
```
**描述:**
准备解码器内部资源,调用该接口前必须先调用Configure接口。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
zengyawen 已提交
225
| codec | 指向OH_AVCodec实例的指针  | 
Z
zengyawen 已提交
226 227 228 229 230

**返回:**

执行成功返回AV_ERR_OK

Z
zengyawen 已提交
231
执行失败返回具体错误码,参考[OH_AVErrCode](_core.md#oh_averrcode)
Z
zengyawen 已提交
232 233 234 235 236 237 238 239 240


### OH_AudioDecoder_PushInputData()

  
```
OH_AVErrCode OH_AudioDecoder_PushInputData (OH_AVCodec * codec, uint32_t index, OH_AVCodecBufferAttr attr )
```
**描述:**
Z
zengyawen 已提交
241
将填充好数据的输入Buffer提交给音频解码器。[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)回调会报告可用的输入 Buffer及对应的索引值。一旦指定索引的Buffer被提交给解码器,直到再一次收到[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) 回调报告相同索引的Buffer可用前,该Buffer都不可以再次被访问。另外,对于部分解码器,要求在最开始给解码器输入 Codec-Specific-Data,用以初始化解码器的解码过程。
Z
zengyawen 已提交
242 243 244 245 246 247 248

@syscap SystemCapability.Multimedia.Media.AudioDecoder

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
zengyawen 已提交
249 250 251
| codec | 指向OH_AVCodec实例的指针  | 
| index | 输入Buffer对应的索引值  | 
| attr | 描述该Buffer内所包含数据的信息  | 
Z
zengyawen 已提交
252 253 254 255 256

**返回:**

执行成功返回AV_ERR_OK

Z
zengyawen 已提交
257
执行失败返回具体错误码,参考[OH_AVErrCode](_core.md#oh_averrcode)
Z
zengyawen 已提交
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274


### OH_AudioDecoder_Reset()

  
```
OH_AVErrCode OH_AudioDecoder_Reset (OH_AVCodec * codec)
```
**描述:**
重置解码器。如需继续解码工作,需要重新调用Configure接口以配置该解码器实例。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
zengyawen 已提交
275
| codec | 指向OH_AVCodec实例的指针  | 
Z
zengyawen 已提交
276 277 278 279 280

**返回:**

执行成功返回AV_ERR_OK

Z
zengyawen 已提交
281
执行失败返回具体错误码,参考[OH_AVErrCode](_core.md#oh_averrcode)
Z
zengyawen 已提交
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298


### OH_AudioDecoder_SetCallback()

  
```
OH_AVErrCode OH_AudioDecoder_SetCallback (OH_AVCodec * codec, OH_AVCodecAsyncCallback callback, void * userData )
```
**描述:**
设置异步回调函数,使得你的应用能够响应音频解码器产生的事件,该接口被调用必须是在Prepare被调用前。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
zengyawen 已提交
299
| codec | 指向OH_AVCodec实例的指针  | 
Z
zengyawen 已提交
300
| callback | 一个包含所有回调函数的集合体,参考[OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) | 
Z
zengyawen 已提交
301
| userData | 用户特定数据  | 
Z
zengyawen 已提交
302 303 304 305 306

**返回:**

执行成功返回AV_ERR_OK

Z
zengyawen 已提交
307
执行失败返回具体错误码,参考[OH_AVErrCode](_core.md#oh_averrcode)
Z
zengyawen 已提交
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324


### OH_AudioDecoder_SetParameter()

  
```
OH_AVErrCode OH_AudioDecoder_SetParameter (OH_AVCodec * codec, OH_AVFormat * format )
```
**描述:**
向解码器设置动态参数,注意:该接口仅能在解码器被启动后调用,同时错误的参数设置,可能会导致解码失败。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
zengyawen 已提交
325 326
| codec | 指向OH_AVCodec实例的指针  | 
| format | OH_AVFormat句柄指针  | 
Z
zengyawen 已提交
327 328 329 330 331

**返回:**

执行成功返回AV_ERR_OK

Z
zengyawen 已提交
332
执行失败返回具体错误码,参考[OH_AVErrCode](_core.md#oh_averrcode)
Z
zengyawen 已提交
333 334 335 336 337 338 339 340 341


### OH_AudioDecoder_Start()

  
```
OH_AVErrCode OH_AudioDecoder_Start (OH_AVCodec * codec)
```
**描述:**
Z
zengyawen 已提交
342
启动解码器,该接口必须在已经Prepare成功后调用。 在启动成功后,解码器将开始报告[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)事件。
Z
zengyawen 已提交
343 344 345 346 347 348 349

@syscap SystemCapability.Multimedia.Media.AudioDecoder

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
zengyawen 已提交
350
| codec | 指向OH_AVCodec实例的指针  | 
Z
zengyawen 已提交
351 352 353 354 355

**返回:**

执行成功返回AV_ERR_OK

Z
zengyawen 已提交
356
执行失败返回具体错误码,参考[OH_AVErrCode](_core.md#oh_averrcode)
Z
zengyawen 已提交
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373


### OH_AudioDecoder_Stop()

  
```
OH_AVErrCode OH_AudioDecoder_Stop (OH_AVCodec * codec)
```
**描述:**
停止解码器。在停止后可通过Start重新进入Started状态,但需要注意的是,若先前给解码器输入过 Codec-Specific-Data,则需要重新输入。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
zengyawen 已提交
374
| codec | 指向OH_AVCodec实例的指针  | 
Z
zengyawen 已提交
375 376 377 378 379

**返回:**

执行成功返回AV_ERR_OK

Z
zengyawen 已提交
380
执行失败返回具体错误码,参考[OH_AVErrCode](_core.md#oh_averrcode)