2 * Copyright (c) 2013 Nicolas George
4 * This file is part of FFmpeg.
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.
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.
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
21 #include "libavutil/avassert.h"
22 #include "libavutil/opt.h"
25 #include "framesync.h"
28 #define OFFSET(member) offsetof(FFFrameSync, member)
29 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_FILTERING_PARAM
31 static const char *framesync_name(void *ptr)
36 static const AVOption framesync_options[] = {
37 { "eof_action", "Action to take when encountering EOF from secondary input ",
38 OFFSET(opt_eof_action), AV_OPT_TYPE_INT, { .i64 = EOF_ACTION_REPEAT },
39 EOF_ACTION_REPEAT, EOF_ACTION_PASS, .flags = FLAGS, "eof_action" },
40 { "repeat", "Repeat the previous frame.", 0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_REPEAT }, .flags = FLAGS, "eof_action" },
41 { "endall", "End both streams.", 0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_ENDALL }, .flags = FLAGS, "eof_action" },
42 { "pass", "Pass through the main input.", 0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_PASS }, .flags = FLAGS, "eof_action" },
43 { "shortest", "force termination when the shortest input terminates", OFFSET(opt_shortest), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, FLAGS },
44 { "repeatlast", "extend last frame of secondary streams beyond EOF", OFFSET(opt_repeatlast), AV_OPT_TYPE_BOOL, { .i64 = 1 }, 0, 1, FLAGS },
47 static const AVClass framesync_class = {
48 .version = LIBAVUTIL_VERSION_INT,
49 .class_name = "framesync",
50 .item_name = framesync_name,
51 .category = AV_CLASS_CATEGORY_FILTER,
52 .option = framesync_options,
53 .parent_log_context_offset = OFFSET(parent),
56 const AVClass *ff_framesync_child_class_iterate(void **iter)
58 const AVClass *c = *iter ? NULL : &framesync_class;
59 *iter = (void *)(uintptr_t)c;
69 static int consume_from_fifos(FFFrameSync *fs);
71 const AVClass *ff_framesync_get_class(void)
73 return &framesync_class;
76 void ff_framesync_preinit(FFFrameSync *fs)
80 fs->class = &framesync_class;
81 av_opt_set_defaults(fs);
84 int ff_framesync_init(FFFrameSync *fs, AVFilterContext *parent, unsigned nb_in)
86 /* For filters with several outputs, we will not be able to assume which
87 output is relevant for ff_outlink_frame_wanted() and
88 ff_outlink_set_status(). To be designed when needed. */
89 av_assert0(parent->nb_outputs == 1);
91 ff_framesync_preinit(fs);
95 fs->in = av_calloc(nb_in, sizeof(*fs->in));
97 return AVERROR(ENOMEM);
101 static void framesync_eof(FFFrameSync *fs)
105 ff_outlink_set_status(fs->parent->outputs[0], AVERROR_EOF, AV_NOPTS_VALUE);
108 static void framesync_sync_level_update(FFFrameSync *fs)
110 unsigned i, level = 0;
112 for (i = 0; i < fs->nb_in; i++)
113 if (fs->in[i].state != STATE_EOF)
114 level = FFMAX(level, fs->in[i].sync);
115 av_assert0(level <= fs->sync_level);
116 if (level < fs->sync_level)
117 av_log(fs, AV_LOG_VERBOSE, "Sync level %u\n", level);
119 fs->sync_level = level;
124 int ff_framesync_configure(FFFrameSync *fs)
128 if (!fs->opt_repeatlast || fs->opt_eof_action == EOF_ACTION_PASS) {
129 fs->opt_repeatlast = 0;
130 fs->opt_eof_action = EOF_ACTION_PASS;
132 if (fs->opt_shortest || fs->opt_eof_action == EOF_ACTION_ENDALL) {
133 fs->opt_shortest = 1;
134 fs->opt_eof_action = EOF_ACTION_ENDALL;
136 if (!fs->opt_repeatlast) {
137 for (i = 1; i < fs->nb_in; i++) {
138 fs->in[i].after = EXT_NULL;
142 if (fs->opt_shortest) {
143 for (i = 0; i < fs->nb_in; i++)
144 fs->in[i].after = EXT_STOP;
147 if (!fs->time_base.num) {
148 for (i = 0; i < fs->nb_in; i++) {
149 if (fs->in[i].sync) {
150 if (fs->time_base.num) {
151 fs->time_base = av_gcd_q(fs->time_base, fs->in[i].time_base,
152 AV_TIME_BASE / 2, AV_TIME_BASE_Q);
154 fs->time_base = fs->in[i].time_base;
158 if (!fs->time_base.num) {
159 av_log(fs, AV_LOG_ERROR, "Impossible to set time base\n");
160 return AVERROR(EINVAL);
162 av_log(fs, AV_LOG_VERBOSE, "Selected %d/%d time base\n",
163 fs->time_base.num, fs->time_base.den);
166 for (i = 0; i < fs->nb_in; i++)
167 fs->in[i].pts = fs->in[i].pts_next = AV_NOPTS_VALUE;
168 fs->sync_level = UINT_MAX;
169 framesync_sync_level_update(fs);
174 static int framesync_advance(FFFrameSync *fs)
180 while (!(fs->frame_ready || fs->eof)) {
181 ret = consume_from_fifos(fs);
186 for (i = 0; i < fs->nb_in; i++)
187 if (fs->in[i].have_next && fs->in[i].pts_next < pts)
188 pts = fs->in[i].pts_next;
189 if (pts == INT64_MAX) {
193 for (i = 0; i < fs->nb_in; i++) {
194 if (fs->in[i].pts_next == pts ||
195 (fs->in[i].before == EXT_INFINITY &&
196 fs->in[i].state == STATE_BOF)) {
197 av_frame_free(&fs->in[i].frame);
198 fs->in[i].frame = fs->in[i].frame_next;
199 fs->in[i].pts = fs->in[i].pts_next;
200 fs->in[i].frame_next = NULL;
201 fs->in[i].pts_next = AV_NOPTS_VALUE;
202 fs->in[i].have_next = 0;
203 fs->in[i].state = fs->in[i].frame ? STATE_RUN : STATE_EOF;
204 if (fs->in[i].sync == fs->sync_level && fs->in[i].frame)
206 if (fs->in[i].state == STATE_EOF &&
207 fs->in[i].after == EXT_STOP)
212 for (i = 0; i < fs->nb_in; i++)
213 if ((fs->in[i].state == STATE_BOF &&
214 fs->in[i].before == EXT_STOP))
221 static int64_t framesync_pts_extrapolate(FFFrameSync *fs, unsigned in,
224 /* Possible enhancement: use the link's frame rate */
228 static void framesync_inject_frame(FFFrameSync *fs, unsigned in, AVFrame *frame)
232 av_assert0(!fs->in[in].have_next);
234 pts = av_rescale_q(frame->pts, fs->in[in].time_base, fs->time_base);
236 fs->in[in].frame_next = frame;
237 fs->in[in].pts_next = pts;
238 fs->in[in].have_next = 1;
241 static void framesync_inject_status(FFFrameSync *fs, unsigned in, int status, int64_t pts)
243 av_assert0(!fs->in[in].have_next);
244 pts = fs->in[in].state != STATE_RUN || fs->in[in].after == EXT_INFINITY
245 ? INT64_MAX : framesync_pts_extrapolate(fs, in, fs->in[in].pts);
247 framesync_sync_level_update(fs);
248 fs->in[in].frame_next = NULL;
249 fs->in[in].pts_next = pts;
250 fs->in[in].have_next = 1;
253 int ff_framesync_get_frame(FFFrameSync *fs, unsigned in, AVFrame **rframe,
257 unsigned need_copy = 0, i;
261 if (!fs->in[in].frame) {
265 frame = fs->in[in].frame;
267 /* Find out if we need to copy the frame: is there another sync
268 stream, and do we know if its current frame will outlast this one? */
269 pts_next = fs->in[in].have_next ? fs->in[in].pts_next : INT64_MAX;
270 for (i = 0; i < fs->nb_in && !need_copy; i++)
271 if (i != in && fs->in[i].sync &&
272 (!fs->in[i].have_next || fs->in[i].pts_next < pts_next))
275 if (!(frame = av_frame_clone(frame)))
276 return AVERROR(ENOMEM);
277 if ((ret = av_frame_make_writable(frame)) < 0) {
278 av_frame_free(&frame);
282 fs->in[in].frame = NULL;
290 void ff_framesync_uninit(FFFrameSync *fs)
294 for (i = 0; i < fs->nb_in; i++) {
295 av_frame_free(&fs->in[i].frame);
296 av_frame_free(&fs->in[i].frame_next);
302 static int consume_from_fifos(FFFrameSync *fs)
304 AVFilterContext *ctx = fs->parent;
305 AVFrame *frame = NULL;
307 unsigned i, nb_active, nb_miss;
310 nb_active = nb_miss = 0;
311 for (i = 0; i < fs->nb_in; i++) {
312 if (fs->in[i].have_next || fs->in[i].state == STATE_EOF)
315 ret = ff_inlink_consume_frame(ctx->inputs[i], &frame);
320 framesync_inject_frame(fs, i, frame);
322 ret = ff_inlink_acknowledge_status(ctx->inputs[i], &status, &pts);
324 framesync_inject_status(fs, i, status, pts);
331 if (nb_miss == nb_active && !ff_outlink_frame_wanted(ctx->outputs[0]))
332 return FFERROR_NOT_READY;
333 for (i = 0; i < fs->nb_in; i++)
334 if (!fs->in[i].have_next && fs->in[i].state != STATE_EOF)
335 ff_inlink_request_frame(ctx->inputs[i]);
341 int ff_framesync_activate(FFFrameSync *fs)
345 ret = framesync_advance(fs);
348 if (fs->eof || !fs->frame_ready)
350 ret = fs->on_event(fs);
358 int ff_framesync_init_dualinput(FFFrameSync *fs, AVFilterContext *parent)
362 ret = ff_framesync_init(fs, parent, 2);
365 fs->in[0].time_base = parent->inputs[0]->time_base;
366 fs->in[1].time_base = parent->inputs[1]->time_base;
368 fs->in[0].before = EXT_STOP;
369 fs->in[0].after = EXT_INFINITY;
371 fs->in[1].before = EXT_NULL;
372 fs->in[1].after = EXT_INFINITY;
376 int ff_framesync_dualinput_get(FFFrameSync *fs, AVFrame **f0, AVFrame **f1)
378 AVFilterContext *ctx = fs->parent;
379 AVFrame *mainpic = NULL, *secondpic = NULL;
382 if ((ret = ff_framesync_get_frame(fs, 0, &mainpic, 1)) < 0 ||
383 (ret = ff_framesync_get_frame(fs, 1, &secondpic, 0)) < 0) {
384 av_frame_free(&mainpic);
388 mainpic->pts = av_rescale_q(fs->pts, fs->time_base, ctx->outputs[0]->time_base);
389 if (ctx->is_disabled)
396 int ff_framesync_dualinput_get_writable(FFFrameSync *fs, AVFrame **f0, AVFrame **f1)
400 ret = ff_framesync_dualinput_get(fs, f0, f1);
403 ret = ff_inlink_make_frame_writable(fs->parent->inputs[0], f0);