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 AVPixelFormat *pixel_fmts; ///< list of allowed pixel formats, terminated by AV_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     const int *channel_counts;              ///< list of allowed channel counts, terminated by -1
  50     int all_channel_counts;                 ///< if not 0, accept any channel count or layout
  51 } AVABufferSinkParams;
  52
  53 /**
  54  * Create an AVABufferSinkParams structure.
  55  *
  56  * Must be freed with av_free().
  57  */
  58 AVABufferSinkParams *av_abuffersink_params_alloc(void);
  59
  60 /**
  61  * Set the frame size for an audio buffer sink.
  62  *
  63  * All calls to av_buffersink_get_buffer_ref will return a buffer with
  64  * exactly the specified number of samples, or AVERROR(EAGAIN) if there is
  65  * not enough. The last buffer at EOF will be padded with 0.
  66  */
  67 void av_buffersink_set_frame_size(AVFilterContext *ctx, unsigned frame_size);
  68
  69 /**
  70  * Tell av_buffersink_get_buffer_ref() to read video/samples buffer
  71  * reference, but not remove it from the buffer. This is useful if you
  72  * need only to read a video/samples buffer, without to fetch it.
  73  */
  74 #define AV_BUFFERSINK_FLAG_PEEK 1
  75
  76 /**
  77  * Tell av_buffersink_get_buffer_ref() not to request a frame from its input.
  78  * If a frame is already buffered, it is read (and removed from the buffer),
  79  * but if no frame is present, return AVERROR(EAGAIN).
  80  */
  81 #define AV_BUFFERSINK_FLAG_NO_REQUEST 2
  82
  83 /**
  84  * Get an audio/video buffer data from buffer_sink and put it in bufref.
  85  *
  86  * This function works with both audio and video buffer sinks.
  87  *
  88  * @param buffer_sink pointer to a buffersink or abuffersink context
  89  * @param flags a combination of AV_BUFFERSINK_FLAG_* flags
  90  * @return >= 0 in case of success, a negative AVERROR code in case of
  91  * failure
  92  */
  93 int av_buffersink_get_buffer_ref(AVFilterContext *buffer_sink,
  94                                  AVFilterBufferRef **bufref, int flags);
  95
  96
  97 /**
  98  * Get the number of immediately available frames.
  99  */
 100 int av_buffersink_poll_frame(AVFilterContext *ctx);
 101
 102 /**
 103  * Get the frame rate of the input.
 104  */
 105 AVRational av_buffersink_get_frame_rate(AVFilterContext *ctx);
 106
 107 /**
 108  * @defgroup libav_api Libav API
 109  * @{
 110  */
 111
 112 /**
 113  * Get a buffer with filtered data from sink and put it in buf.
 114  *
 115  * @param ctx pointer to a context of a buffersink or abuffersink AVFilter.
 116  * @param buf pointer to the buffer will be written here if buf is non-NULL. buf
 117  *            must be freed by the caller using avfilter_unref_buffer().
 118  *            Buf may also be NULL to query whether a buffer is ready to be
 119  *            output.
 120  *
 121  * @return >= 0 in case of success, a negative AVERROR code in case of
 122  *         failure.
 123  */
 124 int av_buffersink_read(AVFilterContext *ctx, AVFilterBufferRef **buf);
 125
 126 /**
 127  * Same as av_buffersink_read, but with the ability to specify the number of
 128  * samples read. This function is less efficient than av_buffersink_read(),
 129  * because it copies the data around.
 130  *
 131  * @param ctx pointer to a context of the abuffersink AVFilter.
 132  * @param buf pointer to the buffer will be written here if buf is non-NULL. buf
 133  *            must be freed by the caller using avfilter_unref_buffer(). buf
 134  *            will contain exactly nb_samples audio samples, except at the end
 135  *            of stream, when it can contain less than nb_samples.
 136  *            Buf may also be NULL to query whether a buffer is ready to be
 137  *            output.
 138  *
 139  * @warning do not mix this function with av_buffersink_read(). Use only one or
 140  * the other with a single sink, not both.
 141  */
 142 int av_buffersink_read_samples(AVFilterContext *ctx, AVFilterBufferRef **buf,
 143                                int nb_samples);
 144
 145 /**
 146  * @}
 147  */
 148
 149 #endif /* AVFILTER_BUFFERSINK_H */