LUFA/Drivers/USB/Class/Device/Audio.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \ingroup Group_USBClassAudio
  32  *  @defgroup Group_USBClassAudioDevice Audio Class Device Mode Driver
  33  *
  34  *  \section Sec_Dependencies Module Source Dependencies
  35  *  The following files must be built with any user project that uses this module:
  36  *    - LUFA/Drivers/USB/Class/Device/Audio.c
  37  *
  38  *  \section Module Description
  39  *  Device Mode USB Class driver framework interface, for the Audio USB Class driver.
  40  *
  41  *  @{
  42  */
  43
  44 #ifndef _AUDIO_CLASS_DEVICE_H_
  45 #define _AUDIO_CLASS_DEVICE_H_
  46
  47         /* Includes: */
  48                 #include "../../USB.h"
  49                 #include "../Common/Audio.h"
  50
  51                 #include <string.h>
  52
  53         /* Enable C linkage for C++ Compilers: */
  54                 #if defined(__cplusplus)
  55                         extern "C" {
  56                 #endif
  57
  58         /* Public Interface - May be used in end-application: */
  59                 /* Type Defines: */
  60                         /** Class state structure. An instance of this structure should be made for each Audio interface
  61                          *  within the user application, and passed to each of the Audio class driver functions as the
  62                          *  AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information.
  63                          */
  64                         typedef struct
  65                         {
  66                                 const struct
  67                                 {
  68                                         uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this
  69                                                                                                                 *   structure controls
  70                                                                                                                 */
  71
  72                                         uint8_t  DataINEndpointNumber; /**< Endpoint number of the incomming Audio Streaming data, if available
  73                                                                                                         *   (zero if unused)
  74                                                                                                         */
  75                                         uint16_t DataINEndpointSize; /**< Size in bytes of the incomming Audio Streaming data endpoint, if available
  76                                                                                                   *   (zero if unused)
  77                                                                                                   */
  78
  79                                         uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the outgoing Audio Streaming data, if available
  80                                                                                                          *   (zero if unused)
  81                                                                                                          */
  82                                         uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing Audio Streaming data endpoint, if available
  83                                                                                                    *   (zero if unused)
  84                                                                                                    */
  85                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  86                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  87                                            */
  88                                 struct
  89                                 {
  90                                         bool     InterfaceEnabled; /**< Set and cleared by the class driver to indicate if the host has enabled the streaming endpoints
  91                                                                                                 *   of the Audio Streaming interface.
  92                                                                                                 */
  93                                 } State; /**< State data for the USB class interface within the device. All elements in this section
  94                                           *   are reset to their defaults when the interface is enumerated.
  95                                           */
  96                         } USB_ClassInfo_Audio_Device_t;
  97
  98                 /* Function Prototypes: */
  99                         /** Configures the endpoints of a given Audio interface, ready for use. This should be linked to the library
 100                          *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the
 101                          *  given Audio interface is selected.
 102                          *
 103                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 104                          *
 105                          *  \return Boolean true if the endpoints were sucessfully configured, false otherwise
 106                          */
 107                         bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 108
 109                         /** Processes incomming control requests from the host, that are directed to the given Audio class interface. This should be
 110                          *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
 111                          *
 112                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 113                          */
 114                         void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 115
 116                         /** General management task for a given Audio class interface, required for the correct operation of the interface. This should
 117                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 118                          *
 119                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 120                          */
 121                         void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 122
 123                         /** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming
 124                          *  OUT endpoint ready for reading.
 125                          *
 126                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 127                          *
 128                          *  \return Boolean true if the given Audio interface has a sample to be read, false otherwise
 129                          */
 130                         bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
 131
 132                         /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects
 133                          *  the streaming IN endpoint ready for writing.
 134                          *
 135                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 136                          *
 137                          *  \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise
 138                          */
 139                         bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
 140
 141                 /* Inline Functions: */
 142                         /** Reads the next 8-bit audio sample from the current audio interface.
 143                          *
 144                          *  \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
 145                          *        the correct endpoint is selected and ready for data.
 146                          *
 147                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 148                          *
 149                          *  \return  Signed 8-bit audio sample from the audio interface
 150                          */
 151                         static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
 152                         static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 153                         {
 154                                 int8_t Sample;
 155
 156                                 Sample = Endpoint_Read_Byte();
 157
 158                                 if (!(Endpoint_BytesInEndpoint()))
 159                                   Endpoint_ClearOUT();
 160
 161                                 return Sample;
 162                         }
 163
 164                         /** Reads the next 16-bit audio sample from the current audio interface.
 165                          *
 166                          *  \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
 167                          *        the correct endpoint is selected and ready for data.
 168                          *
 169                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 170                          *
 171                          *  \return  Signed 16-bit audio sample from the audio interface
 172                          */
 173                         static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
 174                         static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 175                         {
 176                                 int16_t Sample;
 177
 178                                 Sample = (int16_t)Endpoint_Read_Word_LE();
 179
 180                                 if (!(Endpoint_BytesInEndpoint()))
 181                                   Endpoint_ClearOUT();
 182
 183                                 return Sample;
 184                         }
 185
 186                         /** Reads the next 24-bit audio sample from the current audio interface.
 187                          *
 188                          *  \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
 189                          *        the correct endpoint is selected and ready for data.
 190                          *
 191                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 192                          *  \return  Signed 24-bit audio sample from the audio interface
 193                          */
 194                         static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
 195                         static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 196                         {
 197                                 int32_t Sample;
 198
 199                                 Sample = (((uint32_t)Endpoint_Read_Byte() << 16) | Endpoint_Read_Word_LE());
 200
 201                                 if (!(Endpoint_BytesInEndpoint()))
 202                                   Endpoint_ClearOUT();
 203
 204                                 return Sample;
 205                         }
 206
 207                         /** Writes the next 8-bit audio sample to the current audio interface.
 208                          *
 209                          *  \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
 210                          *        the correct endpoint is selected and ready for data.
 211                          *
 212                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 213                          *  \param[in] Sample  Signed 8-bit audio sample
 214                          */
 215                         static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 216                                                                      const int8_t Sample) ATTR_ALWAYS_INLINE;
 217                         static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 218                                                                      const int8_t Sample)
 219                         {
 220                                 Endpoint_Write_Byte(Sample);
 221
 222                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 223                                   Endpoint_ClearIN();
 224                         }
 225
 226                         /** Writes the next 16-bit audio sample to the current audio interface.
 227                          *
 228                          *  \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
 229                          *        the correct endpoint is selected and ready for data.
 230                          *
 231                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 232                          *  \param[in] Sample  Signed 16-bit audio sample
 233                          */
 234                         static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 235                                                                       const int16_t Sample) ATTR_ALWAYS_INLINE;
 236                         static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 237                                                                       const int16_t Sample)
 238                         {
 239                                 Endpoint_Write_Word_LE(Sample);
 240
 241                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 242                                   Endpoint_ClearIN();
 243                         }
 244
 245                         /** Writes the next 24-bit audio sample to the current audio interface.
 246                          *
 247                          *  \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
 248                          *        the correct endpoint is selected and ready for data.
 249                          *
 250                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 251                          *  \param[in] Sample  Signed 24-bit audio sample
 252                          */
 253                         static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 254                                                                       const int32_t Sample) ATTR_ALWAYS_INLINE;
 255                         static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 256                                                                       const int32_t Sample)
 257                         {
 258                                 Endpoint_Write_Byte(Sample >> 16);
 259                                 Endpoint_Write_Word_LE(Sample);
 260
 261                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 262                                   Endpoint_ClearIN();
 263                         }
 264
 265         /* Disable C linkage for C++ Compilers: */
 266                 #if defined(__cplusplus)
 267                         }
 268                 #endif
 269
 270 #endif
 271
 272 /** @} */