Demos/Device/LowLevel/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[in] 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                 /** Endpoint number of the Audio isochronous streaming data endpoint. */
 141                 #define AUDIO_STREAM_EPNUM           1
 142
 143                 /** Endpoint size in bytes of the Audio isochronous streaming data endpoint. The Windows audio stack requires
 144                  *  at least 192 bytes for correct output, thus the smaller 128 byte maximum endpoint size on some of the smaller
 145                  *  USB AVR models will result in unavoidable distorted output.
 146                  */
 147                 #define AUDIO_STREAM_EPSIZE          ENDPOINT_MAX_SIZE(AUDIO_STREAM_EPNUM)
 148
 149                 /** Sample frequency of the data being transmitted through the streaming endpoint. */
 150                 #define AUDIO_SAMPLE_FREQUENCY       48000
 151
 152         /* Type Defines: */
 153                 /** Type define for an Audio class specific interface descriptor. This follows a regular interface descriptor to
 154                  *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
 155                  *  details.
 156                  */
 157                 typedef struct
 158                 {
 159                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 160                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 161
 162                         uint16_t                  ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */
 163                         uint16_t                  TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */
 164
 165                         uint8_t                   InCollection; /**< Total number of audio class interfaces within this device */
 166                         uint8_t                   InterfaceNumbers[1]; /**< Interface numbers of each audio interface */
 167                 } USB_Audio_Interface_AC_t;
 168
 169                 /** Type define for an Audio class specific Feature Unit descriptor. This indicates to the host what features
 170                  *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
 171                  *  specification for more details.
 172                  */
 173                 typedef struct
 174                 {
 175                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 176                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 177
 178                         uint8_t                   UnitID; /**< ID value of this feature unit - must be a unique value within the device */
 179                         uint8_t                   SourceID; /**< Source ID value of the audio source input into this feature unit */
 180
 181                         uint8_t                   ControlSize; /**< Size of each element in the ChanelControlls array */
 182                         uint8_t                   ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel */
 183
 184                         uint8_t                   FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 185                 } USB_Audio_FeatureUnit_t;
 186
 187                 /** Type define for an Audio class specific input terminal descriptor. This indicates to the host that the device
 188                  *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
 189                  *  a USB endpoint). See the USB Audio specification for more details.
 190                  */
 191                 typedef struct
 192                 {
 193                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 194                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 195
 196                         uint8_t                   TerminalID; /**< ID value of this terminal unit - must be a unique value within the device */
 197                         uint16_t                  TerminalType; /**< Type of terminal, a TERMINAL_* mask */
 198                         uint8_t                   AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals
 199                                                                              *   such as the speaker and microphone of a phone handset
 200                                                                              */
 201                         uint8_t                   TotalChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
 202                         uint16_t                  ChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal */
 203
 204                         uint8_t                   ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device */
 205                         uint8_t                   TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 206                 } USB_Audio_InputTerminal_t;
 207
 208                 /** Type define for an Audio class specific output terminal descriptor. This indicates to the host that the device
 209                  *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
 210                  *  a USB endpoint). See the USB Audio specification for more details.
 211                  */
 212                 typedef struct
 213                 {
 214                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 215                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 216
 217                         uint8_t                   TerminalID; /**< ID value of this terminal unit - must be a unique value within the device */
 218                         uint16_t                  TerminalType; /**< Type of terminal, a TERMINAL_* mask */
 219                         uint8_t                   AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals
 220                                                                             *   such as the speaker and microphone of a phone handset
 221                                                                             */
 222                         uint8_t                   SourceID; /**< ID value of the unit this terminal's audio is sourced from */
 223
 224                         uint8_t                   TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 225                 } USB_Audio_OutputTerminal_t;
 226
 227                 /** Type define for an Audio class specific streaming interface descriptor. This indicates to the host
 228                  *  how audio streams within the device are formatted. See the USB Audio specification for more details.
 229                  */
 230                 typedef struct
 231                 {
 232                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 233                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 234
 235                         uint8_t                   TerminalLink; /**< ID value of the output terminal this descriptor is describing */
 236
 237                         uint8_t                   FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output */
 238                         uint16_t                  AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification */
 239                 } USB_Audio_Interface_AS_t;
 240
 241                 /** Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
 242                  *  this this structure is used to build up the value instead. Fill this structure with the SAMPLE_FREQ() macro.
 243                  */
 244                 typedef struct
 245                 {
 246                         uint16_t                  LowWord; /**< Low 16 bits of the 24-bit value */
 247                         uint8_t                   HighByte; /**< Upper 8 bits of the 24-bit value */
 248                 } Audio_SampleFreq_t;
 249
 250                 /** Type define for an Audio class specific audio format descriptor. This is used to give the host full details
 251                  *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
 252                  *  in the device's audio streams. See the USB Audio specification for more details.
 253                  */
 254                 typedef struct
 255                 {
 256                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 257                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 258
 259                         uint8_t                   FormatType; /**< Format of the audio stream, see Audio Device Formats specification */
 260                         uint8_t                   Channels; /**< Total number of discrete channels in the stream */
 261
 262                         uint8_t                   SubFrameSize; /**< Size in bytes of each channel's sample data in the stream */
 263                         uint8_t                   BitResolution; /**< Bits of resolution of each channel's samples in the stream */
 264
 265                         uint8_t                   SampleFrequencyType; /**< Total number of sample frequencies supported by the device */
 266                         Audio_SampleFreq_t        SampleFrequencies[1]; /**< Sample frequencies supported by the device */
 267                 } USB_Audio_Format_t;
 268
 269                 /** Type define for an Audio class specific endpoint descriptor. This contains a regular endpoint
 270                  *  descriptor with a few Audio-class specific extensions. See the USB Audio specification for more details.
 271                  */
 272                 typedef struct
 273                 {
 274                         USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint */
 275
 276                         uint8_t                   Refresh; /**< Always set to zero */
 277                         uint8_t                   SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise) */
 278                 } USB_Audio_StreamEndpoint_Std_t;
 279
 280                 /** Type define for an Audio class specific extended endpoint descriptor. This contains extra information
 281                  *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
 282                  *  class specific extended endpoint descriptor. See the USB Audio specification for more details.
 283                  */
 284                 typedef struct
 285                 {
 286                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 287                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 288
 289                         uint8_t                   Attributes; /**< Audio class specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS */
 290
 291                         uint8_t                   LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification */
 292                         uint16_t                  LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry */
 293                 } USB_Audio_StreamEndpoint_Spc_t;
 294
 295                 /** Type define for the device configuration descriptor structure. This must be defined in the
 296                  *  application code, as the configuration descriptor contains several sub-descriptors which
 297                  *  vary between devices, and which describe the device's usage to the host.
 298                  */
 299                 typedef struct
 300                 {
 301                         USB_Descriptor_Configuration_Header_t Config;
 302                         USB_Descriptor_Interface_t            AudioControlInterface;
 303                         USB_Audio_Interface_AC_t              AudioControlInterface_SPC;
 304                         USB_Audio_InputTerminal_t             InputTerminal;
 305                         USB_Audio_OutputTerminal_t            OutputTerminal;
 306                         USB_Descriptor_Interface_t            AudioStreamInterface_Alt0;
 307                         USB_Descriptor_Interface_t            AudioStreamInterface_Alt1;
 308                         USB_Audio_Interface_AS_t              AudioStreamInterface_SPC;
 309                         USB_Audio_Format_t                    AudioFormat;
 310                         USB_Audio_StreamEndpoint_Std_t        AudioEndpoint;
 311                         USB_Audio_StreamEndpoint_Spc_t        AudioEndpoint_SPC;
 312                 } USB_Descriptor_Configuration_t;
 313
 314         /* Function Prototypes: */
 315                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 316                                                                                         ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 317
 318 #endif