projects / pub / lufa.git / blob
? search:


c838411f06fc2a6cfc85c40bb319bef321a32368
[pub/lufa.git] / LUFA / Drivers / USB / Class / Common / Audio.h
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2011.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.lufa-lib.org
7 */
8
9 /*
10 Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
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 permission notice and warranty disclaimer appear in supporting
17 documentation, and that the name of the author not be used in
18 advertising or publicity pertaining to distribution of the
19 software without specific, written prior permission.
20
21 The author disclaim all warranties with regard to this
22 software, including all implied warranties of merchantability
23 and fitness. In no event shall the author be liable for any
24 special, indirect or consequential damages or any damages
25 whatsoever resulting from loss of use, data or profits, whether
26 in an action of contract, negligence or other tortious action,
27 arising out of or in connection with the use or performance of
28 this software.
29 */
30
31 /** \file
32 * \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 * \note This file should not be included directly. It is automatically included as needed by the USB module driver
37 * dispatch header located in LUFA/Drivers/USB.h.
38 */
39
40 /** \ingroup Group_USBClassAudio
41 * \defgroup Group_USBClassAudioCommon Common Class Definitions
42 *
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 #ifndef _AUDIO_CLASS_COMMON_H_
51 #define _AUDIO_CLASS_COMMON_H_
52
53 /* Includes: */
54 #include "../../Core/StdDescriptors.h"
55
56 /* Enable C linkage for C++ Compilers: */
57 #if defined(__cplusplus)
58 extern "C" {
59 #endif
60
61 /* Preprocessor Checks: */
62 #if !defined(__INCLUDE_FROM_AUDIO_DRIVER)
63 #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
64 #endif
65
66 /* Macros: */
67 #if !defined(AUDIO_TOTAL_SAMPLE_RATES) || defined(__DOXYGEN__)
68 /** Total number of discrete audio sample rates supported by the device. This value can be overridden by defining this
69 * token in the project makefile to the desired value, and passing it to the compiler via the -D switch.
70 */
71 #define AUDIO_TOTAL_SAMPLE_RATES 1
72 #endif
73
74 /** \name Audio Channel Masks */
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
113 /** \name Audio Feature Masks */
114 //@{
115 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
116 #define AUDIO_FEATURE_MUTE (1 << 0)
117
118 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
119 #define AUDIO_FEATURE_VOLUME (1 << 1)
120
121 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
122 #define AUDIO_FEATURE_BASS (1 << 2)
123
124 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
125 #define AUDIO_FEATURE_MID (1 << 3)
126
127 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
128 #define AUDIO_FEATURE_TREBLE (1 << 4)
129
130 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
131 #define AUDIO_FEATURE_GRAPHIC_EQUALIZER (1 << 5)
132
133 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
134 #define AUDIO_FEATURE_AUTOMATIC_GAIN (1 << 6)
135
136 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
137 #define AUDIO_FEATURE_DELAY (1 << 7)
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_BOOST (1 << 8)
141
142 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
143 #define AUDIO_FEATURE_BASS_LOUDNESS (1 << 9)
144 //@}
145
146 /** \name Audio Terminal Types */
147 //@{
148 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
149 #define AUDIO_TERMINAL_UNDEFINED 0x0100
150
151 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
152 #define AUDIO_TERMINAL_STREAMING 0x0101
153
154 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
155 #define AUDIO_TERMINAL_VENDOR 0x01FF
156
157 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
158 #define AUDIO_TERMINAL_IN_UNDEFINED 0x0200
159
160 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
161 #define AUDIO_TERMINAL_IN_MIC 0x0201
162
163 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
164 #define AUDIO_TERMINAL_IN_DESKTOP_MIC 0x0202
165
166 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
167 #define AUDIO_TERMINAL_IN_PERSONAL_MIC 0x0203
168
169 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
170 #define AUDIO_TERMINAL_IN_OMNIDIR_MIC 0x0204
171
172 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
173 #define AUDIO_TERMINAL_IN_MIC_ARRAY 0x0205
174
175 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
176 #define AUDIO_TERMINAL_IN_PROCESSING_MIC 0x0206
177
178 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
179 #define AUDIO_TERMINAL_IN_OUT_UNDEFINED 0x0300
180
181 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
182 #define AUDIO_TERMINAL_OUT_SPEAKER 0x0301
183
184 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
185 #define AUDIO_TERMINAL_OUT_HEADPHONES 0x0302
186
187 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
188 #define AUDIO_TERMINAL_OUT_HEAD_MOUNTED 0x0303
189
190 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
191 #define AUDIO_TERMINAL_OUT_DESKTOP 0x0304
192
193 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
194 #define AUDIO_TERMINAL_OUT_ROOM 0x0305
195
196 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
197 #define AUDIO_TERMINAL_OUT_COMMUNICATION 0x0306
198
199 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
200 #define AUDIO_TERMINAL_OUT_LOWFREQ 0x0307
201 //@}
202
203 /** Convenience macro to fill a 24-bit \ref USB_Audio_SampleFreq_t structure with the given sample rate as a 24-bit number.
204 *
205 * \param[in] freq Required audio sampling frequency in HZ
206 */
207 #define AUDIO_SAMPLE_FREQ(freq) {.Byte1 = (freq & 0x0000FF), .Byte2 = ((freq >> 8) & 0xFF), .Byte3 = ((freq >> 16) & 0xFF)}
208
209 /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
210 * accepts only filled endpoint packets of audio samples.
211 */
212 #define AUDIO_EP_FULL_PACKETS_ONLY (1 << 7)
213
214 /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
215 * will accept partially filled endpoint packets of audio samples.
216 */
217 #define AUDIO_EP_ACCEPTS_SMALL_PACKETS (0 << 7)
218
219 /* Enums: */
220 /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the Audio
221 * device class.
222 */
223 enum Audio_Descriptor_ClassSubclassProtocol_t
224 {
225 AUDIO_CSCP_AudioClass = 0x01, /**< Descriptor Class value indicating that the device or
226 * interface belongs to the USB Audio 1.0 class.
227 */
228 AUDIO_CSCP_ControlSubclass = 0x01, /**< Descriptor Subclass value indicating that the device or
229 * interface belongs to the Audio Control subclass.
230 */
231 AUDIO_CSCP_ControlProtocol = 0x00, /**< Descriptor Protocol value indicating that the device or
232 * interface belongs to the Audio Control protocol.
233 */
234 AUDIO_CSCP_AudioStreamingSubclass = 0x02, /**< Descriptor Subclass value indicating that the device or
235 * interface belongs to the MIDI Streaming subclass.
236 */
237 AUDIO_CSCP_MIDIStreamingSubclass = 0x03, /**< Descriptor Subclass value indicating that the device or
238 * interface belongs to the Audio streaming subclass.
239 */
240 AUDIO_CSCP_StreamingProtocol = 0x00, /**< Descriptor Protocol value indicating that the device or
241 * interface belongs to the Streaming Audio protocol.
242 */
243 };
244
245 /** Audio class specific interface description subtypes, for the Audio Control interface. */
246 enum Audio_CSInterface_AC_SubTypes_t
247 {
248 AUDIO_DSUBTYPE_CSInterface_Header = 0x01, /**< Audio class specific control interface header. */
249 AUDIO_DSUBTYPE_CSInterface_InputTerminal = 0x02, /**< Audio class specific control interface Input Terminal. */
250 AUDIO_DSUBTYPE_CSInterface_OutputTerminal = 0x03, /**< Audio class specific control interface Output Terminal. */
251 AUDIO_DSUBTYPE_CSInterface_Mixer = 0x04, /**< Audio class specific control interface Mixer Unit. */
252 AUDIO_DSUBTYPE_CSInterface_Selector = 0x05, /**< Audio class specific control interface Selector Unit. */
253 AUDIO_DSUBTYPE_CSInterface_Feature = 0x06, /**< Audio class specific control interface Feature Unit. */
254 AUDIO_DSUBTYPE_CSInterface_Processing = 0x07, /**< Audio class specific control interface Processing Unit. */
255 AUDIO_DSUBTYPE_CSInterface_Extension = 0x08, /**< Audio class specific control interface Extension Unit. */
256 };
257
258 /** Audio class specific interface description subtypes, for the Audio Streaming interface. */
259 enum Audio_CSInterface_AS_SubTypes_t
260 {
261 AUDIO_DSUBTYPE_CSInterface_General = 0x01, /**< Audio class specific streaming interface general descriptor. */
262 AUDIO_DSUBTYPE_CSInterface_FormatType = 0x02, /**< Audio class specific streaming interface format type descriptor. */
263 AUDIO_DSUBTYPE_CSInterface_FormatSpecific = 0x03, /**< Audio class specific streaming interface format information descriptor. */
264 };
265
266 /** Audio class specific endpoint description subtypes, for the Audio Streaming interface. */
267 enum Audio_CSEndpoint_SubTypes_t
268 {
269 AUDIO_DSUBTYPE_CSEndpoint_General = 0x01, /**< Audio class specific endpoint general descriptor. */
270 };
271
272 /* Type Defines: */
273 /** \brief Audio class-specific Input Terminal Descriptor (LUFA naming conventions).
274 *
275 * Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
276 * contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
277 * a USB endpoint). See the USB Audio specification for more details.
278 *
279 * \see \ref USB_Audio_StdDescriptor_InputTerminal_t for the version of this type with standard element names.
280 */
281 typedef struct
282 {
283 USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
284 uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
285 * must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal.
286 */
287
288 uint8_t TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
289 uint16_t TerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
290 uint8_t AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals
291 * such as the speaker and microphone of a phone handset.
292 */
293 uint8_t TotalChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
294 uint16_t ChannelConfig; /**< \c CHANNEL_* masks indicating what channel layout is supported by this terminal. */
295
296 uint8_t ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device. */
297 uint8_t TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
298 } ATTR_PACKED USB_Audio_Descriptor_InputTerminal_t;
299
300 /** \brief Audio class-specific Input Terminal Descriptor (USB-IF naming conventions).
301 *
302 * Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
303 * contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
304 * a USB endpoint). See the USB Audio specification for more details.
305 *
306 * \see \ref USB_Audio_Descriptor_InputTerminal_t for the version of this type with non-standard LUFA specific
307 * element names.
308 */
309 typedef struct
310 {
311 uint8_t bLength; /**< Size of the descriptor, in bytes. */
312 uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
313 * given by the specific class.
314 */
315
316 uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
317 * must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal.
318 */
319 uint8_t bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
320 uint16_t wTerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
321 uint8_t bAssocTerminal; /**< ID of associated output terminal, for physically grouped terminals
322 * such as the speaker and microphone of a phone handset.
323 */
324 uint8_t bNrChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
325 uint16_t wChannelConfig; /**< \c CHANNEL_* masks indicating what channel layout is supported by this terminal. */
326
327 uint8_t iChannelNames; /**< Index of a string descriptor describing this channel within the device. */
328 uint8_t iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
329 } ATTR_PACKED USB_Audio_StdDescriptor_InputTerminal_t;
330
331 /** \brief Audio class-specific Output Terminal Descriptor (LUFA naming conventions).
332 *
333 * Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
334 * contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
335 * a USB endpoint). See the USB Audio specification for more details.
336 *
337 * \see \ref USB_Audio_StdDescriptor_OutputTerminal_t for the version of this type with standard element names.
338 */
339 typedef struct
340 {
341 USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
342 uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
343 * must be \ref AUDIO_DSUBTYPE_CSInterface_OutputTerminal.
344 */
345
346 uint8_t TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
347 uint16_t TerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
348 uint8_t AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals
349 * such as the speaker and microphone of a phone handset.
350 */
351 uint8_t SourceID; /**< ID value of the unit this terminal's audio is sourced from. */
352
353 uint8_t TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
354 } ATTR_PACKED USB_Audio_Descriptor_OutputTerminal_t;
355
356 /** \brief Audio class-specific Output Terminal Descriptor (USB-IF naming conventions).
357 *
358 * Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
359 * contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
360 * a USB endpoint). See the USB Audio specification for more details.
361 *
362 * \see \ref USB_Audio_Descriptor_OutputTerminal_t for the version of this type with non-standard LUFA specific
363 * element names.
364 */
365 typedef struct
366 {
367 uint8_t bLength; /**< Size of the descriptor, in bytes. */
368 uint8_t bDescriptorType; /**< Sub type value used to distinguish between audio class-specific descriptors,
369 * must be \ref AUDIO_DSUBTYPE_CSInterface_OutputTerminal.
370 */
371
372 uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
373 * a value from the \ref Audio_CSInterface_AC_SubTypes_t enum.
374 */
375 uint8_t bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
376 uint16_t wTerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
377 uint8_t bAssocTerminal; /**< ID of associated input terminal, for physically grouped terminals
378 * such as the speaker and microphone of a phone handset.
379 */
380 uint8_t bSourceID; /**< ID value of the unit this terminal's audio is sourced from. */
381
382 uint8_t iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
383 } ATTR_PACKED USB_Audio_StdDescriptor_OutputTerminal_t;
384
385 /** \brief Audio class-specific Interface Descriptor (LUFA naming conventions).
386 *
387 * Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
388 * supply extra information about the audio device's layout to the host. See the USB Audio specification for more
389 * details.
390 *
391 * \see \ref USB_Audio_StdDescriptor_Interface_AC_t for the version of this type with standard element names.
392 */
393 typedef struct
394 {
395 USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
396 uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
397 * a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
398 */
399
400 uint16_t ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version. */
401 uint16_t TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
402
403 uint8_t InCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */
404 uint8_t InterfaceNumber; /**< Interface number of the associated Audio Streaming interface. */
405 } ATTR_PACKED USB_Audio_Descriptor_Interface_AC_t;
406
407 /** \brief Audio class-specific Interface Descriptor (USB-IF naming conventions).
408 *
409 * Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
410 * supply extra information about the audio device's layout to the host. See the USB Audio specification for more
411 * details.
412 *
413 * \see \ref USB_Audio_Descriptor_Interface_AC_t for the version of this type with non-standard LUFA specific
414 * element names.
415 */
416 typedef struct
417 {
418 uint8_t bLength; /**< Size of the descriptor, in bytes. */
419 uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
420 * given by the specific class.
421 */
422
423 uint8_t bDescriptorSubtype;/**< Sub type value used to distinguish between audio class-specific descriptors,
424 * a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
425 */
426
427 uint16_t bcdADC; /**< Binary coded decimal value, indicating the supported Audio Class specification version. */
428 uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
429
430 uint8_t bInCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */
431 uint8_t bInterfaceNumbers; /**< Interface number of the associated Audio Streaming interface. */
432 } ATTR_PACKED USB_Audio_StdDescriptor_Interface_AC_t;
433
434 /** \brief Audio class-specific Feature Unit Descriptor (LUFA naming conventions).
435 *
436 * Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
437 * are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
438 * specification for more details.
439 *
440 * \see \ref USB_Audio_StdDescriptor_FeatureUnit_t for the version of this type with standard element names.
441 */
442 typedef struct
443 {
444 USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
445 uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
446 * must be \ref AUDIO_DSUBTYPE_CSInterface_Feature.
447 */
448
449 uint8_t UnitID; /**< ID value of this feature unit - must be a unique value within the device. */
450 uint8_t SourceID; /**< Source ID value of the audio source input into this feature unit. */
451
452 uint8_t ControlSize; /**< Size of each element in the \c ChanelControlls array. */
453 uint8_t ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
454
455 uint8_t FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
456 } ATTR_PACKED USB_Audio_Descriptor_FeatureUnit_t;
457
458 /** \brief Audio class-specific Feature Unit Descriptor (USB-IF naming conventions).
459 *
460 * Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
461 * are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
462 * specification for more details.
463 *
464 * \see \ref USB_Audio_Descriptor_FeatureUnit_t for the version of this type with non-standard LUFA specific
465 * element names.
466 */
467 typedef struct
468 {
469 uint8_t bLength; /**< Size of the descriptor, in bytes. */
470 uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
471 * given by the specific class.
472 */
473
474 uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
475 * must be \ref AUDIO_DSUBTYPE_CSInterface_Feature.
476 */
477
478 uint8_t bUnitID; /**< ID value of this feature unit - must be a unique value within the device. */
479 uint8_t bSourceID; /**< Source ID value of the audio source input into this feature unit. */
480
481 uint8_t bControlSize; /**< Size of each element in the \c ChanelControlls array. */
482 uint8_t bmaControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
483
484 uint8_t iFeature; /**< Index of a string descriptor describing this descriptor within the device. */
485 } ATTR_PACKED USB_Audio_StdDescriptor_FeatureUnit_t;
486
487 /** \brief Audio class-specific Streaming Audio Interface Descriptor (LUFA naming conventions).
488 *
489 * Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
490 * how audio streams within the device are formatted. See the USB Audio specification for more details.
491 *
492 * \see \ref USB_Audio_StdDescriptor_Interface_AS_t for the version of this type with standard element names.
493 */
494 typedef struct
495 {
496 USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
497 uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
498 * a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
499 */
500
501 uint8_t TerminalLink; /**< ID value of the output terminal this descriptor is describing. */
502
503 uint8_t FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */
504 uint16_t AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification. */
505 } ATTR_PACKED USB_Audio_Descriptor_Interface_AS_t;
506
507 /** \brief Audio class-specific Streaming Audio Interface Descriptor (USB-IF naming conventions).
508 *
509 * Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
510 * how audio streams within the device are formatted. See the USB Audio specification for more details.
511 *
512 * \see \ref USB_Audio_Descriptor_Interface_AS_t for the version of this type with non-standard LUFA specific
513 * element names.
514 */
515 typedef struct
516 {
517 uint8_t bLength; /**< Size of the descriptor, in bytes. */
518 uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
519 * given by the specific class.
520 */
521
522 uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
523 * a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
524 */
525
526 uint8_t bTerminalLink; /**< ID value of the output terminal this descriptor is describing. */
527
528 uint8_t bDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */
529 uint16_t wFormatTag; /**< Format of the audio stream, see Audio Device Formats specification. */
530 } ATTR_PACKED USB_Audio_StdDescriptor_Interface_AS_t;
531
532 /** \brief 24-Bit Audio Frequency Structure.
533 *
534 * Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
535 * this this structure is used to build up the value instead. Fill this structure with the \ref AUDIO_SAMPLE_FREQ() macro.
536 */
537 typedef struct
538 {
539 uint8_t Byte1; /**< Lowest 8 bits of the 24-bit value. */
540 uint8_t Byte2; /**< Middle 8 bits of the 24-bit value. */
541 uint8_t Byte3; /**< Upper 8 bits of the 24-bit value. */
542 } ATTR_PACKED USB_Audio_SampleFreq_t;
543
544 /** \brief Audio class-specific Format Descriptor (LUFA naming conventions).
545 *
546 * Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
547 * about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
548 * in the device's audio streams. See the USB Audio specification for more details.
549 *
550 * \see \ref USB_Audio_StdDescriptor_Format_t for the version of this type with standard element names.
551 */
552 typedef struct
553 {
554 USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
555 uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
556 * must be \ref AUDIO_DSUBTYPE_CSInterface_FormatType.
557 */
558
559 uint8_t FormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
560 uint8_t Channels; /**< Total number of discrete channels in the stream. */
561
562 uint8_t SubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
563 uint8_t BitResolution; /**< Bits of resolution of each channel's samples in the stream. */
564
565 uint8_t SampleFrequencyType; /**< Total number of sample frequencies supported by the device. */
566 USB_Audio_SampleFreq_t SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES]; /**< Sample frequencies supported by the device (must be 24-bit). */
567 } ATTR_PACKED USB_Audio_Descriptor_Format_t;
568
569 /** \brief Audio class-specific Format Descriptor (USB-IF naming conventions).
570 *
571 * Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
572 * about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
573 * in the device's audio streams. See the USB Audio specification for more details.
574 *
575 * \see \ref USB_Audio_Descriptor_Format_t for the version of this type with non-standard LUFA specific
576 * element names.
577 */
578 typedef struct
579 {
580 uint8_t bLength; /**< Size of the descriptor, in bytes. */
581 uint8_t bDescriptorType; /**< Sub type value used to distinguish between audio class-specific descriptors,
582 * must be \ref AUDIO_DSUBTYPE_CSInterface_FormatType.
583 */
584
585 uint8_t bDescriptorSubtype;/**< Sub type value used to distinguish between audio class-specific descriptors,
586 * a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
587 */
588
589 uint8_t bFormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
590 uint8_t bNrChannels; /**< Total number of discrete channels in the stream. */
591
592 uint8_t bSubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
593 uint8_t bBitResolution; /**< Bits of resolution of each channel's samples in the stream. */
594
595 uint8_t bSampleFrequencyType; /**< Total number of sample frequencies supported by the device. */
596 uint8_t SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES * 3]; /**< Sample frequencies supported by the device (must be 24-bit). */
597 } ATTR_PACKED USB_Audio_StdDescriptor_Format_t;
598
599 /** \brief Audio class-specific Streaming Endpoint Descriptor (LUFA naming conventions).
600 *
601 * Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
602 * descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
603 *
604 * \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Std_t for the version of this type with standard element names.
605 */
606 typedef struct
607 {
608 USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint. */
609
610 uint8_t Refresh; /**< Always set to zero for Audio class devices. */
611 uint8_t SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
612 } ATTR_PACKED USB_Audio_Descriptor_StreamEndpoint_Std_t;
613
614 /** \brief Audio class-specific Streaming Endpoint Descriptor (USB-IF naming conventions).
615 *
616 * Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
617 * descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
618 *
619 * \see \ref USB_Audio_Descriptor_StreamEndpoint_Std_t for the version of this type with non-standard LUFA specific
620 * element names.
621 */
622 typedef struct
623 {
624 uint8_t bLength; /**< Size of the descriptor, in bytes. */
625 uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a
626 * value given by the specific class.
627 */
628 uint8_t bEndpointAddress; /**< Logical address of the endpoint within the device for the current
629 * configuration, including direction mask.
630 */
631 uint8_t bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (\c EP_TYPE_*)
632 * and attributes (\c ENDPOINT_ATTR_*) masks.
633 */
634 uint16_t wMaxPacketSize; /**< Size of the endpoint bank, in bytes. This indicates the maximum packet size
635 * that the endpoint can receive at a time.
636 */
637 uint8_t bInterval; /**< Polling interval in milliseconds for the endpoint if it is an INTERRUPT or
638 * ISOCHRONOUS type.
639 */
640
641 uint8_t bRefresh; /**< Always set to zero for Audio class devices. */
642 uint8_t bSynchAddress; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
643 } ATTR_PACKED USB_Audio_StdDescriptor_StreamEndpoint_Std_t;
644
645 /** \brief Audio class-specific Extended Endpoint Descriptor (LUFA naming conventions).
646 *
647 * Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
648 * on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
649 * class-specific extended endpoint descriptor. See the USB Audio specification for more details.
650 *
651 * \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Spc_t for the version of this type with standard element names.
652 */
653 typedef struct
654 {
655 USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
656 uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
657 * a value from the \ref Audio_CSEndpoint_SubTypes_t enum.
658 */
659
660 uint8_t Attributes; /**< Audio class-specific endpoint attributes, such as \ref AUDIO_EP_FULL_PACKETS_ONLY. */
661
662 uint8_t LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */
663 uint16_t LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */
664 } ATTR_PACKED USB_Audio_Descriptor_StreamEndpoint_Spc_t;
665
666 /** \brief Audio class-specific Extended Endpoint Descriptor (USB-IF naming conventions).
667 *
668 * Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
669 * on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
670 * class-specific extended endpoint descriptor. See the USB Audio specification for more details.
671 *
672 * \see \ref USB_Audio_Descriptor_StreamEndpoint_Spc_t for the version of this type with non-standard LUFA specific
673 * element names.
674 */
675 typedef struct
676 {
677 uint8_t bLength; /**< Size of the descriptor, in bytes. */
678 uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
679 * given by the specific class.
680 */
681
682 uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
683 * a value from the \ref Audio_CSEndpoint_SubTypes_t enum.
684 */
685
686 uint8_t bmAttributes; /**< Audio class-specific endpoint attributes, such as \ref AUDIO_EP_FULL_PACKETS_ONLY. */
687
688 uint8_t bLockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */
689 uint16_t wLockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */
690 } ATTR_PACKED USB_Audio_StdDescriptor_StreamEndpoint_Spc_t;
691
692 /* Disable C linkage for C++ Compilers: */
693 #if defined(__cplusplus)
694 }
695 #endif
696
697 #endif
698
699 /** @} */
700
Lightweight USB Framework for AVRs