tmk_core/protocol/lufa/LUFA-git/Projects/MIDIToneGenerator/MIDIToneGenerator.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 Tone Generator Project
   8  *
   9  *  \section Sec_Compat Project Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this project.
  12  *
  13  *  \li Series 7 USB AVRs (AT90USBxxx7)
  14  *  \li Series 6 USB AVRs (AT90USBxxx6)
  15  *  \li Series 4 USB AVRs (ATMEGAxxU4)
  16  *
  17  *  \section Sec_Info USB Information:
  18  *
  19  *  The following table gives a rundown of the USB utilization of this project.
  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 \n
  37  *        USB-MIDI Audio Class Extension Specification \n
  38  *        General MIDI Specification</td>
  39  *   </tr>
  40  *   <tr>
  41  *    <td><b>Supported USB Speeds:</b></td>
  42  *    <td>Full Speed Mode</td>
  43  *   </tr>
  44  *  </table>
  45  *
  46  *  \section Sec_Description Project Description:
  47  *
  48  *  MIDI note synthesiser project. This project implements a basic DDS frequency synthesiser, capable of producing 8-bit PWM sine
  49  *  waves of variable frequency. When attached to a USB host, this project will allow for multiple MIDI notes to be synthesised into
  50  *  audiable sound via PWM, using the notes sent to MIDI channel 1.
  51  *
  52  *  Outgoing audio will output in 8-bit PWM onto the timer 3 output compare channel A. Decouple the audio output with a capacitor
  53  *  and attach to a speaker to hear the audio.
  54  *
  55  *  \section Sec_Options Project Options
  56  *
  57  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
  58  *
  59  *  <table>
  60  *   <tr>
  61  *    <th><b>Define Name:</b></th>
  62  *    <th><b>Location:</b></th>
  63  *    <th><b>Description:</b></th>
  64  *   </tr>
  65  *   <tr>
  66  *    <td>MAX_SIMULTANEOUS_NOTES</td>
  67  *    <td>AppConfig.h</td>
  68  *    <td>Sets the maximum number of MIDI notes that can be generated simultaneously. More notes require more processing time,
  69  *        and thus a value that is too high will cause audiable sound distortion due to insufficient CPU time.</td>
  70  *   </tr>
  71  *  </table>
  72  */
  73