buffersrc.h 2.63 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*
 *
 * This file is part of Libav.
 *
 * Libav is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * Libav is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Libav; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef AVFILTER_BUFFERSRC_H
#define AVFILTER_BUFFERSRC_H

/**
 * @file
25
 * @ingroup lavfi_buffersrc
26 27 28 29 30
 * Memory buffer source API.
 */

#include "avfilter.h"

31 32 33 34 35 36
/**
 * @defgroup lavfi_buffersrc Buffer source API
 * @ingroup lavfi
 * @{
 */

37
#if FF_API_AVFILTERBUFFER
38
/**
39
 * Add a buffer to a filtergraph.
40
 *
41
 * @param ctx an instance of the buffersrc filter
42 43
 * @param buf buffer containing frame data to be passed down the filtergraph.
 * This function will take ownership of buf, the user must not free it.
44
 * A NULL buf signals EOF -- i.e. no more frames will be sent to this filter.
45 46
 *
 * @deprecated use av_buffersrc_write_frame() or av_buffersrc_add_frame()
47
 */
48
attribute_deprecated
49
int av_buffersrc_buffer(AVFilterContext *ctx, AVFilterBufferRef *buf);
50
#endif
51

52 53 54
/**
 * Add a frame to the buffer source.
 *
55
 * @param ctx   an instance of the buffersrc filter
56 57 58
 * @param frame frame to be added. If the frame is reference counted, this
 * function will make a new reference to it. Otherwise the frame data will be
 * copied.
59
 *
60
 * @return 0 on success, a negative AVERROR on error
61
 */
62
int av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame);
63

64 65 66
/**
 * Add a frame to the buffer source.
 *
67
 * @param ctx   an instance of the buffersrc filter
68 69 70 71 72 73 74 75 76 77 78 79 80
 * @param frame frame to be added. If the frame is reference counted, this
 * function will take ownership of the reference(s) and reset the frame.
 * Otherwise the frame data will be copied. If this function returns an error,
 * the input frame is not touched.
 *
 * @return 0 on success, a negative AVERROR on error.
 *
 * @note the difference between this function and av_buffersrc_write_frame() is
 * that av_buffersrc_write_frame() creates a new reference to the input frame,
 * while this function takes ownership of the reference passed to it.
 */
int av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame);

81 82 83 84
/**
 * @}
 */

85
#endif /* AVFILTER_BUFFERSRC_H */