Subversion Repositories Kolibri OS

Rev

Blame | Last modification | View Log | RSS feed

  1. /*
  2.  *
  3.  * This file is part of FFmpeg.
  4.  *
  5.  * FFmpeg 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.  * FFmpeg 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 FFmpeg; 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.  * @ingroup lavfi_buffersrc
  26.  * Memory buffer source API.
  27.  */
  28.  
  29. #include "libavcodec/avcodec.h"
  30. #include "avfilter.h"
  31.  
  32. /**
  33.  * @defgroup lavfi_buffersrc Buffer source API
  34.  * @ingroup lavfi
  35.  * @{
  36.  */
  37.  
  38. enum {
  39.  
  40.     /**
  41.      * Do not check for format changes.
  42.      */
  43.     AV_BUFFERSRC_FLAG_NO_CHECK_FORMAT = 1,
  44.  
  45. #if FF_API_AVFILTERBUFFER
  46.     /**
  47.      * Ignored
  48.      */
  49.     AV_BUFFERSRC_FLAG_NO_COPY = 2,
  50. #endif
  51.  
  52.     /**
  53.      * Immediately push the frame to the output.
  54.      */
  55.     AV_BUFFERSRC_FLAG_PUSH = 4,
  56.  
  57.     /**
  58.      * Keep a reference to the frame.
  59.      * If the frame if reference-counted, create a new reference; otherwise
  60.      * copy the frame data.
  61.      */
  62.     AV_BUFFERSRC_FLAG_KEEP_REF = 8,
  63.  
  64. };
  65.  
  66. #if FF_API_AVFILTERBUFFER
  67. /**
  68.  * Add buffer data in picref to buffer_src.
  69.  *
  70.  * @param buffer_src  pointer to a buffer source context
  71.  * @param picref      a buffer reference, or NULL to mark EOF
  72.  * @param flags       a combination of AV_BUFFERSRC_FLAG_*
  73.  * @return            >= 0 in case of success, a negative AVERROR code
  74.  *                    in case of failure
  75.  */
  76. attribute_deprecated
  77. int av_buffersrc_add_ref(AVFilterContext *buffer_src,
  78.                          AVFilterBufferRef *picref, int flags);
  79. #endif
  80.  
  81. /**
  82.  * Get the number of failed requests.
  83.  *
  84.  * A failed request is when the request_frame method is called while no
  85.  * frame is present in the buffer.
  86.  * The number is reset when a frame is added.
  87.  */
  88. unsigned av_buffersrc_get_nb_failed_requests(AVFilterContext *buffer_src);
  89.  
  90. #if FF_API_AVFILTERBUFFER
  91. /**
  92.  * Add a buffer to a filtergraph.
  93.  *
  94.  * @param ctx an instance of the buffersrc filter
  95.  * @param buf buffer containing frame data to be passed down the filtergraph.
  96.  * This function will take ownership of buf, the user must not free it.
  97.  * A NULL buf signals EOF -- i.e. no more frames will be sent to this filter.
  98.  *
  99.  * @deprecated use av_buffersrc_write_frame() or av_buffersrc_add_frame()
  100.  */
  101. attribute_deprecated
  102. int av_buffersrc_buffer(AVFilterContext *ctx, AVFilterBufferRef *buf);
  103. #endif
  104.  
  105. /**
  106.  * Add a frame to the buffer source.
  107.  *
  108.  * @param ctx   an instance of the buffersrc filter
  109.  * @param frame frame to be added. If the frame is reference counted, this
  110.  * function will make a new reference to it. Otherwise the frame data will be
  111.  * copied.
  112.  *
  113.  * @return 0 on success, a negative AVERROR on error
  114.  *
  115.  * This function is equivalent to av_buffersrc_add_frame_flags() with the
  116.  * AV_BUFFERSRC_FLAG_KEEP_REF flag.
  117.  */
  118. int av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame);
  119.  
  120. /**
  121.  * Add a frame to the buffer source.
  122.  *
  123.  * @param ctx   an instance of the buffersrc filter
  124.  * @param frame frame to be added. If the frame is reference counted, this
  125.  * function will take ownership of the reference(s) and reset the frame.
  126.  * Otherwise the frame data will be copied. If this function returns an error,
  127.  * the input frame is not touched.
  128.  *
  129.  * @return 0 on success, a negative AVERROR on error.
  130.  *
  131.  * @note the difference between this function and av_buffersrc_write_frame() is
  132.  * that av_buffersrc_write_frame() creates a new reference to the input frame,
  133.  * while this function takes ownership of the reference passed to it.
  134.  *
  135.  * This function is equivalent to av_buffersrc_add_frame_flags() without the
  136.  * AV_BUFFERSRC_FLAG_KEEP_REF flag.
  137.  */
  138. int av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame);
  139.  
  140. /**
  141.  * Add a frame to the buffer source.
  142.  *
  143.  * By default, if the frame is reference-counted, this function will take
  144.  * ownership of the reference(s) and reset the frame. This can be controlled
  145.  * using the flags.
  146.  *
  147.  * If this function returns an error, the input frame is not touched.
  148.  *
  149.  * @param buffer_src  pointer to a buffer source context
  150.  * @param frame       a frame, or NULL to mark EOF
  151.  * @param flags       a combination of AV_BUFFERSRC_FLAG_*
  152.  * @return            >= 0 in case of success, a negative AVERROR code
  153.  *                    in case of failure
  154.  */
  155. int av_buffersrc_add_frame_flags(AVFilterContext *buffer_src,
  156.                                  AVFrame *frame, int flags);
  157.  
  158.  
  159. /**
  160.  * @}
  161.  */
  162.  
  163. #endif /* AVFILTER_BUFFERSRC_H */
  164.