libavfilter/vsink_buffer.h

   1 /*
   2  * This file is part of FFmpeg.
   3  *
   4  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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_VSINK_BUFFER_H
  20 #define AVFILTER_VSINK_BUFFER_H
  21
  22 /**
  23  * @file
  24  * memory buffer sink API for video
  25  */
  26
  27 #include "avfilter.h"
  28
  29 /**
  30  * Tell av_vsink_buffer_get_video_buffer_ref() to read the picref, but not
  31  * remove it from the buffer. This is useful if you need only to read
  32  * the picref, without to fetch it.
  33  */
  34 #define AV_VSINK_BUF_FLAG_PEEK 1
  35
  36 /**
  37  * Get a video buffer data from buffer_sink and put it in picref.
  38  *
  39  * @param buffer_sink pointer to a buffer sink context
  40  * @param flags a combination of AV_VSINK_BUF_FLAG_* flags
  41  * @return >= 0 in case of success, a negative AVERROR code in case of
  42  * failure
  43  */
  44 int av_vsink_buffer_get_video_buffer_ref(AVFilterContext *buffer_sink,
  45                                          AVFilterBufferRef **picref, int flags);
  46
  47 #endif /* AVFILTER_VSINK_BUFFER_H */