Audio.h 34.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
/*
             LUFA Library
     Copyright (C) Dean Camera, 2010.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

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

  Permission to use, copy, modify, distribute, and sell this 
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in 
  all copies and that both that the copyright notice and this
  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 
  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
38
39
40
41
42
43
44
 *
 *  \note This file should not be included directly. It is automatically included as needed by the class driver
 *        dispatch header located in LUFA/Drivers/USB/Class/Audio.h.
 */

/** \ingroup Group_USBClassAudio
 *  @defgroup Group_USBClassAudioCommon  Common Class Definitions
 *
 *  \section Module Description
 *  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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 *
 *  @{
 */

#ifndef _AUDIO_CLASS_COMMON_H_
#define _AUDIO_CLASS_COMMON_H_

	/* Includes: */
		#include "../../USB.h"
		
		#include <string.h>

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

	/* Preprocessor Checks: */
		#if !defined(__INCLUDE_FROM_AUDIO_DRIVER)
			#error Do not include this file directly. Include LUFA/Drivers/Class/Audio.h instead.
		#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
		
		/** Descriptor header constant to indicate a Audio class interface descriptor. */
		#define DTYPE_AudioInterface         0x24

		/** Descriptor header constant to indicate a Audio class endpoint descriptor. */
		#define DTYPE_AudioEndpoint          0x25

82
		/** Audio class descriptor subtype value for a Audio class-specific header descriptor. */
83
84
		#define DSUBTYPE_Header              0x01

85
		/** Audio class descriptor subtype value for an Output Terminal Audio class-specific descriptor. */
86
87
		#define DSUBTYPE_InputTerminal       0x02

88
		/** Audio class descriptor subtype value for an Input Terminal Audio class-specific descriptor. */
89
90
		#define DSUBTYPE_OutputTerminal      0x03

91
		/** Audio class descriptor subtype value for a Feature Unit Audio class-specific descriptor. */
92
93
		#define DSUBTYPE_FeatureUnit         0x06

94
		/** Audio class descriptor subtype value for a general Audio class-specific descriptor. */
95
96
		#define DSUBTYPE_General             0x01

97
		/** Audio class descriptor subtype value for an Audio class-specific descriptor indicating the format of an audio stream. */
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
		#define DSUBTYPE_Format              0x02
		
		/** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
		#define CHANNEL_LEFT_FRONT           (1 << 0)

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

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

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

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

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

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

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

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

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

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

		/** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
		#define CHANNEL_TOP                  (1 << 11)

		/** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
		#define FEATURE_MUTE                 (1 << 0)

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

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

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

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

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

		/** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */

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

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

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

		/** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
		#define FEATURE_BASS_LOUDNESS        (1 << 9)

		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */		
		#define TERMINAL_UNDEFINED           0x0100

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

		/** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */		
		#define TERMINAL_OUT_LOWFREQ         0x0307

		/** Convenience macro, to fill a 24-bit AudioSampleFreq_t structure with the given sample rate as a 24-bit number.
		 *
		 *  \param[in] freq  Required audio sampling frequency in HZ
		 */
		#define AUDIO_SAMPLE_FREQ(freq)  {LowWord: ((uint32_t)freq & 0x00FFFF), HighByte: (((uint32_t)freq >> 16) & 0x0000FF)}
		
228
		/** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
229
230
231
232
		 *  accepts only filled endpoint packets of audio samples.
		 */
		#define EP_ACCEPTS_ONLY_FULL_PACKETS (1 << 7)

233
		/** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
234
235
236
237
238
		 *  will accept partially filled endpoint packets of audio samples.
		 */
		#define EP_ACCEPTS_SMALL_PACKETS     (0 << 7)
		
	/* Type Defines: */
