audio.h

00001 /**
00002   ******************************************************************************
00003   * @file    audio.h
00004   * @author  MCD Application Team
00005   * @brief   This header file contains the common defines and functions prototypes
00006   *          for the Audio driver.  
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
00011   * All rights reserved.</center></h2>
00012   *
00013   * This software component is licensed by ST under BSD 3-Clause license,
00014   * the "License"; You may not use this file except in compliance with the
00015   * License. You may obtain a copy of the License at:
00016   *                        opensource.org/licenses/BSD-3-Clause
00017   *
00018   ******************************************************************************
00019   */
00020 
00021 /* Define to prevent recursive inclusion -------------------------------------*/
00022 #ifndef __AUDIO_H
00023 #define __AUDIO_H
00024 
00025 #ifdef __cplusplus
00026  extern "C" {
00027 #endif
00028 
00029 /* Includes ------------------------------------------------------------------*/
00030 #include <stdint.h>
00031 
00032 /** @addtogroup BSP
00033   * @{
00034   */
00035 
00036 /** @addtogroup Components
00037   * @{
00038   */
00039     
00040 /** @addtogroup AUDIO
00041   * @{
00042   */
00043 
00044 /** @defgroup AUDIO_Exported_Constants
00045   * @{
00046   */
00047 
00048 /* Codec audio Standards */
00049 #define CODEC_STANDARD                0x04
00050 #define I2S_STANDARD                  I2S_STANDARD_PHILIPS
00051 
00052 /**
00053   * @}
00054   */
00055 
00056 /** @defgroup AUDIO_Exported_Types
00057   * @{
00058   */
00059 
00060 /** @defgroup AUDIO_Driver_structure  Audio Driver structure
00061   * @{
00062   */
00063 typedef struct
00064 {
00065   uint32_t  (*Init)(uint16_t, uint16_t, uint8_t, uint32_t);
00066   void      (*DeInit)(void);
00067   uint32_t  (*ReadID)(uint16_t);
00068   uint32_t  (*Play)(uint16_t, uint16_t*, uint16_t);
00069   uint32_t  (*Pause)(uint16_t);
00070   uint32_t  (*Resume)(uint16_t);
00071   uint32_t  (*Stop)(uint16_t, uint32_t);
00072   uint32_t  (*SetFrequency)(uint16_t, uint32_t);
00073   uint32_t  (*SetVolume)(uint16_t, uint8_t);
00074   uint32_t  (*SetMute)(uint16_t, uint32_t);
00075   uint32_t  (*SetOutputMode)(uint16_t, uint8_t);
00076   uint32_t  (*Reset)(uint16_t);
00077 }AUDIO_DrvTypeDef;
00078 /**
00079   * @}
00080   */
00081 
00082 /**
00083   * @}
00084   */
00085 
00086 /**
00087   * @}
00088   */
00089 
00090 /**
00091   * @}
00092   */
00093 
00094 /**
00095   * @}
00096   */
00097 
00098 #ifdef __cplusplus
00099 }
00100 #endif
00101 
00102 #endif /* __AUDIO_H */
00103 
00104 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/