904891258ad99e67947ebc447f0eb14b099d5820
[ffmpeg.git] / libavresample / resample.c
1 /*
2  * Copyright (c) 2004 Michael Niedermayer <michaelni@gmx.at>
3  * Copyright (c) 2012 Justin Ruggles <justin.ruggles@gmail.com>
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 #include "libavutil/common.h"
23 #include "libavutil/libm.h"
24 #include "libavutil/log.h"
25 #include "internal.h"
26 #include "resample.h"
27 #include "audio_data.h"
28
29 struct ResampleContext {
30     AVAudioResampleContext *avr;
31     AudioData *buffer;
32     uint8_t *filter_bank;
33     int filter_length;
34     int ideal_dst_incr;
35     int dst_incr;
36     int index;
37     int frac;
38     int src_incr;
39     int compensation_distance;
40     int phase_shift;
41     int phase_mask;
42     int linear;
43     enum AVResampleFilterType filter_type;
44     int kaiser_beta;
45     double factor;
46     void (*set_filter)(void *filter, double *tab, int phase, int tap_count);
47     void (*resample_one)(struct ResampleContext *c, void *dst0,
48                          int dst_index, const void *src0, int src_size,
49                          int index, int frac);
50     void (*resample_nearest)(void *dst0, int dst_index,
51                              const void *src0, int index);
52     int padding_size;
53 };
54
55
56 /* double template */
57 #define CONFIG_RESAMPLE_DBL
58 #include "resample_template.c"
59 #undef CONFIG_RESAMPLE_DBL
60
61 /* float template */
62 #define CONFIG_RESAMPLE_FLT
63 #include "resample_template.c"
64 #undef CONFIG_RESAMPLE_FLT
65
66 /* s32 template */
67 #define CONFIG_RESAMPLE_S32
68 #include "resample_template.c"
69 #undef CONFIG_RESAMPLE_S32
70
71 /* s16 template */
72 #include "resample_template.c"
73
74
75 /* 0th order modified bessel function of the first kind. */
76 static double bessel(double x)
77 {
78     double v     = 1;
79     double lastv = 0;
80     double t     = 1;
81     int i;
82
83     x = x * x / 4;
84     for (i = 1; v != lastv; i++) {
85         lastv = v;
86         t    *= x / (i * i);
87         v    += t;
88     }
89     return v;
90 }
91
92 /* Build a polyphase filterbank. */
93 static int build_filter(ResampleContext *c)
94 {
95     int ph, i;
96     double x, y, w, factor;
97     double *tab;
98     int tap_count    = c->filter_length;
99     int phase_count  = 1 << c->phase_shift;
100     const int center = (tap_count - 1) / 2;
101
102     tab = av_malloc(tap_count * sizeof(*tab));
103     if (!tab)
104         return AVERROR(ENOMEM);
105
106     /* if upsampling, only need to interpolate, no filter */
107     factor = FFMIN(c->factor, 1.0);
108
109     for (ph = 0; ph < phase_count; ph++) {
110         double norm = 0;
111         for (i = 0; i < tap_count; i++) {
112             x = M_PI * ((double)(i - center) - (double)ph / phase_count) * factor;
113             if (x == 0) y = 1.0;
114             else        y = sin(x) / x;
115             switch (c->filter_type) {
116             case AV_RESAMPLE_FILTER_TYPE_CUBIC: {
117                 const float d = -0.5; //first order derivative = -0.5
118                 x = fabs(((double)(i - center) - (double)ph / phase_count) * factor);
119                 if (x < 1.0) y = 1 - 3 * x*x + 2 * x*x*x + d * (                -x*x + x*x*x);
120                 else         y =                           d * (-4 + 8 * x - 5 * x*x + x*x*x);
121                 break;
122             }
123             case AV_RESAMPLE_FILTER_TYPE_BLACKMAN_NUTTALL:
124                 w  = 2.0 * x / (factor * tap_count) + M_PI;
125                 y *= 0.3635819 - 0.4891775 * cos(    w) +
126                                  0.1365995 * cos(2 * w) -
127                                  0.0106411 * cos(3 * w);
128                 break;
129             case AV_RESAMPLE_FILTER_TYPE_KAISER:
130                 w  = 2.0 * x / (factor * tap_count * M_PI);
131                 y *= bessel(c->kaiser_beta * sqrt(FFMAX(1 - w * w, 0)));
132                 break;
133             }
134
135             tab[i] = y;
136             norm  += y;
137         }
138         /* normalize so that an uniform color remains the same */
139         for (i = 0; i < tap_count; i++)
140             tab[i] = tab[i] / norm;
141
142         c->set_filter(c->filter_bank, tab, ph, tap_count);
143     }
144
145     av_free(tab);
146     return 0;
147 }
148
149 ResampleContext *ff_audio_resample_init(AVAudioResampleContext *avr)
150 {
151     ResampleContext *c;
152     int out_rate    = avr->out_sample_rate;
153     int in_rate     = avr->in_sample_rate;
154     double factor   = FFMIN(out_rate * avr->cutoff / in_rate, 1.0);
155     int phase_count = 1 << avr->phase_shift;
156     int felem_size;
157
158     if (avr->internal_sample_fmt != AV_SAMPLE_FMT_S16P &&
159         avr->internal_sample_fmt != AV_SAMPLE_FMT_S32P &&
160         avr->internal_sample_fmt != AV_SAMPLE_FMT_FLTP &&
161         avr->internal_sample_fmt != AV_SAMPLE_FMT_DBLP) {
162         av_log(avr, AV_LOG_ERROR, "Unsupported internal format for "
163                "resampling: %s\n",
164                av_get_sample_fmt_name(avr->internal_sample_fmt));
165         return NULL;
166     }
167     c = av_mallocz(sizeof(*c));
168     if (!c)
169         return NULL;
170
171     c->avr           = avr;
172     c->phase_shift   = avr->phase_shift;
173     c->phase_mask    = phase_count - 1;
174     c->linear        = avr->linear_interp;
175     c->factor        = factor;
176     c->filter_length = FFMAX((int)ceil(avr->filter_size / factor), 1);
177     c->filter_type   = avr->filter_type;
178     c->kaiser_beta   = avr->kaiser_beta;
179
180     switch (avr->internal_sample_fmt) {
181     case AV_SAMPLE_FMT_DBLP:
182         c->resample_one  = resample_one_dbl;
183         c->resample_nearest = resample_nearest_dbl;
184         c->set_filter    = set_filter_dbl;
185         break;
186     case AV_SAMPLE_FMT_FLTP:
187         c->resample_one  = resample_one_flt;
188         c->resample_nearest = resample_nearest_flt;
189         c->set_filter    = set_filter_flt;
190         break;
191     case AV_SAMPLE_FMT_S32P:
192         c->resample_one  = resample_one_s32;
193         c->resample_nearest = resample_nearest_s32;
194         c->set_filter    = set_filter_s32;
195         break;
196     case AV_SAMPLE_FMT_S16P:
197         c->resample_one  = resample_one_s16;
198         c->resample_nearest = resample_nearest_s16;
199         c->set_filter    = set_filter_s16;
200         break;
201     }
202
203     felem_size = av_get_bytes_per_sample(avr->internal_sample_fmt);
204     c->filter_bank = av_mallocz(c->filter_length * (phase_count + 1) * felem_size);
205     if (!c->filter_bank)
206         goto error;
207
208     if (build_filter(c) < 0)
209         goto error;
210
211     memcpy(&c->filter_bank[(c->filter_length * phase_count + 1) * felem_size],
212            c->filter_bank, (c->filter_length - 1) * felem_size);
213     memcpy(&c->filter_bank[c->filter_length * phase_count * felem_size],
214            &c->filter_bank[(c->filter_length - 1) * felem_size], felem_size);
215
216     c->compensation_distance = 0;
217     if (!av_reduce(&c->src_incr, &c->dst_incr, out_rate,
218                    in_rate * (int64_t)phase_count, INT32_MAX / 2))
219         goto error;
220     c->ideal_dst_incr = c->dst_incr;
221
222     c->padding_size   = (c->filter_length - 1) / 2;
223     c->index = -phase_count * ((c->filter_length - 1) / 2);
224     c->frac  = 0;
225
226     /* allocate internal buffer */
227     c->buffer = ff_audio_data_alloc(avr->resample_channels, 0,
228                                     avr->internal_sample_fmt,
229                                     "resample buffer");
230     if (!c->buffer)
231         goto error;
232
233     av_log(avr, AV_LOG_DEBUG, "resample: %s from %d Hz to %d Hz\n",
234            av_get_sample_fmt_name(avr->internal_sample_fmt),
235            avr->in_sample_rate, avr->out_sample_rate);
236
237     return c;
238
239 error:
240     ff_audio_data_free(&c->buffer);
241     av_free(c->filter_bank);
242     av_free(c);
243     return NULL;
244 }
245
246 void ff_audio_resample_free(ResampleContext **c)
247 {
248     if (!*c)
249         return;
250     ff_audio_data_free(&(*c)->buffer);
251     av_free((*c)->filter_bank);
252     av_freep(c);
253 }
254
255 int avresample_set_compensation(AVAudioResampleContext *avr, int sample_delta,
256                                 int compensation_distance)
257 {
258     ResampleContext *c;
259     AudioData *fifo_buf = NULL;
260     int ret = 0;
261
262     if (compensation_distance < 0)
263         return AVERROR(EINVAL);
264     if (!compensation_distance && sample_delta)
265         return AVERROR(EINVAL);
266
267     if (!avr->resample_needed) {
268 #if FF_API_RESAMPLE_CLOSE_OPEN
269         /* if resampling was not enabled previously, re-initialize the
270            AVAudioResampleContext and force resampling */
271         int fifo_samples;
272         int restore_matrix = 0;
273         double matrix[AVRESAMPLE_MAX_CHANNELS * AVRESAMPLE_MAX_CHANNELS] = { 0 };
274
275         /* buffer any remaining samples in the output FIFO before closing */
276         fifo_samples = av_audio_fifo_size(avr->out_fifo);
277         if (fifo_samples > 0) {
278             fifo_buf = ff_audio_data_alloc(avr->out_channels, fifo_samples,
279                                            avr->out_sample_fmt, NULL);
280             if (!fifo_buf)
281                 return AVERROR(EINVAL);
282             ret = ff_audio_data_read_from_fifo(avr->out_fifo, fifo_buf,
283                                                fifo_samples);
284             if (ret < 0)
285                 goto reinit_fail;
286         }
287         /* save the channel mixing matrix */
288         if (avr->am) {
289             ret = avresample_get_matrix(avr, matrix, AVRESAMPLE_MAX_CHANNELS);
290             if (ret < 0)
291                 goto reinit_fail;
292             restore_matrix = 1;
293         }
294
295         /* close the AVAudioResampleContext */
296         avresample_close(avr);
297
298         avr->force_resampling = 1;
299
300         /* restore the channel mixing matrix */
301         if (restore_matrix) {
302             ret = avresample_set_matrix(avr, matrix, AVRESAMPLE_MAX_CHANNELS);
303             if (ret < 0)
304                 goto reinit_fail;
305         }
306
307         /* re-open the AVAudioResampleContext */
308         ret = avresample_open(avr);
309         if (ret < 0)
310             goto reinit_fail;
311
312         /* restore buffered samples to the output FIFO */
313         if (fifo_samples > 0) {
314             ret = ff_audio_data_add_to_fifo(avr->out_fifo, fifo_buf, 0,
315                                             fifo_samples);
316             if (ret < 0)
317                 goto reinit_fail;
318             ff_audio_data_free(&fifo_buf);
319         }
320 #else
321         av_log(avr, AV_LOG_ERROR, "Unable to set resampling compensation\n");
322         return AVERROR(EINVAL);
323 #endif
324     }
325     c = avr->resample;
326     c->compensation_distance = compensation_distance;
327     if (compensation_distance) {
328         c->dst_incr = c->ideal_dst_incr - c->ideal_dst_incr *
329                       (int64_t)sample_delta / compensation_distance;
330     } else {
331         c->dst_incr = c->ideal_dst_incr;
332     }
333     return 0;
334
335 reinit_fail:
336     ff_audio_data_free(&fifo_buf);
337     return ret;
338 }
339
340 static int resample(ResampleContext *c, void *dst, const void *src,
341                     int *consumed, int src_size, int dst_size, int update_ctx,
342                     int nearest_neighbour)
343 {
344     int dst_index;
345     int index         = c->index;
346     int frac          = c->frac;
347     int dst_incr_frac = c->dst_incr % c->src_incr;
348     int dst_incr      = c->dst_incr / c->src_incr;
349     int compensation_distance = c->compensation_distance;
350
351     if (!dst != !src)
352         return AVERROR(EINVAL);
353
354     if (nearest_neighbour) {
355         int64_t index2 = ((int64_t)index) << 32;
356         int64_t incr   = (1LL << 32) * c->dst_incr / c->src_incr;
357         dst_size       = FFMIN(dst_size,
358                                (src_size-1-index) * (int64_t)c->src_incr /
359                                c->dst_incr);
360
361         if (dst) {
362             for(dst_index = 0; dst_index < dst_size; dst_index++) {
363                 c->resample_nearest(dst, dst_index, src, index2 >> 32);
364                 index2 += incr;
365             }
366         } else {
367             dst_index = dst_size;
368         }
369         index += dst_index * dst_incr;
370         index += (frac + dst_index * (int64_t)dst_incr_frac) / c->src_incr;
371         frac   = (frac + dst_index * (int64_t)dst_incr_frac) % c->src_incr;
372     } else {
373         for (dst_index = 0; dst_index < dst_size; dst_index++) {
374             int sample_index = index >> c->phase_shift;
375
376             if (sample_index + c->filter_length > src_size ||
377                 -sample_index >= src_size)
378                 break;
379
380             if (dst)
381                 c->resample_one(c, dst, dst_index, src, src_size, index, frac);
382
383             frac  += dst_incr_frac;
384             index += dst_incr;
385             if (frac >= c->src_incr) {
386                 frac -= c->src_incr;
387                 index++;
388             }
389             if (dst_index + 1 == compensation_distance) {
390                 compensation_distance = 0;
391                 dst_incr_frac = c->ideal_dst_incr % c->src_incr;
392                 dst_incr      = c->ideal_dst_incr / c->src_incr;
393             }
394         }
395     }
396     if (consumed)
397         *consumed = FFMAX(index, 0) >> c->phase_shift;
398
399     if (update_ctx) {
400         if (index >= 0)
401             index &= c->phase_mask;
402
403         if (compensation_distance) {
404             compensation_distance -= dst_index;
405             if (compensation_distance <= 0)
406                 return AVERROR_BUG;
407         }
408         c->frac     = frac;
409         c->index    = index;
410         c->dst_incr = dst_incr_frac + c->src_incr*dst_incr;
411         c->compensation_distance = compensation_distance;
412     }
413
414     return dst_index;
415 }
416
417 int ff_audio_resample(ResampleContext *c, AudioData *dst, AudioData *src)
418 {
419     int ch, in_samples, in_leftover, consumed = 0, out_samples = 0;
420     int ret = AVERROR(EINVAL);
421     int nearest_neighbour = (c->compensation_distance == 0 &&
422                              c->filter_length == 1 &&
423                              c->phase_shift == 0);
424
425     in_samples  = src ? src->nb_samples : 0;
426     in_leftover = c->buffer->nb_samples;
427
428     /* add input samples to the internal buffer */
429     if (src) {
430         ret = ff_audio_data_combine(c->buffer, in_leftover, src, 0, in_samples);
431         if (ret < 0)
432             return ret;
433     } else if (!in_leftover) {
434         /* no remaining samples to flush */
435         return 0;
436     } else {
437         /* TODO: pad buffer to flush completely */
438     }
439
440     /* calculate output size and reallocate output buffer if needed */
441     /* TODO: try to calculate this without the dummy resample() run */
442     if (!dst->read_only && dst->allow_realloc) {
443         out_samples = resample(c, NULL, NULL, NULL, c->buffer->nb_samples,
444                                INT_MAX, 0, nearest_neighbour);
445         ret = ff_audio_data_realloc(dst, out_samples);
446         if (ret < 0) {
447             av_log(c->avr, AV_LOG_ERROR, "error reallocating output\n");
448             return ret;
449         }
450     }
451
452     /* resample each channel plane */
453     for (ch = 0; ch < c->buffer->channels; ch++) {
454         out_samples = resample(c, (void *)dst->data[ch],
455                                (const void *)c->buffer->data[ch], &consumed,
456                                c->buffer->nb_samples, dst->allocated_samples,
457                                ch + 1 == c->buffer->channels, nearest_neighbour);
458     }
459     if (out_samples < 0) {
460         av_log(c->avr, AV_LOG_ERROR, "error during resampling\n");
461         return out_samples;
462     }
463
464     /* drain consumed samples from the internal buffer */
465     ff_audio_data_drain(c->buffer, consumed);
466
467     av_dlog(c->avr, "resampled %d in + %d leftover to %d out + %d leftover\n",
468             in_samples, in_leftover, out_samples, c->buffer->nb_samples);
469
470     dst->nb_samples = out_samples;
471     return 0;
472 }
473
474 int avresample_get_delay(AVAudioResampleContext *avr)
475 {
476     ResampleContext *c = avr->resample;
477
478     if (!avr->resample_needed || !avr->resample)
479         return 0;
480
481     return FFMAX(c->buffer->nb_samples - c->padding_size, 0);
482 }