Audio.h 39 KB
Newer Older
1
2
3
/*
             LUFA Library
     Copyright (C) Dean Camera, 2010.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
10
11
*/

/*
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)

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
17
18
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
19
20
21
22
23
24
25
26
27
28
29
30
31
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
32
 *  \brief Common definitions and declarations for the library USB Audio 1.0 Class driver.
33
 *
34
 *  Common definitions and declarations for the library USB Audio 1.0 Class driver.
35
 *
36
37
 *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
 *        dispatch header located in LUFA/Drivers/USB.h.
38
39
40
41
42
 */

/** \ingroup Group_USBClassAudio
 *  @defgroup Group_USBClassAudioCommon  Common Class Definitions
 *
43
 *  \section Sec_ModDescription Module Description
44
 *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
45
 *  Audio 1.0 Class.
46
47
48
49
50
51
52
53
 *
 *  @{
 */

#ifndef _AUDIO_CLASS_COMMON_H_
#define _AUDIO_CLASS_COMMON_H_

	/* Includes: */
54
		#include "../../HighLevel/StdDescriptors.h"
55

56
57
58
59
60
61
62
63
64
		#include <string.h>

	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

	/* Preprocessor Checks: */
		#if !defined(__INCLUDE_FROM_AUDIO_DRIVER)
65
			#error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
66
67
68
69
70
71
72
73
74
		#endif

	/* Macros: */
		#if !defined(AUDIO_TOTAL_SAMPLE_RATES) || defined(__DOXYGEN__)
			/** Total number of discrete audio sample rates supported by the device. This value can be overridden by defining this
			 *  token in the project makefile to the desired value, and passing it to the compiler via the -D switch.
			 */
			#define AUDIO_TOTAL_SAMPLE_RATES    1
		#endif
75
76
77
		
		/** \name Audio Channel Masks */
		//@{
78
		/** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
79
		#define AUDIO_CHANNEL_LEFT_FRONT           (1 << 0)
80
81

		/** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
82
		#define AUDIO_CHANNEL_RIGHT_FRONT          (1 << 1)
83
84

		/** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
85
		#define AUDIO_CHANNEL_CENTER_FRONT         (1 << 2)
86
87

		/** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
88
		#define AUDIO_CHANNEL_LOW_FREQ_ENHANCE     (1 << 3)
89
90

		/** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
91
		#define AUDIO_CHANNEL_LEFT_SURROUND        (1 << 4)
92
93

		/** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
94
		#define AUDIO_CHANNEL_RIGHT_SURROUND       (1 << 5)
95
96

		/** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
97
		#define AUDIO_CHANNEL_LEFT_OF_CENTER       (1 << 6)
98
99

		/** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
100
		#define AUDIO_CHANNEL_RIGHT_OF_CENTER      (1 << 7)
101
102

		/** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
103
		#define AUDIO_CHANNEL_SURROUND             (1 << 8)
104
105

		/** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
106
		#define AUDIO_CHANNEL_SIDE_LEFT            (1 << 9)
107
108

		/** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
109
		#define AUDIO_CHANNEL_SIDE_RIGHT           (1 << 10)
110
111

		/** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
112
		#define AUDIO_CHANNEL_TOP                  (1 << 11)
113
		//@}
114

115
116
		/** \name Audio Feature Masks */
		//@{
117
		/** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
118
		#define AUDIO_FEATURE_MUTE                 (1 << 0)
119
120

		/** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
121
		#define AUDIO_FEATURE_VOLUME               (1 << 1)
122
123

		/** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
124
		#define AUDIO_FEATURE_BASS                 (1 << 2)
125
126

		/** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
127
		#define AUDIO_FEATURE_MID                  (1 << 3)
128
129

		/** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
130
		#define AUDIO_FEATURE_TREBLE               (1 << 4)
131
132

		/** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
133
		#define AUDIO_FEATURE_GRAPHIC_EQUALIZER    (1 << 5)
134
135

		/** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
136
		#define AUDIO_FEATURE_AUTOMATIC_GAIN       (1 << 6)
137
138

		/** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
139
		#define AUDIO_FEATURE_DELAY                (1 << 7)
140
141

		/** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
142
		#define AUDIO_FEATURE_BASS_BOOST           (1 << 8)
143
144

		/** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
145
		#define AUDIO_FEATURE_BASS_LOUDNESS        (1 << 9)
146
		//@}
147

148
149
		/** \name Audio Terminal Types */
		//@{
