Functions | |
| void | BSP_AUDIO_OUT_ChangeBuffer (uint16_t *pData, uint16_t Size) |
| Sends n-Bytes on the I2S interface. More... | |
| void | BSP_AUDIO_OUT_ClockConfig (I2S_HandleTypeDef *hi2s, uint32_t AudioFreq, void *Params) |
| Clock Config. More... | |
| void | BSP_AUDIO_OUT_Error_CallBack (void) |
| Manages the DMA FIFO error event. More... | |
| 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... | |
| void | BSP_AUDIO_OUT_MspDeInit (I2S_HandleTypeDef *hi2s, void *Params) |
| De-Initializes BSP_AUDIO_OUT MSP. More... | |
| void | BSP_AUDIO_OUT_MspInit (I2S_HandleTypeDef *hi2s, void *Params) |
| AUDIO OUT I2S MSP Init. More... | |
| uint8_t | BSP_AUDIO_OUT_Pause (void) |
| 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). 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) |
| 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). More... | |
| void | BSP_AUDIO_OUT_SetFrequency (uint32_t AudioFreq) |
| Update 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 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... | |
| void | BSP_AUDIO_OUT_TransferComplete_CallBack (void) |
| Manages the DMA full Transfer complete event. More... | |
Detailed Description
Function Documentation
◆ BSP_AUDIO_OUT_ChangeBuffer()
| void BSP_AUDIO_OUT_ChangeBuffer | ( | uint16_t * | pData, |
| uint16_t | Size | ||
| ) |
Sends n-Bytes on the I2S interface.
- Parameters
-
pData Pointer to data address Size Number of data to be written
Sends n-Bytes on the I2S interface.
- Parameters
-
pData pointer on PCM samples buffer Size number of data to be written
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 288 of file stm32f4_discovery_audio.c.
◆ BSP_AUDIO_OUT_ClockConfig()
| 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.
- 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 487 of file stm32f4_discovery_audio.c.
◆ BSP_AUDIO_OUT_Error_CallBack()
| void BSP_AUDIO_OUT_Error_CallBack | ( | void | ) |
Manages the DMA FIFO error event.
- Return values
-
None
Definition at line 651 of file stm32f4_discovery_audio.c.
◆ BSP_AUDIO_OUT_HalfTransfer_CallBack()
| void BSP_AUDIO_OUT_HalfTransfer_CallBack | ( | void | ) |
Manages the DMA Half Transfer complete event.
- Return values
-
None
Definition at line 644 of file stm32f4_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, 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
-
AUDIO_OK if correct communication, else wrong communication
- 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
- 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.
- Return values
-
AUDIO_OK if correct communication, else wrong communication
Definition at line 214 of file stm32f4_discovery_audio.c.
◆ BSP_AUDIO_OUT_MspDeInit()
| void BSP_AUDIO_OUT_MspDeInit | ( | I2S_HandleTypeDef * | hi2s, |
| void * | Params | ||
| ) |
De-Initializes BSP_AUDIO_OUT MSP.
- Parameters
-
hi2s might be required to set audio peripheral predivider if any. Params : pointer on additional configuration parameters, can be NULL.
Definition at line 599 of file stm32f4_discovery_audio.c.
◆ BSP_AUDIO_OUT_MspInit()
| void BSP_AUDIO_OUT_MspInit | ( | I2S_HandleTypeDef * | hi2s, |
| void * | Params | ||
| ) |
AUDIO OUT I2S MSP Init.
- Parameters
-
hi2s might be required to set audio peripheral predivider if any. Params : pointer on additional configuration parameters, can be NULL.
Definition at line 529 of file stm32f4_discovery_audio.c.
◆ BSP_AUDIO_OUT_Pause()
| uint8_t BSP_AUDIO_OUT_Pause | ( | void | ) |
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).
- Return values
-
AUDIO_OK if correct communication, else wrong communication
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
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).
- 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 behaviour).
- Return values
-
AUDIO_OK if correct communication, else wrong communication
Definition at line 301 of file stm32f4_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 266 of file stm32f4_discovery_audio.c.
◆ BSP_AUDIO_OUT_Resume()
| uint8_t BSP_AUDIO_OUT_Resume | ( | void | ) |
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
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
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).
- 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 behaviour).
- Return values
-
AUDIO_OK if correct communication, else wrong communication
Definition at line 325 of file stm32f4_discovery_audio.c.
◆ BSP_AUDIO_OUT_SetFrequency()
| void BSP_AUDIO_OUT_SetFrequency | ( | uint32_t | AudioFreq | ) |
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.
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.
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.
- Return values
-
None
Definition at line 443 of file stm32f4_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
- 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 401 of file stm32f4_discovery_audio.c.
◆ BSP_AUDIO_OUT_SetOutputMode()
| 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
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
- 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 423 of file stm32f4_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 381 of file stm32f4_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_HW: completely shut down the codec (physically). Then 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
- 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
- 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
- Parameters
-
Instance : AUDIO OUT Instance. It can only be 0 (SAI)
- Return values
-
BSP status
Definition at line 349 of file stm32f4_discovery_audio.c.
◆ BSP_AUDIO_OUT_TransferComplete_CallBack()
| void BSP_AUDIO_OUT_TransferComplete_CallBack | ( | void | ) |
Manages the DMA full Transfer complete event.
- Return values
-
None
Definition at line 637 of file stm32f4_discovery_audio.c.