cosmetics: Move MPEG-4 decoding functions around to avoid forward declarations.
[ffmpeg.git] / doc / libavfilter.texi
index f8189f1..0e473fd 100644 (file)
@@ -80,8 +80,121 @@ build.
 
 Below is a description of the currently available video filters.
 
+@section crop
+
+Crop the input video to x:y:width:height.
+
+@example
+./ffmpeg -i in.avi -vfilters "crop=0:0:0:240" out.avi
+@end example
+
+``x'' and ``y'' specify the position of the top-left corner of the
+output (non-cropped) area.
+
+The default value of ``x'' and ``y'' is 0.
+
+The ``width'' and ``height'' parameters specify the width and height
+of the output (non-cropped) area.
+
+A value of 0 is interpreted as the maximum possible size contained in
+the area delimited by the top-left corner at position x:y.
+
+For example the parameters:
+
+@example
+"crop=100:100:0:0"
+@end example
+
+will delimit the rectangle with the top-left corner placed at position
+100:100 and the right-bottom corner corresponding to the right-bottom
+corner of the input image.
+
+The default value of ``width'' and ``height'' is 0.
+
+@section format
+
+Convert the input video to one of the specified pixel formats.
+Libavfilter will try to pick one that is supported for the input to
+the next filter.
+
+The filter accepts a list of pixel format names, separated by ``:'',
+for example ``yuv420p:monow:rgb24''.
+
+The following command:
+
+@example
+./ffmpeg -i in.avi -vfilters "format=yuv420p" out.avi
+@end example
+
+will convert the input video to the format ``yuv420p''.
+
+@section noformat
+
+Force libavfilter not to use any of the specified pixel formats for the
+input to the next filter.
+
+The filter accepts a list of pixel format names, separated by ``:'',
+for example ``yuv420p:monow:rgb24''.
+
+The following command:
+
+@example
+./ffmpeg -i in.avi -vfilters "noformat=yuv420p, vflip" out.avi
+@end example
+
+will make libavfilter use a format different from ``yuv420p'' for the
+input to the vflip filter.
+
 @section null
 
 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 vflip
+
+Flip the input video vertically.
+
+@example
+./ffmpeg -i in.avi -vfilters "vflip" out.avi
+@end example
+
 @bye