Demos/Device/ClassDriver/MIDI/MIDI.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 MIDI 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>USB-MIDI Audio Class Extension Specification</td>
  30  *    <td>General MIDI 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  *  MIDI demonstration application. This gives a simple reference
  41  *  application for implementing the USB-MIDI class in USB devices.
  42  *  It is built upon the USB Audio class.
  43  *
  44  *  Joystick movements are translated into note on/off messages and
  45  *  are sent to the host PC as MIDI streams which can be read by any
  46  *  MIDI program supporting MIDI IN devices.
  47  *
  48  *  If the HWB is not pressed, channel 1 (default piano) is used. If
  49  *  the HWB is set, then channel 10 (default percussion) is selected.
  50  *
  51  *  This device implements MIDI-THRU mode, with the IN MIDI data being
  52  *  generated by the device itself. OUT MIDI data is discarded.
  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>
  61  *     None
  62  *    </td>
  63  *   </tr>
  64  *  </table>
  65  */