Fixed incorrect comparison in the descriptor callback routine of the TeensyHID bootlo...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / Audio.h
index f92b9ab..fd821e9 100644 (file)
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r
-#ifndef _AUDIO_CLASS_H_\r
-#define _AUDIO_CLASS_H_\r
+/** \file\r
+ *  \brief Device mode driver for the library USB Audio Class driver.\r
+ *\r
+ *  Device mode driver for the library USB Audio Class driver.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ *        dispatch header located in LUFA/Drivers/USB/Class/Audio.h.\r
+ */\r
+\r
+/** \ingroup Group_USBClassAudio\r
+ *  @defgroup Group_USBClassAudioDevice Audio Class Device Mode Driver\r
+ *\r
+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - LUFA/Drivers/USB/Class/Device/Audio.c\r
+ *\r
+ *  \section Module Description\r
+ *  Device Mode USB Class driver framework interface, for the Audio USB Class driver.\r
+ *\r
+ *  @{\r
+ */\r
+\r
+#ifndef _AUDIO_CLASS_DEVICE_H_\r
+#define _AUDIO_CLASS_DEVICE_H_\r
 \r
        /* Includes: */\r
                #include "../../USB.h"\r
 \r
        /* Includes: */\r
                #include "../../USB.h"\r
-\r
+               #include "../Common/Audio.h"\r
+               \r
                #include <string.h>\r
 \r
        /* Enable C linkage for C++ Compilers: */\r
                #include <string.h>\r
 \r
        /* Enable C linkage for C++ Compilers: */\r
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\r
 \r
-       /* Macros: */\r
-               /** Descriptor header constant to indicate a Audio class interface descriptor. */\r
-               #define DTYPE_AudioInterface         0x24\r
-\r
-               /** Descriptor header constant to indicate a Audio class endpoint descriptor. */\r
-               #define DTYPE_AudioEndpoint          0x25\r
-\r
-               /** Audio class descriptor subtype value for a Audio class specific header descriptor. */\r
-               #define DSUBTYPE_Header              0x01\r
-\r
-               /** Audio class descriptor subtype value for an Output Terminal Audio class specific descriptor. */\r
-               #define DSUBTYPE_InputTerminal       0x02\r
-\r
-               /** Audio class descriptor subtype value for an Input Terminal Audio class specific descriptor. */\r
-               #define DSUBTYPE_OutputTerminal      0x03\r
-\r
-               /** Audio class descriptor subtype value for a Feature Unit Audio class specific descriptor. */\r
-               #define DSUBTYPE_FeatureUnit         0x06\r
-\r
-               /** Audio class descriptor subtype value for a general Audio class specific descriptor. */\r
-               #define DSUBTYPE_General             0x01\r
+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_AUDIO_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Class/Audio.h instead.\r
+               #endif\r
 \r
 \r
