# AudioDecoder ## Overview Provides the functions for audio decoding. \@syscap SystemCapability.Multimedia.Media.AudioDecoder **Since:** 9 ## Summary ### Files | Name | Description | | -------- | -------- | | [native_avcodec_audiodecoder.h](native__avcodec__audiodecoder_8h.md) | Declares the native APIs used for audio decoding.
File to Include: | ### Functions | Name | Description | | -------- | -------- | | [OH_AudioDecoder_CreateByMime](#oh_audiodecoder_createbymime) (const char \*mime) | Creates an audio decoder instance based on a Multipurpose Internet Mail Extension (MIME) type. This API is recommended in most cases. | | [OH_AudioDecoder_CreateByName](#oh_audiodecoder_createbyname) (const char \*name) | Creates an audio decoder instance based on an audio decoder name. To use this API, you must know the exact name of the audio decoder. | | [OH_AudioDecoder_Destroy](#oh_audiodecoder_destroy) (OH_AVCodec \*codec) | Clears the internal resources of an audio decoder and destroys the audio decoder instance. | | [OH_AudioDecoder_SetCallback](#oh_audiodecoder_setcallback) (OH_AVCodec \*codec, [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) callback, void \*userData) | Sets an asynchronous callback so that your application can respond to events generated by an audio decoder. This API must be called prior to **Prepare**. | | [OH_AudioDecoder_Configure](#oh_audiodecoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | Configures an audio decoder. Typically, you need to configure the attributes, which can be extracted from the container, of the audio track that can be decoded. This API must be called prior to **Prepare**. | | [OH_AudioDecoder_Prepare](#oh_audiodecoder_prepare) (OH_AVCodec \*codec) | Prepares internal resources for an audio decoder. This API must be called after **Configure**. | | [OH_AudioDecoder_Start](#oh_audiodecoder_start) (OH_AVCodec \*codec) | Starts an audio decoder. This API can be called only after the decoder is prepared successfully. After being started, the decoder starts to report the [OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) event. | | [OH_AudioDecoder_Stop](#oh_audiodecoder_stop) (OH_AVCodec \*codec) | Stops an audio decoder. After the decoder is stopped, you can call **Start** to start it again. If you have passed codec-specific data in the previous **Start** for the decoder, you must pass it again. | | [OH_AudioDecoder_Flush](#oh_audiodecoder_flush) (OH_AVCodec \*codec) | Clears the input and output data in the internal buffer of an audio decoder. This API invalidates the indexes of all buffers previously reported through the asynchronous callback. Therefore, before calling this API, ensure that the buffers corresponding to the indexes are no longer required. | | [OH_AudioDecoder_Reset](#oh_audiodecoder_reset) (OH_AVCodec \*codec) | Resets an audio decoder. To continue decoding, you must call **Configure** and **Start** to configure and start the decoder again. | | [OH_AudioDecoder_GetOutputDescription](#oh_audiodecoder_getoutputdescription) (OH_AVCodec \*codec) | Obtains the attributes of the output data of an audio decoder. The caller must manually release the **OH_AVFormat** instance in the return value. | | [OH_AudioDecoder_SetParameter](#oh_audiodecoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | Sets dynamic parameters for an audio decoder. This API can be called only after the decoder is started. Incorrect parameter settings may cause decoding failure. | | [OH_AudioDecoder_PushInputData](#oh_audiodecoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) attr) | Pushes the input buffer filled with data to an audio decoder. The [OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) callback reports available input buffers and their indexes. After being pushed to the decoder, a buffer is not accessible until the buffer with the same index is reported again through the [OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) callback. In addition, some decoders require the input of codec-specific data to initialize the decoding process. | | [OH_AudioDecoder_FreeOutputData](#oh_audiodecoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | Frees an output buffer of an audio decoder. | ## Function Description ### OH_AudioDecoder_Configure() ``` OH_AVErrCode OH_AudioDecoder_Configure (OH_AVCodec * codec, OH_AVFormat * format ) ``` **Description**
Configures an audio decoder. Typically, you need to configure the attributes, which can be extracted from the container, of the audio track that can be decoded. This API must be called prior to **Prepare**. \@syscap SystemCapability.Multimedia.Media.AudioDecoder **Parameters** | Name | Description | | -------- | -------- | | codec | Indicates the pointer to an **OH_AVCodec** instance. | | format | Indicates the handle to an **OH_AVFormat** instance, which provides the attributes of the audio track to be decoded. | **Returns** Returns **AV_ERR_OK** if the operation is successful. Returns an error code defined in [OH_AVErrCode](_core.md#oh_averrcode) if the operation fails. ### OH_AudioDecoder_CreateByMime() ``` OH_AVCodec* OH_AudioDecoder_CreateByMime (const char * mime) ``` **Description**
Creates an audio decoder instance based on a Multipurpose Internet Mail Extension (MIME) type. This API is recommended in most cases. \@syscap SystemCapability.Multimedia.Media.AudioDecoder **Parameters** | Name | Description | | -------- | -------- | | mime | Indicates the pointer to a MIME type. For details, see [OH_AVCODEC_MIMETYPE_AUDIO_AAC](_codec_base.md#oh_avcodec_mimetype_audio_aac). | **Returns** Returns the pointer to an **OH_AVCodec** instance. ### OH_AudioDecoder_CreateByName() ``` OH_AVCodec* OH_AudioDecoder_CreateByName (const char * name) ``` **Description**
Creates an audio decoder instance based on an audio decoder name. To use this API, you must know the exact name of the audio decoder. \@syscap SystemCapability.Multimedia.Media.AudioDecoder **Parameters** | Name | Description | | -------- | -------- | | name | Indicates the pointer to an audio decoder name. | **Returns** Returns the pointer to an **OH_AVCodec** instance. ### OH_AudioDecoder_Destroy() ``` OH_AVErrCode OH_AudioDecoder_Destroy (OH_AVCodec * codec) ``` **Description**
Clears the internal resources of an audio decoder and destroys the audio decoder instance. \@syscap SystemCapability.Multimedia.Media.AudioDecoder **Parameters** | Name | Description | | -------- | -------- | | codec | Indicates the pointer to an **OH_AVCodec** instance. | **Returns** Returns **AV_ERR_OK** if the operation is successful. Returns an error code defined in [OH_AVErrCode](_core.md#oh_averrcode) if the operation fails. ### OH_AudioDecoder_Flush() ``` OH_AVErrCode OH_AudioDecoder_Flush (OH_AVCodec * codec) ``` **Description**
Clears the input and output data in the internal buffer of an audio decoder. This API invalidates the indexes of all buffers previously reported through the asynchronous callback. Therefore, before calling this API, ensure that the buffers corresponding to the indexes are no longer required. \@syscap SystemCapability.Multimedia.Media.AudioDecoder **Parameters** | Name | Description | | -------- | -------- | | codec | Indicates the pointer to an **OH_AVCodec** instance. | **Returns** Returns **AV_ERR_OK** if the operation is successful. Returns an error code defined in [OH_AVErrCode](_core.md#oh_averrcode) if the operation fails. ### OH_AudioDecoder_FreeOutputData() ``` OH_AVErrCode OH_AudioDecoder_FreeOutputData (OH_AVCodec * codec, uint32_t index ) ``` **Description**
Frees an output buffer of an audio decoder. \@syscap SystemCapability.Multimedia.Media.AudioDecoder **Parameters** | Name | Description | | -------- | -------- | | codec | Indicates the pointer to an **OH_AVCodec** instance. | | index | Indicates the index of an output buffer. | **Returns** Returns **AV_ERR_OK** if the operation is successful. Returns an error code defined in [OH_AVErrCode](_core.md#oh_averrcode) if the operation fails. ### OH_AudioDecoder_GetOutputDescription() ``` OH_AVFormat* OH_AudioDecoder_GetOutputDescription (OH_AVCodec * codec) ``` **Description**
Obtains the attributes of the output data of an audio decoder. The caller must manually release the **OH_AVFormat** instance in the return value. \@syscap SystemCapability.Multimedia.Media.AudioDecoder **Parameters** | Name | Description | | -------- | -------- | | codec | Indicates the pointer to an **OH_AVCodec** instance. | **Returns** Returns the handle to an **OH_AVFormat** instance, which must be manually released. ### OH_AudioDecoder_Prepare() ``` OH_AVErrCode OH_AudioDecoder_Prepare (OH_AVCodec * codec) ``` **Description**
Prepares internal resources for an audio decoder. This API must be called after **Configure**. \@syscap SystemCapability.Multimedia.Media.AudioDecoder **Parameters** | Name | Description | | -------- | -------- | | codec | Indicates the pointer to an **OH_AVCodec** instance. | **Returns** Returns **AV_ERR_OK** if the operation is successful. Returns an error code defined in [OH_AVErrCode](_core.md#oh_averrcode) if the operation fails. ### OH_AudioDecoder_PushInputData() ``` OH_AVErrCode OH_AudioDecoder_PushInputData (OH_AVCodec * codec, uint32_t index, OH_AVCodecBufferAttr attr ) ``` **Description**
Pushes the input buffer filled with data to an audio decoder. The [OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) callback reports available input buffers and their indexes. After being pushed to the decoder, a buffer is not accessible until the buffer with the same index is reported again through the [OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) callback. In addition, some decoders require the input of codec-specific data to initialize the decoding process. \@syscap SystemCapability.Multimedia.Media.AudioDecoder **Parameters** | Name | Description | | -------- | -------- | | codec | Indicates the pointer to an **OH_AVCodec** instance. | | index | Indicates the index of an input buffer. | | attr | Indicates the attributes of the data contained in the buffer. | **Returns** Returns **AV_ERR_OK** if the operation is successful. Returns an error code defined in [OH_AVErrCode](_core.md#oh_averrcode) if the operation fails. ### OH_AudioDecoder_Reset() ``` OH_AVErrCode OH_AudioDecoder_Reset (OH_AVCodec * codec) ``` **Description**
Resets an audio decoder. To continue decoding, you must call **Configure** and **Start** to configure and start the decoder again. \@syscap SystemCapability.Multimedia.Media.AudioDecoder **Parameters** | Name | Description | | -------- | -------- | | codec | Indicates the pointer to an **OH_AVCodec** instance. | **Returns** Returns **AV_ERR_OK** if the operation is successful. Returns an error code defined in [OH_AVErrCode](_core.md#oh_averrcode) if the operation fails. ### OH_AudioDecoder_SetCallback() ``` OH_AVErrCode OH_AudioDecoder_SetCallback (OH_AVCodec * codec, OH_AVCodecAsyncCallback callback, void * userData ) ``` **Description**
Sets an asynchronous callback so that your application can respond to events generated by an audio decoder. This API must be called prior to **Prepare**. \@syscap SystemCapability.Multimedia.Media.AudioDecoder **Parameters** | Name | Description | | -------- | -------- | | codec | Indicates the pointer to an **OH_AVCodec** instance. | | callback | Indicates a collection of all callback functions. For details, see [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md). | | userData | Indicates the pointer to user-specific data. | **Returns** Returns **AV_ERR_OK** if the operation is successful. Returns an error code defined in [OH_AVErrCode](_core.md#oh_averrcode) if the operation fails. ### OH_AudioDecoder_SetParameter() ``` OH_AVErrCode OH_AudioDecoder_SetParameter (OH_AVCodec * codec, OH_AVFormat * format ) ``` **Description**
Sets dynamic parameters for an audio decoder. This API can be called only after the decoder is started. Incorrect parameter settings may cause decoding failure. \@syscap SystemCapability.Multimedia.Media.AudioDecoder **Parameters** | Name | Description | | -------- | -------- | | codec | Indicates the pointer to an **OH_AVCodec** instance. | | format | Indicates the handle to an **OH_AVFormat** instance. | **Returns** Returns **AV_ERR_OK** if the operation is successful. Returns an error code defined in [OH_AVErrCode](_core.md#oh_averrcode) if the operation fails. ### OH_AudioDecoder_Start() ``` OH_AVErrCode OH_AudioDecoder_Start (OH_AVCodec * codec) ``` **Description**
Starts an audio decoder. This API can be called only after the decoder is prepared successfully. After being started, the decoder starts to report the [OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) event. \@syscap SystemCapability.Multimedia.Media.AudioDecoder **Parameters** | Name | Description | | -------- | -------- | | codec | Indicates the pointer to an **OH_AVCodec** instance. | **Returns** Returns **AV_ERR_OK** if the operation is successful. Returns an error code defined in [OH_AVErrCode](_core.md#oh_averrcode) if the operation fails. ### OH_AudioDecoder_Stop() ``` OH_AVErrCode OH_AudioDecoder_Stop (OH_AVCodec * codec) ``` **Description**
Stops an audio decoder. After the decoder is stopped, you can call **Start** to start it again. If you have passed codec-specific data in the previous **Start** for the decoder, you must pass it again. \@syscap SystemCapability.Multimedia.Media.AudioDecoder **Parameters** | Name | Description | | -------- | -------- | | codec | Indicates the pointer to an **OH_AVCodec** instance. | **Returns** Returns **AV_ERR_OK** if the operation is successful. Returns an error code defined in [OH_AVErrCode](_core.md#oh_averrcode) if the operation fails.