8470c042da793beeab6ce08830da9f22af26cbda
[ffmpeg.git] / doc / ffmpeg-resampler.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle FFmpeg Resampler Documentation
4 @titlepage
5 @center @titlefont{FFmpeg Resampler Documentation}
6 @end titlepage
7
8 @top
9
10 @contents
11
12 @chapter Description
13 @c man begin DESCRIPTION
14
15 The FFmpeg resampler provides an high-level interface to the
16 libswresample library audio resampling utilities. In particular it
17 allows to perform audio resampling, audio channel layout rematrixing,
18 and convert audio format and packing layout.
19
20 @c man end DESCRIPTION
21
22 @chapter Resampler Options
23 @c man begin RESAMPLER OPTIONS
24
25 The audio resampler supports the following named options.
26
27 Options may be set by specifying -@var{option} @var{value} in the
28 FFmpeg tools, @var{option}=@var{value} for the aresample filter,
29 by setting the value explicitly in the
30 @code{SwrContext} options or using the @file{libavutil/opt.h} API for
31 programmatic use.
32
33 @table @option
34
35 @item ich, in_channel_count
36 Set the number of input channels. Default value is 0. Setting this
37 value is not mandatory if the corresponding channel layout
38 @option{in_channel_layout} is set.
39
40 @item och, out_channel_count
41 Set the number of output channels. Default value is 0. Setting this
42 value is not mandatory if the corresponding channel layout
43 @option{out_channel_layout} is set.
44
45 @item uch, used_channel_count
46 Set the number of used channels. Default value is 0. This option is
47 only used for special remapping.
48
49 @item isr, in_sample_rate
50 Set the input sample rate. Default value is 0.
51
52 @item osr, out_sample_rate
53 Set the output sample rate. Default value is 0.
54
55 @item isf, in_sample_fmt
56 Specify the input sample format. It is set by default to @code{none}.
57
58 @item osf, out_sample_fmt
59 Specify the output sample format. It is set by default to @code{none}.
60
61 @item tsf, internal_sample_fmt
62 Set the internal sample format. Default value is @code{none}.
63
64 @item icl, in_channel_layout
65 Set the input channel layout.
66
67 @item ocl, out_channel_layout
68 Set the output channel layout.
69
70 @item clev, center_mix_level
71 Set center mix level. It is a value expressed in deciBel, and must be
72 inclusively included between -32 and +32.
73
74 @item slev, surround_mix_level
75 Set surround mix level. It is a value expressed in deciBel, and must
76 be inclusively included between -32 and +32.
77
78 @item lfe_mix_evel
79 Set LFE mix level.
80
81 @item rmvol, rematrix_volume
82 Set rematrix volume. Default value is 1.0.
83
84 @item flags, swr_flags
85 Set flags used by the converter. Default value is 0.
86
87 It supports the following individual flags:
88 @table @option
89 @item res
90 force resampling
91 @end table
92
93 @item dither_scale
94 Set the dither scale. Default value is 1.
95
96 @item dither_method
97 Set dither method. Default value is 0.
98
99 Supported values:
100 @table @samp
101 @item rectangular
102 select rectangular dither
103 @item triangular
104 select triangular dither
105 @item triangular_hp
106 select triangular dither with high pass
107 @end table
108
109 @item filter_size
110 Set resampling filter size, default value is 16.
111
112 @item phase_shift
113 Set resampling phase shift, default value is 10, must be included
114 between 0 and 30.
115
116 @item linear_interp
117 Use Linear Interpolation if set to 1, default value is 0.
118
119 @item cutoff
120 Set cutoff frequency ratio. Must be a float value between 0 and 1,
121 default value is 0.8.
122
123 @item min_comp
124 Set the minimum difference between timestamps and audio data (in
125 seconds) to trigger stretching/squeezing/filling or trimming of the
126 data to make it match the timestamps. The default is that
127 stretching/squeezing/filling and trimming is disabled
128 (@option{min_comp} = @code{FLT_MAX}).
129
130 @item min_hard_comp
131 Set the minimum difference between timestamps and audio data (in
132 seconds) to trigger adding/dropping samples to make it match the
133 timestamps.  This option effectively is a threshold to select between
134 hard (trim/fill) and soft (squeeze/stretch) compensation. Note that
135 all compensation is by default disabled through @option{min_comp}.
136 The default is 0.1.
137
138 @item comp_duration
139 Set duration (in seconds) over which data is stretched/squeezed to
140 make it match the timestamps. Must be a non-negative double float
141 value, default value is 1.0.
142
143 @item max_soft_comp
144 Set maximum factor by which data is stretched/squeezed to make it
145 match the timestamps. Must be a non-negative double float value,
146 default value is 0.
147
148 @item matrix_encoding
149 Select matrixed stereo encoding.
150
151 It accepts the following values:
152 @table @samp
153 @item none
154 select none
155 @item dolby
156 select Dolby
157 @item dplii
158 select Dolby Pro Logic II
159 @end table
160
161 Default value is @code{none}.
162
163 @item filter_type
164 Select resampling filter type. This only affects resampling
165 operations.
166
167 It accepts the following values:
168 @table @samp
169 @item cubic
170 select cubic
171 @item blackman_nuttall
172 select Blackman Nuttall Windowed Sinc
173 @item kaiser
174 select Kaiser Windowed Sinc
175 @end table
176
177 @item kaiser_beta
178 Set Kaiser Window Beta value. Must be an integer included between 2
179 and 16, default value is 9.
180
181 @end table
182
183 @c man end RESAMPLER OPTIONS
184
185 @chapter See Also
186
187 @ifhtml
188 @url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
189 @url{libswresample.html}
190 @end ifhtml
191
192 @ifnothtml
193 ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libswresample(3)
194 @end ifnothtml
195
196 @include authors.texi
197
198 @ignore
199
200 @setfilename ffmpeg-resampler
201 @settitle FFmpeg Resampler
202
203 @end ignore
204
205 @bye