Audio Software Codecs
Loading...
Searching...
No Matches
cy_audio_sw_codec_decode_config_t Struct Reference

Description

Audio Software Codec Decode configuration.

Data Fields

cy_audio_sw_codec_type_t codec_type
 Codec used for decoding.
 
cy_audio_sw_codec_sampling_rate_t sampling_rate
 Sampling rate of the data.
 
cy_audio_sw_codec_channel_t channel
 Channel informations of the data.
 
cy_audio_sw_codec_bitwidth_t bitwidth
 Bitwidth information.
 
void * callback_user_arg
 Application specific user argument, Passed argument will be passed back to application in the MW callbacks also see cy_audio_sw_codec_decode_stream_info_callback_t.
 
cy_audio_sw_codec_decode_stream_info_callback_t stream_info
 Decoded stream information callback.
 
cy_audio_sw_codec_specific_decode_config_t codec_specific_config
 Additional config based on codec usage.
 

Field Documentation

◆ sampling_rate

cy_audio_sw_codec_sampling_rate_t cy_audio_sw_codec_decode_config_t::sampling_rate

Sampling rate of the data.

Application needs to provide this parameter compulsorily if the data to be decoded is not having the codec header (example: lc3 header). i.e.,If the codec header is not available in the stream and if the application has not passed this information, then codec-mw will not be able to decode any data.

If the data to be decoded has the codec header, then codec-mw will internally parse the codec header and extract this information. In this case, Application can optionally provide this parameter if it is known already, if this information is not known then application can pass CY_AUDIO_CODEC_SAMPLING_RATE_UNKNOWN.

◆ channel

cy_audio_sw_codec_channel_t cy_audio_sw_codec_decode_config_t::channel

Channel informations of the data.

Application needs to provide this parameter compulsorily if the data to be decoded is not having the codec header (example: lc3 header). i.e.,If the codec header is not available in the stream and if the application has not passed this information, then codec-mw will not be able to decode any data.

If the data to be decoded has the codec header, then codec-mw will internally parse the codec header and extract this information. In this case, Application can optionally provide this parameter if it is known already, if this information is not known then application can pass CY_AUDIO_CODEC_CHANNEL_UNKNOWN.

◆ bitwidth

cy_audio_sw_codec_bitwidth_t cy_audio_sw_codec_decode_config_t::bitwidth

Bitwidth information.

Application needs to provide this parameter compulsory if the data to be decoded is not having the codec header (example: lc3 header). i.e.,If the codec header is not available in the stream and if the application has not passed this information, then codec-mw will not be able to decode any data.

If the data to be decoded has the codec header, then codec-mw will internally parse the codec header and extract this information. In this case, Application can optionally provide this parameter if it is known already, if this information is not known then application can pass CY_AUDIO_CODEC_BITWIDTH_UNKNOWN.

◆ stream_info

cy_audio_sw_codec_decode_stream_info_callback_t cy_audio_sw_codec_decode_config_t::stream_info

Decoded stream information callback.

Used to notify application about the information about the stream fed through cy_audio_sw_codec_decode().

Dynamic change of stream info is not supported. Change in the stream info is notified via this callback and application is expected to do deinit and init and decode new data.