lavfi: remove avfilter_null_* from public API on next bump.
[ffmpeg.git] / libavfilter / vf_select.c
1 /*
2  * Copyright (c) 2011 Stefano Sabatini
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; 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/mathematics.h"
29 #include "avfilter.h"
30 #include "video.h"
31
32 static const char *const var_names[] = {
33     "E",                 ///< Euler number
34     "PHI",               ///< golden ratio
35     "PI",                ///< greek pi
36
37     "TB",                ///< timebase
38
39     "pts",               ///< original pts in the file of the frame
40     "start_pts",         ///< first PTS in the stream, expressed in TB units
41     "prev_pts",          ///< previous frame PTS
42     "prev_selected_pts", ///< previous selected frame PTS
43
44     "t",                 ///< first PTS in seconds
45     "start_t",           ///< first PTS in the stream, expressed in seconds
46     "prev_t",            ///< previous frame time
47     "prev_selected_t",   ///< previously selected time
48
49     "pict_type",         ///< the type of picture in the movie
50     "I",
51     "P",
52     "B",
53     "S",
54     "SI",
55     "SP",
56     "BI",
57
58     "interlace_type",    ///< the frame interlace type
59     "PROGRESSIVE",
60     "TOPFIRST",
61     "BOTTOMFIRST",
62
63     "n",                 ///< frame number (starting from zero)
64     "selected_n",        ///< selected frame number (starting from zero)
65     "prev_selected_n",   ///< number of the last selected frame
66
67     "key",               ///< tell if the frame is a key frame
68     "pos",               ///< original position in the file of the frame
69
70     NULL
71 };
72
73 enum var_name {
74     VAR_E,
75     VAR_PHI,
76     VAR_PI,
77
78     VAR_TB,
79
80     VAR_PTS,
81     VAR_START_PTS,
82     VAR_PREV_PTS,
83     VAR_PREV_SELECTED_PTS,
84
85     VAR_T,
86     VAR_START_T,
87     VAR_PREV_T,
88     VAR_PREV_SELECTED_T,
89
90     VAR_PICT_TYPE,
91     VAR_PICT_TYPE_I,
92     VAR_PICT_TYPE_P,
93     VAR_PICT_TYPE_B,
94     VAR_PICT_TYPE_S,
95     VAR_PICT_TYPE_SI,
96     VAR_PICT_TYPE_SP,
97     VAR_PICT_TYPE_BI,
98
99     VAR_INTERLACE_TYPE,
100     VAR_INTERLACE_TYPE_P,
101     VAR_INTERLACE_TYPE_T,
102     VAR_INTERLACE_TYPE_B,
103
104     VAR_N,
105     VAR_SELECTED_N,
106     VAR_PREV_SELECTED_N,
107
108     VAR_KEY,
109     VAR_POS,
110
111     VAR_VARS_NB
112 };
113
114 #define FIFO_SIZE 8
115
116 typedef struct {
117     AVExpr *expr;
118     double var_values[VAR_VARS_NB];
119     double select;
120     int cache_frames;
121     AVFifoBuffer *pending_frames; ///< FIFO buffer of video frames
122 } SelectContext;
123
124 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
125 {
126     SelectContext *select = ctx->priv;
127     int ret;
128
129     if ((ret = av_expr_parse(&select->expr, args ? args : "1",
130                              var_names, NULL, NULL, NULL, NULL, 0, ctx)) < 0) {
131         av_log(ctx, AV_LOG_ERROR, "Error while parsing expression '%s'\n", args);
132         return ret;
133     }
134
135     select->pending_frames = av_fifo_alloc(FIFO_SIZE*sizeof(AVFilterBufferRef*));
136     if (!select->pending_frames) {
137         av_log(ctx, AV_LOG_ERROR, "Failed to allocate pending frames buffer.\n");
138         return AVERROR(ENOMEM);
139     }
140     return 0;
141 }
142
143 #define INTERLACE_TYPE_P 0
144 #define INTERLACE_TYPE_T 1
145 #define INTERLACE_TYPE_B 2
146
147 static int config_input(AVFilterLink *inlink)
148 {
149     SelectContext *select = inlink->dst->priv;
150
151     select->var_values[VAR_E]   = M_E;
152     select->var_values[VAR_PHI] = M_PHI;
153     select->var_values[VAR_PI]  = M_PI;
154
155     select->var_values[VAR_N]          = 0.0;
156     select->var_values[VAR_SELECTED_N] = 0.0;
157
158     select->var_values[VAR_TB] = av_q2d(inlink->time_base);
159
160     select->var_values[VAR_PREV_PTS]          = NAN;
161     select->var_values[VAR_PREV_SELECTED_PTS] = NAN;
162     select->var_values[VAR_PREV_SELECTED_T]   = NAN;
163     select->var_values[VAR_START_PTS]         = NAN;
164     select->var_values[VAR_START_T]           = NAN;
165
166     select->var_values[VAR_PICT_TYPE_I]  = AV_PICTURE_TYPE_I;
167     select->var_values[VAR_PICT_TYPE_P]  = AV_PICTURE_TYPE_P;
168     select->var_values[VAR_PICT_TYPE_B]  = AV_PICTURE_TYPE_B;
169     select->var_values[VAR_PICT_TYPE_SI] = AV_PICTURE_TYPE_SI;
170     select->var_values[VAR_PICT_TYPE_SP] = AV_PICTURE_TYPE_SP;
171
172     select->var_values[VAR_INTERLACE_TYPE_P] = INTERLACE_TYPE_P;
173     select->var_values[VAR_INTERLACE_TYPE_T] = INTERLACE_TYPE_T;
174     select->var_values[VAR_INTERLACE_TYPE_B] = INTERLACE_TYPE_B;;
175
176     return 0;
177 }
178
179 #define D2TS(d)  (isnan(d) ? AV_NOPTS_VALUE : (int64_t)(d))
180 #define TS2D(ts) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts))
181
182 static int select_frame(AVFilterContext *ctx, AVFilterBufferRef *picref)
183 {
184     SelectContext *select = ctx->priv;
185     AVFilterLink *inlink = ctx->inputs[0];
186     double res;
187
188     if (isnan(select->var_values[VAR_START_PTS]))
189         select->var_values[VAR_START_PTS] = TS2D(picref->pts);
190     if (isnan(select->var_values[VAR_START_T]))
191         select->var_values[VAR_START_T] = TS2D(picref->pts) * av_q2d(inlink->time_base);
192
193     select->var_values[VAR_PTS] = TS2D(picref->pts);
194     select->var_values[VAR_T  ] = TS2D(picref->pts) * av_q2d(inlink->time_base);
195     select->var_values[VAR_POS] = picref->pos == -1 ? NAN : picref->pos;
196     select->var_values[VAR_PREV_PTS] = TS2D(picref ->pts);
197
198     select->var_values[VAR_INTERLACE_TYPE] =
199         !picref->video->interlaced     ? INTERLACE_TYPE_P :
200         picref->video->top_field_first ? INTERLACE_TYPE_T : INTERLACE_TYPE_B;
201     select->var_values[VAR_PICT_TYPE] = picref->video->pict_type;
202
203     res = av_expr_eval(select->expr, select->var_values, NULL);
204     av_log(inlink->dst, AV_LOG_DEBUG,
205            "n:%d pts:%d t:%f pos:%d interlace_type:%c key:%d pict_type:%c "
206            "-> select:%f\n",
207            (int)select->var_values[VAR_N],
208            (int)select->var_values[VAR_PTS],
209            select->var_values[VAR_T],
210            (int)select->var_values[VAR_POS],
211            select->var_values[VAR_INTERLACE_TYPE] == INTERLACE_TYPE_P ? 'P' :
212            select->var_values[VAR_INTERLACE_TYPE] == INTERLACE_TYPE_T ? 'T' :
213            select->var_values[VAR_INTERLACE_TYPE] == INTERLACE_TYPE_B ? 'B' : '?',
214            (int)select->var_values[VAR_KEY],
215            av_get_picture_type_char(select->var_values[VAR_PICT_TYPE]),
216            res);
217
218     select->var_values[VAR_N] += 1.0;
219
220     if (res) {
221         select->var_values[VAR_PREV_SELECTED_N]   = select->var_values[VAR_N];
222         select->var_values[VAR_PREV_SELECTED_PTS] = select->var_values[VAR_PTS];
223         select->var_values[VAR_PREV_SELECTED_T]   = select->var_values[VAR_T];
224         select->var_values[VAR_SELECTED_N] += 1.0;
225     }
226     return res;
227 }
228
229 static void start_frame(AVFilterLink *inlink, AVFilterBufferRef *picref)
230 {
231     SelectContext *select = inlink->dst->priv;
232
233     select->select = select_frame(inlink->dst, picref);
234     if (select->select) {
235         /* frame was requested through poll_frame */
236         if (select->cache_frames) {
237             if (!av_fifo_space(select->pending_frames))
238                 av_log(inlink->dst, AV_LOG_ERROR,
239                        "Buffering limit reached, cannot cache more frames\n");
240             else
241                 av_fifo_generic_write(select->pending_frames, &picref,
242                                       sizeof(picref), NULL);
243             return;
244         }
245         avfilter_start_frame(inlink->dst->outputs[0], avfilter_ref_buffer(picref, ~0));
246     }
247 }
248
249 static void draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
250 {
251     SelectContext *select = inlink->dst->priv;
252
253     if (select->select && !select->cache_frames)
254         avfilter_draw_slice(inlink->dst->outputs[0], y, h, slice_dir);
255 }
256
257 static void end_frame(AVFilterLink *inlink)
258 {
259     SelectContext *select = inlink->dst->priv;
260     AVFilterBufferRef *picref = inlink->cur_buf;
261
262     if (select->select) {
263         if (select->cache_frames)
264             return;
265         avfilter_end_frame(inlink->dst->outputs[0]);
266     }
267     avfilter_unref_buffer(picref);
268 }
269
270 static int request_frame(AVFilterLink *outlink)
271 {
272     AVFilterContext *ctx = outlink->src;
273     SelectContext *select = ctx->priv;
274     AVFilterLink *inlink = outlink->src->inputs[0];
275     select->select = 0;
276
277     if (av_fifo_size(select->pending_frames)) {
278         AVFilterBufferRef *picref;
279         av_fifo_generic_read(select->pending_frames, &picref, sizeof(picref), NULL);
280         avfilter_start_frame(outlink, avfilter_ref_buffer(picref, ~0));
281         avfilter_draw_slice(outlink, 0, outlink->h, 1);
282         avfilter_end_frame(outlink);
283         avfilter_unref_buffer(picref);
284         return 0;
285     }
286
287     while (!select->select) {
288         int ret = avfilter_request_frame(inlink);
289         if (ret < 0)
290             return ret;
291     }
292
293     return 0;
294 }
295
296 static int poll_frame(AVFilterLink *outlink)
297 {
298     SelectContext *select = outlink->src->priv;
299     AVFilterLink *inlink = outlink->src->inputs[0];
300     int count, ret;
301
302     if (!av_fifo_size(select->pending_frames)) {
303         if ((count = avfilter_poll_frame(inlink)) <= 0)
304             return count;
305         /* request frame from input, and apply select condition to it */
306         select->cache_frames = 1;
307         while (count-- && av_fifo_space(select->pending_frames)) {
308             ret = avfilter_request_frame(inlink);
309             if (ret < 0)
310                 break;
311         }
312         select->cache_frames = 0;
313     }
314
315     return av_fifo_size(select->pending_frames)/sizeof(AVFilterBufferRef *);
316 }
317
318 static av_cold void uninit(AVFilterContext *ctx)
319 {
320     SelectContext *select = ctx->priv;
321     AVFilterBufferRef *picref;
322
323     av_expr_free(select->expr);
324     select->expr = NULL;
325
326     while (select->pending_frames &&
327            av_fifo_generic_read(select->pending_frames, &picref, sizeof(picref), NULL) == sizeof(picref))
328         avfilter_unref_buffer(picref);
329     av_fifo_free(select->pending_frames);
330     select->pending_frames = NULL;
331 }
332
333 AVFilter avfilter_vf_select = {
334     .name      = "select",
335     .description = NULL_IF_CONFIG_SMALL("Select frames to pass in output."),
336     .init      = init,
337     .uninit    = uninit,
338
339     .priv_size = sizeof(SelectContext),
340
341     .inputs    = (AVFilterPad[]) {{ .name             = "default",
342                                     .type             = AVMEDIA_TYPE_VIDEO,
343                                     .get_video_buffer = ff_null_get_video_buffer,
344                                     .config_props     = config_input,
345                                     .start_frame      = start_frame,
346                                     .draw_slice       = draw_slice,
347                                     .end_frame        = end_frame },
348                                   { .name = NULL }},
349     .outputs   = (AVFilterPad[]) {{ .name             = "default",
350                                     .type             = AVMEDIA_TYPE_VIDEO,
351                                     .poll_frame       = poll_frame,
352                                     .request_frame    = request_frame, },
353                                   { .name = NULL}},
354 };