Go to most recent revision | Details | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
4349 | Serge | 1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
2 | .\" |
||
3 | .\" Standard preamble: |
||
4 | .\" ======================================================================== |
||
5 | .de Sh \" Subsection heading |
||
6 | .br |
||
7 | .if t .Sp |
||
8 | .ne 5 |
||
9 | .PP |
||
10 | \fB\\$1\fR |
||
11 | .PP |
||
12 | .. |
||
13 | .de Sp \" Vertical space (when we can't use .PP) |
||
14 | .if t .sp .5v |
||
15 | .if n .sp |
||
16 | .. |
||
17 | .de Vb \" Begin verbatim text |
||
18 | .ft CW |
||
19 | .nf |
||
20 | .ne \\$1 |
||
21 | .. |
||
22 | .de Ve \" End verbatim text |
||
23 | .ft R |
||
24 | .fi |
||
25 | .. |
||
26 | .\" Set up some character translations and predefined strings. \*(-- will |
||
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
||
28 | .\" double quote, and \*(R" will give a right double quote. | will give a |
||
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
||
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
||
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
||
32 | .tr \(*W-|\(bv\*(Tr |
||
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
||
34 | .ie n \{\ |
||
35 | . ds -- \(*W- |
||
36 | . ds PI pi |
||
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
||
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
||
39 | . ds L" "" |
||
40 | . ds R" "" |
||
41 | . ds C` "" |
||
42 | . ds C' "" |
||
43 | 'br\} |
||
44 | .el\{\ |
||
45 | . ds -- \|\(em\| |
||
46 | . ds PI \(*p |
||
47 | . ds L" `` |
||
48 | . ds R" '' |
||
49 | 'br\} |
||
50 | .\" |
||
51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
||
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
||
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
||
54 | .\" output yourself in some meaningful fashion. |
||
55 | .if \nF \{\ |
||
56 | . de IX |
||
57 | . tm Index:\\$1\t\\n%\t"\\$2" |
||
58 | .. |
||
59 | . nr % 0 |
||
60 | . rr F |
||
61 | .\} |
||
62 | .\" |
||
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
||
64 | .\" way too many mistakes in technical documents. |
||
65 | .hy 0 |
||
66 | .if n .na |
||
67 | .\" |
||
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
||
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
||
70 | . \" fudge factors for nroff and troff |
||
71 | .if n \{\ |
||
72 | . ds #H 0 |
||
73 | . ds #V .8m |
||
74 | . ds #F .3m |
||
75 | . ds #[ \f1 |
||
76 | . ds #] \fP |
||
77 | .\} |
||
78 | .if t \{\ |
||
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
||
80 | . ds #V .6m |
||
81 | . ds #F 0 |
||
82 | . ds #[ \& |
||
83 | . ds #] \& |
||
84 | .\} |
||
85 | . \" simple accents for nroff and troff |
||
86 | .if n \{\ |
||
87 | . ds ' \& |
||
88 | . ds ` \& |
||
89 | . ds ^ \& |
||
90 | . ds , \& |
||
91 | . ds ~ ~ |
||
92 | . ds / |
||
93 | .\} |
||
94 | .if t \{\ |
||
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
||
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
||
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
||
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
||
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
||
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
||
101 | .\} |
||
102 | . \" troff and (daisy-wheel) nroff accents |
||
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
||
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
||
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
||
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
||
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
||
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
||
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
||
110 | .ds ae a\h'-(\w'a'u*4/10)'e |
||
111 | .ds Ae A\h'-(\w'A'u*4/10)'E |
||
112 | . \" corrections for vroff |
||
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
||
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
||
115 | . \" for low resolution devices (crt and lpr) |
||
116 | .if \n(.H>23 .if \n(.V>19 \ |
||
117 | \{\ |
||
118 | . ds : e |
||
119 | . ds 8 ss |
||
120 | . ds o a |
||
121 | . ds d- d\h'-1'\(ga |
||
122 | . ds D- D\h'-1'\(hy |
||
123 | . ds th \o'bp' |
||
124 | . ds Th \o'LP' |
||
125 | . ds ae ae |
||
126 | . ds Ae AE |
||
127 | .\} |
||
128 | .rm #[ #] #H #V #F C |
||
129 | .\" ======================================================================== |
||
130 | .\" |
||
131 | .IX Title "FFMPEG-RESAMPLER 1" |
||
132 | .TH FFMPEG-RESAMPLER 1 "2013-12-14" " " " " |
||
133 | .SH "NAME" |
||
134 | ffmpeg\-resampler \- FFmpeg Resampler |
||
135 | .SH "DESCRIPTION" |
||
136 | .IX Header "DESCRIPTION" |
||
137 | The FFmpeg resampler provides a high-level interface to the |
||
138 | libswresample library audio resampling utilities. In particular it |
||
139 | allows to perform audio resampling, audio channel layout rematrixing, |
||
140 | and convert audio format and packing layout. |
||
141 | .SH "RESAMPLER OPTIONS" |
||
142 | .IX Header "RESAMPLER OPTIONS" |
||
143 | The audio resampler supports the following named options. |
||
144 | .PP |
||
145 | Options may be set by specifying \-\fIoption\fR \fIvalue\fR in the |
||
146 | FFmpeg tools, \fIoption\fR=\fIvalue\fR for the aresample filter, |
||
147 | by setting the value explicitly in the |
||
148 | \&\f(CW\*(C`SwrContext\*(C'\fR options or using the \fIlibavutil/opt.h\fR \s-1API\s0 for |
||
149 | programmatic use. |
||
150 | .IP "\fBich, in_channel_count\fR" 4 |
||
151 | .IX Item "ich, in_channel_count" |
||
152 | Set the number of input channels. Default value is 0. Setting this |
||
153 | value is not mandatory if the corresponding channel layout |
||
154 | \&\fBin_channel_layout\fR is set. |
||
155 | .IP "\fBoch, out_channel_count\fR" 4 |
||
156 | .IX Item "och, out_channel_count" |
||
157 | Set the number of output channels. Default value is 0. Setting this |
||
158 | value is not mandatory if the corresponding channel layout |
||
159 | \&\fBout_channel_layout\fR is set. |
||
160 | .IP "\fBuch, used_channel_count\fR" 4 |
||
161 | .IX Item "uch, used_channel_count" |
||
162 | Set the number of used input channels. Default value is 0. This option is |
||
163 | only used for special remapping. |
||
164 | .IP "\fBisr, in_sample_rate\fR" 4 |
||
165 | .IX Item "isr, in_sample_rate" |
||
166 | Set the input sample rate. Default value is 0. |
||
167 | .IP "\fBosr, out_sample_rate\fR" 4 |
||
168 | .IX Item "osr, out_sample_rate" |
||
169 | Set the output sample rate. Default value is 0. |
||
170 | .IP "\fBisf, in_sample_fmt\fR" 4 |
||
171 | .IX Item "isf, in_sample_fmt" |
||
172 | Specify the input sample format. It is set by default to \f(CW\*(C`none\*(C'\fR. |
||
173 | .IP "\fBosf, out_sample_fmt\fR" 4 |
||
174 | .IX Item "osf, out_sample_fmt" |
||
175 | Specify the output sample format. It is set by default to \f(CW\*(C`none\*(C'\fR. |
||
176 | .IP "\fBtsf, internal_sample_fmt\fR" 4 |
||
177 | .IX Item "tsf, internal_sample_fmt" |
||
178 | Set the internal sample format. Default value is \f(CW\*(C`none\*(C'\fR. |
||
179 | This will automatically be chosen when it is not explicitly set. |
||
180 | .IP "\fBicl, in_channel_layout\fR" 4 |
||
181 | .IX Item "icl, in_channel_layout" |
||
182 | .PD 0 |
||
183 | .IP "\fBocl, out_channel_layout\fR" 4 |
||
184 | .IX Item "ocl, out_channel_layout" |
||
185 | .PD |
||
186 | Set the input/output channel layout. |
||
187 | .Sp |
||
188 | See the Channel Layout section in the \fIffmpeg\-utils\fR\|(1) manual |
||
189 | for the required syntax. |
||
190 | .IP "\fBclev, center_mix_level\fR" 4 |
||
191 | .IX Item "clev, center_mix_level" |
||
192 | Set the center mix level. It is a value expressed in deciBel, and must be |
||
193 | in the interval [\-32,32]. |
||
194 | .IP "\fBslev, surround_mix_level\fR" 4 |
||
195 | .IX Item "slev, surround_mix_level" |
||
196 | Set the surround mix level. It is a value expressed in deciBel, and must |
||
197 | be in the interval [\-32,32]. |
||
198 | .IP "\fBlfe_mix_level\fR" 4 |
||
199 | .IX Item "lfe_mix_level" |
||
200 | Set \s-1LFE\s0 mix into non \s-1LFE\s0 level. It is used when there is a \s-1LFE\s0 input but no |
||
201 | \&\s-1LFE\s0 output. It is a value expressed in deciBel, and must |
||
202 | be in the interval [\-32,32]. |
||
203 | .IP "\fBrmvol, rematrix_volume\fR" 4 |
||
204 | .IX Item "rmvol, rematrix_volume" |
||
205 | Set rematrix volume. Default value is 1.0. |
||
206 | .IP "\fBrematrix_maxval\fR" 4 |
||
207 | .IX Item "rematrix_maxval" |
||
208 | Set maximum output value for rematrixing. |
||
209 | This can be used to prevent clipping vs. preventing volumn reduction |
||
210 | A value of 1.0 prevents cliping. |
||
211 | .IP "\fBflags, swr_flags\fR" 4 |
||
212 | .IX Item "flags, swr_flags" |
||
213 | Set flags used by the converter. Default value is 0. |
||
214 | .Sp |
||
215 | It supports the following individual flags: |
||
216 | .RS 4 |
||
217 | .IP "\fBres\fR" 4 |
||
218 | .IX Item "res" |
||
219 | force resampling, this flag forces resampling to be used even when the |
||
220 | input and output sample rates match. |
||
221 | .RE |
||
222 | .RS 4 |
||
223 | .RE |
||
224 | .IP "\fBdither_scale\fR" 4 |
||
225 | .IX Item "dither_scale" |
||
226 | Set the dither scale. Default value is 1. |
||
227 | .IP "\fBdither_method\fR" 4 |
||
228 | .IX Item "dither_method" |
||
229 | Set dither method. Default value is 0. |
||
230 | .Sp |
||
231 | Supported values: |
||
232 | .RS 4 |
||
233 | .IP "\fBrectangular\fR" 4 |
||
234 | .IX Item "rectangular" |
||
235 | select rectangular dither |
||
236 | .IP "\fBtriangular\fR" 4 |
||
237 | .IX Item "triangular" |
||
238 | select triangular dither |
||
239 | .IP "\fBtriangular_hp\fR" 4 |
||
240 | .IX Item "triangular_hp" |
||
241 | select triangular dither with high pass |
||
242 | .IP "\fBlipshitz\fR" 4 |
||
243 | .IX Item "lipshitz" |
||
244 | select lipshitz noise shaping dither |
||
245 | .IP "\fBshibata\fR" 4 |
||
246 | .IX Item "shibata" |
||
247 | select shibata noise shaping dither |
||
248 | .IP "\fBlow_shibata\fR" 4 |
||
249 | .IX Item "low_shibata" |
||
250 | select low shibata noise shaping dither |
||
251 | .IP "\fBhigh_shibata\fR" 4 |
||
252 | .IX Item "high_shibata" |
||
253 | select high shibata noise shaping dither |
||
254 | .IP "\fBf_weighted\fR" 4 |
||
255 | .IX Item "f_weighted" |
||
256 | select f\-weighted noise shaping dither |
||
257 | .IP "\fBmodified_e_weighted\fR" 4 |
||
258 | .IX Item "modified_e_weighted" |
||
259 | select modified-e-weighted noise shaping dither |
||
260 | .IP "\fBimproved_e_weighted\fR" 4 |
||
261 | .IX Item "improved_e_weighted" |
||
262 | select improved-e-weighted noise shaping dither |
||
263 | .RE |
||
264 | .RS 4 |
||
265 | .RE |
||
266 | .IP "\fBresampler\fR" 4 |
||
267 | .IX Item "resampler" |
||
268 | Set resampling engine. Default value is swr. |
||
269 | .Sp |
||
270 | Supported values: |
||
271 | .RS 4 |
||
272 | .IP "\fBswr\fR" 4 |
||
273 | .IX Item "swr" |
||
274 | select the native \s-1SW\s0 Resampler; filter options precision and cheby are not |
||
275 | applicable in this case. |
||
276 | .IP "\fBsoxr\fR" 4 |
||
277 | .IX Item "soxr" |
||
278 | select the SoX Resampler (where available); compensation, and filter options |
||
279 | filter_size, phase_shift, filter_type & kaiser_beta, are not applicable in this |
||
280 | case. |
||
281 | .RE |
||
282 | .RS 4 |
||
283 | .RE |
||
284 | .IP "\fBfilter_size\fR" 4 |
||
285 | .IX Item "filter_size" |
||
286 | For swr only, set resampling filter size, default value is 32. |
||
287 | .IP "\fBphase_shift\fR" 4 |
||
288 | .IX Item "phase_shift" |
||
289 | For swr only, set resampling phase shift, default value is 10, and must be in |
||
290 | the interval [0,30]. |
||
291 | .IP "\fBlinear_interp\fR" 4 |
||
292 | .IX Item "linear_interp" |
||
293 | Use Linear Interpolation if set to 1, default value is 0. |
||
294 | .IP "\fBcutoff\fR" 4 |
||
295 | .IX Item "cutoff" |
||
296 | Set cutoff frequency (swr: 6dB point; soxr: 0dB point) ratio; must be a float |
||
297 | value between 0 and 1. Default value is 0.97 with swr, and 0.91 with soxr |
||
298 | (which, with a sample-rate of 44100, preserves the entire audio band to 20kHz). |
||
299 | .IP "\fBprecision\fR" 4 |
||
300 | .IX Item "precision" |
||
301 | For soxr only, the precision in bits to which the resampled signal will be |
||
302 | calculated. The default value of 20 (which, with suitable dithering, is |
||
303 | appropriate for a destination bit-depth of 16) gives SoX's 'High Quality'; a |
||
304 | value of 28 gives SoX's 'Very High Quality'. |
||
305 | .IP "\fBcheby\fR" 4 |
||
306 | .IX Item "cheby" |
||
307 | For soxr only, selects passband rolloff none (Chebyshev) & higher-precision |
||
308 | approximation for 'irrational' ratios. Default value is 0. |
||
309 | .IP "\fBasync\fR" 4 |
||
310 | .IX Item "async" |
||
311 | For swr only, simple 1 parameter audio sync to timestamps using stretching, |
||
312 | squeezing, filling and trimming. Setting this to 1 will enable filling and |
||
313 | trimming, larger values represent the maximum amount in samples that the data |
||
314 | may be stretched or squeezed for each second. |
||
315 | Default value is 0, thus no compensation is applied to make the samples match |
||
316 | the audio timestamps. |
||
317 | .IP "\fBfirst_pts\fR" 4 |
||
318 | .IX Item "first_pts" |
||
319 | For swr only, assume the first pts should be this value. The time unit is 1 / sample rate. |
||
320 | This allows for padding/trimming at the start of stream. By default, no |
||
321 | assumption is made about the first frame's expected pts, so no padding or |
||
322 | trimming is done. For example, this could be set to 0 to pad the beginning with |
||
323 | silence if an audio stream starts after the video stream or to trim any samples |
||
324 | with a negative pts due to encoder delay. |
||
325 | .IP "\fBmin_comp\fR" 4 |
||
326 | .IX Item "min_comp" |
||
327 | For swr only, set the minimum difference between timestamps and audio data (in |
||
328 | seconds) to trigger stretching/squeezing/filling or trimming of the |
||
329 | data to make it match the timestamps. The default is that |
||
330 | stretching/squeezing/filling and trimming is disabled |
||
331 | (\fBmin_comp\fR = \f(CW\*(C`FLT_MAX\*(C'\fR). |
||
332 | .IP "\fBmin_hard_comp\fR" 4 |
||
333 | .IX Item "min_hard_comp" |
||
334 | For swr only, set the minimum difference between timestamps and audio data (in |
||
335 | seconds) to trigger adding/dropping samples to make it match the |
||
336 | timestamps. This option effectively is a threshold to select between |
||
337 | hard (trim/fill) and soft (squeeze/stretch) compensation. Note that |
||
338 | all compensation is by default disabled through \fBmin_comp\fR. |
||
339 | The default is 0.1. |
||
340 | .IP "\fBcomp_duration\fR" 4 |
||
341 | .IX Item "comp_duration" |
||
342 | For swr only, set duration (in seconds) over which data is stretched/squeezed |
||
343 | to make it match the timestamps. Must be a non-negative double float value, |
||
344 | default value is 1.0. |
||
345 | .IP "\fBmax_soft_comp\fR" 4 |
||
346 | .IX Item "max_soft_comp" |
||
347 | For swr only, set maximum factor by which data is stretched/squeezed to make it |
||
348 | match the timestamps. Must be a non-negative double float value, default value |
||
349 | is 0. |
||
350 | .IP "\fBmatrix_encoding\fR" 4 |
||
351 | .IX Item "matrix_encoding" |
||
352 | Select matrixed stereo encoding. |
||
353 | .Sp |
||
354 | It accepts the following values: |
||
355 | .RS 4 |
||
356 | .IP "\fBnone\fR" 4 |
||
357 | .IX Item "none" |
||
358 | select none |
||
359 | .IP "\fBdolby\fR" 4 |
||
360 | .IX Item "dolby" |
||
361 | select Dolby |
||
362 | .IP "\fBdplii\fR" 4 |
||
363 | .IX Item "dplii" |
||
364 | select Dolby Pro Logic \s-1II\s0 |
||
365 | .RE |
||
366 | .RS 4 |
||
367 | .Sp |
||
368 | Default value is \f(CW\*(C`none\*(C'\fR. |
||
369 | .RE |
||
370 | .IP "\fBfilter_type\fR" 4 |
||
371 | .IX Item "filter_type" |
||
372 | For swr only, select resampling filter type. This only affects resampling |
||
373 | operations. |
||
374 | .Sp |
||
375 | It accepts the following values: |
||
376 | .RS 4 |
||
377 | .IP "\fBcubic\fR" 4 |
||
378 | .IX Item "cubic" |
||
379 | select cubic |
||
380 | .IP "\fBblackman_nuttall\fR" 4 |
||
381 | .IX Item "blackman_nuttall" |
||
382 | select Blackman Nuttall Windowed Sinc |
||
383 | .IP "\fBkaiser\fR" 4 |
||
384 | .IX Item "kaiser" |
||
385 | select Kaiser Windowed Sinc |
||
386 | .RE |
||
387 | .RS 4 |
||
388 | .RE |
||
389 | .IP "\fBkaiser_beta\fR" 4 |
||
390 | .IX Item "kaiser_beta" |
||
391 | For swr only, set Kaiser Window Beta value. Must be an integer in the |
||
392 | interval [2,16], default value is 9. |
||
393 | .IP "\fBoutput_sample_bits\fR" 4 |
||
394 | .IX Item "output_sample_bits" |
||
395 | For swr only, set number of used output sample bits for dithering. Must be an integer in the |
||
396 | interval [0,64], default value is 0, which means it's not used. |
||
397 | .SH "SEE ALSO" |
||
398 | .IX Header "SEE ALSO" |
||
399 | \&\fIffmpeg\fR\|(1), \fIffplay\fR\|(1), \fIffprobe\fR\|(1), \fIffserver\fR\|(1), \fIlibswresample\fR\|(3) |
||
400 | .SH "AUTHORS" |
||
401 | .IX Header "AUTHORS" |
||
402 | The FFmpeg developers. |
||
403 | .PP |
||
404 | For details about the authorship, see the Git history of the project |
||
405 | (git://source.ffmpeg.org/ffmpeg), e.g. by typing the command |
||
406 | \&\fBgit log\fR in the FFmpeg source directory, or browsing the |
||
407 | online repository at <\fBhttp://source.ffmpeg.org\fR>. |
||
408 | .PP |
||
409 | Maintainers for the specific components are listed in the file |
||
410 | \&\fI\s-1MAINTAINERS\s0\fR in the source code tree.\fBhttp://source.ffmpeg.org\fR>>> |