Created audio filters section to replace -af description.

git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@14193 b3059339-0415-0410-9bf9-f77b7e298cf2

1 files changed, 161 insertions, 111 deletions

diff --git a/DOCS/man/en/mplayer.1 b/DOCS/man/en/mplayer.1
index ad8835b98d..9a32ea5e55 100644
--- a/DOCS/man/en/mplayer.1
+++ b/DOCS/man/en/mplayer.1
@@ -3036,117 +3036,6 @@ Skip FFmpeg's MP3 decoder.
 .PD 1
 .
 .TP
-.B \-af <filter1[=parameter1:parameter2:...],filter2,...>
-Activate a comma separated list of audio filters and their options.
-Also see the audio filters section of the documentation.
-.br
-.I NOTE:
-To get a full list of available audio filters, see \-af help.
-.sp 1
-Available filters are:
-.RSs
-.IPs resample[=srate[:sloppy][:type]]
-Changes the sample rate of the audio stream to an integer srate in Hz.
-It only supports the 16-bit little-endian format.
-With MEncoder, you need to also use \-srate <srate>.
-.IPs lavcresample[=srate[:length[:linear[:count[:cutoff]]]]]
-Changes the sample rate of the audio stream to an integer srate in Hz.
-It only supports the 16-bit little-endian format.
-With MEncoder, you need to also use \-srate <srate>.
-.RSss
-srate: the output sample rate
-.br
-length: length of the filter with respect to the lower sampling rate
-(default: 16)
-.br
-linear: if 1 then filters will be linearly interpolated between polyphase
-entries
-.br
-count: log2 of the number of polyphase entries
-(..., 10->1024, 11->2048, 12->4096, ...)
-(default: 10->1024)
-.br
-cutoff: cutoff frequency (0.0-1.0), default set depending upon filter length
-.REss
-.IPs sweep[=speed]
-sine sweep
-.IPs hrtf
-.br
-Head-related transfer function: Converts multichannel audio to
-2 channel output for headphones, preserving the spatiality of the sound.
-.IPs channels[=nch]
-Change the number of channels to nch output channels.
-If the number of output channels is bigger than the number of input channels
-empty channels are inserted (except when mixing from mono to stereo, then
-the mono channel is repeated in both of the output channels).
-If the number of output channels is smaller than the number of input channels
-the exceeding channels are truncated.
-.IPs format[=bps:f]
-Select the bytes per sample and the format used for output from the
-filter layer.
-The option bps is an integer and denotes Bytes per sample.
-The format f is a string containing a concatenated mix of:
-.br
-alaw, mulaw or imaadpcm
-.br
-float or int
-.br
-unsigned or signed
-.br
-le or be (little- or big-endian)
-.br
-.IPs volume[=v:sc]
-Select the output volume level.
-This filter is not reentrant and can therefore only be enabled once for every
-audio stream.
-.RSss
-v: Sets the desired gain in dB for all channels in the stream
-from -200dB to +60dB (where -200dB mutes the sound
-completely and +60dB equals a gain of 1000).
-.br
-sc: Enable soft clipping.
-.REss
-.IPs pan[=n:l01:l02:...l10:l11:l12:...ln0:ln1:ln2:...]
-Mixes channels arbitrarily, see DOCS/\:HTML/\:en/\:audio.html for details.
-.RSss
-n: number of input channels (1\-6)
-.br
-lij: How much of input channel j is mixed into output channel i.
-.REss
-.IPs sub[=fc:ch]
-Add subwoofer channel.
-.RSss
-fc: cutoff frequency for low-pass filter (20Hz to 300Hz) (default: 60Hz)
-.br
-ch: channel number for the sub-channel
-.REss
-.IPs surround[=d]
-Decoder for matrix encoded surround sound, works on many 2 channel files.
-.RSss
-d: delay time in ms for the rear speakers (0ms to 1000ms) (default: 15ms)
-.REss
-.IPs delay[=ch1:ch2:...]
-Delays the sound output.
-Specify the delay separately for each channel in milliseconds (floating point
-number between 0 and 1000).
-.IPs export[=mmapped_file[:nsamples]]
-Exports the incoming signal to other processes using memory mapping (mmap()).
-.RSss
-mmapped_file: file to map data to (default: ~/.mplayer/\:mplayer-af_export)
-.br
-nsamples: number of samples per channel (default: 512)
-.REss
-.IPs extrastereo[=mul]
-Increases the difference between left and right channels to add some
-sort of "live" effect to playback.
-.RSss
-mul: difference coefficient (default: 2.5)
-.REss
-.IPs volnorm
-Maximizes the volume without distorting the sound.
-.RE
-.
-.TP
 .B \-af-adv <force=(0\-3):list=(filters)> (also see \-af)
 Specify advanced audio filter options:
 .RSs
@@ -3583,6 +3472,167 @@ Can be used to force scaling with \-vf scale.
 .
 .
 .
