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