Ngo Kien / BSP_DISCO_F746NG

Clone

Dependents:   SignalProcessLab DigitalSignalAlgorithm_Lab DigitalSignal_Lab

Drivers/BSP/Components/Common/audio.h@0:fc80425b677a, 2019-08-26 (annotated)

Committer:
ngtkien
Date:
Mon Aug 26 16:33:09 2019 +0000
Revision:
0:fc80425b677a
Library

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ngtkien 0:fc80425b677a 1 /**
ngtkien 0:fc80425b677a 2 ******************************************************************************
ngtkien 0:fc80425b677a 3 * @file audio.h
ngtkien 0:fc80425b677a 4 * @author MCD Application Team
ngtkien 0:fc80425b677a 5 * @version V4.0.1
ngtkien 0:fc80425b677a 6 * @date 21-July-2015
ngtkien 0:fc80425b677a 7 * @brief This header file contains the common defines and functions prototypes
ngtkien 0:fc80425b677a 8 * for the Audio driver.
ngtkien 0:fc80425b677a 9 ******************************************************************************
ngtkien 0:fc80425b677a 10 * @attention
ngtkien 0:fc80425b677a 11 *
ngtkien 0:fc80425b677a 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
ngtkien 0:fc80425b677a 13 *
ngtkien 0:fc80425b677a 14 * Redistribution and use in source and binary forms, with or without modification,
ngtkien 0:fc80425b677a 15 * are permitted provided that the following conditions are met:
ngtkien 0:fc80425b677a 16 * 1. Redistributions of source code must retain the above copyright notice,
ngtkien 0:fc80425b677a 17 * this list of conditions and the following disclaimer.
ngtkien 0:fc80425b677a 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
ngtkien 0:fc80425b677a 19 * this list of conditions and the following disclaimer in the documentation
ngtkien 0:fc80425b677a 20 * and/or other materials provided with the distribution.
ngtkien 0:fc80425b677a 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
ngtkien 0:fc80425b677a 22 * may be used to endorse or promote products derived from this software
ngtkien 0:fc80425b677a 23 * without specific prior written permission.
ngtkien 0:fc80425b677a 24 *
ngtkien 0:fc80425b677a 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
ngtkien 0:fc80425b677a 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
ngtkien 0:fc80425b677a 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
ngtkien 0:fc80425b677a 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
ngtkien 0:fc80425b677a 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
ngtkien 0:fc80425b677a 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
ngtkien 0:fc80425b677a 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
ngtkien 0:fc80425b677a 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
ngtkien 0:fc80425b677a 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
ngtkien 0:fc80425b677a 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
ngtkien 0:fc80425b677a 35 *
ngtkien 0:fc80425b677a 36 ******************************************************************************
ngtkien 0:fc80425b677a 37 */
ngtkien 0:fc80425b677a 38
ngtkien 0:fc80425b677a 39 /* Define to prevent recursive inclusion -------------------------------------*/
ngtkien 0:fc80425b677a 40 #ifndef __AUDIO_H
ngtkien 0:fc80425b677a 41 #define __AUDIO_H
ngtkien 0:fc80425b677a 42
ngtkien 0:fc80425b677a 43 #ifdef __cplusplus
ngtkien 0:fc80425b677a 44 extern "C" {
ngtkien 0:fc80425b677a 45 #endif
ngtkien 0:fc80425b677a 46
ngtkien 0:fc80425b677a 47 /* Includes ------------------------------------------------------------------*/
ngtkien 0:fc80425b677a 48 #include <stdint.h>
ngtkien 0:fc80425b677a 49
ngtkien 0:fc80425b677a 50 /** @addtogroup BSP
ngtkien 0:fc80425b677a 51 * @{
ngtkien 0:fc80425b677a 52 */
ngtkien 0:fc80425b677a 53
ngtkien 0:fc80425b677a 54 /** @addtogroup Components
ngtkien 0:fc80425b677a 55 * @{
ngtkien 0:fc80425b677a 56 */
ngtkien 0:fc80425b677a 57
ngtkien 0:fc80425b677a 58 /** @addtogroup AUDIO
ngtkien 0:fc80425b677a 59 * @{
ngtkien 0:fc80425b677a 60 */
ngtkien 0:fc80425b677a 61
ngtkien 0:fc80425b677a 62 /** @defgroup AUDIO_Exported_Constants
ngtkien 0:fc80425b677a 63 * @{
ngtkien 0:fc80425b677a 64 */
ngtkien 0:fc80425b677a 65
ngtkien 0:fc80425b677a 66 /* Codec audio Standards */
ngtkien 0:fc80425b677a 67 #define CODEC_STANDARD 0x04
ngtkien 0:fc80425b677a 68 #define I2S_STANDARD I2S_STANDARD_PHILIPS
ngtkien 0:fc80425b677a 69
ngtkien 0:fc80425b677a 70 /**
ngtkien 0:fc80425b677a 71 * @}
ngtkien 0:fc80425b677a 72 */
ngtkien 0:fc80425b677a 73
ngtkien 0:fc80425b677a 74 /** @defgroup AUDIO_Exported_Types
ngtkien 0:fc80425b677a 75 * @{
ngtkien 0:fc80425b677a 76 */
ngtkien 0:fc80425b677a 77
ngtkien 0:fc80425b677a 78 /** @defgroup AUDIO_Driver_structure Audio Driver structure
ngtkien 0:fc80425b677a 79 * @{
ngtkien 0:fc80425b677a 80 */
ngtkien 0:fc80425b677a 81 typedef struct
ngtkien 0:fc80425b677a 82 {
ngtkien 0:fc80425b677a 83 uint32_t (*Init)(uint16_t, uint16_t, uint8_t, uint32_t);
ngtkien 0:fc80425b677a 84 void (*DeInit)(void);
ngtkien 0:fc80425b677a 85 uint32_t (*ReadID)(uint16_t);
ngtkien 0:fc80425b677a 86 uint32_t (*Play)(uint16_t, uint16_t*, uint16_t);
ngtkien 0:fc80425b677a 87 uint32_t (*Pause)(uint16_t);
ngtkien 0:fc80425b677a 88 uint32_t (*Resume)(uint16_t);
ngtkien 0:fc80425b677a 89 uint32_t (*Stop)(uint16_t, uint32_t);
ngtkien 0:fc80425b677a 90 uint32_t (*SetFrequency)(uint16_t, uint32_t);
ngtkien 0:fc80425b677a 91 uint32_t (*SetVolume)(uint16_t, uint8_t);
ngtkien 0:fc80425b677a 92 uint32_t (*SetMute)(uint16_t, uint32_t);
ngtkien 0:fc80425b677a 93 uint32_t (*SetOutputMode)(uint16_t, uint8_t);
ngtkien 0:fc80425b677a 94 uint32_t (*Reset)(uint16_t);
ngtkien 0:fc80425b677a 95 }AUDIO_DrvTypeDef;
ngtkien 0:fc80425b677a 96 /**
ngtkien 0:fc80425b677a 97 * @}
ngtkien 0:fc80425b677a 98 */
ngtkien 0:fc80425b677a 99
ngtkien 0:fc80425b677a 100 /**
ngtkien 0:fc80425b677a 101 * @}
ngtkien 0:fc80425b677a 102 */
ngtkien 0:fc80425b677a 103
ngtkien 0:fc80425b677a 104 /**
ngtkien 0:fc80425b677a 105 * @}
ngtkien 0:fc80425b677a 106 */
ngtkien 0:fc80425b677a 107
ngtkien 0:fc80425b677a 108 /**
ngtkien 0:fc80425b677a 109 * @}
ngtkien 0:fc80425b677a 110 */
ngtkien 0:fc80425b677a 111
ngtkien 0:fc80425b677a 112 /**
ngtkien 0:fc80425b677a 113 * @}
ngtkien 0:fc80425b677a 114 */
ngtkien 0:fc80425b677a 115
ngtkien 0:fc80425b677a 116 #ifdef __cplusplus
ngtkien 0:fc80425b677a 117 }
ngtkien 0:fc80425b677a 118 #endif
ngtkien 0:fc80425b677a 119
ngtkien 0:fc80425b677a 120 #endif /* __AUDIO_H */
ngtkien 0:fc80425b677a 121
ngtkien 0:fc80425b677a 122 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/