150
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
151
		#define AUDIO_TERMINAL_UNDEFINED           0x0100
152

153
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
154
		#define AUDIO_TERMINAL_STREAMING           0x0101
155

156
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
157
		#define AUDIO_TERMINAL_VENDOR              0x01FF
158

159
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
160
		#define AUDIO_TERMINAL_IN_UNDEFINED        0x0200
161

162
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
163
		#define AUDIO_TERMINAL_IN_MIC              0x0201
164

165
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
166
		#define AUDIO_TERMINAL_IN_DESKTOP_MIC      0x0202
167

168
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
169
		#define AUDIO_TERMINAL_IN_PERSONAL_MIC     0x0203
170

171
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
172
		#define AUDIO_TERMINAL_IN_OMNIDIR_MIC      0x0204
173

174
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
175
		#define AUDIO_TERMINAL_IN_MIC_ARRAY        0x0205
176

177
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
178
		#define AUDIO_TERMINAL_IN_PROCESSING_MIC   0x0206
179

180
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
181
		#define AUDIO_TERMINAL_IN_OUT_UNDEFINED    0x0300
182

183
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
184
		#define AUDIO_TERMINAL_OUT_SPEAKER         0x0301
185

186
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
187
		#define AUDIO_TERMINAL_OUT_HEADPHONES      0x0302
188

189
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
190
		#define AUDIO_TERMINAL_OUT_HEAD_MOUNTED    0x0303
191

192
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
193
		#define AUDIO_TERMINAL_OUT_DESKTOP         0x0304
194

195
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
196
		#define AUDIO_TERMINAL_OUT_ROOM            0x0305
197

198
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
199
		#define AUDIO_TERMINAL_OUT_COMMUNICATION   0x0306
200

201
		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
202
		#define AUDIO_TERMINAL_OUT_LOWFREQ         0x0307
203
		//@}
204

205
		/** Convenience macro to fill a 24-bit \ref USB_Audio_SampleFreq_t structure with the given sample rate as a 24-bit number.
206
207
208
		 *
		 *  \param[in] freq  Required audio sampling frequency in HZ
		 */
209
		#define AUDIO_SAMPLE_FREQ(freq)           {((uint32_t)freq & 0x00FFFF), (((uint32_t)freq >> 16) & 0x0000FF)}
210

211
		/** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
212
213
		 *  accepts only filled endpoint packets of audio samples.
		 */
214
		#define AUDIO_EP_FULL_PACKETS_ONLY        (1 << 7)
215

216
		/** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
217
218
		 *  will accept partially filled endpoint packets of audio samples.
		 */
219
		#define AUDIO_EP_ACCEPTS_SMALL_PACKETS    (0 << 7)
220

221
	/* Enums: */
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
		/** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the Audio
		 *  device class.
		 */
		enum Audio_Descriptor_ClassSubclassProtocol_t
		{
			AUDIO_CSCP_AudioClass                     = 0x01, /**< Descriptor Class value indicating that the device or
			                                                   *   interface belongs to the USB Audio 1.0 class.
			                                                   */
			AUDIO_CSCP_ControlSubclass                = 0x01, /**< Descriptor Subclass value indicating that the device or
			                                                   *   interface belongs to the Audio Control subclass.
			                                                   */
			AUDIO_CSCP_ControlProtocol                = 0x00, /**< Descriptor Protocol value indicating that the device or
			                                                   *   interface belongs to the Audio Control protocol.
			                                                   */
			AUDIO_CSCP_AudioStreamingSubclass         = 0x02, /**< Descriptor Subclass value indicating that the device or
			                                                   *   interface belongs to the MIDI Streaming subclass.
			                                                   */
			AUDIO_CSCP_MIDIStreamingSubclass          = 0x03, /**< Descriptor Subclass value indicating that the device or
			                                                   *   interface belongs to the Audio streaming subclass.
			                                                   */
			AUDIO_CSCP_StreamingProtocol              = 0x00, /**< Descriptor Protocol value indicating that the device or
			                                                   *   interface belongs to the Streaming Audio protocol.
			                                                   */
		};
	
