STM32F769I_DISCOVERY_AUDIO_IN Exported Functions

Collaboration diagram for STM32F769I_DISCOVERY_AUDIO_IN Exported Functions:

Functions
uint8_t	BSP_AUDIO_IN_AllocScratch (int32_t *pScratch, uint32_t size)
	Allocate channel buffer scratch. More...
void	BSP_AUDIO_IN_ClockConfig (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t AudioFreq, void *Params)
	Clock Config. More...
void	BSP_AUDIO_IN_DeInit (void)
	Deinit the audio IN peripherals. More...
void	BSP_AUDIO_IN_Error_CallBack (void)
	Audio IN Error callback function. More...
uint8_t	BSP_AUDIO_IN_GetChannelNumber (void)
	Return audio in channel number. More...
void	BSP_AUDIO_IN_HalfTransfer_CallBack (void)
	Manages the DMA Half Transfer complete event. More...
uint8_t	BSP_AUDIO_IN_Init (uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr)
	Initializes 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...
void	BSP_AUDIO_IN_MspDeInit (void)
	DeInitialize BSP_AUDIO_IN MSP. More...
void	BSP_AUDIO_IN_MspInit (void)
	Initialize BSP_AUDIO_IN MSP. More...
uint8_t	BSP_AUDIO_IN_Pause (void)
	Pauses the audio file stream. More...
uint8_t	BSP_AUDIO_IN_Record (uint16_t *pData, uint32_t Size)
	Starts audio recording. More...
uint8_t	BSP_AUDIO_IN_Resume (void)
	Resumes the audio file stream. More...
uint8_t	BSP_AUDIO_IN_Stop (void)
	Stops audio recording. More...
void	BSP_AUDIO_IN_TransferComplete_CallBack (void)
	User callback when record buffer is filled. More...

Detailed Description

Function Documentation

BSP_AUDIO_IN_AllocScratch()

uint8_t BSP_AUDIO_IN_AllocScratch	(	int32_t *	pScratch,
		uint32_t	size
	)

Allocate channel buffer scratch.

Parameters

pScratch	: pointer to scratch tables.
size	of scratch buffer

Definition at line 1204 of file stm32f769i_discovery_audio.c.

BSP_AUDIO_IN_ClockConfig()

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 1690 of file stm32f769i_discovery_audio.c.

BSP_AUDIO_IN_DeInit()

void BSP_AUDIO_IN_DeInit

(

void

)

Deinit the audio IN peripherals.

Return values

None

Definition at line 1036 of file stm32469i_discovery_audio.c.

BSP_AUDIO_IN_Error_CallBack()

void BSP_AUDIO_IN_Error_CallBack

(

void

)

Audio IN Error callback function.

Return values

None

Definition at line 1637 of file stm32f769i_discovery_audio.c.

BSP_AUDIO_IN_GetChannelNumber()

uint8_t BSP_AUDIO_IN_GetChannelNumber

(

void

)

Return audio in channel number.

Return values

Number

of channel

Definition at line 1223 of file stm32f769i_discovery_audio.c.

BSP_AUDIO_IN_HalfTransfer_CallBack()

void BSP_AUDIO_IN_HalfTransfer_CallBack

(

void

)

Manages the DMA Half Transfer complete event.

Return values

None

Definition at line 1011 of file stm32f4_discovery_audio.c.

BSP_AUDIO_IN_Init()

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_OK

if correct communication, else wrong communication

Parameters

AudioFreq	Audio frequency to be configured for the I2S peripheral.
BitRes	Audio Bit resolution.
ChnlNbr	Audio Channel number.

Return values

AUDIO_OK

if correct communication, else wrong communication

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.
BitRes	Audio frequency to be configured for the I2S peripheral.
ChnlNbr	Audio frequency to be configured for the I2S peripheral.

Return values

AUDIO_OK

if correct communication, else wrong communication

Initializes 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_OK

if correct communication, else wrong communication

Definition at line 705 of file stm32f4_discovery_audio.c.

BSP_AUDIO_IN_InitEx()

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_OK

if correct communication, else wrong communication

Definition at line 1140 of file stm32f769i_discovery_audio.c.

BSP_AUDIO_IN_MspDeInit()

void BSP_AUDIO_IN_MspDeInit

(

void

)

DeInitialize BSP_AUDIO_IN MSP.

Return values

None

Definition at line 1666 of file stm32f769i_discovery_audio.c.

BSP_AUDIO_IN_MspInit()

void BSP_AUDIO_IN_MspInit

(

void

)

Initialize BSP_AUDIO_IN MSP.

Return values

None

Definition at line 1647 of file stm32f769i_discovery_audio.c.

BSP_AUDIO_IN_Pause()

uint8_t BSP_AUDIO_IN_Pause

(

void

)

Pauses the audio file stream.

Return values

AUDIO_OK

if correct communication, else wrong communication

Pauses the audio file stream.

Return values

AUDIO_OK

if correct communication, else wrong communication

Definition at line 771 of file stm32f4_discovery_audio.c.

BSP_AUDIO_IN_Record()

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_OK

if correct communication, else wrong communication

Parameters

pbuf	Main buffer pointer for the recorded data storing
size	Current size of the recorded buffer

Return values

AUDIO_OK

if correct communication, else wrong communication

Starts audio recording.

Parameters

pbuf	Main buffer pointer for the recorded data storing
size	Current size of the recorded buffer

Return values

AUDIO_OK

if correct communication, else wrong communication

Definition at line 737 of file stm32f4_discovery_audio.c.

BSP_AUDIO_IN_Resume()

uint8_t BSP_AUDIO_IN_Resume

(

void

)

Resumes the audio file stream.

Return values

AUDIO_OK

if correct communication, else wrong communication

Resumes the audio file stream.

Return values

AUDIO_OK

if correct communication, else wrong communication

Definition at line 784 of file stm32f4_discovery_audio.c.

BSP_AUDIO_IN_Stop()

uint8_t BSP_AUDIO_IN_Stop

(

void

)

Stops audio recording.

Return values

AUDIO_OK

if correct communication, else wrong communication

Stops audio recording.

Return values

AUDIO_OK

if correct communication, else wrong communication

Definition at line 754 of file stm32f4_discovery_audio.c.

BSP_AUDIO_IN_TransferComplete_CallBack()

void BSP_AUDIO_IN_TransferComplete_CallBack

(

void

)

User callback when record buffer is filled.

Return values

None

Definition at line 1001 of file stm32f4_discovery_audio.c.