lavfi: export ff_filter_set_ready() to the library.
[ffmpeg.git] / libavfilter / filters.h
1 /*
2  * Filters implementation helper functions
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public License
8  * as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public License
17  * along with FFmpeg; if not, write to the Free Software Foundation, Inc.,
18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #ifndef AVFILTER_FILTERS_H
22 #define AVFILTER_FILTERS_H
23
24 /**
25  * Filters implementation helper functions
26  */
27
28 #include "avfilter.h"
29
30 /**
31  * Mark a filter ready and schedule it for activation.
32  *
33  * This is automatically done when something happens to the filter (queued
34  * frame, status change, request on output).
35  * Filters implementing the activate callback can call it directly to
36  * perform one more round of processing later.
37  * It is also useful for filters reacting to external or asynchronous
38  * events.
39  */
40 void ff_filter_set_ready(AVFilterContext *filter, unsigned priority);
41
42 /**
43  * Test and acknowledge the change of status on the link.
44  *
45  * Status means EOF or an error condition; a change from the normal (0)
46  * status to a non-zero status can be queued in a filter's input link, it
47  * becomes relevant after the frames queued in the link's FIFO are
48  * processed. This function tests if frames are still queued and if a queued
49  * status change has not yet been processed. In that case it performs basic
50  * treatment (updating the link's timestamp) and returns a positive value to
51  * let the filter do its own treatments (flushing...).
52  *
53  * Filters implementing the activate callback should call this function when
54  * they think it might succeed (usually after checking unsuccessfully for a
55  * queued frame).
56  * Filters implementing the filter_frame and request_frame callbacks do not
57  * need to call that since the same treatment happens in ff_filter_frame().
58  *
59  * @param[out] rstatus  new or current status
60  * @param[out] rpts     current timestamp of the link in link time base
61  * @return  >0 if status changed, <0 if status already acked, 0 otherwise
62  */
63 int ff_inlink_acknowledge_status(AVFilterLink *link, int *rstatus, int64_t *rpts);
64
65 #endif /* AVFILTER_FILTERS_H */