239
		/** \brief Audio class-specific Interface Descriptor (LUFA naming conventions).
240
		 *
241
		 *  Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
242
243
		 *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
		 *  details.
244
245
		 *
		 *  \see \ref USB_Audio_StdDescriptor_Interface_AC_t for the version of this type with standard element names.
246
247
248
		 */
		typedef struct
		{
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
			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. */

			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. */
			
			uint8_t                 InCollection; /**< Total number of audio class interfaces within this device. */
			uint8_t                 InterfaceNumbers[1]; /**< Interface numbers of each audio 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
Dean Camera's avatar
Dean Camera committed
272
273
			                           *   given by the specific class.
			                           */
274

275
276
277
278
			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */

			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. */
279
			
280
281
282
			uint8_t  bInCollection; /**< Total number of audio class interfaces within this device. */
			uint8_t  bInterfaceNumbers[1]; /**< Interface numbers of each audio interface. */
		} USB_Audio_StdDescriptor_Interface_AC_t;
283
		
284
		/** \brief Audio class-specific Feature Unit Descriptor (LUFA naming conventions).
285
		 *
286
		 *  Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
287
288
		 *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
		 *  specification for more details.
289
290
		 *
		 *  \see \ref USB_Audio_StdDescriptor_FeatureUnit_t for the version of this type with standard element names.
291
292
293
		 */
		typedef struct
		{
294
295
			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. */
296
			
297
298
			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. */
299
			
300
301
			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. */
302
			
303
304
			uint8_t                 FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
		} USB_Audio_Descriptor_FeatureUnit_t;
305

306
307
308
309
310
311
312
313
314
315
316
317
318
		/** \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
Dean Camera's avatar
Dean Camera committed
319
320
			                          *   given by the specific class.
			                          */
321
322
323
324
325
326
327
328
329
330
331
332
333

			uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
			
			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. */
			
			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. */
			
			uint8_t iFeature; /**< Index of a string descriptor describing this descriptor within the device. */
		} USB_Audio_StdDescriptor_FeatureUnit_t;

		/** \brief Audio class-specific Input Terminal Descriptor (LUFA naming conventions).
334
		 *
335
		 *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
336
337
		 *  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.
338
339
		 *
		 *  \see \ref USB_Audio_StdDescriptor_InputTerminal_t for the version of this type with standard element names.
340
341
342
		 */
		typedef struct
		{
343
344
			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. */
345
		
346
347
348
			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
349
350
			                                                   *   such as the speaker and microphone of a phone handset.
			                                                   */
351
352
			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. */
353
			
354
355
356
			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;
357

358
359
360
361
362
363
364
365
366
367
368
369
370
		/** \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
371
372
			                           *   given by the specific class.
			                           */
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387

			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
			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. */
			
			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).
388
		 *
389
		 *  Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
390
391
		 *  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.
392
393
		 *
		 *  \see \ref USB_Audio_StdDescriptor_OutputTerminal_t for the version of this type with standard element names.
394
395
396
		 */
		typedef struct
		{
397
398
			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. */
399
		
400
401
402
			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
403
			                                                    *   such as the speaker and microphone of a phone handset.
404
			                                                    */
405
			uint8_t                 SourceID; /**< ID value of the unit this terminal's audio is sourced from. */
406
			
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
			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. */
			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
423
424
			                           *   given by the specific class.
			                           */
425
426
427
428
429
430
431
432
433
434
435

			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */		
			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. */
			
			uint8_t  iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
		} USB_Audio_StdDescriptor_OutputTerminal_t;
436
		