-               /** Audio class descriptor subtype value for an Audio class specific descriptor indicating the format of an audio stream. */\r
-               #define DSUBTYPE_Format              0x02\r
-               \r
-               //@{\r
-               /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */\r
-\r
-               #define CHANNEL_LEFT_FRONT           (1 << 0)\r
-               #define CHANNEL_RIGHT_FRONT          (1 << 1)\r
-               #define CHANNEL_CENTER_FRONT         (1 << 2)\r
-               #define CHANNEL_LOW_FREQ_ENHANCE     (1 << 3)\r
-               #define CHANNEL_LEFT_SURROUND        (1 << 4)\r
-               #define CHANNEL_RIGHT_SURROUND       (1 << 5)\r
-               #define CHANNEL_LEFT_OF_CENTER       (1 << 6)\r
-               #define CHANNEL_RIGHT_OF_CENTER      (1 << 7)\r
-               #define CHANNEL_SURROUND             (1 << 8)\r
-               #define CHANNEL_SIDE_LEFT            (1 << 9)\r
-               #define CHANNEL_SIDE_RIGHT           (1 << 10)\r
-               #define CHANNEL_TOP                  (1 << 11)\r
-               //@}\r
-\r
-               //@{\r
-               /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */\r
-\r
-               #define FEATURE_MUTE                 (1 << 0)\r
-               #define FEATURE_VOLUME               (1 << 1)\r
-               #define FEATURE_BASS                 (1 << 2)\r
-               #define FEATURE_MID                  (1 << 3)\r
-               #define FEATURE_TREBLE               (1 << 4)\r
-               #define FEATURE_GRAPHIC_EQUALIZER    (1 << 5)\r
-               #define FEATURE_AUTOMATIC_GAIN       (1 << 6)\r
-               #define FEATURE_DELAY                (1 << 7)\r
-               #define FEATURE_BASS_BOOST           (1 << 8)\r
-               #define FEATURE_BASS_LOUDNESS        (1 << 9)\r
-               //@}\r
-\r
-               //@{\r
-               /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */\r
-               \r
-               #define TERMINAL_UNDEFINED           0x0100\r
-               #define TERMINAL_STREAMING           0x0101\r
-               #define TERMINAL_VENDOR              0x01FF\r
-               #define TERMINAL_IN_UNDEFINED        0x0200\r
-               #define TERMINAL_IN_MIC              0x0201\r
-               #define TERMINAL_IN_DESKTOP_MIC      0x0202\r
-               #define TERMINAL_IN_PERSONAL_MIC     0x0203\r
-               #define TERMINAL_IN_OMNIDIR_MIC      0x0204\r
-               #define TERMINAL_IN_MIC_ARRAY        0x0205\r
-               #define TERMINAL_IN_PROCESSING_MIC   0x0206\r
-               #define TERMINAL_IN_OUT_UNDEFINED    0x0300\r
-               #define TERMINAL_OUT_SPEAKER         0x0301\r
-               #define TERMINAL_OUT_HEADPHONES      0x0302\r
-               #define TERMINAL_OUT_HEAD_MOUNTED    0x0303\r
-               #define TERMINAL_OUT_DESKTOP         0x0304\r
-               #define TERMINAL_OUT_ROOM            0x0305\r
-               #define TERMINAL_OUT_COMMUNICATION   0x0306\r
-               #define TERMINAL_OUT_LOWFREQ         0x0307\r
-               //@}\r
-\r
-               /** Convenience macro, to fill a 24-bit AudioSampleFreq_t structure with the given sample rate as a 24-bit number.\r
-                *\r
-                *  \param freq  Required audio sampling frequency in HZ\r
-                */\r
-               #define AUDIO_SAMPLE_FREQ(freq)  {LowWord: ((uint32_t)freq & 0x00FFFF), HighByte: (((uint32_t)freq >> 16) & 0x0000FF)}\r
+       /* Public Interface - May be used in end-application: */\r
+               /* Type Defines: */\r
+                       /** \brief Audio Class Device Mode Configuration and State Structure.\r
+                        *\r
+                        *  Class state structure. An instance of this structure should be made for each Audio interface\r
+                        *  within the user application, and passed to each of the Audio class driver functions as the\r
+                        *  AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information.\r
+                        */\r
+                       typedef struct\r
+                       {\r
+                               const struct\r
+                               {\r
+                                       uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this\r
+                                                                                                               *   structure controls\r
+                                                                                                               */\r
+\r
+                                       uint8_t  DataINEndpointNumber; /**< Endpoint number of the incoming Audio Streaming data, if available\r
+                                                                                                       *   (zero if unused)\r
+                                                                                                       */\r
+                                       uint16_t DataINEndpointSize; /**< Size in bytes of the incoming Audio Streaming data endpoint, if available\r
+                                                                                                 *   (zero if unused)\r
+                                                                                                 */\r
+\r
+                                       uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the outgoing Audio Streaming data, if available\r
+                                                                                                        *   (zero if unused)\r
+                                                                                                        */\r
+                                       uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing Audio Streaming data endpoint, if available\r
+                                                                                                  *   (zero if unused)\r
+                                                                                                  */                   \r
+                               } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
+                                          *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
+                                          */\r
+                               struct\r
+                               {\r
+                                       bool     InterfaceEnabled; /**< Set and cleared by the class driver to indicate if the host has enabled the streaming endpoints\r
+                                                                                               *   of the Audio Streaming interface.\r
+                                                                                               */\r
+                               } State; /**< State data for the USB class interface within the device. All elements in this section\r
+                                         *   are reset to their defaults when the interface is enumerated.\r
+                                         */                            \r
+                       } USB_ClassInfo_Audio_Device_t;\r
                \r
                \r
