Functions
uint8_t	BSP_AUDIO_OUT_Init (uint16_t OutputDevice, uint8_t Volume, uint32_t AudioFreq)
	Configures 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.
void	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.
uint8_t	BSP_AUDIO_OUT_SetMute (uint32_t Cmd)
	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_SetFrequency (uint32_t AudioFreq)
	Updates the audio frequency.
void	BSP_AUDIO_OUT_DeInit (void)
	Deinit the audio peripherals.
void	HAL_I2S_TxCpltCallback (I2S_HandleTypeDef *hi2s)
	Tx Transfer completed callbacks.
void	HAL_I2S_TxHalfCpltCallback (I2S_HandleTypeDef *hi2s)
	Tx Half Transfer completed callbacks.
void	HAL_I2S_ErrorCallback (I2S_HandleTypeDef *hi2s)
	I2S error callbacks.
__weak void	BSP_AUDIO_OUT_TransferComplete_CallBack (void)
	Manages the DMA full Transfer complete event.
__weak void	BSP_AUDIO_OUT_HalfTransfer_CallBack (void)
	Manages the DMA Half Transfer complete event.
__weak void	BSP_AUDIO_OUT_Error_CallBack (void)
	Manages the DMA FIFO error event.
__weak void	BSP_AUDIO_OUT_MspInit (I2S_HandleTypeDef hi2s, void Params)
	Initializes BSP_AUDIO_OUT MSP.
__weak void	BSP_AUDIO_OUT_MspDeInit (I2S_HandleTypeDef hi2s, void Params)
	Deinitializes I2S MSP.
__weak void	BSP_AUDIO_OUT_ClockConfig (I2S_HandleTypeDef hi2s, uint32_t AudioFreq, void Params)
	Clock Config.
static void	I2Sx_Out_Init (uint32_t AudioFreq)
	Initializes the Audio Codec audio interface (I2S)

Function Documentation

void 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

Definition at line 300 of file stm32f413h_discovery_audio.c.

__weak void BSP_AUDIO_OUT_ClockConfig	(	I2S_HandleTypeDef *	hi2s,
		uint32_t	AudioFreq,
		void *	Params
	)

Clock Config.

Parameters:

hi2s,:	might be required to set audio peripheral predivider if any.
AudioFreq,:	Audio frequency used to play the audio stream.
Params	: pointer on additional configuration parameters, can be NULL.

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

Definition at line 667 of file stm32f413h_discovery_audio.c.

void BSP_AUDIO_OUT_DeInit ( void )

Deinit the audio peripherals.

Definition at line 474 of file stm32f413h_discovery_audio.c.

__weak void BSP_AUDIO_OUT_Error_CallBack ( void )

Manages the DMA FIFO error event.

Definition at line 529 of file stm32f413h_discovery_audio.c.

__weak void BSP_AUDIO_OUT_HalfTransfer_CallBack ( void )

Manages the DMA Half Transfer complete event.

Definition at line 522 of file stm32f413h_discovery_audio.c.

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 I2S PLL input clock must be done in the user application.

Return values:

AUDIO_OK if correct communication, else wrong communication

Definition at line 220 of file stm32f413h_discovery_audio.c.

__weak void BSP_AUDIO_OUT_MspDeInit	(	I2S_HandleTypeDef *	hi2s,
		void *	Params
	)

Deinitializes I2S MSP.

Parameters:

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

Definition at line 620 of file stm32f413h_discovery_audio.c.

__weak void BSP_AUDIO_OUT_MspInit	(	I2S_HandleTypeDef *	hi2s,
		void *	Params
	)

Initializes BSP_AUDIO_OUT MSP.

Parameters:

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

Definition at line 538 of file stm32f413h_discovery_audio.c.

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 313 of file stm32f413h_discovery_audio.c.

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 279 of file stm32f413h_discovery_audio.c.

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 337 of file stm32f413h_discovery_audio.c.

void BSP_AUDIO_OUT_SetFrequency ( uint32_t AudioFreq )

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

Return values:

None

Definition at line 455 of file stm32f413h_discovery_audio.c.

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 413 of file stm32f413h_discovery_audio.c.

uint8_t BSP_AUDIO_OUT_SetOutputMode ( uint8_t Output )

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 434 of file stm32f413h_discovery_audio.c.

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 393 of file stm32f413h_discovery_audio.c.

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 365 of file stm32f413h_discovery_audio.c.

__weak void BSP_AUDIO_OUT_TransferComplete_CallBack ( void )

Manages the DMA full Transfer complete event.

Definition at line 515 of file stm32f413h_discovery_audio.c.

void HAL_I2S_ErrorCallback ( I2S_HandleTypeDef * hi2s )

I2S error callbacks.

Parameters:

hi2s,: I2S handle

Definition at line 507 of file stm32f413h_discovery_audio.c.

void HAL_I2S_TxCpltCallback ( I2S_HandleTypeDef * hi2s )