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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 /** \file
  32  *  \brief Device mode driver for the library USB Audio 1.0 Class driver.
  33  *
  34  *  Device mode driver for the library USB Audio 1.0 Class driver.
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
  37  *        dispatch header located in LUFA/Drivers/USB.h.
  38  */
  39
  40 /** \ingroup Group_USBClassAudio
  41  *  @defgroup Group_USBClassAudioDevice Audio Class Device Mode Driver
  42  *
  43  *  \section Sec_Dependencies Module Source Dependencies
  44  *  The following files must be built with any user project that uses this module:
  45  *    - LUFA/Drivers/USB/Class/Device/Audio.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  46  *
  47  *  \section Sec_ModDescription Module Description
  48  *  Device Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver.
  49  *
  50  *  @{
  51  */
  52
  53 #ifndef _AUDIO_CLASS_DEVICE_H_
  54 #define _AUDIO_CLASS_DEVICE_H_
  55
  56         /* Includes: */
  57                 #include "../../USB.h"
  58                 #include "../Common/Audio.h"
  59
  60                 #include <string.h>
  61
  62         /* Enable C linkage for C++ Compilers: */
  63                 #if defined(__cplusplus)
  64                         extern "C" {
  65                 #endif
  66
  67         /* Preprocessor Checks: */
  68                 #if !defined(__INCLUDE_FROM_AUDIO_DRIVER)
  69                         #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
  70                 #endif
  71
  72                 #if defined(__INCLUDE_FROM_AUDIO_DEVICE_C) && defined(NO_STREAM_CALLBACKS)
  73                         #error The NO_STREAM_CALLBACKS compile time option cannot be used in projects using the library Class drivers.
  74                 #endif
  75
  76         /* Public Interface - May be used in end-application: */
  77                 /* Type Defines: */
  78                         /** \brief Audio Class Device Mode Configuration and State Structure.
  79                          *
  80                          *  Class state structure. An instance of this structure should be made for each Audio interface
  81                          *  within the user application, and passed to each of the Audio class driver functions as the
  82                          *  AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information.
  83                          */
  84                         typedef struct
  85                         {
  86                                 const struct
  87                                 {
  88                                         uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this
  89                                                                                                                 *   structure controls.
  90                                                                                                                 */
  91
  92                                         uint8_t  DataINEndpointNumber; /**< Endpoint number of the incoming Audio Streaming data, if available
  93                                                                                                         *   (zero if unused).
  94                                                                                                         */
  95                                         uint16_t DataINEndpointSize; /**< Size in bytes of the incoming Audio Streaming data endpoint, if available
  96                                                                                                   *   (zero if unused).
  97                                                                                                   */
  98
  99                                         uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the outgoing Audio Streaming data, if available
 100                                                                                                          *   (zero if unused).
 101                                                                                                          */
 102                                         uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing Audio Streaming data endpoint, if available
 103                                                                                                    *   (zero if unused).
 104                                                                                                    */
 105                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
 106                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
 107                                            */
 108                                 struct
 109                                 {
 110                                         bool     InterfaceEnabled; /**< Set and cleared by the class driver to indicate if the host has enabled the streaming endpoints
 111                                                                                                 *   of the Audio Streaming interface.
 112                                                                                                 */
 113                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 114                                           *   are reset to their defaults when the interface is enumerated.
 115                                           */
 116                         } USB_ClassInfo_Audio_Device_t;
 117
 118                 /* Function Prototypes: */
 119                         /** Configures the endpoints of a given Audio interface, ready for use. This should be linked to the library
 120                          *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the
 121                          *  given Audio interface is selected.
 122                          *
 123                          *  \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other
 124                          *        interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
 125                          *        within a single interface is allowed, but no two interfaces of any type have have interleaved endpoint indexes.
 126                          *
 127                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 128                          *
 129                          *  \return Boolean true if the endpoints were successfully configured, false otherwise.
 130                          */
 131                         bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 132
 133                         /** Processes incoming control requests from the host, that are directed to the given Audio class interface. This should be
 134                          *  linked to the library \ref EVENT_USB_Device_ControlRequest() event.
 135                          *
 136                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 137                          */
 138                         void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 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                                                                 ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 148                         static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 149                         {
 150                                 (void)AudioInterfaceInfo;
 151                         }
 152
 153                         /** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming
 154                          *  OUT endpoint ready for reading.
 155                          *
 156                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
 157                          *       the call will fail.
 158                          *
 159                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 160                          *
 161                          *  \return Boolean true if the given Audio interface has a sample to be read, false otherwise.
 162                          */
 163                         static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 164                                                                          ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 165                         static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 166                         {
 167                                 if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
 168                                   return false;
 169
 170                                 Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataOUTEndpointNumber);
 171                                 return Endpoint_IsOUTReceived();
 172                         }
 173
 174                         /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects
 175                          *  the streaming IN endpoint ready for writing.
 176                          *
 177                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
 178                          *       the call will fail.
 179                          *
 180                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 181                          *
 182                          *  \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise.
 183                          */
 184                         static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 185                                                                              ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 186                         static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 187                         {
 188                                 if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
 189                                   return false;
 190
 191                                 Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataINEndpointNumber);
 192                                 return Endpoint_IsINReady();
 193                         }
 194
 195                         /** Reads the next 8-bit audio sample from the current audio interface.
 196                          *
 197                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
 198                          *       ensure the correct endpoint is selected and ready for data.
 199                          *
 200                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 201                          *
 202                          *  \return  Signed 8-bit audio sample from the audio interface.
 203                          */
 204                         static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 205                                                                       ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 206                         static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 207                         {
 208                                 int8_t Sample;
 209
 210                                 (void)AudioInterfaceInfo;
 211
 212                                 Sample = Endpoint_Read_Byte();
 213
 214                                 if (!(Endpoint_BytesInEndpoint()))
 215                                   Endpoint_ClearOUT();
 216
 217                                 return Sample;
 218                         }
 219
 220                         /** Reads the next 16-bit audio sample from the current audio interface.
 221                          *
 222                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
 223                          *       that the correct endpoint is selected and ready for data.
 224                          *
 225                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 226                          *
 227                          *  \return  Signed 16-bit audio sample from the audio interface.
 228                          */
 229                         static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 230                                                                         ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 231                         static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 232                         {
 233                                 int16_t Sample;
 234
 235                                 (void)AudioInterfaceInfo;
 236
 237                                 Sample = (int16_t)Endpoint_Read_Word_LE();
 238
 239                                 if (!(Endpoint_BytesInEndpoint()))
 240                                   Endpoint_ClearOUT();
 241
 242                                 return Sample;
 243                         }
 244
 245                         /** Reads the next 24-bit audio sample from the current audio interface.
 246                          *
 247                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
 248                          *       that 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                          *
 252                          *  \return Signed 24-bit audio sample from the audio interface.
 253                          */
 254                         static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 255                                                                         ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 256                         static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 257                         {
 258                                 int32_t Sample;
 259
 260                                 (void)AudioInterfaceInfo;
 261
 262                                 Sample = (((uint32_t)Endpoint_Read_Byte() << 16) | Endpoint_Read_Word_LE());
 263
 264                                 if (!(Endpoint_BytesInEndpoint()))
 265                                   Endpoint_ClearOUT();
 266
 267                                 return Sample;
 268                         }
 269
 270                         /** Writes the next 8-bit audio sample to the current audio interface.
 271                          *
 272                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
 273                          *       ensure that the correct endpoint is selected and ready for data.
 274                          *
 275                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 276                          *  \param[in]     Sample              Signed 8-bit audio sample.
 277                          */
 278                         static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 279                                                                      const int8_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 280                         static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 281                                                                      const int8_t Sample)
 282                         {
 283                                 Endpoint_Write_Byte(Sample);
 284
 285                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 286                                   Endpoint_ClearIN();
 287                         }
 288
 289                         /** Writes the next 16-bit audio sample to the current audio interface.
 290                          *
 291                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
 292                          *       ensure that the correct endpoint is selected and ready for data.
 293                          *
 294                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 295                          *  \param[in]     Sample              Signed 16-bit audio sample.
 296                          */
 297                         static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 298                                                                       const int16_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 299                         static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 300                                                                       const int16_t Sample)
 301                         {
 302                                 Endpoint_Write_Word_LE(Sample);
 303
 304                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 305                                   Endpoint_ClearIN();
 306                         }
 307
 308                         /** Writes the next 24-bit audio sample to the current audio interface.
 309                          *
 310                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
 311                          *       ensure that the correct endpoint is selected and ready for data.
 312                          *
 313                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 314                          *  \param[in]     Sample              Signed 24-bit audio sample.
 315                          */
 316                         static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 317                                                                       const int32_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 318                         static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 319                                                                       const int32_t Sample)
 320                         {
 321                                 Endpoint_Write_Word_LE(Sample);
 322                                 Endpoint_Write_Byte(Sample >> 16);
 323
 324                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 325                                   Endpoint_ClearIN();
 326                         }
 327
 328         /* Disable C linkage for C++ Compilers: */
 329                 #if defined(__cplusplus)
 330                         }
 331                 #endif
 332
 333 #endif
 334
 335 /** @} */
 336