• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# AudioDecoder
2
3
4## 概述
5
6AudioDecoder模块提供用于音频解码功能的函数。
7
8**系统能力：** SystemCapability.Multimedia.Media.AudioDecoder
9
10**起始版本：** 9
11
12
13## 汇总
14
15
16### 文件
17
18| 名称 | 描述 |
19| -------- | -------- |
20| [native_avcodec_audiodecoder.h](native__avcodec__audiodecoder_8h.md) | 声明用于音频解码的Native API。 |
21
22
23### 函数
24
25| 名称 | 描述 |
26| -------- | -------- |
27| OH_AVCodec \* [OH_AudioDecoder_CreateByMime](#oh_audiodecoder_createbymime) (const char \*mime) | 根据MIME类型创建音频解码器实例。 |
28| OH_AVCodec \* [OH_AudioDecoder_CreateByName](#oh_audiodecoder_createbyname) (const char \*name) | 通过音频解码器名称创建音频解码器实例。 |
29| [OH_AVErrCode](_core.md#oh_averrcode) [OH_AudioDecoder_Destroy](#oh_audiodecoder_destroy) (OH_AVCodec \*codec) | 清理解码器内部资源，销毁解码器实例。 |
30| [OH_AVErrCode](_core.md#oh_averrcode) [OH_AudioDecoder_SetCallback](#oh_audiodecoder_setcallback) (OH_AVCodec \*codec, [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) callback, void \*userData) | 设置异步回调函数，使应用可以响应音频解码器生成的事件。 |
31| [OH_AVErrCode](_core.md#oh_averrcode) [OH_AudioDecoder_Configure](#oh_audiodecoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | 要配置音频解码器，通常需要配置从容器中提取的音频描述信息。 |
32| [OH_AVErrCode](_core.md#oh_averrcode) [OH_AudioDecoder_Prepare](#oh_audiodecoder_prepare) (OH_AVCodec \*codec) | 准备解码器的内部资源。 |
33| [OH_AVErrCode](_core.md#oh_averrcode) [OH_AudioDecoder_Start](#oh_audiodecoder_start) (OH_AVCodec \*codec) | Prepare成功后调用此接口启动解码器。 |
34| [OH_AVErrCode](_core.md#oh_averrcode) [OH_AudioDecoder_Stop](#oh_audiodecoder_stop) (OH_AVCodec \*codec) | 停止解码器。 |
35| [OH_AVErrCode](_core.md#oh_averrcode) [OH_AudioDecoder_Flush](#oh_audiodecoder_flush) (OH_AVCodec \*codec) | 清除解码器中缓存的输入和输出数据。 |
36| [OH_AVErrCode](_core.md#oh_averrcode) [OH_AudioDecoder_Reset](#oh_audiodecoder_reset) (OH_AVCodec \*codec) | 重置解码器。如果要继续解码，需要再次调用Configure接口配置解码器实例。 |
37| OH_AVFormat \* [OH_AudioDecoder_GetOutputDescription](#oh_audiodecoder_getoutputdescription) (OH_AVCodec \*codec) | 获取解码器输出数据的描述信息。 |
38| [OH_AVErrCode](_core.md#oh_averrcode) [OH_AudioDecoder_SetParameter](#oh_audiodecoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | 配置解码器的动态参数。 |
39| [OH_AVErrCode](_core.md#oh_averrcode) [OH_AudioDecoder_PushInputData](#oh_audiodecoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) attr) | 将填充有数据的输入缓冲区提交给音频解码器。 |
40| [OH_AVErrCode](_core.md#oh_averrcode) [OH_AudioDecoder_FreeOutputData](#oh_audiodecoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | 将处理后的输出缓冲区返回给解码器。 |
41| [OH_AVErrCode](_core.md#oh_averrcode) [OH_AudioDecoder_IsValid](#oh_audiodecoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前解码器实例是否有效，可用于后台故障恢复或应用程序从后台恢复时检测解码器有效状态。 |
42
43
44## 函数说明
45
46
47### OH_AudioDecoder_Configure()
48
49```
50OH_AVErrCode OH_AudioDecoder_Configure (OH_AVCodec *codec, OH_AVFormat *format)
51```
52
53**描述**
54
55要配置音频解码器，通常需要配置从容器中提取的音频描述信息。
56
57在调用Prepare之前，必须调用此接口。
58
59**系统能力：** SystemCapability.Multimedia.Media.AudioDecoder
60
61**起始版本：** 9
62
63**废弃版本：** 11
64
65**替代接口：**[OH_AudioCodec_Configure](_audio_codec.md#oh_audiocodec_configure)
66
67**参数:**
68
69| 名称 | 描述 |
70| -------- | -------- |
71| codec | 指向OH_AVCodec实例的指针。 |
72| format | 指向OH_AVFormat的指针，给出要解码的音频轨道的描述。 |
73
74**返回：**
75
76如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
77
78
79### OH_AudioDecoder_CreateByMime()
80
81```
82OH_AVCodec* OH_AudioDecoder_CreateByMime (const char *mime)
83```
84
85**描述**
86
87根据MIME类型创建音频解码器实例，大多数场景下建议使用此方式。
88
89**系统能力：** SystemCapability.Multimedia.Media.AudioDecoder
90
91**起始版本：** 9
92
93**废弃版本：** 11
94
95**替代接口：**[OH_AudioCodec_CreateByMime](_audio_codec.md#oh_audiocodec_createbymime)
96
97**参数:**
98
99| 名称 | 描述 |
100| -------- | -------- |
101| mime | MIME类型描述字符串，请参阅[AVCODEC_MIMETYPE](_codec_base.md#变量)。 |
102
103**返回：**
104
105返回指向OH_AVCodec实例的指针。
106
107
108### OH_AudioDecoder_CreateByName()
109
110```
111OH_AVCodec* OH_AudioDecoder_CreateByName (const char *name)
112```
113
114**描述**
115
116通过音频解码器名称创建音频解码器实例，使用此接口的前提是知道解码器的确切名称。
117
118**系统能力：** SystemCapability.Multimedia.Media.AudioDecoder
119
120**起始版本：** 9
121
122**废弃版本：** 11
123
124**替代接口：**[OH_AudioCodec_CreateByName](_audio_codec.md#oh_audiocodec_createbyname)
125
126**参数:**
127
128| 名称 | 描述 |
129| -------- | -------- |
130| name | 音频解码器名称。 |
131
132**返回：**
133
134返回指向OH_AVCodec实例的指针。
135
136
137### OH_AudioDecoder_Destroy()
138
139```
140OH_AVErrCode OH_AudioDecoder_Destroy (OH_AVCodec *codec)
141```
142
143**描述**
144
145清理解码器内部资源，销毁解码器实例。
146
147**系统能力：** SystemCapability.Multimedia.Media.AudioDecoder
148
149**起始版本：** 9
150
151**废弃版本：** 11
152
153**替代接口：**[OH_AudioCodec_Destroy](_audio_codec.md#oh_audiocodec_destroy)
154
155**参数:**
156
157| 名称 | 描述 |
158| -------- | -------- |
159| codec | 指向OH_AVCodec实例的指针。 |
160
161**返回：**
162
163如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
164
165
166### OH_AudioDecoder_Flush()
167
168```
169OH_AVErrCode OH_AudioDecoder_Flush (OH_AVCodec *codec)
170```
171
172**描述**
173
174清除解码器中缓存的输入和输出数据。
175
176调用此接口后，以前通过异步回调上报的所有缓冲区索引都将失效，请确保不要访问这些索引对应的缓冲区。
177
178**系统能力：** SystemCapability.Multimedia.Media.AudioDecoder
179
180**起始版本：** 9
181
182**废弃版本：** 11
183
184**替代接口：**[OH_AudioCodec_Flush](_audio_codec.md#oh_audiocodec_flush)
185
186**参数:**
187
188| 名称 | 描述 |
189| -------- | -------- |
190| codec | 指向OH_AVCodec实例的指针。 |
191
192**返回：**
193
194如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
195
196
197### OH_AudioDecoder_FreeOutputData()
198
199```
200OH_AVErrCode OH_AudioDecoder_FreeOutputData (OH_AVCodec *codec, uint32_t index)
201```
202
203**描述**
204
205将处理后的输出缓冲区返回给解码器。
206
207**系统能力：** SystemCapability.Multimedia.Media.AudioDecoder
208
209**起始版本：** 9
210
211**废弃版本：** 11
212
213**替代接口：**[OH_AudioCodec_FreeOutputBuffer](_audio_codec.md#oh_audiocodec_freeoutputbuffer)
214
215**参数:**
216
217| 名称 | 描述 |
218| -------- | -------- |
219| codec | 指向OH_AVCodec实例的指针。 |
220| index | 输出缓冲区Buffer对应的索引值。 |
221
222**返回：**
223
224如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
225
226
227### OH_AudioDecoder_GetOutputDescription()
228
229```
230OH_AVFormat* OH_AudioDecoder_GetOutputDescription (OH_AVCodec *codec)
231```
232
233**描述**
234
235获取解码器输出数据的描述信息。
236
237需要注意的是，返回值所指向的OH_AVFormat实例的生命周期需要调用者手动释放。
238
239**系统能力：** SystemCapability.Multimedia.Media.AudioDecoder
240
241**起始版本：** 9
242
243**废弃版本：** 11
244
245**替代接口：**[OH_AudioCodec_GetOutputDescription](_audio_codec.md#oh_audiocodec_getoutputdescription)
246
247**参数:**
248
249| 名称 | 描述 |
250| -------- | -------- |
251| codec | 指向OH_AVCodec实例的指针 |
252
253**返回：**
254
255返回OH_AVFormat句柄指针，生命周期将使用下一个GetOutputDescription 刷新，或使用OH_AVCodec销毁。
256
257
258### OH_AudioDecoder_IsValid()
259
260```
261OH_AVErrCode OH_AudioDecoder_IsValid (OH_AVCodec *codec, bool *isValid)
262```
263
264**描述**
265
266检查当前解码器实例是否有效，可用于后台故障恢复或应用程序从后台恢复时检测解码器有效状态。
267
268**系统能力：** SystemCapability.Multimedia.Media.AudioDecoder
269
270**起始版本：** 10
271
272**废弃版本：** 11
273
274**替代接口：**[OH_AudioCodec_IsValid](_audio_codec.md#oh_audiocodec_isvalid)
275
276**参数:**
277
278| 名称 | 描述 |
279| -------- | -------- |
280| codec | 指向OH_AVCodec实例的指针 |
281| isValid | 指向布尔实例的指针，true：解码器实例有效，false：解码器实例无效。 |
282
283**返回：**
284
285如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
286
287
288### OH_AudioDecoder_Prepare()
289
290```
291OH_AVErrCode OH_AudioDecoder_Prepare (OH_AVCodec *codec)
292```
293
294**描述**
295
296准备解码器的内部资源，在调用此接口之前必须调用Configure接口。
297
298**系统能力：** SystemCapability.Multimedia.Media.AudioDecoder
299
300**起始版本：** 9
301
302**废弃版本：** 11
303
304**替代接口：**[OH_AudioCodec_Prepare](_audio_codec.md#oh_audiocodec_prepare)
305
306**参数:**
307
308| 名称 | 描述 |
309| -------- | -------- |
310| codec | 指向OH_AVCodec实例的指针。 |
311
312**返回：**
313
314如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
315
316
317### OH_AudioDecoder_PushInputData()
318
319```
320OH_AVErrCode OH_AudioDecoder_PushInputData (OH_AVCodec *codec, uint32_t index, OH_AVCodecBufferAttr attr)
321```
322
323**描述**
324
325将填充有数据的输入缓冲区提交给音频解码器。
326
327[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)回调将报告可用的输入缓冲区和相应的索引值。一旦具有指定索引的缓冲区提交到音频解码器，则无法再次访问此缓冲区， 直到再次收到[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)回调，收到相同索引时此缓冲区才可使用。
328
329此外，对于某些解码器，需要在开始时向解码器输入特定配置参数，以初始化解码器的解码过程。
330
331**系统能力：** SystemCapability.Multimedia.Media.AudioDecoder
332
333**起始版本：** 9
334
335**废弃版本：** 11
336
337**替代接口：**[OH_AudioCodec_PushInputBuffer](_audio_codec.md#oh_audiocodec_pushinputbuffer)
338
339**参数:**
340
341| 名称 | 描述 |
342| -------- | -------- |
343| codec | 指向OH_AVCodec实例的指针。 |
344| index | 输入缓冲区Buffer对应的索引值。 |
345| attr | 描述缓冲区中包含的数据的信息。 |
346
347**返回：**
348
349如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
350
351
352### OH_AudioDecoder_Reset()
353
354```
355OH_AVErrCode OH_AudioDecoder_Reset (OH_AVCodec *codec)
356```
357
358**描述**
359
360重置解码器。如果要继续解码，需要再次调用Configure接口配置解码器实例。
361
362**系统能力：** SystemCapability.Multimedia.Media.AudioDecoder
363
364**起始版本：** 9
365
366**废弃版本：** 11
367
368**替代接口：**[OH_AudioCodec_Reset](_audio_codec.md#oh_audiocodec_reset)
369
370**参数:**
371
372| 名称 | 描述 |
373| -------- | -------- |
374| codec | 指向OH_AVCodec实例的指针。 |
375
376**返回：**
377
378如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
379
380
381### OH_AudioDecoder_SetCallback()
382
383```
384OH_AVErrCode OH_AudioDecoder_SetCallback (OH_AVCodec *codec, OH_AVCodecAsyncCallback callback, void *userData)
385```
386
387**描述**
388
389设置异步回调函数，使应用可以响应音频解码器生成的事件。在调用Prepare之前，必须调用此接口。
390
391**系统能力：** SystemCapability.Multimedia.Media.AudioDecoder
392
393**起始版本：** 9
394
395**废弃版本：** 11
396
397**替代接口：**[OH_AudioCodec_RegisterCallback](_audio_codec.md#oh_audiocodec_registercallback)
398
399**参数:**
400
401| 名称 | 描述 |
402| -------- | -------- |
403| codec | 指向OH_AVCodec实例的指针。 |
404| callback | 所有回调函数的集合，请参见 [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md)。 |
405| userData | 用户特定数据。 |
406
407**返回：**
408
409如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
410
411
412### OH_AudioDecoder_SetParameter()
413
414```
415OH_AVErrCode OH_AudioDecoder_SetParameter (OH_AVCodec *codec, OH_AVFormat *format)
416```
417
418**描述**
419
420配置解码器的动态参数。
421
422注意：该接口必须在解码器启动后才能调用。另外，参数配置错误可能会导致解码失败。
423
424**系统能力：** SystemCapability.Multimedia.Media.AudioDecoder
425
426**起始版本：** 9
427
428**废弃版本：** 11
429
430**替代接口：**[OH_AudioCodec_SetParameter](_audio_codec.md#oh_audiocodec_setparameter)
431
432**参数:**
433
434| 名称 | 描述 |
435| -------- | -------- |
436| codec | 指向OH_AVCodec实例的指针。 |
437| format | OH_AVFormat句柄指针。 |
438
439**返回：**
440
441如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
442
443
444### OH_AudioDecoder_Start()
445
446```
447OH_AVErrCode OH_AudioDecoder_Start (OH_AVCodec *codec)
448```
449
450**描述**
451
452Prepare成功后调用此接口启动解码器。启动后，解码器将开始上报OH_AVCodecOnNeedInputData事件。
453
454**系统能力：** SystemCapability.Multimedia.Media.AudioDecoder
455
456**起始版本：** 9
457
458**废弃版本：** 11
459
460**替代接口：**[OH_AudioCodec_Start](_audio_codec.md#oh_audiocodec_start)
461
462**参数:**
463
464| 名称 | 描述 |
465| -------- | -------- |
466| codec | 指向OH_AVCodec实例的指针。 |
467
468**返回：**
469
470如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
471
472
473### OH_AudioDecoder_Stop()
474
475```
476OH_AVErrCode OH_AudioDecoder_Stop (OH_AVCodec *codec)
477```
478
479**描述**
480
481停止解码器。
482
483停止后，您可以通过Start重新进入已启动状态，但需要注意的是， 如果解码器之前已输入数据，则需要重新输入解码器数据。
484
485**系统能力：** SystemCapability.Multimedia.Media.AudioDecoder
486
487**起始版本：** 9
488
489**废弃版本：** 11
490
491**替代接口：**[OH_AudioCodec_Stop](_audio_codec.md#oh_audiocodec_stop)
492
493**参数:**
494
495| 名称 | 描述 |
496| -------- | -------- |
497| codec | 指向OH_AVCodec实例的指针。 |
498
499**返回：**
500
501如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
502