Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \mainpage Audio Output Device Demo
   8  *
   9  *  \section SSec_Compat Demo Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  - Series 7 USB AVRs
  14  *  - Series 6 USB AVRs
  15  *  - Series 4 USB AVRs
  16  *
  17  *  \section SSec_Info USB Information:
  18  *
  19  *  The following table gives a rundown of the USB utilization of this demo.
  20  *
  21  *  <table>
  22  *   <tr>
  23  *    <td><b>USB Mode:</b></td>
  24  *    <td>Device</td>
  25  *   </tr>
  26  *   <tr>
  27  *    <td><b>USB Class:</b></td>
  28  *    <td>Audio Class</td>
  29  *   </tr>
  30  *   <tr>
  31  *    <td><b>USB Subclass:</b></td>
  32  *    <td>Standard Audio Device</td>
  33  *   </tr>
  34  *   <tr>
  35  *    <td><b>Relevant Standards:</b></td>
  36  *    <td>USBIF Audio Class Specification</td>
  37  *    <td>USBIF Audio Class Terminal Types Specification</td>
  38  *    <td>USBIF Audio Data Formats Specification</td>
  39  *   </tr>
  40  *   <tr>
  41  *    <td><b>Usable Speeds:</b></td>
  42  *    <td>Full Speed Mode</td>
  43  *   </tr>
  44  *  </table>
  45  *
  46  *  \section SSec_Description Project Description:
  47  *
  48  *  Audio demonstration application. This gives a simple reference
  49  *  application for implementing a USB Audio Output device using the
  50  *  basic USB Audio drivers in all modern OSes (i.e. no special drivers
  51  *  required).
  52  *
  53  *  On start-up the system will automatically enumerate and function
  54  *  as a USB speaker. Outgoing audio will output in 8-bit PWM onto
  55  *  the timer 3 output compare channel A for AUDIO_OUT_MONO mode, on
  56  *  timer 3 channels A and B for AUDIO_OUT_STEREO and on PORTC as a signed
  57  *  mono sample for AUDIO_OUT_PORTC. Audio output will also be indicated on
  58  *  the board LEDs in all modes. Decouple audio outputs with a capacitor and
  59  *  attach to a speaker to hear the audio.
  60  *
  61  *  Under Windows, if a driver request dialogue pops up, select the option
  62  *  to automatically install the appropriate drivers.
  63  *
  64  *  \section SSec_Options Project Options
  65  *
  66  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  67  *
  68  *  <table>
  69  *   <tr>
  70  *    <td><b>Define Name:</b></td>
  71  *    <td><b>Location:</b></td>
  72  *    <td><b>Description:</b></td>
  73  *   </tr>
  74  *   <tr>
  75  *    <td>AUDIO_OUT_STEREO</td>
  76  *    <td>Makefile CDEFS</td>
  77  *    <td>When defined, this outputs the audio samples in stereo to the timer output pins of the microcontroller.</td>
  78  *   </tr>
  79  *   <tr>
  80  *    <td>AUDIO_OUT_MONO</td>
  81  *    <td>Makefile CDEFS</td>
  82  *    <td>When defined, this outputs the audio samples in mono to the timer output pin of the microcontroller.</td>
  83  *   </tr>
  84  *   <tr>
  85  *    <td>AUDIO_OUT_PORTC</td>
  86  *    <td>Makefile CDEFS</td>
  87  *    <td>When defined, this outputs the audio samples in mono to port C of the microcontroller, for connection to an
  88  *        external DAC.</td>
  89  *   </tr>
  90  *   <tr>
  91  *    <td>AUDIO_SAMPLE_FREQUENCY</td>
  92  *    <td>Descriptors.h</td>
  93  *    <td>Gives the audio sample rate per channel for the audio stream, in Hz.</td>
  94  *   </tr>
  95  *  </table>
  96  */