Remove "Error parsing options string [...]" messages.
[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
41     /* set by filter_samples() to signal an output frame to request_frame() */
42     int got_output;
43 } ASyncContext;
44
45 #define OFFSET(x) offsetof(ASyncContext, x)
46 #define A AV_OPT_FLAG_AUDIO_PARAM
47 static const AVOption asyncts_options[] = {
48     { "compensate", "Stretch/squeeze the data to make it match the timestamps", OFFSET(resample),      AV_OPT_TYPE_INT,   { 0 },   0, 1,       A },
49     { "min_delta",  "Minimum difference between timestamps and audio data "
50                     "(in seconds) to trigger padding/trimmin the data.",        OFFSET(min_delta_sec), AV_OPT_TYPE_FLOAT, { 0.1 }, 0, INT_MAX, A },
51     { "max_comp",   "Maximum compensation in samples per second.",              OFFSET(max_comp),      AV_OPT_TYPE_INT,   { 500 }, 0, INT_MAX, A },
52     { "first_pts",  "Assume the first pts should be this value.",               OFFSET(pts),           AV_OPT_TYPE_INT64, { AV_NOPTS_VALUE }, INT64_MIN, INT64_MAX, A },
53     { NULL },
54 };
55
56 AVFILTER_DEFINE_CLASS(asyncts);
57
58 static int init(AVFilterContext *ctx, const char *args)
59 {
60     ASyncContext *s = ctx->priv;
61     int ret;
62
63     s->class = &asyncts_class;
64     av_opt_set_defaults(s);
65
66     if ((ret = av_set_options_string(s, args, "=", ":")) < 0)
67         return ret;
68     av_opt_free(s);
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 = 0;
116     int nb_samples;
117
118     s->got_output = 0;
119     while (ret >= 0 && !s->got_output)
120         ret = ff_request_frame(ctx->inputs[0]);
121
122     /* flush the fifo */
123     if (ret == AVERROR_EOF && (nb_samples = avresample_get_delay(s->avr))) {
124         AVFilterBufferRef *buf = ff_get_audio_buffer(link, AV_PERM_WRITE,
125                                                      nb_samples);
126         if (!buf)
127             return AVERROR(ENOMEM);
128         avresample_convert(s->avr, (void**)buf->extended_data, buf->linesize[0],
129                            nb_samples, NULL, 0, 0);
130         buf->pts = s->pts;
131         return ff_filter_samples(link, buf);
132     }
133
134     return ret;
135 }
136
137 static int write_to_fifo(ASyncContext *s, AVFilterBufferRef *buf)
138 {
139     int ret = avresample_convert(s->avr, NULL, 0, 0, (void**)buf->extended_data,
140                                  buf->linesize[0], buf->audio->nb_samples);
141     avfilter_unref_buffer(buf);
142     return ret;
143 }
144
145 /* get amount of data currently buffered, in samples */
146 static int64_t get_delay(ASyncContext *s)
147 {
148     return avresample_available(s->avr) + avresample_get_delay(s->avr);
149 }
150
151 static int filter_samples(AVFilterLink *inlink, AVFilterBufferRef *buf)
152 {
153     AVFilterContext  *ctx = inlink->dst;
154     ASyncContext       *s = ctx->priv;
155     AVFilterLink *outlink = ctx->outputs[0];
156     int nb_channels = av_get_channel_layout_nb_channels(buf->audio->channel_layout);
157     int64_t pts = (buf->pts == AV_NOPTS_VALUE) ? buf->pts :
158                   av_rescale_q(buf->pts, inlink->time_base, outlink->time_base);
159     int out_size, ret;
160     int64_t delta;
161
162     /* buffer data until we get the first timestamp */
163     if (s->pts == AV_NOPTS_VALUE) {
164         if (pts != AV_NOPTS_VALUE) {
165             s->pts = pts - get_delay(s);
166         }
167         return write_to_fifo(s, buf);
168     }
169
170     /* now wait for the next timestamp */
171     if (pts == AV_NOPTS_VALUE) {
172         return write_to_fifo(s, buf);
173     }
174
175     /* when we have two timestamps, compute how many samples would we have
176      * to add/remove to get proper sync between data and timestamps */
177     delta    = pts - s->pts - get_delay(s);
178     out_size = avresample_available(s->avr);
179
180     if (labs(delta) > s->min_delta) {
181         av_log(ctx, AV_LOG_VERBOSE, "Discontinuity - %"PRId64" samples.\n", delta);
182         out_size = av_clipl_int32((int64_t)out_size + delta);
183     } else {
184         if (s->resample) {
185             int comp = av_clip(delta, -s->max_comp, s->max_comp);
186             av_log(ctx, AV_LOG_VERBOSE, "Compensating %d samples per second.\n", comp);
187             avresample_set_compensation(s->avr, delta, inlink->sample_rate);
188         }
189         delta = 0;
190     }
191
192     if (out_size > 0) {
193         AVFilterBufferRef *buf_out = ff_get_audio_buffer(outlink, AV_PERM_WRITE,
194                                                          out_size);
195         if (!buf_out) {
196             ret = AVERROR(ENOMEM);
197             goto fail;
198         }
199
200         avresample_read(s->avr, (void**)buf_out->extended_data, out_size);
201         buf_out->pts = s->pts;
202
203         if (delta > 0) {
204             av_samples_set_silence(buf_out->extended_data, out_size - delta,
205                                    delta, nb_channels, buf->format);
206         }
207         ret = ff_filter_samples(outlink, buf_out);
208         if (ret < 0)
209             goto fail;
210         s->got_output = 1;
211     } else {
212         av_log(ctx, AV_LOG_WARNING, "Non-monotonous timestamps, dropping "
213                "whole buffer.\n");
214     }
215
216     /* drain any remaining buffered data */
217     avresample_read(s->avr, NULL, avresample_available(s->avr));
218
219     s->pts = pts - avresample_get_delay(s->avr);
220     ret = avresample_convert(s->avr, NULL, 0, 0, (void**)buf->extended_data,
221                              buf->linesize[0], buf->audio->nb_samples);
222
223 fail:
224     avfilter_unref_buffer(buf);
225
226     return ret;
227 }
228
229 AVFilter avfilter_af_asyncts = {
230     .name        = "asyncts",
231     .description = NULL_IF_CONFIG_SMALL("Sync audio data to timestamps"),
232
233     .init        = init,
234     .uninit      = uninit,
235
236     .priv_size   = sizeof(ASyncContext),
237
238     .inputs      = (const AVFilterPad[]) {{ .name           = "default",
239                                             .type           = AVMEDIA_TYPE_AUDIO,
240                                             .filter_samples = filter_samples },
241                                           { NULL }},
242     .outputs     = (const AVFilterPad[]) {{ .name           = "default",
243                                             .type           = AVMEDIA_TYPE_AUDIO,
244                                             .config_props   = config_props,
245                                             .request_frame  = request_frame },
246                                           { NULL }},
247 };