lavfi: define macro AVFILTER_DEFINE_CLASS
[ffmpeg.git] / libavfilter / af_asyncts.c
1 /*
2  * This file is part of Libav.
3  *
4  * Libav is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * Libav is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with Libav; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 #include "libavresample/avresample.h"
20 #include "libavutil/audio_fifo.h"
21 #include "libavutil/mathematics.h"
22 #include "libavutil/opt.h"
23 #include "libavutil/samplefmt.h"
24
25 #include "audio.h"
26 #include "avfilter.h"
27 #include "internal.h"
28
29 typedef struct ASyncContext {
30     const AVClass *class;
31
32     AVAudioResampleContext *avr;
33     int64_t pts;            ///< timestamp in samples of the first sample in fifo
34     int min_delta;          ///< pad/trim min threshold in samples
35
36     /* options */
37     int resample;
38     float min_delta_sec;
39     int max_comp;
40 } ASyncContext;
41
42 #define OFFSET(x) offsetof(ASyncContext, x)
43 #define A AV_OPT_FLAG_AUDIO_PARAM
44 static const AVOption asyncts_options[] = {
45     { "compensate", "Stretch/squeeze the data to make it match the timestamps", OFFSET(resample),      AV_OPT_TYPE_INT,   { 0 },   0, 1,       A },
46     { "min_delta",  "Minimum difference between timestamps and audio data "
47                     "(in seconds) to trigger padding/trimmin the data.",        OFFSET(min_delta_sec), AV_OPT_TYPE_FLOAT, { 0.1 }, 0, INT_MAX, A },
48     { "max_comp",   "Maximum compensation in samples per second.",              OFFSET(max_comp),      AV_OPT_TYPE_INT,   { 500 }, 0, INT_MAX, A },
49     { NULL },
50 };
51
52 AVFILTER_DEFINE_CLASS(asyncts);
53
54 static int init(AVFilterContext *ctx, const char *args, void *opaque)
55 {
56     ASyncContext *s = ctx->priv;
57     int ret;
58
59     s->class = &asyncts_class;
60     av_opt_set_defaults(s);
61
62     if ((ret = av_set_options_string(s, args, "=", ":")) < 0) {
63         av_log(ctx, AV_LOG_ERROR, "Error parsing options string '%s'.\n", args);
64         return ret;
65     }
66     av_opt_free(s);
67
68     s->pts = AV_NOPTS_VALUE;
69
70     return 0;
71 }
72
73 static void uninit(AVFilterContext *ctx)
74 {
75     ASyncContext *s = ctx->priv;
76
77     if (s->avr) {
78         avresample_close(s->avr);
79         avresample_free(&s->avr);
80     }
81 }
82
83 static int config_props(AVFilterLink *link)
84 {
85     ASyncContext *s = link->src->priv;
86     int ret;
87
88     s->min_delta = s->min_delta_sec * link->sample_rate;
89     link->time_base = (AVRational){1, link->sample_rate};
90
91     s->avr = avresample_alloc_context();
92     if (!s->avr)
93         return AVERROR(ENOMEM);
94
95     av_opt_set_int(s->avr,  "in_channel_layout", link->channel_layout, 0);
96     av_opt_set_int(s->avr, "out_channel_layout", link->channel_layout, 0);
97     av_opt_set_int(s->avr,  "in_sample_fmt",     link->format,         0);
98     av_opt_set_int(s->avr, "out_sample_fmt",     link->format,         0);
99     av_opt_set_int(s->avr,  "in_sample_rate",    link->sample_rate,    0);
100     av_opt_set_int(s->avr, "out_sample_rate",    link->sample_rate,    0);
101
102     if (s->resample)
103         av_opt_set_int(s->avr, "force_resampling", 1, 0);
104
105     if ((ret = avresample_open(s->avr)) < 0)
106         return ret;
107
108     return 0;
109 }
110
111 static int request_frame(AVFilterLink *link)
112 {
113     AVFilterContext *ctx = link->src;
114     ASyncContext      *s = ctx->priv;
115     int ret = ff_request_frame(ctx->inputs[0]);
116     int nb_samples;
117
118     /* flush the fifo */
119     if (ret == AVERROR_EOF && (nb_samples = avresample_get_delay(s->avr))) {
120         AVFilterBufferRef *buf = ff_get_audio_buffer(link, AV_PERM_WRITE,
121                                                      nb_samples);
122         if (!buf)
123             return AVERROR(ENOMEM);
124         avresample_convert(s->avr, (void**)buf->extended_data, buf->linesize[0],
125                            nb_samples, NULL, 0, 0);
126         buf->pts = s->pts;
127         ff_filter_samples(link, buf);
128         return 0;
129     }
130
131     return ret;
132 }
133
134 static void write_to_fifo(ASyncContext *s, AVFilterBufferRef *buf)
135 {
136     avresample_convert(s->avr, NULL, 0, 0, (void**)buf->extended_data,
137                        buf->linesize[0], buf->audio->nb_samples);
138     avfilter_unref_buffer(buf);
139 }
140
141 /* get amount of data currently buffered, in samples */
142 static int64_t get_delay(ASyncContext *s)
143 {
144     return avresample_available(s->avr) + avresample_get_delay(s->avr);
145 }
146
147 static void filter_samples(AVFilterLink *inlink, AVFilterBufferRef *buf)
148 {
149     AVFilterContext  *ctx = inlink->dst;
150     ASyncContext       *s = ctx->priv;
151     AVFilterLink *outlink = ctx->outputs[0];
152     int nb_channels = av_get_channel_layout_nb_channels(buf->audio->channel_layout);
153     int64_t pts = (buf->pts == AV_NOPTS_VALUE) ? buf->pts :
154                   av_rescale_q(buf->pts, inlink->time_base, outlink->time_base);
155     int out_size;
156     int64_t delta;
157
158     /* buffer data until we get the first timestamp */
159     if (s->pts == AV_NOPTS_VALUE) {
160         if (pts != AV_NOPTS_VALUE) {
161             s->pts = pts - get_delay(s);
162         }
163         write_to_fifo(s, buf);
164         return;
165     }
166
167     /* now wait for the next timestamp */
168     if (pts == AV_NOPTS_VALUE) {
169         write_to_fifo(s, buf);
170         return;
171     }
172
173     /* when we have two timestamps, compute how many samples would we have
174      * to add/remove to get proper sync between data and timestamps */
175     delta    = pts - s->pts - get_delay(s);
176     out_size = avresample_available(s->avr);
177
178     if (labs(delta) > s->min_delta) {
179         av_log(ctx, AV_LOG_VERBOSE, "Discontinuity - %"PRId64" samples.\n", delta);
180         out_size += delta;
181     } else {
182         if (s->resample) {
183             int comp = av_clip(delta, -s->max_comp, s->max_comp);
184             av_log(ctx, AV_LOG_VERBOSE, "Compensating %d samples per second.\n", comp);
185             avresample_set_compensation(s->avr, delta, inlink->sample_rate);
186         }
187         delta = 0;
188     }
189
190     if (out_size > 0) {
191         AVFilterBufferRef *buf_out = ff_get_audio_buffer(outlink, AV_PERM_WRITE,
192                                                          out_size);
193         if (!buf_out)
194             return;
195
196         avresample_read(s->avr, (void**)buf_out->extended_data, out_size);
197         buf_out->pts = s->pts;
198
199         if (delta > 0) {
200             av_samples_set_silence(buf_out->extended_data, out_size - delta,
201                                    delta, nb_channels, buf->format);
202         }
203         ff_filter_samples(outlink, buf_out);
204     } else {
205         av_log(ctx, AV_LOG_WARNING, "Non-monotonous timestamps, dropping "
206                "whole buffer.\n");
207     }
208
209     /* drain any remaining buffered data */
210     avresample_read(s->avr, NULL, avresample_available(s->avr));
211
212     s->pts = pts - avresample_get_delay(s->avr);
213     avresample_convert(s->avr, NULL, 0, 0, (void**)buf->extended_data,
214                        buf->linesize[0], buf->audio->nb_samples);
215     avfilter_unref_buffer(buf);
216 }
217
218 AVFilter avfilter_af_asyncts = {
219     .name        = "asyncts",
220     .description = NULL_IF_CONFIG_SMALL("Sync audio data to timestamps"),
221
222     .init        = init,
223     .uninit      = uninit,
224
225     .priv_size   = sizeof(ASyncContext),
226
227     .inputs      = (const AVFilterPad[]) {{ .name           = "default",
228                                             .type           = AVMEDIA_TYPE_AUDIO,
229                                             .filter_samples = filter_samples },
230                                           { NULL }},
231     .outputs     = (const AVFilterPad[]) {{ .name           = "default",
232                                             .type           = AVMEDIA_TYPE_AUDIO,
233                                             .config_props   = config_props,
234                                             .request_frame  = request_frame },
235                                           { NULL }},
236 };