STM32L152D_EVAL_AUDIO_OUT_Exported_Functions

Functions
uint8_t	BSP_AUDIO_OUT_Init (uint16_t OutputDevice, uint8_t Volume, uint32_t AudioFreq)
	Configure the audio peripherals.
uint8_t	BSP_AUDIO_OUT_Play (uint16_t *pBuffer, uint32_t Size)
	Starts playing audio stream from a data buffer for a determined size.
uint8_t	BSP_AUDIO_OUT_ChangeBuffer (uint16_t *pData, uint16_t Size)
	Sends n-Bytes on the I2S interface.
uint8_t	BSP_AUDIO_OUT_Pause (void)
	This function Pauses the audio file stream.
uint8_t	BSP_AUDIO_OUT_Resume (void)
	This function Resumes the audio file stream.
uint8_t	BSP_AUDIO_OUT_Stop (uint32_t Option)
	Stops audio playing and Power down the Audio Codec.
uint8_t	BSP_AUDIO_OUT_SetVolume (uint8_t Volume)
	Controls the current audio volume level.
void	BSP_AUDIO_OUT_SetFrequency (uint32_t AudioFreq)
	Update the audio frequency.
uint8_t	BSP_AUDIO_OUT_SetMute (uint32_t Command)
	Enables or disables the MUTE mode by software.
uint8_t	BSP_AUDIO_OUT_SetOutputMode (uint8_t Output)
	Switch dynamically (while audio file is played) the output target (speaker or headphone).
void	BSP_AUDIO_OUT_TransferComplete_CallBack (void)
	Manages the DMA full Transfer complete event.
void	BSP_AUDIO_OUT_HalfTransfer_CallBack (void)
	Manages the DMA Half Transfer complete event.
void	BSP_AUDIO_OUT_Error_CallBack (void)
	Manages the DMA FIFO error event.

---

Function Documentation

uint8_t BSP_AUDIO_OUT_ChangeBuffer	(	uint16_t *	pData,
		uint16_t	Size
	)

Sends n-Bytes on the I2S interface.

Parameters:

pData,:	pointer on data address
Size,:	number of data to be written

Return values:

None

Definition at line 276 of file stm32l152d_eval_audio.c.

References hAudioOutI2s.

void BSP_AUDIO_OUT_Error_CallBack

(

void

)

Manages the DMA FIFO error event.

Return values:

None

Definition at line 456 of file stm32l152d_eval_audio.c.

Referenced by HAL_I2S_ErrorCallback().

void BSP_AUDIO_OUT_HalfTransfer_CallBack

(

void

)

Manages the DMA Half Transfer complete event.

Return values:

None

Definition at line 448 of file stm32l152d_eval_audio.c.

Referenced by HAL_I2S_TxHalfCpltCallback().

uint8_t BSP_AUDIO_OUT_Init	(	uint16_t	OutputDevice,
		uint8_t	Volume,
		uint32_t	AudioFreq
	)

Configure the audio peripherals.

Parameters:

OutputDevice,:	OUTPUT_DEVICE_SPEAKER, OUTPUT_DEVICE_HEADPHONE, OUTPUT_DEVICE_BOTH or OUTPUT_DEVICE_AUTO .
Volume,:	Initial volume level (from 0 (Mute) to 100 (Max))
AudioFreq,:	Audio frequency used to play the audio stream.

Return values:

0	if correct communication, else wrong communication

Definition at line 218 of file stm32l152d_eval_audio.c.

References AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, I2SOUT_Init(), and pAudioDrv.

uint8_t BSP_AUDIO_OUT_Pause

(

void

)

This function Pauses the audio file stream.

In case of using DMA, the DMA Pause feature is used.

Note:

When calling BSP_AUDIO_OUT_Pause() function for pause, only BSP_AUDIO_OUT_Resume() function should be called for resume (use of BSP_AUDIO_OUT_Play() function for resume could lead to unexpected behavior).

Return values:

AUDIO_OK

if correct communication, else wrong communication

