libavfilter/buffersrc.h

   1 /*
   2  *
   3  * This file is part of Libav.
   4  *
   5  * Libav is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * Libav is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with Libav; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19
  20 #ifndef AVFILTER_BUFFERSRC_H
  21 #define AVFILTER_BUFFERSRC_H
  22
  23 /**
  24  * @file
  25  * Memory buffer source API.
  26  */
  27
  28 #include "avfilter.h"
  29
  30 #if FF_API_AVFILTERBUFFER
  31 /**
  32  * Add a buffer to the filtergraph s.
  33  *
  34  * @param buf buffer containing frame data to be passed down the filtergraph.
  35  * This function will take ownership of buf, the user must not free it.
  36  * A NULL buf signals EOF -- i.e. no more frames will be sent to this filter.
  37  *
  38  * @deprecated use av_buffersrc_write_frame() or av_buffersrc_add_frame()
  39  */
  40 attribute_deprecated
  41 int av_buffersrc_buffer(AVFilterContext *s, AVFilterBufferRef *buf);
  42 #endif
  43
  44 /**
  45  * Add a frame to the buffer source.
  46  *
  47  * @param s an instance of the buffersrc filter.
  48  * @param frame frame to be added. If the frame is reference counted, this
  49  * function will make a new reference to it. Otherwise the frame data will be
  50  * copied.
  51  *
  52  * @return 0 on success, a negative AVERROR on error
  53  */
  54 int av_buffersrc_write_frame(AVFilterContext *s, const AVFrame *frame);
  55
  56 /**
  57  * Add a frame to the buffer source.
  58  *
  59  * @param s an instance of the buffersrc filter.
  60  * @param frame frame to be added. If the frame is reference counted, this
  61  * function will take ownership of the reference(s) and reset the frame.
  62  * Otherwise the frame data will be copied. If this function returns an error,
  63  * the input frame is not touched.
  64  *
  65  * @return 0 on success, a negative AVERROR on error.
  66  *
  67  * @note the difference between this function and av_buffersrc_write_frame() is
  68  * that av_buffersrc_write_frame() creates a new reference to the input frame,
  69  * while this function takes ownership of the reference passed to it.
  70  */
  71 int av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame);
  72
  73 #endif /* AVFILTER_BUFFERSRC_H */