AudioOutput.txt 3.14 KB
Newer Older
1
2
3
4
5
6
7
/** \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.
 */
 
/** \mainpage Audio Output Device Demo
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 *
 *  \section SSec_Info USB Information:
 *
 *  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>
 *   <tr> 
 *    <td><b>USB Subclass:</b></td>
 *    <td>Standard Audio Device</td>
 *   </tr>
 *   <tr>
 *    <td><b>Relevant Standards:</b></td>
 *    <td>USBIF Audio Class Specification</td>
 *    <td>USBIF Audio Class Terminal Types Specification</td>
 *    <td>USBIF Audio Data Formats Specification</td>
 *   </tr>
 *   <tr>
 *    <td><b>Usable Speeds:</b></td>
 *    <td>Full Speed Mode</td>
 *   </tr>
 *  </table>
 *
 *  \section SSec_Description Project Description: 
 *
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 *  Audio demonstration application. This gives a simple reference
 *  application for implementing a USB Audio Output device using the
 *  basic USB Audio drivers in all modern OSes (i.e. no special drivers
 *  required).
 *  
 *  On startup the system will automatically enumerate and function
 *  as a USB speaker. Incomming audio will output in 8-bit PWM onto
 *  the timer output (timer 3 for the AT90USBXXX6/7 USB AVRs, timer 1 for
 *  the AT90USBXXX2 controller AVRs) compare channel A for AUDIO_OUT_MONO
 *  mode, on channels A and B for AUDIO_OUT_STEREO and on the board LEDs
 *  for AUDIO_OUT_LEDS mode. Decouple audio outputs with a capacitor and
 *  attach to a speaker to hear the audio.
 *  
 *  Under Windows, if a driver request dialogue pops up, select the option
 *  to automatically install the appropriate drivers.
55
56
57
58
 *
 *  \section SSec_Options Project Options
 *
 *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
59
60
61
 *
 *  <table>
 *   <tr>
62
63
64
 *    <td><b>Define Name:</b></td>
 *    <td><b>Location:</b></td>
 *    <td><b>Description:</b></td>
65
66
 *   </tr>
 *   <tr>
67
68
69
 *    <td>AUDIO_OUT_STEREO</td>
 *    <td>Makefile CDEFS</td>
 *    <td>When defined, this outputs the audio samples in stereo to the timer output pins of the microcontroller.</td>
70
 *   </tr>
71
72
73
74
 *   <tr>
 *    <td>AUDIO_OUT_MONO</td>
 *    <td>Makefile CDEFS</td>
 *    <td>When defined, this outputs the audio samples in mono to the timer output pin of the microcontroller.</td>
75
76
 *   </tr>
 *   <tr>
77
78
79
 *    <td>AUDIO_OUT_LEDS</td>
 *    <td>Makefile CDEFS</td>
 *    <td>When defined, this outputs the audio samples in stereo to the board LEDs.</td>
80
81
 *   </tr>
 *   <tr>
82
83
84
85
 *    <td>AUDIO_OUT_PORTC</td>
 *    <td>Makefile CDEFS</td>
 *    <td>When defined, this outputs the audio samples in mono to port C of the microcontroller, for connection to an
 *        external DAC.</td>
86
 *   </tr>
87
88
89
90
91
 *   <tr>
 *    <td>AUDIO_SAMPLE_FREQUENCY</td>
 *    <td>Descriptors.h</td>
 *    <td>Gives the audio sample rate per channel for the audio stream, in Hz.</td>
 *   </tr>
92
93
 *  </table>
 */