-               /** Mask for the attributes parameter of an Audio class specific Endpoint descriptor, indicating that the endpoint\r
-                *  accepts only filled endpoint packets of audio samples.\r
-                */\r
-               #define EP_ACCEPTS_ONLY_FULL_PACKETS (1 << 7)\r
-\r
-               /** Mask for the attributes parameter of an Audio class specific Endpoint descriptor, indicating that the endpoint\r
-                *  will accept partially filled endpoint packets of audio samples.\r
-                */\r
-               #define EP_ACCEPTS_SMALL_PACKETS     (0 << 7)\r
-               \r
-       /* Type Defines: */\r
-               /** Type define for an Audio class specific interface descriptor. This follows a regular interface descriptor to\r
-                *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more\r
-                *  details.\r
-                */\r
-               typedef struct\r
-               {\r
-                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */\r
-                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
-\r
-                       uint16_t                  ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */\r
-                       uint16_t                  TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */\r
-                       \r
-                       uint8_t                   InCollection; /**< Total number of audio class interfaces within this device */\r
-                       uint8_t                   InterfaceNumbers[1]; /**< Interface numbers of each audio interface */\r
-               } USB_AudioInterface_AC_t;\r
-               \r
-               /** Type define for an Audio class specific Feature Unit descriptor. This indicates to the host what features\r
-                *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio\r
-                *  specification for more details.\r
-                */\r
-               typedef struct\r
-               {\r
-                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */\r
-                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
-                       \r
-                       uint8_t                   UnitID; /**< ID value of this feature unit - must be a unique value within the device */\r
-                       uint8_t                   SourceID; /**< Source ID value of the audio source input into this feature unit */\r
-                       \r
-                       uint8_t                   ControlSize; /**< Size of each element in the ChanelControlls array */\r
-                       uint8_t                   ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel */\r
+               /* Function Prototypes: */\r
+                       /** Configures the endpoints of a given Audio interface, ready for use. This should be linked to the library\r
+                        *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
+                        *  given Audio interface is selected.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state\r
+                        *\r
+                        *  \return Boolean true if the endpoints were successfully configured, false otherwise\r
+                        */\r
+                       bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** Processes incoming control requests from the host, that are directed to the given Audio class interface. This should be\r
+                        *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state\r
+                        */\r
+                       void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
                        \r
                        \r
-                       uint8_t                   FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device */\r
-               } USB_AudioFeatureUnit_t;\r
-\r
-               /** Type define for an Audio class specific input terminal descriptor. This indicates to the host that the device\r
-                *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,\r
-                *  a USB endpoint). See the USB Audio specification for more details.\r
-                */\r
-               typedef struct\r
-               {\r
-                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */\r
-                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
-               \r
-                       uint8_t                   TerminalID; /**< ID value of this terminal unit - must be a unique value within the device */\r
-                       uint16_t                  TerminalType; /**< Type of terminal, a TERMINAL_* mask */\r
-                       uint8_t                   AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals\r
-                                                                            *   such as the speaker and microphone of a phone handset\r
-                                                                            */\r
-                       uint8_t                   TotalChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */\r
-                       uint16_t                  ChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal */\r
-                       \r
-                       uint8_t                   ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device */\r
-                       uint8_t                   TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */\r
-               } USB_AudioInputTerminal_t;\r
-\r
-               /** Type define for an Audio class specific output terminal descriptor. This indicates to the host that the device\r
-                *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,\r
-                *  a USB endpoint). See the USB Audio specification for more details.\r
-                */\r
-               typedef struct\r
-               {\r
-                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */\r
-                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
-               \r
-                       uint8_t                   TerminalID; /**< ID value of this terminal unit - must be a unique value within the device */\r
-                       uint16_t                  TerminalType; /**< Type of terminal, a TERMINAL_* mask */\r
-                       uint8_t                   AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals\r
-                                                                           *   such as the speaker and microphone of a phone handset\r
-                                                                           */\r
-                       uint8_t                   SourceID; /**< ID value of the unit this terminal's audio is sourced from */\r
-                       \r
-                       uint8_t                   TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */\r
-               } USB_AudioOutputTerminal_t;\r
-               \r
-               /** Type define for an Audio class specific streaming interface descriptor. This indicates to the host\r
-                *  how audio streams within the device are formatted. See the USB Audio specification for more details.\r
-                */\r
-               typedef struct\r
-               {\r
-                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */\r
-                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
-                       \r
-                       uint8_t                   TerminalLink; /**< ID value of the output terminal this descriptor is describing */\r
-                       \r
-                       uint8_t                   FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output */\r
-                       uint16_t                  AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification */\r
-               } USB_AudioInterface_AS_t;\r
-               \r
-               /** Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,\r
-                *  this this structure is used to build up the value instead. Fill this structure with the SAMPLE_FREQ() macro.\r
-                */\r
-               typedef struct\r
-               {\r
-                       uint16_t                  LowWord; /**< Low 16 bits of the 24-bit value */\r
-                       uint8_t                   HighByte; /**< Upper 8 bits of the 24-bit value */\r
-               } AudioSampleFreq_t;\r
-\r
-               /** Type define for an Audio class specific audio format descriptor. This is used to give the host full details\r
-                *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used\r
-                *  in the device's audio streams. See the USB Audio specification for more details.\r
-                */\r
-               typedef struct\r
-               {\r
-                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */\r
-                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
-\r
-                       uint8_t                   FormatType; /**< Format of the audio stream, see Audio Device Formats specification */\r
-                       uint8_t                   Channels; /**< Total number of discrete channels in the stream */\r
-                       \r
-                       uint8_t                   SubFrameSize; /**< Size in bytes of each channel's sample data in the stream */\r
-                       uint8_t                   BitResolution; /**< Bits of resolution of each channel's samples in the stream */\r
+               /* Inline Functions: */         \r
+                       /** General management task for a given Audio class interface, required for the correct operation of the interface. This should\r
+                        *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state\r
+                        */\r
+                       static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);\r
+                       static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)\r
+                       {\r
+                               (void)AudioInterfaceInfo;\r
+                       }\r
 \r
 \r