Definition at line 289 of file stm32l152d_eval_audio.c.

References AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, hAudioOutI2s, and pAudioDrv.

uint8_t BSP_AUDIO_OUT_Play	(	uint16_t *	pBuffer,
		uint32_t	Size
	)

Starts playing audio stream from a data buffer for a determined size.

Parameters:

pBuffer,:	Pointer to the buffer
Size,:	Number of audio data BYTES.

Return values:

AUDIO_OK

if correct communication, else wrong communication

Definition at line 254 of file stm32l152d_eval_audio.c.

References AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, DMA_MAX, hAudioOutI2s, and pAudioDrv.

uint8_t BSP_AUDIO_OUT_Resume

(

void

)

This function Resumes the audio file stream.

Note:

When calling BSP_AUDIO_OUT_Pause() function for pause, only BSP_AUDIO_OUT_Resume() function should be called for resume (use of BSP_AUDIO_OUT_Play() function for resume could lead to unexpected behavior).

Return values:

AUDIO_OK

if correct communication, else wrong communication

Definition at line 313 of file stm32l152d_eval_audio.c.

References AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, hAudioOutI2s, and pAudioDrv.

void BSP_AUDIO_OUT_SetFrequency

(

uint32_t

AudioFreq

)

Update the audio frequency.

Parameters:

AudioFreq,:

Audio frequency used to play the audio stream.

Return values:

None

Note:

This API should be called after the BSP_AUDIO_OUT_Init() to adjust the audio frequency.

Definition at line 430 of file stm32l152d_eval_audio.c.

References I2SOUT_Init().

uint8_t BSP_AUDIO_OUT_SetMute

(

uint32_t

Cmd

)

Enables or disables the MUTE mode by software.

Parameters:

Cmd,:

could be AUDIO_MUTE_ON to mute sound or AUDIO_MUTE_OFF to unmute the codec and restore previous volume level.

Return values:

AUDIO_OK

if correct communication, else wrong communication

Definition at line 387 of file stm32l152d_eval_audio.c.

References AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, and pAudioDrv.

uint8_t BSP_AUDIO_OUT_SetOutputMode

(

uint8_t

Output

)

Switch dynamically (while audio file is played) the output target (speaker or headphone).

Note:

This function modifies a global variable of the audio codec driver: OutputDev.

Parameters:

Output,:

specifies the audio output target: OUTPUT_DEVICE_SPEAKER, OUTPUT_DEVICE_HEADPHONE, OUTPUT_DEVICE_BOTH or OUTPUT_DEVICE_AUTO

Return values:

AUDIO_OK

if correct communication, else wrong communication

Definition at line 409 of file stm32l152d_eval_audio.c.

References AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, and pAudioDrv.

uint8_t BSP_AUDIO_OUT_SetVolume

(

uint8_t

Volume

)

Controls the current audio volume level.

Parameters:

Volume,:

Volume level to be set in percentage from 0% to 100% (0 for Mute and 100 for Max volume level).

Return values:

AUDIO_OK

if correct communication, else wrong communication

Definition at line 367 of file stm32l152d_eval_audio.c.

References AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, and pAudioDrv.

uint8_t BSP_AUDIO_OUT_Stop

(

uint32_t

Option

)

Stops audio playing and Power down the Audio Codec.

Parameters:

Option,:

could be one of the following parameters CODEC_PDWN_HW: completely shut down the codec (physically). Then need to reconfigure the Codec after power on.

Return values:

AUDIO_OK

if correct communication, else wrong communication

Definition at line 336 of file stm32l152d_eval_audio.c.

References AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, AUDIO_RESET_GPIO, AUDIO_RESET_PIN, hAudioOutI2s, and pAudioDrv.

void BSP_AUDIO_OUT_TransferComplete_CallBack

(

void

)

Manages the DMA full Transfer complete event.

Return values:

None

Definition at line 440 of file stm32l152d_eval_audio.c.

Referenced by HAL_I2S_TxCpltCallback().