STM32F769I-Discovery BSP User Manual: STM32F769I_DISCOVERY_AUDIO_IN Exported Functions

STM32F769I-Discovery BSP Drivers

STM32F769I-Discovery BSP User Manual
STM32F769I_DISCOVERY_AUDIO_IN Exported Functions

Functions

uint8_t BSP_AUDIO_IN_Init (uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr)
 Initialize wave recording.
uint8_t BSP_AUDIO_IN_InitEx (uint16_t InputDevice, uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr)
 Initialize wave recording.
uint8_t BSP_AUDIO_IN_AllocScratch (int32_t *pScratch, uint32_t size)
 Allocate channel buffer scratch.
uint8_t BSP_AUDIO_IN_GetChannelNumber (void)
 Return audio in channel number.
void BSP_AUDIO_IN_DeInit (void)
 Deinit the audio IN peripherals.
uint8_t BSP_AUDIO_IN_Record (uint16_t *pData, uint32_t Size)
 Start audio recording.
uint8_t BSP_AUDIO_IN_Stop (void)
 Stop audio recording.
uint8_t BSP_AUDIO_IN_Pause (void)
 Pause the audio file stream.
uint8_t BSP_AUDIO_IN_Resume (void)
 Resume the audio file stream.
void BSP_AUDIO_IN_TransferComplete_CallBack (void)
 User callback when record buffer is filled.
void BSP_AUDIO_IN_HalfTransfer_CallBack (void)
 Manages the DMA Half Transfer complete event.
void BSP_AUDIO_IN_Error_CallBack (void)
 Audio IN Error callback function.
void BSP_AUDIO_IN_ClockConfig (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t AudioFreq, void *Params)
 Clock Config.
void BSP_AUDIO_IN_MspInit (void)
 Initialize BSP_AUDIO_IN MSP.
void BSP_AUDIO_IN_MspDeInit (void)
 DeInitialize BSP_AUDIO_IN MSP.

Function Documentation

uint8_t BSP_AUDIO_IN_AllocScratch ( int32_t *  pScratch,
uint32_t  size 
)

Allocate channel buffer scratch.

Parameters:
pScratch: pointer to scratch tables.
sizeof scratch buffer

Definition at line 1194 of file stm32f769i_discovery_audio.c.

References AUDIO_OK, AudioIn_ChannelNumber, pScratchBuff, and ScratchSize.

void BSP_AUDIO_IN_ClockConfig ( DFSDM_Filter_HandleTypeDef *  hdfsdm_filter,
uint32_t  AudioFreq,
void *  Params 
)

Clock Config.

Parameters:
hdfsdm_filter,:might be required to set audio peripheral predivider if any.
AudioFreq,:Audio frequency used to play the audio stream.
Params
Note:
This API is called by BSP_AUDIO_IN_Init() Being __weak it can be overwritten by the application
Return values:
None

Definition at line 1680 of file stm32f769i_discovery_audio.c.

Referenced by BSP_AUDIO_IN_InitEx().

void BSP_AUDIO_IN_DeInit ( void  )

Deinit the audio IN peripherals.

Return values:
None

Definition at line 1410 of file stm32f769i_discovery_audio.c.

References AudioIn_Device, BSP_AUDIO_IN_MspDeInit(), DFSDMx_DeInit(), INPUT_DEVICE_DIGITAL_MIC, and SAIx_In_DeInit().

void BSP_AUDIO_IN_Error_CallBack ( void  )

Audio IN Error callback function.

Return values:
None

Definition at line 1627 of file stm32f769i_discovery_audio.c.

Referenced by HAL_SAI_ErrorCallback().

uint8_t BSP_AUDIO_IN_GetChannelNumber ( void  )

Return audio in channel number.

Return values:
Numberof channel

Definition at line 1213 of file stm32f769i_discovery_audio.c.

References AudioIn_ChannelNumber.

Manages the DMA Half Transfer complete event.

Return values:
None

Definition at line 1616 of file stm32f769i_discovery_audio.c.

Referenced by HAL_DFSDM_FilterRegConvCpltCallback(), HAL_DFSDM_FilterRegConvHalfCpltCallback(), and HAL_SAI_RxHalfCpltCallback().

uint8_t BSP_AUDIO_IN_Init ( uint32_t  AudioFreq,
uint32_t  BitRes,
uint32_t  ChnlNbr 
)

Initialize wave recording.

Parameters:
AudioFreq,:Audio frequency to be configured for the DFSDM peripheral.
BitRes,:Audio frequency to be configured for the DFSDM peripheral.
ChnlNbr,:Audio frequency to be configured for the DFSDM peripheral.
Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1117 of file stm32f769i_discovery_audio.c.

