Data Structures
struct	wiced_bt_audio_config_buffer_t
	Audio buffer configuration structure Please refer wiced_audio_buffer_initialize API documentation for recommended size. More...

struct	wiced_bt_a2dp_statistics_t
	A2DP statistics structure. More...

Macros
#define	WICED_BT_AUDIO_PCM_DATA_SIZE_IN_AN_AUDIO_FRAME 1024
	The audio data (PCM data) size in bytes in an outgoing A2DP audio frame. More...

Typedefs
typedef void(*	wiced_audio_suspend_complete_cback_t )(void)
	Audio suspend complete callback.

typedef void(*	wiced_audio_buffer_empty_cback_t )(uint32_t total_intr_count, uint32_t total_empty_count, uint32_t consecutive_empty_count)
	Audio buffer empty callback. More...

typedef void(*	wiced_audio_congestion_status_cback_t )(wiced_bool_t is_congested)
	Audio congestion status callback. More...

typedef void(	wiced_audio_request_samples_callback_t )(uint8_t num_packets, uint32_t packet_audio_size, uint32_t req_pkt_count, uint32_t rx_pkt_count)
	Audio Request Samples callback. More...

Enumerations
enum	wiced_audio_route_t { AUDIO_ROUTE_I2S = 0x00, AUDIO_ROUTE_UART = 0x01, AUDIO_ROUTE_SINE = 0x02, AUDIO_ROUTE_COMPRESSED_TRANSPORT = 0x04 }
	wiced audio routes More...

enum	wiced_device_role_t { WICED_AUDIO_SOURCE_ROLE = 1 << 1, WICED_AUDIO_SINK_ROLE = 1 << 2, WICED_HF_ROLE = 1 << 3 }
	wiced device roles More...

Functions
wiced_result_t	wiced_audio_buffer_initialize (wiced_bt_audio_config_buffer_t wiced_audio_cfg_pool)
	Function wiced_audio_buffer_initialize. More...

void	wiced_audio_start (int is_master, int audio_route, uint16_t lcid, wiced_bt_a2d_sbc_cie_t *pSbc)
	Function wiced_audio_start. More...

void	wiced_audio_stop (uint16_t lcid)
	Function wiced_audio_stop. More...

void	wiced_audio_suspend (uint16_t lcid, wiced_audio_suspend_complete_cback_t p_cback)
	Function wiced_audio_suspend. More...

void	wiced_audio_register_buffer_empty_cback (wiced_audio_buffer_empty_cback_t p_cback)
	Function wiced_audio_register_buffer_empty_cback. More...

void	wiced_audio_use_sw_timing (int enable)
	Function wiced_audio_use_sw_timing. More...

void	wiced_audio_set_sinwave (int16_t *pIn)
	Function wiced_audio_set_sinwave. More...

void	wiced_audio_get_statistics (wiced_bt_a2dp_statistics_t *buffer_stat)
	Function wiced_audio_get_statistics. More...

void	wiced_audio_register_congestion_cback (wiced_audio_congestion_status_cback_t p_congestion_stat)
	Function wiced_audio_register_congestion_cback. More...

wiced_result_t	wiced_audio_samples_route_init (wiced_audio_request_samples_callback_t *p_callback)
	Function wiced_audio_samples_route_init. More...

wiced_bool_t	wiced_audio_samples_set (uint8_t *p_in, uint32_t size)
	Function wiced_audio_samples_set. More...

wiced_bool_t	wiced_mp3_codec_dec_init (void *p_mem)
	Initialize the MP3 decoder. More...

uint32_t	wiced_mp3_codec_dec_audio_frame_dec (void p_in, void p_out, uint32_t in_size)
	wiced_mp3_codec_dec_audio_frame_dec More...

Detailed Description

Macro Definition Documentation

#define WICED_BT_AUDIO_PCM_DATA_SIZE_IN_AN_AUDIO_FRAME 1024

The audio data (PCM data) size in bytes in an outgoing A2DP audio frame.

Typedef Documentation

typedef void( * wiced_audio_buffer_empty_cback_t)(uint32_t total_intr_count, uint32_t total_empty_count, uint32_t consecutive_empty_count)

Audio buffer empty callback.

Callback invoked on audio buffer empty event. Registered using wiced_audio_register_buffer_empty_cback()

Parameters

