ST / BSP_DISCO_H747I

BSP files for STM32H747I-Discovery Copy from ST Cube delivery

Dependents:   DISCO_H747I_LCD_demo DISCO_H747I_AUDIO_demo

Embed: (wiki syntax)

« Back to documentation index

IN Exported Functions
Functions

IN Exported Functions
[STM32H747I_DISCOVERY_AUDIO]

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_OUT_Init (uint32_t InputDevice, uint32_t OutputDevice, uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr)
 Initializes wave recording and playback in parallel.
void BSP_AUDIO_IN_SelectInterface (uint32_t Interface)
 Link digital mic to specified source.
uint32_t BSP_AUDIO_IN_GetInterface (void)
 Get digital mic interface.
uint8_t BSP_AUDIO_IN_GetChannelNumber (void)
 Return audio in channel number.
uint8_t BSP_AUDIO_IN_Record (uint16_t *pBuf, 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.
uint8_t BSP_AUDIO_IN_SetVolume (uint8_t Volume)
 Controls the audio in volume level.
void BSP_AUDIO_IN_DeInit (void)
 Deinit the audio IN peripherals.
uint8_t BSP_AUDIO_IN_PDMToPCM_Init (uint32_t AudioFreq, uint32_t ChnlNbrIn, uint32_t ChnlNbrOut)
 Initialize the PDM library.
uint8_t BSP_AUDIO_IN_PDMToPCM (uint16_t *PDMBuf, uint16_t *PCMBuf)
 Converts audio format from PDM to PCM.
__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_TransferComplete_CallBackEx (uint32_t InputDevice)
 User callback when record buffer is filled.
__weak void BSP_AUDIO_IN_HalfTransfer_CallBackEx (uint32_t InputDevice)
 User callback when record buffer is filled.
__weak void BSP_AUDIO_IN_Error_CallBack (void)
 Audio IN Error callback function.
__weak void BSP_AUDIO_IN_MspInit (void)
 Initialize BSP_AUDIO_IN MSP.
__weak void BSP_AUDIO_IN_MspDeInit (void)
 DeInitialize BSP_AUDIO_IN MSP.
__weak void BSP_AUDIO_IN_ClockConfig (uint32_t AudioFreq, void *Params)
 Clock Config.

Function Documentation

__weak void BSP_AUDIO_IN_ClockConfig ( uint32_t  AudioFreq,
void *  Params 
)

Clock Config.

Parameters:
AudioFreq,:Audio frequency used to play 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
Return values:
None

Definition at line 1233 of file stm32h747i_discovery_audio.c.

void BSP_AUDIO_IN_DeInit ( void   )

Deinit the audio IN peripherals.

Return values:
None

Definition at line 1092 of file stm32h747i_discovery_audio.c.

__weak void BSP_AUDIO_IN_Error_CallBack ( void   )

Audio IN Error callback function.

Return values:
None

Definition at line 1201 of file stm32h747i_discovery_audio.c.

uint8_t BSP_AUDIO_IN_GetChannelNumber ( void   )

Return audio in channel number.

Return values:
Numberof channel

Definition at line 997 of file stm32h747i_discovery_audio.c.

uint32_t BSP_AUDIO_IN_GetInterface ( void   )

Get digital mic interface.

Return values:
Digitalmic interface.

Definition at line 988 of file stm32h747i_discovery_audio.c.

__weak void BSP_AUDIO_IN_HalfTransfer_CallBack ( void   )

Manages the DMA Half Transfer complete event.

Return values:
None

Definition at line 1168 of file stm32h747i_discovery_audio.c.

__weak void BSP_AUDIO_IN_HalfTransfer_CallBackEx ( uint32_t  InputDevice )

User callback when record buffer is filled.

Parameters:
InputDevice,:INPUT_DEVICE_DIGITAL_MIC1 or INPUT_DEVICE_DIGITAL_MIC2

Definition at line 1190 of file stm32h747i_discovery_audio.c.

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 785 of file stm32h747i_discovery_audio.c.

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 800 of file stm32h747i_discovery_audio.c.

__weak void BSP_AUDIO_IN_MspDeInit ( void   )

DeInitialize BSP_AUDIO_IN MSP.

Return values:
None

Definition at line 1220 of file stm32h747i_discovery_audio.c.

__weak void BSP_AUDIO_IN_MspInit ( void   )

Initialize BSP_AUDIO_IN MSP.

Return values:
None

Definition at line 1211 of file stm32h747i_discovery_audio.c.

uint8_t BSP_AUDIO_IN_OUT_Init ( uint32_t  InputDevice,
uint32_t  OutputDevice,
uint32_t  AudioFreq,
uint32_t  BitRes,
uint32_t  ChnlNbr 
)

Initializes wave recording and playback in parallel.

Parameters:
InputDevice,:INPUT_DEVICE_DIGITAL_MICROPHONE_2
OutputDevice,:OUTPUT_DEVICE_SPEAKER, OUTPUT_DEVICE_HEADPHONE, or OUTPUT_DEVICE_BOTH.
AudioFreq,:Audio frequency to be configured for the SAI peripheral.
BitRes,:Audio frequency to be configured.
ChnlNbr,:Channel number.
Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 896 of file stm32h747i_discovery_audio.c.

uint8_t BSP_AUDIO_IN_Pause ( void   )

Pause the audio file stream.

Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1037 of file stm32h747i_discovery_audio.c.

uint8_t BSP_AUDIO_IN_PDMToPCM ( uint16_t *  PDMBuf,
uint16_t *  PCMBuf 
)

Converts audio format from PDM to PCM.

Parameters:
PDMBuf,:Pointer to PDM buffer data
PCMBuf,:Pointer to PCM buffer data
Return values:
AUDIO_OKin case of success, AUDIO_ERROR otherwise

Definition at line 1141 of file stm32h747i_discovery_audio.c.

uint8_t BSP_AUDIO_IN_PDMToPCM_Init ( uint32_t  AudioFreq,
uint32_t  ChnlNbrIn,
uint32_t  ChnlNbrOut 
)

Initialize the PDM library.

Parameters:
AudioFreq,:Audio sampling frequency
ChnlNbrIn,:Number of input audio channels in the PDM buffer
ChnlNbrOut,:Number of desired output audio channels in the resulting PCM buffer
Return values:
None

Definition at line 1106 of file stm32h747i_discovery_audio.c.

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 1008 of file stm32h747i_discovery_audio.c.

uint8_t BSP_AUDIO_IN_Resume ( void   )

Resume the audio file stream.

Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1057 of file stm32h747i_discovery_audio.c.

void BSP_AUDIO_IN_SelectInterface ( uint32_t  Interface )

Link digital mic to specified source.

Parameters:
Interface: Audio In interface for Digital mic. It can be: AUDIO_IN_INTERFACE_SAI AUDIO_IN_INTERFACE_PDM
Return values:
None

Definition at line 979 of file stm32h747i_discovery_audio.c.

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 1079 of file stm32h747i_discovery_audio.c.

uint8_t BSP_AUDIO_IN_Stop ( void   )

Stop audio recording.

Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1024 of file stm32h747i_discovery_audio.c.

__weak void BSP_AUDIO_IN_TransferComplete_CallBack ( void   )

User callback when record buffer is filled.

Return values:
None

Definition at line 1157 of file stm32h747i_discovery_audio.c.

__weak void BSP_AUDIO_IN_TransferComplete_CallBackEx ( uint32_t  InputDevice )

User callback when record buffer is filled.

Parameters:
InputDevice,:INPUT_DEVICE_DIGITAL_MIC1 or INPUT_DEVICE_DIGITAL_MIC2

Definition at line 1179 of file stm32h747i_discovery_audio.c.

Generated on Tue Jul 12 2022 18:45:42 by  doxygen 1.7.2