Merge commit '7e350379f87e7f74420b4813170fe808e2313911'
[ffmpeg.git] / libavfilter / f_select.c
1 /*
2  * Copyright (c) 2011 Stefano Sabatini
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 /**
22  * @file
23  * filter for selecting which frame passes in the filterchain
24  */
25
26 #include "libavutil/eval.h"
27 #include "libavutil/fifo.h"
28 #include "libavutil/internal.h"
29 #include "libavutil/opt.h"
30 #include "avfilter.h"
31 #include "audio.h"
32 #include "formats.h"
33 #include "internal.h"
34 #include "video.h"
35
36 #if CONFIG_AVCODEC
37 #include "libavcodec/dsputil.h"
38 #endif
39
40 static const char *const var_names[] = {
41     "TB",                ///< timebase
42
43     "pts",               ///< original pts in the file of the frame
44     "start_pts",         ///< first PTS in the stream, expressed in TB units
45     "prev_pts",          ///< previous frame PTS
46     "prev_selected_pts", ///< previous selected frame PTS
47
48     "t",                 ///< first PTS in seconds
49     "start_t",           ///< first PTS in the stream, expressed in seconds
50     "prev_t",            ///< previous frame time
51     "prev_selected_t",   ///< previously selected time
52
53     "pict_type",         ///< the type of picture in the movie
54     "I",
55     "P",
56     "B",
57     "S",
58     "SI",
59     "SP",
60     "BI",
61
62     "interlace_type",    ///< the frame interlace type
63     "PROGRESSIVE",
64     "TOPFIRST",
65     "BOTTOMFIRST",
66
67     "consumed_samples_n",///< number of samples consumed by the filter (only audio)
68     "samples_n",         ///< number of samples in the current frame (only audio)
69     "sample_rate",       ///< sample rate (only audio)
70
71     "n",                 ///< frame number (starting from zero)
72     "selected_n",        ///< selected frame number (starting from zero)
73     "prev_selected_n",   ///< number of the last selected frame
74
75     "key",               ///< tell if the frame is a key frame
76     "pos",               ///< original position in the file of the frame
77
78     "scene",
79
80     NULL
81 };
82
83 enum var_name {
84     VAR_TB,
85
86     VAR_PTS,
87     VAR_START_PTS,
88     VAR_PREV_PTS,
89     VAR_PREV_SELECTED_PTS,
90
91     VAR_T,
92     VAR_START_T,
93     VAR_PREV_T,
94     VAR_PREV_SELECTED_T,
95
96     VAR_PICT_TYPE,
97     VAR_PICT_TYPE_I,
98     VAR_PICT_TYPE_P,
99     VAR_PICT_TYPE_B,
100     VAR_PICT_TYPE_S,
101     VAR_PICT_TYPE_SI,
102     VAR_PICT_TYPE_SP,
103     VAR_PICT_TYPE_BI,
104
105     VAR_INTERLACE_TYPE,
106     VAR_INTERLACE_TYPE_P,
107     VAR_INTERLACE_TYPE_T,
108     VAR_INTERLACE_TYPE_B,
109
110     VAR_CONSUMED_SAMPLES_N,
111     VAR_SAMPLES_N,
112     VAR_SAMPLE_RATE,
113
114     VAR_N,
115     VAR_SELECTED_N,
116     VAR_PREV_SELECTED_N,
117
118     VAR_KEY,
119     VAR_POS,
120
121     VAR_SCENE,
122
123     VAR_VARS_NB
124 };
125
126 typedef struct {
127     const AVClass *class;
128     AVExpr *expr;
129     char *expr_str;
130     double var_values[VAR_VARS_NB];
131     int do_scene_detect;            ///< 1 if the expression requires scene detection variables, 0 otherwise
132 #if CONFIG_AVCODEC
133     AVCodecContext *avctx;          ///< codec context required for the DSPContext (scene detect only)
134     DSPContext c;                   ///< context providing optimized SAD methods   (scene detect only)
135     double prev_mafd;               ///< previous MAFD                             (scene detect only)
136 #endif
137     AVFrame *prev_picref; ///< previous frame                            (scene detect only)
138     double select;
139 } SelectContext;
140
141 #define OFFSET(x) offsetof(SelectContext, x)
142 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM
143 static const AVOption options[] = {
144     { "expr", "set selection expression", OFFSET(expr_str), AV_OPT_TYPE_STRING, {.str = "1"}, 0, 0, FLAGS },
145     { "e",    "set selection expression", OFFSET(expr_str), AV_OPT_TYPE_STRING, {.str = "1"}, 0, 0, FLAGS },
146     {NULL},
147 };
148
149 static av_cold int init(AVFilterContext *ctx, const char *args, const AVClass *class)
150 {
151     SelectContext *select = ctx->priv;
152     const char *shorthand[] = { "expr", NULL };
153     int ret;
154
155     select->class = class;
156     av_opt_set_defaults(select);
157
158     if ((ret = av_opt_set_from_string(select, args, shorthand, "=", ":")) < 0)
159         return ret;
160
161     if ((ret = av_expr_parse(&select->expr, select->expr_str,
162                              var_names, NULL, NULL, NULL, NULL, 0, ctx)) < 0) {
163         av_log(ctx, AV_LOG_ERROR, "Error while parsing expression '%s'\n", select->expr_str);
164         return ret;
165     }
166     select->do_scene_detect = !!strstr(select->expr_str, "scene");
167
168     return 0;
169 }
170
171 #define INTERLACE_TYPE_P 0
172 #define INTERLACE_TYPE_T 1
173 #define INTERLACE_TYPE_B 2
174
175 static int config_input(AVFilterLink *inlink)
176 {
177     SelectContext *select = inlink->dst->priv;
178
179     select->var_values[VAR_N]          = 0.0;
180     select->var_values[VAR_SELECTED_N] = 0.0;
181
182     select->var_values[VAR_TB] = av_q2d(inlink->time_base);
183
184     select->var_values[VAR_PREV_PTS]          = NAN;
185     select->var_values[VAR_PREV_SELECTED_PTS] = NAN;
186     select->var_values[VAR_PREV_SELECTED_T]   = NAN;
187     select->var_values[VAR_PREV_T]            = NAN;
188     select->var_values[VAR_START_PTS]         = NAN;
189     select->var_values[VAR_START_T]           = NAN;
190
191     select->var_values[VAR_PICT_TYPE_I]  = AV_PICTURE_TYPE_I;
192     select->var_values[VAR_PICT_TYPE_P]  = AV_PICTURE_TYPE_P;
193     select->var_values[VAR_PICT_TYPE_B]  = AV_PICTURE_TYPE_B;
194     select->var_values[VAR_PICT_TYPE_SI] = AV_PICTURE_TYPE_SI;
195     select->var_values[VAR_PICT_TYPE_SP] = AV_PICTURE_TYPE_SP;
196
197     select->var_values[VAR_INTERLACE_TYPE_P] = INTERLACE_TYPE_P;
198     select->var_values[VAR_INTERLACE_TYPE_T] = INTERLACE_TYPE_T;
199     select->var_values[VAR_INTERLACE_TYPE_B] = INTERLACE_TYPE_B;
200
201     select->var_values[VAR_PICT_TYPE]         = NAN;
202     select->var_values[VAR_INTERLACE_TYPE]    = NAN;
203     select->var_values[VAR_SCENE]             = NAN;
204     select->var_values[VAR_CONSUMED_SAMPLES_N] = NAN;
205     select->var_values[VAR_SAMPLES_N]          = NAN;
206
207     select->var_values[VAR_SAMPLE_RATE] =
208         inlink->type == AVMEDIA_TYPE_AUDIO ? inlink->sample_rate : NAN;
209
210 #if CONFIG_AVCODEC
211     if (select->do_scene_detect) {
212         select->avctx = avcodec_alloc_context3(NULL);
213         if (!select->avctx)
214             return AVERROR(ENOMEM);
215         dsputil_init(&select->c, select->avctx);
216     }
217 #endif
218     return 0;
219 }
220
221 #if CONFIG_AVCODEC
222 static double get_scene_score(AVFilterContext *ctx, AVFrame *frame)
223 {
224     double ret = 0;
225     SelectContext *select = ctx->priv;
226     AVFrame *prev_picref = select->prev_picref;
227
228     if (prev_picref &&
229         frame->height    == prev_picref->height &&
230         frame->width    == prev_picref->width &&
231         frame->linesize[0] == prev_picref->linesize[0]) {
232         int x, y, nb_sad = 0;
233         int64_t sad = 0;
234         double mafd, diff;
235         uint8_t *p1 =      frame->data[0];
236         uint8_t *p2 = prev_picref->data[0];
237         const int linesize = frame->linesize[0];
238
239         for (y = 0; y < frame->height - 8; y += 8) {
240             for (x = 0; x < frame->width*3 - 8; x += 8) {
241                 sad += select->c.sad[1](select, p1 + x, p2 + x,
242                                         linesize, 8);
243                 nb_sad += 8 * 8;
244             }
245             p1 += 8 * linesize;
246             p2 += 8 * linesize;
247         }
248         emms_c();
249         mafd = nb_sad ? sad / nb_sad : 0;
250         diff = fabs(mafd - select->prev_mafd);
251         ret  = av_clipf(FFMIN(mafd, diff) / 100., 0, 1);
252         select->prev_mafd = mafd;
253         av_frame_free(&prev_picref);
254     }
255     select->prev_picref = av_frame_clone(frame);
256     return ret;
257 }
258 #endif
259
260 #define D2TS(d)  (isnan(d) ? AV_NOPTS_VALUE : (int64_t)(d))
261 #define TS2D(ts) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts))
262
263 static int select_frame(AVFilterContext *ctx, AVFrame *frame)
264 {
265     SelectContext *select = ctx->priv;
266     AVFilterLink *inlink = ctx->inputs[0];
267     double res;
268
269     if (isnan(select->var_values[VAR_START_PTS]))
270         select->var_values[VAR_START_PTS] = TS2D(frame->pts);
271     if (isnan(select->var_values[VAR_START_T]))
272         select->var_values[VAR_START_T] = TS2D(frame->pts) * av_q2d(inlink->time_base);
273
274     select->var_values[VAR_PTS] = TS2D(frame->pts);
275     select->var_values[VAR_T  ] = TS2D(frame->pts) * av_q2d(inlink->time_base);
276     select->var_values[VAR_POS] = av_frame_get_pkt_pos(frame) == -1 ? NAN : av_frame_get_pkt_pos(frame);
277
278     switch (inlink->type) {
279     case AVMEDIA_TYPE_AUDIO:
280         select->var_values[VAR_SAMPLES_N] = frame->nb_samples;
281         break;
282
283     case AVMEDIA_TYPE_VIDEO:
284         select->var_values[VAR_INTERLACE_TYPE] =
285             !frame->interlaced_frame ? INTERLACE_TYPE_P :
286         frame->top_field_first ? INTERLACE_TYPE_T : INTERLACE_TYPE_B;
287         select->var_values[VAR_PICT_TYPE] = frame->pict_type;
288 #if CONFIG_AVCODEC
289         if (select->do_scene_detect) {
290             char buf[32];
291             select->var_values[VAR_SCENE] = get_scene_score(ctx, frame);
292             // TODO: document metadata
293             snprintf(buf, sizeof(buf), "%f", select->var_values[VAR_SCENE]);
294             av_dict_set(&frame->metadata, "lavfi.scene_score", buf, 0);
295         }
296 #endif
297         break;
298     }
299
300     res = av_expr_eval(select->expr, select->var_values, NULL);
301     av_log(inlink->dst, AV_LOG_DEBUG,
302            "n:%f pts:%f t:%f key:%d",
303            select->var_values[VAR_N],
304            select->var_values[VAR_PTS],
305            select->var_values[VAR_T],
306            (int)select->var_values[VAR_KEY]);
307
308     switch (inlink->type) {
309     case AVMEDIA_TYPE_VIDEO:
310         av_log(inlink->dst, AV_LOG_DEBUG, " interlace_type:%c pict_type:%c scene:%f",
311                select->var_values[VAR_INTERLACE_TYPE] == INTERLACE_TYPE_P ? 'P' :
312                select->var_values[VAR_INTERLACE_TYPE] == INTERLACE_TYPE_T ? 'T' :
313                select->var_values[VAR_INTERLACE_TYPE] == INTERLACE_TYPE_B ? 'B' : '?',
314                av_get_picture_type_char(select->var_values[VAR_PICT_TYPE]),
315                select->var_values[VAR_SCENE]);
316         break;
317     case AVMEDIA_TYPE_AUDIO:
318         av_log(inlink->dst, AV_LOG_DEBUG, " samples_n:%d consumed_samples_n:%d",
319                (int)select->var_values[VAR_SAMPLES_N],
320                (int)select->var_values[VAR_CONSUMED_SAMPLES_N]);
321         break;
322     }
323
324     av_log(inlink->dst, AV_LOG_DEBUG, " -> select:%f\n", res);
325
326     if (res) {
327         select->var_values[VAR_PREV_SELECTED_N]   = select->var_values[VAR_N];
328         select->var_values[VAR_PREV_SELECTED_PTS] = select->var_values[VAR_PTS];
329         select->var_values[VAR_PREV_SELECTED_T]   = select->var_values[VAR_T];
330         select->var_values[VAR_SELECTED_N] += 1.0;
331         if (inlink->type == AVMEDIA_TYPE_AUDIO)
332             select->var_values[VAR_CONSUMED_SAMPLES_N] += frame->nb_samples;
333     }
334
335     select->var_values[VAR_N] += 1.0;
336     select->var_values[VAR_PREV_PTS] = select->var_values[VAR_PTS];
337     select->var_values[VAR_PREV_T]   = select->var_values[VAR_T];
338
339     return res;
340 }
341
342 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
343 {
344     SelectContext *select = inlink->dst->priv;
345
346     select->select = select_frame(inlink->dst, frame);
347     if (select->select)
348         return ff_filter_frame(inlink->dst->outputs[0], frame);
349
350     av_frame_free(&frame);
351     return 0;
352 }
353
354 static int request_frame(AVFilterLink *outlink)
355 {
356     AVFilterContext *ctx = outlink->src;
357     SelectContext *select = ctx->priv;
358     AVFilterLink *inlink = outlink->src->inputs[0];
359     select->select = 0;
360
361     do {
362         int ret = ff_request_frame(inlink);
363         if (ret < 0)
364             return ret;
365     } while (!select->select);
366
367     return 0;
368 }
369
370 static av_cold void uninit(AVFilterContext *ctx)
371 {
372     SelectContext *select = ctx->priv;
373
374     av_expr_free(select->expr);
375     select->expr = NULL;
376     av_opt_free(select);
377
378 #if CONFIG_AVCODEC
379     if (select->do_scene_detect) {
380         av_frame_free(&select->prev_picref);
381         if (select->avctx) {
382             avcodec_close(select->avctx);
383             av_freep(&select->avctx);
384         }
385     }
386 #endif
387 }
388
389 static int query_formats(AVFilterContext *ctx)
390 {
391     SelectContext *select = ctx->priv;
392
393     if (!select->do_scene_detect) {
394         return ff_default_query_formats(ctx);
395     } else {
396         static const enum AVPixelFormat pix_fmts[] = {
397             AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
398             AV_PIX_FMT_NONE
399         };
400         ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
401     }
402     return 0;
403 }
404
405 #if CONFIG_ASELECT_FILTER
406
407 #define aselect_options options
408 AVFILTER_DEFINE_CLASS(aselect);
409
410 static av_cold int aselect_init(AVFilterContext *ctx, const char *args)
411 {
412     SelectContext *select = ctx->priv;
413     int ret;
414
415     if ((ret = init(ctx, args, &aselect_class)) < 0)
416         return ret;
417
418     if (select->do_scene_detect) {
419         av_log(ctx, AV_LOG_ERROR, "Scene detection is ignored in aselect filter\n");
420         return AVERROR(EINVAL);
421     }
422
423     return 0;
424 }
425
426 static const AVFilterPad avfilter_af_aselect_inputs[] = {
427     {
428         .name             = "default",
429         .type             = AVMEDIA_TYPE_AUDIO,
430         .get_audio_buffer = ff_null_get_audio_buffer,
431         .config_props     = config_input,
432         .filter_frame     = filter_frame,
433     },
434     { NULL }
435 };
436
437 static const AVFilterPad avfilter_af_aselect_outputs[] = {
438     {
439         .name = "default",
440         .type = AVMEDIA_TYPE_AUDIO,
441     },
442     { NULL }
443 };
444
445 AVFilter avfilter_af_aselect = {
446     .name      = "aselect",
447     .description = NULL_IF_CONFIG_SMALL("Select audio frames to pass in output."),
448     .init      = aselect_init,
449     .uninit    = uninit,
450     .priv_size = sizeof(SelectContext),
451     .inputs    = avfilter_af_aselect_inputs,
452     .outputs   = avfilter_af_aselect_outputs,
453     .priv_class = &aselect_class,
454 };
455 #endif /* CONFIG_ASELECT_FILTER */
456
457 #if CONFIG_SELECT_FILTER
458
459 #define select_options options
460 AVFILTER_DEFINE_CLASS(select);
461
462 static av_cold int select_init(AVFilterContext *ctx, const char *args)
463 {
464     SelectContext *select = ctx->priv;
465     int ret;
466
467     if ((ret = init(ctx, args, &select_class)) < 0)
468         return ret;
469
470     if (select->do_scene_detect && !CONFIG_AVCODEC) {
471         av_log(ctx, AV_LOG_ERROR, "Scene detection is not available without libavcodec.\n");
472         return AVERROR(EINVAL);
473     }
474
475     return 0;
476 }
477
478 static const AVFilterPad avfilter_vf_select_inputs[] = {
479     {
480         .name             = "default",
481         .type             = AVMEDIA_TYPE_VIDEO,
482         .get_video_buffer = ff_null_get_video_buffer,
483         .min_perms        = AV_PERM_PRESERVE,
484         .config_props     = config_input,
485         .filter_frame     = filter_frame,
486     },
487     { NULL }
488 };
489
490 static const AVFilterPad avfilter_vf_select_outputs[] = {
491     {
492         .name          = "default",
493         .type          = AVMEDIA_TYPE_VIDEO,
494         .request_frame = request_frame,
495     },
496     { NULL }
497 };
498
499 AVFilter avfilter_vf_select = {
500     .name      = "select",
501     .description = NULL_IF_CONFIG_SMALL("Select video frames to pass in output."),
502     .init      = select_init,
503     .uninit    = uninit,
504     .query_formats = query_formats,
505
506     .priv_size = sizeof(SelectContext),
507
508     .inputs    = avfilter_vf_select_inputs,
509     .outputs   = avfilter_vf_select_outputs,
510     .priv_class = &select_class,
511 };
512 #endif /* CONFIG_SELECT_FILTER */