doc/filters: extend af_channelmap documentation

Signed-off-by: Marton Balint <cus@passwd.hu>
This commit is contained in:
Marton Balint 2024-03-19 03:55:12 +01:00
parent eaca78eff8
commit f1e34f1582

View File

@ -4291,14 +4291,18 @@ It accepts the following parameters:
@item map
Map channels from input to output. The argument is a '|'-separated list of
mappings, each in the @code{@var{in_channel}-@var{out_channel}} or
@var{in_channel} form. @var{in_channel} can be either the name of the input
channel (e.g. FL for front left) or its index in the input channel layout.
@var{out_channel} is the name of the output channel or its index in the output
channel layout. If @var{out_channel} is not given then it is implicitly an
index, starting with zero and increasing by one for each mapping.
@code{@var{in_channel}} form. @var{in_channel} can be either the name of the
input channel (e.g. FL for front left) or its index in the input channel
layout. @var{out_channel} is the name of the output channel or its index in the
output channel layout. If @var{out_channel} is not given then it is implicitly
an index, starting with zero and increasing by one for each mapping. Mixing
different types of mappings is not allowed and will result in a parse error.
@item channel_layout
The channel layout of the output stream.
The channel layout of the output stream. If not specified, then filter will
guess it based on the @var{out_channel} names or the number of mappings.
Guessed layouts will not necessarily contain channels in the order of the
mappings.
@end table
If no mapping is present, the filter will implicitly map input channels to