 |
STM32F769IDiscovery
1.00
uDANTE Audio Networking with STM32F7 DISCO board
|
|
STM32F769IDiscovery
1.00
uDANTE Audio Networking with STM32F7 DISCO board
|
This file provides the Audio driver for the STM32F769I-DISCOVERY board. More...
#include "stm32f769i_discovery_audio.h"Go to the source code of this file.
Data Structures | |
| struct | AUDIOIN_TypeDef |
Macros | |
| #define | DFSDM_OVER_SAMPLING(__FREQUENCY__) |
| #define | DFSDM_CLOCK_DIVIDER(__FREQUENCY__) |
| #define | DFSDM_FILTER_ORDER(__FREQUENCY__) |
| #define | DFSDM_RIGHT_BIT_SHIFT(__FREQUENCY__) |
| #define | SaturaLH(N, L, H) (((N)<(L))?(L):(((N)>(H))?(H):(N))) |
Functions | |
| uint8_t | BSP_AUDIO_OUT_Init (uint16_t OutputDevice, uint8_t Volume, uint32_t AudioFreq) |
| Configures the audio peripherals. 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... | |
| void | BSP_AUDIO_OUT_Restart (uint16_t *pBuffer, uint32_t Size) |
| void | BSP_AUDIO_OUT_ChangeBuffer (uint16_t *pData, uint16_t Size) |
| Sends n-Bytes on the SAI interface. 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. 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... | |
| uint8_t | BSP_AUDIO_OUT_Resume (void) |
| Resumes the audio file stream. 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). More... | |
| uint8_t | BSP_AUDIO_OUT_Stop (uint32_t Option) |
| Stops audio playing and Power down the Audio Codec. More... | |
| uint8_t | BSP_AUDIO_OUT_SetVolume (uint8_t Volume) |
| Controls the current audio volume level. 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... | |
| void | BSP_AUDIO_OUT_SetFrequency (uint32_t AudioFreq) |
| Updates the audio frequency. More... | |
| void | BSP_AUDIO_OUT_SetAudioFrameSlot (uint32_t AudioFrameSlot) |
| Updates the Audio frame slot configuration. More... | |
| void | BSP_AUDIO_OUT_DeInit (void) |
| De-initializes the audio out peripheral. 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... | |
| void | HAL_SAI_ErrorCallback (SAI_HandleTypeDef *hsai) |
| SAI error callbacks. More... | |
| __weak void | BSP_AUDIO_OUT_TransferComplete_CallBack (void) |
| Manages the DMA full Transfer complete event. More... | |
| __weak void | BSP_AUDIO_OUT_HalfTransfer_CallBack (void) |
| Manages the DMA Half Transfer complete event. More... | |
| __weak void | BSP_AUDIO_OUT_Error_CallBack (void) |
| Manages the DMA FIFO error event. More... | |
| __weak void | BSP_AUDIO_OUT_MspInit (SAI_HandleTypeDef *hsai, void *Params) |
| Initializes BSP_AUDIO_OUT MSP. More... | |
| __weak void | BSP_AUDIO_OUT_MspDeInit (SAI_HandleTypeDef *hsai, void *Params) |
| Deinitializes SAI MSP. More... | |
| __weak void | BSP_AUDIO_OUT_ClockConfig (SAI_HandleTypeDef *hsai, uint32_t AudioFreq, void *Params) |
| Clock Config. More... | |
| uint8_t | BSP_AUDIO_IN_Init (uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr) |
| Initialize wave recording. More... | |
| uint8_t | BSP_AUDIO_IN_InitEx (uint16_t InputDevice, uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr) |
| Initialize wave recording. More... | |
| uint8_t | BSP_AUDIO_IN_AllocScratch (int32_t *pScratch, uint32_t size) |
| Allocate channel buffer scratch. More... | |
| uint8_t | BSP_AUDIO_IN_GetChannelNumber (void) |
| Return audio in channel number. More... | |
| uint8_t | BSP_AUDIO_IN_Record (uint16_t *pbuf, uint32_t size) |
| Start audio recording. More... | |
| uint8_t | BSP_AUDIO_IN_Stop (void) |
| Stop audio recording. More... | |
| uint8_t | BSP_AUDIO_IN_Pause (void) |
| Pause the audio file stream. More... | |
| uint8_t | BSP_AUDIO_IN_Resume (void) |
| Resume the audio file stream. More... | |
| void | BSP_AUDIO_IN_DeInit (void) |
| Deinit the audio IN peripherals. More... | |
| void | HAL_DFSDM_FilterRegConvCpltCallback (DFSDM_Filter_HandleTypeDef *hdfsdm_filter) |
| Regular conversion complete callback. More... | |
| void | HAL_DFSDM_FilterRegConvHalfCpltCallback (DFSDM_Filter_HandleTypeDef *hdfsdm_filter) |
| Half regular conversion complete callback. More... | |
| void | HAL_SAI_RxHalfCpltCallback (SAI_HandleTypeDef *hsai) |
| Half reception complete callback. More... | |
| void | HAL_SAI_RxCpltCallback (SAI_HandleTypeDef *hsai) |
| Reception complete callback. More... | |
| __weak void | BSP_AUDIO_IN_TransferComplete_CallBack (void) |
| User callback when record buffer is filled. More... | |
| __weak void | BSP_AUDIO_IN_HalfTransfer_CallBack (void) |
| Manages the DMA Half Transfer complete event. More... | |
| __weak void | BSP_AUDIO_IN_Error_CallBack (void) |
| Audio IN Error callback function. More... | |
| __weak void | BSP_AUDIO_IN_MspInit (void) |
| Initialize BSP_AUDIO_IN MSP. More... | |
| __weak void | BSP_AUDIO_IN_MspDeInit (void) |
| DeInitialize BSP_AUDIO_IN MSP. More... | |
| __weak void | BSP_AUDIO_IN_ClockConfig (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t AudioFreq, void *Params) |
| Clock Config. More... | |
Variables | |
| AUDIO_DrvTypeDef * | audio_drv |
| SAI_HandleTypeDef | haudio_out_sai |
| SAI_HandleTypeDef | haudio_in_sai |
| AUDIOIN_TypeDef | hAudioIn |
| DFSDM_Channel_HandleTypeDef | hAudioInTopLeftChannel |
| DFSDM_Channel_HandleTypeDef | hAudioInTopRightChannel |
| DFSDM_Filter_HandleTypeDef | hAudioInTopLeftFilter |
| DFSDM_Filter_HandleTypeDef | hAudioInTopRightFilter |
| DMA_HandleTypeDef | hDmaTopLeft |
| DMA_HandleTypeDef | hDmaTopRight |
| DFSDM_Channel_HandleTypeDef | hAudioInButtomLeftChannel |
| DFSDM_Channel_HandleTypeDef | hAudioInButtomRightChannel |
| DFSDM_Filter_HandleTypeDef | hAudioInButtomLeftFilter |
| DFSDM_Filter_HandleTypeDef | hAudioInButtomRightFilter |
| DMA_HandleTypeDef | hDmaButtomLeft |
| DMA_HandleTypeDef | hDmaButtomRight |
This file provides the Audio driver for the STM32F769I-DISCOVERY board.
How To use this driver:
-----------------------
+ This driver supports STM32F7xx devices on STM32F769I-DISCOVERY (MB1225) Evaluation boards.
+ Call the function BSP_AUDIO_OUT_Init(
OutputDevice: physical output mode (OUTPUT_DEVICE_SPEAKER,
OUTPUT_DEVICE_HEADPHONE or OUTPUT_DEVICE_BOTH)
Volume : Initial volume to be set (0 is min (mute), 100 is max (100%)
AudioFreq : Audio frequency in Hz (8000, 16000, 22500, 32000...)
this parameter is relative to the audio file/stream type.
)
This function configures all the hardware required for the audio application (codec, I2C, SAI,
GPIOs, DMA and interrupt if needed). This function returns AUDIO_OK if configuration is OK.
If the returned value is different from AUDIO_OK or the function is stuck then the communication with
the codec has failed (try to un-plug the power or reset device in this case).
- OUTPUT_DEVICE_SPEAKER : only speaker will be set as output for the audio stream.
- OUTPUT_DEVICE_HEADPHONE: only headphones will be set as output for the audio stream.
- OUTPUT_DEVICE_BOTH : both Speaker and Headphone are used as outputs for the audio stream
at the same time.
Note. On STM32F769I-DISCOVERY SAI_DMA is configured in CIRCULAR mode. Due to this the application
does NOT need to call BSP_AUDIO_OUT_ChangeBuffer() to assure streaming.
+ Call the function BSP_AUDIO_OUT_Play(
pBuffer: pointer to the audio data file address
Size : size of the buffer to be sent in Bytes
)
to start playing (for the first time) from the audio file/stream.
+ Call the function BSP_AUDIO_OUT_Pause() to pause playing
+ Call the function BSP_AUDIO_OUT_Resume() to resume playing.
Note. After calling BSP_AUDIO_OUT_Pause() function for pause, only BSP_AUDIO_OUT_Resume() should be called
for resume (it is not allowed to call BSP_AUDIO_OUT_Play() in this case).
Note. This function should be called only when the audio file is played or paused (not stopped).
+ For each mode, you may need to implement the relative callback functions into your code.
The Callback functions are named BSP_AUDIO_OUT_XXX_CallBack() and only their prototypes are declared in
the stm32f769i_discovery_audio.h file. (refer to the example for more details on the callbacks implementations)
+ To Stop playing, to modify the volume level, the frequency, the audio frame slot,
the device output mode the mute or the stop, use the functions: BSP_AUDIO_OUT_SetVolume(),
AUDIO_OUT_SetFrequency(), BSP_AUDIO_OUT_SetAudioFrameSlot(), BSP_AUDIO_OUT_SetOutputMode(),
BSP_AUDIO_OUT_SetMute() and BSP_AUDIO_OUT_Stop().
+ Call the function BSP_AUDIO_IN_Init(
AudioFreq: Audio frequency in Hz (8000, 16000, 22500, 32000...)
this parameter is relative to the audio file/stream type.
BitRes: Bit resolution fixed to 16bit
ChnlNbr: Number of channel to be configured for the DFSDM peripheral
)
This function configures all the hardware required for the audio in application (DFSDM filters and channels,
Clock source for DFSDM periphiral, GPIOs, DMA and interrupt if needed).
This function returns AUDIO_OK if configuration is OK.If the returned value is different from AUDIO_OK then
the configuration should be wrong.
Note: On STM32F769I-DISCOVERY, four DFSDM Channel/Filters are configured and their DMA streams are configured
in CIRCULAR mode.
+ Call the function BSP_AUDIO_IN_AllocScratch(
pScratch: pointer to scratch tables
size: size of scratch buffer)
This function must be called before BSP_AUDIO_IN_RECORD() to allocate buffer scratch for each DFSDM channel
and its size.
Note: These buffers scratch are used as intermidiate buffers to collect data within final record buffer.
size is the total size of the four buffers scratch; If size is 512 then the size of each is 128.
This function must be called after BSP_AUDIO_IN_Init()
+ Call the function BSP_AUDIO_IN_RECORD(
pBuf: pointer to the recorded audio data file address
Size: size of the buffer to be written in Bytes
)
to start recording from microphones.
+ Call the function BSP_AUDIO_IN_Pause() to pause recording
+ Call the function BSP_AUDIO_IN_Resume() to recording playing.
Note. After calling BSP_AUDIO_IN_Pause() function for pause, only BSP_AUDIO_IN_Resume() should be called
for resume (it is not allowed to call BSP_AUDIO_IN_RECORD() in this case).
+ Call the function BSP_AUDIO_IN_Stop() to stop recording
+ For each mode, you may need to implement the relative callback functions into your code.
The Callback functions are named BSP_AUDIO_IN_XXX_CallBack() and only their prototypes are declared in
the stm32f769i_discovery_audio.h file. (refer to the example for more details on the callbacks implementations)
Driver architecture:
--------------------
+ This driver provides the High Audio Layer: consists of the function API exported in the stm32f769i_discovery_audio.h file
(BSP_AUDIO_OUT_Init(), BSP_AUDIO_OUT_Play() ...)
+ This driver provide also the Media Access Layer (MAL): which consists of functions allowing to access the media containing/
providing the audio file/stream. These functions are also included as local functions into
the stm32f769i_discovery_audio.c file (DFSDMx_Init(), DFSDMx_DeInit(), SAIx_Init() and SAIx_DeInit())
Known Limitations:
------------------
1- If the TDM Format used to play in parallel 2 audio Stream (the first Stream is configured in codec SLOT0 and second
Stream in SLOT1) the Pause/Resume, volume and mute feature will control the both streams.
2- Parsing of audio file is not implemented (in order to determine audio file properties: Mono/Stereo, Data size,
File size, Audio Frequency, Audio Data header size ...). The configuration is fixed for the given audio file.
3- Supports only Stereo audio streaming.
4- Supports only 16-bits audio data size.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Definition in file stm32f769i_discovery_audio.c.
1.8.11