|
STM32L4R9I-Discovery BSP User Manual
|
This file contains the common defines and functions prototypes for the stm32l4r9i_discovery_audio.c driver. More...
Go to the source code of this file.
Defines | |
| #define | BSP_AUDIO_OUT_CIRCULARMODE ((uint32_t)0x00000001) /* BUFFER CIRCULAR MODE */ |
| #define | BSP_AUDIO_OUT_NORMALMODE ((uint32_t)0x00000002) /* BUFFER NORMAL MODE */ |
| #define | BSP_AUDIO_OUT_STEREOMODE ((uint32_t)0x00000004) /* STEREO MODE */ |
| #define | BSP_AUDIO_OUT_MONOMODE ((uint32_t)0x00000008) /* MONO MODE */ |
| #define | BSP_AUDIO_FREQUENCY_96K SAI_AUDIO_FREQUENCY_96K |
| #define | BSP_AUDIO_FREQUENCY_48K SAI_AUDIO_FREQUENCY_48K |
| #define | BSP_AUDIO_FREQUENCY_44K SAI_AUDIO_FREQUENCY_44K |
| #define | BSP_AUDIO_FREQUENCY_32K SAI_AUDIO_FREQUENCY_32K |
| #define | BSP_AUDIO_FREQUENCY_22K SAI_AUDIO_FREQUENCY_22K |
| #define | BSP_AUDIO_FREQUENCY_16K SAI_AUDIO_FREQUENCY_16K |
| #define | BSP_AUDIO_FREQUENCY_11K SAI_AUDIO_FREQUENCY_11K |
| #define | BSP_AUDIO_FREQUENCY_8K SAI_AUDIO_FREQUENCY_8K |
| #define | DMA_MAX_SZE (uint32_t)0xFFFF |
| #define | AUDIO_SAIx_PLL_DISABLE() HAL_RCCEx_DisablePLLSAI1() |
| #define | AUDIODATA_SIZE 2 /* 16-bits audio data size */ |
| #define | AUDIO_OK 0 |
| #define | AUDIO_ERROR 1 |
| #define | AUDIO_TIMEOUT 2 |
| #define | DEFAULT_AUDIO_OUT_FREQ BSP_AUDIO_FREQUENCY_48K |
| #define | DEFAULT_AUDIO_OUT_BIT_RESOLUTION ((uint8_t)16) |
| #define | DEFAULT_AUDIO_OUT_CHANNEL_NBR ((uint8_t)2) /* Mono = 1, Stereo = 2 */ |
| #define | DEFAULT_AUDIO_OUT_VOLUME ((uint16_t)80) |
| #define | DEFAULT_AUDIO_IN_FREQ BSP_AUDIO_FREQUENCY_16K |
| #define | DEFAULT_AUDIO_IN_BIT_RESOLUTION 16 |
| #define | DEFAULT_AUDIO_IN_CHANNEL_NBR 1 /* Mono = 1, Stereo = 2 */ |
| #define | DEFAULT_AUDIO_IN_VOLUME 80 |
| #define | CODEC_RESET_DELAY 5 |
| #define | INPUT_DEVICE_DIGITAL_MIC1 0x20 /* Left microphone */ |
| #define | INPUT_DEVICE_DIGITAL_MIC2 0x40 /* Right microphone */ |
| #define | INPUT_DEVICE_DIGITAL_MIC (INPUT_DEVICE_DIGITAL_MIC1 | INPUT_DEVICE_DIGITAL_MIC2) |
| #define | INPUT_DEVICE_ANALOG_MIC INPUT_DEVICE_MIC1 |
| #define | DMA_MAX(_X_) (((_X_) <= DMA_MAX_SZE)? (_X_):DMA_MAX_SZE) |
Typedefs | |
| typedef void(* | Audio_CallbackTypeDef )(void) |
Functions | |
| uint8_t | BSP_AUDIO_OUT_Init (uint16_t OutputDevice, uint8_t Volume, uint32_t AudioFreq) |
| Configures the audio codec related peripherals. | |
| uint8_t | BSP_AUDIO_OUT_DeInit (void) |
| De-Initializes audio codec related peripherals. | |
| uint8_t | BSP_AUDIO_OUT_Play (uint16_t *pData, uint32_t Size) |
| Starts playing audio stream from a data buffer for a determined size. | |
| uint8_t | BSP_AUDIO_OUT_ChangeBuffer (uint16_t *pData, uint16_t Size) |
| Sends n-Bytes on the SAI interface. | |
| uint8_t | BSP_AUDIO_OUT_Pause (void) |
| This function Pauses the audio file stream. | |
| uint8_t | BSP_AUDIO_OUT_Resume (void) |
| This function Resumes the audio file stream. | |
| uint8_t | BSP_AUDIO_OUT_Stop (uint32_t Option) |
| Stops audio playing and Power down the Audio Codec. | |
| uint8_t | BSP_AUDIO_OUT_SetVolume (uint8_t Volume) |
| Controls the current audio volume level. | |
| uint8_t | BSP_AUDIO_OUT_SetFrequency (uint32_t AudioFreq) |
| Updates the audio frequency. | |
| void | BSP_AUDIO_OUT_ChangeAudioConfig (uint32_t AudioOutOption) |
| Changes the Audio Out Configuration. | |
| uint8_t | BSP_AUDIO_OUT_SetMute (uint32_t Cmd) |
| Enables or disables the MUTE mode by software. | |
| uint8_t | BSP_AUDIO_OUT_SetOutputMode (uint8_t Output) |
| Switch dynamically (while audio file is being played) the output target (speaker or headphone). | |
| void | BSP_AUDIO_OUT_RegisterCallbacks (Audio_CallbackTypeDef ErrorCallback, Audio_CallbackTypeDef HalfTransferCallback, Audio_CallbackTypeDef TransferCompleteCallback) |
| register user callback functions | |
| uint8_t | BSP_AUDIO_IN_Init (uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr) |
| Initializes micropone related peripherals. | |
| 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_DeInit (void) |
| De-Initializes microphone related peripherals. | |
| uint8_t | BSP_AUDIO_IN_Record (uint16_t *pbuf, uint32_t size) |
| Starts audio recording. | |
| uint8_t | BSP_AUDIO_IN_SetFrequency (uint32_t AudioFreq) |
| Updates the audio frequency. | |
| 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. | |
| void | BSP_AUDIO_IN_RegisterCallbacks (Audio_CallbackTypeDef ErrorCallback, Audio_CallbackTypeDef HalfTransferCallback, Audio_CallbackTypeDef TransferCompleteCallback) |
| register user callback functions | |
Variables | |
| SAI_HandleTypeDef | BSP_AUDIO_hSai_Tx |
| SAI_HandleTypeDef | BSP_AUDIO_hSai_Rx |
| DFSDM_Filter_HandleTypeDef | BSP_AUDIO_hDfsdmLeftFilter |
| DFSDM_Filter_HandleTypeDef | BSP_AUDIO_hDfsdmRightFilter |
Detailed Description
This file contains the common defines and functions prototypes for the stm32l4r9i_discovery_audio.c driver.
- Attention:
© COPYRIGHT(c) 2017 STMicroelectronics
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
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 stm32l4r9i_discovery_audio.h.
Generated on Fri Oct 13 2017 02:37:42 for STM32L4R9I-Discovery BSP User Manual by
1.7.6.1