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