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