libavfilter/vf_idet.c
e3e89b6d
 /*
  * Copyright (C) 2012 Michael Niedermayer <michaelni@gmx.at>
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
43cbd440
 #include <float.h> /* FLT_MAX */
 
e3e89b6d
 #include "libavutil/cpu.h"
 #include "libavutil/common.h"
43cbd440
 #include "libavutil/opt.h"
c9e183b4
 #include "internal.h"
406a9ccf
 #include "vf_idet.h"
e3e89b6d
 
43cbd440
 #define OFFSET(x) offsetof(IDETContext, x)
 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
 
 static const AVOption idet_options[] = {
cdb7a1ac
     { "intl_thres", "set interlacing threshold", OFFSET(interlace_threshold),   AV_OPT_TYPE_FLOAT, {.dbl = 1.04}, -1, FLT_MAX, FLAGS },
     { "prog_thres", "set progressive threshold", OFFSET(progressive_threshold), AV_OPT_TYPE_FLOAT, {.dbl = 1.5},  -1, FLT_MAX, FLAGS },
fdf22f97
     { "rep_thres",  "set repeat threshold",      OFFSET(repeat_threshold),      AV_OPT_TYPE_FLOAT, {.dbl = 3.0},  -1, FLT_MAX, FLAGS },
fe6f5f29
     { "half_life", "half life of cumulative statistics", OFFSET(half_life),     AV_OPT_TYPE_FLOAT, {.dbl = 0.0},  -1, INT_MAX, FLAGS },
a79ac73b
     { "analyze_interlaced_flag", "set number of frames to use to determine if the interlace flag is accurate", OFFSET(analyze_interlaced_flag), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, FLAGS },
43cbd440
     { NULL }
 };
 
 AVFILTER_DEFINE_CLASS(idet);
 
0477254d
 static const char *type2str(Type type)
 {
     switch(type) {
ae6118de
         case TFF          : return "tff";
         case BFF          : return "bff";
         case PROGRESSIVE  : return "progressive";
         case UNDETERMINED : return "undetermined";
0477254d
     }
     return NULL;
 }
e3e89b6d
 
fe6f5f29
 #define PRECISION 1048576
 
 static uint64_t uintpow(uint64_t b,unsigned int e)
 {
     uint64_t r=1;
     while(e--) r*=b;
     return r;
 }
 
 static int av_dict_set_fxp(AVDictionary **pm, const char *key, uint64_t value, unsigned int digits,
                 int flags)
 {
     char valuestr[44];
5d590d87
     uint64_t print_precision = uintpow(10, digits);
 
     value = av_rescale(value, print_precision, PRECISION);
 
fe6f5f29
     snprintf(valuestr, sizeof(valuestr), "%"PRId64".%0*"PRId64,
5d590d87
              value / print_precision, digits, value % print_precision);
 
fe6f5f29
     return av_dict_set(pm, key, valuestr, flags);
 }
 
fdf22f97
 static const char *rep2str(RepeatedField repeated_field)
 {
     switch(repeated_field) {
         case REPEAT_NONE    : return "neither";
         case REPEAT_TOP     : return "top";
         case REPEAT_BOTTOM  : return "bottom";
     }
     return NULL;
 }
 
406a9ccf
 int ff_idet_filter_line_c(const uint8_t *a, const uint8_t *b, const uint8_t *c, int w)
e3e89b6d
 {
     int x;
     int ret=0;
 
     for(x=0; x<w; x++){
dc9edb06
         int v = (*a++ + *c++) - 2 * *b++;
         ret += FFABS(v);
e3e89b6d
     }
 
     return ret;
 }
 
e3fd6a3a
 int ff_idet_filter_line_c_16bit(const uint16_t *a, const uint16_t *b, const uint16_t *c, int w)
