STM32F4-Discovery BSP User Manual: STM32F4 DISCOVERY AUDIO IN Private Functions

STM32F4-Discovery BSP

previous page next page
STM32F4-Discovery BSP User Manual
Functions
STM32F4 DISCOVERY AUDIO IN Private Functions
STM32F4 DISCOVERY AUDIO

Functions

uint8_t BSP_AUDIO_IN_Init (uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr)
 Initializes wave recording.
uint8_t BSP_AUDIO_IN_Record (uint16_t *pbuf, uint32_t size)
 Starts audio recording.
uint8_t BSP_AUDIO_IN_Stop (void)
 Stops audio recording.
uint8_t BSP_AUDIO_IN_Pause (void)
 Pauses the audio file stream.
uint8_t BSP_AUDIO_IN_Resume (void)
 Resumes the audio file stream.
uint8_t BSP_AUDIO_IN_SetVolume (uint8_t Volume)
 Controls the audio in volume level.
uint8_t BSP_AUDIO_IN_PDMToPCM (uint16_t *PDMBuf, uint16_t *PCMBuf)
 Converts audio format from PDM to PCM.
void HAL_I2S_RxCpltCallback (I2S_HandleTypeDef *hi2s)
 Rx Transfer completed callbacks.
void HAL_I2S_RxHalfCpltCallback (I2S_HandleTypeDef *hi2s)
 Rx Half Transfer completed callbacks.
__weak void BSP_AUDIO_IN_ClockConfig (I2S_HandleTypeDef *hi2s, uint32_t AudioFreq, void *Params)
 Audio In Clock Config.
__weak void BSP_AUDIO_IN_MspInit (I2S_HandleTypeDef *hi2s, void *Params)
 BSP AUDIO IN MSP Init.
__weak void BSP_AUDIO_IN_MspDeInit (I2S_HandleTypeDef *hi2s, void *Params)
 DeInitializes BSP_AUDIO_IN MSP.
__weak void BSP_AUDIO_IN_TransferComplete_CallBack (void)
 User callback when record buffer is filled.
__weak void BSP_AUDIO_IN_HalfTransfer_CallBack (void)
 Manages the DMA Half Transfer complete event.
__weak void BSP_AUDIO_IN_Error_Callback (void)
 Audio IN Error callback function.
static void PDMDecoder_Init (uint32_t AudioFreq, uint32_t ChnlNbr)
 Initialize the PDM library.
static uint8_t I2S2_Init (uint32_t AudioFreq)
 Initializes the Audio Codec audio interface (I2S)

Function Documentation

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

Audio In Clock Config.

Parameters:
hi2s,:I2S handle
AudioFreq,:Audio frequency used to record the audio stream.
Params: pointer on additional configuration parameters, can be NULL.
Note:
This API is called by BSP_AUDIO_IN_Init() Being __weak it can be overwritten by the application

Definition at line 866 of file stm32f4_discovery_audio.c.

Referenced by BSP_AUDIO_IN_Init().

__weak void BSP_AUDIO_IN_Error_Callback ( void  )

Audio IN Error callback function.

Definition at line 1018 of file stm32f4_discovery_audio.c.

Referenced by HAL_I2S_ErrorCallback().

__weak void BSP_AUDIO_IN_HalfTransfer_CallBack ( void  )

Manages the DMA Half Transfer complete event.

Definition at line 1008 of file stm32f4_discovery_audio.c.

Referenced by HAL_I2S_RxHalfCpltCallback().

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

Initializes wave recording.

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

Definition at line 704 of file stm32f4_discovery_audio.c.

References AUDIO_OK, BSP_AUDIO_IN_ClockConfig(), BSP_AUDIO_IN_MspInit(), hAudioInI2s, I2S2, I2S2_Init(), and PDMDecoder_Init().

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

DeInitializes BSP_AUDIO_IN MSP.

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

Definition at line 966 of file stm32f4_discovery_audio.c.

References I2S2, I2S2_CLK_DISABLE, I2S2_DMAx_IRQ, I2S2_MOSI_GPIO_PORT, I2S2_MOSI_PIN, I2S2_SCK_GPIO_PORT, and I2S2_SCK_PIN.

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

BSP AUDIO IN MSP Init.

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

Definition at line 900 of file stm32f4_discovery_audio.c.

