Collaboration diagram for STM32469I Discovery AUDIO OUT Private Functions:

Functions
void	BSP_AUDIO_OUT_ChangeAudioConfig (uint32_t AudioOutOption)
	Changes the Audio Out Configuration. More...

void	BSP_AUDIO_OUT_ChangeBuffer (uint16_t *pData, uint16_t Size)
	Sends n-Bytes on the SAI interface. More...

__weak void	BSP_AUDIO_OUT_ClockConfig (SAI_HandleTypeDef hsai, uint32_t AudioFreq, void Params)
	Clock Config. More...

void	BSP_AUDIO_OUT_DeInit (void)
	Deinit the audio peripherals. More...

__weak void	BSP_AUDIO_OUT_Error_CallBack (void)
	Manages the DMA FIFO error event. More...

__weak void	BSP_AUDIO_OUT_HalfTransfer_CallBack (void)
	Manages the DMA Half Transfer complete event. More...

uint8_t	BSP_AUDIO_OUT_Init (uint16_t OutputDevice, uint8_t Volume, uint32_t AudioFreq)
	Configures the audio peripherals. More...

__weak void	BSP_AUDIO_OUT_MspDeInit (SAI_HandleTypeDef hsai, void Params)
	Deinitializes BSP_AUDIO_OUT MSP. More...

__weak void	BSP_AUDIO_OUT_MspInit (SAI_HandleTypeDef hsai, void Params)
	Initializes BSP_AUDIO_OUT MSP. More...

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. More...

uint8_t	BSP_AUDIO_OUT_Play (uint16_t *pBuffer, uint32_t Size)
	Starts playing audio stream from a data buffer for a determined size. More...

uint8_t	BSP_AUDIO_OUT_Resume (void)
	This function Resumes the audio file stream. WARNING: 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). More...

void	BSP_AUDIO_OUT_SetAudioFrameSlot (uint32_t AudioFrameSlot)
	Updates the Audio frame slot configuration. More...

void	BSP_AUDIO_OUT_SetFrequency (uint32_t AudioFreq)
	Updates the audio frequency. More...

uint8_t	BSP_AUDIO_OUT_SetMute (uint32_t Cmd)
	Enables or disables the MUTE mode by software. More...

uint8_t	BSP_AUDIO_OUT_SetOutputMode (uint8_t Output)
	Switch dynamically (while audio file is being played) the output target (speaker or headphone). More...

uint8_t	BSP_AUDIO_OUT_SetVolume (uint8_t Volume)
	Controls the current audio volume level. More...

uint8_t	BSP_AUDIO_OUT_Stop (uint32_t Option)
	Stops audio playing and Power down the Audio Codec. More...

__weak void	BSP_AUDIO_OUT_TransferComplete_CallBack (void)
	Manages the DMA full Transfer complete event. More...

void	HAL_SAI_ErrorCallback (SAI_HandleTypeDef *hsai)
	SAI error callbacks. More...

void	HAL_SAI_TxCpltCallback (SAI_HandleTypeDef *hsai)
	Tx Transfer completed callbacks. More...

void	HAL_SAI_TxHalfCpltCallback (SAI_HandleTypeDef *hsai)
	Tx Half Transfer completed callbacks. More...

static uint8_t	SAIx_Init (uint32_t AudioFreq)
	Initializes the Audio Codec audio interface (SAI). More...

Detailed Description

Function Documentation

◆ BSP_AUDIO_OUT_ChangeAudioConfig()

void BSP_AUDIO_OUT_ChangeAudioConfig ( uint32_t AudioOutOption )

Changes the Audio Out Configuration.

Parameters

AudioOutOption specifies the audio out new configuration This parameter can be any value of BSP AUDIO OUT Option

Note: This API should be called after the BSP_AUDIO_OUT_Init() to adjust the audio out configuration.

Definition at line 516 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_ChangeBuffer()

void BSP_AUDIO_OUT_ChangeBuffer	(	uint16_t *	pData,
		uint16_t	Size
	)

Sends n-Bytes on the SAI interface.

Sends n-Bytes on the I2S interface.