e3e89b6d
 {
     int x;
     int ret=0;
 
     for(x=0; x<w; x++){
dc9edb06
         int v = (*a++ + *c++) - 2 * *b++;
         ret += FFABS(v);
e3e89b6d
     }
 
     return ret;
 }
 
 static void filter(AVFilterContext *ctx)
 {
     IDETContext *idet = ctx->priv;
     int y, i;
     int64_t alpha[2]={0};
     int64_t delta=0;
fdf22f97
     int64_t gamma[2]={0};
fa1f92a4
     Type type, best_type;
fdf22f97
     RepeatedField repeat;
fa1f92a4
     int match = 0;
6af050d7
     AVDictionary **metadata = &idet->cur->metadata;
e3e89b6d
 
     for (i = 0; i < idet->csp->nb_components; i++) {
a05a44e2
         int w = idet->cur->width;
         int h = idet->cur->height;
e3e89b6d
         int refs = idet->cur->linesize[i];
 
         if (i && i<3) {
21f94684
             w = AV_CEIL_RSHIFT(w, idet->csp->log2_chroma_w);
             h = AV_CEIL_RSHIFT(h, idet->csp->log2_chroma_h);
e3e89b6d
         }
 
         for (y = 2; y < h - 2; y++) {
             uint8_t *prev = &idet->prev->data[i][y*refs];
             uint8_t *cur  = &idet->cur ->data[i][y*refs];
             uint8_t *next = &idet->next->data[i][y*refs];
             alpha[ y   &1] += idet->filter_line(cur-refs, prev, cur+refs, w);
             alpha[(y^1)&1] += idet->filter_line(cur-refs, next, cur+refs, w);
             delta          += idet->filter_line(cur-refs,  cur, cur+refs, w);
fdf22f97
             gamma[(y^1)&1] += idet->filter_line(cur     , prev, cur     , w);
e3e89b6d
         }
     }
 
31fdf306
     if      (alpha[0] > idet->interlace_threshold * alpha[1]){
ca2b450c
         type = TFF;
31fdf306
     }else if(alpha[1] > idet->interlace_threshold * alpha[0]){
ca2b450c
         type = BFF;
31fdf306
     }else if(alpha[1] > idet->progressive_threshold * delta){
7ac6b8cf
         type = PROGRESSIVE;
ca2b450c
     }else{
         type = UNDETERMINED;
     }
 
fdf22f97
     if ( gamma[0] > idet->repeat_threshold * gamma[1] ){
         repeat = REPEAT_TOP;
     } else if ( gamma[1] > idet->repeat_threshold * gamma[0] ){
         repeat = REPEAT_BOTTOM;
     } else {
         repeat = REPEAT_NONE;
     }
 
fa1f92a4
     memmove(idet->history+1, idet->history, HIST_SIZE-1);
     idet->history[0] = type;
     best_type = UNDETERMINED;
     for(i=0; i<HIST_SIZE; i++){
         if(idet->history[i] != UNDETERMINED){
             if(best_type == UNDETERMINED)
                 best_type = idet->history[i];
 
             if(idet->history[i] == best_type) {
                 match++;
             }else{
                 match=0;
                 break;
             }
         }
     }
     if(idet->last_type == UNDETERMINED){
         if(match  ) idet->last_type = best_type;
     }else{
         if(match>2) idet->last_type = best_type;
     }
1a5c08ee
 
     if      (idet->last_type == TFF){
a05a44e2
         idet->cur->top_field_first = 1;
         idet->cur->interlaced_frame = 1;
1a5c08ee
     }else if(idet->last_type == BFF){
a05a44e2
         idet->cur->top_field_first = 0;
         idet->cur->interlaced_frame = 1;
7ac6b8cf
     }else if(idet->last_type == PROGRESSIVE){
a05a44e2
         idet->cur->interlaced_frame = 0;
e3e89b6d
     }
0477254d
 
fdf22f97
     for(i=0; i<3; i++)
         idet->repeats[i]  = av_rescale(idet->repeats [i], idet->decay_coefficient, PRECISION);
fe6f5f29
 
     for(i=0; i<4; i++){
4bbd8f05
         idet->prestat [i] = av_rescale(idet->prestat [i], idet->decay_coefficient, PRECISION);
         idet->poststat[i] = av_rescale(idet->poststat[i], idet->decay_coefficient, PRECISION);
fe6f5f29
     }
 
fdf22f97
     idet->total_repeats [         repeat] ++;
     idet->repeats       [         repeat] += PRECISION;
 
fe6f5f29
     idet->total_prestat [           type] ++;
     idet->prestat       [           type] += PRECISION;
 
     idet->total_poststat[idet->last_type] ++;
     idet->poststat      [idet->last_type] += PRECISION;
28478438
 
fdf22f97
     av_log(ctx, AV_LOG_DEBUG, "Repeated Field:%12s, Single frame:%12s, Multi frame:%12s\n",
            rep2str(repeat), type2str(type), type2str(idet->last_type));
 
     av_dict_set    (metadata, "lavfi.idet.repeated.current_frame", rep2str(repeat), 0);
     av_dict_set_fxp(metadata, "lavfi.idet.repeated.neither",       idet->repeats[REPEAT_NONE], 2, 0);
     av_dict_set_fxp(metadata, "lavfi.idet.repeated.top",           idet->repeats[REPEAT_TOP], 2, 0);
     av_dict_set_fxp(metadata, "lavfi.idet.repeated.bottom",        idet->repeats[REPEAT_BOTTOM], 2, 0);
28478438
 
fe6f5f29
     av_dict_set    (metadata, "lavfi.idet.single.current_frame",   type2str(type), 0);
     av_dict_set_fxp(metadata, "lavfi.idet.single.tff",             idet->prestat[TFF], 2 , 0);
     av_dict_set_fxp(metadata, "lavfi.idet.single.bff",             idet->prestat[BFF], 2, 0);
     av_dict_set_fxp(metadata, "lavfi.idet.single.progressive",     idet->prestat[PROGRESSIVE], 2, 0);
     av_dict_set_fxp(metadata, "lavfi.idet.single.undetermined",    idet->prestat[UNDETERMINED], 2, 0);
28478438
 
ae6118de
     av_dict_set    (metadata, "lavfi.idet.multiple.current_frame", type2str(idet->last_type), 0);
fe6f5f29
     av_dict_set_fxp(metadata, "lavfi.idet.multiple.tff",           idet->poststat[TFF], 2, 0);
     av_dict_set_fxp(metadata, "lavfi.idet.multiple.bff",           idet->poststat[BFF], 2, 0);
     av_dict_set_fxp(metadata, "lavfi.idet.multiple.progressive",   idet->poststat[PROGRESSIVE], 2, 0);
     av_dict_set_fxp(metadata, "lavfi.idet.multiple.undetermined",  idet->poststat[UNDETERMINED], 2, 0);
e3e89b6d
 }
 