+.SH "AUDIO FILTERS"
+Audio filters allow you to modify the audio stream and its properties.
+The syntax is:
+.
+.TP
+.B \-af <filter1[=parameter1:parameter2:...],filter2,...>
+Setup a chain of audio filters.
+.PP
+.I NOTE:
+To get a full list of available audio filters, see \-af help.
+.PP
+Available filters are:
+.
+.TP
+.B resample[=srate[:sloppy][:type]]
+Changes the sample rate of the audio stream to an integer srate in Hz.
+It only supports the 16-bit little-endian format.
+With MEncoder, you need to also use \-srate <srate>.
+.
+.TP
+.B lavcresample[=srate[:length[:linear[:count[:cutoff]]]]]
+Changes the sample rate of the audio stream to an integer srate in Hz.
+It only supports the 16-bit little-endian format.
+With MEncoder, you need to also use \-srate <srate>.
+.PD 0
+.RSs
+.IPs srate
+the output sample rate
+.IPs length
+length of the filter with respect to the lower sampling rate (default: 16)
+.IPs linear
+if 1 then filters will be linearly interpolated between polyphase entries
+.IPs count
+log2 of the number of polyphase entries
+(..., 10->1024, 11->2048, 12->4096, ...)
+(default: 10->1024)
+.IPs cutoff
+cutoff frequency (0.0-1.0), default set depending upon filter length
+.RE
+.PD 1
+.
+.TP
+.B sweep[=speed]
+sine sweep
+.
+.TP
+.B hrtf\ \ \ 
+Head-related transfer function: Converts multichannel audio to
+2 channel output for headphones, preserving the spatiality of the sound.
+.
+.TP
+.B channels[=nch]
+Change the number of channels to nch output channels.
+If the number of output channels is bigger than the number of input channels
+empty channels are inserted (except when mixing from mono to stereo, then
+the mono channel is repeated in both of the output channels).
+If the number of output channels is smaller than the number of input channels
+the exceeding channels are truncated.
+.
+.TP
+.B format[=bps:f]
+Select the bytes per sample and the format used for output from the
+filter layer.
+The option bps is an integer and denotes Bytes per sample.
+The format f is a string containing a concatenated mix of:
+.br
+alaw, mulaw or imaadpcm
+.br
+float or int
+.br
+unsigned or signed
+.br
+le or be (little- or big-endian)
+.br
+.
+.TP
+.B volume[=v:sc]
+Select the output volume level.
+This filter is not reentrant and can therefore only be enabled once for every
+audio stream.
+.PD 0
+.RSs
+.IPs v
+Sets the desired gain in dB for all channels in the stream
+from -200dB to +60dB (where -200dB mutes the sound
+completely and +60dB equals a gain of 1000).
+.IPs sc
+Enable soft clipping.
+.RE
+.PD 1
+.
+.TP
+.B pan[=n:l01:l02:...l10:l11:l12:...ln0:ln1:ln2:...]
+Mixes channels arbitrarily, see DOCS/\:HTML/\:en/\:audio.html for details.
+.PD 0
+.RSs
+.IPs n
+number of input channels (1\-6)
+.IPs lij
+How much of input channel j is mixed into output channel i.
+.RE
+.PD 1
+.
+.TP
+.B sub[=fc:ch]
+Add subwoofer channel.
+.PD 0
+.RSs
+.IPs fc
+cutoff frequency for low-pass filter (20Hz to 300Hz) (default: 60Hz)
+.IPs ch
+channel number for the sub-channel
+.RE
+.PD 1
+.
+.TP
+.B surround[=d]
+Decoder for matrix encoded surround sound, works on many 2 channel files.
+.PD 0
+.RSs
+.IPs d
+delay time in ms for the rear speakers (0ms to 1000ms) (default: 15ms)
+.RE
+.PD 1
+.
+.TP
+.B delay[=ch1:ch2:...]
+Delays the sound output.
+Specify the delay separately for each channel in milliseconds (floating point
+number between 0 and 1000).
+.
+.TP
+.B export[=mmapped_file[:nsamples]]
+Exports the incoming signal to other processes using memory mapping (mmap()).
+.PD 0
+.RSs
+.IPs mmapped_file
+file to map data to (default: ~/.mplayer/\:mplayer-af_export)
+.IPs nsamples
+number of samples per channel (default: 512)
+.RE
+.PD 1
+.
+.TP
+.B extrastereo[=mul]
+Increases the difference between left and right channels to add some
+sort of "live" effect to playback.
+.PD 0
+.RSs
+.IPs mul\ \ 
+difference coefficient (default: 2.5)
+.RE
+.PD 1
+.
+.TP
+.B volnorm
+Maximizes the volume without distorting the sound.
+.RE
+.
+.
+.
 .SH "VIDEO FILTERS"
 Video filters allow you to modify the video stream and its properties.
 The syntax is: