mirror of
https://github.com/FFmpeg/FFmpeg.git
synced 2024-12-23 12:43:46 +02:00
doc: Libavfilter English cleanup
This aims to standardize the English used in the libavfilter documentation, describing the same thing in the same way more often, and significantly reduce the amount of outright errors, including run-on sentences and sentence fragments. Signed-off-by: Luca Barbato <lu_zero@gentoo.org>
This commit is contained in:
parent
617a1a98a6
commit
d4a8a86c68
1240
doc/filters.texi
1240
doc/filters.texi
File diff suppressed because it is too large
Load Diff
@ -11,10 +11,10 @@
|
|||||||
|
|
||||||
@chapter Introduction
|
@chapter Introduction
|
||||||
|
|
||||||
Libavfilter is the filtering API of Libav. It is the substitute of the
|
Libavfilter is the filtering API of Libav. It replaces 'vhooks', and
|
||||||
now deprecated 'vhooks' and started as a Google Summer of Code project.
|
started as a Google Summer of Code project.
|
||||||
|
|
||||||
But note that there may still be serious bugs in the code and its API
|
Note that there may still be serious bugs in the code and its API
|
||||||
and ABI should not be considered stable yet!
|
and ABI should not be considered stable yet!
|
||||||
|
|
||||||
@chapter Tutorial
|
@chapter Tutorial
|
||||||
@ -31,33 +31,33 @@ input --> split --> fifo -----------------------> overlay --> output
|
|||||||
+------> fifo --> crop --> vflip --------+
|
+------> fifo --> crop --> vflip --------+
|
||||||
@end example
|
@end example
|
||||||
|
|
||||||
splits the stream in two streams, sends one stream through the crop filter
|
splits the stream in two streams, then sends one stream through the crop filter
|
||||||
and the vflip filter before merging it back with the other stream by
|
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:
|
overlaying it on top. You can use the following command to achieve this:
|
||||||
|
|
||||||
@example
|
@example
|
||||||
./avconv -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
|
./avconv -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
|
@end example
|
||||||
|
|
||||||
The result will be that in output the top half of the video is mirrored
|
The result will be that the top half of the video is mirrored
|
||||||
onto the bottom half.
|
onto the bottom half of the output video.
|
||||||
|
|
||||||
Video filters are loaded using the @var{-vf} option passed to
|
Video filters are loaded using the @var{-vf} option passed to
|
||||||
avconv or to avplay. Filters in the same linear chain are separated by
|
avconv or to avplay. Filters in the same linear chain are separated by
|
||||||
commas. In our example, @var{split, fifo, overlay} are in one linear
|
commas. In our example, @var{split}, @var{fifo}, and @var{overlay} are in one
|
||||||
chain, and @var{fifo, crop, vflip} are in another. The points where
|
linear chain, and @var{fifo}, @var{crop}, and @var{vflip} are in another. The
|
||||||
the linear chains join are labeled by names enclosed in square
|
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
|
brackets. In our example, they join at @var{[T1]} and @var{[T2]}. The magic
|
||||||
labels @var{[in]} and @var{[out]} are the points where video is input
|
labels @var{[in]} and @var{[out]} are the points where video is input
|
||||||
and output.
|
and output.
|
||||||
|
|
||||||
Some filters take in input a list of parameters: they are specified
|
Some filters take a list of parameters: they are specified
|
||||||
after the filter name and an equal sign, and are separated each other
|
after the filter name and an equal sign, and are separated
|
||||||
by a semicolon.
|
by a semicolon.
|
||||||
|
|
||||||
There exist so-called @var{source filters} that do not have a video
|
There are so-called @var{source filters} that do not take video
|
||||||
input, and we expect in the future some @var{sink filters} that will
|
input, and we expect that some @var{sink filters} will
|
||||||
not have video output.
|
not have video output, at some point in the future.
|
||||||
|
|
||||||
@chapter graph2dot
|
@chapter graph2dot
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user