a05a44e2
 static int filter_frame(AVFilterLink *link, AVFrame *picref)
e3e89b6d
 {
     AVFilterContext *ctx = link->dst;
     IDETContext *idet = ctx->priv;
 
a79ac73b
     // initial frame(s) and not interlaced, just pass through for
     // the analyze_interlaced_flag mode
     if (idet->analyze_interlaced_flag &&
         !picref->interlaced_frame &&
         !idet->next) {
         return ff_filter_frame(ctx->outputs[0], picref);
     }
     if (idet->analyze_interlaced_flag_done) {
         if (picref->interlaced_frame && idet->interlaced_flag_accuracy < 0)
             picref->interlaced_frame = 0;
         return ff_filter_frame(ctx->outputs[0], picref);
     }
 
5c1a8d3b
     av_frame_free(&idet->prev);
 
56a33b23
     if(   picref->width  != link->w
        || picref->height != link->h
        || picref->format != link->format) {
         link->dst->inputs[0]->format = picref->format;
         link->dst->inputs[0]->w      = picref->width;
         link->dst->inputs[0]->h      = picref->height;
 
         av_frame_free(&idet->cur );
         av_frame_free(&idet->next);
     }
 
e3e89b6d
     idet->prev = idet->cur;
     idet->cur  = idet->next;
     idet->next = picref;
 
dd5d6179
     if (!idet->cur &&
         !(idet->cur = av_frame_clone(idet->next)))
         return AVERROR(ENOMEM);
e3e89b6d
 
     if (!idet->prev)
dd5d6179
         return 0;
e3e89b6d
 
     if (!idet->csp)
79393a83
         idet->csp = av_pix_fmt_desc_get(link->format);
5d8e836d
     if (idet->csp->comp[0].depth > 8){
e3fd6a3a
         idet->filter_line = (ff_idet_filter_func)ff_idet_filter_line_c_16bit;
         if (ARCH_X86)
             ff_idet_init_x86(idet, 1);
     }
e3e89b6d
 
a79ac73b
     if (idet->analyze_interlaced_flag) {
         if (idet->cur->interlaced_frame) {
             idet->cur->interlaced_frame = 0;
             filter(ctx);
             if (idet->last_type == PROGRESSIVE) {
                 idet->interlaced_flag_accuracy --;
                 idet->analyze_interlaced_flag --;
             } else if (idet->last_type != UNDETERMINED) {
                 idet->interlaced_flag_accuracy ++;
                 idet->analyze_interlaced_flag --;
             }
             if (idet->analyze_interlaced_flag == 1) {
                 ff_filter_frame(ctx->outputs[0], av_frame_clone(idet->cur));
 
                 if (idet->next->interlaced_frame && idet->interlaced_flag_accuracy < 0)
                     idet->next->interlaced_frame = 0;
                 idet->analyze_interlaced_flag_done = 1;
                 av_log(ctx, AV_LOG_INFO, "Final flag accuracy %d\n", idet->interlaced_flag_accuracy);
                 return ff_filter_frame(ctx->outputs[0], av_frame_clone(idet->next));
             }
         }
     } else {
         filter(ctx);
     }
e3e89b6d
 
a05a44e2
     return ff_filter_frame(ctx->outputs[0], av_frame_clone(idet->cur));
e3e89b6d
 }
 
