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 "April 2nd, 2011" speaker\-test
  15 .SH NAME
  16 speaker\-test \- command\-line speaker test tone generator for ALSA
  17 .SH SYNOPSIS
  18 .B speaker\-test [\-options]
  19
  20 .SH DESCRIPTION
  21 \fBspeaker\-test\fP generates a tone that can be used to test the speakers of a computer.
  22
  23 \fBspeaker\-test\fP by default will test the \fIdefault\fP device. If you
  24 want to test another sound device you will have first to get a list of
  25 all of the sound cards in your system and the devices associated with
  26 those cards. Notice that there might be for example, one device for
  27 analog sound, one for digital sound and one for HDMI sound.
  28 To get the list of available cards and devices you can run \fBaplay \-L\fR.
  29
  30 .P \fBaplay\fR's output will be similar to this one:
  31
  32 .nf
  33 $ aplay \-L
  34 null
  35     Discard all samples (playback) or generate zero samples (capture)
  36 default:CARD=ICH5
  37     Intel ICH5, Intel ICH5
  38     Default Audio Device
  39 front:CARD=ICH5,DEV=0
  40     Intel ICH5, Intel ICH5
  41     Front speakers
  42 surround40:CARD=ICH5,DEV=0
  43     Intel ICH5, Intel ICH5
  44     4.0 Surround output to Front and Rear speakers
  45 (...)
  46 .fi
  47
  48 .P Each of the devices is listed in the beginning of the definition so,
  49 in the above example, there are four devices listed: null, default, front
  50 and surround40. So, if you want to test the last device you can
  51 run \fBspeaker\-test \-Dsurround40:ICH5 \-c 6\fR. The \fB\-c\fR option will
  52 indicate that the six audio channels in the device have to be tested.
  53
  54
  55
  56
  57
  58 .SH OPTIONS
  59
  60 .TP
  61 \fB\-c\fP | \fB\-\-channels\fP \fINUM\fP
  62 \fINUM\fP channels in stream
  63
  64 .TP
  65 \fB\-D\fP | \fB\-\-device\fP \fINAME\fP
  66 PCM device name \fINAME\fP
  67
  68 .TP
  69 \fB\-f\fP | \fB\-\-frequency\fP \fIFREQ\fP
  70 sine wave of \fIFREQ\fP Hz
  71
  72 .TP
  73 \fB\-\-help\fP
  74 Print usage help
  75
  76 .TP
  77 \fB\-b\fP | \fB\-\-buffer\fP \fITIME\fP
  78 Use buffer size of \fITIME\fP microseconds.
  79 When 0 is given, use the maximal buffer size.
  80 The default value is 0.
  81
  82 .TP
  83 \fB\-p\fP | \fB\-\-period\fP \fITIME\fP
  84 Use period size of \fITIME\fP microseconds.
  85 When 0 is given, the periods given by \fB\-P\fP option is used.
  86 The default value is 0.
  87
  88 .TP
  89 \fB\-P\fP | \fB\-\-nperiods\fP \fIPERIODS\fP
  90 Use number of periods.  The default value is 4.
  91
  92 .TP
  93 \fB\-r\fP | \fB\-\-rate\fP \fIRATE\fP
  94 stream of \fIRATE\fP Hz
  95
  96 .TP
  97 \fB\-t\fP | \fB\-\-test\fP \fBpink\fP|\fBsine\fP|\fBwav\fP
  98 \fB\-t pink\fP means use pink noise (default).
  99
 100 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.
 101
 102 \fB\-t sine\fP means to use sine wave.
 103
 104 \fB\-t wav\fP means to play WAV files, either pre-defined files or given via \fB\-w\fP option.
 105
 106 You can pass the number from 1 to 3 as a backward compatibility.
 107
 108 .TP
 109 \fB\-l\fP | \fB\-\-nloops\fP \fICOUNT\fP
 110
 111 Specifies the number of loops.  Zero means to run infinitely.
 112
 113 When \fB\-s\fP option below with a valid channel is given, \fBspeaker\-test\fP will perform
 114 always a single-shot without looping.
 115
 116 .TP
 117 \fB\-s\fP | \fB\-\-speaker\fP \fICHANNEL\fP
 118 Do a single-shot speaker test for the given channel.  The channel number starts from 1.
 119 The channel number corresponds to left, right, rear-left, rear-right, center, LFE,
 120 side-left, side-right, and so on.
 121
 122 For example, when 1 is passed, it tests the left channel only once rather than both channels
 123 with looping.
 124
 125 .TP
 126 \fB\-w\fP | \fB\-\-wavfile\fP \fIFILE\fP
 127 Use the given WAV file for the playback instead of pre-defined WAV files.
 128
 129 .TP
 130 \fB\-W\fP | \fB\-\-wavdir\fP \fIDIRECTORY\fP
 131 Specify the directory containing WAV files for playback.
 132 The default path is \fI/usr/share/sounds/alsa\fP.
 133
 134 .TP
 135 \fB\-m\fP | \fB\-\-chmap\fP \fIMAP\fP
 136 Pass the channel map to override.
 137 If the playback in a specific channel order or channel positions is
 138 required, pass the channel position strings to this option.
 139
 140 .TP
 141 \fB\-X\fP | \fB\-\-force-frequency\fP
 142 Allow supplied \fIFREQ\fP to be outside the default range of 30-8000Hz. A minimum of 1Hz is still enforced.
 143
 144 .SH USAGE EXAMPLES
 145
 146 Produce stereo sound from one stereo jack:
 147 .EX
 148   speaker\-test \-Dplug:front \-c2
 149 .EE
 150
 151 Produce 4 speaker sound from two stereo jacks:
 152 .EX
 153   speaker\-test \-Dplug:surround40 \-c4
 154 .EE
 155
 156 Produce 5.1 speaker sound from three stereo jacks:
 157 .EX
 158   speaker\-test \-Dplug:surround51 \-c6
 159 .EE
 160
 161 To send a nice low 75Hz tone to the Woofer and then exit without touching any other speakers:
 162 .EX
 163   speaker\-test \-Dplug:surround51 \-c6 \-s1 \-f75
 164 .EE
 165
 166 To do a 2\-speaker test using the spdif (coax or optical) output:
 167 .EX
 168   speaker\-test \-Dplug:spdif \-c2
 169 .EE
 170
 171 Play in the order of front\-right and front-left from the front PCM
 172 .EX
 173   speaker\-test \-Dplug:front \-c2 \-mFR,FL
 174 .EE
 175
 176 .SH SEE ALSO
 177 .BR aplay(1)
 178
 179 .SH AUTHOR
 180 The speaker\-test program was written by James Courtier-Dutton.
 181 Pink noise support was added by Nathan Hurst.
 182 Further extensions by Takashi Iwai.