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

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

/*
  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
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
 *
 *  @{
 */

#ifndef _AUDIO_CLASS_COMMON_H_
#define _AUDIO_CLASS_COMMON_H_

	/* Includes: */
		#include "../../USB.h"
55

56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
		#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
75

76
		/** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
77
		#define AUDIO_CHANNEL_LEFT_FRONT           (1 << 0)
78
79

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

196
		/** Convenience macro to fill a 24-bit \ref USB_Audio_SampleFreq_t structure with the given sample rate as a 24-bit number.
197
198
199
		 *
		 *  \param[in] freq  Required audio sampling frequency in HZ
		 */
200
		#define AUDIO_SAMPLE_FREQ(freq)           {((uint32_t)freq & 0x00FFFF), (((uint32_t)freq >> 16) & 0x0000FF)}
201

202
		/** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
203
204
		 *  accepts only filled endpoint packets of audio samples.
		 */
205
		#define AUDIO_EP_FULL_PACKETS_ONLY        (1 << 7)
206

207
		/** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
208
209
		 *  will accept partially filled endpoint packets of audio samples.
		 */
210
		#define AUDIO_EP_ACCEPTS_SMALL_PACKETS    (0 << 7)
211

212
213
214
	/* Enums: */
		/** Audio class specific interface description subtypes, for the Audio Control interface. */
		enum Audio_CSInterface_AC_SubTypes_t
215
		{
216
217
218
219
220
221
222
223
224
225
226
227
			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
228
		{
229
230
231
232
			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. */
		};
233

234
235
		/** Audio class specific endpoint description subtypes, for the Audio Streaming interface. */
		enum Audio_CSEndpoint_SubTypes_t
236
		{
237
238
			AUDIO_DSUBTYPE_CSEndpoint_General         = 0x01, /**< Audio class specific endpoint general descriptor. */
		};
239

240
	/* Type Defines: */
241
		/** \brief Audio class-specific Input Terminal Descriptor (LUFA naming conventions).
242
		 *
243
		 *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
244
245
		 *  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.
246
247
		 *
		 *  \see \ref USB_Audio_StdDescriptor_InputTerminal_t for the version of this type with standard element names.
248
249
250
		 */
		typedef struct
		{
251
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
252
253
254
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal.
			                                  */
255

256
257
258
			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
259
260
			                                                   *   such as the speaker and microphone of a phone handset.
			                                                   */
261
262
			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. */
263

264
265
266
			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;
267

268
269
270
271
272
273
274
275
276
277
278
279
280
		/** \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
281
282
			                           *   given by the specific class.
			                           */
283

284
285
286
			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                              *   must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal.
			                              */
287
288
289
290
291
292
293
			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. */
294

295
296
297
298
299
			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).
300
		 *
301
		 *  Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
302
303
		 *  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.
304
305
		 *
		 *  \see \ref USB_Audio_StdDescriptor_OutputTerminal_t for the version of this type with standard element names.
306
307
308
		 */
		typedef struct
		{
309
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
310
311
312
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   must be \ref AUDIO_DSUBTYPE_CSInterface_OutputTerminal.
			                                  */
313

314
315
316
			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
317
			                                                    *   such as the speaker and microphone of a phone handset.
318
			                                                    */
319
			uint8_t                 SourceID; /**< ID value of the unit this terminal's audio is sourced from. */
320

321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
			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. */
336
337
			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
338
			                           */
339

340
341
342
			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.
			                              */
343
344
345
346
347
348
			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. */
349

350
351
			uint8_t  iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
		} USB_Audio_StdDescriptor_OutputTerminal_t;
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369

		/** \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. */
370

371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
			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. */
397

398
399
400
			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;
401

402
403
404
405
406
407
408
409
410
411
412
413
414
415
		/** \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.
			                                  */
416

417
418
			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. */
419

420
421
			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. */
422

423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
			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.
			                             */
445

446
447
			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. */
448

449
450
			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. */
451

452
453
			uint8_t iFeature; /**< Index of a string descriptor describing this descriptor within the device. */
		} USB_Audio_StdDescriptor_FeatureUnit_t;
454

