AudioInput.txt 2.76 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 Input 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
 *  - Series 7 USB AVRs (AT90USBxxx7)
 *  - Series 6 USB AVRs (AT90USBxxx6)
 *  - 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
41
42
43
44
45
 *   </tr>
 *   <tr>
 *    <td><b>Usable Speeds:</b></td>
 *    <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 Input 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
 *  On start-up the system will automatically enumerate and function as a 
 *  USB microphone. By default, the demo will produce a square wave test tone
 *  when the board button is pressed. If USE_TEST_TONE is not defined in the
 *  project makefile, incoming audio from the ADC channel 1 will be sampled
 *  and sent to the host computer instead.
58
 *
59
 *  When in microphone mode, connect a microphone to the ADC channel 2.
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
 *
 *  <table>
 *   <tr>
 *    <td><b>Define Name:</b></td>
 *    <td><b>Location:</b></td>
 *    <td><b>Description:</b></td>
 *   </tr>
 *   <tr>
75
 *    <td>USE_TEST_TONE</td>
76
 *    <td>AppConfig.h</td>
77
78
79
80
 *    <td>When defined, this alters the demo to produce a square wave test tone when the first board button is pressed
 *        instead of sampling the board microphone.</td>
 *   </tr>
 *   <tr>
81
 *    <td>MICROPHONE_BIASED_TO_HALF_RAIL</td>
82
 *    <td>AppConfig.h</td>
83
84
85
86
 *    <td>When defined, this alters the demo so that the half VCC bias of the microphone input is subtracted.</td>
 *   </tr>
 *  </table>
 */
87