setpts: add FRAME_RATE constant
[ffmpeg.git] / libavfilter / setpts.c
1 /*
2  * Copyright (c) 2010 Stefano Sabatini
3  * Copyright (c) 2008 Victor Paesa
4  *
5  * This file is part of Libav.
6  *
7  * Libav is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * Libav is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * video presentation timestamp (PTS) modification filter
25  */
26
27 #include <inttypes.h>
28
29 #include "libavutil/eval.h"
30 #include "libavutil/internal.h"
31 #include "libavutil/mathematics.h"
32 #include "libavutil/opt.h"
33 #include "libavutil/time.h"
34
35 #include "audio.h"
36 #include "avfilter.h"
37 #include "internal.h"
38 #include "video.h"
39
40 #include "config.h"
41
42 static const char *const var_names[] = {
43     "E",           ///< Euler number
44     "FRAME_RATE",  ///< defined only for constant frame-rate video
45     "INTERLACED",  ///< tell if the current frame is interlaced
46     "N",           ///< frame / sample number (starting at zero)
47     "PHI",         ///< golden ratio
48     "PI",          ///< greek pi
49     "PREV_INPTS",  ///< previous  input PTS
50     "PREV_OUTPTS", ///< previous output PTS
51     "PTS",         ///< original pts in the file of the frame
52     "STARTPTS",    ///< PTS at start of movie
53     "TB",          ///< timebase
54     "RTCTIME",     ///< wallclock (RTC) time in micro seconds
55     "RTCSTART",    ///< wallclock (RTC) time at the start of the movie in micro seconds
56     "S",           //   Number of samples in the current frame
57     "SR",          //   Audio sample rate
58     NULL
59 };
60
61 enum var_name {
62     VAR_E,
63     VAR_FRAME_RATE,
64     VAR_INTERLACED,
65     VAR_N,
66     VAR_PHI,
67     VAR_PI,
68     VAR_PREV_INPTS,
69     VAR_PREV_OUTPTS,
70     VAR_PTS,
71     VAR_STARTPTS,
72     VAR_TB,
73     VAR_RTCTIME,
74     VAR_RTCSTART,
75     VAR_S,
76     VAR_SR,
77     VAR_VARS_NB
78 };
79
80 typedef struct SetPTSContext {
81     const AVClass *class;
82     char *expr_str;
83     AVExpr *expr;
84     double var_values[VAR_VARS_NB];
85 } SetPTSContext;
86
87 static av_cold int init(AVFilterContext *ctx)
88 {
89     SetPTSContext *setpts = ctx->priv;
90     int ret;
91
92     if ((ret = av_expr_parse(&setpts->expr, setpts->expr_str,
93                              var_names, NULL, NULL, NULL, NULL, 0, ctx)) < 0) {
94         av_log(ctx, AV_LOG_ERROR, "Error while parsing expression '%s'\n", setpts->expr_str);
95         return ret;
96     }
97
98     setpts->var_values[VAR_E]           = M_E;
99     setpts->var_values[VAR_N]           = 0.0;
100     setpts->var_values[VAR_S]           = 0.0;
101     setpts->var_values[VAR_PHI]         = M_PHI;
102     setpts->var_values[VAR_PI]          = M_PI;
103     setpts->var_values[VAR_PREV_INPTS]  = NAN;
104     setpts->var_values[VAR_PREV_OUTPTS] = NAN;
105     setpts->var_values[VAR_STARTPTS]    = NAN;
106     return 0;
107 }
108
109 static int config_input(AVFilterLink *inlink)
110 {
111     SetPTSContext *setpts = inlink->dst->priv;
112
113     setpts->var_values[VAR_TB] = av_q2d(inlink->time_base);
114     setpts->var_values[VAR_RTCSTART] = av_gettime();
115
116     if (inlink->type == AVMEDIA_TYPE_AUDIO) {
117         setpts->var_values[VAR_SR] = inlink->sample_rate;
118     }
119
120     setpts->var_values[VAR_FRAME_RATE] = inlink->frame_rate.num &&
121                                          inlink->frame_rate.den ?
122                                             av_q2d(inlink->frame_rate) : NAN;
123
124     // Indicate the output can be variable framerate.
125     inlink->frame_rate = (AVRational){1, 0};
126
127     av_log(inlink->src, AV_LOG_VERBOSE, "TB:%f\n", setpts->var_values[VAR_TB]);
128     return 0;
129 }
130
131 #define D2TS(d)  (isnan(d) ? AV_NOPTS_VALUE : (int64_t)(d))
132 #define TS2D(ts) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts))
133
134 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
135 {
136     SetPTSContext *setpts = inlink->dst->priv;
137     int64_t in_pts = frame->pts;
138     double d;
139
140     if (isnan(setpts->var_values[VAR_STARTPTS]))
141         setpts->var_values[VAR_STARTPTS] = TS2D(frame->pts);
142
143     setpts->var_values[VAR_PTS       ] = TS2D(frame->pts);
144     setpts->var_values[VAR_RTCTIME   ] = av_gettime();
145
146     if (inlink->type == AVMEDIA_TYPE_VIDEO) {
147         setpts->var_values[VAR_INTERLACED] = frame->interlaced_frame;
148     } else {
149         setpts->var_values[VAR_S] = frame->nb_samples;
150     }
151
152     d = av_expr_eval(setpts->expr, setpts->var_values, NULL);
153     frame->pts = D2TS(d);
154
155     av_log(inlink->dst, AV_LOG_TRACE,
156             "n:%"PRId64" interlaced:%d pts:%"PRId64" t:%f -> pts:%"PRId64" t:%f\n",
157             (int64_t)setpts->var_values[VAR_N],
158             (int)setpts->var_values[VAR_INTERLACED],
159             in_pts, in_pts * av_q2d(inlink->time_base),
160             frame->pts, frame->pts * av_q2d(inlink->time_base));
161
162     if (inlink->type == AVMEDIA_TYPE_VIDEO) {
163         setpts->var_values[VAR_N] += 1.0;
164     } else {
165         setpts->var_values[VAR_N] += frame->nb_samples;
166     }
167
168     setpts->var_values[VAR_PREV_INPTS ] = TS2D(in_pts);
169     setpts->var_values[VAR_PREV_OUTPTS] = TS2D(frame->pts);
170     return ff_filter_frame(inlink->dst->outputs[0], frame);
171 }
172
173 static av_cold void uninit(AVFilterContext *ctx)
174 {
175     SetPTSContext *setpts = ctx->priv;
176     av_expr_free(setpts->expr);
177     setpts->expr = NULL;
178 }
179
180 #define OFFSET(x) offsetof(SetPTSContext, x)
181 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_AUDIO_PARAM
182 static const AVOption options[] = {
183     { "expr", "Expression determining the frame timestamp", OFFSET(expr_str), AV_OPT_TYPE_STRING, { .str = "PTS" }, .flags = FLAGS },
184     { NULL },
185 };
186
187 #if CONFIG_SETPTS_FILTER
188 static const AVClass setpts_class = {
189     .class_name = "setpts",
190     .item_name  = av_default_item_name,
191     .option     = options,
192     .version    = LIBAVUTIL_VERSION_INT,
193 };
194
195 static const AVFilterPad avfilter_vf_setpts_inputs[] = {
196     {
197         .name             = "default",
198         .type             = AVMEDIA_TYPE_VIDEO,
199         .get_video_buffer = ff_null_get_video_buffer,
200         .config_props     = config_input,
201         .filter_frame     = filter_frame,
202     },
203     { NULL }
204 };
205
206 static const AVFilterPad avfilter_vf_setpts_outputs[] = {
207     {
208         .name = "default",
209         .type = AVMEDIA_TYPE_VIDEO,
210     },
211     { NULL }
212 };
213
214 AVFilter ff_vf_setpts = {
215     .name      = "setpts",
216     .description = NULL_IF_CONFIG_SMALL("Set PTS for the output video frame."),
217     .init      = init,
218     .uninit    = uninit,
219
220     .priv_size = sizeof(SetPTSContext),
221     .priv_class = &setpts_class,
222
223     .inputs    = avfilter_vf_setpts_inputs,
224     .outputs   = avfilter_vf_setpts_outputs,
225 };
226 #endif
227
228 #if CONFIG_ASETPTS_FILTER
229 static const AVClass asetpts_class = {
230     .class_name = "asetpts",
231     .item_name  = av_default_item_name,
232     .option     = options,
233     .version    = LIBAVUTIL_VERSION_INT,
234 };
235
236 static const AVFilterPad asetpts_inputs[] = {
237     {
238         .name             = "default",
239         .type             = AVMEDIA_TYPE_AUDIO,
240         .get_audio_buffer = ff_null_get_audio_buffer,
241         .config_props     = config_input,
242         .filter_frame     = filter_frame,
243     },
244     { NULL }
245 };
246
247 static const AVFilterPad asetpts_outputs[] = {
248     {
249         .name = "default",
250         .type = AVMEDIA_TYPE_AUDIO,
251     },
252     { NULL }
253 };
254
255 AVFilter ff_af_asetpts = {
256     .name        = "asetpts",
257     .description = NULL_IF_CONFIG_SMALL("Set PTS for the output audio frame."),
258     .init        = init,
259     .uninit      = uninit,
260
261     .priv_size  = sizeof(SetPTSContext),
262     .priv_class = &asetpts_class,
263
264     .inputs    = asetpts_inputs,
265     .outputs   = asetpts_outputs,
266 };
267 #endif