References BSP_AUDIO_IN_InitEx(), and INPUT_DEVICE_DIGITAL_MIC.

uint8_t BSP_AUDIO_IN_InitEx ( uint16_t  InputDevice,
uint32_t  AudioFreq,
uint32_t  BitRes,
uint32_t  ChnlNbr 
)

Initialize wave recording.

Parameters:
InputDevice,:INPUT_DEVICE_DIGITAL_MIC or INPUT_DEVICE_ANALOG_MIC.
AudioFreq,:Audio frequency to be configured.
BitRes,:Audio bit resolution to be configured..
ChnlNbr,:Number of channel to be configured.
Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1130 of file stm32f769i_discovery_audio.c.

References audio_drv, AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_IN_SAIx, AUDIO_OK, AudioIn_ChannelNumber, AudioIn_Device, BSP_AUDIO_IN_ClockConfig(), BSP_AUDIO_IN_MspInit(), BSP_AUDIO_OUT_ClockConfig(), BSP_AUDIO_OUT_MspInit(), DFSDMx_Init(), haudio_in_sai, hAudioInTopLeftFilter, INPUT_DEVICE_DIGITAL_MIC, SAIx_In_DeInit(), and SAIx_In_Init().

Referenced by BSP_AUDIO_IN_Init().

void BSP_AUDIO_IN_MspDeInit ( void  )

DeInitialize BSP_AUDIO_IN MSP.

Return values:
None

Definition at line 1656 of file stm32f769i_discovery_audio.c.

References AudioIn_Device, DFSDMx_ChannelMspDeInit(), DFSDMx_FilterMspDeInit(), haudio_in_sai, INPUT_DEVICE_DIGITAL_MIC, and SAI_AUDIO_IN_MspDeInit().

Referenced by BSP_AUDIO_IN_DeInit().

void BSP_AUDIO_IN_MspInit ( void  )

Initialize BSP_AUDIO_IN MSP.

Return values:
None

Definition at line 1637 of file stm32f769i_discovery_audio.c.

References AudioIn_Device, DFSDMx_ChannelMspInit(), DFSDMx_FilterMspInit(), haudio_in_sai, INPUT_DEVICE_DIGITAL_MIC, and SAI_AUDIO_IN_MspInit().

Referenced by BSP_AUDIO_IN_InitEx().

uint8_t BSP_AUDIO_IN_Pause ( void  )

Pause the audio file stream.

Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1338 of file stm32f769i_discovery_audio.c.

References AUDIO_ERROR, AUDIO_OK, AudioIn_ChannelNumber, hAudioInButtomLeftFilter, hAudioInButtomRightFilter, hAudioInTopLeftFilter, and hAudioInTopRightFilter.

uint8_t BSP_AUDIO_IN_Record ( uint16_t *  pbuf,
uint32_t  size 
)

Start audio recording.

Parameters:
pbuf,:Main buffer pointer for the recorded data storing
size,:Current size of the recorded buffer
Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1224 of file stm32f769i_discovery_audio.c.

References AppBuffHalf, AppBuffTrigger, AUDIO_ERROR, AUDIO_OK, AudioIn_ChannelNumber, AudioIn_Device, haudio_in_sai, hAudioInButtomLeftFilter, hAudioInButtomRightFilter, hAudioInTopLeftFilter, hAudioInTopRightFilter, INPUT_DEVICE_DIGITAL_MIC, AUDIOIN_TypeDef::pRecBuf, pScratchBuff, AUDIOIN_TypeDef::RecSize, and ScratchSize.

uint8_t BSP_AUDIO_IN_Resume ( void  )

Resume the audio file stream.

Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1374 of file stm32f769i_discovery_audio.c.

References AUDIO_ERROR, AUDIO_OK, AudioIn_ChannelNumber, hAudioInButtomLeftFilter, hAudioInButtomRightFilter, hAudioInTopLeftFilter, hAudioInTopRightFilter, pScratchBuff, and ScratchSize.

uint8_t BSP_AUDIO_IN_Stop ( void  )

User callback when record buffer is filled.

Return values:
None

Definition at line 1605 of file stm32f769i_discovery_audio.c.

Referenced by HAL_DFSDM_FilterRegConvCpltCallback(), HAL_DFSDM_FilterRegConvHalfCpltCallback(), and HAL_SAI_RxCpltCallback().

Generated on Fri Dec 30 2016 18:30:07 for STM32F769I-Discovery BSP User Manual by   doxygen 1.7.6.1