lavfi: remove request/poll and drawing functions from public API on next bump
[ffmpeg.git] / libavfilter / video.h
1 /*
2  * This file is part of Libav.
3  *
4  * Libav is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * Libav is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with Libav; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 #ifndef AVFILTER_VIDEO_H
20 #define AVFILTER_VIDEO_H
21
22 #include "avfilter.h"
23
24 AVFilterBufferRef *ff_default_get_video_buffer(AVFilterLink *link,
25                                                int perms, int w, int h);
26 AVFilterBufferRef *ff_null_get_video_buffer(AVFilterLink *link, int perms, int w, int h);
27
28 void ff_null_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
29 void ff_null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
30 void ff_null_end_frame(AVFilterLink *link);
31
32 /**
33  * Notify the next filter of the start of a frame.
34  *
35  * @param link   the output link the frame will be sent over
36  * @param picref A reference to the frame about to be sent. The data for this
37  *               frame need only be valid once draw_slice() is called for that
38  *               portion. The receiving filter will free this reference when
39  *               it no longer needs it.
40  */
41 void ff_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
42
43 /**
44  * Notify the next filter that the current frame has finished.
45  *
46  * @param link the output link the frame was sent over
47  */
48 void ff_end_frame(AVFilterLink *link);
49
50 /**
51  * Send a slice to the next filter.
52  *
53  * Slices have to be provided in sequential order, either in
54  * top-bottom or bottom-top order. If slices are provided in
55  * non-sequential order the behavior of the function is undefined.
56  *
57  * @param link the output link over which the frame is being sent
58  * @param y    offset in pixels from the top of the image for this slice
59  * @param h    height of this slice in pixels
60  * @param slice_dir the assumed direction for sending slices,
61  *             from the top slice to the bottom slice if the value is 1,
62  *             from the bottom slice to the top slice if the value is -1,
63  *             for other values the behavior of the function is undefined.
64  */
65 void ff_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
66
67 #endif /* AVFILTER_VIDEO_H */