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