-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2009.\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
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \ingroup Group_USBDeviceClassDrivers\r
- * @defgroup Group_USBClassAudioDevice Audio Device Class Driver - LUFA/Drivers/Class/Device/Audio.h\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
- * Functions, macros, variables, enums and types related to the management of USB Audio Class interfaces\r
- * within a USB device.\r
- *\r
- * @{\r
- */\r
-\r
-#ifndef _AUDIO_CLASS_H_\r
-#define _AUDIO_CLASS_H_\r
-\r
- /* Includes: */\r
- #include "../../USB.h"\r
-\r
- #include <string.h>\r
-\r
- /* Enable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\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
-\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
- /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */\r
- #define CHANNEL_LEFT_FRONT (1 << 0)\r
-\r
- /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */\r
- #define CHANNEL_RIGHT_FRONT (1 << 1)\r
-\r
- /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */\r
- #define CHANNEL_CENTER_FRONT (1 << 2)\r
-\r
- /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */\r
- #define CHANNEL_LOW_FREQ_ENHANCE (1 << 3)\r
-\r
- /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */\r
- #define CHANNEL_LEFT_SURROUND (1 << 4)\r
-\r
- /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */\r
- #define CHANNEL_RIGHT_SURROUND (1 << 5)\r
-\r
- /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */\r
- #define CHANNEL_LEFT_OF_CENTER (1 << 6)\r
-\r
- /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */\r
- #define CHANNEL_RIGHT_OF_CENTER (1 << 7)\r
-\r
- /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */\r
- #define CHANNEL_SURROUND (1 << 8)\r
-\r
- /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */\r
- #define CHANNEL_SIDE_LEFT (1 << 9)\r
-\r
- /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */\r
- #define CHANNEL_SIDE_RIGHT (1 << 10)\r
-\r
- /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */\r
- #define CHANNEL_TOP (1 << 11)\r
-\r
- /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */\r
- #define FEATURE_MUTE (1 << 0)\r
-\r
- /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */\r
- #define FEATURE_VOLUME (1 << 1)\r
-\r
- /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */\r
- #define FEATURE_BASS (1 << 2)\r
-\r
- /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */\r
- #define FEATURE_MID (1 << 3)\r
-\r
- /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */\r
- #define FEATURE_TREBLE (1 << 4)\r
-\r
- /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */\r
- #define FEATURE_GRAPHIC_EQUALIZER (1 << 5)\r
-\r
- /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */\r
-\r
- /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */\r
- #define FEATURE_AUTOMATIC_GAIN (1 << 6)\r
-\r
- /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */\r
- #define FEATURE_DELAY (1 << 7)\r
-\r
- /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */\r
- #define FEATURE_BASS_BOOST (1 << 8)\r
-
- /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */\r
- #define FEATURE_BASS_LOUDNESS (1 << 9)\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_UNDEFINED 0x0100\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_STREAMING 0x0101\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_VENDOR 0x01FF\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_IN_UNDEFINED 0x0200\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_IN_MIC 0x0201\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_IN_DESKTOP_MIC 0x0202\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_IN_PERSONAL_MIC 0x0203\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_IN_OMNIDIR_MIC 0x0204\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_IN_MIC_ARRAY 0x0205\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_IN_PROCESSING_MIC 0x0206\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_IN_OUT_UNDEFINED 0x0300\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_OUT_SPEAKER 0x0301\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_OUT_HEADPHONES 0x0302\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_OUT_HEAD_MOUNTED 0x0303\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_OUT_DESKTOP 0x0304\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_OUT_ROOM 0x0305\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_OUT_COMMUNICATION 0x0306\r
-\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ \r
- #define TERMINAL_OUT_LOWFREQ 0x0307\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
- \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
- \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
-\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
-\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
-\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. The contents of this structure should be set to their correct\r
- * values when used, or ommitted to force the library to use default values.\r
- */\r
- typedef struct\r
- {\r
- uint8_t StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls */\r
-\r
- uint8_t DataINEndpointNumber; /**< Endpoint number of the incomming Audio Streaming data, if available (zero if unused) */\r
- uint16_t DataINEndpointSize; /**< Size in bytes of the incomming Audio Streaming data endpoint, if available (zero if unused) */\r
-\r
- uint8_t DataOUTEndpointNumber; /**< Endpoint number of the outgoing Audio Streaming data, if available (zero if unused) */\r
- uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing Audio Streaming data endpoint, if available (zero if unused) */\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
- } USB_ClassInfo_Audio_t;\r
- \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_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
- * given Audio interface is selected.\r
- *\r
- * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
- *\r
- * \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
- */\r
- bool USB_Audio_ConfigureEndpoints(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-\r
- /** Processes incomming 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_UnhandledControlPacket() event.\r
- *\r
- * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
- */\r
- void USB_Audio_ProcessControlPacket(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-\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 AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
- */\r
- void USB_Audio_USBTask(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
- \r
- /** Reads the next 8-bit audio sample from the current audio interface.\r
- *\r
- * \note This should be preceeded 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
- * \return Signed 8-bit audio sample from the audio interface\r
- */\r
- int8_t USB_Audio_ReadSample8(void);\r
-\r
- /** Reads the next 16-bit audio sample from the current audio interface.\r
- *\r
- * \note This should be preceeded 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
- * \return Signed 16-bit audio sample from the audio interface\r
- */\r
- int16_t USB_Audio_ReadSample16(void);\r
-\r
- /** Reads the next 24-bit audio sample from the current audio interface.\r
- *\r
- * \note This should be preceeded 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
- * \return Signed 24-bit audio sample from the audio interface\r
- */\r
- int32_t USB_Audio_ReadSample24(void);\r
-\r
- /** Writes the next 8-bit audio sample to the current audio interface.\r
- *\r
- * \note This should be preceeded 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 Sample Signed 8-bit audio sample\r
- */\r
- void USB_Audio_WriteSample8(int8_t Sample);\r
-\r
- /** Writes the next 16-bit audio sample to the current audio interface.\r
- *\r
- * \note This should be preceeded 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 Sample Signed 16-bit audio sample\r
- */\r
- void USB_Audio_WriteSample16(int16_t Sample);\r
-\r
- /** Writes the next 24-bit audio sample to the current audio interface.\r
- *\r
- * \note This should be preceeded 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 Sample Signed 24-bit audio sample\r
- */\r
- void USB_Audio_WriteSample24(int32_t Sample);\r
-\r
- /** Determines if the given audio interface is ready for a sample to be read from it.\r
- *\r
- * \param 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
- bool USB_Audio_IsSampleReceived(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-\r
- /** Determines if the given audio interface is ready to accept the next sample to be written to it.\r
- *\r
- * \param 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
- bool USB_Audio_IsReadyForNextSample(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-\r
- /* Disable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- }\r
- #endif\r
- \r
-#endif\r
-\r
-/** @} */\r
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2011.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.lufa-lib.org
+*/
+
+/*
+ Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+ Permission to use, copy, modify, distribute, and sell this
+ software and its documentation for any purpose is hereby granted
+ without fee, provided that the above copyright notice appear in
+ all copies and that both that the copyright notice and this
+ permission notice and warranty disclaimer appear in supporting
+ documentation, and that the name of the author not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission.
+
+ The author disclaim all warranties with regard to this
+ software, including all implied warranties of merchantability
+ and fitness. In no event shall the author be liable for any
+ special, indirect or consequential damages or any damages
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
+*/
+
+/** \file
+ * \brief Device mode driver for the library USB Audio 1.0 Class driver.
+ *
+ * Device mode driver for the library USB Audio 1.0 Class driver.
+ *
+ * \note This file should not be included directly. It is automatically included as needed by the USB module driver
+ * dispatch header located in LUFA/Drivers/USB.h.
+ */
+
+/** \ingroup Group_USBClassAudio
+ * \defgroup Group_USBClassAudioDevice Audio 1.0 Class Device Mode Driver
+ *
+ * \section Sec_Dependencies Module Source Dependencies
+ * The following files must be built with any user project that uses this module:
+ * - LUFA/Drivers/USB/Class/Device/Audio.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
+ *
+ * \section Sec_ModDescription Module Description
+ * Device Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver.
+ *
+ * @{
+ */
+
+#ifndef _AUDIO_CLASS_DEVICE_H_
+#define _AUDIO_CLASS_DEVICE_H_
+
+ /* Includes: */
+ #include "../../USB.h"
+ #include "../Common/Audio.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/USB.h instead.
+ #endif
+
+ /* Public Interface - May be used in end-application: */
+ /* Type Defines: */
+ /** \brief Audio Class Device Mode Configuration and State Structure.
+ *
+ * Class state structure. An instance of this structure should be made for each Audio interface
+ * within the user application, and passed to each of the Audio class driver functions as the
+ * \c AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information.
+ */
+ typedef struct
+ {
+ const struct
+ {
+ uint8_t StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this
+ * structure controls.
+ */
+
+ uint8_t DataINEndpointNumber; /**< Endpoint number of the incoming Audio Streaming data, if available
+ * (zero if unused).
+ */
+ uint16_t DataINEndpointSize; /**< Size in bytes of the incoming Audio Streaming data endpoint, if available
+ * (zero if unused).
+ */
+
+ uint8_t DataOUTEndpointNumber; /**< Endpoint number of the outgoing Audio Streaming data, if available
+ * (zero if unused).
+ */
+ uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing Audio Streaming data endpoint, if available
+ * (zero if unused).
+ */
+ } Config; /**< Config data for the USB class interface within the device. All elements in this section
+ * <b>must</b> be set or the interface will fail to enumerate and operate correctly.
+ */
+ struct
+ {
+ bool InterfaceEnabled; /**< Set and cleared by the class driver to indicate if the host has enabled the streaming endpoints
+ * of the Audio Streaming interface.
+ */
+ } State; /**< State data for the USB class interface within the device. All elements in this section
+ * are reset to their defaults when the interface is enumerated.
+ */
+ } USB_ClassInfo_Audio_Device_t;
+
+ /* Function Prototypes: */
+ /** Configures the endpoints of a given Audio interface, ready for use. This should be linked to the library
+ * \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the
+ * given Audio interface is selected.
+ *
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
+ *
+ * \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.
+ */
+ bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** Processes incoming control requests from the host, that are directed to the given Audio class interface. This should be
+ * linked to the library \ref EVENT_USB_Device_ControlRequest() event.
+ *
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
+ */
+ void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** Audio class driver callback for the setting and retrieval of streaming endpoint properties. This callback must be implemented
+ * in the user application to handle property manipulations on streaming audio endpoints.
+ *
+ * When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for
+ * the given endpoint index, and should return as fast as possible. When non-NULL, this value may be altered for GET operations
+ * to indicate the size of the retreived data.
+ *
+ * \note The length of the retrieved data stored into the Data buffer on GET operations should not exceed the initial value
+ * of the \c DataLength parameter.
+ *
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
+ * \param[in] EndpointProperty Property of the endpoint to get or set, a value from \ref Audio_ClassRequests_t.
+ * \param[in] EndpointAddress Address of the streaming endpoint whose property is being referenced.
+ * \param[in] EndpointControl Parameter of the endpoint to get or set, a value from \ref Audio_EndpointControls_t.
+ * \param[in,out] DataLength For SET operations, the length of the parameter data to set. For GET operations, the maximum
+ * length of the retrieved data. When NULL, the function should return whether the given property
+ * and parameter is valid for the requested endpoint without reading or modifying the Data buffer.
+ * \param[in,out] Data Pointer to a location where the parameter data is stored for SET operations, or where
+ * the retrieved data is to be stored for GET operations.
+ *
+ * \return Boolean true if the property get/set was successful, false otherwise
+ */
+ bool CALLBACK_Audio_Device_GetSetEndpointProperty(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
+ const uint8_t EndpointProperty,
+ const uint8_t EndpointAddress,
+ const uint8_t EndpointControl,
+ uint16_t* const DataLength,
+ uint8_t* Data);
+
+ /** Audio class driver event for an Audio Stream start/stop change. This event fires each time the device receives a stream enable or
+ * disable control request from the host, to start and stop the audio stream. The current state of the stream can be determined by the
+ * State.InterfaceEnabled value inside the Audio interface structure passed as a parameter.
+ *
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
+ */
+ void EVENT_Audio_Device_StreamStartStop(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
+
+ /* Inline Functions: */
+ /** General management task for a given Audio class interface, required for the correct operation of the interface. This should
+ * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
+ *
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
+ */
+ static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
+ static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+ {
+ (void)AudioInterfaceInfo;
+ }
+
+ /** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming
+ * OUT endpoint ready for reading.
+ *
+ * \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
+ * the call will fail.
+ *
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
+ *
+ * \return Boolean \c true if the given Audio interface has a sample to be read, \c false otherwise.
+ */
+ static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
+ static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+ {
+ if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
+ return false;
+
+ Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataOUTEndpointNumber);
+ return Endpoint_IsOUTReceived();
+ }
+
+ /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects
+ * the streaming IN endpoint ready for writing.
+ *
+ * \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
+ * the call will fail.
+ *
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
+ *
+ * \return Boolean \c true if the given Audio interface is ready to accept the next sample, \c false otherwise.
+ */
+ static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
+ static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+ {
+ if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
+ return false;
+
+ Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataINEndpointNumber);
+ return Endpoint_IsINReady();
+ }
+
+ /** Reads the next 8-bit audio sample from the current audio interface.
+ *
+ * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
+ * that the correct endpoint is selected and ready for data.
+ *
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
+ *
+ * \return Signed 8-bit audio sample from the audio interface.
+ */
+ static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
+ static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+ {
+ int8_t Sample;
+
+ (void)AudioInterfaceInfo;
+
+ Sample = Endpoint_Read_8();
+
+ if (!(Endpoint_BytesInEndpoint()))
+ Endpoint_ClearOUT();
+
+ return Sample;
+ }
+
+ /** Reads the next 16-bit audio sample from the current audio interface.
+ *
+ * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
+ * that the correct endpoint is selected and ready for data.
+ *
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
+ *
+ * \return Signed 16-bit audio sample from the audio interface.
+ */
+ static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
+ static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+ {
+ int16_t Sample;
+
+ (void)AudioInterfaceInfo;
+
+ Sample = (int16_t)Endpoint_Read_16_LE();
+
+ if (!(Endpoint_BytesInEndpoint()))
+ Endpoint_ClearOUT();
+
+ return Sample;
+ }
+
+ /** Reads the next 24-bit audio sample from the current audio interface.
+ *
+ * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
+ * that the correct endpoint is selected and ready for data.
+ *
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
+ *
+ * \return Signed 24-bit audio sample from the audio interface.
+ */
+ static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
+ static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+ {
+ int32_t Sample;
+
+ (void)AudioInterfaceInfo;
+
+ Sample = (((uint32_t)Endpoint_Read_8() << 16) | Endpoint_Read_16_LE());
+
+ if (!(Endpoint_BytesInEndpoint()))
+ Endpoint_ClearOUT();
+
+ return Sample;
+ }
+
+ /** Writes the next 8-bit audio sample to the current audio interface.
+ *
+ * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
+ * ensure that the correct endpoint is selected and ready for data.
+ *
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
+ * \param[in] Sample Signed 8-bit audio sample.
+ */
+ static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
+ const int8_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
+ static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
+ const int8_t Sample)
+ {
+ Endpoint_Write_8(Sample);
+
+ if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
+ Endpoint_ClearIN();
+ }
+
+ /** Writes the next 16-bit audio sample to the current audio interface.
+ *
+ * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
+ * ensure that the correct endpoint is selected and ready for data.
+ *
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
+ * \param[in] Sample Signed 16-bit audio sample.
+ */
+ static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
+ const int16_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
+ static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
+ const int16_t Sample)
+ {
+ Endpoint_Write_16_LE(Sample);
+
+ if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
+ Endpoint_ClearIN();
+ }
+
+ /** Writes the next 24-bit audio sample to the current audio interface.
+ *
+ * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
+ * ensure that the correct endpoint is selected and ready for data.
+ *
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
+ * \param[in] Sample Signed 24-bit audio sample.
+ */
+ static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
+ const int32_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
+ static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
+ const int32_t Sample)
+ {
+ Endpoint_Write_16_LE(Sample);
+ Endpoint_Write_8(Sample >> 16);
+
+ if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
+ Endpoint_ClearIN();
+ }
+
+ /* Private Interface - For use in library only: */
+ #if !defined(__DOXYGEN__)
+ /* Function Prototypes: */
+ #if defined(__INCLUDE_FROM_AUDIO_DEVICE_C)
+ void Audio_Device_Event_Stub(void) ATTR_CONST;
+
+ void EVENT_Audio_Device_StreamStartStop(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+ ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(Audio_Device_Event_Stub);
+ #endif
+
+ #endif
+
+ /* Disable C linkage for C++ Compilers: */
+ #if defined(__cplusplus)
+ }
+ #endif
+
+#endif
+
+/** @} */
+
projects / pub / USBasp.git / blobdiff