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