247
248
		/** Audio class specific interface description subtypes, for the Audio Control interface. */
		enum Audio_CSInterface_AC_SubTypes_t
249
		{
250
251
252
253
254
255
256
257
258
259
260
261
			AUDIO_DSUBTYPE_CSInterface_Header         = 0x01, /**< Audio class specific control interface header. */
			AUDIO_DSUBTYPE_CSInterface_InputTerminal  = 0x02, /**< Audio class specific control interface Input Terminal. */
			AUDIO_DSUBTYPE_CSInterface_OutputTerminal = 0x03, /**< Audio class specific control interface Output Terminal. */
			AUDIO_DSUBTYPE_CSInterface_Mixer          = 0x04, /**< Audio class specific control interface Mixer Unit. */
			AUDIO_DSUBTYPE_CSInterface_Selector       = 0x05, /**< Audio class specific control interface Selector Unit. */
			AUDIO_DSUBTYPE_CSInterface_Feature        = 0x06, /**< Audio class specific control interface Feature Unit. */
			AUDIO_DSUBTYPE_CSInterface_Processing     = 0x07, /**< Audio class specific control interface Processing Unit. */
			AUDIO_DSUBTYPE_CSInterface_Extension      = 0x08, /**< Audio class specific control interface Extension Unit. */
		};

		/** Audio class specific interface description subtypes, for the Audio Streaming interface. */
		enum Audio_CSInterface_AS_SubTypes_t
262
		{
263
264
265
266
			AUDIO_DSUBTYPE_CSInterface_General        = 0x01, /**< Audio class specific streaming interface general descriptor. */
			AUDIO_DSUBTYPE_CSInterface_FormatType     = 0x02, /**< Audio class specific streaming interface format type descriptor. */
			AUDIO_DSUBTYPE_CSInterface_FormatSpecific = 0x03, /**< Audio class specific streaming interface format information descriptor. */
		};
267

268
269
		/** Audio class specific endpoint description subtypes, for the Audio Streaming interface. */
		enum Audio_CSEndpoint_SubTypes_t
270
		{
271
272
			AUDIO_DSUBTYPE_CSEndpoint_General         = 0x01, /**< Audio class specific endpoint general descriptor. */
		};
273

274
	/* Type Defines: */
275
		/** \brief Audio class-specific Input Terminal Descriptor (LUFA naming conventions).
276
		 *
277
		 *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
278
279
		 *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
		 *  a USB endpoint). See the USB Audio specification for more details.
280
281
		 *
		 *  \see \ref USB_Audio_StdDescriptor_InputTerminal_t for the version of this type with standard element names.
282
283
284
		 */
		typedef struct
		{
285
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
286
287
288
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal.
			                                  */
289

290
291
292
			uint8_t                 TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
			uint16_t                TerminalType; /**< Type of terminal, a TERMINAL_* mask. */
			uint8_t                 AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals
Dean Camera's avatar
Dean Camera committed
293
294
			                                                   *   such as the speaker and microphone of a phone handset.
			                                                   */
295
296
			uint8_t                 TotalChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
			uint16_t                ChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal. */
297

298
299
300
			uint8_t                 ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device. */
			uint8_t                 TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
		} USB_Audio_Descriptor_InputTerminal_t;
301

