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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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 incoming Audio Streaming data, if available
  73                                                                                                         *   (zero if unused)
  74                                                                                                         */
  75                                         uint16_t DataINEndpointSize; /**< Size in bytes of the incoming 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 successfully 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 incoming 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                         /** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming
 117                          *  OUT endpoint ready for reading.
 118                          *
 119                          *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
 120                          *        the call will fail.
 121                          *
 122                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 123                          *
 124                          *  \return Boolean true if the given Audio interface has a sample to be read, false otherwise
 125                          */
 126                         bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
 127
 128                         /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects
 129                          *  the streaming IN endpoint ready for writing.
 130                          *
 131                          *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
 132                          *        the call will fail.
 133                          *
 134                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 135                          *
 136                          *  \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise
 137                          */
 138                         bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
 139
 140                 /* Inline Functions: */
 141                         /** General management task for a given Audio class interface, required for the correct operation of the interface. This should
 142                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 143                          *
 144                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 145                          */
 146                         static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
 147                         static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 148                         {
 149                                 (void)AudioInterfaceInfo;
 150                         }
 151
 152                         /** Reads the next 8-bit audio sample from the current audio interface.
 153                          *
 154                          *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
 155                          *        the correct endpoint is selected and ready for data.
 156                          *
 157                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 158                          *
 159                          *  \return  Signed 8-bit audio sample from the audio interface
 160                          */
 161                         static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
 162                         static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 163                         {
 164                                 int8_t Sample;
 165
 166                                 (void)AudioInterfaceInfo;
 167
 168                                 Sample = Endpoint_Read_Byte();
 169
 170                                 if (!(Endpoint_BytesInEndpoint()))
 171                                   Endpoint_ClearOUT();
 172
 173                                 return Sample;
 174                         }
 175
 176                         /** Reads the next 16-bit audio sample from the current audio interface.
 177                          *
 178                          *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
 179                          *        the correct endpoint is selected and ready for data.
 180                          *
 181                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 182                          *
 183                          *  \return  Signed 16-bit audio sample from the audio interface
 184                          */
 185                         static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
 186                         static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 187                         {
 188                                 int16_t Sample;
 189
 190                                 (void)AudioInterfaceInfo;
 191
 192                                 Sample = (int16_t)Endpoint_Read_Word_LE();
 193
 194                                 if (!(Endpoint_BytesInEndpoint()))
 195                                   Endpoint_ClearOUT();
 196
 197                                 return Sample;
 198                         }
 199
 200                         /** Reads the next 24-bit audio sample from the current audio interface.
 201                          *
 202                          *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
 203                          *        the correct endpoint is selected and ready for data.
 204                          *
 205                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 206                          *  \return  Signed 24-bit audio sample from the audio interface
 207                          */
 208                         static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
 209                         static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 210                         {
 211                                 int32_t Sample;
 212
 213                                 (void)AudioInterfaceInfo;
 214
 215                                 Sample = (((uint32_t)Endpoint_Read_Byte() << 16) | Endpoint_Read_Word_LE());
 216
 217                                 if (!(Endpoint_BytesInEndpoint()))
 218                                   Endpoint_ClearOUT();
 219
 220                                 return Sample;
 221                         }
 222
 223                         /** Writes the next 8-bit audio sample to the current audio interface.
 224                          *
 225                          *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
 226                          *        the correct endpoint is selected and ready for data.
 227                          *
 228                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 229                          *  \param[in] Sample  Signed 8-bit audio sample
 230                          */
 231                         static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 232                                                                      const int8_t Sample) ATTR_ALWAYS_INLINE;
 233                         static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 234                                                                      const int8_t Sample)
 235                         {
 236                                 Endpoint_Write_Byte(Sample);
 237
 238                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 239                                   Endpoint_ClearIN();
 240                         }
 241
 242                         /** Writes the next 16-bit audio sample to the current audio interface.
 243                          *
 244                          *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
 245                          *        the correct endpoint is selected and ready for data.
 246                          *
 247                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 248                          *  \param[in] Sample  Signed 16-bit audio sample
 249                          */
 250                         static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 251                                                                       const int16_t Sample) ATTR_ALWAYS_INLINE;
 252                         static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 253                                                                       const int16_t Sample)
 254                         {
 255                                 Endpoint_Write_Word_LE(Sample);
 256
 257                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 258                                   Endpoint_ClearIN();
 259                         }
 260
 261                         /** Writes the next 24-bit audio sample to the current audio interface.
 262                          *
 263                          *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
 264                          *        the correct endpoint is selected and ready for data.
 265                          *
 266                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 267                          *  \param[in] Sample  Signed 24-bit audio sample
 268                          */
 269                         static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 270                                                                       const int32_t Sample) ATTR_ALWAYS_INLINE;
 271                         static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 272                                                                       const int32_t Sample)
 273                         {
 274                                 Endpoint_Write_Byte(Sample >> 16);
 275                                 Endpoint_Write_Word_LE(Sample);
 276
 277                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 278                                   Endpoint_ClearIN();
 279                         }
 280
 281         /* Disable C linkage for C++ Compilers: */
 282                 #if defined(__cplusplus)
 283                         }
 284                 #endif
 285
 286 #endif
 287
 288 /** @} */