libavfilter/buffersrc.h
e1d9dbf2
 /*
  *
d814a839
  * This file is part of FFmpeg.
e1d9dbf2
  *
d814a839
  * FFmpeg is free software; you can redistribute it and/or
e1d9dbf2
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
d814a839
  * FFmpeg is distributed in the hope that it will be useful,
e1d9dbf2
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
d814a839
  * License along with FFmpeg; if not, write to the Free Software
e1d9dbf2
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #ifndef AVFILTER_BUFFERSRC_H
 #define AVFILTER_BUFFERSRC_H
 
 /**
  * @file
ba7dfe5c
  * @ingroup lavfi_buffersrc
e1d9dbf2
  * Memory buffer source API.
  */
 
972cad77
 #include "libavcodec/avcodec.h"
e1d9dbf2
 #include "avfilter.h"
 
ba7dfe5c
 /**
  * @defgroup lavfi_buffersrc Buffer source API
  * @ingroup lavfi
  * @{
  */
 
3985ec0e
 enum {
 
     /**
      * Do not check for format changes.
      */
     AV_BUFFERSRC_FLAG_NO_CHECK_FORMAT = 1,
 
5bbe4142
     /**
      * Immediately push the frame to the output.
      */
     AV_BUFFERSRC_FLAG_PUSH = 4,
 
b0012de4
     /**
      * Keep a reference to the frame.
      * If the frame if reference-counted, create a new reference; otherwise
      * copy the frame data.
      */
     AV_BUFFERSRC_FLAG_KEEP_REF = 8,
 
3985ec0e
 };
 
4d4350f4
 /**
  * Get the number of failed requests.
  *
  * A failed request is when the request_frame method is called while no
  * frame is present in the buffer.
  * The number is reset when a frame is added.
  */
 unsigned av_buffersrc_get_nb_failed_requests(AVFilterContext *buffer_src);
 
3e2cf79e
 /**
720c6b78
  * Add a frame to the buffer source.
  *
4a7d3837
  * @param ctx   an instance of the buffersrc filter
7e350379
  * @param frame frame to be added. If the frame is reference counted, this
  * function will make a new reference to it. Otherwise the frame data will be
  * copied.
720c6b78
  *
7e350379
  * @return 0 on success, a negative AVERROR on error
b0012de4
  *
  * This function is equivalent to av_buffersrc_add_frame_flags() with the
  * AV_BUFFERSRC_FLAG_KEEP_REF flag.
720c6b78
  */
624057df
 av_warn_unused_result
4a7d3837
 int av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame);
720c6b78
 
7e350379
 /**
  * Add a frame to the buffer source.
  *
4a7d3837
  * @param ctx   an instance of the buffersrc filter
7e350379
  * @param frame frame to be added. If the frame is reference counted, this
  * function will take ownership of the reference(s) and reset the frame.
  * Otherwise the frame data will be copied. If this function returns an error,
  * the input frame is not touched.
  *
  * @return 0 on success, a negative AVERROR on error.
  *
  * @note the difference between this function and av_buffersrc_write_frame() is
  * that av_buffersrc_write_frame() creates a new reference to the input frame,
  * while this function takes ownership of the reference passed to it.
b0012de4
  *
  * This function is equivalent to av_buffersrc_add_frame_flags() without the
  * AV_BUFFERSRC_FLAG_KEEP_REF flag.
7e350379
  */
624057df
 av_warn_unused_result
7e350379
 int av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame);
 
a05a44e2
 /**
b0012de4
  * Add a frame to the buffer source.
  *
  * By default, if the frame is reference-counted, this function will take
88f2586a
  * ownership of the reference(s) and reset the frame. This can be controlled
b0012de4
  * using the flags.
  *
  * If this function returns an error, the input frame is not touched.
a05a44e2
  *
  * @param buffer_src  pointer to a buffer source context
  * @param frame       a frame, or NULL to mark EOF
  * @param flags       a combination of AV_BUFFERSRC_FLAG_*
  * @return            >= 0 in case of success, a negative AVERROR code
  *                    in case of failure
  */
624057df
 av_warn_unused_result
a05a44e2
 int av_buffersrc_add_frame_flags(AVFilterContext *buffer_src,
                                  AVFrame *frame, int flags);
 
 
baaa6d67
 /**
ba7dfe5c
  * @}
  */
 
e1d9dbf2
 #endif /* AVFILTER_BUFFERSRC_H */