git.sesse.net Git - ffmpeg/blob - libavfilter/buffersink.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_BUFFERSINK_H
  20 #define AVFILTER_BUFFERSINK_H
  21
  22 /**
  23  * @file
  24  * memory buffer sink API for audio and video
  25  */
  26
  27 #include "avfilter.h"
  28
  29 /**
  30  * Struct to use for initializing a buffersink context.
  31  */
  32 typedef struct {
  33     const enum PixelFormat *pixel_fmts; ///< list of allowed pixel formats, terminated by PIX_FMT_NONE
  34 } AVBufferSinkParams;
  35
  36 /**
  37  * Create an AVBufferSinkParams structure.
  38  *
  39  * Must be freed with av_free().
  40  */
  41 AVBufferSinkParams *av_buffersink_params_alloc(void);
  42
  43 /**
  44  * Struct to use for initializing an abuffersink context.
  45  */
  46 typedef struct {
  47     const enum AVSampleFormat *sample_fmts; ///< list of allowed sample formats, terminated by AV_SAMPLE_FMT_NONE
  48     const int64_t *channel_layouts;         ///< list of allowed channel layouts, terminated by -1
  49 #if FF_API_PACKING
  50     const int *packing_fmts;                ///< list of allowed packing formats
  51 #endif
  52 } AVABufferSinkParams;
  53
  54 /**
  55  * Create an AVABufferSinkParams structure.
  56  *
  57  * Must be freed with av_free().
  58  */
  59 AVABufferSinkParams *av_abuffersink_params_alloc(void);
  60
  61 /**
  62  * Tell av_buffersink_get_buffer_ref() to read video/samples buffer
  63  * reference, but not remove it from the buffer. This is useful if you
  64  * need only to read a video/samples buffer, without to fetch it.
  65  */
  66 #define AV_BUFFERSINK_FLAG_PEEK 1
  67
  68 /**
  69  * Tell av_buffersink_get_buffer_ref() not to request a frame from its input.
  70  * If a frame is already buffered, it is read (and removed from the buffer),
  71  * but if no frame is present, return AVERROR(EAGAIN).
  72  */
  73 #define AV_BUFFERSINK_FLAG_NO_REQUEST 2
  74
  75 /**
  76  * Get an audio/video buffer data from buffer_sink and put it in bufref.
  77  *
  78  * This function works with both audio and video buffer sinks.
  79  *
  80  * @param buffer_sink pointer to a buffersink or abuffersink context
  81  * @param flags a combination of AV_BUFFERSINK_FLAG_* flags
  82  * @return >= 0 in case of success, a negative AVERROR code in case of
  83  * failure
  84  */
  85 int av_buffersink_get_buffer_ref(AVFilterContext *buffer_sink,
  86                                  AVFilterBufferRef **bufref, int flags);
  87
  88
  89 /**
  90  * Get the number of immediately available frames.
  91  */
  92 int av_buffersink_poll_frame(AVFilterContext *ctx);
  93
  94 #if FF_API_OLD_VSINK_API
  95 /**
  96  * @deprecated Use av_buffersink_get_buffer_ref() instead.
  97  */
  98 attribute_deprecated
  99 int av_vsink_buffer_get_video_buffer_ref(AVFilterContext *buffer_sink,
 100                                          AVFilterBufferRef **picref, int flags);
 101 #endif
 102
 103 /**
 104  * Get a buffer with filtered data from sink and put it in buf.
 105  *
 106  * @param sink pointer to a context of a buffersink or abuffersink AVFilter.
 107  * @param buf pointer to the buffer will be written here if buf is non-NULL. buf
 108  *            must be freed by the caller using avfilter_unref_buffer().
 109  *            Buf may also be NULL to query whether a buffer is ready to be
 110  *            output.
 111  *
 112  * @return >= 0 in case of success, a negative AVERROR code in case of
 113  *         failure.
 114  */
 115 int av_buffersink_read(AVFilterContext *sink, AVFilterBufferRef **buf);
 116
 117 /**
 118  * Same as av_buffersink_read, but with the ability to specify the number of
 119  * samples read. This function is less efficient than av_buffersink_read(),
 120  * because it copies the data around.
 121  *
 122  * @param sink pointer to a context of the abuffersink AVFilter.
 123  * @param buf pointer to the buffer will be written here if buf is non-NULL. buf
 124  *            must be freed by the caller using avfilter_unref_buffer(). buf
 125  *            will contain exactly nb_samples audio samples, except at the end
 126  *            of stream, when it can contain less than nb_samples.
 127  *            Buf may also be NULL to query whether a buffer is ready to be
 128  *            output.
 129  *
 130  * @warning do not mix this function with av_buffersink_read(). Use only one or
 131  * the other with a single sink, not both.
 132  */
 133 int av_buffersink_read_samples(AVFilterContext *ctx, AVFilterBufferRef **buf,
 134                                int nb_samples);
 135
 136 #endif /* AVFILTER_BUFFERSINK_H */