AudioInput.txt 2.33 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 Input Device Demo
8
9
10
11
 *
 *  \section SSec_Info USB Information:
 *
 *  The following table gives a rundown of the USB utilization of this demo.
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
 *
 *  <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>
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 *
 *  \section SSec_Description Project Description: 
 *
 *  Audio demonstration application. This gives a simple reference
 *  application for implementing a USB Audio Input 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 microphone. Incomming audio from the ADC channel 1 will
 *  be sampled and sent to the host computer.
 *  
 *  To use, connect a microphone to the ADC channel 2.
 *  
 *  Under Windows, if a driver request dialogue pops up, select the option
 *  to automatically install the appropriate drivers.
 *
 *  \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.
 *
 *  <table>
 *   <tr>
 *    <td><b>Define Name:</b></td>
 *    <td><b>Location:</b></td>
 *    <td><b>Description:</b></td>
 *   </tr>
 *   <tr>
 *    <td>MICROPHONE_BIASED_TO_HALF_RAIL</td>
 *    <td>Makefile CDEFS</td>
 *    <td>When defined, this alters the demo so that the half VCC bias of the microphone input is subtracted.</td>
 *   </tr>
69
70
71
72
73
 *   <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>
74
 *  </table>
75
 */