git.sesse.net Git - casparcg/blob - ffmpeg 0.8/include/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_VSINK_BUFFER_H
  20 #define AVFILTER_VSINK_BUFFER_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     const int *packing_fmts;                ///< list of allowed packing formats
  50 } AVABufferSinkParams;
  51
  52 /**
  53  * Create an AVABufferSinkParams structure.
  54  *
  55  * Must be freed with av_free().
  56  */
  57 AVABufferSinkParams *av_abuffersink_params_alloc(void);
  58
  59 /**
  60  * Tell av_buffersink_get_buffer_ref() to read video/samples buffer
  61  * reference, but not remove it from the buffer. This is useful if you
  62  * need only to read a video/samples buffer, without to fetch it.
  63  */
  64 #define AV_BUFFERSINK_FLAG_PEEK 1
  65
  66 /**
  67  * Get an audio/video buffer data from buffer_sink and put it in bufref.
  68  *
  69  * This function works with both audio and video buffer sinks.
  70  *
  71  * @param buffer_sink pointer to a buffersink or abuffersink context
  72  * @param flags a combination of AV_BUFFERSINK_FLAG_* flags
  73  * @return >= 0 in case of success, a negative AVERROR code in case of
  74  * failure
  75  */
  76 int av_buffersink_get_buffer_ref(AVFilterContext *buffer_sink,
  77                                  AVFilterBufferRef **bufref, int flags);
  78
  79 #if FF_API_OLD_VSINK_API
  80 /**
  81  * @deprecated Use av_buffersink_get_buffer_ref() instead.
  82  */
  83 attribute_deprecated
  84 int av_vsink_buffer_get_video_buffer_ref(AVFilterContext *buffer_sink,
  85                                          AVFilterBufferRef **picref, int flags);
  86 #endif
  87
  88 #endif /* AVFILTER_VSINK_BUFFER_H */