302
303
304
305
306
307
308
309
310
311
312
313
314
		/** \brief Audio class-specific Input Terminal Descriptor (USB-IF naming conventions).
		 *
		 *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
		 *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
		 *  a USB endpoint). See the USB Audio specification for more details.
		 *
		 *  \see \ref USB_Audio_Descriptor_InputTerminal_t for the version of this type with non-standard LUFA specific
		 *       element names.
		 */
		typedef struct
		{
			uint8_t  bLength; /**< Size of the descriptor, in bytes. */
			uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
Dean Camera's avatar
Dean Camera committed
315
316
			                           *   given by the specific class.
			                           */
317

318
319
320
			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                              *   must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal.
			                              */
321
322
323
324
325
326
327
			uint8_t  bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
			uint16_t wTerminalType; /**< Type of terminal, a TERMINAL_* mask. */
			uint8_t  bAssocTerminal; /**< ID of associated output terminal, for physically grouped terminals
			                          *   such as the speaker and microphone of a phone handset.
			                          */
			uint8_t  bNrChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
			uint16_t wChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal. */
328

329
330
331
332
333
			uint8_t  iChannelNames; /**< Index of a string descriptor describing this channel within the device. */
			uint8_t  iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
		} USB_Audio_StdDescriptor_InputTerminal_t;

		/** \brief Audio class-specific Output Terminal Descriptor (LUFA naming conventions).
334
		 *
335
		 *  Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
336
337
		 *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
		 *  a USB endpoint). See the USB Audio specification for more details.
338
339
		 *
		 *  \see \ref USB_Audio_StdDescriptor_OutputTerminal_t for the version of this type with standard element names.
340
341
342
		 */
		typedef struct
		{
343
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
344
345
346
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   must be \ref AUDIO_DSUBTYPE_CSInterface_OutputTerminal.
			                                  */
347

348
349
350
			uint8_t                 TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
			uint16_t                TerminalType; /**< Type of terminal, a TERMINAL_* mask. */
			uint8_t                 AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals
351
			                                                    *   such as the speaker and microphone of a phone handset.
352
			                                                    */
353
			uint8_t                 SourceID; /**< ID value of the unit this terminal's audio is sourced from. */
354

355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
			uint8_t                 TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
		} USB_Audio_Descriptor_OutputTerminal_t;

		/** \brief Audio class-specific Output Terminal Descriptor (USB-IF naming conventions).
		 *
		 *  Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
		 *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
		 *  a USB endpoint). See the USB Audio specification for more details.
		 *
		 *  \see \ref USB_Audio_Descriptor_OutputTerminal_t for the version of this type with non-standard LUFA specific
		 *       element names.
		 */
		typedef struct
		{
			uint8_t  bLength; /**< Size of the descriptor, in bytes. */
370
371
			uint8_t  bDescriptorType; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                           *   must be \ref AUDIO_DSUBTYPE_CSInterface_OutputTerminal.
Dean Camera's avatar
Dean Camera committed
372
			                           */
373

374
375
376
			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                              *   a value from the \ref Audio_CSInterface_AC_SubTypes_t enum.
			                              */
377
378
379
380
381
382
			uint8_t  bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
			uint16_t wTerminalType; /**< Type of terminal, a TERMINAL_* mask. */
			uint8_t  bAssocTerminal; /**< ID of associated input terminal, for physically grouped terminals
			                          *   such as the speaker and microphone of a phone handset.
			                          */
			uint8_t  bSourceID; /**< ID value of the unit this terminal's audio is sourced from. */
383

384
385
			uint8_t  iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
		} USB_Audio_StdDescriptor_OutputTerminal_t;
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403

		/** \brief Audio class-specific Interface Descriptor (LUFA naming conventions).
		 *
		 *  Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
		 *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
		 *  details.
		 *
		 *  \see \ref USB_Audio_StdDescriptor_Interface_AC_t for the version of this type with standard element names.
		 */
		typedef struct
		{
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
			                                  */

			uint16_t                ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version. */
			uint16_t                TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
404

405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
			uint8_t                 InCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */
			uint8_t                 InterfaceNumber; /**< Interface number of the associated Audio Streaming interface. */
		} USB_Audio_Descriptor_Interface_AC_t;

		/** \brief Audio class-specific Interface Descriptor (USB-IF naming conventions).
		 *
		 *  Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
		 *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
		 *  details.
		 *
		 *  \see \ref USB_Audio_Descriptor_Interface_AC_t for the version of this type with non-standard LUFA specific
		 *       element names.
		 */
		typedef struct
		{
			uint8_t  bLength; /**< Size of the descriptor, in bytes. */
			uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
			                           *   given by the specific class.
			                           */

			uint8_t  bDescriptorSubtype;/**< Sub type value used to distinguish between audio class-specific descriptors,
			                             *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
			                             */

			uint16_t bcdADC; /**< Binary coded decimal value, indicating the supported Audio Class specification version. */
			uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
431

432
433
434
			uint8_t  bInCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */
			uint8_t  bInterfaceNumbers; /**< Interface number of the associated Audio Streaming interface. */
		} USB_Audio_StdDescriptor_Interface_AC_t;