ad5c43bb
 static int request_frame(AVFilterLink *link)
 {
     AVFilterContext *ctx = link->src;
     IDETContext *idet = ctx->priv;
598f8a7a
     int ret;
ad5c43bb
 
598f8a7a
     if (idet->eof)
         return AVERROR_EOF;
ad5c43bb
 
598f8a7a
     ret = ff_request_frame(link->src->inputs[0]);
ad5c43bb
 
598f8a7a
     if (ret == AVERROR_EOF && idet->cur && !idet->analyze_interlaced_flag_done) {
         AVFrame *next = av_frame_clone(idet->next);
ad5c43bb
 
598f8a7a
         if (!next)
             return AVERROR(ENOMEM);
ad5c43bb
 
598f8a7a
         ret = filter_frame(link->src->inputs[0], next);
         idet->eof = 1;
     }
ad5c43bb
 
7635242a
     return ret;
ad5c43bb
 }
 
e3e89b6d
 static av_cold void uninit(AVFilterContext *ctx)
 {
     IDETContext *idet = ctx->priv;
723c37d3
     int level = strncmp(ctx->name, "auto-inserted", 13) ? AV_LOG_INFO : AV_LOG_DEBUG;
e3e89b6d
 
723c37d3
     av_log(ctx, level, "Repeated Fields: Neither:%6"PRId64" Top:%6"PRId64" Bottom:%6"PRId64"\n",
fdf22f97
            idet->total_repeats[REPEAT_NONE],
            idet->total_repeats[REPEAT_TOP],
            idet->total_repeats[REPEAT_BOTTOM]
         );
723c37d3
     av_log(ctx, level, "Single frame detection: TFF:%6"PRId64" BFF:%6"PRId64" Progressive:%6"PRId64" Undetermined:%6"PRId64"\n",
fe6f5f29
            idet->total_prestat[TFF],
            idet->total_prestat[BFF],
            idet->total_prestat[PROGRESSIVE],
            idet->total_prestat[UNDETERMINED]
         );
723c37d3
     av_log(ctx, level, "Multi frame detection: TFF:%6"PRId64" BFF:%6"PRId64" Progressive:%6"PRId64" Undetermined:%6"PRId64"\n",
fe6f5f29
            idet->total_poststat[TFF],
            idet->total_poststat[BFF],
            idet->total_poststat[PROGRESSIVE],
            idet->total_poststat[UNDETERMINED]
         );
6fb35dba
 
a05a44e2
     av_frame_free(&idet->prev);
     av_frame_free(&idet->cur );
     av_frame_free(&idet->next);
e3e89b6d
 }
 
 static int query_formats(AVFilterContext *ctx)
 {
ac627b3d
     static const enum AVPixelFormat pix_fmts[] = {
         AV_PIX_FMT_YUV420P,
         AV_PIX_FMT_YUV422P,
         AV_PIX_FMT_YUV444P,
         AV_PIX_FMT_YUV410P,
         AV_PIX_FMT_YUV411P,
         AV_PIX_FMT_GRAY8,
         AV_PIX_FMT_YUVJ420P,
         AV_PIX_FMT_YUVJ422P,
         AV_PIX_FMT_YUVJ444P,
a8e00cf9
         AV_PIX_FMT_GRAY16,
ac627b3d
         AV_PIX_FMT_YUV440P,
         AV_PIX_FMT_YUVJ440P,
d25d9296
         AV_PIX_FMT_YUV420P9,
         AV_PIX_FMT_YUV422P9,
         AV_PIX_FMT_YUV444P9,
a8e00cf9
         AV_PIX_FMT_YUV420P10,
         AV_PIX_FMT_YUV422P10,
         AV_PIX_FMT_YUV444P10,
d25d9296
         AV_PIX_FMT_YUV420P12,
         AV_PIX_FMT_YUV422P12,
         AV_PIX_FMT_YUV444P12,
         AV_PIX_FMT_YUV420P14,
         AV_PIX_FMT_YUV422P14,
         AV_PIX_FMT_YUV444P14,
a8e00cf9
         AV_PIX_FMT_YUV420P16,
         AV_PIX_FMT_YUV422P16,
         AV_PIX_FMT_YUV444P16,
ac627b3d
         AV_PIX_FMT_YUVA420P,
         AV_PIX_FMT_NONE
e3e89b6d
     };
fd682b18
     AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
     if (!fmts_list)
         return AVERROR(ENOMEM);
     return ff_set_common_formats(ctx, fmts_list);
e3e89b6d
 }
 
