Merge commit 'a2fc8dbae85339d1b418d296f2982b6c04c53c57'
[ffmpeg.git] / doc / libavfilter.texi
index f8189f1..d9472eb 100644 (file)
@@ -1,87 +1,45 @@
 \input texinfo @c -*- texinfo -*-
+@documentencoding UTF-8
 
 @settitle Libavfilter Documentation
 @titlepage
-@sp 7
 @center @titlefont{Libavfilter Documentation}
-@sp 3
 @end titlepage
 
+@top
 
-@chapter Introduction
+@contents
 
-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.
+@chapter Description
+@c man begin DESCRIPTION
 
-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:
+The libavfilter library provides a generic audio/video filtering
+framework containing several filters, sources and sinks.
 
-@example
-   svn checkout svn://svn.ffmpeg.org/soc/libavfilter
-@end example
+@c man end DESCRIPTION
 
-And then read the README file in the top directory to learn how to
-integrate it into ffmpeg and ffplay.
+@chapter See Also
 
-But note that there may still be serious bugs in the code and its API
-and ABI should not be considered stable yet!
+@ifhtml
+@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe},
+@url{ffmpeg-filters.html,ffmpeg-filters},
+@url{libavutil.html,libavutil}, @url{libswscale.html,libswscale}, @url{libswresample.html,libswresample},
+@url{libavcodec.html,libavcodec}, @url{libavformat.html,libavformat}, @url{libavdevice.html,libavdevice}
+@end ifhtml
 
-@chapter Tutorial
+@ifnothtml
+ffmpeg(1), ffplay(1), ffprobe(1),
+ffmpeg-filters(1),
+libavutil(3), libswscale(3), libswresample(3), libavcodec(3), libavformat(3), libavdevice(3)
+@end ifnothtml
 
-In libavfilter, it is possible for filters to have multiple inputs and
-multiple outputs.
-To illustrate the sorts of things that are possible, we can
-use a complex filter graph. For example, the following one:
+@include authors.texi
 
-@example
-input --> split --> fifo -----------------------> overlay --> output
-            |                                        ^
-            |                                        |
-            +------> fifo --> crop --> vflip --------+
-@end example
+@ignore
 
-splits the stream in two streams, sends one stream through the crop filter
-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:
+@setfilename libavfilter
+@settitle multimedia filtering library
 
-@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]
-@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
-onto the bottom half.
-
-Video filters are loaded using the @var{-vfilters} 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
-the linear chains join are labeled by names enclosed in square
-brackets. In our example, that is @var{[T1]} and @var{[T2]}. The magic
-labels @var{[in]} and @var{[out]} are the points where video is input
-and output.
-
-Some filters take in input a list of parameters: they are specified
-after the filter name and an equal sign, and are separated each other
-by a semicolon.
-
-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
-
-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.
-
-Below is a description of the currently available video filters.
-
-@section null
-
-Pass the source unchanged to the output.
+@end ignore
 
 @bye