435

436
437
438
439
440
441
442
443
444
445
446
447
448
449
		/** \brief Audio class-specific Feature Unit Descriptor (LUFA naming conventions).
		 *
		 *  Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
		 *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
		 *  specification for more details.
		 *
		 *  \see \ref USB_Audio_StdDescriptor_FeatureUnit_t for the version of this type with standard element names.
		 */
		typedef struct
		{
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   must be \ref AUDIO_DSUBTYPE_CSInterface_Feature.
			                                  */
450

451
452
			uint8_t                 UnitID; /**< ID value of this feature unit - must be a unique value within the device. */
			uint8_t                 SourceID; /**< Source ID value of the audio source input into this feature unit. */
453

454
455
			uint8_t                 ControlSize; /**< Size of each element in the ChanelControlls array. */
			uint8_t                 ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
456

457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
			uint8_t                 FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
		} USB_Audio_Descriptor_FeatureUnit_t;

		/** \brief Audio class-specific Feature Unit Descriptor (USB-IF naming conventions).
		 *
		 *  Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
		 *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
		 *  specification for more details.
		 *
		 *  \see \ref USB_Audio_Descriptor_FeatureUnit_t for the version of this type with non-standard LUFA specific
		 *       element names.
		 */
		typedef struct
		{
			uint8_t bLength; /**< Size of the descriptor, in bytes. */
			uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
			                          *   given by the specific class.
			                          */

			uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                             *   must be \ref AUDIO_DSUBTYPE_CSInterface_Feature.
			                             */
479

480
481
			uint8_t bUnitID; /**< ID value of this feature unit - must be a unique value within the device. */
			uint8_t bSourceID; /**< Source ID value of the audio source input into this feature unit. */
482

483
484
			uint8_t bControlSize; /**< Size of each element in the ChanelControlls array. */
			uint8_t bmaControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
485

486
487
			uint8_t iFeature; /**< Index of a string descriptor describing this descriptor within the device. */
		} USB_Audio_StdDescriptor_FeatureUnit_t;
488