-                       uint8_t                   SampleFrequencyType; /**< Total number of sample frequencies supported by the device */                       \r
-                       AudioSampleFreq_t         SampleFrequencies[1]; /**< Sample frequencies supported by the device */\r
-               } USB_AudioFormat_t;\r
-               \r
-               /** Type define for an Audio class specific endpoint descriptor. This contains a regular endpoint \r
-                *  descriptor with a few Audio-class specific extensions. See the USB Audio specification for more details.\r
-                */\r
-               typedef struct\r
-               {\r
-                       USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint */\r
-\r
-                       uint8_t                   Refresh; /**< Always set to zero */\r
-                       uint8_t                   SyncEndpointNumber; /**< Endpoint address to send synchronisation information to, if needed (zero otherwise) */\r
-               } USB_AudioStreamEndpoint_Std_t;\r
-                                       \r
-               /** Type define for an Audio class specific extended endpoint descriptor. This contains extra information\r
-                *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio\r
-                *  class specific extended endpoint descriptor. See the USB Audio specification for more details.\r
-                */\r
-               typedef struct\r
-               {\r
-                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */\r
-                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
-                       \r
-                       uint8_t                   Attributes; /**< Audio class specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS */\r
+                       /** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming\r
+                        *  OUT endpoint ready for reading.\r
+                        *\r
+                        *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or\r
+                        *        the call will fail.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state\r
+                        *\r
+                        *  \return Boolean true if the given Audio interface has a sample to be read, false otherwise\r
+                        */             \r
+                       static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)\r
+                       {\r
+                               if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))\r
+                                 return false;\r
+                               \r
+                               Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataOUTEndpointNumber);      \r
+                               return Endpoint_IsOUTReceived();\r
+                       }\r
+\r
+                       /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects\r
+                        *  the streaming IN endpoint ready for writing.\r
+                        *\r
+                        *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or\r
+                        *        the call will fail.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state\r
+                        *\r
+                        *  \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise\r
+                        */\r
+                       static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)\r
+                       {\r
+                               if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))\r
+                                 return false;\r
+                               \r
+                               Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataINEndpointNumber);\r
+                               return Endpoint_IsINReady();\r
+                       }\r
 \r
 \r
-                       uint8_t                   LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification */\r
-                       uint16_t                  LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry */\r
-               } USB_AudioStreamEndpoint_Spc_t;        \r
+                       /** Reads the next 8-bit audio sample from the current audio interface.\r
+                        *\r
+                        *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
+                        *        the correct endpoint is selected and ready for data.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state\r
+                        *\r
+                        *  \return  Signed 8-bit audio sample from the audio interface\r
+                        */\r
+                       static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;\r
+                       static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)\r
+                       {\r
+                               int8_t Sample;\r
+                               \r
+                               (void)AudioInterfaceInfo;\r
+\r
+                               Sample = Endpoint_Read_Byte();\r
+\r
+                               if (!(Endpoint_BytesInEndpoint()))\r
+                                 Endpoint_ClearOUT();\r
+                               \r
+                               return Sample;\r
+                       }\r
 \r
 \r
