platform.texi: close @enumerate section in the "Using shared libraries" subsection
[ffmpeg.git] / doc / libavfilter.texi
index f8189f1..de5baa8 100644 (file)
@@ -2,31 +2,20 @@
 
 @settitle Libavfilter Documentation
 @titlepage
-@sp 7
 @center @titlefont{Libavfilter Documentation}
-@sp 3
 @end titlepage
 
+@top
+
+@contents
 
 @chapter Introduction
 
 Libavfilter is the filtering API of FFmpeg. It is the substitute of the
 now deprecated 'vhooks' and started as a Google Summer of Code project.
 
-Integrating libavfilter into the main FFmpeg repository is a work in
-progress. If you wish to try the unfinished development code of
-libavfilter then check it out from the libavfilter repository into
-some directory of your choice by:
-
-@example
-   svn checkout svn://svn.ffmpeg.org/soc/libavfilter
-@end example
-
-And then read the README file in the top directory to learn how to
-integrate it into ffmpeg and ffplay.
-
-But note that there may still be serious bugs in the code and its API
-and ABI should not be considered stable yet!
+Audio filtering integration into the main FFmpeg repository is a work in
+progress, so audio API and ABI should not be considered stable yet.
 
 @chapter Tutorial
 
@@ -47,14 +36,13 @@ and the vflip filter before merging it back with the other stream by
 overlaying it on top. You can use the following command to achieve this:
 
 @example
-./ffmpeg -i in.avi -s 240x320 -vfilters "[in] split [T1], fifo, [T2] overlay= 0:240 [out]; [T1] fifo, crop=0:0:-1:240, vflip [T2]
+ffmpeg -i input -vf "[in] split [T1], fifo, [T2] overlay=0:H/2 [out]; [T1] fifo, crop=iw:ih/2:0:ih/2, vflip [T2]" output
 @end example
 
-where input_video.avi has a vertical resolution of 480 pixels. The
-result will be that in output the top half of the video is mirrored
+The result will be that in output the top half of the video is mirrored
 onto the bottom half.
 
-Video filters are loaded using the @var{-vfilters} option passed to
+Video filters are loaded using the @var{-vf} option passed to
 ffmpeg or to ffplay. Filters in the same linear chain are separated by
 commas. In our example, @var{split, fifo, overlay} are in one linear
 chain, and @var{fifo, crop, vflip} are in another. The points where
@@ -71,17 +59,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 Available video filters
+@chapter graph2dot
 
-When you configure your FFmpeg build, you can disable any of the
-existing video filters.
-The configure output will show the video filters included in your
-build.
+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.
 
-Below is a description of the currently available video filters.
+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
 
-@section null
+can be used to create and display an image representing the graph
+described by the @var{GRAPH_DESCRIPTION} string.
 
-Pass the source unchanged to the output.
+@include filters.texi
 
 @bye