489
		/** \brief Audio class-specific Streaming Audio Interface Descriptor (LUFA naming conventions).
490
		 *
491
		 *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
492
		 *  how audio streams within the device are formatted. See the USB Audio specification for more details.
493
494
		 *
		 *  \see \ref USB_Audio_StdDescriptor_Interface_AS_t for the version of this type with standard element names.
495
496
497
		 */
		typedef struct
		{
498
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
499
500
501
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
			                                  */
502

503
			uint8_t                 TerminalLink; /**< ID value of the output terminal this descriptor is describing. */
504

505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
			uint8_t                 FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */
			uint16_t                AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification. */
		} USB_Audio_Descriptor_Interface_AS_t;

		/** \brief Audio class-specific Streaming Audio Interface Descriptor (USB-IF naming conventions).
		 *
		 *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
		 *  how audio streams within the device are formatted. See the USB Audio specification for more details.
		 *
		 *  \see \ref USB_Audio_Descriptor_Interface_AS_t for the version of this type with non-standard LUFA specific
		 *       element names.
		 */
		typedef struct
		{
			uint8_t  bLength; /**< Size of the descriptor, in bytes. */
			uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
Dean Camera's avatar
Dean Camera committed
521
522
			                           *   given by the specific class.
			                           */
523

524
525
526
			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                              *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
			                              */
527

528
			uint8_t  bTerminalLink; /**< ID value of the output terminal this descriptor is describing. */
529

530
531
532
			uint8_t  bDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */
			uint16_t wFormatTag; /**< Format of the audio stream, see Audio Device Formats specification. */
		} USB_Audio_StdDescriptor_Interface_AS_t;
533

534
535
536
		/** \brief 24-Bit Audio Frequency Structure.
		 *
		 *  Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
537
		 *  this this structure is used to build up the value instead. Fill this structure with the \ref AUDIO_SAMPLE_FREQ() macro.
538
539
540
		 */
		typedef struct
		{
541
542
			uint16_t LowWord; /**< Low 16 bits of the 24-bit value. */
			uint8_t  HighByte; /**< Upper 8 bits of the 24-bit value. */
543
544
		} USB_Audio_SampleFreq_t;

545
		/** \brief Audio class-specific Format Descriptor (LUFA naming conventions).
546
		 *
547
		 *  Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
548
549
		 *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
		 *  in the device's audio streams. See the USB Audio specification for more details.
550
551
		 *
		 *  \see \ref USB_Audio_StdDescriptor_Format_t for the version of this type with standard element names.
552
553
554
		 */
		typedef struct
		{
555
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
556
557
558
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   must be \ref AUDIO_DSUBTYPE_CSInterface_FormatType.
			                                  */
559

560
561
			uint8_t                 FormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
			uint8_t                 Channels; /**< Total number of discrete channels in the stream. */
562

563
564
565
			uint8_t                 SubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
			uint8_t                 BitResolution; /**< Bits of resolution of each channel's samples in the stream. */

566
			uint8_t                 SampleFrequencyType; /**< Total number of sample frequencies supported by the device. */
567
568
569
570
571
572
573
574
575
576
577
578
579
580
			USB_Audio_SampleFreq_t  SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES]; /**< Sample frequencies supported by the device (must be 24-bit). */
		} USB_Audio_Descriptor_Format_t;

		/** \brief Audio class-specific Format Descriptor (USB-IF naming conventions).
		 *
		 *  Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
		 *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
		 *  in the device's audio streams. See the USB Audio specification for more details.
		 *
		 *  \see \ref USB_Audio_Descriptor_Format_t for the version of this type with non-standard LUFA specific
		 *       element names.
		 */
		typedef struct
		{
581
582
583
584
			uint8_t bLength; /**< Size of the descriptor, in bytes. */
			uint8_t bDescriptorType; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                          *   must be \ref AUDIO_DSUBTYPE_CSInterface_FormatType.
			                          */
585

586
587
588
			uint8_t bDescriptorSubtype;/**< Sub type value used to distinguish between audio class-specific descriptors,
			                            *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
			                            */
589

590
591
			uint8_t bFormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
			uint8_t bNrChannels; /**< Total number of discrete channels in the stream. */
592

593
594
			uint8_t bSubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
			uint8_t bBitResolution; /**< Bits of resolution of each channel's samples in the stream. */
595

596
			uint8_t bSampleFrequencyType; /**< Total number of sample frequencies supported by the device. */
597
			uint8_t SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES * 3]; /**< Sample frequencies supported by the device (must be 24-bit). */
598
		} USB_Audio_StdDescriptor_Format_t;
599

