audio.h

00001 /**
00002   ******************************************************************************
00003   * @file    audio.h
00004   * @author  MCD Application Team
00005   * @version V4.0.1
00006   * @date    21-July-2015
00007   * @brief   This header file contains the common defines and functions prototypes
00008   *          for the Audio driver.  
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
00013   *
00014   * Redistribution and use in source and binary forms, with or without modification,
00015   * are permitted provided that the following conditions are met:
00016   *   1. Redistributions of source code must retain the above copyright notice,
00017   *      this list of conditions and the following disclaimer.
00018   *   2. Redistributions in binary form must reproduce the above copyright notice,
00019   *      this list of conditions and the following disclaimer in the documentation
00020   *      and/or other materials provided with the distribution.
00021   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00022   *      may be used to endorse or promote products derived from this software
00023   *      without specific prior written permission.
00024   *
00025   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00026   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00028   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00029   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00030   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00031   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00032   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00033   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00034   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035   *
00036   ******************************************************************************
00037   */
00038 
00039 /* Define to prevent recursive inclusion -------------------------------------*/
00040 #ifndef __AUDIO_H
00041 #define __AUDIO_H
00042 
00043 #ifdef __cplusplus
00044  extern "C" {
00045 #endif
00046 
00047 /* Includes ------------------------------------------------------------------*/
00048 #include <stdint.h>
00049 
00050 /** @addtogroup BSP
00051   * @{
00052   */
00053 
00054 /** @addtogroup Components
00055   * @{
00056   */
00057     
00058 /** @addtogroup AUDIO
00059   * @{
00060   */
00061 
00062 /** @defgroup AUDIO_Exported_Constants
00063   * @{
00064   */
00065 
00066 /* Codec audio Standards */
00067 #define CODEC_STANDARD                0x04
00068 #define I2S_STANDARD                  I2S_STANDARD_PHILIPS
00069 
00070 /**
00071   * @}
00072   */
00073 
00074 /** @defgroup AUDIO_Exported_Types
00075   * @{
00076   */
00077 
00078 /** @defgroup AUDIO_Driver_structure  Audio Driver structure
00079   * @{
00080   */
00081 typedef struct
00082 {
00083   uint32_t  (*Init)(uint16_t, uint16_t, uint8_t, uint32_t);
00084   void      (*DeInit)(void);
00085   uint32_t  (*ReadID)(uint16_t);
00086   uint32_t  (*Play)(uint16_t, uint16_t*, uint16_t);
00087   uint32_t  (*Pause)(uint16_t);
00088   uint32_t  (*Resume)(uint16_t);
00089   uint32_t  (*Stop)(uint16_t, uint32_t);
00090   uint32_t  (*SetFrequency)(uint16_t, uint32_t);
00091   uint32_t  (*SetVolume)(uint16_t, uint8_t);
00092   uint32_t  (*SetMute)(uint16_t, uint32_t);
00093   uint32_t  (*SetOutputMode)(uint16_t, uint8_t);
00094   uint32_t  (*Reset)(uint16_t);
00095 }AUDIO_DrvTypeDef;
00096 /**
00097   * @}
00098   */
00099 
00100 /**
00101   * @}
00102   */
00103 
00104 /**
00105   * @}
00106   */
00107 
00108 /**
00109   * @}
00110   */
00111 
00112 /**
00113   * @}
00114   */
00115 
00116 #ifdef __cplusplus
00117 }
00118 #endif
00119 
00120 #endif /* __AUDIO_H */
00121 
00122 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/