Common Class Definitions
[Audio Device Class Driver - LUFA/Drivers/Class/Audio.h]

Data Structures

struct  USB_Audio_Interface_AC_t
struct  USB_Audio_FeatureUnit_t
struct  USB_Audio_InputTerminal_t
struct  USB_Audio_OutputTerminal_t
struct  USB_Audio_Interface_AS_t
struct  USB_Audio_SampleFreq_t
struct  USB_Audio_Format_t
struct  USB_Audio_StreamEndpoint_Std_t
struct  USB_Audio_StreamEndpoint_Spc_t

Defines

#define AUDIO_TOTAL_SAMPLE_RATES   1
#define DTYPE_AudioInterface   0x24
#define DTYPE_AudioEndpoint   0x25
#define DSUBTYPE_Header   0x01
#define DSUBTYPE_InputTerminal   0x02
#define DSUBTYPE_OutputTerminal   0x03
#define DSUBTYPE_FeatureUnit   0x06
#define DSUBTYPE_General   0x01
#define DSUBTYPE_Format   0x02
#define CHANNEL_LEFT_FRONT   (1 << 0)
#define CHANNEL_RIGHT_FRONT   (1 << 1)
#define CHANNEL_CENTER_FRONT   (1 << 2)
#define CHANNEL_LOW_FREQ_ENHANCE   (1 << 3)
#define CHANNEL_LEFT_SURROUND   (1 << 4)
#define CHANNEL_RIGHT_SURROUND   (1 << 5)
#define CHANNEL_LEFT_OF_CENTER   (1 << 6)
#define CHANNEL_RIGHT_OF_CENTER   (1 << 7)
#define CHANNEL_SURROUND   (1 << 8)
#define CHANNEL_SIDE_LEFT   (1 << 9)
#define CHANNEL_SIDE_RIGHT   (1 << 10)
#define CHANNEL_TOP   (1 << 11)
#define FEATURE_MUTE   (1 << 0)
#define FEATURE_VOLUME   (1 << 1)
#define FEATURE_BASS   (1 << 2)
#define FEATURE_MID   (1 << 3)
#define FEATURE_TREBLE   (1 << 4)
#define FEATURE_GRAPHIC_EQUALIZER   (1 << 5)
#define FEATURE_AUTOMATIC_GAIN   (1 << 6)
#define FEATURE_DELAY   (1 << 7)
#define FEATURE_BASS_BOOST   (1 << 8)
#define FEATURE_BASS_LOUDNESS   (1 << 9)
#define TERMINAL_UNDEFINED   0x0100
#define TERMINAL_STREAMING   0x0101
#define TERMINAL_VENDOR   0x01FF
#define TERMINAL_IN_UNDEFINED   0x0200
#define TERMINAL_IN_MIC   0x0201
#define TERMINAL_IN_DESKTOP_MIC   0x0202
#define TERMINAL_IN_PERSONAL_MIC   0x0203
#define TERMINAL_IN_OMNIDIR_MIC   0x0204
#define TERMINAL_IN_MIC_ARRAY   0x0205
#define TERMINAL_IN_PROCESSING_MIC   0x0206
#define TERMINAL_IN_OUT_UNDEFINED   0x0300
#define TERMINAL_OUT_SPEAKER   0x0301
#define TERMINAL_OUT_HEADPHONES   0x0302
#define TERMINAL_OUT_HEAD_MOUNTED   0x0303
#define TERMINAL_OUT_DESKTOP   0x0304
#define TERMINAL_OUT_ROOM   0x0305
#define TERMINAL_OUT_COMMUNICATION   0x0306
#define TERMINAL_OUT_LOWFREQ   0x0307
#define AUDIO_SAMPLE_FREQ(freq)   {LowWord: ((uint32_t)freq & 0x00FFFF), HighByte: (((uint32_t)freq >> 16) & 0x0000FF)}
#define EP_ACCEPTS_ONLY_FULL_PACKETS   (1 << 7)
#define EP_ACCEPTS_SMALL_PACKETS   (0 << 7)

Detailed Description

Description

Constants, Types and Enum definitions that are common to both Device and Host modes for the USB Audio Class.


Define Documentation

#define AUDIO_SAMPLE_FREQ ( freq   )     {LowWord: ((uint32_t)freq & 0x00FFFF), HighByte: (((uint32_t)freq >> 16) & 0x0000FF)}

Convenience macro, to fill a 24-bit AudioSampleFreq_t structure with the given sample rate as a 24-bit number.

Parameters:
[in] freq Required audio sampling frequency in HZ
#define AUDIO_TOTAL_SAMPLE_RATES   1

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 CHANNEL_CENTER_FRONT   (1 << 2)

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_LEFT_OF_CENTER   (1 << 6)

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_LOW_FREQ_ENHANCE   (1 << 3)

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_RIGHT_OF_CENTER   (1 << 7)

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_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_SURROUND   (1 << 8)

Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details.

#define CHANNEL_TOP   (1 << 11)

Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details.

#define DSUBTYPE_FeatureUnit   0x06

Audio class descriptor subtype value for a Feature Unit Audio class specific descriptor.

#define DSUBTYPE_Format   0x02

Audio class descriptor subtype value for an Audio class specific descriptor indicating the format of an audio stream.

#define DSUBTYPE_General   0x01

Audio class descriptor subtype value for a general Audio class specific descriptor.

#define DSUBTYPE_Header   0x01

Audio class descriptor subtype value for a Audio class specific header descriptor.

#define DSUBTYPE_InputTerminal   0x02

Audio class descriptor subtype value for an Output Terminal Audio class specific descriptor.

#define DSUBTYPE_OutputTerminal   0x03

Audio class descriptor subtype value for an Input Terminal Audio class specific descriptor.

#define DTYPE_AudioEndpoint   0x25

Descriptor header constant to indicate a Audio class endpoint descriptor.

#define DTYPE_AudioInterface   0x24

Descriptor header constant to indicate a Audio class interface descriptor.

#define EP_ACCEPTS_ONLY_FULL_PACKETS   (1 << 7)

Mask for the attributes parameter of an Audio class specific Endpoint descriptor, indicating that the endpoint accepts only filled endpoint packets of audio samples.

#define EP_ACCEPTS_SMALL_PACKETS   (0 << 7)

Mask for the attributes parameter of an Audio class specific Endpoint descriptor, indicating that the endpoint will accept partially filled endpoint packets of audio samples.

#define FEATURE_AUTOMATIC_GAIN   (1 << 6)

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_BASS   (1 << 2)

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)

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_GRAPHIC_EQUALIZER   (1 << 5)

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_MUTE   (1 << 0)

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_VOLUME   (1 << 1)

Supported feature mask for an Audio class feature unit 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_MIC   0x0201

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_OMNIDIR_MIC   0x0204

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_IN_PERSONAL_MIC   0x0203

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_UNDEFINED   0x0200

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_DESKTOP   0x0304

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_HEADPHONES   0x0302

Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details.

#define TERMINAL_OUT_LOWFREQ   0x0307

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_SPEAKER   0x0301

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_UNDEFINED   0x0100

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.


Generated on Thu Sep 24 22:58:13 2009 for LUFA (Formerly MyUSB) Library by  doxygen 1.6.1