FFmpeg coverage


Directory: ../../../ffmpeg/
File: src/libavfilter/avfilter_internal.h
Date: 2026-04-24 19:58:39
Exec Total Coverage
Lines: 6 6 100.0%
Functions: 3 3 100.0%
Branches: 0 0 -%

Line Branch Exec Source
1 /*
2 * This file is part of FFmpeg.
3 *
4 * FFmpeg 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 * FFmpeg 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 FFmpeg; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18
19 /*
20 * APIs internal to the generic filter(graph) layer.
21 *
22 * MUST NOT be included by individual filters.
23 */
24
25 #ifndef AVFILTER_AVFILTER_INTERNAL_H
26 #define AVFILTER_AVFILTER_INTERNAL_H
27
28 #include <stdint.h>
29
30 #include "avfilter.h"
31 #include "filters.h"
32 #include "framepool.h"
33 #include "framequeue.h"
34
35 typedef struct FilterLinkInternal {
36 FilterLink l;
37
38 /**
39 * Pool of frames used for allocations.
40 */
41 FFFramePool frame_pool;
42
43 /**
44 * Queue of frames waiting to be filtered.
45 */
46 FFFrameQueue fifo;
47
48 /**
49 * If set, the source filter can not generate a frame as is.
50 * The goal is to avoid repeatedly calling the request_frame() method on
51 * the same link.
52 */
53 int frame_blocked_in;
54
55 /**
56 * Link input status.
57 * If not zero, all attempts of filter_frame will fail with the
58 * corresponding code.
59 */
60 int status_in;
61
62 /**
63 * Timestamp of the input status change.
64 */
65 int64_t status_in_pts;
66
67 /**
68 * Link output status.
69 * If not zero, all attempts of request_frame will fail with the
70 * corresponding code.
71 */
72 int status_out;
73
74 /**
75 * True if a frame is currently wanted on the output of this filter.
76 * Set when ff_request_frame() is called by the output,
77 * cleared when a frame is filtered.
78 */
79 int frame_wanted_out;
80
81 /**
82 * Index in the age array.
83 */
84 int age_index;
85
86 /** stage of the initialization of the link properties (dimensions, etc) */
87 enum {
88 AVLINK_UNINIT = 0, ///< not started
89 AVLINK_STARTINIT, ///< started, but incomplete
90 AVLINK_INIT ///< complete
91 } init_state;
92 } FilterLinkInternal;
93
94 35871032 static inline FilterLinkInternal *ff_link_internal(AVFilterLink *link)
95 {
96 35871032 return (FilterLinkInternal*)link;
97 }
98
99 typedef struct FFFilterContext {
100 /**
101 * The public AVFilterContext. See avfilter.h for it.
102 */
103 AVFilterContext p;
104
105 avfilter_execute_func *execute;
106
107 // AV_CLASS_STATE_FLAG_*
108 unsigned state_flags;
109
110 /**
111 * Ready status of the filter.
112 * A non-0 value means that the filter needs activating;
113 * a higher value suggests a more urgent activation.
114 */
115 unsigned ready;
116
117 /// parsed expression
118 struct AVExpr *enable;
119 /// variable values for the enable expression
120 double *var_values;
121
122 struct AVFilterCommand *command_queue;
123 } FFFilterContext;
124
125 39881706 static inline FFFilterContext *fffilterctx(AVFilterContext *ctx)
126 {
127 39881706 return (FFFilterContext*)ctx;
128 }
129
130 typedef struct AVFilterCommand {
131 double time; ///< time expressed in seconds
132 char *command; ///< command
133 char *arg; ///< optional argument for the command
134 int flags;
135 struct AVFilterCommand *next;
136 } AVFilterCommand;
137
138 typedef struct FFFilterGraph {
139 /**
140 * The public AVFilterGraph. See avfilter.h for it.
141 */
142 AVFilterGraph p;
143
144 struct FilterLinkInternal **sink_links;
145 int sink_links_count;
146
147 unsigned disable_auto_convert;
148
149 void *thread;
150 avfilter_execute_func *thread_execute;
151 FFFrameQueueGlobal frame_queues;
152 } FFFilterGraph;
153
154 1070818 static inline FFFilterGraph *fffiltergraph(AVFilterGraph *graph)
155 {
156 1070818 return (FFFilterGraph*)graph;
157 }
158
159 /**
160 * Update the position of a link in the age heap.
161 */
162 void ff_avfilter_graph_update_heap(AVFilterGraph *graph,
163 struct FilterLinkInternal *li);
164
165 /**
166 * Allocate a new filter context and return it.
167 *
168 * @param filter what filter to create an instance of
169 * @param inst_name name to give to the new filter context
170 *
171 * @return newly created filter context or NULL on failure
172 */
173 AVFilterContext *ff_filter_alloc(const AVFilter *filter, const char *inst_name);
174
175 /**
176 * Remove a filter from a graph;
177 */
178 void ff_filter_graph_remove_filter(AVFilterGraph *graph, AVFilterContext *filter);
179
180 int ff_filter_activate(AVFilterContext *filter);
181
182 /**
183 * Parse filter options into a dictionary.
184 *
185 * @param logctx context for logging
186 * @param priv_class a filter's private class for shorthand options or NULL
187 * @param options dictionary to store parsed options in
188 * @param args options string to parse
189 *
190 * @return a non-negative number on success, a negative error code on failure
191 */
192 int ff_filter_opt_parse(void *logctx, const AVClass *priv_class,
193 AVDictionary **options, const char *args);
194
195 int ff_graph_thread_init(FFFilterGraph *graph);
196
197 void ff_graph_thread_free(FFFilterGraph *graph);
198
199 /**
200 * Negotiate the media format, dimensions, etc of all inputs to a filter.
201 *
202 * @param filter the filter to negotiate the properties for its inputs
203 * @return zero on successful negotiation
204 */
205 int ff_filter_config_links(AVFilterContext *filter);
206
207 /* misc trace functions */
208
209 #define FF_TPRINTF_START(ctx, func) ff_tlog(NULL, "%-16s: ", #func)
210
211 #ifdef TRACE
212 void ff_tlog_link(void *ctx, AVFilterLink *link, int end);
213 #else
214 #define ff_tlog_link(ctx, link, end) do { } while(0)
215 #endif
216
217 /**
218 * Run one round of processing on a filter graph.
219 */
220 int ff_filter_graph_run_once(AVFilterGraph *graph);
221
222 /**
223 * Process the commands queued in the link up to the time of the frame.
224 * Commands will trigger the process_command() callback.
225 * @return >= 0 or AVERROR code.
226 */
227 int ff_inlink_process_commands(AVFilterLink *link, const AVFrame *frame);
228
229 #endif /* AVFILTER_AVFILTER_INTERNAL_H */
230