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