avfilter/zoompan: add in_time variable
[ffmpeg.git] / libavfilter / vf_zoompan.c
1 /*
2  * Copyright (c) 2013 Paul B Mahol
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 "libavutil/avassert.h"
22 #include "libavutil/eval.h"
23 #include "libavutil/opt.h"
24 #include "libavutil/pixdesc.h"
25 #include "avfilter.h"
26 #include "filters.h"
27 #include "formats.h"
28 #include "internal.h"
29 #include "video.h"
30 #include "libswscale/swscale.h"
31
32 static const char *const var_names[] = {
33     "in_w",   "iw",
34     "in_h",   "ih",
35     "out_w",  "ow",
36     "out_h",  "oh",
37     "in",
38     "on",
39     "duration",
40     "pduration",
41     "in_time", "it",
42     "out_time", "time", "ot",
43     "frame",
44     "zoom",
45     "pzoom",
46     "x", "px",
47     "y", "py",
48     "a",
49     "sar",
50     "dar",
51     "hsub",
52     "vsub",
53     NULL
54 };
55
56 enum var_name {
57     VAR_IN_W,   VAR_IW,
58     VAR_IN_H,   VAR_IH,
59     VAR_OUT_W,  VAR_OW,
60     VAR_OUT_H,  VAR_OH,
61     VAR_IN,
62     VAR_ON,
63     VAR_DURATION,
64     VAR_PDURATION,
65     VAR_IN_TIME, VAR_IT,
66     VAR_TIME, VAR_OUT_TIME, VAR_OT,
67     VAR_FRAME,
68     VAR_ZOOM,
69     VAR_PZOOM,
70     VAR_X, VAR_PX,
71     VAR_Y, VAR_PY,
72     VAR_A,
73     VAR_SAR,
74     VAR_DAR,
75     VAR_HSUB,
76     VAR_VSUB,
77     VARS_NB
78 };
79
80 typedef struct ZPcontext {
81     const AVClass *class;
82     char *zoom_expr_str;
83     char *x_expr_str;
84     char *y_expr_str;
85     char *duration_expr_str;
86
87     AVExpr *zoom_expr, *x_expr, *y_expr;
88
89     int w, h;
90     double x, y;
91     double prev_zoom;
92     int prev_nb_frames;
93     struct SwsContext *sws;
94     int64_t frame_count;
95     const AVPixFmtDescriptor *desc;
96     AVFrame *in;
97     double var_values[VARS_NB];
98     int nb_frames;
99     int current_frame;
100     int finished;
101     AVRational framerate;
102 } ZPContext;
103
104 #define OFFSET(x) offsetof(ZPContext, x)
105 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
106 static const AVOption zoompan_options[] = {
107     { "zoom", "set the zoom expression", OFFSET(zoom_expr_str), AV_OPT_TYPE_STRING, {.str = "1" }, .flags = FLAGS },
108     { "z", "set the zoom expression", OFFSET(zoom_expr_str), AV_OPT_TYPE_STRING, {.str = "1" }, .flags = FLAGS },
109     { "x", "set the x expression", OFFSET(x_expr_str), AV_OPT_TYPE_STRING, {.str="0"}, .flags = FLAGS },
110     { "y", "set the y expression", OFFSET(y_expr_str), AV_OPT_TYPE_STRING, {.str="0"}, .flags = FLAGS },
111     { "d", "set the duration expression", OFFSET(duration_expr_str), AV_OPT_TYPE_STRING, {.str="90"}, .flags = FLAGS },
112     { "s", "set the output image size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str="hd720"}, .flags = FLAGS },
113     { "fps", "set the output framerate", OFFSET(framerate), AV_OPT_TYPE_VIDEO_RATE, { .str = "25" }, 0, INT_MAX, .flags = FLAGS },
114     { NULL }
115 };
116
117 AVFILTER_DEFINE_CLASS(zoompan);
118
119 static av_cold int init(AVFilterContext *ctx)
120 {
121     ZPContext *s = ctx->priv;
122
123     s->prev_zoom = 1;
124     return 0;
125 }
126
127 static int config_output(AVFilterLink *outlink)
128 {
129     AVFilterContext *ctx = outlink->src;
130     ZPContext *s = ctx->priv;
131     int ret;
132
133     outlink->w = s->w;
134     outlink->h = s->h;
135     outlink->time_base = av_inv_q(s->framerate);
136     outlink->frame_rate = s->framerate;
137     s->desc = av_pix_fmt_desc_get(outlink->format);
138     s->finished = 1;
139
140     ret = av_expr_parse(&s->zoom_expr, s->zoom_expr_str, var_names, NULL, NULL, NULL, NULL, 0, ctx);
141     if (ret < 0)
142         return ret;
143
144     ret = av_expr_parse(&s->x_expr, s->x_expr_str, var_names, NULL, NULL, NULL, NULL, 0, ctx);
145     if (ret < 0)
146         return ret;
147
148     ret = av_expr_parse(&s->y_expr, s->y_expr_str, var_names, NULL, NULL, NULL, NULL, 0, ctx);
149     if (ret < 0)
150         return ret;
151
152     return 0;
153 }
154
155 static int output_single_frame(AVFilterContext *ctx, AVFrame *in, double *var_values, int i,
156                                double *zoom, double *dx, double *dy)
157 {
158     ZPContext *s = ctx->priv;
159     AVFilterLink *outlink = ctx->outputs[0];
160     AVFilterLink *inlink = ctx->inputs[0];
161     int64_t pts = s->frame_count;
162     int k, x, y, w, h, ret = 0;
163     uint8_t *input[4];
164     int px[4], py[4];
165     AVFrame *out;
166
167     var_values[VAR_PX]    = s->x;
168     var_values[VAR_PY]    = s->y;
169     var_values[VAR_PZOOM] = s->prev_zoom;
170     var_values[VAR_PDURATION] = s->prev_nb_frames;
171     var_values[VAR_IN_TIME] = var_values[VAR_IT]  = in->pts == AV_NOPTS_VALUE ?
172         NAN : in->pts * av_q2d(inlink->time_base);
173     var_values[VAR_OUT_TIME] = pts * av_q2d(outlink->time_base);
174     var_values[VAR_TIME] = var_values[VAR_OT] = var_values[VAR_OUT_TIME];
175     var_values[VAR_FRAME] = i;
176     var_values[VAR_ON] = outlink->frame_count_in;
177
178     *zoom = av_expr_eval(s->zoom_expr, var_values, NULL);
179
180     *zoom = av_clipd(*zoom, 1, 10);
181     var_values[VAR_ZOOM] = *zoom;
182     w = in->width * (1.0 / *zoom);
183     h = in->height * (1.0 / *zoom);
184
185     *dx = av_expr_eval(s->x_expr, var_values, NULL);
186
187     x = *dx = av_clipd(*dx, 0, FFMAX(in->width - w, 0));
188     var_values[VAR_X] = *dx;
189     x &= ~((1 << s->desc->log2_chroma_w) - 1);
190
191     *dy = av_expr_eval(s->y_expr, var_values, NULL);
192
193     y = *dy = av_clipd(*dy, 0, FFMAX(in->height - h, 0));
194     var_values[VAR_Y] = *dy;
195     y &= ~((1 << s->desc->log2_chroma_h) - 1);
196
197     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
198     if (!out) {
199         ret = AVERROR(ENOMEM);
200         return ret;
201     }
202
203     px[1] = px[2] = AV_CEIL_RSHIFT(x, s->desc->log2_chroma_w);
204     px[0] = px[3] = x;
205
206     py[1] = py[2] = AV_CEIL_RSHIFT(y, s->desc->log2_chroma_h);
207     py[0] = py[3] = y;
208
209     s->sws = sws_alloc_context();
210     if (!s->sws) {
211         ret = AVERROR(ENOMEM);
212         goto error;
213     }
214
215     for (k = 0; in->data[k]; k++)
216         input[k] = in->data[k] + py[k] * in->linesize[k] + px[k];
217
218     av_opt_set_int(s->sws, "srcw", w, 0);
219     av_opt_set_int(s->sws, "srch", h, 0);
220     av_opt_set_int(s->sws, "src_format", in->format, 0);
221     av_opt_set_int(s->sws, "dstw", outlink->w, 0);
222     av_opt_set_int(s->sws, "dsth", outlink->h, 0);
223     av_opt_set_int(s->sws, "dst_format", outlink->format, 0);
224     av_opt_set_int(s->sws, "sws_flags", SWS_BICUBIC, 0);
225
226     if ((ret = sws_init_context(s->sws, NULL, NULL)) < 0)
227         goto error;
228
229     sws_scale(s->sws, (const uint8_t *const *)&input, in->linesize, 0, h, out->data, out->linesize);
230
231     out->pts = pts;
232     s->frame_count++;
233
234     ret = ff_filter_frame(outlink, out);
235     sws_freeContext(s->sws);
236     s->sws = NULL;
237     s->current_frame++;
238
239     if (s->current_frame >= s->nb_frames) {
240         if (*dx != -1)
241             s->x = *dx;
242         if (*dy != -1)
243             s->y = *dy;
244         if (*zoom != -1)
245             s->prev_zoom = *zoom;
246         s->prev_nb_frames = s->nb_frames;
247         s->nb_frames = 0;
248         s->current_frame = 0;
249         av_frame_free(&s->in);
250         s->finished = 1;
251     }
252     return ret;
253 error:
254     sws_freeContext(s->sws);
255     s->sws = NULL;
256     av_frame_free(&out);
257     return ret;
258 }
259
260 static int activate(AVFilterContext *ctx)
261 {
262     ZPContext *s = ctx->priv;
263     AVFilterLink *inlink = ctx->inputs[0];
264     AVFilterLink *outlink = ctx->outputs[0];
265     int status, ret = 0;
266     int64_t pts;
267
268     FF_FILTER_FORWARD_STATUS_BACK(outlink, inlink);
269
270     if (s->in && ff_outlink_frame_wanted(outlink)) {
271         double zoom = -1, dx = -1, dy = -1;
272
273         ret = output_single_frame(ctx, s->in, s->var_values, s->current_frame,
274                                   &zoom, &dx, &dy);
275         if (ret < 0)
276             return ret;
277     }
278
279     if (!s->in && (ret = ff_inlink_consume_frame(inlink, &s->in)) > 0) {
280         double zoom = -1, dx = -1, dy = -1, nb_frames;
281
282         s->finished = 0;
283         s->var_values[VAR_IN_W]  = s->var_values[VAR_IW] = s->in->width;
284         s->var_values[VAR_IN_H]  = s->var_values[VAR_IH] = s->in->height;
285         s->var_values[VAR_OUT_W] = s->var_values[VAR_OW] = s->w;
286         s->var_values[VAR_OUT_H] = s->var_values[VAR_OH] = s->h;
287         s->var_values[VAR_IN]    = inlink->frame_count_out - 1;
288         s->var_values[VAR_ON]    = outlink->frame_count_in;
289         s->var_values[VAR_PX]    = s->x;
290         s->var_values[VAR_PY]    = s->y;
291         s->var_values[VAR_X]     = 0;
292         s->var_values[VAR_Y]     = 0;
293         s->var_values[VAR_PZOOM] = s->prev_zoom;
294         s->var_values[VAR_ZOOM]  = 1;
295         s->var_values[VAR_PDURATION] = s->prev_nb_frames;
296         s->var_values[VAR_A]     = (double) s->in->width / s->in->height;
297         s->var_values[VAR_SAR]   = inlink->sample_aspect_ratio.num ?
298             (double) inlink->sample_aspect_ratio.num / inlink->sample_aspect_ratio.den : 1;
299         s->var_values[VAR_DAR]   = s->var_values[VAR_A] * s->var_values[VAR_SAR];
300         s->var_values[VAR_HSUB]  = 1 << s->desc->log2_chroma_w;
301         s->var_values[VAR_VSUB]  = 1 << s->desc->log2_chroma_h;
302
303         if ((ret = av_expr_parse_and_eval(&nb_frames, s->duration_expr_str,
304                                           var_names, s->var_values,
305                                           NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0) {
306             av_frame_free(&s->in);
307             return ret;
308         }
309
310         s->var_values[VAR_DURATION] = s->nb_frames = nb_frames;
311
312         ret = output_single_frame(ctx, s->in, s->var_values, s->current_frame,
313                                   &zoom, &dx, &dy);
314         if (ret < 0)
315             return ret;
316     }
317     if (ret < 0) {
318         return ret;
319     } else if (s->finished && ff_inlink_acknowledge_status(inlink, &status, &pts)) {
320         ff_outlink_set_status(outlink, status, pts);
321         return 0;
322     } else {
323         if (ff_outlink_frame_wanted(outlink) && s->finished)
324             ff_inlink_request_frame(inlink);
325         return 0;
326     }
327 }
328
329 static int query_formats(AVFilterContext *ctx)
330 {
331     static const enum AVPixelFormat pix_fmts[] = {
332         AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,
333         AV_PIX_FMT_YUV420P,  AV_PIX_FMT_YUV411P,
334         AV_PIX_FMT_YUV410P,  AV_PIX_FMT_YUV440P,
335         AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUVA422P,
336         AV_PIX_FMT_YUVA420P,
337         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
338         AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
339         AV_PIX_FMT_YUVJ411P,
340         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
341         AV_PIX_FMT_GRAY8,
342         AV_PIX_FMT_NONE
343     };
344
345     AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
346     if (!fmts_list)
347         return AVERROR(ENOMEM);
348     return ff_set_common_formats(ctx, fmts_list);
349 }
350
351 static av_cold void uninit(AVFilterContext *ctx)
352 {
353     ZPContext *s = ctx->priv;
354
355     sws_freeContext(s->sws);
356     s->sws = NULL;
357     av_expr_free(s->x_expr);
358     av_expr_free(s->y_expr);
359     av_expr_free(s->zoom_expr);
360     av_frame_free(&s->in);
361 }
362
363 static const AVFilterPad inputs[] = {
364     {
365         .name         = "default",
366         .type         = AVMEDIA_TYPE_VIDEO,
367     },
368     { NULL }
369 };
370
371 static const AVFilterPad outputs[] = {
372     {
373         .name          = "default",
374         .type          = AVMEDIA_TYPE_VIDEO,
375         .config_props  = config_output,
376     },
377     { NULL }
378 };
379
380 AVFilter ff_vf_zoompan = {
381     .name          = "zoompan",
382     .description   = NULL_IF_CONFIG_SMALL("Apply Zoom & Pan effect."),
383     .priv_size     = sizeof(ZPContext),
384     .priv_class    = &zoompan_class,
385     .init          = init,
386     .uninit        = uninit,
387     .query_formats = query_formats,
388     .activate      = activate,
389     .inputs        = inputs,
390     .outputs       = outputs,
391 };