Demos/Device/AudioOutput/Descriptors.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 /** \file
  32  *
  33  *  Header file for Descriptors.c.
  34  */
  35
  36 #ifndef _DESCRIPTORS_H_
  37 #define _DESCRIPTORS_H_
  38
  39         /* Includes: */
  40                 #include <LUFA/Drivers/USB/USB.h>
  41
  42                 #include <avr/pgmspace.h>
  43
  44         /* Macros: */
  45                 /** Descriptor header constant to indicate a Audio class interface descriptor. */
  46                 #define DTYPE_AudioInterface         0x24
  47
  48                 /** Descriptor header constant to indicate a Audio class endpoint descriptor. */
  49                 #define DTYPE_AudioEndpoint          0x25
  50
  51                 /** Audio class descriptor subtype value for a Audio class specific header descriptor. */
  52                 #define DSUBTYPE_Header              0x01
  53
  54                 /** Audio class descriptor subtype value for an Output Terminal Audio class specific descriptor. */
  55                 #define DSUBTYPE_InputTerminal       0x02
  56
  57                 /** Audio class descriptor subtype value for an Input Terminal Audio class specific descriptor. */
  58                 #define DSUBTYPE_OutputTerminal      0x03
  59
  60                 /** Audio class descriptor subtype value for a Feature Unit Audio class specific descriptor. */
  61                 #define DSUBTYPE_FeatureUnit         0x06
  62
  63                 /** Audio class descriptor subtype value for a general Audio class specific descriptor. */
  64                 #define DSUBTYPE_General             0x01
  65
  66                 /** Audio class descriptor subtype value for an Audio class specific descriptor indicating the format of an audio stream. */
  67                 #define DSUBTYPE_Format              0x02
  68
  69                 //@{
  70                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  71
  72                 #define CHANNEL_LEFT_FRONT           (1 << 0)
  73                 #define CHANNEL_RIGHT_FRONT          (1 << 1)
  74                 #define CHANNEL_CENTER_FRONT         (1 << 2)
  75                 #define CHANNEL_LOW_FREQ_ENHANCE     (1 << 3)
  76                 #define CHANNEL_LEFT_SURROUND        (1 << 4)
  77                 #define CHANNEL_RIGHT_SURROUND       (1 << 5)
  78                 #define CHANNEL_LEFT_OF_CENTER       (1 << 6)
  79                 #define CHANNEL_RIGHT_OF_CENTER      (1 << 7)
  80                 #define CHANNEL_SURROUND             (1 << 8)
  81                 #define CHANNEL_SIDE_LEFT            (1 << 9)
  82                 #define CHANNEL_SIDE_RIGHT           (1 << 10)
  83                 #define CHANNEL_TOP                  (1 << 11)
  84                 //@}
  85
  86                 //@{
  87                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
  88
  89                 #define FEATURE_MUTE                 (1 << 0)
  90                 #define FEATURE_VOLUME               (1 << 1)
  91                 #define FEATURE_BASS                 (1 << 2)
  92                 #define FEATURE_MID                  (1 << 3)
  93                 #define FEATURE_TREBLE               (1 << 4)
  94                 #define FEATURE_GRAPHIC_EQUALIZER    (1 << 5)
  95                 #define FEATURE_AUTOMATIC_GAIN       (1 << 6)
  96                 #define FEATURE_DELAY                (1 << 7)
  97                 #define FEATURE_BASS_BOOST           (1 << 8)
  98                 #define FEATURE_BASS_LOUDNESS        (1 << 9)
  99                 //@}
 100
 101                 //@{
 102                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 103
 104                 #define TERMINAL_UNDEFINED           0x0100
 105                 #define TERMINAL_STREAMING           0x0101
 106                 #define TERMINAL_VENDOR              0x01FF
 107                 #define TERMINAL_IN_UNDEFINED        0x0200
 108                 #define TERMINAL_IN_MIC              0x0201
 109                 #define TERMINAL_IN_DESKTOP_MIC      0x0202
 110                 #define TERMINAL_IN_PERSONAL_MIC     0x0203
 111                 #define TERMINAL_IN_OMNIDIR_MIC      0x0204
 112                 #define TERMINAL_IN_MIC_ARRAY        0x0205
 113                 #define TERMINAL_IN_PROCESSING_MIC   0x0206
 114                 #define TERMINAL_IN_OUT_UNDEFINED    0x0300
 115                 #define TERMINAL_OUT_SPEAKER         0x0301
 116                 #define TERMINAL_OUT_HEADPHONES      0x0302
 117                 #define TERMINAL_OUT_HEAD_MOUNTED    0x0303
 118                 #define TERMINAL_OUT_DESKTOP         0x0304
 119                 #define TERMINAL_OUT_ROOM            0x0305
 120                 #define TERMINAL_OUT_COMMUNICATION   0x0306
 121                 #define TERMINAL_OUT_LOWFREQ         0x0307
 122                 //@}
 123
 124                 /** Convenience macro, to fill a 24-bit AudioSampleFreq_t structure with the given sample rate as a 24-bit number.
 125                  *
 126                  *  \param freq  Required audio sampling frequency in HZ
 127                  */
 128                 #define SAMPLE_FREQ(freq)  {LowWord: ((uint32_t)freq & 0x00FFFF), HighByte: (((uint32_t)freq >> 16) & 0x0000FF)}
 129
 130                 /** Mask for the attributes parameter of an Audio class specific Endpoint descriptor, indicating that the endpoint
 131                  *  accepts only filled endpoint packets of audio samples.
 132                  */
 133                 #define EP_ACCEPTS_ONLY_FULL_PACKETS (1 << 7)
 134
 135                 /** Mask for the attributes parameter of an Audio class specific Endpoint descriptor, indicating that the endpoint
 136                  *  will accept partially filled endpoint packets of audio samples.
 137                  */
 138                 #define EP_ACCEPTS_SMALL_PACKETS     (0 << 7)
 139
 140                 #if defined(USB_FULL_CONTROLLER) || defined(__DOXYGEN__)
 141                         /** Endpoint number of the Audio isochronous streaming data endpoint. */
 142                         #define AUDIO_STREAM_EPNUM       1
 143                 #else
 144                         #define AUDIO_STREAM_EPNUM       3
 145                 #endif
 146
 147                 /** Endpoint size in bytes of the Audio isochronous streaming data endpoint. The Windows audio stack requires
 148                  *  at least 192 bytes for correct output, thus the smaller 128 byte maximum endpoint size on some of the smaller
 149                  *  USB AVR models will result in unavoidable distorted output.
 150                  */
 151                 #define AUDIO_STREAM_EPSIZE          ENDPOINT_MAX_SIZE(AUDIO_STREAM_EPNUM)
 152
 153                 /** Sample frequency of the data being transmitted through the streaming endpoint. */
 154                 #define AUDIO_SAMPLE_FREQUENCY       48000
 155
 156         /* Type Defines: */
 157                 /** Type define for an Audio class specific interface descriptor. This follows a regular interface descriptor to
 158                  *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
 159                  *  details.
 160                  */
 161                 typedef struct
 162                 {
 163                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 164                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 165
 166                         uint16_t                  ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */
 167                         uint16_t                  TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */
 168
 169                         uint8_t                   InCollection; /**< Total number of audio class interfaces within this device */
 170                         uint8_t                   InterfaceNumbers[1]; /**< Interface numbers of each audio interface */
 171                 } USB_AudioInterface_AC_t;
 172
 173                 /** Type define for an Audio class specific Feature Unit descriptor. This indicates to the host what features
 174                  *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
 175                  *  specification for more details.
 176                  */
 177                 typedef struct
 178                 {
 179                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 180                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 181
 182                         uint8_t                   UnitID; /**< ID value of this feature unit - must be a unique value within the device */
 183                         uint8_t                   SourceID; /**< Source ID value of the audio source input into this feature unit */
 184
 185                         uint8_t                   ControlSize; /**< Size of each element in the ChanelControlls array */
 186                         uint8_t                   ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel */
 187
 188                         uint8_t                   FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 189                 } USB_AudioFeatureUnit_t;
 190
 191                 /** Type define for an Audio class specific input terminal descriptor. This indicates to the host that the device
 192                  *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
 193                  *  a USB endpoint). See the USB Audio specification for more details.
 194                  */
 195                 typedef struct
 196                 {
 197                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 198                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 199
 200                         uint8_t                   TerminalID; /**< ID value of this terminal unit - must be a unique value within the device */
 201                         uint16_t                  TerminalType; /**< Type of terminal, a TERMINAL_* mask */
 202                         uint8_t                   AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals
 203                                                                              *   such as the speaker and microphone of a phone handset
 204                                                                              */
 205                         uint8_t                   TotalChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
 206                         uint16_t                  ChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal */
 207
 208                         uint8_t                   ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device */
 209                         uint8_t                   TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 210                 } USB_AudioInputTerminal_t;
 211
 212                 /** Type define for an Audio class specific output terminal descriptor. This indicates to the host that the device
 213                  *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
 214                  *  a USB endpoint). See the USB Audio specification for more details.
 215                  */
 216                 typedef struct
 217                 {
 218                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 219                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 220
 221                         uint8_t                   TerminalID; /**< ID value of this terminal unit - must be a unique value within the device */
 222                         uint16_t                  TerminalType; /**< Type of terminal, a TERMINAL_* mask */
 223                         uint8_t                   AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals
 224                                                                             *   such as the speaker and microphone of a phone handset
 225                                                                             */
 226                         uint8_t                   SourceID; /**< ID value of the unit this terminal's audio is sourced from */
 227
 228                         uint8_t                   TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 229                 } USB_AudioOutputTerminal_t;
 230
 231                 /** Type define for an Audio class specific streaming interface descriptor. This indicates to the host
 232                  *  how audio streams within the device are formatted. See the USB Audio specification for more 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                         uint8_t                   TerminalLink; /**< ID value of the output terminal this descriptor is describing */
 240
 241                         uint8_t                   FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output */
 242                         uint16_t                  AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification */
 243                 } USB_AudioInterface_AS_t;
 244
 245                 /** Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
 246                  *  this this structure is used to build up the value instead. Fill this structure with the SAMPLE_FREQ() macro.
 247                  */
 248                 typedef struct
 249                 {
 250                         uint16_t                  LowWord; /**< Low 16 bits of the 24-bit value */
 251                         uint8_t                   HighByte; /**< Upper 8 bits of the 24-bit value */
 252                 } AudioSampleFreq_t;
 253
 254                 /** Type define for an Audio class specific audio format descriptor. This is used to give the host full details
 255                  *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
 256                  *  in the device's audio streams. See the USB Audio specification for more details.
 257                  */
 258                 typedef struct
 259                 {
 260                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 261                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 262
 263                         uint8_t                   FormatType; /**< Format of the audio stream, see Audio Device Formats specification */
 264                         uint8_t                   Channels; /**< Total number of discrete channels in the stream */
 265
 266                         uint8_t                   SubFrameSize; /**< Size in bytes of each channel's sample data in the stream */
 267                         uint8_t                   BitResolution; /**< Bits of resolution of each channel's samples in the stream */
 268
 269                         uint8_t                   SampleFrequencyType; /**< Total number of sample frequencies supported by the device */
 270                         AudioSampleFreq_t         SampleFrequencies[1]; /**< Sample frequencies supported by the device */
 271                 } USB_AudioFormat_t;
 272
 273                 /** Type define for an Audio class specific endpoint descriptor. This contains a regular endpoint
 274                  *  descriptor with a few Audio-class specific extensions. See the USB Audio specification for more details.
 275                  */
 276                 typedef struct
 277                 {
 278                         USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint */
 279
 280                         uint8_t                   Refresh; /**< Always set to zero */
 281                         uint8_t                   SyncEndpointNumber; /**< Endpoint address to send synchronisation information to, if needed (zero otherwise) */
 282                 } USB_AudioStreamEndpoint_Std_t;
 283
 284                 /** Type define for an Audio class specific extended endpoint descriptor. This contains extra information
 285                  *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
 286                  *  class specific extended endpoint descriptor. See the USB Audio specification for more details.
 287                  */
 288                 typedef struct
 289                 {
 290                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 291                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 292
 293                         uint8_t                   Attributes; /**< Audio class specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS */
 294
 295                         uint8_t                   LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification */
 296                         uint16_t                  LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry */
 297                 } USB_AudioStreamEndpoint_Spc_t;
 298
 299                 /** Type define for the device configuration descriptor structure. This must be defined in the
 300                  *  application code, as the configuration descriptor contains several sub-descriptors which
 301                  *  vary between devices, and which describe the device's usage to the host.
 302                  */
 303                 typedef struct
 304                 {
 305                         USB_Descriptor_Configuration_Header_t Config;
 306                         USB_Descriptor_Interface_t            AudioControlInterface;
 307                         USB_AudioInterface_AC_t               AudioControlInterface_SPC;
 308                         USB_AudioInputTerminal_t              InputTerminal;
 309                         USB_AudioOutputTerminal_t             OutputTerminal;
 310                         USB_Descriptor_Interface_t            AudioStreamInterface_Alt0;
 311                         USB_Descriptor_Interface_t            AudioStreamInterface_Alt1;
 312                         USB_AudioInterface_AS_t               AudioStreamInterface_SPC;
 313                         USB_AudioFormat_t                     AudioFormat;
 314                         USB_AudioStreamEndpoint_Std_t         AudioEndpoint;
 315                         USB_AudioStreamEndpoint_Spc_t         AudioEndpoint_SPC;
 316                 } USB_Descriptor_Configuration_t;
 317
 318         /* Function Prototypes: */
 319                 uint16_t USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 320                                            ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 321
 322 #endif