lavfi: make FFERROR_NOT_READY available to filters.
[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  * Special return code when activate() did not do anything.
32  */
33 #define FFERROR_NOT_READY FFERRTAG('N','R','D','Y')
34
35 /**
36  * Mark a filter ready and schedule it for activation.
37  *
38  * This is automatically done when something happens to the filter (queued
39  * frame, status change, request on output).
40  * Filters implementing the activate callback can call it directly to
41  * perform one more round of processing later.
42  * It is also useful for filters reacting to external or asynchronous
43  * events.
44  */
45 void ff_filter_set_ready(AVFilterContext *filter, unsigned priority);
46
47 /**
48  * Process the commands queued in the link up to the time of the frame.
49  * Commands will trigger the process_command() callback.
50  * @return  >= 0 or AVERROR code.
51  */
52 int ff_inlink_process_commands(AVFilterLink *link, const AVFrame *frame);
53
54 /**
55  * Evaluate the timeline expression of the link for the time and properties
56  * of the frame.
57  * @return  >0 if enabled, 0 if disabled
58  * @note  It does not update link->dst->is_disabled.
59  */
60 int ff_inlink_evaluate_timeline_at_frame(AVFilterLink *link, const AVFrame *frame);
61
62 /**
63  * Test if a frame is available on the link.
64  * @return  >0 if a frame is available
65  */
66 int ff_inlink_check_available_frame(AVFilterLink *link);
67
68 /**
69  * Test if enough samples are available on the link.
70  * @return  >0 if enough samples are available
71  * @note  on EOF and error, min becomes 1
72  */
73 int ff_inlink_check_available_samples(AVFilterLink *link, unsigned min);
74
75 /**
76  * Take a frame from the link's FIFO and update the link's stats.
77  *
78  * If ff_inlink_check_available_frame() was previously called, the
79  * preferred way of expressing it is "av_assert1(ret);" immediately after
80  * ff_inlink_consume_frame(). Negative error codes must still be checked.
81  *
82  * @note  May trigger process_command() and/or update is_disabled.
83  * @return  >0 if a frame is available,
84  *          0 and set rframe to NULL if no frame available,
85  *          or AVERROR code
86  */
87 int ff_inlink_consume_frame(AVFilterLink *link, AVFrame **rframe);
88
89 /**
90  * Take samples from the link's FIFO and update the link's stats.
91  *
92  * If ff_inlink_check_available_samples() was previously called, the
93  * preferred way of expressing it is "av_assert1(ret);" immediately after
94  * ff_inlink_consume_samples(). Negative error codes must still be checked.
95  *
96  * @note  May trigger process_command() and/or update is_disabled.
97  * @return  >0 if a frame is available,
98  *          0 and set rframe to NULL if no frame available,
99  *          or AVERROR code
100  */
101 int ff_inlink_consume_samples(AVFilterLink *link, unsigned min, unsigned max,
102                             AVFrame **rframe);
103
104 /**
105  * Make sure a frame is writable.
106  * This is similar to av_frame_make_writable() except it uses the link's
107  * buffer allocation callback, and therefore allows direct rendering.
108  */
109 int ff_inlink_make_frame_writable(AVFilterLink *link, AVFrame **rframe);
110
111 /**
112  * Test and acknowledge the change of status on the link.
113  *
114  * Status means EOF or an error condition; a change from the normal (0)
115  * status to a non-zero status can be queued in a filter's input link, it
116  * becomes relevant after the frames queued in the link's FIFO are
117  * processed. This function tests if frames are still queued and if a queued
118  * status change has not yet been processed. In that case it performs basic
119  * treatment (updating the link's timestamp) and returns a positive value to
120  * let the filter do its own treatments (flushing...).
121  *
122  * Filters implementing the activate callback should call this function when
123  * they think it might succeed (usually after checking unsuccessfully for a
124  * queued frame).
125  * Filters implementing the filter_frame and request_frame callbacks do not
126  * need to call that since the same treatment happens in ff_filter_frame().
127  *
128  * @param[out] rstatus  new or current status
129  * @param[out] rpts     current timestamp of the link in link time base
130  * @return  >0 if status changed, <0 if status already acked, 0 otherwise
131  */
132 int ff_inlink_acknowledge_status(AVFilterLink *link, int *rstatus, int64_t *rpts);
133
134 /**
135  * Mark that a frame is wanted on the link.
136  * Unlike ff_filter_frame(), it must not be called when the link has a
137  * non-zero status, and thus does not acknowledge it.
138  * Also it cannot fail.
139  */
140 void ff_inlink_request_frame(AVFilterLink *link);
141
142 #endif /* AVFILTER_FILTERS_H */