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