]> git.sesse.net Git - ffmpeg/blobdiff - doc/libavfilter.texi
DCA: optimise dca_subsubframe()
[ffmpeg] / doc / libavfilter.texi
index 9efeba2f68ca063b7b4d705e85f19fa3fa9f77b1..3aeded9524036dd43fe0edf5c6cd147d154f0d86 100644 (file)
@@ -71,6 +71,34 @@ There exist so-called @var{source filters} that do not have a video
 input, and we expect in the future some @var{sink filters} that will
 not have video output.
 
+@chapter graph2dot
+
+The @file{graph2dot} program included in the FFmpeg @file{tools}
+directory can be used to parse a filter graph description and issue a
+corresponding textual representation in the dot language.
+
+Invoke the command:
+@example
+graph2dot -h
+@end example
+
+to see how to use @file{graph2dot}.
+
+You can then pass the dot description to the @file{dot} program (from
+the graphviz suite of programs) and obtain a graphical representation
+of the filter graph.
+
+For example the sequence of commands:
+@example
+echo @var{GRAPH_DESCRIPTION} | \
+tools/graph2dot -o graph.tmp && \
+dot -Tpng graph.tmp -o graph.png && \
+display graph.png
+@end example
+
+can be used to create and display an image representing the graph
+described by the @var{GRAPH_DESCRIPTION} string.
+
 @chapter Available video filters
 
 When you configure your FFmpeg build, you can disable any of the
@@ -149,6 +177,99 @@ input to the vflip filter.
 
 Pass the source unchanged to the output.
 
+@section scale
+
+Scale the input video to width:height and/or convert the image format.
+
+For example the command:
+
+@example
+./ffmpeg -i in.avi -vfilters "scale=200:100" out.avi
+@end example
+
+will scale the input video to a size of 200x100.
+
+If the input image format is different from the format requested by
+the next filter, the scale filter will convert the input to the
+requested format.
+
+If the value for ``width'' or ``height'' is 0, the respective input
+size is used for the output.
+
+If the value for ``width'' or ``height'' is -1, the scale filter will
+use, for the respective output size, a value that maintains the aspect
+ratio of the input image.
+
+The default value of ``width'' and ``height'' is 0.
+
+@section slicify
+
+Pass the images of input video on to next video filter as multiple
+slices.
+
+@example
+./ffmpeg -i in.avi -vfilters "slicify=32" out.avi
+@end example
+
+The filter accepts the slice height as parameter. If the parameter is
+not specified it will use the default value of 16.
+
+Adding this in the beginning of filter chains should make filtering
+faster due to better use of the memory cache.
+
+@section unsharp
+
+Sharpen or blur the input video. It accepts the following parameters:
+
+@multitable @columnfractions .2 .5 .1 .1 .1
+@headitem Name @tab Description @tab Min @tab Max @tab Default
+@item @var{luma_msize_x}
+@tab Luma matrix horizontal size
+@tab 3
+@tab 13
+@tab 5
+@item @var{luma_msize_y}
+@tab Luma matrix vertical size
+@tab 3
+@tab 13
+@tab 5
+@item @var{luma_amount}
+@tab Luma effect strength
+@tab -2.0
+@tab 5.0
+@tab 1.0
+@item @var{chroma_msize_x}
+@tab Chroma matrix horizontal size
+@tab 3
+@tab 13
+@tab 0
+@item @var{chroma_msize_y}
+@tab Chroma matrix vertical size
+@tab 3
+@tab 13
+@tab 0
+@item @var{chroma_amount}
+@tab Chroma effect strength
+@tab -2.0
+@tab 5.0
+@tab 0.0
+@end multitable
+
+Negative values for the amount will blur the input video, while positive
+values will sharpen. All parameters are optional and default to the
+equivalent of the string '5:5:1.0:0:0:0.0'.
+
+@example
+# Strong luma sharpen effect parameters
+unsharp=7:7:2.5
+
+# Strong blur of both luma and chroma parameters
+unsharp=7:7:-2:7:7:-2
+
+# Use the default values with @command{ffmpeg}
+./ffmpeg -i in.avi -vfilters "unsharp" out.mp4
+@end example
+
 @section vflip
 
 Flip the input video vertically.
@@ -157,4 +278,30 @@ Flip the input video vertically.
 ./ffmpeg -i in.avi -vfilters "vflip" out.avi
 @end example
 
+@chapter Available video sources
+
+Below is a description of the currently available video sources.
+
+@section nullsrc
+
+Null video source, never return images. It is mainly useful as a
+template and to be employed in analysis / debugging tools.
+
+It accepts as optional parameter a string of the form
+``width:height'', where ``width'' and ``height'' specify the size of
+the configured source.
+
+The default values of ``width'' and ``height'' are respectively 352
+and 288 (corresponding to the CIF size format).
+
+@chapter Available video sinks
+
+Below is a description of the currently available video sinks.
+
+@section nullsink
+
+Null video sink, do absolutely nothing with the input video. It is
+mainly useful as a template and to be employed in analysis / debugging
+tools.
+
 @bye