Keyboard firmwares for Atmel AVR and Cortex-M
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

AudioOutput.txt 3.0KB

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