Move settb docs after setpts docs, fix alphabetical order.
[ffmpeg.git] / doc / filters.texi
1 @chapter Audio Filters
2 @c man begin AUDIO FILTERS
3
4 When you configure your FFmpeg build, you can disable any of the
5 existing filters using --disable-filters.
6 The configure output will show the audio filters included in your
7 build.
8
9 Below is a description of the currently available audio filters.
10
11 @section anull
12
13 Pass the audio source unchanged to the output.
14
15 @c man end AUDIO FILTERS
16
17 @chapter Audio Sources
18 @c man begin AUDIO SOURCES
19
20 Below is a description of the currently available audio sources.
21
22 @section anullsrc
23
24 Null audio source, never return audio frames. It is mainly useful as a
25 template and to be employed in analysis / debugging tools.
26
27 It accepts as optional parameter a string of the form
28 @var{sample_rate}:@var{channel_layout}.
29
30 @var{sample_rate} specify the sample rate, and defaults to 44100.
31
32 @var{channel_layout} specify the channel layout, and can be either an
33 integer or a string representing a channel layout. The default value
34 of @var{channel_layout} is 3, which corresponds to CH_LAYOUT_STEREO.
35
36 Check the channel_layout_map definition in
37 @file{libavcodec/audioconvert.c} for the mapping between strings and
38 channel layout values.
39
40 Follow some examples:
41 @example
42 #  set the sample rate to 48000 Hz and the channel layout to CH_LAYOUT_MONO.
43 anullsrc=48000:4
44
45 # same as
46 anullsrc=48000:mono
47 @end example
48
49 @c man end AUDIO SOURCES
50
51 @chapter Audio Sinks
52 @c man begin AUDIO SINKS
53
54 Below is a description of the currently available audio sinks.
55
56 @section anullsink
57
58 Null audio sink, do absolutely nothing with the input audio. It is
59 mainly useful as a template and to be employed in analysis / debugging
60 tools.
61
62 @c man end AUDIO SINKS
63
64 @chapter Video Filters
65 @c man begin VIDEO FILTERS
66
67 When you configure your FFmpeg build, you can disable any of the
68 existing filters using --disable-filters.
69 The configure output will show the video filters included in your
70 build.
71
72 Below is a description of the currently available video filters.
73
74 @section blackframe
75
76 Detect frames that are (almost) completely black. Can be useful to
77 detect chapter transitions or commercials. Output lines consist of
78 the frame number of the detected frame, the percentage of blackness,
79 the position in the file if known or -1 and the timestamp in seconds.
80
81 In order to display the output lines, you need to set the loglevel at
82 least to the AV_LOG_INFO value.
83
84 The filter accepts the syntax:
85 @example
86 blackframe[=@var{amount}:[@var{threshold}]]
87 @end example
88
89 @var{amount} is the percentage of the pixels that have to be below the
90 threshold, and defaults to 98.
91
92 @var{threshold} is the threshold below which a pixel value is
93 considered black, and defaults to 32.
94
95 @section crop
96
97 Crop the input video to @var{out_w}:@var{out_h}:@var{x}:@var{y}.
98
99 The parameters are expressions containing the following constants:
100
101 @table @option
102 @item E, PI, PHI
103 the corresponding mathematical approximated values for e
104 (euler number), pi (greek PI), PHI (golden ratio)
105
106 @item x, y
107 the computed values for @var{x} and @var{y}. They are evaluated for
108 each new frame.
109
110 @item in_w, in_h
111 the input width and heigth
112
113 @item iw, ih
114 same as @var{in_w} and @var{in_h}
115
116 @item out_w, out_h
117 the output (cropped) width and heigth
118
119 @item ow, oh
120 same as @var{out_w} and @var{out_h}
121
122 @item n
123 the number of input frame, starting from 0
124
125 @item pos
126 the position in the file of the input frame, NAN if unknown
127
128 @item t
129 timestamp expressed in seconds, NAN if the input timestamp is unknown
130
131 @end table
132
133 The @var{out_w} and @var{out_h} parameters specify the expressions for
134 the width and height of the output (cropped) video. They are
135 evaluated just at the configuration of the filter.
136
137 The default value of @var{out_w} is "in_w", and the default value of
138 @var{out_h} is "in_h".
139
140 The expression for @var{out_w} may depend on the value of @var{out_h},
141 and the expression for @var{out_h} may depend on @var{out_w}, but they
142 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
143 evaluated after @var{out_w} and @var{out_h}.
144
145 The @var{x} and @var{y} parameters specify the expressions for the
146 position of the top-left corner of the output (non-cropped) area. They
147 are evaluated for each frame. If the evaluated value is not valid, it
148 is approximated to the nearest valid value.
149
150 The default value of @var{x} is "(in_w-out_w)/2", and the default
151 value for @var{y} is "(in_h-out_h)/2", which set the cropped area at
152 the center of the input image.
153
154 The expression for @var{x} may depend on @var{y}, and the expression
155 for @var{y} may depend on @var{x}.
156
157 Follow some examples:
158 @example
159 # crop the central input area with size 100x100
160 crop=100:100
161
162 # crop the central input area with size 2/3 of the input video
163 "crop=2/3*in_w:2/3*in_h"
164
165 # crop the input video central square
166 crop=in_h
167
168 # delimit the rectangle with the top-left corner placed at position
169 # 100:100 and the right-bottom corner corresponding to the right-bottom
170 # corner of the input image.
171 crop=in_w-100:in_h-100:100:100
172
173 # crop 10 pixels from the lefth and right borders, and 20 pixels from
174 # the top and bottom borders
175 "crop=in_w-2*10:in_h-2*20"
176
177 # keep only the bottom right quarter of the input image
178 "crop=in_w/2:in_h/2:in_w/2:in_h/2"
179
180 # crop height for getting Greek harmony
181 "crop=in_w:1/PHI*in_w"
182
183 # trembling effect
184 "crop=in_w/2:in_h/2:(in_w-out_w)/2+((in_w-out_w)/2)*sin(n/10):(in_h-out_h)/2 +((in_h-out_h)/2)*sin(n/7)"
185
186 # erratic camera effect depending on timestamp and position
187 "crop=in_w/2:in_h/2:(in_w-out_w)/2+((in_w-out_w)/2)*sin(t*10):(in_h-out_h)/2 +((in_h-out_h)/2)*sin(t*13)"
188
189 # set x depending on the value of y
190 "crop=in_w/2:in_h/2:y:10+10*sin(n/10)"
191 @end example
192
193 @section cropdetect
194
195 Auto-detect crop size.
196
197 Calculate necessary cropping parameters and prints the recommended
198 parameters through the logging system. The detected dimensions
199 correspond to the non-black area of the input video.
200
201 It accepts the syntax:
202 @example
203 cropdetect[=@var{limit}[:@var{round}[:@var{reset}]]]
204 @end example
205
206 @table @option
207
208 @item limit
209 Threshold, which can be optionally specified from nothing (0) to
210 everything (255), defaults to 24.
211
212 @item round
213 Value which the width/height should be divisible by, defaults to
214 16. The offset is automatically adjusted to center the video. Use 2 to
215 get only even dimensions (needed for 4:2:2 video). 16 is best when
216 encoding to most video codecs.
217
218 @item reset
219 Counter that determines after how many frames cropdetect will reset
220 the previously detected largest video area and start over to detect
221 the current optimal crop area. Defaults to 0.
222
223 This can be useful when channel logos distort the video area. 0
224 indicates never reset and return the largest area encountered during
225 playback.
226 @end table
227
228 @section drawbox
229
230 Draw a colored box on the input image.
231
232 It accepts the syntax:
233 @example
234 drawbox=@var{x}:@var{y}:@var{width}:@var{height}:@var{color}
235 @end example
236
237 @table @option
238
239 @item x, y
240 Specify the top left corner coordinates of the box. Default to 0.
241
242 @item width, height
243 Specify the width and height of the box, if 0 they are interpreted as
244 the input width and height. Default to 0.
245
246 @item color
247 Specify the color of the box to write, it can be the name of a color
248 (case insensitive match) or a 0xRRGGBB[AA] sequence.
249 @end table
250
251 Follow some examples:
252 @example
253 # draw a black box around the edge of the input image
254 drawbox
255
256 # draw a box with color red and an opacity of 50%
257 drawbox=10:20:200:60:red@@0.5"
258 @end example
259
260 @section fifo
261
262 Buffer input images and send them when they are requested.
263
264 This filter is mainly useful when auto-inserted by the libavfilter
265 framework.
266
267 The filter does not take parameters.
268
269 @section format
270
271 Convert the input video to one of the specified pixel formats.
272 Libavfilter will try to pick one that is supported for the input to
273 the next filter.
274
275 The filter accepts a list of pixel format names, separated by ":",
276 for example "yuv420p:monow:rgb24".
277
278 The following command:
279
280 @example
281 ./ffmpeg -i in.avi -vf "format=yuv420p" out.avi
282 @end example
283
284 will convert the input video to the format "yuv420p".
285
286 @section frei0r
287
288 Apply a frei0r effect to the input video.
289
290 To enable compilation of this filter you need to install the frei0r
291 header and configure FFmpeg with --enable-frei0r.
292
293 The filter supports the syntax:
294 @example
295 @var{filter_name}:@var{param1}:@var{param2}:...:@var{paramN}
296 @end example
297
298 @var{filter_name} is the name to the frei0r effect to load. If the
299 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
300 is searched in each one of the directories specified by the colon
301 separated list in @env{FREIOR_PATH}, otherwise in the standard frei0r
302 paths, which are in this order: @file{HOME/.frei0r-1/lib/},
303 @file{/usr/local/lib/frei0r-1/}, @file{/usr/lib/frei0r-1/}.
304
305 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
306 for the frei0r effect.
307
308 A frei0r effect parameter can be a boolean (whose values are specified
309 with "y" and "n"), a double, a color (specified by the syntax
310 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
311 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
312 description), a position (specified by the syntax @var{X}/@var{Y},
313 @var{X} and @var{Y} being float numbers) and a string.
314
315 The number and kind of parameters depend on the loaded effect. If an
316 effect parameter is not specified the default value is set.
317
318 Some examples follow:
319 @example
320 # apply the distort0r effect, set the first two double parameters
321 frei0r=distort0r:0.5:0.01
322
323 # apply the colordistance effect, takes a color as first parameter
324 frei0r=colordistance:0.2/0.3/0.4
325 frei0r=colordistance:violet
326 frei0r=colordistance:0x112233
327
328 # apply the perspective effect, specify the top left and top right
329 # image positions
330 frei0r=perspective:0.2/0.2:0.8/0.2
331 @end example
332
333 For more information see:
334 @url{http://piksel.org/frei0r}
335
336 @section hflip
337
338 Flip the input video horizontally.
339
340 For example to horizontally flip the video in input with
341 @file{ffmpeg}:
342 @example
343 ffmpeg -i in.avi -vf "hflip" out.avi
344 @end example
345
346 @section noformat
347
348 Force libavfilter not to use any of the specified pixel formats for the
349 input to the next filter.
350
351 The filter accepts a list of pixel format names, separated by ":",
352 for example "yuv420p:monow:rgb24".
353
354 The following command:
355
356 @example
357 ./ffmpeg -i in.avi -vf "noformat=yuv420p, vflip" out.avi
358 @end example
359
360 will make libavfilter use a format different from "yuv420p" for the
361 input to the vflip filter.
362
363 @section null
364
365 Pass the video source unchanged to the output.
366
367 @section ocv_smooth
368
369 Apply smooth transform using libopencv.
370
371 To enable this filter install libopencv library and headers and
372 configure FFmpeg with --enable-libopencv.
373
374 The filter accepts the following parameters:
375 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
376
377 @var{type} is the type of smooth filter to apply, and can be one of
378 the following values: "blur", "blur_no_scale", "median", "gaussian",
379 "bilateral". The default value is "gaussian".
380
381 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
382 parameters whose meanings depend on smooth type. @var{param1} and
383 @var{param2} accept integer positive values or 0, @var{param3} and
384 @var{param4} accept float values.
385
386 The default value for @var{param1} is 3, the default value for the
387 other parameters is 0.
388
389 These parameters correspond to the parameters assigned to the
390 libopencv function @code{cvSmooth}. Refer to the official libopencv
391 documentation for the exact meaning of the parameters:
392 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
393
394 @section pad
395
396 Add paddings to the input image, and places the original input at the
397 given coordinates @var{x}, @var{y}.
398
399 It accepts the following parameters:
400 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
401
402 Follows the description of the accepted parameters.
403
404 @table @option
405 @item width, height
406
407 Specify the size of the output image with the paddings added. If the
408 value for @var{width} or @var{height} is 0, the corresponding input size
409 is used for the output.
410
411 The default value of @var{width} and @var{height} is 0.
412
413 @item x, y
414
415 Specify the offsets where to place the input image in the padded area
416 with respect to the top/left border of the output image.
417
418 The default value of @var{x} and @var{y} is 0.
419
420 @item color
421
422 Specify the color of the padded area, it can be the name of a color
423 (case insensitive match) or a 0xRRGGBB[AA] sequence.
424
425 The default value of @var{color} is "black".
426
427 @end table
428
429 For example:
430
431 @example
432 # Add paddings with color "violet" to the input video. Output video
433 # size is 640x480, the top-left corner of the input video is placed at
434 # row 0, column 40.
435 pad=640:480:0:40:violet
436 @end example
437
438 @section pixdesctest
439
440 Pixel format descriptor test filter, mainly useful for internal
441 testing. The output video should be equal to the input video.
442
443 For example:
444 @example
445 format=monow, pixdesctest
446 @end example
447
448 can be used to test the monowhite pixel format descriptor definition.
449
450 @section scale
451
452 Scale the input video to @var{width}:@var{height} and/or convert the image format.
453
454 For example the command:
455
456 @example
457 ./ffmpeg -i in.avi -vf "scale=200:100" out.avi
458 @end example
459
460 will scale the input video to a size of 200x100.
461
462 If the input image format is different from the format requested by
463 the next filter, the scale filter will convert the input to the
464 requested format.
465
466 If the value for @var{width} or @var{height} is 0, the respective input
467 size is used for the output.
468
469 If the value for @var{width} or @var{height} is -1, the scale filter will
470 use, for the respective output size, a value that maintains the aspect
471 ratio of the input image.
472
473 The default value of @var{width} and @var{height} is 0.
474
475 @section setpts
476
477 Change the PTS (presentation timestamp) of the input video frames.
478
479 Accept in input an expression evaluated through the eval API, which
480 can contain the following constants:
481
482 @table @option
483 @item PTS
484 the presentation timestamp in input
485
486 @item PI
487 Greek PI
488
489 @item PHI
490 golden ratio
491
492 @item E
493 Euler number
494
495 @item N
496 the count of the input frame, starting from 0.
497
498 @item STARTPTS
499 the PTS of the first video frame
500
501 @item INTERLACED
502 tell if the current frame is interlaced
503
504 @item POS
505 original position in the file of the frame, or undefined if undefined
506 for the current frame
507
508 @item PREV_INPTS
509 previous input PTS
510
511 @item PREV_OUTPTS
512 previous output PTS
513
514 @end table
515
516 Some examples follow:
517
518 @example
519 # start counting PTS from zero
520 setpts=PTS-STARTPTS
521
522 # fast motion
523 setpts=0.5*PTS
524
525 # slow motion
526 setpts=2.0*PTS
527
528 # fixed rate 25 fps
529 setpts=N/(25*TB)
530
531 # fixed rate 25 fps with some jitter
532 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
533 @end example
534
535 @section settb
536
537 Set the timebase to use for the output frames timestamps.
538 It is mainly useful for testing timebase configuration.
539
540 It accepts in input an arithmetic expression representing a rational.
541 The expression can contain the constants "PI", "E", "PHI", "AVTB" (the
542 default timebase), and "intb" (the input timebase).
543
544 The default value for the input is "intb".
545
546 Follow some examples.
547
548 @example
549 # set the timebase to 1/25
550 settb=1/25
551
552 # set the timebase to 1/10
553 settb=0.1
554
555 #set the timebase to 1001/1000
556 settb=1+0.001
557
558 #set the timebase to 2*intb
559 settb=2*intb
560
561 #set the default timebase value
562 settb=AVTB
563 @end example
564
565 @section slicify
566
567 Pass the images of input video on to next video filter as multiple
568 slices.
569
570 @example
571 ./ffmpeg -i in.avi -vf "slicify=32" out.avi
572 @end example
573
574 The filter accepts the slice height as parameter. If the parameter is
575 not specified it will use the default value of 16.
576
577 Adding this in the beginning of filter chains should make filtering
578 faster due to better use of the memory cache.
579
580 @section transpose
581
582 Transpose rows with columns in the input video and optionally flip it.
583
584 It accepts a parameter representing an integer, which can assume the
585 values:
586
587 @table @samp
588 @item 0
589 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
590 @example
591 L.R     L.l
592 . . ->  . .
593 l.r     R.r
594 @end example
595
596 @item 1
597 Rotate by 90 degrees clockwise, that is:
598 @example
599 L.R     l.L
600 . . ->  . .
601 l.r     r.R
602 @end example
603
604 @item 2
605 Rotate by 90 degrees counterclockwise, that is:
606 @example
607 L.R     R.r
608 . . ->  . .
609 l.r     L.l
610 @end example
611
612 @item 3
613 Rotate by 90 degrees clockwise and vertically flip, that is:
614 @example
615 L.R     r.R
616 . . ->  . .
617 l.r     l.L
618 @end example
619 @end table
620
621 @section unsharp
622
623 Sharpen or blur the input video.
624
625 It accepts the following parameters:
626 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
627
628 Negative values for the amount will blur the input video, while positive
629 values will sharpen. All parameters are optional and default to the
630 equivalent of the string '5:5:1.0:0:0:0.0'.
631
632 @table @option
633
634 @item luma_msize_x
635 Set the luma matrix horizontal size. It can be an integer between 3
636 and 13, default value is 5.
637
638 @item luma_msize_y
639 Set the luma matrix vertical size. It can be an integer between 3
640 and 13, default value is 5.
641
642 @item luma_amount
643 Set the luma effect strength. It can be a float number between -2.0
644 and 5.0, default value is 1.0.
645
646 @item chroma_msize_x
647 Set the chroma matrix horizontal size. It can be an integer between 3
648 and 13, default value is 0.
649
650 @item chroma_msize_y
651 Set the chroma matrix vertical size. It can be an integer between 3
652 and 13, default value is 0.
653
654 @item luma_amount
655 Set the chroma effect strength. It can be a float number between -2.0
656 and 5.0, default value is 0.0.
657
658 @end table
659
660 @example
661 # Strong luma sharpen effect parameters
662 unsharp=7:7:2.5
663
664 # Strong blur of both luma and chroma parameters
665 unsharp=7:7:-2:7:7:-2
666
667 # Use the default values with @command{ffmpeg}
668 ./ffmpeg -i in.avi -vf "unsharp" out.mp4
669 @end example
670
671 @section vflip
672
673 Flip the input video vertically.
674
675 @example
676 ./ffmpeg -i in.avi -vf "vflip" out.avi
677 @end example
678
679 @section yadif
680
681 yadif is "yet another deinterlacing filter".
682
683 It accepts the syntax:
684 @example
685 yadif=[@var{mode}[:@var{parity}]]
686 @end example
687
688 @table @option
689
690 @item mode
691 Specify the interlacing mode to adopt, accepts one of the following values.
692
693 0: Output 1 frame for each frame.
694
695 1: Output 1 frame for each field.
696
697 2: Like 0 but skips spatial interlacing check.
698
699 3: Like 1 but skips spatial interlacing check.
700
701 Default value is 0.
702
703 @item parity
704 0 if is bottom field first, 1 if the interlaced video is top field
705 first, -1 to enable automatic detection.
706
707 @end table
708
709 @c man end VIDEO FILTERS
710
711 @chapter Video Sources
712 @c man begin VIDEO SOURCES
713
714 Below is a description of the currently available video sources.
715
716 @section buffer
717
718 Buffer video frames, and make them available to the filter chain.
719
720 This source is mainly intended for a programmatic use, in particular
721 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
722
723 It accepts the following parameters:
724 @var{width}:@var{height}:@var{pix_fmt_string}:@var{timebase_num}:@var{timebase_den}
725
726 All the parameters need to be explicitely defined.
727
728 Follows the list of the accepted parameters.
729
730 @table @option
731
732 @item width, height
733 Specify the width and height of the buffered video frames.
734
735 @item pix_fmt_string
736 A string representing the pixel format of the buffered video frames.
737 It may be a number corresponding to a pixel format, or a pixel format
738 name.
739
740 @item timebase_num, timebase_den
741 Specify numerator and denomitor of the timebase assumed by the
742 timestamps of the buffered frames.
743 @end table
744
745 For example:
746 @example
747 buffer=320:240:yuv410p:1:24
748 @end example
749
750 will instruct the source to accept video frames with size 320x240 and
751 with format "yuv410p" and assuming 1/24 as the timestamps timebase.
752 Since the pixel format with name "yuv410p" corresponds to the number 6
753 (check the enum PixelFormat definition in @file{libavutil/pixfmt.h}),
754 this example corresponds to:
755 @example
756 buffer=320:240:6:1:24
757 @end example
758
759 @section color
760
761 Provide an uniformly colored input.
762
763 It accepts the following parameters:
764 @var{color}:@var{frame_size}:@var{frame_rate}
765
766 Follows the description of the accepted parameters.
767
768 @table @option
769
770 @item color
771 Specify the color of the source. It can be the name of a color (case
772 insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an
773 alpha specifier. The default value is "black".
774
775 @item frame_size
776 Specify the size of the sourced video, it may be a string of the form
777 @var{width}x@var{heigth}, or the name of a size abbreviation. The
778 default value is "320x240".
779
780 @item frame_rate
781 Specify the frame rate of the sourced video, as the number of frames
782 generated per second. It has to be a string in the format
783 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
784 number or a valid video frame rate abbreviation. The default value is
785 "25".
786
787 @end table
788
789 For example the following graph description will generate a red source
790 with an opacity of 0.2, with size "qcif" and a frame rate of 10
791 frames per second, which will be overlayed over the source connected
792 to the pad with identifier "in".
793
794 @example
795 "color=red@@0.2:qcif:10 [color]; [in][color] overlay [out]"
796 @end example
797
798 @section nullsrc
799
800 Null video source, never return images. It is mainly useful as a
801 template and to be employed in analysis / debugging tools.
802
803 It accepts as optional parameter a string of the form
804 @var{width}:@var{height}:@var{timebase}.
805
806 @var{width} and @var{height} specify the size of the configured
807 source. The default values of @var{width} and @var{height} are
808 respectively 352 and 288 (corresponding to the CIF size format).
809
810 @var{timebase} specifies an arithmetic expression representing a
811 timebase. The expression can contain the constants "PI", "E", "PHI",
812 "AVTB" (the default timebase), and defaults to the value "AVTB".
813
814 @c man end VIDEO SOURCES
815
816 @chapter Video Sinks
817 @c man begin VIDEO SINKS
818
819 Below is a description of the currently available video sinks.
820
821 @section nullsink
822
823 Null video sink, do absolutely nothing with the input video. It is
824 mainly useful as a template and to be employed in analysis / debugging
825 tools.
826
827 @c man end VIDEO SINKS
828