lavfi/idet: switch to an AVOptions-based system.
[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 "libavutil/pixdesc.h"
27 #include "avfilter.h"
28 #include "internal.h"
29
30 #define HIST_SIZE 4
31
32 typedef enum {
33     TFF,
34     BFF,
35     PROGRSSIVE,
36     UNDETERMINED,
37 } Type;
38
39 typedef struct {
40     const AVClass *class;
41     float interlace_threshold;
42     float progressive_threshold;
43
44     Type last_type;
45     int prestat[4];
46     int poststat[4];
47
48     uint8_t history[HIST_SIZE];
49
50     AVFrame *cur;
51     AVFrame *next;
52     AVFrame *prev;
53     int (*filter_line)(const uint8_t *prev, const uint8_t *cur, const uint8_t *next, int w);
54
55     const AVPixFmtDescriptor *csp;
56 } IDETContext;
57
58 #define OFFSET(x) offsetof(IDETContext, x)
59 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
60
61 static const AVOption idet_options[] = {
62     { "intl_thres", "set interlacing threshold", OFFSET(interlace_threshold),   AV_OPT_TYPE_FLOAT, {.dbl = 1.04}, -1, FLT_MAX, FLAGS },
63     { "prog_thres", "set progressive threshold", OFFSET(progressive_threshold), AV_OPT_TYPE_FLOAT, {.dbl = 1.5},  -1, FLT_MAX, FLAGS },
64     { NULL }
65 };
66
67 AVFILTER_DEFINE_CLASS(idet);
68
69 static const char *type2str(Type type)
70 {
71     switch(type) {
72         case TFF         : return "Top Field First   ";
73         case BFF         : return "Bottom Field First";
74         case PROGRSSIVE  : return "Progressive       ";
75         case UNDETERMINED: return "Undetermined      ";
76     }
77     return NULL;
78 }
79
80 static int filter_line_c(const uint8_t *a, const uint8_t *b, const uint8_t *c, int w)
81 {
82     int x;
83     int ret=0;
84
85     for(x=0; x<w; x++){
86         int v = (*a++ + *c++) - 2 * *b++;
87         ret += FFABS(v);
88     }
89
90     return ret;
91 }
92
93 static int filter_line_c_16bit(const uint16_t *a, const uint16_t *b, const uint16_t *c, int w)
94 {
95     int x;
96     int ret=0;
97
98     for(x=0; x<w; x++){
99         int v = (*a++ + *c++) - 2 * *b++;
100         ret += FFABS(v);
101     }
102
103     return ret;
104 }
105
106 static void filter(AVFilterContext *ctx)
107 {
108     IDETContext *idet = ctx->priv;
109     int y, i;
110     int64_t alpha[2]={0};
111     int64_t delta=0;
112     Type type, best_type;
113     int match = 0;
114
115     for (i = 0; i < idet->csp->nb_components; i++) {
116         int w = idet->cur->width;
117         int h = idet->cur->height;
118         int refs = idet->cur->linesize[i];
119
120         if (i && i<3) {
121             w >>= idet->csp->log2_chroma_w;
122             h >>= idet->csp->log2_chroma_h;
123         }
124
125         for (y = 2; y < h - 2; y++) {
126             uint8_t *prev = &idet->prev->data[i][y*refs];
127             uint8_t *cur  = &idet->cur ->data[i][y*refs];
128             uint8_t *next = &idet->next->data[i][y*refs];
129             alpha[ y   &1] += idet->filter_line(cur-refs, prev, cur+refs, w);
130             alpha[(y^1)&1] += idet->filter_line(cur-refs, next, cur+refs, w);
131             delta          += idet->filter_line(cur-refs,  cur, cur+refs, w);
132         }
133     }
134
135     if      (alpha[0] > idet->interlace_threshold * alpha[1]){
136         type = TFF;
137     }else if(alpha[1] > idet->interlace_threshold * alpha[0]){
138         type = BFF;
139     }else if(alpha[1] > idet->progressive_threshold * delta){
140         type = PROGRSSIVE;
141     }else{
142         type = UNDETERMINED;
143     }
144
145     memmove(idet->history+1, idet->history, HIST_SIZE-1);
146     idet->history[0] = type;
147     best_type = UNDETERMINED;
148     for(i=0; i<HIST_SIZE; i++){
149         if(idet->history[i] != UNDETERMINED){
150             if(best_type == UNDETERMINED)
151                 best_type = idet->history[i];
152
153             if(idet->history[i] == best_type) {
154                 match++;
155             }else{
156                 match=0;
157                 break;
158             }
159         }
160     }
161     if(idet->last_type == UNDETERMINED){
162         if(match  ) idet->last_type = best_type;
163     }else{
164         if(match>2) idet->last_type = best_type;
165     }
166
167     if      (idet->last_type == TFF){
168         idet->cur->top_field_first = 1;
169         idet->cur->interlaced_frame = 1;
170     }else if(idet->last_type == BFF){
171         idet->cur->top_field_first = 0;
172         idet->cur->interlaced_frame = 1;
173     }else if(idet->last_type == PROGRSSIVE){
174         idet->cur->interlaced_frame = 0;
175     }
176
177     idet->prestat [           type] ++;
178     idet->poststat[idet->last_type] ++;
179     av_log(ctx, AV_LOG_DEBUG, "Single frame:%s, Multi frame:%s\n", type2str(type), type2str(idet->last_type));
180 }
181
182 static int filter_frame(AVFilterLink *link, AVFrame *picref)
183 {
184     AVFilterContext *ctx = link->dst;
185     IDETContext *idet = ctx->priv;
186
187     if (idet->prev)
188         av_frame_free(&idet->prev);
189     idet->prev = idet->cur;
190     idet->cur  = idet->next;
191     idet->next = picref;
192
193     if (!idet->cur)
194         return 0;
195
196     if (!idet->prev)
197         idet->prev = av_frame_clone(idet->cur);
198
199     if (!idet->csp)
200         idet->csp = av_pix_fmt_desc_get(link->format);
201     if (idet->csp->comp[0].depth_minus1 / 8 == 1)
202         idet->filter_line = (void*)filter_line_c_16bit;
203
204     filter(ctx);
205
206     return ff_filter_frame(ctx->outputs[0], av_frame_clone(idet->cur));
207 }
208
209 static int request_frame(AVFilterLink *link)
210 {
211     AVFilterContext *ctx = link->src;
212     IDETContext *idet = ctx->priv;
213
214     do {
215         int ret;
216
217         if ((ret = ff_request_frame(link->src->inputs[0])))
218             return ret;
219     } while (!idet->cur);
220
221     return 0;
222 }
223
224 static av_cold void uninit(AVFilterContext *ctx)
225 {
226     IDETContext *idet = ctx->priv;
227
228     av_log(ctx, AV_LOG_INFO, "Single frame detection: TFF:%d BFF:%d Progressive:%d Undetermined:%d\n",
229            idet->prestat[TFF],
230            idet->prestat[BFF],
231            idet->prestat[PROGRSSIVE],
232            idet->prestat[UNDETERMINED]
233     );
234     av_log(ctx, AV_LOG_INFO, "Multi frame detection: TFF:%d BFF:%d Progressive:%d Undetermined:%d\n",
235            idet->poststat[TFF],
236            idet->poststat[BFF],
237            idet->poststat[PROGRSSIVE],
238            idet->poststat[UNDETERMINED]
239     );
240
241     av_frame_free(&idet->prev);
242     av_frame_free(&idet->cur );
243     av_frame_free(&idet->next);
244 }
245
246 static int query_formats(AVFilterContext *ctx)
247 {
248     static const enum AVPixelFormat pix_fmts[] = {
249         AV_PIX_FMT_YUV420P,
250         AV_PIX_FMT_YUV422P,
251         AV_PIX_FMT_YUV444P,
252         AV_PIX_FMT_YUV410P,
253         AV_PIX_FMT_YUV411P,
254         AV_PIX_FMT_GRAY8,
255         AV_PIX_FMT_YUVJ420P,
256         AV_PIX_FMT_YUVJ422P,
257         AV_PIX_FMT_YUVJ444P,
258         AV_NE( AV_PIX_FMT_GRAY16BE, AV_PIX_FMT_GRAY16LE ),
259         AV_PIX_FMT_YUV440P,
260         AV_PIX_FMT_YUVJ440P,
261         AV_NE( AV_PIX_FMT_YUV420P10BE, AV_PIX_FMT_YUV420P10LE ),
262         AV_NE( AV_PIX_FMT_YUV422P10BE, AV_PIX_FMT_YUV422P10LE ),
263         AV_NE( AV_PIX_FMT_YUV444P10BE, AV_PIX_FMT_YUV444P10LE ),
264         AV_NE( AV_PIX_FMT_YUV420P16BE, AV_PIX_FMT_YUV420P16LE ),
265         AV_NE( AV_PIX_FMT_YUV422P16BE, AV_PIX_FMT_YUV422P16LE ),
266         AV_NE( AV_PIX_FMT_YUV444P16BE, AV_PIX_FMT_YUV444P16LE ),
267         AV_PIX_FMT_YUVA420P,
268         AV_PIX_FMT_NONE
269     };
270
271     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
272
273     return 0;
274 }
275
276 static av_cold int init(AVFilterContext *ctx, const char *args)
277 {
278     IDETContext *idet = ctx->priv;
279
280     idet->last_type = UNDETERMINED;
281     memset(idet->history, UNDETERMINED, HIST_SIZE);
282
283     idet->filter_line = filter_line_c;
284
285     return 0;
286 }
287
288
289 static const AVFilterPad idet_inputs[] = {
290     {
291         .name         = "default",
292         .type         = AVMEDIA_TYPE_VIDEO,
293         .filter_frame = filter_frame,
294     },
295     { NULL }
296 };
297
298 static const AVFilterPad idet_outputs[] = {
299     {
300         .name          = "default",
301         .type          = AVMEDIA_TYPE_VIDEO,
302         .request_frame = request_frame,
303     },
304     { NULL }
305 };
306
307 AVFilter avfilter_vf_idet = {
308     .name          = "idet",
309     .description   = NULL_IF_CONFIG_SMALL("Interlace detect Filter."),
310
311     .priv_size     = sizeof(IDETContext),
312     .init          = init,
313     .uninit        = uninit,
314     .query_formats = query_formats,
315     .inputs        = idet_inputs,
316     .outputs       = idet_outputs,
317     .priv_class    = &idet_class,
318 };