fd6228e6
 static av_cold int init(AVFilterContext *ctx)
e3e89b6d
 {
     IDETContext *idet = ctx->priv;
 
ad5c43bb
     idet->eof = 0;
1a5c08ee
     idet->last_type = UNDETERMINED;
fa1f92a4
     memset(idet->history, UNDETERMINED, HIST_SIZE);
1a5c08ee
 
fe6f5f29
     if( idet->half_life > 0 )
641cb77f
         idet->decay_coefficient = lrint( PRECISION * exp2(-1.0 / idet->half_life) );
fe6f5f29
     else
         idet->decay_coefficient = PRECISION;
 
406a9ccf
     idet->filter_line = ff_idet_filter_line_c;
 
     if (ARCH_X86)
e3fd6a3a
         ff_idet_init_x86(idet, 0);
e3e89b6d
 
     return 0;
 }
 
2d9d4440
 static const AVFilterPad idet_inputs[] = {
     {
         .name         = "default",
         .type         = AVMEDIA_TYPE_VIDEO,
4cd40ef3
         .filter_frame = filter_frame,
2d9d4440
     },
     { NULL }
 };
 
 static const AVFilterPad idet_outputs[] = {
     {
b211607b
         .name         = "default",
         .type         = AVMEDIA_TYPE_VIDEO,
ad5c43bb
         .request_frame = request_frame
2d9d4440
     },
     { NULL }
 };
 
325f6e0a
 AVFilter ff_vf_idet = {
e3e89b6d
     .name          = "idet",
     .description   = NULL_IF_CONFIG_SMALL("Interlace detect Filter."),
     .priv_size     = sizeof(IDETContext),
     .init          = init,
     .uninit        = uninit,
     .query_formats = query_formats,
2d9d4440
     .inputs        = idet_inputs,
     .outputs       = idet_outputs,
43cbd440
     .priv_class    = &idet_class,
e3e89b6d
 };