lavfi: add video buffer sink, and use it in avtools
[libav.git] / libavfilter / buffersink.h
CommitLineData
ac712309
AK
1/*
2 * This file is part of Libav.
3 *
4 * Libav 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 * Libav 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 Libav; 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
25 */
26
27#include "avfilter.h"
28
29/**
30 * Get a buffer with filtered data from sink and put it in buf.
31 *
32 * @param sink pointer to a context of a buffersink AVFilter.
33 * @param buf pointer to the buffer will be written here if buf is non-NULL. buf
34 * must be freed by the caller using avfilter_unref_buffer().
35 * Buf may also be NULL to query whether a buffer is ready to be
36 * output.
37 *
38 * @return >= 0 in case of success, a negative AVERROR code in case of
39 * failure.
40 */
41int av_buffersink_read(AVFilterContext *sink, AVFilterBufferRef **buf);
42
43#endif /* AVFILTER_BUFFERSINK_H */