LUFA/Drivers/USB/Class/Common/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 /** \file
  32  *  \brief Common definitions and declarations for the library USB Audio 1.0 Class driver.
  33  *
  34  *  Common definitions and declarations 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 class driver
  37  *        dispatch header located in LUFA/Drivers/USB/Class/Audio.h.
  38  */
  39
  40 /** \ingroup Group_USBClassAudio
  41  *  @defgroup Group_USBClassAudioCommon  Common Class Definitions
  42  *
  43  *  \section Module Description
  44  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  45  *  Audio 1.0 Class.
  46  *
  47  *  @{
  48  */
  49
  50 #ifndef _AUDIO_CLASS_COMMON_H_
  51 #define _AUDIO_CLASS_COMMON_H_
  52
  53         /* Includes: */
  54                 #include "../../USB.h"
  55
  56                 #include <string.h>
  57
  58         /* Enable C linkage for C++ Compilers: */
  59                 #if defined(__cplusplus)
  60                         extern "C" {
  61                 #endif
  62
  63         /* Preprocessor Checks: */
  64                 #if !defined(__INCLUDE_FROM_AUDIO_DRIVER)
  65                         #error Do not include this file directly. Include LUFA/Drivers/Class/Audio.h instead.
  66                 #endif
  67
  68         /* Macros: */
  69                 #if !defined(AUDIO_TOTAL_SAMPLE_RATES) || defined(__DOXYGEN__)
  70                         /** Total number of discrete audio sample rates supported by the device. This value can be overridden by defining this
  71                          *  token in the project makefile to the desired value, and passing it to the compiler via the -D switch.
  72                          */
  73                         #define AUDIO_TOTAL_SAMPLE_RATES    1
  74                 #endif
  75
  76                 /** Descriptor header constant to indicate a Audio class interface descriptor. */
  77                 #define DTYPE_AudioInterface         0x24
  78
  79                 /** Descriptor header constant to indicate a Audio class endpoint descriptor. */
  80                 #define DTYPE_AudioEndpoint          0x25
  81
  82                 /** Audio class descriptor subtype value for a Audio class-specific header descriptor. */
  83                 #define DSUBTYPE_Header              0x01
  84
  85                 /** Audio class descriptor subtype value for an Output Terminal Audio class-specific descriptor. */
  86                 #define DSUBTYPE_InputTerminal       0x02
  87
  88                 /** Audio class descriptor subtype value for an Input Terminal Audio class-specific descriptor. */
  89                 #define DSUBTYPE_OutputTerminal      0x03
  90
  91                 /** Audio class descriptor subtype value for a Feature Unit Audio class-specific descriptor. */
  92                 #define DSUBTYPE_FeatureUnit         0x06
  93
  94                 /** Audio class descriptor subtype value for a general Audio class-specific descriptor. */
  95                 #define DSUBTYPE_General             0x01
  96
  97                 /** Audio class descriptor subtype value for an Audio class-specific descriptor indicating the format of an audio stream. */
  98                 #define DSUBTYPE_Format              0x02
  99
 100                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 101                 #define CHANNEL_LEFT_FRONT           (1 << 0)
 102
 103                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 104                 #define CHANNEL_RIGHT_FRONT          (1 << 1)
 105
 106                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 107                 #define CHANNEL_CENTER_FRONT         (1 << 2)
 108
 109                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 110                 #define CHANNEL_LOW_FREQ_ENHANCE     (1 << 3)
 111
 112                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 113                 #define CHANNEL_LEFT_SURROUND        (1 << 4)
 114
 115                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 116                 #define CHANNEL_RIGHT_SURROUND       (1 << 5)
 117
 118                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 119                 #define CHANNEL_LEFT_OF_CENTER       (1 << 6)
 120
 121                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 122                 #define CHANNEL_RIGHT_OF_CENTER      (1 << 7)
 123
 124                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 125                 #define CHANNEL_SURROUND             (1 << 8)
 126
 127                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 128                 #define CHANNEL_SIDE_LEFT            (1 << 9)
 129
 130                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 131                 #define CHANNEL_SIDE_RIGHT           (1 << 10)
 132
 133                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 134                 #define CHANNEL_TOP                  (1 << 11)
 135
 136                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 137                 #define FEATURE_MUTE                 (1 << 0)
 138
 139                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 140                 #define FEATURE_VOLUME               (1 << 1)
 141
 142                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 143                 #define FEATURE_BASS                 (1 << 2)
 144
 145                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 146                 #define FEATURE_MID                  (1 << 3)
 147
 148                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 149                 #define FEATURE_TREBLE               (1 << 4)
 150
 151                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 152                 #define FEATURE_GRAPHIC_EQUALIZER    (1 << 5)
 153
 154                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 155
 156                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 157                 #define FEATURE_AUTOMATIC_GAIN       (1 << 6)
 158
 159                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 160                 #define FEATURE_DELAY                (1 << 7)
 161
 162                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 163                 #define FEATURE_BASS_BOOST           (1 << 8)
 164
 165                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 166                 #define FEATURE_BASS_LOUDNESS        (1 << 9)
 167
 168                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 169                 #define TERMINAL_UNDEFINED           0x0100
 170
 171                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 172                 #define TERMINAL_STREAMING           0x0101
 173
 174                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 175                 #define TERMINAL_VENDOR              0x01FF
 176
 177                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 178                 #define TERMINAL_IN_UNDEFINED        0x0200
 179
 180                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 181                 #define TERMINAL_IN_MIC              0x0201
 182
 183                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 184                 #define TERMINAL_IN_DESKTOP_MIC      0x0202
 185
 186                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 187                 #define TERMINAL_IN_PERSONAL_MIC     0x0203
 188
 189                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 190                 #define TERMINAL_IN_OMNIDIR_MIC      0x0204
 191
 192                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 193                 #define TERMINAL_IN_MIC_ARRAY        0x0205
 194
 195                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 196                 #define TERMINAL_IN_PROCESSING_MIC   0x0206
 197
 198                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 199                 #define TERMINAL_IN_OUT_UNDEFINED    0x0300
 200
 201                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 202                 #define TERMINAL_OUT_SPEAKER         0x0301
 203
 204                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 205                 #define TERMINAL_OUT_HEADPHONES      0x0302
 206
 207                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 208                 #define TERMINAL_OUT_HEAD_MOUNTED    0x0303
 209
 210                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 211                 #define TERMINAL_OUT_DESKTOP         0x0304
 212
 213                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 214                 #define TERMINAL_OUT_ROOM            0x0305
 215
 216                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 217                 #define TERMINAL_OUT_COMMUNICATION   0x0306
 218
 219                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 220                 #define TERMINAL_OUT_LOWFREQ         0x0307
 221
 222                 /** Convenience macro, to fill a 24-bit AudioSampleFreq_t structure with the given sample rate as a 24-bit number.
 223                  *
 224                  *  \param[in] freq  Required audio sampling frequency in HZ
 225                  */
 226                 #define AUDIO_SAMPLE_FREQ(freq)  {LowWord: ((uint32_t)freq & 0x00FFFF), HighByte: (((uint32_t)freq >> 16) & 0x0000FF)}
 227
 228                 /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
 229                  *  accepts only filled endpoint packets of audio samples.
 230                  */
 231                 #define EP_ACCEPTS_ONLY_FULL_PACKETS (1 << 7)
 232
 233                 /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
 234                  *  will accept partially filled endpoint packets of audio samples.
 235                  */
 236                 #define EP_ACCEPTS_SMALL_PACKETS     (0 << 7)
 237
 238         /* Type Defines: */
 239                 /** \brief Audio class-specific Interface Descriptor (LUFA naming conventions).
 240                  *
 241                  *  Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
 242                  *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
 243                  *  details.
 244                  *
 245                  *  \see \ref USB_Audio_StdDescriptor_Interface_AC_t for the version of this type with standard element names.
 246                  */
 247                 typedef struct
 248                 {
 249                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 250                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 251
 252                         uint16_t                ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version. */
 253                         uint16_t                TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 254
 255                         uint8_t                 InCollection; /**< Total number of audio class interfaces within this device. */
 256                         uint8_t                 InterfaceNumbers[1]; /**< Interface numbers of each audio interface. */
 257                 } USB_Audio_Descriptor_Interface_AC_t;
 258
 259                 /** \brief Audio class-specific Interface Descriptor (USB-IF naming conventions).
 260                  *
 261                  *  Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
 262                  *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
 263                  *  details.
 264                  *
 265                  *  \see \ref USB_Audio_Descriptor_Interface_AC_t for the version of this type with non-standard LUFA specific
 266                  *       element names.
 267                  */
 268                 typedef struct
 269                 {
 270                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 271                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 272                                                       *   given by the specific class.
 273                                                       */
 274
 275                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 276
 277                         uint16_t bcdADC; /**< Binary coded decimal value, indicating the supported Audio Class specification version. */
 278                         uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 279
 280                         uint8_t  bInCollection; /**< Total number of audio class interfaces within this device. */
 281                         uint8_t  bInterfaceNumbers[1]; /**< Interface numbers of each audio interface. */
 282                 } USB_Audio_StdDescriptor_Interface_AC_t;
 283
 284                 /** \brief Audio class-specific Feature Unit Descriptor (LUFA naming conventions).
 285                  *
 286                  *  Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
 287                  *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
 288                  *  specification for more details.
 289                  *
 290                  *  \see \ref USB_Audio_StdDescriptor_FeatureUnit_t for the version of this type with standard element names.
 291                  */
 292                 typedef struct
 293                 {
 294                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 295                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 296
 297                         uint8_t                 UnitID; /**< ID value of this feature unit - must be a unique value within the device. */
 298                         uint8_t                 SourceID; /**< Source ID value of the audio source input into this feature unit. */
 299
 300                         uint8_t                 ControlSize; /**< Size of each element in the ChanelControlls array. */
 301                         uint8_t                 ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
 302
 303                         uint8_t                 FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 304                 } USB_Audio_Descriptor_FeatureUnit_t;
 305
 306                 /** \brief Audio class-specific Feature Unit Descriptor (USB-IF naming conventions).
 307                  *
 308                  *  Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
 309                  *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
 310                  *  specification for more details.
 311                  *
 312                  *  \see \ref USB_Audio_Descriptor_FeatureUnit_t for the version of this type with non-standard LUFA specific
 313                  *       element names.
 314                  */
 315                 typedef struct
 316                 {
 317                         uint8_t bLength; /**< Size of the descriptor, in bytes. */
 318                         uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 319                                                       *   given by the specific class.
 320                                                       */
 321
 322                         uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 323
 324                         uint8_t bUnitID; /**< ID value of this feature unit - must be a unique value within the device. */
 325                         uint8_t bSourceID; /**< Source ID value of the audio source input into this feature unit. */
 326
 327                         uint8_t bControlSize; /**< Size of each element in the ChanelControlls array. */
 328                         uint8_t bmaControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
 329
 330                         uint8_t iFeature; /**< Index of a string descriptor describing this descriptor within the device. */
 331                 } USB_Audio_StdDescriptor_FeatureUnit_t;
 332
 333                 /** \brief Audio class-specific Input Terminal Descriptor (LUFA naming conventions).
 334                  *
 335                  *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
 336                  *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
 337                  *  a USB endpoint). See the USB Audio specification for more details.
 338                  *
 339                  *  \see \ref USB_Audio_StdDescriptor_InputTerminal_t for the version of this type with standard element names.
 340                  */
 341                 typedef struct
 342                 {
 343                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 344                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 345
 346                         uint8_t                 TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
 347                         uint16_t                TerminalType; /**< Type of terminal, a TERMINAL_* mask. */
 348                         uint8_t                 AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals
 349                                                                              *   such as the speaker and microphone of a phone handset.
 350                                                                              */
 351                         uint8_t                 TotalChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
 352                         uint16_t                ChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal. */
 353
 354                         uint8_t                 ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device. */
 355                         uint8_t                 TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 356                 } USB_Audio_Descriptor_InputTerminal_t;
 357
 358                 /** \brief Audio class-specific Input Terminal Descriptor (USB-IF naming conventions).
 359                  *
 360                  *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
 361                  *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
 362                  *  a USB endpoint). See the USB Audio specification for more details.
 363                  *
 364                  *  \see \ref USB_Audio_Descriptor_InputTerminal_t for the version of this type with non-standard LUFA specific
 365                  *       element names.
 366                  */
 367                 typedef struct
 368                 {
 369                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 370                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 371                                                       *   given by the specific class.
 372                                                       */
 373
 374                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 375                         uint8_t  bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
 376                         uint16_t wTerminalType; /**< Type of terminal, a TERMINAL_* mask. */
 377                         uint8_t  bAssocTerminal; /**< ID of associated output terminal, for physically grouped terminals
 378                                                   *   such as the speaker and microphone of a phone handset.
 379                                                   */
 380                         uint8_t  bNrChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
 381                         uint16_t wChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal. */
 382
 383                         uint8_t  iChannelNames; /**< Index of a string descriptor describing this channel within the device. */
 384                         uint8_t  iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
 385                 } USB_Audio_StdDescriptor_InputTerminal_t;
 386
 387                 /** \brief Audio class-specific Output Terminal Descriptor (LUFA naming conventions).
 388                  *
 389                  *  Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
 390                  *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
 391                  *  a USB endpoint). See the USB Audio specification for more details.
 392                  *
 393                  *  \see \ref USB_Audio_StdDescriptor_OutputTerminal_t for the version of this type with standard element names.
 394                  */
 395                 typedef struct
 396                 {
 397                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 398                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 399
 400                         uint8_t                 TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
 401                         uint16_t                TerminalType; /**< Type of terminal, a TERMINAL_* mask. */
 402                         uint8_t                 AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals
 403                                                                             *   such as the speaker and microphone of a phone handset.
 404                                                                             */
 405                         uint8_t                 SourceID; /**< ID value of the unit this terminal's audio is sourced from. */
 406
 407                         uint8_t                 TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 408                 } USB_Audio_Descriptor_OutputTerminal_t;
 409
 410                 /** \brief Audio class-specific Output Terminal Descriptor (USB-IF naming conventions).
 411                  *
 412                  *  Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
 413                  *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
 414                  *  a USB endpoint). See the USB Audio specification for more details.
 415                  *
 416                  *  \see \ref USB_Audio_Descriptor_OutputTerminal_t for the version of this type with non-standard LUFA specific
 417                  *       element names.
 418                  */
 419                 typedef struct
 420                 {
 421                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 422                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 423                                                       *   given by the specific class.
 424                                                       */
 425
 426                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 427                         uint8_t  bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
 428                         uint16_t wTerminalType; /**< Type of terminal, a TERMINAL_* mask. */
 429                         uint8_t  bAssocTerminal; /**< ID of associated input terminal, for physically grouped terminals
 430                                                   *   such as the speaker and microphone of a phone handset.
 431                                                   */
 432                         uint8_t  bSourceID; /**< ID value of the unit this terminal's audio is sourced from. */
 433
 434                         uint8_t  iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
 435                 } USB_Audio_StdDescriptor_OutputTerminal_t;
 436
 437                 /** \brief Audio class-specific Streaming Audio Interface Descriptor (LUFA naming conventions).
 438                  *
 439                  *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
 440                  *  how audio streams within the device are formatted. See the USB Audio specification for more details.
 441                  *
 442                  *  \see \ref USB_Audio_StdDescriptor_Interface_AS_t for the version of this type with standard element names.
 443                  */
 444                 typedef struct
 445                 {
 446                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 447                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 448
 449                         uint8_t                 TerminalLink; /**< ID value of the output terminal this descriptor is describing. */
 450
 451                         uint8_t                 FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */
 452                         uint16_t                AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification. */
 453                 } USB_Audio_Descriptor_Interface_AS_t;
 454
 455                 /** \brief Audio class-specific Streaming Audio Interface Descriptor (USB-IF naming conventions).
 456                  *
 457                  *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
 458                  *  how audio streams within the device are formatted. See the USB Audio specification for more details.
 459                  *
 460                  *  \see \ref USB_Audio_Descriptor_Interface_AS_t for the version of this type with non-standard LUFA specific
 461                  *       element names.
 462                  */
 463                 typedef struct
 464                 {
 465                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 466                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 467                                                       *   given by the specific class.
 468                                                       */
 469
 470                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 471
 472                         uint8_t  bTerminalLink; /**< ID value of the output terminal this descriptor is describing. */
 473
 474                         uint8_t  bDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */
 475                         uint16_t wFormatTag; /**< Format of the audio stream, see Audio Device Formats specification. */
 476                 } USB_Audio_StdDescriptor_Interface_AS_t;
 477
 478                 /** \brief 24-Bit Audio Frequency Structure.
 479                  *
 480                  *  Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
 481                  *  this this structure is used to build up the value instead. Fill this structure with the \ref AUDIO_SAMPLE_FREQ() macro.
 482                  */
 483                 typedef struct
 484                 {
 485                         uint16_t    LowWord; /**< Low 16 bits of the 24-bit value. */
 486                         uint8_t     HighByte; /**< Upper 8 bits of the 24-bit value. */
 487                 } USB_Audio_SampleFreq_t;
 488
 489                 /** \brief Audio class-specific Format Descriptor (LUFA naming conventions).
 490                  *
 491                  *  Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
 492                  *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
 493                  *  in the device's audio streams. See the USB Audio specification for more details.
 494                  *
 495                  *  \see \ref USB_Audio_StdDescriptor_Format_t for the version of this type with standard element names.
 496                  */
 497                 typedef struct
 498                 {
 499                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 500                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 501
 502                         uint8_t                 FormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
 503                         uint8_t                 Channels; /**< Total number of discrete channels in the stream. */
 504
 505                         uint8_t                 SubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
 506                         uint8_t                 BitResolution; /**< Bits of resolution of each channel's samples in the stream. */
 507
 508                         uint8_t                 SampleFrequencyType; /**< Total number of sample frequencies supported by the device. */
 509                         USB_Audio_SampleFreq_t  SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES]; /**< Sample frequencies supported by the device (must be 24-bit). */
 510                 } USB_Audio_Descriptor_Format_t;
 511
 512                 /** \brief Audio class-specific Format Descriptor (USB-IF naming conventions).
 513                  *
 514                  *  Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
 515                  *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
 516                  *  in the device's audio streams. See the USB Audio specification for more details.
 517                  *
 518                  *  \see \ref USB_Audio_Descriptor_Format_t for the version of this type with non-standard LUFA specific
 519                  *       element names.
 520                  */
 521                 typedef struct
 522                 {
 523                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 524                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 525                                                       *   given by the specific class.
 526                                                       */
 527
 528                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 529
 530                         uint8_t  bFormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
 531                         uint8_t  bNrChannels; /**< Total number of discrete channels in the stream. */
 532
 533                         uint8_t  bSubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
 534                         uint8_t  bBitResolution; /**< Bits of resolution of each channel's samples in the stream. */
 535
 536                         uint8_t  bSampleFrequencyType; /**< Total number of sample frequencies supported by the device. */
 537                         uint8_t  SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES * 3]; /**< Sample frequencies supported by the device (must be 24-bit). */
 538                 } USB_Audio_StdDescriptor_Format_t;
 539
 540                 /** \brief Audio class-specific Streaming Endpoint Descriptor (LUFA naming conventions).
 541                  *
 542                  *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
 543                  *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
 544                  *
 545                  *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Std_t for the version of this type with standard element names.
 546                  */
 547                 typedef struct
 548                 {
 549                         USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint. */
 550
 551                         uint8_t                   Refresh; /**< Always set to zero for Audio class devices. */
 552                         uint8_t                   SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
 553                 } USB_Audio_Descriptor_StreamEndpoint_Std_t;
 554
 555                 /** \brief Audio class-specific Streaming Endpoint Descriptor (USB-IF naming conventions).
 556                  *
 557                  *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
 558                  *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
 559                  *
 560                  *  \see \ref USB_Audio_Descriptor_StreamEndpoint_Std_t for the version of this type with non-standard LUFA specific
 561                  *       element names.
 562                  */
 563                 typedef struct
 564                 {
 565                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 566                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a
 567                                                                            *   value given by the specific class.
 568                                                                            */
 569                         uint8_t  bEndpointAddress; /**< Logical address of the endpoint within the device for the current
 570                                                                                 *   configuration, including direction mask.
 571                                                                                 */
 572                         uint8_t  bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (EP_TYPE_*)
 573                                                                         *   and attributes (ENDPOINT_ATTR_*) masks.
 574                                                                         */
 575                         uint16_t wMaxPacketSize; /**< Size of the endpoint bank, in bytes. This indicates the maximum packet size
 576                                                                           *   that the endpoint can receive at a time.
 577                                                                           */
 578                         uint8_t  bInterval; /**< Polling interval in milliseconds for the endpoint if it is an INTERRUPT or
 579                                                                  *   ISOCHRONOUS type.
 580                                                                  */
 581
 582                         uint8_t  bRefresh; /**< Always set to zero for Audio class devices. */
 583                         uint8_t  bSynchAddress; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
 584                 } USB_Audio_StdDescriptor_StreamEndpoint_Std_t;
 585
 586                 /** \brief Audio class-specific Extended Endpoint Descriptor (LUFA naming conventions).
 587                  *
 588                  *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
 589                  *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
 590                  *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
 591                  *
 592                  *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Spc_t for the version of this type with standard element names.
 593                  */
 594                 typedef struct
 595                 {
 596                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
 597                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 598
 599                         uint8_t                   Attributes; /**< Audio class-specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS. */
 600
 601                         uint8_t                   LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */
 602                         uint16_t                  LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */
 603                 } USB_Audio_Descriptor_StreamEndpoint_Spc_t;
 604
 605                 /** \brief Audio class-specific Extended Endpoint Descriptor (USB-IF naming conventions).
 606                  *
 607                  *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
 608                  *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
 609                  *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
 610                  *
 611                  *  \see \ref USB_Audio_Descriptor_StreamEndpoint_Spc_t for the version of this type with non-standard LUFA specific
 612                  *       element names.
 613                  */
 614                 typedef struct
 615                 {
 616                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 617                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 618                                                       *   given by the specific class.
 619                                                       */
 620
 621                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 622
 623                         uint8_t  bmAttributes; /**< Audio class-specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS. */
 624
 625                         uint8_t  bLockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */
 626                         uint16_t wLockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */
 627                 } USB_Audio_StdDescriptor_StreamEndpoint_Spc_t;
 628
 629         /* Disable C linkage for C++ Compilers: */
 630                 #if defined(__cplusplus)
 631                         }
 632                 #endif
 633
 634 #endif
 635
 636 /** @} */