455
		/** \brief Audio class-specific Streaming Audio Interface Descriptor (LUFA naming conventions).
456
		 *
457
		 *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
458
		 *  how audio streams within the device are formatted. See the USB Audio specification for more details.
459
460
		 *
		 *  \see \ref USB_Audio_StdDescriptor_Interface_AS_t for the version of this type with standard element names.
461
462
463
		 */
		typedef struct
		{
464
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
465
466
467
			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.
			                                  */
468

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

471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
			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
487
488
			                           *   given by the specific class.
			                           */
489

490
491
492
			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.
			                              */
493

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

496
497
498
			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;
499

500
501
502
		/** \brief 24-Bit Audio Frequency Structure.
		 *
		 *  Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
503
		 *  this this structure is used to build up the value instead. Fill this structure with the \ref AUDIO_SAMPLE_FREQ() macro.
504
505
506
		 */
		typedef struct
		{
507
508
			uint16_t LowWord; /**< Low 16 bits of the 24-bit value. */
			uint8_t  HighByte; /**< Upper 8 bits of the 24-bit value. */
509
510
		} USB_Audio_SampleFreq_t;

511
		/** \brief Audio class-specific Format Descriptor (LUFA naming conventions).
512
		 *
513
		 *  Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
514
515
		 *  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.
516
517
		 *
		 *  \see \ref USB_Audio_StdDescriptor_Format_t for the version of this type with standard element names.
518
519
520
		 */
		typedef struct
		{
521
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
522
523
524
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   must be \ref AUDIO_DSUBTYPE_CSInterface_FormatType.
			                                  */
525

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

529
530
531
			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. */

532
			uint8_t                 SampleFrequencyType; /**< Total number of sample frequencies supported by the device. */
533
534
535
536
537
538
539
540
541
542
543
544
545
546
			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
		{
547
548
549
550
			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.
			                          */
551

552
553
554
			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.
			                            */
555

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

559
560
			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. */
561

562
			uint8_t bSampleFrequencyType; /**< Total number of sample frequencies supported by the device. */
563
			uint8_t SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES * 3]; /**< Sample frequencies supported by the device (must be 24-bit). */
564
		} USB_Audio_StdDescriptor_Format_t;
565

566
		/** \brief Audio class-specific Streaming Endpoint Descriptor (LUFA naming conventions).
567
		 *
568
		 *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
569
		 *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
570
571
		 *
		 *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Std_t for the version of this type with standard element names.
572
573
574
		 */
		typedef struct
		{
575
			USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint. */
576

577
578
			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). */
579
580
581
582
		} USB_Audio_Descriptor_StreamEndpoint_Std_t;

		/** \brief Audio class-specific Streaming Endpoint Descriptor (USB-IF naming conventions).
		 *
583
		 *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
584
585
586
587
588
589
590
591
592
		 *  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
593
594
			                           *   value given by the specific class.
			                           */
595
			uint8_t  bEndpointAddress; /**< Logical address of the endpoint within the device for the current
Dean Camera's avatar
Dean Camera committed
596
597
			                            *   configuration, including direction mask.
			                            */
598
			uint8_t  bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (EP_TYPE_*)
Dean Camera's avatar
Dean Camera committed
599
600
			                        *   and attributes (ENDPOINT_ATTR_*) masks.
			                        */
601
			uint16_t wMaxPacketSize; /**< Size of the endpoint bank, in bytes. This indicates the maximum packet size
Dean Camera's avatar
Dean Camera committed
602
603
			                          *   that the endpoint can receive at a time.
			                          */
604
			uint8_t  bInterval; /**< Polling interval in milliseconds for the endpoint if it is an INTERRUPT or
Dean Camera's avatar
Dean Camera committed
605
606
			                     *   ISOCHRONOUS type.
			                     */
607

608
609
610
			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
611

612
		/** \brief Audio class-specific Extended Endpoint Descriptor (LUFA naming conventions).
613
		 *
614
		 *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
615
		 *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
616
		 *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
617
618
		 *
		 *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Spc_t for the version of this type with standard element names.
619
620
621
		 */
		typedef struct
		{
622
623
624
625
			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.
			                                  */
626

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

629
630
			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. */
631
		} USB_Audio_Descriptor_StreamEndpoint_Spc_t;
632

633
634
635
636
637
638
639
640
641
642
643
644
645
		/** \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
646
647
			                           *   given by the specific class.
			                           */
648

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

653
654
655
656
657
			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;
658

659
660
661
662
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
663

664
665
666
#endif

/** @} */
667