buffersink.h 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  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. #ifndef AVFILTER_BUFFERSINK_H
  19. #define AVFILTER_BUFFERSINK_H
  20. /**
  21. * @file
  22. * @ingroup lavfi_buffersink
  23. * memory buffer sink API for audio and video
  24. */
  25. #include "avfilter.h"
  26. /**
  27. * @defgroup lavfi_buffersink Buffer sink API
  28. * @ingroup lavfi
  29. * @{
  30. */
  31. /**
  32. * Get a frame with filtered data from sink and put it in frame.
  33. *
  34. * @param ctx pointer to a buffersink or abuffersink filter context.
  35. * @param frame pointer to an allocated frame that will be filled with data.
  36. * The data must be freed using av_frame_unref() / av_frame_free()
  37. * @param flags a combination of AV_BUFFERSINK_FLAG_* flags
  38. *
  39. * @return >= 0 in for success, a negative AVERROR code for failure.
  40. */
  41. int av_buffersink_get_frame_flags(AVFilterContext *ctx, AVFrame *frame, int flags);
  42. /**
  43. * Tell av_buffersink_get_buffer_ref() to read video/samples buffer
  44. * reference, but not remove it from the buffer. This is useful if you
  45. * need only to read a video/samples buffer, without to fetch it.
  46. */
  47. #define AV_BUFFERSINK_FLAG_PEEK 1
  48. /**
  49. * Tell av_buffersink_get_buffer_ref() not to request a frame from its input.
  50. * If a frame is already buffered, it is read (and removed from the buffer),
  51. * but if no frame is present, return AVERROR(EAGAIN).
  52. */
  53. #define AV_BUFFERSINK_FLAG_NO_REQUEST 2
  54. /**
  55. * Struct to use for initializing a buffersink context.
  56. */
  57. typedef struct AVBufferSinkParams {
  58. const enum AVPixelFormat *pixel_fmts; ///< list of allowed pixel formats, terminated by AV_PIX_FMT_NONE
  59. } AVBufferSinkParams;
  60. /**
  61. * Create an AVBufferSinkParams structure.
  62. *
  63. * Must be freed with av_free().
  64. */
  65. AVBufferSinkParams *av_buffersink_params_alloc(void);
  66. /**
  67. * Struct to use for initializing an abuffersink context.
  68. */
  69. typedef struct AVABufferSinkParams {
  70. const enum AVSampleFormat *sample_fmts; ///< list of allowed sample formats, terminated by AV_SAMPLE_FMT_NONE
  71. const int64_t *channel_layouts; ///< list of allowed channel layouts, terminated by -1
  72. const int *channel_counts; ///< list of allowed channel counts, terminated by -1
  73. int all_channel_counts; ///< if not 0, accept any channel count or layout
  74. int *sample_rates; ///< list of allowed sample rates, terminated by -1
  75. } AVABufferSinkParams;
  76. /**
  77. * Create an AVABufferSinkParams structure.
  78. *
  79. * Must be freed with av_free().
  80. */
  81. AVABufferSinkParams *av_abuffersink_params_alloc(void);
  82. /**
  83. * Set the frame size for an audio buffer sink.
  84. *
  85. * All calls to av_buffersink_get_buffer_ref will return a buffer with
  86. * exactly the specified number of samples, or AVERROR(EAGAIN) if there is
  87. * not enough. The last buffer at EOF will be padded with 0.
  88. */
  89. void av_buffersink_set_frame_size(AVFilterContext *ctx, unsigned frame_size);
  90. /**
  91. * @defgroup lavfi_buffersink_accessors Buffer sink accessors
  92. * Get the properties of the stream
  93. * @{
  94. */
  95. enum AVMediaType av_buffersink_get_type (const AVFilterContext *ctx);
  96. AVRational av_buffersink_get_time_base (const AVFilterContext *ctx);
  97. int av_buffersink_get_format (const AVFilterContext *ctx);
  98. AVRational av_buffersink_get_frame_rate (const AVFilterContext *ctx);
  99. int av_buffersink_get_w (const AVFilterContext *ctx);
  100. int av_buffersink_get_h (const AVFilterContext *ctx);
  101. AVRational av_buffersink_get_sample_aspect_ratio (const AVFilterContext *ctx);
  102. int av_buffersink_get_channels (const AVFilterContext *ctx);
  103. uint64_t av_buffersink_get_channel_layout (const AVFilterContext *ctx);
  104. int av_buffersink_get_sample_rate (const AVFilterContext *ctx);
  105. AVBufferRef * av_buffersink_get_hw_frames_ctx (const AVFilterContext *ctx);
  106. /** @} */
  107. /**
  108. * Get a frame with filtered data from sink and put it in frame.
  109. *
  110. * @param ctx pointer to a context of a buffersink or abuffersink AVFilter.
  111. * @param frame pointer to an allocated frame that will be filled with data.
  112. * The data must be freed using av_frame_unref() / av_frame_free()
  113. *
  114. * @return
  115. * - >= 0 if a frame was successfully returned.
  116. * - AVERROR(EAGAIN) if no frames are available at this point; more
  117. * input frames must be added to the filtergraph to get more output.
  118. * - AVERROR_EOF if there will be no more output frames on this sink.
  119. * - A different negative AVERROR code in other failure cases.
  120. */
  121. int av_buffersink_get_frame(AVFilterContext *ctx, AVFrame *frame);
  122. /**
  123. * Same as av_buffersink_get_frame(), but with the ability to specify the number
  124. * of samples read. This function is less efficient than
  125. * av_buffersink_get_frame(), because it copies the data around.
  126. *
  127. * @param ctx pointer to a context of the abuffersink AVFilter.
  128. * @param frame pointer to an allocated frame that will be filled with data.
  129. * The data must be freed using av_frame_unref() / av_frame_free()
  130. * frame will contain exactly nb_samples audio samples, except at
  131. * the end of stream, when it can contain less than nb_samples.
  132. *
  133. * @return The return codes have the same meaning as for
  134. * av_buffersink_get_frame().
  135. *
  136. * @warning do not mix this function with av_buffersink_get_frame(). Use only one or
  137. * the other with a single sink, not both.
  138. */
  139. int av_buffersink_get_samples(AVFilterContext *ctx, AVFrame *frame, int nb_samples);
  140. /**
  141. * @}
  142. */
  143. #endif /* AVFILTER_BUFFERSINK_H */