git.sesse.net Git - ffmpeg/blob - libavfilter/video.h

   1 /*
   2  * Copyright (c) 2007 Bobby Bingham
   3  *
   4  * This file is part of FFmpeg.
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  */
  20
  21
  22 #ifndef AVFILTER_VIDEO_H
  23 #define AVFILTER_VIDEO_H
  24
  25 #include "avfilter.h"
  26
  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);
  30
  31 /**
  32  * Request a picture buffer with a specific set of permissions.
  33  *
  34  * @param link  the output link to the filter from which the buffer will
  35  *              be requested
  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.
  41  */
  42 AVFilterBufferRef *ff_get_video_buffer(AVFilterLink *link, int perms,
  43                                        int w, int h);
  44
  45 int ff_inplace_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
  46 int ff_null_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
  47 int ff_null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
  48 int ff_null_end_frame(AVFilterLink *link);
  49
  50 /**
  51  * Notify the next filter of the start of a frame.
  52  *
  53  * @param link   the output link the frame will be sent over
  54  * @param picref A reference to the frame about to be sent. The data for this
  55  *               frame need only be valid once draw_slice() is called for that
  56  *               portion. The receiving filter will free this reference when
  57  *               it no longer needs it.
  58  *
  59  * @return >= 0 on success, a negative AVERROR on error. This function will
  60  * unreference picref in case of error.
  61  */
  62 int ff_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
  63
  64 /**
  65  * Pass video frame along and keep an internal reference for later use.
  66  */
  67 int ff_null_start_frame_keep_ref(AVFilterLink *inlink, AVFilterBufferRef *picref);
  68
  69 /**
  70  * Notify the next filter that the current frame has finished.
  71  *
  72  * @param link the output link the frame was sent over
  73  *
  74  * @return >= 0 on success, a negative AVERROR on error
  75  */
  76 int ff_end_frame(AVFilterLink *link);
  77
  78 /**
  79  * Send a slice to the next filter.
  80  *
  81  * Slices have to be provided in sequential order, either in
  82  * top-bottom or bottom-top order. If slices are provided in
  83  * non-sequential order the behavior of the function is undefined.
  84  *
  85  * @param link the output link over which the frame is being sent
  86  * @param y    offset in pixels from the top of the image for this slice
  87  * @param h    height of this slice in pixels
  88  * @param slice_dir the assumed direction for sending slices,
  89  *             from the top slice to the bottom slice if the value is 1,
  90  *             from the bottom slice to the top slice if the value is -1,
  91  *             for other values the behavior of the function is undefined.
  92  *
  93  * @return >= 0 on success, a negative AVERROR on error.
  94  */
  95 int ff_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
  96
  97 #endif /* AVFILTER_VIDEO_H */