total_intr_count	: Total number of i2s interrupts
total_empty_count	: Total number of times the audio buffer is empty
consecutive_empty_count	: Number of consecutive times the audio buffer is empty, resets on receiving audio data

typedef void(* wiced_audio_congestion_status_cback_t)(wiced_bool_t is_congested)

Audio congestion status callback.

Callback invoked when there is a change in the audio stream congestion status. This gets invoked when the audio stream is congested and also when the congestion is cleared

Parameters

is_congested : TRUE - when the audio stream is congested FALSE - when the congestion is cleared

typedef void( wiced_audio_request_samples_callback_t)(uint8_t num_packets, uint32_t packet_audio_size, uint32_t req_pkt_count, uint32_t rx_pkt_count)

Audio Request Samples callback.

Callback invoked when the litehost requires the audio data (PCM data) to compose the outgoing A2DP frames.

Parameters

[in]	num_packets	: number of packes in a packet count
[in]	packet_audio_size	: data (PCM data) size in bytes in a audio packet This shall be WICED_BT_AUDIO_PCM_DATA_SIZE_IN_AN_AUDIO_FRAME
[in]	req_pkt_count	: requested packet count for outgoing transmission
[in]	rx_pkt_count	: received packet count (ignored)

Enumeration Type Documentation

enum wiced_audio_route_t

wiced audio routes

Enumerator
AUDIO_ROUTE_I2S	Route the PCM Samples over I2S. Read from I2S in case of audio source,write to I2S in case of audio sink
AUDIO_ROUTE_UART	Route the PCM samples over transport. Receive the audio data to be sent OTA from transport in case of audio source.Receive the audio data OTA, decode and send to transport in case of audio sink
AUDIO_ROUTE_SINE	Route the stored sine samples over the air. Applicable in case of audio source
AUDIO_ROUTE_COMPRESSED_TRANSPORT	Route the compressed audio data(AVDTP media packet, including the header) over transport. Receive the audio data OTA and send to transport. Applicable in case of audio sink

enum wiced_device_role_t

wiced device roles

Enumerator
WICED_AUDIO_SOURCE_ROLE	Audio Source.
WICED_AUDIO_SINK_ROLE	Audio Sink.
WICED_HF_ROLE	Handsfree.

Function Documentation

wiced_result_t wiced_audio_buffer_initialize ( wiced_bt_audio_config_buffer_t wiced_audio_cfg_pool )

Function wiced_audio_buffer_initialize.

Audio buffer initialization. Allocates the audio buffer and returns pointer to the audio buffer. This buffer is used by the a2dp source to hold the audio data received over the transport from the host

Parameters

[in] wiced_audio_cfg_pool : Size of the audio tx buffer and codec buffer to be allocated

Returns: WICED_SUCCESS if Success, otherwise WICED_NO_MEMORY.

NOTE : Recommended audio_tx_buffer_size : If the application includes A2DP source profile, the transport buffer size shall be set to at least 8KB. In case of A2DP sink profile, set the transport buffer size (recommended size 0x1c00) if required to send the encoded/decoded data over the transport.

Recommended audio_codec_buffer_size:

In case of A2DP sink profile, set the transport buffer size if required to send the audio data over the transport

| MSBC (WBS CODEC)* | 13KB = 5KB(for Encoding)+ 8KB(for Decoding) |

TODO : Provide formula for calculating Jitter Buffer

In case of multiple profiles used by application simultaneously, example A2DP sink and HFP device profiles, size specified should be the maximum of the recommended value for each profile supported.

void wiced_audio_get_statistics ( wiced_bt_a2dp_statistics_t * buffer_stat )

Function wiced_audio_get_statistics.

Used by the A2DP source to read A2DP streaming statistics

Parameters

[out] buffer_stat : pointer to fill statistics.

Returns: void

void wiced_audio_register_buffer_empty_cback ( wiced_audio_buffer_empty_cback_t p_cback )

Function wiced_audio_register_buffer_empty_cback.

Register the callback function to be invoked on audio buffer empty event

Parameters

[in] p_cback : callback function to be invoked on audio buffer empty event

Returns: void

void wiced_audio_register_congestion_cback ( wiced_audio_congestion_status_cback_t p_congestion_stat )

Function wiced_audio_register_congestion_cback.

Register the callback function to be invoked on audio stream congestion status change event

