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