FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavfilter/vf_telecine.c
Date: 2024-11-20 23:03:26
Exec Total Coverage
Lines: 121 139 87.1%
Functions: 6 6 100.0%
Branches: 47 62 75.8%
Line Branch Exec Source
1 /*
2 * Copyright (c) 2012 Rudolf Polzer
3 * Copyright (c) 2013 Paul B Mahol
4 *
5 * This file is part of FFmpeg.
6 *
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22 /**
23 * @file telecine filter, heavily based from mpv-player:TOOLS/vf_dlopen/telecine.c by
24 * Rudolf Polzer.
25 */
26
27 #include "libavutil/avstring.h"
28 #include "libavutil/imgutils.h"
29 #include "libavutil/opt.h"
30 #include "libavutil/pixdesc.h"
31 #include "avfilter.h"
32 #include "filters.h"
33 #include "formats.h"
34 #include "video.h"
35
36 typedef struct TelecineContext {
37 const AVClass *class;
38 int first_field;
39 char *pattern;
40 unsigned int pattern_pos;
41 int64_t start_time;
42
43 AVRational pts;
44 AVRational ts_unit;
45 int out_cnt;
46 int occupied;
47
48 int nb_planes;
49 int planeheight[4];
50 int stride[4];
51
52 AVFrame *frame[5];
53 AVFrame *temp;
54 } TelecineContext;
55
56 #define OFFSET(x) offsetof(TelecineContext, x)
57 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
58
59 static const AVOption telecine_options[] = {
60 {"first_field", "select first field", OFFSET(first_field), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, .unit = "field"},
61 {"top", "select top field first", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, .unit = "field"},
62 {"t", "select top field first", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, .unit = "field"},
63 {"bottom", "select bottom field first", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, .unit = "field"},
64 {"b", "select bottom field first", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, .unit = "field"},
65 {"pattern", "pattern that describe for how many fields a frame is to be displayed", OFFSET(pattern), AV_OPT_TYPE_STRING, {.str="23"}, 0, 0, FLAGS},
66 {NULL}
67 };
68
69 AVFILTER_DEFINE_CLASS(telecine);
70
71 36 static av_cold int init(AVFilterContext *ctx)
72 {
73 36 TelecineContext *s = ctx->priv;
74 const char *p;
75 36 int max = 0;
76
77
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 36 times.
 36 if (!strlen(s->pattern)) {
78 ✗ av_log(ctx, AV_LOG_ERROR, "No pattern provided.\n");
79 ✗ return AVERROR_INVALIDDATA;
80 }
81
82
2/2
✓ Branch 0 taken 72 times.
✓ Branch 1 taken 36 times.
 108 for (p = s->pattern; *p; p++) {
83
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 72 times.
 72 if (!av_isdigit(*p)) {
84 ✗ av_log(ctx, AV_LOG_ERROR, "Provided pattern includes non-numeric characters.\n");
85 ✗ return AVERROR_INVALIDDATA;
86 }
87
88 72 max = FFMAX(*p - '0', max);
89 72 s->pts.num += 2;
90 72 s->pts.den += *p - '0';
91 }
92
93 36 s->start_time = AV_NOPTS_VALUE;
94
95 36 s->out_cnt = (max + 1) / 2;
96 36 av_log(ctx, AV_LOG_INFO, "Telecine pattern %s yields up to %d frames per frame, pts advance factor: %d/%d\n",
97 s->pattern, s->out_cnt, s->pts.num, s->pts.den);
98
99 36 return 0;
100 }
101
102 18 static int query_formats(const AVFilterContext *ctx,
103 AVFilterFormatsConfig **cfg_in,
104 AVFilterFormatsConfig **cfg_out)
105 {
106 18 int reject_flags = AV_PIX_FMT_FLAG_BITSTREAM |
107 AV_PIX_FMT_FLAG_HWACCEL |
108 AV_PIX_FMT_FLAG_PAL;
109
110 18 return ff_set_common_formats2(ctx, cfg_in, cfg_out,
111 ff_formats_pixdesc_filter(0, reject_flags));
112 }
113
114 18 static int config_input(AVFilterLink *inlink)
115 {
116 18 TelecineContext *s = inlink->dst->priv;
117 18 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
118 int i, ret;
119
120 18 s->temp = ff_get_video_buffer(inlink, inlink->w, inlink->h);
121
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 18 times.
 18 if (!s->temp)
122 ✗ return AVERROR(ENOMEM);
123
2/2
✓ Branch 0 taken 36 times.
✓ Branch 1 taken 18 times.
 54 for (i = 0; i < s->out_cnt; i++) {
124 36 s->frame[i] = ff_get_video_buffer(inlink, inlink->w, inlink->h);
125
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 36 times.
 36 if (!s->frame[i])
126 ✗ return AVERROR(ENOMEM);
127 }
128
129
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 18 times.
 18 if ((ret = av_image_fill_linesizes(s->stride, inlink->format, inlink->w)) < 0)
130 ✗ return ret;
131
132 18 s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
133 18 s->planeheight[0] = s->planeheight[3] = inlink->h;
134
135 18 s->nb_planes = av_pix_fmt_count_planes(inlink->format);
136
137 18 return 0;
138 }
139
140 18 static int config_output(AVFilterLink *outlink)
141 {
142 18 AVFilterContext *ctx = outlink->src;
143 18 TelecineContext *s = ctx->priv;
144 18 AVFilterLink *inlink = ctx->inputs[0];
145 18 FilterLink *il = ff_filter_link(inlink);
146 18 FilterLink *ol = ff_filter_link(outlink);
147 18 AVRational fps = il->frame_rate;
148
149
2/4
✓ Branch 0 taken 18 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 18 times.
 18 if (!fps.num || !fps.den) {
150 ✗ av_log(ctx, AV_LOG_ERROR, "The input needs a constant frame rate; "
151 "current rate of %d/%d is invalid\n", fps.num, fps.den);
152 ✗ return AVERROR(EINVAL);
153 }
154 18 fps = av_mul_q(fps, av_inv_q(s->pts));
155 18 av_log(ctx, AV_LOG_VERBOSE, "FPS: %d/%d -> %d/%d\n",
156 il->frame_rate.num, il->frame_rate.den, fps.num, fps.den);
157
158 18 ol->frame_rate = fps;
159 18 outlink->time_base = av_mul_q(inlink->time_base, s->pts);
160 18 av_log(ctx, AV_LOG_VERBOSE, "TB: %d/%d -> %d/%d\n",
161 inlink->time_base.num, inlink->time_base.den, outlink->time_base.num, outlink->time_base.den);
162
163 18 s->ts_unit = av_inv_q(av_mul_q(fps, outlink->time_base));
164
165 18 return 0;
166 }
167
168 479 static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
169 {
170 479 AVFilterContext *ctx = inlink->dst;
171 479 AVFilterLink *outlink = ctx->outputs[0];
172 479 FilterLink *outl = ff_filter_link(outlink);
173 479 TelecineContext *s = ctx->priv;
174 479 int i, len, ret = 0, nout = 0;
175
176
2/2
✓ Branch 0 taken 18 times.
✓ Branch 1 taken 461 times.
 479 if (s->start_time == AV_NOPTS_VALUE)
177 18 s->start_time = inpicref->pts;
178
179 479 len = s->pattern[s->pattern_pos] - '0';
180
181 479 s->pattern_pos++;
182
2/2
✓ Branch 0 taken 231 times.
✓ Branch 1 taken 248 times.
 479 if (!s->pattern[s->pattern_pos])
183 231 s->pattern_pos = 0;
184
185
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 479 times.
 479 if (!len) { // do not output any field from this frame
186 ✗ av_frame_free(&inpicref);
187 ✗ return 0;
188 }
189
190
2/2
✓ Branch 0 taken 230 times.
✓ Branch 1 taken 249 times.
 479 if (s->occupied) {
191 230 ret = ff_inlink_make_frame_writable(inlink, &s->frame[nout]);
192
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 230 times.
 230 if (ret < 0) {
193 ✗ av_frame_free(&inpicref);
194 ✗ return ret;
195 }
196
2/2
✓ Branch 0 taken 690 times.
✓ Branch 1 taken 230 times.
 920 for (i = 0; i < s->nb_planes; i++) {
197 // fill in the EARLIER field from the buffered pic
198 690 av_image_copy_plane(s->frame[nout]->data[i] + s->frame[nout]->linesize[i] * s->first_field,
199 690 s->frame[nout]->linesize[i] * 2,
200 690 s->temp->data[i] + s->temp->linesize[i] * s->first_field,
201 690 s->temp->linesize[i] * 2,
202 s->stride[i],
203 690 (s->planeheight[i] - s->first_field + 1) / 2);
204 // fill in the LATER field from the new pic
205 690 av_image_copy_plane(s->frame[nout]->data[i] + s->frame[nout]->linesize[i] * !s->first_field,
206 690 s->frame[nout]->linesize[i] * 2,
207 690 inpicref->data[i] + inpicref->linesize[i] * !s->first_field,
208 690 inpicref->linesize[i] * 2,
209 s->stride[i],
210 690 (s->planeheight[i] - !s->first_field + 1) / 2);
211 }
212 #if FF_API_INTERLACED_FRAME
213 FF_DISABLE_DEPRECATION_WARNINGS
214 230 s->frame[nout]->interlaced_frame = 1;
215 230 s->frame[nout]->top_field_first = !s->first_field;
216 FF_ENABLE_DEPRECATION_WARNINGS
217 #endif
218 230 s->frame[nout]->flags |= AV_FRAME_FLAG_INTERLACED;
219
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 230 times.
 230 if (s->first_field)
220 ✗ s->frame[nout]->flags &= ~AV_FRAME_FLAG_TOP_FIELD_FIRST;
221 else
222 230 s->frame[nout]->flags |= AV_FRAME_FLAG_TOP_FIELD_FIRST;
223 230 nout++;
224 230 len--;
225 230 s->occupied = 0;
226 }
227
228
2/2
✓ Branch 0 taken 358 times.
✓ Branch 1 taken 479 times.
 837 while (len >= 2) {
229 // output THIS image as-is
230 358 ret = ff_inlink_make_frame_writable(inlink, &s->frame[nout]);
231
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 358 times.
 358 if (ret < 0) {
232 ✗ av_frame_free(&inpicref);
233 ✗ return ret;
234 }
235
2/2
✓ Branch 0 taken 1074 times.
✓ Branch 1 taken 358 times.
 1432 for (i = 0; i < s->nb_planes; i++)
236 1074 av_image_copy_plane(s->frame[nout]->data[i], s->frame[nout]->linesize[i],
237 1074 inpicref->data[i], inpicref->linesize[i],
238 s->stride[i],
239 s->planeheight[i]);
240 #if FF_API_INTERLACED_FRAME
241 FF_DISABLE_DEPRECATION_WARNINGS
242 358 s->frame[nout]->interlaced_frame = inpicref->interlaced_frame;
243 358 s->frame[nout]->top_field_first = inpicref->top_field_first;
244 FF_ENABLE_DEPRECATION_WARNINGS
245 #endif
246 358 s->frame[nout]->flags |= (inpicref->flags & (AV_FRAME_FLAG_INTERLACED | AV_FRAME_FLAG_TOP_FIELD_FIRST));
247 358 nout++;
248 358 len -= 2;
249 }
250
251
2/2
✓ Branch 0 taken 243 times.
✓ Branch 1 taken 236 times.
 479 if (len >= 1) {
252 // copy THIS image to the buffer, we need it later
253
2/2
✓ Branch 0 taken 729 times.
✓ Branch 1 taken 243 times.
 972 for (i = 0; i < s->nb_planes; i++)
254 729 av_image_copy_plane(s->temp->data[i], s->temp->linesize[i],
255 729 inpicref->data[i], inpicref->linesize[i],
256 s->stride[i],
257 s->planeheight[i]);
258 243 s->occupied = 1;
259 }
260
261
2/2
✓ Branch 0 taken 588 times.
✓ Branch 1 taken 479 times.
 1067 for (i = 0; i < nout; i++) {
262 588 AVFrame *frame = av_frame_clone(s->frame[i]);
263
3/4
✓ Branch 0 taken 588 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 443 times.
✓ Branch 3 taken 145 times.
 588 int interlaced = frame ? !!(frame->flags & AV_FRAME_FLAG_INTERLACED) : 0;
264
3/4
✓ Branch 0 taken 588 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 443 times.
✓ Branch 3 taken 145 times.
 588 int tff = frame ? !!(frame->flags & AV_FRAME_FLAG_TOP_FIELD_FIRST) : 0;
265
266
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 588 times.
 588 if (!frame) {
267 ✗ av_frame_free(&inpicref);
268 ✗ return AVERROR(ENOMEM);
269 }
270
271 588 av_frame_copy_props(frame, inpicref);
272 #if FF_API_INTERLACED_FRAME
273 FF_DISABLE_DEPRECATION_WARNINGS
274 588 frame->interlaced_frame = interlaced;
275 588 frame->top_field_first = tff;
276 FF_ENABLE_DEPRECATION_WARNINGS
277 #endif
278
2/2
✓ Branch 0 taken 443 times.
✓ Branch 1 taken 145 times.
 588 if (interlaced)
279 443 frame->flags |= AV_FRAME_FLAG_INTERLACED;
280 else
281 145 frame->flags &= ~AV_FRAME_FLAG_INTERLACED;
282
2/2
✓ Branch 0 taken 443 times.
✓ Branch 1 taken 145 times.
 588 if (tff)
283 443 frame->flags |= AV_FRAME_FLAG_TOP_FIELD_FIRST;
284 else
285 145 frame->flags &= ~AV_FRAME_FLAG_TOP_FIELD_FIRST;
286
1/2
✓ Branch 0 taken 588 times.
✗ Branch 1 not taken.
 588 frame->pts = ((s->start_time == AV_NOPTS_VALUE) ? 0 : s->start_time) +
287 588 av_rescale(outl->frame_count_in, s->ts_unit.num,
288 588 s->ts_unit.den);
289 588 ret = ff_filter_frame(outlink, frame);
290 }
291 479 av_frame_free(&inpicref);
292
293 479 return ret;
294 }
295
296 36 static av_cold void uninit(AVFilterContext *ctx)
297 {
298 36 TelecineContext *s = ctx->priv;
299 int i;
300
301 36 av_frame_free(&s->temp);
302
2/2
✓ Branch 0 taken 72 times.
✓ Branch 1 taken 36 times.
 108 for (i = 0; i < s->out_cnt; i++)
303 72 av_frame_free(&s->frame[i]);
304 36 }
305
306 static const AVFilterPad telecine_inputs[] = {
307 {
308 .name = "default",
309 .type = AVMEDIA_TYPE_VIDEO,
310 .filter_frame = filter_frame,
311 .config_props = config_input,
312 },
313 };
314
315 static const AVFilterPad telecine_outputs[] = {
316 {
317 .name = "default",
318 .type = AVMEDIA_TYPE_VIDEO,
319 .config_props = config_output,
320 },
321 };
322
323 const AVFilter ff_vf_telecine = {
324 .name = "telecine",
325 .description = NULL_IF_CONFIG_SMALL("Apply a telecine pattern."),
326 .priv_size = sizeof(TelecineContext),
327 .priv_class = &telecine_class,
328 .init = init,
329 .uninit = uninit,
330 FILTER_INPUTS(telecine_inputs),
331 FILTER_OUTPUTS(telecine_outputs),
332 FILTER_QUERY_FUNC2(query_formats),
333 };
334