2 * Copyright (c) 2007 Bobby Bingham
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #ifndef AVFILTER_VIDEO_H
23 #define AVFILTER_VIDEO_H
27 AVFilterBufferRef *ff_default_get_video_buffer(AVFilterLink *link,
28 int perms, int w, int h);
29 AVFilterBufferRef *ff_null_get_video_buffer(AVFilterLink *link, int perms, int w, int h);
32 * Request a picture buffer with a specific set of permissions.
34 * @param link the output link to the filter from which the buffer will
36 * @param perms the required access permissions
37 * @param w the minimum width of the buffer to allocate
38 * @param h the minimum height of the buffer to allocate
39 * @return A reference to the buffer. This must be unreferenced with
40 * avfilter_unref_buffer when you are finished with it.
42 AVFilterBufferRef *ff_get_video_buffer(AVFilterLink *link, int perms,
46 * Notify the next filter of the start of a frame.
48 * @param link the output link the frame will be sent over
49 * @param picref A reference to the frame about to be sent. The data for this
50 * frame need only be valid once draw_slice() is called for that
51 * portion. The receiving filter will free this reference when
52 * it no longer needs it.
54 * @return >= 0 on success, a negative AVERROR on error. This function will
55 * unreference picref in case of error.
57 int ff_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
60 * Notify the next filter that the current frame has finished.
62 * @param link the output link the frame was sent over
64 * @return >= 0 on success, a negative AVERROR on error
66 int ff_end_frame(AVFilterLink *link);
69 * Send a slice to the next filter.
71 * Slices have to be provided in sequential order, either in
72 * top-bottom or bottom-top order. If slices are provided in
73 * non-sequential order the behavior of the function is undefined.
75 * @param link the output link over which the frame is being sent
76 * @param y offset in pixels from the top of the image for this slice
77 * @param h height of this slice in pixels
78 * @param slice_dir the assumed direction for sending slices,
79 * from the top slice to the bottom slice if the value is 1,
80 * from the bottom slice to the top slice if the value is -1,
81 * for other values the behavior of the function is undefined.
83 * @return >= 0 on success, a negative AVERROR on error.
85 int ff_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
87 #endif /* AVFILTER_VIDEO_H */