LUFA/Drivers/USB/Class/Common/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  *  @{
  33  */
  34
  35 #ifndef _AUDIO_CLASS_COMMON_H_
  36 #define _AUDIO_CLASS_COMMON_H_
  37
  38         /* Includes: */
  39                 #include "../../USB.h"
  40
  41                 #include <string.h>
  42
  43         /* Enable C linkage for C++ Compilers: */
  44                 #if defined(__cplusplus)
  45                         extern "C" {
  46                 #endif
  47
  48         /* Macros: */
  49                 /** Descriptor header constant to indicate a Audio class interface descriptor. */
  50                 #define DTYPE_AudioInterface         0x24
  51
  52                 /** Descriptor header constant to indicate a Audio class endpoint descriptor. */
  53                 #define DTYPE_AudioEndpoint          0x25
  54
  55                 /** Audio class descriptor subtype value for a Audio class specific header descriptor. */
  56                 #define DSUBTYPE_Header              0x01
  57
  58                 /** Audio class descriptor subtype value for an Output Terminal Audio class specific descriptor. */
  59                 #define DSUBTYPE_InputTerminal       0x02
  60
  61                 /** Audio class descriptor subtype value for an Input Terminal Audio class specific descriptor. */
  62                 #define DSUBTYPE_OutputTerminal      0x03
  63
  64                 /** Audio class descriptor subtype value for a Feature Unit Audio class specific descriptor. */
  65                 #define DSUBTYPE_FeatureUnit         0x06
  66
  67                 /** Audio class descriptor subtype value for a general Audio class specific descriptor. */
  68                 #define DSUBTYPE_General             0x01
  69
  70                 /** Audio class descriptor subtype value for an Audio class specific descriptor indicating the format of an audio stream. */
  71                 #define DSUBTYPE_Format              0x02
  72
  73                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  74                 #define CHANNEL_LEFT_FRONT           (1 << 0)
  75
  76                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  77                 #define CHANNEL_RIGHT_FRONT          (1 << 1)
  78
  79                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  80                 #define CHANNEL_CENTER_FRONT         (1 << 2)
  81
  82                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  83                 #define CHANNEL_LOW_FREQ_ENHANCE     (1 << 3)
  84
  85                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  86                 #define CHANNEL_LEFT_SURROUND        (1 << 4)
  87
  88                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  89                 #define CHANNEL_RIGHT_SURROUND       (1 << 5)
  90
  91                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  92                 #define CHANNEL_LEFT_OF_CENTER       (1 << 6)
  93
  94                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  95                 #define CHANNEL_RIGHT_OF_CENTER      (1 << 7)
  96
  97                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  98                 #define CHANNEL_SURROUND             (1 << 8)
  99
 100                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 101                 #define CHANNEL_SIDE_LEFT            (1 << 9)
 102
 103                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 104                 #define CHANNEL_SIDE_RIGHT           (1 << 10)
 105
 106                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 107                 #define CHANNEL_TOP                  (1 << 11)
 108
 109                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 110                 #define FEATURE_MUTE                 (1 << 0)
 111
 112                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 113                 #define FEATURE_VOLUME               (1 << 1)
 114
 115                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 116                 #define FEATURE_BASS                 (1 << 2)
 117
 118                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 119                 #define FEATURE_MID                  (1 << 3)
 120
 121                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 122                 #define FEATURE_TREBLE               (1 << 4)
 123
 124                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 125                 #define FEATURE_GRAPHIC_EQUALIZER    (1 << 5)
 126
 127                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 128
 129                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 130                 #define FEATURE_AUTOMATIC_GAIN       (1 << 6)
 131
 132                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 133                 #define FEATURE_DELAY                (1 << 7)
 134
 135                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 136                 #define FEATURE_BASS_BOOST           (1 << 8)
 137
 138                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 139                 #define FEATURE_BASS_LOUDNESS        (1 << 9)
 140
 141                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 142                 #define TERMINAL_UNDEFINED           0x0100
 143
 144                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 145                 #define TERMINAL_STREAMING           0x0101
 146
 147                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 148                 #define TERMINAL_VENDOR              0x01FF
 149
 150                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 151                 #define TERMINAL_IN_UNDEFINED        0x0200
 152
 153                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 154                 #define TERMINAL_IN_MIC              0x0201
 155
 156                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 157                 #define TERMINAL_IN_DESKTOP_MIC      0x0202
 158
 159                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 160                 #define TERMINAL_IN_PERSONAL_MIC     0x0203
 161
 162                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 163                 #define TERMINAL_IN_OMNIDIR_MIC      0x0204
 164
 165                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 166                 #define TERMINAL_IN_MIC_ARRAY        0x0205
 167
 168                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 169                 #define TERMINAL_IN_PROCESSING_MIC   0x0206
 170
 171                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 172                 #define TERMINAL_IN_OUT_UNDEFINED    0x0300
 173
 174                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 175                 #define TERMINAL_OUT_SPEAKER         0x0301
 176
 177                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 178                 #define TERMINAL_OUT_HEADPHONES      0x0302
 179
 180                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 181                 #define TERMINAL_OUT_HEAD_MOUNTED    0x0303
 182
 183                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 184                 #define TERMINAL_OUT_DESKTOP         0x0304
 185
 186                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 187                 #define TERMINAL_OUT_ROOM            0x0305
 188
 189                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 190                 #define TERMINAL_OUT_COMMUNICATION   0x0306
 191
 192                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 193                 #define TERMINAL_OUT_LOWFREQ         0x0307
 194
 195                 /** Convenience macro, to fill a 24-bit AudioSampleFreq_t structure with the given sample rate as a 24-bit number.
 196                  *
 197                  *  \param freq  Required audio sampling frequency in HZ
 198                  */
 199                 #define AUDIO_SAMPLE_FREQ(freq)  {LowWord: ((uint32_t)freq & 0x00FFFF), HighByte: (((uint32_t)freq >> 16) & 0x0000FF)}
 200
 201                 /** Mask for the attributes parameter of an Audio class specific Endpoint descriptor, indicating that the endpoint
 202                  *  accepts only filled endpoint packets of audio samples.
 203                  */
 204                 #define EP_ACCEPTS_ONLY_FULL_PACKETS (1 << 7)
 205
 206                 /** Mask for the attributes parameter of an Audio class specific Endpoint descriptor, indicating that the endpoint
 207                  *  will accept partially filled endpoint packets of audio samples.
 208                  */
 209                 #define EP_ACCEPTS_SMALL_PACKETS     (0 << 7)
 210
 211         /* Type Defines: */
 212                 /** Type define for an Audio class specific interface descriptor. This follows a regular interface descriptor to
 213                  *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
 214                  *  details.
 215                  */
 216                 typedef struct
 217                 {
 218                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 219                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 220
 221                         uint16_t                  ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */
 222                         uint16_t                  TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */
 223
 224                         uint8_t                   InCollection; /**< Total number of audio class interfaces within this device */
 225                         uint8_t                   InterfaceNumbers[1]; /**< Interface numbers of each audio interface */
 226                 } USB_AudioInterface_AC_t;
 227
 228                 /** Type define for an Audio class specific Feature Unit descriptor. This indicates to the host what features
 229                  *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
 230                  *  specification for more details.
 231                  */
 232                 typedef struct
 233                 {
 234                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 235                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 236
 237                         uint8_t                   UnitID; /**< ID value of this feature unit - must be a unique value within the device */
 238                         uint8_t                   SourceID; /**< Source ID value of the audio source input into this feature unit */
 239
 240                         uint8_t                   ControlSize; /**< Size of each element in the ChanelControlls array */
 241                         uint8_t                   ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel */
 242
 243                         uint8_t                   FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 244                 } USB_AudioFeatureUnit_t;
 245
 246                 /** Type define for an Audio class specific input terminal descriptor. This indicates to the host that the device
 247                  *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
 248                  *  a USB endpoint). See the USB Audio specification for more details.
 249                  */
 250                 typedef struct
 251                 {
 252                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 253                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 254
 255                         uint8_t                   TerminalID; /**< ID value of this terminal unit - must be a unique value within the device */
 256                         uint16_t                  TerminalType; /**< Type of terminal, a TERMINAL_* mask */
 257                         uint8_t                   AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals
 258                                                                              *   such as the speaker and microphone of a phone handset
 259                                                                              */
 260                         uint8_t                   TotalChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
 261                         uint16_t                  ChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal */
 262
 263                         uint8_t                   ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device */
 264                         uint8_t                   TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 265                 } USB_AudioInputTerminal_t;
 266
 267                 /** Type define for an Audio class specific output terminal descriptor. This indicates to the host that the device
 268                  *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
 269                  *  a USB endpoint). See the USB Audio specification for more details.
 270                  */
 271                 typedef struct
 272                 {
 273                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 274                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 275
 276                         uint8_t                   TerminalID; /**< ID value of this terminal unit - must be a unique value within the device */
 277                         uint16_t                  TerminalType; /**< Type of terminal, a TERMINAL_* mask */
 278                         uint8_t                   AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals
 279                                                                             *   such as the speaker and microphone of a phone handset
 280                                                                             */
 281                         uint8_t                   SourceID; /**< ID value of the unit this terminal's audio is sourced from */
 282
 283                         uint8_t                   TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 284                 } USB_AudioOutputTerminal_t;
 285
 286                 /** Type define for an Audio class specific streaming interface descriptor. This indicates to the host
 287                  *  how audio streams within the device are formatted. See the USB Audio specification for more details.
 288                  */
 289                 typedef struct
 290                 {
 291                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 292                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 293
 294                         uint8_t                   TerminalLink; /**< ID value of the output terminal this descriptor is describing */
 295
 296                         uint8_t                   FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output */
 297                         uint16_t                  AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification */
 298                 } USB_AudioInterface_AS_t;
 299
 300                 /** Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
 301                  *  this this structure is used to build up the value instead. Fill this structure with the SAMPLE_FREQ() macro.
 302                  */
 303                 typedef struct
 304                 {
 305                         uint16_t                  LowWord; /**< Low 16 bits of the 24-bit value */
 306                         uint8_t                   HighByte; /**< Upper 8 bits of the 24-bit value */
 307                 } AudioSampleFreq_t;
 308
 309                 /** Type define for an Audio class specific audio format descriptor. This is used to give the host full details
 310                  *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
 311                  *  in the device's audio streams. See the USB Audio specification for more details.
 312                  */
 313                 typedef struct
 314                 {
 315                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 316                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 317
 318                         uint8_t                   FormatType; /**< Format of the audio stream, see Audio Device Formats specification */
 319                         uint8_t                   Channels; /**< Total number of discrete channels in the stream */
 320
 321                         uint8_t                   SubFrameSize; /**< Size in bytes of each channel's sample data in the stream */
 322                         uint8_t                   BitResolution; /**< Bits of resolution of each channel's samples in the stream */
 323
 324                         uint8_t                   SampleFrequencyType; /**< Total number of sample frequencies supported by the device */
 325                         AudioSampleFreq_t         SampleFrequencies[1]; /**< Sample frequencies supported by the device */
 326                 } USB_AudioFormat_t;
 327
 328                 /** Type define for an Audio class specific endpoint descriptor. This contains a regular endpoint
 329                  *  descriptor with a few Audio-class specific extensions. See the USB Audio specification for more details.
 330                  */
 331                 typedef struct
 332                 {
 333                         USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint */
 334
 335                         uint8_t                   Refresh; /**< Always set to zero */
 336                         uint8_t                   SyncEndpointNumber; /**< Endpoint address to send synchronisation information to, if needed (zero otherwise) */
 337                 } USB_AudioStreamEndpoint_Std_t;
 338
 339                 /** Type define for an Audio class specific extended endpoint descriptor. This contains extra information
 340                  *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
 341                  *  class specific extended endpoint descriptor. See the USB Audio specification for more details.
 342                  */
 343                 typedef struct
 344                 {
 345                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 346                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 347
 348                         uint8_t                   Attributes; /**< Audio class specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS */
 349
 350                         uint8_t                   LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification */
 351                         uint16_t                  LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry */
 352                 } USB_AudioStreamEndpoint_Spc_t;
 353
 354                 /** Class state structure. An instance of this structure should be made for each Audio interface
 355                  *  within the user application, and passed to each of the Audio class driver functions as the
 356                  *  AudioInterfaceInfo parameter. The contents of this structure should be set to their correct
 357                  *  values when used, or ommitted to force the library to use default values.
 358                  */
 359                 typedef struct
 360                 {
 361                         uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls */
 362
 363                         uint8_t  DataINEndpointNumber; /**< Endpoint number of the incomming Audio Streaming data, if available (zero if unused) */
 364                         uint16_t DataINEndpointSize; /**< Size in bytes of the incomming Audio Streaming data endpoint, if available (zero if unused) */
 365
 366                         uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the outgoing Audio Streaming data, if available (zero if unused) */
 367                         uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing Audio Streaming data endpoint, if available (zero if unused) */
 368
 369                         bool     InterfaceEnabled; /**< Set and cleared by the class driver to indicate if the host has enabled the streaming endpoints
 370                                                     *   of the Audio Streaming interface
 371                                                     */
 372                 } USB_ClassInfo_Audio_t;
 373
 374         /* Disable C linkage for C++ Compilers: */
 375                 #if defined(__cplusplus)
 376                         }
 377                 #endif
 378
 379 #endif
 380
 381 /** @} */