OSDN Git Service

Add WAV file playback support to speaker-test
[android-x86/external-alsa-utils.git] / speaker-test / speaker-test.1
1 .\" -*- nroff -*-
2 .\" macros
3 .de EX \" Begin Example
4 .  IP
5 .  ft CW
6 .  nf
7 .  ne \\$1
8 ..
9 .de EE \" End Example
10 .  ft P
11 .  fi
12 .  PP
13 ..
14 .TH SPEAKER\-TEST 1 "20 September 2004" speaker-test
15 .SH NAME
16 speaker\-test \- command-line speaker test tone generator for ALSA 
17 .SH SYNOPSIS
18 .B speaker\-test
19 .BR "" [ \-D | \-\-device 
20 .IR NAME ]
21 .BR "" [ \-r | \-\-rate
22 .IR RATE ]
23 .BR "" [ \-c | \-\-channels
24 .IR NUM ]
25 .BR "" [ \-f | \-\-frequency
26 .IR FREQ ]
27 .BR "" [ \-p | \-\-period
28 .IR TIME ]
29 .BR "" [ \-n | \-\-noise
30 .IR TIME ]
31 .BR "" [ \-s | \-\-speaker
32 .IR TYPE ]
33 .BR "" [ \-w | \-\-wavfile
34 .IR FILE ]
35 .BR "" [ \-W | \-\-wavdir
36 .IR DIR ]
37 .P
38 .B speaker\-test
39 .B \-\-help
40
41 .SH DESCRIPTION
42 \fBspeaker\-test\fP generates a tone that can be used to test the speakers of a computer.
43
44 .SH OPTIONS
45
46 .TP
47 \fB\-c\fP | \fB\-\-channels\fP \fINUM\fP
48 \fINUM\fP channels in stream
49
50 .TP
51 \fB\-D\fP | \fB\-\-device\fP \fINAME\fP
52 PCM device name \fINAME\fP
53
54 .TP
55 \fB\-f\fP | \fB\-\-frequency\fP \fIFREQ\fP
56 sine wave of \fIFREQ\fP Hz
57
58 .TP
59 \fB\-\-help\fP
60 Print usage help
61
62 .TP
63 \fB\-p\fP | \fB\-\-period\fP \fITIME\fP
64 period size of \fITIME\fP microseconds
65
66 .TP
67 \fB\-r\fP | \fB\-\-rate\fP \fIRATE\fP
68 stream of \fIRATE\fP Hz
69
70 .TP
71 \fB\-s\fP | \fB\-\-speaker\fP \fBpink\fP|\fBsine\fP|\fBwav\fP
72 -tpink means use pink noise (default).
73
74 Pink noise is perceptually uniform noise - that is, it sounds like every frequency at once.  If you can hear any tone it may indicate resonances in your speaker system or room.
75
76 -tsine means use sine wave.
77
78 -twav means to play WAV files, either pre-defined files or given via -w option.
79
80 You can pass the number from 1 to 3 as a backward compatibility.
81
82 .TP
83 \fB\-s\fP | \fB\-\-speaker\fP \fBpink\fP|\fBsine\fP|\fBwav\fP
84 Test speaker 1 or speaker 2 only, rather than both
85
86 .TP
87 \fB\-w\fP | \fB\-\-wavfile\fP
88 Use the given WAV file for the playback instead of pre-defined WAV files.
89
90 .TP
91 \fB\-W\fP | \fB\-\-wavdir\fP
92 Specify the directory containing WAV files for playback.
93
94
95 .SH USAGE EXAMPLES
96
97 Produce stereo sound from one stereo jack:
98 .EX
99   speaker-test -Dplug:front -c2
100 .EE
101
102 Produce 4 speaker sound from two stereo jacks:
103 .EX
104   speaker-test -Dplug:surround40 -c4
105 .EE
106
107 Produce 5.1 speaker sound from three stereo jacks:
108 .EX
109   speaker-test -Dplug:surround51 -c6
110 .EE
111
112 To send a nice low 75Hz tone to the Woofer and then exit without touching any other speakers:
113 .EX
114   speaker-test -Dplug:surround51 -c6 -s1 -f75
115 .EE
116
117 .SH AUTHOR
118 The speaker-test program was written by James Courtier-Dutton.
119 Pink noise support was added by Nathan Hurst.