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                         /** 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                          *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
 127                          *        the call will fail.
 128                          *
 129                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 130                          *
 131                          *  \return Boolean true if the given Audio interface has a sample to be read, false otherwise
 132                          */
 133                         bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
 134
 135                         /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects
 136                          *  the streaming IN endpoint ready for writing.
 137                          *
 138                          *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
 139                          *        the call will fail.
 140                          *
 141                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 142                          *
 143                          *  \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise
 144                          */
 145                         bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
 146
 147                 /* Inline Functions: */
 148                         /** Reads the next 8-bit audio sample from the current audio interface.
 149                          *
 150                          *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
 151                          *        the correct endpoint is selected and ready for data.
 152                          *
 153                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 154                          *
 155                          *  \return  Signed 8-bit audio sample from the audio interface
 156                          */
 157                         static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
 158                         static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 159                         {
 160                                 int8_t Sample;
 161
 162                                 (void)AudioInterfaceInfo;
 163
 164                                 Sample = Endpoint_Read_Byte();
 165
 166                                 if (!(Endpoint_BytesInEndpoint()))
 167                                   Endpoint_ClearOUT();
 168
 169                                 return Sample;
 170                         }
 171
 172                         /** Reads the next 16-bit audio sample from the current audio interface.
 173                          *
 174                          *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
 175                          *        the correct endpoint is selected and ready for data.
 176                          *
 177                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 178                          *
 179                          *  \return  Signed 16-bit audio sample from the audio interface
 180                          */
 181                         static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
 182                         static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 183                         {
 184                                 int16_t Sample;
 185
 186                                 (void)AudioInterfaceInfo;
 187
 188                                 Sample = (int16_t)Endpoint_Read_Word_LE();
 189
 190                                 if (!(Endpoint_BytesInEndpoint()))
 191                                   Endpoint_ClearOUT();
 192
 193                                 return Sample;
 194                         }
 195
 196                         /** Reads the next 24-bit audio sample from the current audio interface.
 197                          *
 198                          *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
 199                          *        the correct endpoint is selected and ready for data.
 200                          *
 201                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 202                          *  \return  Signed 24-bit audio sample from the audio interface
 203                          */
 204                         static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
 205                         static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 206                         {
 207                                 int32_t Sample;
 208
 209                                 (void)AudioInterfaceInfo;
 210
 211                                 Sample = (((uint32_t)Endpoint_Read_Byte() << 16) | Endpoint_Read_Word_LE());
 212
 213                                 if (!(Endpoint_BytesInEndpoint()))
 214                                   Endpoint_ClearOUT();
 215
 216                                 return Sample;
 217                         }
 218
 219                         /** Writes the next 8-bit audio sample to the current audio interface.
 220                          *
 221                          *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
 222                          *        the correct endpoint is selected and ready for data.
 223                          *
 224                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 225                          *  \param[in] Sample  Signed 8-bit audio sample
 226                          */
 227                         static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 228                                                                      const int8_t Sample) ATTR_ALWAYS_INLINE;
 229                         static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 230                                                                      const int8_t Sample)
 231                         {
 232                                 Endpoint_Write_Byte(Sample);
 233
 234                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 235                                   Endpoint_ClearIN();
 236                         }
 237
 238                         /** Writes the next 16-bit audio sample to the current audio interface.
 239                          *
 240                          *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
 241                          *        the correct endpoint is selected and ready for data.
 242                          *
 243                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 244                          *  \param[in] Sample  Signed 16-bit audio sample
 245                          */
 246                         static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 247                                                                       const int16_t Sample) ATTR_ALWAYS_INLINE;
 248                         static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 249                                                                       const int16_t Sample)
 250                         {
 251                                 Endpoint_Write_Word_LE(Sample);
 252
 253                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 254                                   Endpoint_ClearIN();
 255                         }
 256
 257                         /** Writes the next 24-bit audio sample to the current audio interface.
 258                          *
 259                          *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
 260                          *        the correct endpoint is selected and ready for data.
 261                          *
 262                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 263                          *  \param[in] Sample  Signed 24-bit audio sample
 264                          */
 265                         static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 266                                                                       const int32_t Sample) ATTR_ALWAYS_INLINE;
 267                         static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 268                                                                       const int32_t Sample)
 269                         {
 270                                 Endpoint_Write_Byte(Sample >> 16);
 271                                 Endpoint_Write_Word_LE(Sample);
 272
 273                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 274                                   Endpoint_ClearIN();
 275                         }
 276
 277         /* Disable C linkage for C++ Compilers: */
 278                 #if defined(__cplusplus)
 279                         }
 280                 #endif
 281
 282 #endif
 283
 284 /** @} */