Minor code style fixes, documentation improvements.

[pub/USBasp.git] / Demos / Device / LowLevel / AudioOutput / Descriptors.h

diff --git a/Demos/Device/LowLevel/AudioOutput/Descriptors.h b/Demos/Device/LowLevel/AudioOutput/Descriptors.h
index 2a9a6f6..8219112 100644 (file)
--- a/Demos/Device/LowLevel/AudioOutput/Descriptors.h
+++ b/Demos/Device/LowLevel/AudioOutput/Descriptors.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2014.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2014  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
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  The author disclaims 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
   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


@@ -41,18 +41,14 @@
 
                #include <avr/pgmspace.h>
 
 
                #include <avr/pgmspace.h>
 

-       /* Macros: */
-               /** Endpoint number of the Audio isochronous streaming data endpoint. */
-               #define AUDIO_STREAM_EPNUM           1
+               #include "Config/AppConfig.h"

 
 

-               /** Endpoint size in bytes of the Audio isochronous streaming data endpoint. The Windows audio stack requires
-                *  at least 192 bytes for correct output, thus the smaller 128 byte maximum endpoint size on some of the smaller
-                *  USB AVR models will result in unavoidable distorted output.
-                */
-               #define AUDIO_STREAM_EPSIZE          ENDPOINT_MAX_SIZE(AUDIO_STREAM_EPNUM)
+       /* Macros: */
+               /** Endpoint address of the Audio isochronous streaming data OUT endpoint. */
+               #define AUDIO_STREAM_EPADDR          (ENDPOINT_DIR_OUT | 1)

 
 

-               /** Sample frequency of the data being transmitted through the streaming endpoint. */
-               #define AUDIO_SAMPLE_FREQUENCY       48000
+               /** Endpoint size in bytes of the Audio isochronous streaming data endpoint. */
+               #define AUDIO_STREAM_EPSIZE           256

 
        /* Type Defines: */
                /** Type define for the device configuration descriptor structure. This must be defined in the
 
        /* Type Defines: */
                /** Type define for the device configuration descriptor structure. This must be defined in the


@@ -62,18 +58,44 @@
                typedef struct
                {
                        USB_Descriptor_Configuration_Header_t     Config;
                typedef struct
                {
                        USB_Descriptor_Configuration_Header_t     Config;

+
+                       // Audio Control Interface

                        USB_Descriptor_Interface_t                Audio_ControlInterface;
                        USB_Audio_Descriptor_Interface_AC_t       Audio_ControlInterface_SPC;
                        USB_Audio_Descriptor_InputTerminal_t      Audio_InputTerminal;
                        USB_Audio_Descriptor_OutputTerminal_t     Audio_OutputTerminal;
                        USB_Descriptor_Interface_t                Audio_ControlInterface;
                        USB_Audio_Descriptor_Interface_AC_t       Audio_ControlInterface_SPC;
                        USB_Audio_Descriptor_InputTerminal_t      Audio_InputTerminal;
                        USB_Audio_Descriptor_OutputTerminal_t     Audio_OutputTerminal;

+
+                       // Audio Streaming Interface

                        USB_Descriptor_Interface_t                Audio_StreamInterface_Alt0;
                        USB_Descriptor_Interface_t                Audio_StreamInterface_Alt1;
                        USB_Audio_Descriptor_Interface_AS_t       Audio_StreamInterface_SPC;
                        USB_Audio_Descriptor_Format_t             Audio_AudioFormat;
                        USB_Descriptor_Interface_t                Audio_StreamInterface_Alt0;
                        USB_Descriptor_Interface_t                Audio_StreamInterface_Alt1;
                        USB_Audio_Descriptor_Interface_AS_t       Audio_StreamInterface_SPC;
                        USB_Audio_Descriptor_Format_t             Audio_AudioFormat;

+                       USB_Audio_SampleFreq_t                    Audio_AudioFormatSampleRates[5];

                        USB_Audio_Descriptor_StreamEndpoint_Std_t Audio_StreamEndpoint;
                        USB_Audio_Descriptor_StreamEndpoint_Spc_t Audio_StreamEndpoint_SPC;
                } USB_Descriptor_Configuration_t;
 
                        USB_Audio_Descriptor_StreamEndpoint_Std_t Audio_StreamEndpoint;
                        USB_Audio_Descriptor_StreamEndpoint_Spc_t Audio_StreamEndpoint_SPC;
                } USB_Descriptor_Configuration_t;
 

+               /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
+                *  should have a unique ID index associated with it, which can be used to refer to the
+                *  interface from other descriptors.
+                */
+               enum InterfaceDescriptors_t
+               {
+                       INTERFACE_ID_AudioControl = 0, /**< Audio control interface descriptor ID */
+                       INTERFACE_ID_AudioStream  = 1, /**< Audio stream interface descriptor ID */
+               };
+
+               /** Enum for the device string descriptor IDs within the device. Each string descriptor should
+                *  have a unique ID index associated with it, which can be used to refer to the string from
+                *  other descriptors.
+                */
+               enum StringDescriptors_t
+               {
+                       STRING_ID_Language     = 0, /**< Supported Languages string descriptor ID (must be zero) */
+                       STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
+                       STRING_ID_Product      = 2, /**< Product string ID */
+               };
+

        /* Function Prototypes: */
                uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
                                                    const uint8_t wIndex,
        /* Function Prototypes: */
                uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
                                                    const uint8_t wIndex,


@@ -81,3 +103,4 @@
                                                    ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 
 #endif
                                                    ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 
 #endif

+