Statistics
| Branch: | Revision:

ffmpeg / doc / libavfilter.texi @ 006aa1a4

History | View | Annotate | Download (6.51 KB)

1
\input texinfo @c -*- texinfo -*-
2

    
3
@settitle Libavfilter Documentation
4
@titlepage
5
@sp 7
6
@center @titlefont{Libavfilter Documentation}
7
@sp 3
8
@end titlepage
9

    
10

    
11
@chapter Introduction
12

    
13
Libavfilter is the filtering API of FFmpeg. It is the substitute of the
14
now deprecated 'vhooks' and started as a Google Summer of Code project.
15

    
16
Integrating libavfilter into the main FFmpeg repository is a work in
17
progress. If you wish to try the unfinished development code of
18
libavfilter then check it out from the libavfilter repository into
19
some directory of your choice by:
20

    
21
@example
22
   svn checkout svn://svn.ffmpeg.org/soc/libavfilter
23
@end example
24

    
25
And then read the README file in the top directory to learn how to
26
integrate it into ffmpeg and ffplay.
27

    
28
But note that there may still be serious bugs in the code and its API
29
and ABI should not be considered stable yet!
30

    
31
@chapter Tutorial
32

    
33
In libavfilter, it is possible for filters to have multiple inputs and
34
multiple outputs.
35
To illustrate the sorts of things that are possible, we can
36
use a complex filter graph. For example, the following one:
37

    
38
@example
39
input --> split --> fifo -----------------------> overlay --> output
40
            |                                        ^
41
            |                                        |
42
            +------> fifo --> crop --> vflip --------+
43
@end example
44

    
45
splits the stream in two streams, sends one stream through the crop filter
46
and the vflip filter before merging it back with the other stream by
47
overlaying it on top. You can use the following command to achieve this:
48

    
49
@example
50
./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]
51
@end example
52

    
53
where input_video.avi has a vertical resolution of 480 pixels. The
54
result will be that in output the top half of the video is mirrored
55
onto the bottom half.
56

    
57
Video filters are loaded using the @var{-vfilters} option passed to
58
ffmpeg or to ffplay. Filters in the same linear chain are separated by
59
commas. In our example, @var{split, fifo, overlay} are in one linear
60
chain, and @var{fifo, crop, vflip} are in another. The points where
61
the linear chains join are labeled by names enclosed in square
62
brackets. In our example, that is @var{[T1]} and @var{[T2]}. The magic
63
labels @var{[in]} and @var{[out]} are the points where video is input
64
and output.
65

    
66
Some filters take in input a list of parameters: they are specified
67
after the filter name and an equal sign, and are separated each other
68
by a semicolon.
69

    
70
There exist so-called @var{source filters} that do not have a video
71
input, and we expect in the future some @var{sink filters} that will
72
not have video output.
73

    
74
@chapter Available video filters
75

    
76
When you configure your FFmpeg build, you can disable any of the
77
existing video filters.
78
The configure output will show the video filters included in your
79
build.
80

    
81
Below is a description of the currently available video filters.
82

    
83
@section crop
84

    
85
Crop the input video to x:y:width:height.
86

    
87
@example
88
./ffmpeg -i in.avi -vfilters "crop=0:0:0:240" out.avi
89
@end example
90

    
91
``x'' and ``y'' specify the position of the top-left corner of the
92
output (non-cropped) area.
93

    
94
The default value of ``x'' and ``y'' is 0.
95

    
96
The ``width'' and ``height'' parameters specify the width and height
97
of the output (non-cropped) area.
98

    
99
A value of 0 is interpreted as the maximum possible size contained in
100
the area delimited by the top-left corner at position x:y.
101

    
102
For example the parameters:
103

    
104
@example
105
"crop=100:100:0:0"
106
@end example
107

    
108
will delimit the rectangle with the top-left corner placed at position
109
100:100 and the right-bottom corner corresponding to the right-bottom
110
corner of the input image.
111

    
112
The default value of ``width'' and ``height'' is 0.
113

    
114
@section format
115

    
116
Convert the input video to one of the specified pixel formats.
117
Libavfilter will try to pick one that is supported for the input to
118
the next filter.
119

    
120
The filter accepts a list of pixel format names, separated by ``:'',
121
for example ``yuv420p:monow:rgb24''.
122

    
123
The following command:
124

    
125
@example
126
./ffmpeg -i in.avi -vfilters "format=yuv420p" out.avi
127
@end example
128

    
129
will convert the input video to the format ``yuv420p''.
130

    
131
@section noformat
132

    
133
Force libavfilter not to use any of the specified pixel formats for the
134
input to the next filter.
135

    
136
The filter accepts a list of pixel format names, separated by ``:'',
137
for example ``yuv420p:monow:rgb24''.
138

    
139
The following command:
140

    
141
@example
142
./ffmpeg -i in.avi -vfilters "noformat=yuv420p, vflip" out.avi
143
@end example
144

    
145
will make libavfilter use a format different from ``yuv420p'' for the
146
input to the vflip filter.
147

    
148
@section null
149

    
150
Pass the source unchanged to the output.
151

    
152
@section scale
153

    
154
Scale the input video to width:height and/or convert the image format.
155

    
156
For example the command:
157

    
158
@example
159
./ffmpeg -i in.avi -vfilters "scale=200:100" out.avi
160
@end example
161

    
162
will scale the input video to a size of 200x100.
163

    
164
If the input image format is different from the format requested by
165
the next filter, the scale filter will convert the input to the
166
requested format.
167

    
168
If the value for ``width'' or ``height'' is 0, the respective input
169
size is used for the output.
170

    
171
If the value for ``width'' or ``height'' is -1, the scale filter will
172
use, for the respective output size, a value that maintains the aspect
173
ratio of the input image.
174

    
175
The default value of ``width'' and ``height'' is 0.
176

    
177
@section slicify
178

    
179
Pass the images of input video on to next video filter as multiple
180
slices.
181

    
182
@example
183
./ffmpeg -i in.avi -vfilters "slicify=32" out.avi
184
@end example
185

    
186
The filter accepts the slice height as parameter. If the parameter is
187
not specified it will use the default value of 16.
188

    
189
Adding this in the beginning of filter chains should make filtering
190
faster due to better use of the memory cache.
191

    
192
@section vflip
193

    
194
Flip the input video vertically.
195

    
196
@example
197
./ffmpeg -i in.avi -vfilters "vflip" out.avi
198
@end example
199

    
200
@chapter Available video sources
201

    
202
Below is a description of the currently available video sources.
203

    
204
@section nullsrc
205

    
206
Null video source, never return images. It is mainly useful as a
207
template and to be employed in analysis / debugging tools.
208

    
209
It accepts as optional parameter a string of the form
210
``width:height'', where ``width'' and ``height'' specify the size of
211
the configured source.
212

    
213
The default values of ``width'' and ``height'' are respectively 352
214
and 288 (corresponding to the CIF size format).
215

    
216
@chapter Available video sinks
217

    
218
Below is a description of the currently available video sinks.
219

    
220
@section nullsink
221

    
222
Null video sink, do absolutely nothing with the input video. It is
223
mainly useful as a template and to be employed in analysis / debugging
224
tools.
225

    
226
@bye