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