lavfi: document filter design subtleties.
[ffmpeg.git] / doc / filter_design.txt
1 Filter design
2 =============
3
4 This document explains guidelines that should be observed (or ignored with
5 good reason) when writing filters for libavfilter.
6
7 In this document, the word “frame” indicates either a video frame or a group
8 of audio samples, as stored in an AVFilterBuffer structure.
9
10
11 Format negociation
12 ==================
13
14   The query_formats method should set, for each input and each output links,
15   the list supported formats.
16
17   For video links, that means pixel format. For audio links, that means
18   channel layout, sample format and sample packing.
19
20   The lists are not just lists, they are references to shared objects. When
21   the negociation mechanism computes the intersection of the formats
22   supported at each ends of a link, all references to both lists are
23   replaced with a reference to the intersection. And when a single format is
24   eventually chosen for a link amongst the remaining list, again, all
25   references to the list are updated.
26
27   That means that if a filter requires that its input and output have the
28   same format amongst a supported list, all it have to do is use a reference
29   to the same list of formats.
30
31
32 Buffer references ownership and permissions
33 ===========================================
34
35   TODO
36
37
38 Frame scheduling
39 ================
40
41   The purpose of these rules is to ensure that frames flow in the filter
42   graph without getting stuck and accumulating somewhere.
43
44   Simple filters that output one frame for each input frame should not have
45   to worry about it.
46
47   start_frame / filter_samples
48   ----------------------------
49
50     These methods are called when a frame is pushed to the filter's input.
51     They can be called at any time except in a reentrant way.
52
53     If the input frame is enough to produce output, then the filter should
54     push the output frames on the output link immediately.
55
56     As an exception to the previous rule, if the input frame is enough to
57     produce several output frames, then the filter needs output only at
58     least one per link. The additional frames can be left buffered in the
59     filter; these buffered frames must be flushed immediately if a new input
60     produces new output.
61
62     ( Example: framerate-doubling filter: start_frame must (1) flush the
63     second copy of the previous frame, it it is stille there, (2) push the
64     first copy of the incoming frame, (3) keep the second copy for later. )
65
66     If the input frame is not enough to produce output, the filter must not
67     call request_frame to get more. It must just process the frame or queue
68     it. The task of requesting more frames is left to the filter's
69     request_frame method or the application.
70
71     If a filter has several inputs, the filter must be ready for frames
72     arriving randomly on any input. Therefore, any filter with several input
73     will most likely require some kind of queuing mechanism. It is perfectly
74     acceptable to have a limited queue and to drop frames when the inputs
75     are too unbalanced.
76
77   request_frame
78   -------------
79
80     This method is called when a frame is wanted on an output.
81
82     For an input, it should directly call start_frame or filter_samples on
83     the corresponding output.
84
85     For a filter, if there are queued frames already ready, one of these
86     frames should be pushed. If not, the filter should request a frame on
87     one of its input, repeatedly until at least one frame has been pushed.
88
89     Return values:
90     if request_frame could produce a frame, it should return 0;
91     if it could not for temporary reasons, it should return AVERROR(EAGAIN);
92     if it could not because there are no more frames, it shous return
93     AVERROR_EOF.
94
95     The typical implementation of request_frame for a filter with several
96     inputs will look like that:
97
98         if (frames_queued) {
99             push_one_frame();
100             return 0;
101         }
102         while (!frame_pushed) {
103             input = input_where_a_frame_is_most_needed();
104             ret = avfilter_request_frame(input);
105             if (ret == AVERROR_EOF) {
106                 process_eof_on_input();
107             } else if (ret < 0) {
108                 return ret;
109             }
110         }
111         return 0;
112
113     Note that, except for filters that can have queued frames, request_frame
114     does not push frames: it requests them to its input, and as a reaction,
115     the start_frame / filter_samples method will be called and do the work.