600
		/** \brief Audio class-specific Streaming Endpoint Descriptor (LUFA naming conventions).
601
		 *
602
		 *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
603
		 *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
604
605
		 *
		 *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Std_t for the version of this type with standard element names.
606
607
608
		 */
		typedef struct
		{
609
			USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint. */
610

611
612
			uint8_t                   Refresh; /**< Always set to zero for Audio class devices. */
			uint8_t                   SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
613
614
615
616
		} USB_Audio_Descriptor_StreamEndpoint_Std_t;

		/** \brief Audio class-specific Streaming Endpoint Descriptor (USB-IF naming conventions).
		 *
617
		 *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
618
619
620
621
622
623
624
625
626
		 *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
		 *
		 *  \see \ref USB_Audio_Descriptor_StreamEndpoint_Std_t for the version of this type with non-standard LUFA specific
		 *       element names.
		 */
		typedef struct
		{
			uint8_t  bLength; /**< Size of the descriptor, in bytes. */
			uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a
Dean Camera's avatar
Dean Camera committed
627
628
			                           *   value given by the specific class.
			                           */
629
			uint8_t  bEndpointAddress; /**< Logical address of the endpoint within the device for the current
Dean Camera's avatar
Dean Camera committed
630
631
			                            *   configuration, including direction mask.
			                            */
632
			uint8_t  bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (EP_TYPE_*)
Dean Camera's avatar
Dean Camera committed
633
634
			                        *   and attributes (ENDPOINT_ATTR_*) masks.
			                        */
635
			uint16_t wMaxPacketSize; /**< Size of the endpoint bank, in bytes. This indicates the maximum packet size
Dean Camera's avatar
Dean Camera committed
636
637
			                          *   that the endpoint can receive at a time.
			                          */
638
			uint8_t  bInterval; /**< Polling interval in milliseconds for the endpoint if it is an INTERRUPT or
Dean Camera's avatar
Dean Camera committed
639
640
			                     *   ISOCHRONOUS type.
			                     */
641

642
643
644
			uint8_t  bRefresh; /**< Always set to zero for Audio class devices. */
			uint8_t  bSynchAddress; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
		} USB_Audio_StdDescriptor_StreamEndpoint_Std_t;
Dean Camera's avatar
Dean Camera committed
645

646
		/** \brief Audio class-specific Extended Endpoint Descriptor (LUFA naming conventions).
647
		 *
648
		 *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
649
		 *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
650
		 *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
651
652
		 *
		 *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Spc_t for the version of this type with standard element names.
653
654
655
		 */
		typedef struct
		{
656
657
658
659
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   a value from the \ref Audio_CSEndpoint_SubTypes_t enum.
			                                  */
660

661
			uint8_t                 Attributes; /**< Audio class-specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS. */
662

663
664
			uint8_t                 LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */
			uint16_t                LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */
665
		} USB_Audio_Descriptor_StreamEndpoint_Spc_t;
666

667
668
669
670
671
672
673
674
675
676
677
678
679
		/** \brief Audio class-specific Extended Endpoint Descriptor (USB-IF naming conventions).
		 *
		 *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
		 *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
		 *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
		 *
		 *  \see \ref USB_Audio_Descriptor_StreamEndpoint_Spc_t for the version of this type with non-standard LUFA specific
		 *       element names.
		 */
		typedef struct
		{
			uint8_t  bLength; /**< Size of the descriptor, in bytes. */
			uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
Dean Camera's avatar
Dean Camera committed
680
681
			                           *   given by the specific class.
			                           */
682

683
684
685
			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                              *   a value from the \ref Audio_CSEndpoint_SubTypes_t enum.
			                              */
686

687
688
689
690
691
			uint8_t  bmAttributes; /**< Audio class-specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS. */

			uint8_t  bLockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */
			uint16_t wLockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */
		} USB_Audio_StdDescriptor_StreamEndpoint_Spc_t;
692

693
694
695
696
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
697

698
699
700
#endif

/** @} */
701