Demos/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  *  MIDI demonstration application. This gives a simple reference
  10  *  application for implementing the USB-MIDI class in USB devices.
  11  *  It is built upon the USB Audio class.
  12  *
  13  *  Joystick movements are translated into note on/off messages and
  14  *  are sent to the host PC as MIDI streams which can be read by any
  15  *  MIDI program supporting MIDI IN devices.
  16  *
  17  *  If the HWB is not pressed, channel 1 (default piano) is used. If
  18  *  the HWB is set, then channel 10 (default percussion) is selected.
  19  *
  20  *  This device implements MIDI-THRU mode, with the IN MIDI data being
  21  *  generated by the device itself. OUT MIDI data is discarded.
  22  *
  23  *
  24  *  <table>
  25  *   <tr>
  26  *    <td><b>USB Mode:</b></td>
  27  *    <td>Device</td>
  28  *   </tr>
  29  *   <tr>
  30  *    <td><b>USB Class:</b></td>
  31  *    <td>Audio Class</td>
  32  *   </tr>
  33  *   <tr>
  34  *    <td><b>USB Subclass:</b></td>
  35  *    <td>Standard Audio Device</td>
  36  *   </tr>
  37  *   <tr>
  38  *    <td><b>Relevant Standards:</b></td>
  39  *    <td>USBIF Audio Class Specification</td>
  40  *    <td>USB-MIDI Audio Class Extention Specification</td>
  41  *    <td>General MIDI Specification</td>
  42  *   </tr>
  43  *   <tr>
  44  *    <td><b>Usable Speeds:</b></td>
  45  *    <td>Full Speed Mode</td>
  46  *   </tr>
  47  *  </table>
  48  */