437
		/** \brief Audio class-specific Streaming Audio Interface Descriptor (LUFA naming conventions).
438
		 *
439
		 *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
440
		 *  how audio streams within the device are formatted. See the USB Audio specification for more details.
441
442
		 *
		 *  \see \ref USB_Audio_StdDescriptor_Interface_AS_t for the version of this type with standard element names.
443
444
445
		 */
		typedef struct
		{
446
447
			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. */
448
			
449
			uint8_t                 TerminalLink; /**< ID value of the output terminal this descriptor is describing. */
450
			
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
			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
467
468
			                           *   given by the specific class.
			                           */
469
470
471
472
473
474
475
476

			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */		
			
			uint8_t  bTerminalLink; /**< ID value of the output terminal this descriptor is describing. */
			
			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;
477
478
479
480
		
		/** \brief 24-Bit Audio Frequency Structure.
		 *
		 *  Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
481
		 *  this this structure is used to build up the value instead. Fill this structure with the \ref AUDIO_SAMPLE_FREQ() macro.
482
483
484
		 */
		typedef struct
		{
485
486
			uint16_t    LowWord; /**< Low 16 bits of the 24-bit value. */
			uint8_t     HighByte; /**< Upper 8 bits of the 24-bit value. */
487
488
		} USB_Audio_SampleFreq_t;

489
		/** \brief Audio class-specific Format Descriptor (LUFA naming conventions).
490
		 *
491
		 *  Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
492
493
		 *  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.
494
495
		 *
		 *  \see \ref USB_Audio_StdDescriptor_Format_t for the version of this type with standard element names.
496
497
498
		 */
		typedef struct
		{
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
			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. */

			uint8_t                 FormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
			uint8_t                 Channels; /**< Total number of discrete channels in the stream. */
			
			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. */

			uint8_t                 SampleFrequencyType; /**< Total number of sample frequencies supported by the device. */			
			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
		{
			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
525
526
			                           *   given by the specific class.
			                           */
527

528
529
530
531
			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */		

			uint8_t  bFormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
			uint8_t  bNrChannels; /**< Total number of discrete channels in the stream. */
532
			
533
534
			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. */
535

536
537
538
			uint8_t  bSampleFrequencyType; /**< Total number of sample frequencies supported by the device. */			
			uint8_t  SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES * 3]; /**< Sample frequencies supported by the device (must be 24-bit). */
		} USB_Audio_StdDescriptor_Format_t;
539
		
540
		/** \brief Audio class-specific Streaming Endpoint Descriptor (LUFA naming conventions).
541
		 *
542
543
		 *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint 
		 *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
544
545
		 *
		 *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Std_t for the version of this type with standard element names.
546
547
548
		 */
		typedef struct
		{
549
			USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint. */
550

551
552
			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). */
553
554
555
556
557
558
559
560
561
562
563
564
565
566
		} USB_Audio_Descriptor_StreamEndpoint_Std_t;

		/** \brief Audio class-specific Streaming Endpoint Descriptor (USB-IF naming conventions).
		 *
		 *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint 
		 *  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
567
568
			                           *   value given by the specific class.
			                           */
569
			uint8_t  bEndpointAddress; /**< Logical address of the endpoint within the device for the current 
Dean Camera's avatar
Dean Camera committed
570
571
			                            *   configuration, including direction mask.
			                            */
572
			uint8_t  bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (EP_TYPE_*) 
Dean Camera's avatar
Dean Camera committed
573
574
			                        *   and attributes (ENDPOINT_ATTR_*) masks.
			                        */
575
			uint16_t wMaxPacketSize; /**< Size of the endpoint bank, in bytes. This indicates the maximum packet size
Dean Camera's avatar
Dean Camera committed
576
577
			                          *   that the endpoint can receive at a time.
			                          */
578
			uint8_t  bInterval; /**< Polling interval in milliseconds for the endpoint if it is an INTERRUPT or
Dean Camera's avatar
Dean Camera committed
579
580
581
			                     *   ISOCHRONOUS type.
			                     */
			
582
583
584
			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
585

586
		/** \brief Audio class-specific Extended Endpoint Descriptor (LUFA naming conventions).
587
		 *
588
		 *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
589
		 *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
590
		 *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
591
592
		 *
		 *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Spc_t for the version of this type with standard element names.
593
594
595
		 */
		typedef struct
		{
596
597
			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. */
598
			
599
			uint8_t                   Attributes; /**< Audio class-specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS. */
600

601
602
			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. */
603
		} USB_Audio_Descriptor_StreamEndpoint_Spc_t;
604

605
606
607
608
609
610
611
612
613
614
615
616
617
		/** \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
618
619
			                           *   given by the specific class.
			                           */
620
621
622
623
624
625
626
627
628

			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */		
			
			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;
		
629
630
631
632
633
634
635
636
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
		
#endif

/** @} */