avfilter/vf_framerate: change blend factor precision
[ffmpeg.git] / libavfilter / vf_framerate.c
1 /*
2  * Copyright (C) 2012 Mark Himsley
3  *
4  * get_scene_score() Copyright (c) 2011 Stefano Sabatini
5  * taken from libavfilter/vf_select.c
6  *
7  * This file is part of FFmpeg.
8  *
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.
13  *
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.
18  *
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
22  */
23
24 /**
25  * @file
26  * filter for upsampling or downsampling a progressive source
27  */
28
29 #define DEBUG
30
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"
37
38 #include "avfilter.h"
39 #include "internal.h"
40 #include "video.h"
41
42 #define BLEND_FUNC_PARAMS const uint8_t *src1, ptrdiff_t src1_linesize, \
43                           const uint8_t *src2, ptrdiff_t src2_linesize, \
44                           uint8_t *dst, ptrdiff_t dst_linesize, \
45                           ptrdiff_t width, ptrdiff_t height, \
46                           int factor1, int factor2, int half
47
48 #define BLEND_FACTOR_DEPTH8   7
49 #define BLEND_FACTOR_DEPTH16 15
50
51 typedef void (*blend_func)(BLEND_FUNC_PARAMS);
52
53 typedef struct FrameRateContext {
54     const AVClass *class;
55     // parameters
56     AVRational dest_frame_rate;         ///< output frames per second
57     int flags;                          ///< flags affecting frame rate conversion algorithm
58     double scene_score;                 ///< score that denotes a scene change has happened
59     int interp_start;                   ///< start of range to apply linear interpolation
60     int interp_end;                     ///< end of range to apply linear interpolation
61
62     int line_size[4];                   ///< bytes of pixel data per line for each plane
63     int vsub;
64
65     AVRational srce_time_base;          ///< timebase of source
66     AVRational dest_time_base;          ///< timebase of destination
67
68     av_pixelutils_sad_fn sad;           ///< Sum of the absolute difference function (scene detect only)
69     double prev_mafd;                   ///< previous MAFD                           (scene detect only)
70
71     int blend_factor_max;
72     int bitdepth;
73     AVFrame *work;
74
75     AVFrame *f0;                        ///< last frame
76     AVFrame *f1;                        ///< current frame
77     int64_t pts0;                       ///< last frame pts in dest_time_base
78     int64_t pts1;                       ///< current frame pts in dest_time_base
79     int64_t delta;                      ///< pts1 to pts0 delta
80     double score;                       ///< scene change score (f0 to f1)
81     int flush;                          ///< 1 if the filter is being flushed
82     int64_t start_pts;                  ///< pts of the first output frame
83     int64_t n;                          ///< output frame counter
84
85     blend_func blend;
86 } FrameRateContext;
87
88 #define OFFSET(x) offsetof(FrameRateContext, x)
89 #define V AV_OPT_FLAG_VIDEO_PARAM
90 #define F AV_OPT_FLAG_FILTERING_PARAM
91 #define FRAMERATE_FLAG_SCD 01
92
93 static const AVOption framerate_options[] = {
94     {"fps",                 "required output frames per second rate", OFFSET(dest_frame_rate), AV_OPT_TYPE_VIDEO_RATE, {.str="50"},             0,       INT_MAX, V|F },
95
96     {"interp_start",        "point to start linear interpolation",    OFFSET(interp_start),    AV_OPT_TYPE_INT,      {.i64=15},                 0,       255,     V|F },
97     {"interp_end",          "point to end linear interpolation",      OFFSET(interp_end),      AV_OPT_TYPE_INT,      {.i64=240},                0,       255,     V|F },
98     {"scene",               "scene change level",                     OFFSET(scene_score),     AV_OPT_TYPE_DOUBLE,   {.dbl=8.2},                0,       INT_MAX, V|F },
99
100     {"flags",               "set flags",                              OFFSET(flags),           AV_OPT_TYPE_FLAGS,    {.i64=1},                  0,       INT_MAX, V|F, "flags" },
101     {"scene_change_detect", "enable scene change detection",          0,                       AV_OPT_TYPE_CONST,    {.i64=FRAMERATE_FLAG_SCD}, INT_MIN, INT_MAX, V|F, "flags" },
102     {"scd",                 "enable scene change detection",          0,                       AV_OPT_TYPE_CONST,    {.i64=FRAMERATE_FLAG_SCD}, INT_MIN, INT_MAX, V|F, "flags" },
103
104     {NULL}
105 };
106
107 AVFILTER_DEFINE_CLASS(framerate);
108
109 static av_always_inline int64_t sad_8x8_16(const uint16_t *src1, ptrdiff_t stride1,
110                                            const uint16_t *src2, ptrdiff_t stride2)
111 {
112     int sum = 0;
113     int x, y;
114
115     for (y = 0; y < 8; y++) {
116         for (x = 0; x < 8; x++)
117             sum += FFABS(src1[x] - src2[x]);
118         src1 += stride1;
119         src2 += stride2;
120     }
121     return sum;
122 }
123
124 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)
125 {
126     int64_t sad;
127     int x, y;
128     for (sad = y = 0; y < height - 7; y += 8) {
129         for (x = 0; x < width - 7; x += 8) {
130             sad += sad_8x8_16(p1 + y * p1_linesize + x,
131                               p1_linesize,
132                               p2 + y * p2_linesize + x,
133                               p2_linesize);
134         }
135     }
136     return sad;
137 }
138
139 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)
140 {
141     int64_t sad;
142     int x, y;
143     for (sad = y = 0; y < height - 7; y += 8) {
144         for (x = 0; x < width - 7; x += 8) {
145             sad += s->sad(p1 + y * p1_linesize + x,
146                           p1_linesize,
147                           p2 + y * p2_linesize + x,
148                           p2_linesize);
149         }
150     }
151     emms_c();
152     return sad;
153 }
154
155 static double get_scene_score(AVFilterContext *ctx, AVFrame *crnt, AVFrame *next)
156 {
157     FrameRateContext *s = ctx->priv;
158     double ret = 0;
159
160     ff_dlog(ctx, "get_scene_score()\n");
161
162     if (crnt->height == next->height &&
163         crnt->width  == next->width) {
164         int64_t sad;
165         double mafd, diff;
166
167         ff_dlog(ctx, "get_scene_score() process\n");
168         if (s->bitdepth == 8)
169             sad = scene_sad8(s, crnt->data[0], crnt->linesize[0], next->data[0], next->linesize[0], crnt->width, crnt->height);
170         else
171             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);
172
173         mafd = (double)sad * 100.0 / FFMAX(1, (crnt->height & ~7) * (crnt->width & ~7)) / (1 << s->bitdepth);
174         diff = fabs(mafd - s->prev_mafd);
175         ret  = av_clipf(FFMIN(mafd, diff), 0, 100.0);
176         s->prev_mafd = mafd;
177     }
178     ff_dlog(ctx, "get_scene_score() result is:%f\n", ret);
179     return ret;
180 }
181
182 typedef struct ThreadData {
183     AVFrame *copy_src1, *copy_src2;
184     uint16_t src1_factor, src2_factor;
185 } ThreadData;
186
187 static int filter_slice(AVFilterContext *ctx, void *arg, int job, int nb_jobs)
188 {
189     FrameRateContext *s = ctx->priv;
190     ThreadData *td = arg;
191     uint16_t src1_factor = td->src1_factor;
192     uint16_t src2_factor = td->src2_factor;
193     int plane;
194
195     for (plane = 0; plane < 4 && td->copy_src1->data[plane] && td->copy_src2->data[plane]; plane++) {
196         int cpy_line_width = s->line_size[plane];
197         uint8_t *cpy_src1_data = td->copy_src1->data[plane];
198         int cpy_src1_line_size = td->copy_src1->linesize[plane];
199         uint8_t *cpy_src2_data = td->copy_src2->data[plane];
200         int cpy_src2_line_size = td->copy_src2->linesize[plane];
201         int cpy_src_h = (plane > 0 && plane < 3) ? (td->copy_src1->height >> s->vsub) : (td->copy_src1->height);
202         uint8_t *cpy_dst_data = s->work->data[plane];
203         int cpy_dst_line_size = s->work->linesize[plane];
204         const int start = (cpy_src_h *  job   ) / nb_jobs;
205         const int end   = (cpy_src_h * (job+1)) / nb_jobs;
206         cpy_src1_data += start * cpy_src1_line_size;
207         cpy_src2_data += start * cpy_src2_line_size;
208         cpy_dst_data += start * cpy_dst_line_size;
209
210         s->blend(cpy_src1_data, cpy_src1_line_size,
211                  cpy_src2_data, cpy_src2_line_size,
212                  cpy_dst_data,  cpy_dst_line_size,
213                  cpy_line_width, end - start,
214                  src1_factor, src2_factor, s->blend_factor_max >> 1);
215     }
216
217     return 0;
218 }
219
220 static int blend_frames(AVFilterContext *ctx, int interpolate)
221 {
222     FrameRateContext *s = ctx->priv;
223     AVFilterLink *outlink = ctx->outputs[0];
224     double interpolate_scene_score = 0;
225
226     if ((s->flags & FRAMERATE_FLAG_SCD)) {
227         if (s->score >= 0.0)
228             interpolate_scene_score = s->score;
229         else
230             interpolate_scene_score = s->score = get_scene_score(ctx, s->f0, s->f1);
231         ff_dlog(ctx, "blend_frames() interpolate scene score:%f\n", interpolate_scene_score);
232     }
233     // decide if the shot-change detection allows us to blend two frames
234     if (interpolate_scene_score < s->scene_score) {
235         ThreadData td;
236         td.copy_src1 = s->f0;
237         td.copy_src2 = s->f1;
238         td.src2_factor = interpolate;
239         td.src1_factor = s->blend_factor_max - td.src2_factor;
240
241         // get work-space for output frame
242         s->work = ff_get_video_buffer(outlink, outlink->w, outlink->h);
243         if (!s->work)
244             return AVERROR(ENOMEM);
245
246         av_frame_copy_props(s->work, s->f0);
247
248         ff_dlog(ctx, "blend_frames() INTERPOLATE to create work frame\n");
249         ctx->internal->execute(ctx, filter_slice, &td, NULL, FFMIN(outlink->h, ff_filter_get_nb_threads(ctx)));
250         return 1;
251     }
252     return 0;
253 }
254
255 static int process_work_frame(AVFilterContext *ctx)
256 {
257     FrameRateContext *s = ctx->priv;
258     int64_t work_pts;
259     int64_t interpolate, interpolate8;
260     int ret;
261
262     if (!s->f1)
263         return 0;
264     if (!s->f0 && !s->flush)
265         return 0;
266
267     work_pts = s->start_pts + av_rescale_q(s->n, av_inv_q(s->dest_frame_rate), s->dest_time_base);
268
269     if (work_pts >= s->pts1 && !s->flush)
270         return 0;
271
272     if (!s->f0) {
273         s->work = av_frame_clone(s->f1);
274     } else {
275         if (work_pts >= s->pts1 + s->delta && s->flush)
276             return 0;
277
278         interpolate = av_rescale(work_pts - s->pts0, s->blend_factor_max, s->delta);
279         interpolate8 = av_rescale(work_pts - s->pts0, 256, s->delta);
280         ff_dlog(ctx, "process_work_frame() interpolate: %"PRId64"/256\n", interpolate8);
281         if (interpolate >= s->blend_factor_max || interpolate8 > s->interp_end) {
282             s->work = av_frame_clone(s->f1);
283         } else if (interpolate <= 0 || interpolate8 < s->interp_start) {
284             s->work = av_frame_clone(s->f0);
285         } else {
286             ret = blend_frames(ctx, interpolate);
287             if (ret < 0)
288                 return ret;
289             if (ret == 0)
290                 s->work = av_frame_clone(interpolate > (s->blend_factor_max >> 1) ? s->f1 : s->f0);
291         }
292     }
293
294     if (!s->work)
295         return AVERROR(ENOMEM);
296
297     s->work->pts = work_pts;
298     s->n++;
299
300     return 1;
301 }
302
303 static av_cold int init(AVFilterContext *ctx)
304 {
305     FrameRateContext *s = ctx->priv;
306     s->start_pts = AV_NOPTS_VALUE;
307     return 0;
308 }
309
310 static av_cold void uninit(AVFilterContext *ctx)
311 {
312     FrameRateContext *s = ctx->priv;
313     av_frame_free(&s->f0);
314     av_frame_free(&s->f1);
315 }
316
317 static int query_formats(AVFilterContext *ctx)
318 {
319     static const enum AVPixelFormat pix_fmts[] = {
320         AV_PIX_FMT_YUV410P,
321         AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUVJ411P,
322         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUVJ420P,
323         AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVJ422P,
324         AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUVJ440P,
325         AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVJ444P,
326         AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV420P12,
327         AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV422P12,
328         AV_PIX_FMT_YUV444P9, AV_PIX_FMT_YUV444P10, AV_PIX_FMT_YUV444P12,
329         AV_PIX_FMT_NONE
330     };
331
332     AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
333     if (!fmts_list)
334         return AVERROR(ENOMEM);
335     return ff_set_common_formats(ctx, fmts_list);
336 }
337
338 static void blend_frames_c(BLEND_FUNC_PARAMS)
339 {
340     int line, pixel;
341     for (line = 0; line < height; line++) {
342         for (pixel = 0; pixel < width; pixel++)
343             dst[pixel] = ((src1[pixel] * factor1) + (src2[pixel] * factor2) + half) >> BLEND_FACTOR_DEPTH8;
344         src1 += src1_linesize;
345         src2 += src2_linesize;
346         dst  += dst_linesize;
347     }
348 }
349
350 static void blend_frames16_c(BLEND_FUNC_PARAMS)
351 {
352     int line, pixel;
353     uint16_t *dstw = (uint16_t *)dst;
354     uint16_t *src1w = (uint16_t *)src1;
355     uint16_t *src2w = (uint16_t *)src2;
356     width /= 2;
357     src1_linesize /= 2;
358     src2_linesize /= 2;
359     dst_linesize /= 2;
360     for (line = 0; line < height; line++) {
361         for (pixel = 0; pixel < width; pixel++)
362             dstw[pixel] = ((src1w[pixel] * factor1) + (src2w[pixel] * factor2) + half) >> BLEND_FACTOR_DEPTH16;
363         src1w += src1_linesize;
364         src2w += src2_linesize;
365         dstw  += dst_linesize;
366     }
367 }
368
369 static int config_input(AVFilterLink *inlink)
370 {
371     AVFilterContext *ctx = inlink->dst;
372     FrameRateContext *s = ctx->priv;
373     const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
374     int plane;
375
376     for (plane = 0; plane < 4; plane++) {
377         s->line_size[plane] = av_image_get_linesize(inlink->format, inlink->w,
378                                                     plane);
379     }
380
381     s->bitdepth = pix_desc->comp[0].depth;
382     s->vsub = pix_desc->log2_chroma_h;
383
384     s->sad = av_pixelutils_get_sad_fn(3, 3, 2, s); // 8x8 both sources aligned
385     if (!s->sad)
386         return AVERROR(EINVAL);
387
388     s->srce_time_base = inlink->time_base;
389
390     if (s->bitdepth == 8) {
391         s->blend_factor_max = 1 << BLEND_FACTOR_DEPTH8;
392         s->blend = blend_frames_c;
393     } else {
394         s->blend_factor_max = 1 << BLEND_FACTOR_DEPTH16;
395         s->blend = blend_frames16_c;
396     }
397
398     return 0;
399 }
400
401 static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
402 {
403     int ret;
404     AVFilterContext *ctx = inlink->dst;
405     FrameRateContext *s = ctx->priv;
406     int64_t pts;
407
408     if (inpicref->interlaced_frame)
409         av_log(ctx, AV_LOG_WARNING, "Interlaced frame found - the output will not be correct.\n");
410
411     if (inpicref->pts == AV_NOPTS_VALUE) {
412         av_log(ctx, AV_LOG_WARNING, "Ignoring frame without PTS.\n");
413         return 0;
414     }
415
416     pts = av_rescale_q(inpicref->pts, s->srce_time_base, s->dest_time_base);
417     if (s->f1 && pts == s->pts1) {
418         av_log(ctx, AV_LOG_WARNING, "Ignoring frame with same PTS.\n");
419         return 0;
420     }
421
422     av_frame_free(&s->f0);
423     s->f0 = s->f1;
424     s->pts0 = s->pts1;
425     s->f1 = inpicref;
426     s->pts1 = pts;
427     s->delta = s->pts1 - s->pts0;
428     s->score = -1.0;
429
430     if (s->delta < 0) {
431         av_log(ctx, AV_LOG_WARNING, "PTS discontinuity.\n");
432         s->start_pts = s->pts1;
433         s->n = 0;
434         av_frame_free(&s->f0);
435     }
436
437     if (s->start_pts == AV_NOPTS_VALUE)
438         s->start_pts = s->pts1;
439
440     do {
441         ret = process_work_frame(ctx);
442         if (ret <= 0)
443             return ret;
444         ret = ff_filter_frame(ctx->outputs[0], s->work);
445     } while (ret >= 0);
446
447     return ret;
448 }
449
450 static int config_output(AVFilterLink *outlink)
451 {
452     AVFilterContext *ctx = outlink->src;
453     FrameRateContext *s = ctx->priv;
454     int exact;
455
456     ff_dlog(ctx, "config_output()\n");
457
458     ff_dlog(ctx,
459            "config_output() input time base:%u/%u (%f)\n",
460            ctx->inputs[0]->time_base.num,ctx->inputs[0]->time_base.den,
461            av_q2d(ctx->inputs[0]->time_base));
462
463     // make sure timebase is small enough to hold the framerate
464
465     exact = av_reduce(&s->dest_time_base.num, &s->dest_time_base.den,
466                       av_gcd((int64_t)s->srce_time_base.num * s->dest_frame_rate.num,
467                              (int64_t)s->srce_time_base.den * s->dest_frame_rate.den ),
468                       (int64_t)s->srce_time_base.den * s->dest_frame_rate.num, INT_MAX);
469
470     av_log(ctx, AV_LOG_INFO,
471            "time base:%u/%u -> %u/%u exact:%d\n",
472            s->srce_time_base.num, s->srce_time_base.den,
473            s->dest_time_base.num, s->dest_time_base.den, exact);
474     if (!exact) {
475         av_log(ctx, AV_LOG_WARNING, "Timebase conversion is not exact\n");
476     }
477
478     outlink->frame_rate = s->dest_frame_rate;
479     outlink->time_base = s->dest_time_base;
480
481     ff_dlog(ctx,
482            "config_output() output time base:%u/%u (%f) w:%d h:%d\n",
483            outlink->time_base.num, outlink->time_base.den,
484            av_q2d(outlink->time_base),
485            outlink->w, outlink->h);
486
487
488     av_log(ctx, AV_LOG_INFO, "fps -> fps:%u/%u scene score:%f interpolate start:%d end:%d\n",
489             s->dest_frame_rate.num, s->dest_frame_rate.den,
490             s->scene_score, s->interp_start, s->interp_end);
491
492     return 0;
493 }
494
495 static int request_frame(AVFilterLink *outlink)
496 {
497     AVFilterContext *ctx = outlink->src;
498     FrameRateContext *s = ctx->priv;
499     int ret;
500
501     ff_dlog(ctx, "request_frame()\n");
502
503     ret = ff_request_frame(ctx->inputs[0]);
504     if (ret == AVERROR_EOF && s->f1 && !s->flush) {
505         s->flush = 1;
506         ret = process_work_frame(ctx);
507         if (ret < 0)
508             return ret;
509         ret = ret ? ff_filter_frame(ctx->outputs[0], s->work) : AVERROR_EOF;
510     }
511
512     ff_dlog(ctx, "request_frame() source's request_frame() returned:%d\n", ret);
513     return ret;
514 }
515
516 static const AVFilterPad framerate_inputs[] = {
517     {
518         .name         = "default",
519         .type         = AVMEDIA_TYPE_VIDEO,
520         .config_props = config_input,
521         .filter_frame = filter_frame,
522     },
523     { NULL }
524 };
525
526 static const AVFilterPad framerate_outputs[] = {
527     {
528         .name          = "default",
529         .type          = AVMEDIA_TYPE_VIDEO,
530         .request_frame = request_frame,
531         .config_props  = config_output,
532     },
533     { NULL }
534 };
535
536 AVFilter ff_vf_framerate = {
537     .name          = "framerate",
538     .description   = NULL_IF_CONFIG_SMALL("Upsamples or downsamples progressive source between specified frame rates."),
539     .priv_size     = sizeof(FrameRateContext),
540     .priv_class    = &framerate_class,
541     .init          = init,
542     .uninit        = uninit,
543     .query_formats = query_formats,
544     .inputs        = framerate_inputs,
545     .outputs       = framerate_outputs,
546     .flags         = AVFILTER_FLAG_SLICE_THREADS,
547 };