git.sesse.net Git - ffmpeg/blob - 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 /**
  29  * Request a picture buffer with a specific set of permissions.
  30  *
  31  * @param link  the output link to the filter from which the buffer will
  32  *              be requested
  33  * @param perms the required access permissions
  34  * @param w     the minimum width of the buffer to allocate
  35  * @param h     the minimum height of the buffer to allocate
  36  * @return      A reference to the buffer. This must be unreferenced with
  37  *              avfilter_unref_buffer when you are finished with it.
  38  */
  39 AVFilterBufferRef *ff_get_video_buffer(AVFilterLink *link, int perms,
  40                                        int w, int h);
  41
  42 int ff_inplace_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
  43 int ff_null_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
  44 int ff_null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
  45 int ff_null_end_frame(AVFilterLink *link);
  46
  47 /**
  48  * Notify the next filter of the start of a frame.
  49  *
  50  * @param link   the output link the frame will be sent over
  51  * @param picref A reference to the frame about to be sent. The data for this
  52  *               frame need only be valid once draw_slice() is called for that
  53  *               portion. The receiving filter will free this reference when
  54  *               it no longer needs it.
  55  *
  56  * @return >= 0 on success, a negative AVERROR on error. This function will
  57  * unreference picref in case of error.
  58  */
  59 int ff_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
  60
  61 /**
  62  * Notify the next filter that the current frame has finished.
  63  *
  64  * @param link the output link the frame was sent over
  65  *
  66  * @return >= 0 on success, a negative AVERROR on error
  67  */
  68 int ff_end_frame(AVFilterLink *link);
  69
  70 /**
  71  * Send a slice to the next filter.
  72  *
  73  * Slices have to be provided in sequential order, either in
  74  * top-bottom or bottom-top order. If slices are provided in
  75  * non-sequential order the behavior of the function is undefined.
  76  *
  77  * @param link the output link over which the frame is being sent
  78  * @param y    offset in pixels from the top of the image for this slice
  79  * @param h    height of this slice in pixels
  80  * @param slice_dir the assumed direction for sending slices,
  81  *             from the top slice to the bottom slice if the value is 1,
  82  *             from the bottom slice to the top slice if the value is -1,
  83  *             for other values the behavior of the function is undefined.
  84  *
  85  * @return >= 0 on success, a negative AVERROR on error.
  86  */
  87 int ff_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
  88
  89 #endif /* AVFILTER_VIDEO_H */