2 * Copyright (C) 2012 Mark Himsley
4 * get_scene_score() Copyright (c) 2011 Stefano Sabatini
5 * taken from libavfilter/vf_select.c
7 * This file is part of FFmpeg.
9 * FFmpeg is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * FFmpeg is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with FFmpeg; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
26 * filter for upsampling or downsampling a progressive source
31 #include "libavutil/avassert.h"
32 #include "libavutil/imgutils.h"
33 #include "libavutil/internal.h"
34 #include "libavutil/opt.h"
35 #include "libavutil/pixdesc.h"
36 #include "libavutil/pixelutils.h"
41 #include "framerate.h"
43 #define OFFSET(x) offsetof(FrameRateContext, x)
44 #define V AV_OPT_FLAG_VIDEO_PARAM
45 #define F AV_OPT_FLAG_FILTERING_PARAM
46 #define FRAMERATE_FLAG_SCD 01
48 static const AVOption framerate_options[] = {
49 {"fps", "required output frames per second rate", OFFSET(dest_frame_rate), AV_OPT_TYPE_VIDEO_RATE, {.str="50"}, 0, INT_MAX, V|F },
51 {"interp_start", "point to start linear interpolation", OFFSET(interp_start), AV_OPT_TYPE_INT, {.i64=15}, 0, 255, V|F },
52 {"interp_end", "point to end linear interpolation", OFFSET(interp_end), AV_OPT_TYPE_INT, {.i64=240}, 0, 255, V|F },
53 {"scene", "scene change level", OFFSET(scene_score), AV_OPT_TYPE_DOUBLE, {.dbl=8.2}, 0, INT_MAX, V|F },
55 {"flags", "set flags", OFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64=1}, 0, INT_MAX, V|F, "flags" },
56 {"scene_change_detect", "enable scene change detection", 0, AV_OPT_TYPE_CONST, {.i64=FRAMERATE_FLAG_SCD}, INT_MIN, INT_MAX, V|F, "flags" },
57 {"scd", "enable scene change detection", 0, AV_OPT_TYPE_CONST, {.i64=FRAMERATE_FLAG_SCD}, INT_MIN, INT_MAX, V|F, "flags" },
62 AVFILTER_DEFINE_CLASS(framerate);
64 static av_always_inline int64_t sad_8x8_16(const uint16_t *src1, ptrdiff_t stride1,
65 const uint16_t *src2, ptrdiff_t stride2)
70 for (y = 0; y < 8; y++) {
71 for (x = 0; x < 8; x++)
72 sum += FFABS(src1[x] - src2[x]);
79 static int64_t scene_sad16(FrameRateContext *s, const uint16_t *p1, int p1_linesize, const uint16_t* p2, int p2_linesize, const int width, const int height)
83 for (sad = y = 0; y < height - 7; y += 8) {
84 for (x = 0; x < width - 7; x += 8) {
85 sad += sad_8x8_16(p1 + y * p1_linesize + x,
87 p2 + y * p2_linesize + x,
94 static int64_t scene_sad8(FrameRateContext *s, uint8_t *p1, int p1_linesize, uint8_t* p2, int p2_linesize, const int width, const int height)
98 for (sad = y = 0; y < height - 7; y += 8) {
99 for (x = 0; x < width - 7; x += 8) {
100 sad += s->sad(p1 + y * p1_linesize + x,
102 p2 + y * p2_linesize + x,
110 static double get_scene_score(AVFilterContext *ctx, AVFrame *crnt, AVFrame *next)
112 FrameRateContext *s = ctx->priv;
115 ff_dlog(ctx, "get_scene_score()\n");
117 if (crnt->height == next->height &&
118 crnt->width == next->width) {
122 ff_dlog(ctx, "get_scene_score() process\n");
123 if (s->bitdepth == 8)
124 sad = scene_sad8(s, crnt->data[0], crnt->linesize[0], next->data[0], next->linesize[0], crnt->width, crnt->height);
126 sad = scene_sad16(s, (const uint16_t*)crnt->data[0], crnt->linesize[0] / 2, (const uint16_t*)next->data[0], next->linesize[0] / 2, crnt->width, crnt->height);
128 mafd = (double)sad * 100.0 / FFMAX(1, (crnt->height & ~7) * (crnt->width & ~7)) / (1 << s->bitdepth);
129 diff = fabs(mafd - s->prev_mafd);
130 ret = av_clipf(FFMIN(mafd, diff), 0, 100.0);
133 ff_dlog(ctx, "get_scene_score() result is:%f\n", ret);
137 typedef struct ThreadData {
138 AVFrame *copy_src1, *copy_src2;
139 uint16_t src1_factor, src2_factor;
142 static int filter_slice(AVFilterContext *ctx, void *arg, int job, int nb_jobs)
144 FrameRateContext *s = ctx->priv;
145 ThreadData *td = arg;
146 uint16_t src1_factor = td->src1_factor;
147 uint16_t src2_factor = td->src2_factor;
150 for (plane = 0; plane < 4 && td->copy_src1->data[plane] && td->copy_src2->data[plane]; plane++) {
151 int cpy_line_width = s->line_size[plane];
152 uint8_t *cpy_src1_data = td->copy_src1->data[plane];
153 int cpy_src1_line_size = td->copy_src1->linesize[plane];
154 uint8_t *cpy_src2_data = td->copy_src2->data[plane];
155 int cpy_src2_line_size = td->copy_src2->linesize[plane];
156 int cpy_src_h = (plane > 0 && plane < 3) ? (td->copy_src1->height >> s->vsub) : (td->copy_src1->height);
157 uint8_t *cpy_dst_data = s->work->data[plane];
158 int cpy_dst_line_size = s->work->linesize[plane];
159 const int start = (cpy_src_h * job ) / nb_jobs;
160 const int end = (cpy_src_h * (job+1)) / nb_jobs;
161 cpy_src1_data += start * cpy_src1_line_size;
162 cpy_src2_data += start * cpy_src2_line_size;
163 cpy_dst_data += start * cpy_dst_line_size;
165 s->blend(cpy_src1_data, cpy_src1_line_size,
166 cpy_src2_data, cpy_src2_line_size,
167 cpy_dst_data, cpy_dst_line_size,
168 cpy_line_width, end - start,
169 src1_factor, src2_factor, s->blend_factor_max >> 1);
175 static int blend_frames(AVFilterContext *ctx, int interpolate)
177 FrameRateContext *s = ctx->priv;
178 AVFilterLink *outlink = ctx->outputs[0];
179 double interpolate_scene_score = 0;
181 if ((s->flags & FRAMERATE_FLAG_SCD)) {
183 interpolate_scene_score = s->score;
185 interpolate_scene_score = s->score = get_scene_score(ctx, s->f0, s->f1);
186 ff_dlog(ctx, "blend_frames() interpolate scene score:%f\n", interpolate_scene_score);
188 // decide if the shot-change detection allows us to blend two frames
189 if (interpolate_scene_score < s->scene_score) {
191 td.copy_src1 = s->f0;
192 td.copy_src2 = s->f1;
193 td.src2_factor = interpolate;
194 td.src1_factor = s->blend_factor_max - td.src2_factor;
196 // get work-space for output frame
197 s->work = ff_get_video_buffer(outlink, outlink->w, outlink->h);
199 return AVERROR(ENOMEM);
201 av_frame_copy_props(s->work, s->f0);
203 ff_dlog(ctx, "blend_frames() INTERPOLATE to create work frame\n");
204 ctx->internal->execute(ctx, filter_slice, &td, NULL, FFMIN(FFMAX(1, outlink->h >> 2), ff_filter_get_nb_threads(ctx)));
210 static int process_work_frame(AVFilterContext *ctx)
212 FrameRateContext *s = ctx->priv;
214 int64_t interpolate, interpolate8;
219 if (!s->f0 && !s->flush)
222 work_pts = s->start_pts + av_rescale_q(s->n, av_inv_q(s->dest_frame_rate), s->dest_time_base);
224 if (work_pts >= s->pts1 && !s->flush)
228 s->work = av_frame_clone(s->f1);
230 if (work_pts >= s->pts1 + s->delta && s->flush)
233 interpolate = av_rescale(work_pts - s->pts0, s->blend_factor_max, s->delta);
234 interpolate8 = av_rescale(work_pts - s->pts0, 256, s->delta);
235 ff_dlog(ctx, "process_work_frame() interpolate: %"PRId64"/256\n", interpolate8);
236 if (interpolate >= s->blend_factor_max || interpolate8 > s->interp_end) {
237 s->work = av_frame_clone(s->f1);
238 } else if (interpolate <= 0 || interpolate8 < s->interp_start) {
239 s->work = av_frame_clone(s->f0);
241 ret = blend_frames(ctx, interpolate);
245 s->work = av_frame_clone(interpolate > (s->blend_factor_max >> 1) ? s->f1 : s->f0);
250 return AVERROR(ENOMEM);
252 s->work->pts = work_pts;
258 static av_cold int init(AVFilterContext *ctx)
260 FrameRateContext *s = ctx->priv;
261 s->start_pts = AV_NOPTS_VALUE;
265 static av_cold void uninit(AVFilterContext *ctx)
267 FrameRateContext *s = ctx->priv;
268 av_frame_free(&s->f0);
269 av_frame_free(&s->f1);
272 static int query_formats(AVFilterContext *ctx)
274 static const enum AVPixelFormat pix_fmts[] = {
276 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUVJ411P,
277 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUVJ420P,
278 AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVJ422P,
279 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUVJ440P,
280 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVJ444P,
281 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV420P12,
282 AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV422P12,
283 AV_PIX_FMT_YUV444P9, AV_PIX_FMT_YUV444P10, AV_PIX_FMT_YUV444P12,
287 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
289 return AVERROR(ENOMEM);
290 return ff_set_common_formats(ctx, fmts_list);
293 static void blend_frames_c(BLEND_FUNC_PARAMS)
296 for (line = 0; line < height; line++) {
297 for (pixel = 0; pixel < width; pixel++)
298 dst[pixel] = ((src1[pixel] * factor1) + (src2[pixel] * factor2) + half) >> BLEND_FACTOR_DEPTH8;
299 src1 += src1_linesize;
300 src2 += src2_linesize;
305 static void blend_frames16_c(BLEND_FUNC_PARAMS)
308 uint16_t *dstw = (uint16_t *)dst;
309 uint16_t *src1w = (uint16_t *)src1;
310 uint16_t *src2w = (uint16_t *)src2;
315 for (line = 0; line < height; line++) {
316 for (pixel = 0; pixel < width; pixel++)
317 dstw[pixel] = ((src1w[pixel] * factor1) + (src2w[pixel] * factor2) + half) >> BLEND_FACTOR_DEPTH16;
318 src1w += src1_linesize;
319 src2w += src2_linesize;
320 dstw += dst_linesize;
324 void ff_framerate_init(FrameRateContext *s)
326 if (s->bitdepth == 8) {
327 s->blend_factor_max = 1 << BLEND_FACTOR_DEPTH8;
328 s->blend = blend_frames_c;
330 s->blend_factor_max = 1 << BLEND_FACTOR_DEPTH16;
331 s->blend = blend_frames16_c;
334 ff_framerate_init_x86(s);
337 static int config_input(AVFilterLink *inlink)
339 AVFilterContext *ctx = inlink->dst;
340 FrameRateContext *s = ctx->priv;
341 const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
344 for (plane = 0; plane < 4; plane++) {
345 s->line_size[plane] = av_image_get_linesize(inlink->format, inlink->w,
349 s->bitdepth = pix_desc->comp[0].depth;
350 s->vsub = pix_desc->log2_chroma_h;
352 s->sad = av_pixelutils_get_sad_fn(3, 3, 2, s); // 8x8 both sources aligned
354 return AVERROR(EINVAL);
356 s->srce_time_base = inlink->time_base;
358 ff_framerate_init(s);
363 static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
366 AVFilterContext *ctx = inlink->dst;
367 FrameRateContext *s = ctx->priv;
370 if (inpicref->interlaced_frame)
371 av_log(ctx, AV_LOG_WARNING, "Interlaced frame found - the output will not be correct.\n");
373 if (inpicref->pts == AV_NOPTS_VALUE) {
374 av_log(ctx, AV_LOG_WARNING, "Ignoring frame without PTS.\n");
378 pts = av_rescale_q(inpicref->pts, s->srce_time_base, s->dest_time_base);
379 if (s->f1 && pts == s->pts1) {
380 av_log(ctx, AV_LOG_WARNING, "Ignoring frame with same PTS.\n");
384 av_frame_free(&s->f0);
389 s->delta = s->pts1 - s->pts0;
393 av_log(ctx, AV_LOG_WARNING, "PTS discontinuity.\n");
394 s->start_pts = s->pts1;
396 av_frame_free(&s->f0);
399 if (s->start_pts == AV_NOPTS_VALUE)
400 s->start_pts = s->pts1;
403 ret = process_work_frame(ctx);
406 ret = ff_filter_frame(ctx->outputs[0], s->work);
412 static int config_output(AVFilterLink *outlink)
414 AVFilterContext *ctx = outlink->src;
415 FrameRateContext *s = ctx->priv;
418 ff_dlog(ctx, "config_output()\n");
421 "config_output() input time base:%u/%u (%f)\n",
422 ctx->inputs[0]->time_base.num,ctx->inputs[0]->time_base.den,
423 av_q2d(ctx->inputs[0]->time_base));
425 // make sure timebase is small enough to hold the framerate
427 exact = av_reduce(&s->dest_time_base.num, &s->dest_time_base.den,
428 av_gcd((int64_t)s->srce_time_base.num * s->dest_frame_rate.num,
429 (int64_t)s->srce_time_base.den * s->dest_frame_rate.den ),
430 (int64_t)s->srce_time_base.den * s->dest_frame_rate.num, INT_MAX);
432 av_log(ctx, AV_LOG_INFO,
433 "time base:%u/%u -> %u/%u exact:%d\n",
434 s->srce_time_base.num, s->srce_time_base.den,
435 s->dest_time_base.num, s->dest_time_base.den, exact);
437 av_log(ctx, AV_LOG_WARNING, "Timebase conversion is not exact\n");
440 outlink->frame_rate = s->dest_frame_rate;
441 outlink->time_base = s->dest_time_base;
444 "config_output() output time base:%u/%u (%f) w:%d h:%d\n",
445 outlink->time_base.num, outlink->time_base.den,
446 av_q2d(outlink->time_base),
447 outlink->w, outlink->h);
450 av_log(ctx, AV_LOG_INFO, "fps -> fps:%u/%u scene score:%f interpolate start:%d end:%d\n",
451 s->dest_frame_rate.num, s->dest_frame_rate.den,
452 s->scene_score, s->interp_start, s->interp_end);
457 static int request_frame(AVFilterLink *outlink)
459 AVFilterContext *ctx = outlink->src;
460 FrameRateContext *s = ctx->priv;
463 ff_dlog(ctx, "request_frame()\n");
465 ret = ff_request_frame(ctx->inputs[0]);
466 if (ret == AVERROR_EOF && s->f1 && !s->flush) {
468 ret = process_work_frame(ctx);
471 ret = ret ? ff_filter_frame(ctx->outputs[0], s->work) : AVERROR_EOF;
474 ff_dlog(ctx, "request_frame() source's request_frame() returned:%d\n", ret);
478 static const AVFilterPad framerate_inputs[] = {
481 .type = AVMEDIA_TYPE_VIDEO,
482 .config_props = config_input,
483 .filter_frame = filter_frame,
488 static const AVFilterPad framerate_outputs[] = {
491 .type = AVMEDIA_TYPE_VIDEO,
492 .request_frame = request_frame,
493 .config_props = config_output,
498 AVFilter ff_vf_framerate = {
500 .description = NULL_IF_CONFIG_SMALL("Upsamples or downsamples progressive source between specified frame rates."),
501 .priv_size = sizeof(FrameRateContext),
502 .priv_class = &framerate_class,
505 .query_formats = query_formats,
506 .inputs = framerate_inputs,
507 .outputs = framerate_outputs,
508 .flags = AVFILTER_FLAG_SLICE_THREADS,