Parameters

pData	pointer on PCM samples buffer
Size	number of data to be written

Definition at line 322 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_ClockConfig()

__weak void BSP_AUDIO_OUT_ClockConfig	(	SAI_HandleTypeDef *	hsai,
		uint32_t	AudioFreq,
		void *	Params
	)

Clock Config.

Parameters

hsai	might be required to set audio peripheral predivider if any.
AudioFreq	Audio frequency used to play the audio stream.

Note: This API is called by BSP_AUDIO_OUT_Init() and BSP_AUDIO_OUT_SetFrequency() Being __weak it can be overwritten by the application

Parameters

Params : pointer on additional configuration parameters, can be NULL.

Definition at line 783 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_DeInit()

void BSP_AUDIO_OUT_DeInit ( void )

Deinit the audio peripherals.

Definition at line 592 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_Error_CallBack()

__weak void BSP_AUDIO_OUT_Error_CallBack ( void )

Manages the DMA FIFO error event.

Definition at line 650 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_HalfTransfer_CallBack()

__weak void BSP_AUDIO_OUT_HalfTransfer_CallBack ( void )

Manages the DMA Half Transfer complete event.

Definition at line 643 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_Init()

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

Configures the audio peripherals.

Parameters

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

Note: The SAI PLL input clock must be done in the user application.

Return values

AUDIO_OK if correct communication, else wrong communication

Definition at line 235 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_MspDeInit()

__weak void BSP_AUDIO_OUT_MspDeInit	(	SAI_HandleTypeDef *	hsai,
		void *	Params
	)

Deinitializes BSP_AUDIO_OUT MSP.

Parameters

hsai	SAI handle
Params	: pointer on additional configuration parameters, can be NULL.

Definition at line 737 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_MspInit()

__weak void BSP_AUDIO_OUT_MspInit	(	SAI_HandleTypeDef *	hsai,
		void *	Params
	)

Initializes BSP_AUDIO_OUT MSP.

Parameters

hsai	SAI handle
Params	: pointer on additional configuration parameters, can be NULL.

Definition at line 659 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_Pause()

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.

Pauses the audio file stream. In case of using DMA, the DMA Pause feature is used. WARNING: When calling BSP_AUDIO_OUT_Pause() function for pause, only the BSP_AUDIO_OUT_Resume() function should be called for resume (use of BSP_AUDIO_OUT_Play() function for resume could lead to unexpected behavior).

Warning: 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 335 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_Play()

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 295 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_Resume()

uint8_t BSP_AUDIO_OUT_Resume ( void )

This function Resumes the audio file stream. WARNING: 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).

Resumes the audio file streaming.
WARNING: 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 366 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_SetAudioFrameSlot()

void BSP_AUDIO_OUT_SetAudioFrameSlot ( uint32_t AudioFrameSlot )

Updates the Audio frame slot configuration.

Parameters

AudioFrameSlot specifies the audio Frame slot This parameter can be any value of STM32469I Discovery Audio Slot TDM mode

Note: This API should be called after the BSP_AUDIO_OUT_Init() to adjust the audio frame slot.

Definition at line 576 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_SetFrequency()

void BSP_AUDIO_OUT_SetFrequency ( uint32_t AudioFreq )

Updates the audio frequency.

Update the audio frequency.

Parameters

AudioFreq Audio frequency used to play the audio stream.

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

Definition at line 493 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_SetMute()

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 452 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_SetOutputMode()

uint8_t BSP_AUDIO_OUT_SetOutputMode ( uint8_t Output )

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

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

Parameters

Output The audio output target: OUTPUT_DEVICE_SPEAKER, OUTPUT_DEVICE_HEADPHONE or OUTPUT_DEVICE_BOTH

Return values

AUDIO_OK if correct communication, else wrong communication

Definition at line 473 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_SetVolume()

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 432 of file stm32469i_discovery_audio.c.

◆ BSP_AUDIO_OUT_Stop()

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_SW: for software power off (by writing registers). Then no need to reconfigure the Codec after power on.
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 398 of file stm32469i_discovery_audio.c.