AudioOutput.txt 3 KB
Newer Older
1
2
3
4
5
/** \file
 *
 *  This file contains special DoxyGen information for the generation of the main page and other special
 *  documentation pages. It is not a project source file.
 */
6

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