avfilter/vf_idet: add a "half_life" option for statistics
[ffmpeg.git] / libavfilter / vf_idet.c
1 /*
2  * Copyright (C) 2012 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
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 GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #include <float.h> /* FLT_MAX */
22
23 #include "libavutil/cpu.h"
24 #include "libavutil/common.h"
25 #include "libavutil/opt.h"
26 #include "internal.h"
27 #include "vf_idet.h"
28
29 #define OFFSET(x) offsetof(IDETContext, x)
30 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
31
32 static const AVOption idet_options[] = {
33     { "intl_thres", "set interlacing threshold", OFFSET(interlace_threshold),   AV_OPT_TYPE_FLOAT, {.dbl = 1.04}, -1, FLT_MAX, FLAGS },
34     { "prog_thres", "set progressive threshold", OFFSET(progressive_threshold), AV_OPT_TYPE_FLOAT, {.dbl = 1.5},  -1, FLT_MAX, FLAGS },
35     { "half_life", "half life of cumulative statistics", OFFSET(half_life),     AV_OPT_TYPE_FLOAT, {.dbl = 0.0},  -1, INT_MAX, FLAGS },
36     { NULL }
37 };
38
39 AVFILTER_DEFINE_CLASS(idet);
40
41 static const char *type2str(Type type)
42 {
43     switch(type) {
44         case TFF          : return "tff";
45         case BFF          : return "bff";
46         case PROGRESSIVE  : return "progressive";
47         case UNDETERMINED : return "undetermined";
48     }
49     return NULL;
50 }
51
52 #define PRECISION 1048576
53
54 static uint64_t uintpow(uint64_t b,unsigned int e)
55 {
56     uint64_t r=1;
57     while(e--) r*=b;
58     return r;
59 }
60
61 static int av_dict_set_fxp(AVDictionary **pm, const char *key, uint64_t value, unsigned int digits,
62                 int flags)
63 {
64     char valuestr[44];
65     snprintf(valuestr, sizeof(valuestr), "%"PRId64".%0*"PRId64,
66              value / PRECISION, digits, ( value % PRECISION ) / ( PRECISION / uintpow(10,digits) ));
67     return av_dict_set(pm, key, valuestr, flags);
68 }
69
70 int ff_idet_filter_line_c(const uint8_t *a, const uint8_t *b, const uint8_t *c, int w)
71 {
72     int x;
73     int ret=0;
74
75     for(x=0; x<w; x++){
76         int v = (*a++ + *c++) - 2 * *b++;
77         ret += FFABS(v);
78     }
79
80     return ret;
81 }
82
83 int ff_idet_filter_line_c_16bit(const uint16_t *a, const uint16_t *b, const uint16_t *c, int w)
84 {
85     int x;
86     int ret=0;
87
88     for(x=0; x<w; x++){
89         int v = (*a++ + *c++) - 2 * *b++;
90         ret += FFABS(v);
91     }
92
93     return ret;
94 }
95
96 static void filter(AVFilterContext *ctx)
97 {
98     IDETContext *idet = ctx->priv;
99     int y, i;
100     int64_t alpha[2]={0};
101     int64_t delta=0;
102     Type type, best_type;
103     int match = 0;
104     AVDictionary **metadata = avpriv_frame_get_metadatap(idet->cur);
105
106     for (i = 0; i < idet->csp->nb_components; i++) {
107         int w = idet->cur->width;
108         int h = idet->cur->height;
109         int refs = idet->cur->linesize[i];
110
111         if (i && i<3) {
112             w = FF_CEIL_RSHIFT(w, idet->csp->log2_chroma_w);
113             h = FF_CEIL_RSHIFT(h, idet->csp->log2_chroma_h);
114         }
115
116         for (y = 2; y < h - 2; y++) {
117             uint8_t *prev = &idet->prev->data[i][y*refs];
118             uint8_t *cur  = &idet->cur ->data[i][y*refs];
119             uint8_t *next = &idet->next->data[i][y*refs];
120             alpha[ y   &1] += idet->filter_line(cur-refs, prev, cur+refs, w);
121             alpha[(y^1)&1] += idet->filter_line(cur-refs, next, cur+refs, w);
122             delta          += idet->filter_line(cur-refs,  cur, cur+refs, w);
123         }
124     }
125
126     if      (alpha[0] > idet->interlace_threshold * alpha[1]){
127         type = TFF;
128     }else if(alpha[1] > idet->interlace_threshold * alpha[0]){
129         type = BFF;
130     }else if(alpha[1] > idet->progressive_threshold * delta){
131         type = PROGRESSIVE;
132     }else{
133         type = UNDETERMINED;
134     }
135
136     memmove(idet->history+1, idet->history, HIST_SIZE-1);
137     idet->history[0] = type;
138     best_type = UNDETERMINED;
139     for(i=0; i<HIST_SIZE; i++){
140         if(idet->history[i] != UNDETERMINED){
141             if(best_type == UNDETERMINED)
142                 best_type = idet->history[i];
143
144             if(idet->history[i] == best_type) {
145                 match++;
146             }else{
147                 match=0;
148                 break;
149             }
150         }
151     }
152     if(idet->last_type == UNDETERMINED){
153         if(match  ) idet->last_type = best_type;
154     }else{
155         if(match>2) idet->last_type = best_type;
156     }
157
158     if      (idet->last_type == TFF){
159         idet->cur->top_field_first = 1;
160         idet->cur->interlaced_frame = 1;
161     }else if(idet->last_type == BFF){
162         idet->cur->top_field_first = 0;
163         idet->cur->interlaced_frame = 1;
164     }else if(idet->last_type == PROGRESSIVE){
165         idet->cur->interlaced_frame = 0;
166     }
167
168
169
170     for(i=0; i<4; i++){
171         idet->prestat [i] = (idet->decay_coefficient * idet->prestat [i]) / PRECISION;
172         idet->poststat[i] = (idet->decay_coefficient * idet->poststat[i]) / PRECISION;
173     }
174
175     idet->total_prestat [           type] ++;
176     idet->prestat       [           type] += PRECISION;
177
178     idet->total_poststat[idet->last_type] ++;
179     idet->poststat      [idet->last_type] += PRECISION;
180
181     av_log(ctx, AV_LOG_DEBUG, "Single frame:%12s, Multi frame:%12s\n", type2str(type), type2str(idet->last_type));
182
183     av_dict_set    (metadata, "lavfi.idet.single.current_frame",   type2str(type), 0);
184     av_dict_set_fxp(metadata, "lavfi.idet.single.tff",             idet->prestat[TFF], 2 , 0);
185     av_dict_set_fxp(metadata, "lavfi.idet.single.bff",             idet->prestat[BFF], 2, 0);
186     av_dict_set_fxp(metadata, "lavfi.idet.single.progressive",     idet->prestat[PROGRESSIVE], 2, 0);
187     av_dict_set_fxp(metadata, "lavfi.idet.single.undetermined",    idet->prestat[UNDETERMINED], 2, 0);
188
189     av_dict_set    (metadata, "lavfi.idet.multiple.current_frame", type2str(idet->last_type), 0);
190     av_dict_set_fxp(metadata, "lavfi.idet.multiple.tff",           idet->poststat[TFF], 2, 0);
191     av_dict_set_fxp(metadata, "lavfi.idet.multiple.bff",           idet->poststat[BFF], 2, 0);
192     av_dict_set_fxp(metadata, "lavfi.idet.multiple.progressive",   idet->poststat[PROGRESSIVE], 2, 0);
193     av_dict_set_fxp(metadata, "lavfi.idet.multiple.undetermined",  idet->poststat[UNDETERMINED], 2, 0);
194 }
195
196 static int filter_frame(AVFilterLink *link, AVFrame *picref)
197 {
198     AVFilterContext *ctx = link->dst;
199     IDETContext *idet = ctx->priv;
200
201     if (idet->prev)
202         av_frame_free(&idet->prev);
203     idet->prev = idet->cur;
204     idet->cur  = idet->next;
205     idet->next = picref;
206
207     if (!idet->cur)
208         return 0;
209
210     if (!idet->prev)
211         idet->prev = av_frame_clone(idet->cur);
212
213     if (!idet->csp)
214         idet->csp = av_pix_fmt_desc_get(link->format);
215     if (idet->csp->comp[0].depth_minus1 / 8 == 1){
216         idet->filter_line = (ff_idet_filter_func)ff_idet_filter_line_c_16bit;
217         if (ARCH_X86)
218             ff_idet_init_x86(idet, 1);
219     }
220
221     filter(ctx);
222
223     return ff_filter_frame(ctx->outputs[0], av_frame_clone(idet->cur));
224 }
225
226 static int request_frame(AVFilterLink *link)
227 {
228     AVFilterContext *ctx = link->src;
229     IDETContext *idet = ctx->priv;
230
231     do {
232         int ret;
233
234         if (idet->eof)
235             return AVERROR_EOF;
236
237         ret = ff_request_frame(link->src->inputs[0]);
238
239         if (ret == AVERROR_EOF && idet->cur) {
240             AVFrame *next = av_frame_clone(idet->next);
241
242             if (!next)
243                 return AVERROR(ENOMEM);
244
245             filter_frame(link->src->inputs[0], next);
246             idet->eof = 1;
247         } else if (ret < 0) {
248             return ret;
249         }
250     } while (!idet->cur);
251
252     return 0;
253 }
254
255 static av_cold void uninit(AVFilterContext *ctx)
256 {
257     IDETContext *idet = ctx->priv;
258
259     av_log(ctx, AV_LOG_INFO, "Single frame detection: TFF:%6"PRId64" BFF:%6"PRId64" Progressive:%6"PRId64" Undetermined:%6"PRId64"\n",
260            idet->total_prestat[TFF],
261            idet->total_prestat[BFF],
262            idet->total_prestat[PROGRESSIVE],
263            idet->total_prestat[UNDETERMINED]
264         );
265     av_log(ctx, AV_LOG_INFO, "Multi frame detection: TFF:%6"PRId64" BFF:%6"PRId64" Progressive:%6"PRId64" Undetermined:%6"PRId64"\n",
266            idet->total_poststat[TFF],
267            idet->total_poststat[BFF],
268            idet->total_poststat[PROGRESSIVE],
269            idet->total_poststat[UNDETERMINED]
270         );
271
272     av_frame_free(&idet->prev);
273     av_frame_free(&idet->cur );
274     av_frame_free(&idet->next);
275 }
276
277 static int query_formats(AVFilterContext *ctx)
278 {
279     static const enum AVPixelFormat pix_fmts[] = {
280         AV_PIX_FMT_YUV420P,
281         AV_PIX_FMT_YUV422P,
282         AV_PIX_FMT_YUV444P,
283         AV_PIX_FMT_YUV410P,
284         AV_PIX_FMT_YUV411P,
285         AV_PIX_FMT_GRAY8,
286         AV_PIX_FMT_YUVJ420P,
287         AV_PIX_FMT_YUVJ422P,
288         AV_PIX_FMT_YUVJ444P,
289         AV_PIX_FMT_GRAY16,
290         AV_PIX_FMT_YUV440P,
291         AV_PIX_FMT_YUVJ440P,
292         AV_PIX_FMT_YUV420P10,
293         AV_PIX_FMT_YUV422P10,
294         AV_PIX_FMT_YUV444P10,
295         AV_PIX_FMT_YUV420P16,
296         AV_PIX_FMT_YUV422P16,
297         AV_PIX_FMT_YUV444P16,
298         AV_PIX_FMT_YUVA420P,
299         AV_PIX_FMT_NONE
300     };
301
302     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
303
304     return 0;
305 }
306
307 static int config_output(AVFilterLink *outlink)
308 {
309     outlink->flags |= FF_LINK_FLAG_REQUEST_LOOP;
310     return 0;
311 }
312
313 static av_cold int init(AVFilterContext *ctx)
314 {
315     IDETContext *idet = ctx->priv;
316
317     idet->eof = 0;
318     idet->last_type = UNDETERMINED;
319     memset(idet->history, UNDETERMINED, HIST_SIZE);
320
321     if( idet->half_life > 0 )
322         idet->decay_coefficient = (uint64_t) round( PRECISION * pow(2.0,-1.0 / idet->half_life) );
323     else
324         idet->decay_coefficient = PRECISION;
325
326     idet->filter_line = ff_idet_filter_line_c;
327
328     if (ARCH_X86)
329         ff_idet_init_x86(idet, 0);
330
331     return 0;
332 }
333
334 static const AVFilterPad idet_inputs[] = {
335     {
336         .name         = "default",
337         .type         = AVMEDIA_TYPE_VIDEO,
338         .filter_frame = filter_frame,
339     },
340     { NULL }
341 };
342
343 static const AVFilterPad idet_outputs[] = {
344     {
345         .name         = "default",
346         .type         = AVMEDIA_TYPE_VIDEO,
347         .config_props = config_output,
348         .request_frame = request_frame
349     },
350     { NULL }
351 };
352
353 AVFilter ff_vf_idet = {
354     .name          = "idet",
355     .description   = NULL_IF_CONFIG_SMALL("Interlace detect Filter."),
356     .priv_size     = sizeof(IDETContext),
357     .init          = init,
358     .uninit        = uninit,
359     .query_formats = query_formats,
360     .inputs        = idet_inputs,
361     .outputs       = idet_outputs,
362     .priv_class    = &idet_class,
363 };