Parameters

[in] p_cback : callback function to be invoked on audio stream congestion status change event

Returns: void

wiced_result_t wiced_audio_samples_route_init ( wiced_audio_request_samples_callback_t * p_callback )

Function wiced_audio_samples_route_init.

Register to callback function to be invoked when the litehost prepares to compose the outgoing audio frames.

Parameters

[in] p_callback : callback function to be invoked

Returns: WICED_SUCCESS

wiced_bool_t wiced_audio_samples_set	(	uint8_t *	p_in,
		uint32_t	size
	)

Function wiced_audio_samples_set.

Set audio data (PCM data) to the outgoing A2DP audio data.

Parameters

[in]	p_in	: pointer to the PCM data
[in]	size	: length of PCM data in bytes

Returns: WICED_TRUE : Success WICED_FALSE : Fail

void wiced_audio_set_sinwave ( int16_t * pIn )

Function wiced_audio_set_sinwave.

Used by the A2DP source to set the sine audio samples to be used in audio streaming when the audio route is set to sine.

Parameters

[in] pOut : sine audio samples

Returns: void

void wiced_audio_start	(	int	is_master,
		int	audio_route,
		uint16_t	lcid,
		wiced_bt_a2d_sbc_cie_t *	pSbc
	)

Function wiced_audio_start.

Used by the A2DP source to start the audio streaming. I2S interrupts are used for timing the audio data by default. Software timer can also be used for timing the audio data which can be enabled by using the API wiced_audio_use_sw_timing. Enable the software timer before invoking wiced_audio_start

Parameters

[in]	is_master	: If the I2S has to configured as master when using I2S interrupts for timing the audio data. Set to 1 to configure I2S in the master mode. Set to 0 to configure the I2S in the slave mode.
[in]	audio_route	: Audio route to be configured. Configure as AUDIO_ROUTE_I2S if the audio source is I2S Configure as AUDIO_ROUTE_UART if the audio source is FILE Configure as AUDIO_ROUTE_SINE if the audio source is the stored sine wave
[in]	lcid	: lcid
[in]	pSbc	: SBC codec info

Returns: void

void wiced_audio_stop ( uint16_t lcid )

Function wiced_audio_stop.

To stop the audio streaming

Parameters

[in] lcid : lcid

Returns: void

void wiced_audio_suspend	(	uint16_t	lcid,
		wiced_audio_suspend_complete_cback_t	p_cback
	)

Function wiced_audio_suspend.

To suspend the audio streaming

Parameters

[in] lcid : lcid

Returns: void

void wiced_audio_use_sw_timing ( int enable )

Function wiced_audio_use_sw_timing.

Used by the A2DP source to time the audio data using software timer. Sofware timer internally uses slot timer to time the audio data. Period of the software timer is determined based on the chosen audio codec sampling frequency and the number of samples. Note: I2S interrupts are used for timing the audio data by default. Software timer can also be used for timing the audio data which can be enabled by using the API wiced_audio_use_sw_timing. Enable the software timer before invoking wiced_audio_start.

Parameters

[in] enable : enables the sw timer

Returns: void

uint32_t wiced_mp3_codec_dec_audio_frame_dec	(	void *	p_in,
		void *	p_out,
		uint32_t	in_size
	)

wiced_mp3_codec_dec_audio_frame_dec

Decode the MP3 Audio Frame into PCM samples. A MP3 Audio Frame includes a Audio Frame Header and a Audio Frame Body. The MP3 Audio Frame shall start with the Audio Frame Header.

Parameters

[in]	p_in	: point to the input MP3 Audio Frame
[out]	p_out	: point to the output PCM samples
[in]	in_size	: size of the input MP3 Audio Frame in bytes

Returns: Size in bytes of the PCM data in output buffer

wiced_bool_t wiced_mp3_codec_dec_init ( void * p_mem )

Initialize the MP3 decoder.

Parameters

p_mem[in] : pointer to the allocated buffer used for decoding

Returns: WICED_TRUE : Success WICED_FALSE : Fail


			AIROC^™ BTSDK v4.9 - Documentation

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

In case of A2DP sink profile, set the transport buffer size if required to send the audio data over the transport

| MSBC (WBS CODEC)* | 13KB = 5KB(for Encoding)+ 8KB(for Decoding) |