FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libswscale/graph.h
Date: 2026-04-14 14:38:13
Exec Total Coverage
Lines: 3 3 100.0%
Functions: 1 1 100.0%
Branches: 4 4 100.0%
Line Branch Exec Source
1 /*
2 * Copyright (C) 2024 Niklas Haas
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
8 * License 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 GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21 #ifndef SWSCALE_GRAPH_H
22 #define SWSCALE_GRAPH_H
23
24 #include <stdbool.h>
25
26 #include "libavutil/slicethread.h"
27 #include "libavutil/buffer.h"
28
29 #include "swscale.h"
30 #include "format.h"
31
32 1517143 static av_always_inline av_const int ff_fmt_vshift(enum AVPixelFormat fmt, int plane)
33 {
34 1517143 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(fmt);
35
4/4
✓ Branch 0 taken 1020988 times.
✓ Branch 1 taken 496155 times.
✓ Branch 2 taken 331619 times.
✓ Branch 3 taken 689369 times.
 1517143 return (plane == 1 || plane == 2) ? desc->log2_chroma_h : 0;
36 }
37
38 typedef struct SwsPass SwsPass;
39 typedef struct SwsGraph SwsGraph;
40
41 /**
42 * Output `h` lines of filtered data. `out` and `in` point to the
43 * start of the image buffer for this pass.
44 */
45 typedef void (*SwsPassFunc)(const SwsFrame *out, const SwsFrame *in,
46 int y, int h, const SwsPass *pass);
47
48 /**
49 * Function to run from the main thread before processing any lines.
50 */
51 typedef int (*SwsPassSetup)(const SwsFrame *out, const SwsFrame *in,
52 const SwsPass *pass);
53
54 /**
55 * Represents an output buffer for a filter pass. During filter graph
56 * construction, these merely hold the metadata. Allocation of the underlying
57 * storage is deferred until after all filter passes are settled.
58 */
59 typedef struct SwsPassBuffer {
60 SwsFrame frame;
61
62 int width, height; /* dimensions of this buffer */
63 AVFrame *avframe; /* backing storage for `frame` */
64
65 /* Optional allocation hints for optimal performance */
66 int width_align; /* Align width to multiple of this */
67 int width_pad; /* Extra padding pixels */
68 } SwsPassBuffer;
69
70 /**
71 * Represents a single filter pass in the scaling graph. Each filter will
72 * read from some previous pass's output, and write to a buffer associated
73 * with the pass (or into the final output image).
74 */
75 struct SwsPass {
76 const SwsGraph *graph;
77
78 /**
79 * Filter main execution function. Called from multiple threads, with
80 * the granularity dictated by `slice_h`. Individual slices sent to `run`
81 * are always equal to (or smaller than, for the last slice) `slice_h`.
82 */
83 SwsPassFunc run;
84 enum AVPixelFormat format; /* new pixel format */
85 int width, height; /* new output size */
86 int slice_h; /* filter granularity */
87 int num_slices;
88
89 /**
90 * Filter input. This pass's output will be resolved to form this pass's.
91 * input. If NULL, the original input image is used.
92 */
93 SwsPass *input;
94
95 /**
96 * Filter output buffer. This struct is always allocated.
97 */
98 SwsPassBuffer *output; /* refstruct */
99
100 /**
101 * Called once from the main thread before running the filter. Optional.
102 * Returns 0 or a negative error code.
103 */
104 SwsPassSetup setup;
105
106 /**
107 * Optional private state and associated free() function.
108 */
109 void (*free)(void *priv);
110 void *priv;
111 };
112
113 /**
114 * Align `width` to the optimal size for `pass`.
115 */
116 int ff_sws_pass_aligned_width(const SwsPass *pass, int width);
117
118 /**
119 * Filter graph, which represents a 'baked' pixel format conversion.
120 */
121 typedef struct SwsGraph {
122 SwsContext *ctx;
123 AVSliceThread *slicethread;
124 int num_threads; /* resolved at init() time */
125 bool incomplete; /* set during init() if formats had to be inferred */
126 bool noop; /* set during init() if the graph is a no-op */
127
128 AVBufferRef *hw_frames_ref;
129
130 /** Sorted sequence of filter passes to apply */
131 SwsPass **passes;
132 int num_passes;
133
134 /**
135 * Cached copy of the public options that were used to construct this
136 * SwsGraph. Used only to detect when the graph needs to be reinitialized.
137 */
138 SwsContext opts_copy;
139
140 /**
141 * Currently active format and processing parameters.
142 */
143 SwsFormat src, dst;
144 int field;
145
146 /**
147 * Temporary execution state inside ff_sws_graph_run(); used to pass
148 * data to worker threads.
149 */
150 struct {
151 const SwsPass *pass; /* current filter pass */
152 const SwsFrame *input; /* current filter pass input/output */
153 const SwsFrame *output;
154 } exec;
155 } SwsGraph;
156
157 /**
158 * Allocate and initialize the filter graph. Returns 0 or a negative error.
159 */
160 int ff_sws_graph_create(SwsContext *ctx, const SwsFormat *dst, const SwsFormat *src,
161 int field, SwsGraph **out_graph);
162
163
164 /**
165 * Allocate and add a new pass to the filter graph. Takes over ownership of
166 * `priv`, even on failure.
167 *
168 * @param graph Filter graph to add the pass to.
169 * @param fmt Pixel format of the output image.
170 * @param w Width of the output image.
171 * @param h Height of the output image.
172 * @param input Previous pass to read from, or NULL for the input image.
173 * @param align Minimum slice alignment for this pass, or 0 for no threading.
174 * @param run Filter function to run.
175 * @param setup Optional setup function to run from the main thread.
176 * @param priv Private state for the filter run function.
177 * @param free Function to free the private state.
178 * @param out_pass The newly added pass will be written here on success.
179 * @return 0 or a negative error code
180 */
181 int ff_sws_graph_add_pass(SwsGraph *graph, enum AVPixelFormat fmt,
182 int width, int height, SwsPass *input,
183 int align, SwsPassFunc run, SwsPassSetup setup,
184 void *priv, void (*free)(void *priv),
185 SwsPass **out_pass);
186
187 /**
188 * Remove all passes added since the given index.
189 */
190 void ff_sws_graph_rollback(SwsGraph *graph, int since_idx);
191
192 /**
193 * Uninitialize any state associate with this filter graph and free it.
194 */
195 void ff_sws_graph_free(SwsGraph **graph);
196
197 /**
198 * Update dynamic per-frame HDR metadata without requiring a full reinit.
199 */
200 void ff_sws_graph_update_metadata(SwsGraph *graph, const SwsColor *color);
201
202 /**
203 * Wrapper around ff_sws_graph_create() that reuses the existing graph if the
204 * format is compatible. This will also update dynamic per-frame metadata.
205 * Must be called after changing any of the fields in `ctx`, or else they will
206 * have no effect.
207 */
208 int ff_sws_graph_reinit(SwsContext *ctx, const SwsFormat *dst, const SwsFormat *src,
209 int field, SwsGraph **graph);
210
211 /**
212 * Dispatch the filter graph on a single field of the given frames. Internally
213 * threaded.
214 */
215 int ff_sws_graph_run(SwsGraph *graph, const AVFrame *dst, const AVFrame *src);
216
217 #endif /* SWSCALE_GRAPH_H */
218