Move new Class Driver powered demos to a new ClassDriver subdirectory, re-add old...

[pub/lufa.git] / Demos / Device / ClassDriver / AudioOutput / AudioOutput.txt

diff --git a/Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt b/Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt
new file mode 100644 (file)
index 0000000..a47f9b5
--- /dev/null
+++ b/Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt
@@ -0,0 +1,93 @@
+/** \file\r
+ *\r
+ *  This file contains special DoxyGen information for the generation of the main page and other special\r
+ *  documentation pages. It is not a project source file.\r
+ */\r
+ \r
+/** \mainpage Audio Output Device Demo\r
+ *\r
+ *  \section SSec_Info USB Information:\r
+ *\r
+ *  The following table gives a rundown of the USB utilization of this demo.\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>USB Mode:</b></td>\r
+ *    <td>Device</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>USB Class:</b></td>\r
+ *    <td>Audio Class</td>\r
+ *   </tr>\r
+ *   <tr> \r
+ *    <td><b>USB Subclass:</b></td>\r
+ *    <td>Standard Audio Device</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Relevant Standards:</b></td>\r
+ *    <td>USBIF Audio Class Specification</td>\r
+ *    <td>USBIF Audio Class Terminal Types Specification</td>\r
+ *    <td>USBIF Audio Data Formats Specification</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Usable Speeds:</b></td>\r
+ *    <td>Full Speed Mode</td>\r
+ *   </tr>\r
+ *  </table>\r
+ *\r
+ *  \section SSec_Description Project Description: \r
+ *\r
+ *  Audio demonstration application. This gives a simple reference\r
+ *  application for implementing a USB Audio Output device using the\r
+ *  basic USB Audio drivers in all modern OSes (i.e. no special drivers\r
+ *  required).\r
+ *  \r
+ *  On start-up the system will automatically enumerate and function\r
+ *  as a USB speaker. Incoming audio will output in 8-bit PWM onto\r
+ *  the timer output (timer 3 for the AT90USBXXX6/7 USB AVRs, timer 1 for\r
+ *  the AT90USBXXX2 controller AVRs) compare channel A for AUDIO_OUT_MONO\r
+ *  mode, on channels A and B for AUDIO_OUT_STEREO and on the board LEDs\r
+ *  for AUDIO_OUT_LEDS mode. Decouple audio outputs with a capacitor and\r
+ *  attach to a speaker to hear the audio.\r
+ *  \r
+ *  Under Windows, if a driver request dialogue pops up, select the option\r
+ *  to automatically install the appropriate drivers.\r
+ *\r
+ *  \section SSec_Options Project Options\r
+ *\r
+ *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>Define Name:</b></td>\r
+ *    <td><b>Location:</b></td>\r
+ *    <td><b>Description:</b></td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>AUDIO_OUT_STEREO</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, this outputs the audio samples in stereo to the timer output pins of the microcontroller.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>AUDIO_OUT_MONO</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, this outputs the audio samples in mono to the timer output pin of the microcontroller.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>AUDIO_OUT_LEDS</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, this outputs the audio samples in stereo to the board LEDs.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>AUDIO_OUT_PORTC</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, this outputs the audio samples in mono to port C of the microcontroller, for connection to an\r
+ *        external DAC.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>AUDIO_SAMPLE_FREQUENCY</td>\r
+ *    <td>Descriptors.h</td>\r
+ *    <td>Gives the audio sample rate per channel for the audio stream, in Hz.</td>\r
+ *   </tr>\r
+ *  </table>\r
+ */\r