-               typedef struct\r
-               {\r
-                       uint8_t  StreamingInterfaceNumber;\r
+                       /** Reads the next 16-bit audio sample from the current audio interface.\r
+                        *\r
+                        *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
+                        *        the correct endpoint is selected and ready for data.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state\r
+                        *\r
+                        *  \return  Signed 16-bit audio sample from the audio interface\r
+                        */\r
+                       static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;\r
+                       static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)\r
+                       {\r
+                               int16_t Sample;\r
+\r
+                               (void)AudioInterfaceInfo;\r
+\r
+                               Sample = (int16_t)Endpoint_Read_Word_LE();\r
+                                         \r
+                               if (!(Endpoint_BytesInEndpoint()))\r
+                                 Endpoint_ClearOUT();\r
+\r
+                               return Sample;\r
+                       }\r
 \r
 \r
-                       uint8_t  DataINEndpointNumber;\r
-                       uint16_t DataINEndpointSize;\r
+                       /** Reads the next 24-bit audio sample from the current audio interface.\r
+                        *\r
+                        *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
+                        *        the correct endpoint is selected and ready for data.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state\r
+                        *\r
+                        *  \return  Signed 24-bit audio sample from the audio interface\r
+                        */\r
+                       static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;\r
+                       static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)\r
+                       {\r
+                               int32_t Sample;\r
+\r
+                               (void)AudioInterfaceInfo;\r
+\r
+                               Sample = (((uint32_t)Endpoint_Read_Byte() << 16) | Endpoint_Read_Word_LE());\r
+                                         \r
+                               if (!(Endpoint_BytesInEndpoint()))\r
+                                 Endpoint_ClearOUT();\r
+\r
+                               return Sample;\r
+                       }\r
 \r
 \r
-                       uint8_t  DataOUTEndpointNumber;\r
-                       uint16_t DataOUTEndpointSize;\r
+                       /** Writes the next 8-bit audio sample to the current audio interface.\r
+                        *\r
+                        *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
+                        *        the correct endpoint is selected and ready for data.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state\r
+                        *  \param[in] Sample  Signed 8-bit audio sample\r
+                        */\r
+                       static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
+                                                                    const int8_t Sample) ATTR_ALWAYS_INLINE;\r
+                       static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
+                                                                    const int8_t Sample)\r
+                       {\r
+                               Endpoint_Write_Byte(Sample);\r
+\r
+                               if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)\r
+                                 Endpoint_ClearIN();\r
+                       }\r
 \r
 \r
-                       bool     InterfaceEnabled;\r
-               } USB_ClassInfo_Audio_t;\r
-               \r
-       /* Function Prototypes: */\r
-               bool     USB_Audio_ConfigureEndpoints(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-               void     USB_Audio_ProcessControlPacket(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-               void     USB_Audio_USBTask(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-               \r
-               int8_t   USB_Audio_ReadSample8(void);\r
-               int16_t  USB_Audio_ReadSample16(void);\r
-               int32_t  USB_Audio_ReadSample24(void);\r
-               void     USB_Audio_WriteSample8(int8_t Sample);\r
-               void     USB_Audio_WriteSample16(int16_t Sample);\r
-               void     USB_Audio_WriteSample24(int32_t Sample);\r
-               bool     USB_Audio_IsSampleReceived(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-               bool     USB_Audio_IsReadyForNextSample(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
+                       /** Writes the next 16-bit audio sample to the current audio interface.\r
+                        *\r
+                        *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
+                        *        the correct endpoint is selected and ready for data.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state\r
+                        *  \param[in] Sample  Signed 16-bit audio sample\r
+                        */\r
+                       static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
+                                                                     const int16_t Sample) ATTR_ALWAYS_INLINE;\r
+                       static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
+                                                                     const int16_t Sample)\r
+                       {\r
+                               Endpoint_Write_Word_LE(Sample);\r
+\r
+                               if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)\r
+                                 Endpoint_ClearIN();\r
+                       }\r
+\r
+                       /** Writes the next 24-bit audio sample to the current audio interface.\r
+                        *\r
+                        *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
+                        *        the correct endpoint is selected and ready for data.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state\r
+                        *  \param[in] Sample  Signed 24-bit audio sample\r
+                        */\r
+                       static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
+                                                                     const int32_t Sample) ATTR_ALWAYS_INLINE;\r
+                       static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
+                                                                     const int32_t Sample)\r
+                       {\r
+                               Endpoint_Write_Byte(Sample >> 16);\r
+                               Endpoint_Write_Word_LE(Sample);\r
+\r
+                               if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)\r
+                                 Endpoint_ClearIN();\r
+                       }\r
 \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
 \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                #endif\r
                \r
 #endif\r
                #endif\r
                \r
 #endif\r
+\r
+/** @} */\r