libavfilter/buffersink.h

   1 /*
   2  * This file is part of Libav.
   3  *
   4  * Libav 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  * Libav 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 Libav; 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_BUFFERSINK_H
  20 #define AVFILTER_BUFFERSINK_H
  21
  22 /**
  23  * @file
  24  * memory buffer sink API
  25  */
  26
  27 #include "avfilter.h"
  28
  29 /**
  30  * Get a buffer with filtered data from sink and put it in buf.
  31  *
  32  * @param ctx pointer to a context of a buffersink or abuffersink AVFilter.
  33  * @param buf pointer to the buffer will be written here if buf is non-NULL. buf
  34  *            must be freed by the caller using avfilter_unref_buffer().
  35  *            Buf may also be NULL to query whether a buffer is ready to be
  36  *            output.
  37  *
  38  * @return >= 0 in case of success, a negative AVERROR code in case of
  39  *         failure.
  40  */
  41 int av_buffersink_read(AVFilterContext *ctx, AVFilterBufferRef **buf);
  42
  43 /**
  44  * Same as av_buffersink_read, but with the ability to specify the number of
  45  * samples read. This function is less efficient than av_buffersink_read(),
  46  * because it copies the data around.
  47  *
  48  * @param ctx pointer to a context of the abuffersink AVFilter.
  49  * @param buf pointer to the buffer will be written here if buf is non-NULL. buf
  50  *            must be freed by the caller using avfilter_unref_buffer(). buf
  51  *            will contain exactly nb_samples audio samples, except at the end
  52  *            of stream, when it can contain less than nb_samples.
  53  *            Buf may also be NULL to query whether a buffer is ready to be
  54  *            output.
  55  *
  56  * @warning do not mix this function with av_buffersink_read(). Use only one or
  57  * the other with a single sink, not both.
  58  */
  59 int av_buffersink_read_samples(AVFilterContext *ctx, AVFilterBufferRef **buf,
  60                                int nb_samples);
  61
  62 #endif /* AVFILTER_BUFFERSINK_H */