References AUDIO_IN_IRQ_PREPRIO, I2S2, I2S2_CLK_ENABLE, I2S2_DMAx_CHANNEL, I2S2_DMAx_CLK_ENABLE, I2S2_DMAx_IRQ, I2S2_DMAx_MEM_DATA_SIZE, I2S2_DMAx_PERIPH_DATA_SIZE, I2S2_DMAx_STREAM, I2S2_MOSI_AF, I2S2_MOSI_GPIO_CLK_ENABLE, I2S2_MOSI_GPIO_PORT, I2S2_MOSI_PIN, I2S2_SCK_AF, I2S2_SCK_GPIO_CLK_ENABLE, I2S2_SCK_GPIO_PORT, and I2S2_SCK_PIN.

Referenced by BSP_AUDIO_IN_Init().

uint8_t BSP_AUDIO_IN_Pause ( void  )

Pauses the audio file stream.

Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 768 of file stm32f4_discovery_audio.c.

References AUDIO_OK, and hAudioInI2s.

uint8_t BSP_AUDIO_IN_PDMToPCM ( uint16_t *  PDMBuf,
uint16_t *  PCMBuf 
)

Converts audio format from PDM to PCM.

Parameters:
PDMBuf,:Pointer to data PDM buffer
PCMBuf,:Pointer to data PCM buffer
Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 811 of file stm32f4_discovery_audio.c.

References AUDIO_OK, AudioInVolume, DEFAULT_AUDIO_IN_CHANNEL_NBR, Filter, INTERNAL_BUFF_SIZE, and PCM_OUT_SIZE.

uint8_t BSP_AUDIO_IN_Record ( uint16_t *  pbuf,
uint32_t  size 
)

Starts 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 734 of file stm32f4_discovery_audio.c.

References AUDIO_ERROR, AUDIO_OK, and hAudioInI2s.

uint8_t BSP_AUDIO_IN_Resume ( void  )

Resumes the audio file stream.

Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 781 of file stm32f4_discovery_audio.c.

References AUDIO_OK, and hAudioInI2s.

uint8_t BSP_AUDIO_IN_SetVolume ( uint8_t  Volume)

Controls the audio in 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_OKif correct communication, else wrong communication

Definition at line 796 of file stm32f4_discovery_audio.c.

References AUDIO_OK, and AudioInVolume.

uint8_t BSP_AUDIO_IN_Stop ( void  )

Stops audio recording.

Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 751 of file stm32f4_discovery_audio.c.

References AUDIO_ERROR, AUDIO_OK, and hAudioInI2s.

__weak void BSP_AUDIO_IN_TransferComplete_CallBack ( void  )

User callback when record buffer is filled.

Definition at line 998 of file stm32f4_discovery_audio.c.

Referenced by HAL_I2S_RxCpltCallback().

void HAL_I2S_RxCpltCallback ( I2S_HandleTypeDef *  hi2s)

Rx Transfer completed callbacks.

Parameters:
hi2s,:I2S handle

Definition at line 841 of file stm32f4_discovery_audio.c.

References BSP_AUDIO_IN_TransferComplete_CallBack().

void HAL_I2S_RxHalfCpltCallback ( I2S_HandleTypeDef *  hi2s)

Rx Half Transfer completed callbacks.

Parameters:
hi2s,:I2S handle

Definition at line 851 of file stm32f4_discovery_audio.c.

References BSP_AUDIO_IN_HalfTransfer_CallBack().

static uint8_t I2S2_Init ( uint32_t  AudioFreq) [static]

Initializes the Audio Codec audio interface (I2S)

Note:
This function assumes that the I2S input clock (through PLL_R in Devices RevA/Z and through dedicated PLLI2S_R in Devices RevB/Y) is already configured and ready to be used.
Parameters:
AudioFreq,:Audio frequency to be configured for the I2S peripheral.

Definition at line 1061 of file stm32f4_discovery_audio.c.

References AUDIO_ERROR, AUDIO_OK, hAudioInI2s, and I2S2.

Referenced by BSP_AUDIO_IN_Init().

static void PDMDecoder_Init ( uint32_t  AudioFreq,
uint32_t  ChnlNbr 
) [static]

Initialize the PDM library.

Parameters:
AudioFreq,:Audio sampling frequency
ChnlNbr,:Number of audio channels (1: mono; 2: stereo)

Definition at line 1033 of file stm32f4_discovery_audio.c.

References Filter.

Referenced by BSP_AUDIO_IN_Init().

Generated on Thu Jan 19 2017 15:34:14 for STM32F4-Discovery BSP User Manual by   doxygen 1.7.6.1
previous page start next page