Demos/Device/ClassDriver/AudioInput/AudioInput.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 Input Device Demo
   8  *
   9  *  \section SSec_Info USB Information:
  10  *
  11  *  The following table gives a rundown of the USB utilization of this demo.
  12  *
  13  *  <table>
  14  *   <tr>
  15  *    <td><b>USB Mode:</b></td>
  16  *    <td>Device</td>
  17  *   </tr>
  18  *   <tr>
  19  *    <td><b>USB Class:</b></td>
  20  *    <td>Audio Class</td>
  21  *   </tr>
  22  *   <tr>
  23  *    <td><b>USB Subclass:</b></td>
  24  *    <td>Standard Audio Device</td>
  25  *   </tr>
  26  *   <tr>
  27  *    <td><b>Relevant Standards:</b></td>
  28  *    <td>USBIF Audio Class Specification</td>
  29  *    <td>USBIF Audio Class Terminal Types Specification</td>
  30  *    <td>USBIF Audio Data Formats Specification</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>Usable Speeds:</b></td>
  34  *    <td>Full Speed Mode</td>
  35  *   </tr>
  36  *  </table>
  37  *
  38  *  \section SSec_Description Project Description:
  39  *
  40  *  Audio demonstration application. This gives a simple reference
  41  *  application for implementing a USB Audio Input device using the
  42  *  basic USB Audio drivers in all modern OSes (i.e. no special drivers
  43  *  required).
  44  *
  45  *  On start-up the system will automatically enumerate and function
  46  *  as a USB microphone. Incoming audio from the ADC channel 1 will
  47  *  be sampled and sent to the host computer.
  48  *
  49  *  To use, connect a microphone to the ADC channel 2.
  50  *
  51  *  Under Windows, if a driver request dialogue pops up, select the option
  52  *  to automatically install the appropriate drivers.
  53  *
  54  *  \section SSec_Options Project Options
  55  *
  56  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  57  *
  58  *  <table>
  59  *   <tr>
  60  *    <td><b>Define Name:</b></td>
  61  *    <td><b>Location:</b></td>
  62  *    <td><b>Description:</b></td>
  63  *   </tr>
  64  *   <tr>
  65  *    <td>MICROPHONE_BIASED_TO_HALF_RAIL</td>
  66  *    <td>Makefile CDEFS</td>
  67  *    <td>When defined, this alters the demo so that the half VCC bias of the microphone input is subtracted.</td>
  68  *   </tr>
  69  *   <tr>
  70  *    <td>AUDIO_SAMPLE_FREQUENCY</td>
  71  *    <td>Descriptors.h</td>
  72  *    <td>Gives the audio sample rate per channel for the audio stream, in Hz.</td>
  73  *   </tr>
  74  *  </table>
  75  */