swresample/resample: merge first iteration into init in bessel()
[ffmpeg.git] / libswresample / resample.c
1 /*
2  * audio resampling
3  * Copyright (c) 2004-2012 Michael Niedermayer <michaelni@gmx.at>
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 /**
23  * @file
24  * audio resampling
25  * @author Michael Niedermayer <michaelni@gmx.at>
26  */
27
28 #include "libavutil/avassert.h"
29 #include "resample.h"
30
31 /**
32  * 0th order modified bessel function of the first kind.
33  */
34 static double bessel(double x){
35     double lastv=0;
36     double t, v;
37     int i;
38     static const double inv[100]={
39  1.0/( 1* 1), 1.0/( 2* 2), 1.0/( 3* 3), 1.0/( 4* 4), 1.0/( 5* 5), 1.0/( 6* 6), 1.0/( 7* 7), 1.0/( 8* 8), 1.0/( 9* 9), 1.0/(10*10),
40  1.0/(11*11), 1.0/(12*12), 1.0/(13*13), 1.0/(14*14), 1.0/(15*15), 1.0/(16*16), 1.0/(17*17), 1.0/(18*18), 1.0/(19*19), 1.0/(20*20),
41  1.0/(21*21), 1.0/(22*22), 1.0/(23*23), 1.0/(24*24), 1.0/(25*25), 1.0/(26*26), 1.0/(27*27), 1.0/(28*28), 1.0/(29*29), 1.0/(30*30),
42  1.0/(31*31), 1.0/(32*32), 1.0/(33*33), 1.0/(34*34), 1.0/(35*35), 1.0/(36*36), 1.0/(37*37), 1.0/(38*38), 1.0/(39*39), 1.0/(40*40),
43  1.0/(41*41), 1.0/(42*42), 1.0/(43*43), 1.0/(44*44), 1.0/(45*45), 1.0/(46*46), 1.0/(47*47), 1.0/(48*48), 1.0/(49*49), 1.0/(50*50),
44  1.0/(51*51), 1.0/(52*52), 1.0/(53*53), 1.0/(54*54), 1.0/(55*55), 1.0/(56*56), 1.0/(57*57), 1.0/(58*58), 1.0/(59*59), 1.0/(60*60),
45  1.0/(61*61), 1.0/(62*62), 1.0/(63*63), 1.0/(64*64), 1.0/(65*65), 1.0/(66*66), 1.0/(67*67), 1.0/(68*68), 1.0/(69*69), 1.0/(70*70),
46  1.0/(71*71), 1.0/(72*72), 1.0/(73*73), 1.0/(74*74), 1.0/(75*75), 1.0/(76*76), 1.0/(77*77), 1.0/(78*78), 1.0/(79*79), 1.0/(80*80),
47  1.0/(81*81), 1.0/(82*82), 1.0/(83*83), 1.0/(84*84), 1.0/(85*85), 1.0/(86*86), 1.0/(87*87), 1.0/(88*88), 1.0/(89*89), 1.0/(90*90),
48  1.0/(91*91), 1.0/(92*92), 1.0/(93*93), 1.0/(94*94), 1.0/(95*95), 1.0/(96*96), 1.0/(97*97), 1.0/(98*98), 1.0/(99*99), 1.0/(10000)
49     };
50
51     x= x*x/4;
52     t = x;
53     v = 1 + x;
54     for(i=1; v != lastv; i++){
55         lastv=v;
56         t *= x*inv[i];
57         v += t;
58         av_assert2(i<99);
59     }
60     return v;
61 }
62
63 /**
64  * builds a polyphase filterbank.
65  * @param factor resampling factor
66  * @param scale wanted sum of coefficients for each filter
67  * @param filter_type  filter type
68  * @param kaiser_beta  kaiser window beta
69  * @return 0 on success, negative on error
70  */
71 static int build_filter(ResampleContext *c, void *filter, double factor, int tap_count, int alloc, int phase_count, int scale,
72                         int filter_type, int kaiser_beta){
73     int ph, i;
74     double x, y, w;
75     double *tab = av_malloc_array(tap_count,  sizeof(*tab));
76     const int center= (tap_count-1)/2;
77
78     if (!tab)
79         return AVERROR(ENOMEM);
80
81     /* if upsampling, only need to interpolate, no filter */
82     if (factor > 1.0)
83         factor = 1.0;
84
85     for(ph=0;ph<phase_count;ph++) {
86         double norm = 0;
87         for(i=0;i<tap_count;i++) {
88             x = M_PI * ((double)(i - center) - (double)ph / phase_count) * factor;
89             if (x == 0) y = 1.0;
90             else        y = sin(x) / x;
91             switch(filter_type){
92             case SWR_FILTER_TYPE_CUBIC:{
93                 const float d= -0.5; //first order derivative = -0.5
94                 x = fabs(((double)(i - center) - (double)ph / phase_count) * factor);
95                 if(x<1.0) y= 1 - 3*x*x + 2*x*x*x + d*(            -x*x + x*x*x);
96                 else      y=                       d*(-4 + 8*x - 5*x*x + x*x*x);
97                 break;}
98             case SWR_FILTER_TYPE_BLACKMAN_NUTTALL:
99                 w = 2.0*x / (factor*tap_count) + M_PI;
100                 y *= 0.3635819 - 0.4891775 * cos(w) + 0.1365995 * cos(2*w) - 0.0106411 * cos(3*w);
101                 break;
102             case SWR_FILTER_TYPE_KAISER:
103                 w = 2.0*x / (factor*tap_count*M_PI);
104                 y *= bessel(kaiser_beta*sqrt(FFMAX(1-w*w, 0)));
105                 break;
106             default:
107                 av_assert0(0);
108             }
109
110             tab[i] = y;
111             norm += y;
112         }
113
114         /* normalize so that an uniform color remains the same */
115         switch(c->format){
116         case AV_SAMPLE_FMT_S16P:
117             for(i=0;i<tap_count;i++)
118                 ((int16_t*)filter)[ph * alloc + i] = av_clip(lrintf(tab[i] * scale / norm), INT16_MIN, INT16_MAX);
119             break;
120         case AV_SAMPLE_FMT_S32P:
121             for(i=0;i<tap_count;i++)
122                 ((int32_t*)filter)[ph * alloc + i] = av_clipl_int32(llrint(tab[i] * scale / norm));
123             break;
124         case AV_SAMPLE_FMT_FLTP:
125             for(i=0;i<tap_count;i++)
126                 ((float*)filter)[ph * alloc + i] = tab[i] * scale / norm;
127             break;
128         case AV_SAMPLE_FMT_DBLP:
129             for(i=0;i<tap_count;i++)
130                 ((double*)filter)[ph * alloc + i] = tab[i] * scale / norm;
131             break;
132         }
133     }
134 #if 0
135     {
136 #define LEN 1024
137         int j,k;
138         double sine[LEN + tap_count];
139         double filtered[LEN];
140         double maxff=-2, minff=2, maxsf=-2, minsf=2;
141         for(i=0; i<LEN; i++){
142             double ss=0, sf=0, ff=0;
143             for(j=0; j<LEN+tap_count; j++)
144                 sine[j]= cos(i*j*M_PI/LEN);
145             for(j=0; j<LEN; j++){
146                 double sum=0;
147                 ph=0;
148                 for(k=0; k<tap_count; k++)
149                     sum += filter[ph * tap_count + k] * sine[k+j];
150                 filtered[j]= sum / (1<<FILTER_SHIFT);
151                 ss+= sine[j + center] * sine[j + center];
152                 ff+= filtered[j] * filtered[j];
153                 sf+= sine[j + center] * filtered[j];
154             }
155             ss= sqrt(2*ss/LEN);
156             ff= sqrt(2*ff/LEN);
157             sf= 2*sf/LEN;
158             maxff= FFMAX(maxff, ff);
159             minff= FFMIN(minff, ff);
160             maxsf= FFMAX(maxsf, sf);
161             minsf= FFMIN(minsf, sf);
162             if(i%11==0){
163                 av_log(NULL, AV_LOG_ERROR, "i:%4d ss:%f ff:%13.6e-%13.6e sf:%13.6e-%13.6e\n", i, ss, maxff, minff, maxsf, minsf);
164                 minff=minsf= 2;
165                 maxff=maxsf= -2;
166             }
167         }
168     }
169 #endif
170
171     av_free(tab);
172     return 0;
173 }
174
175 static ResampleContext *resample_init(ResampleContext *c, int out_rate, int in_rate, int filter_size, int phase_shift, int linear,
176                                     double cutoff0, enum AVSampleFormat format, enum SwrFilterType filter_type, int kaiser_beta,
177                                     double precision, int cheby)
178 {
179     double cutoff = cutoff0? cutoff0 : 0.97;
180     double factor= FFMIN(out_rate * cutoff / in_rate, 1.0);
181     int phase_count= 1<<phase_shift;
182
183     if (!c || c->phase_shift != phase_shift || c->linear!=linear || c->factor != factor
184            || c->filter_length != FFMAX((int)ceil(filter_size/factor), 1) || c->format != format
185            || c->filter_type != filter_type || c->kaiser_beta != kaiser_beta) {
186         c = av_mallocz(sizeof(*c));
187         if (!c)
188             return NULL;
189
190         c->format= format;
191
192         c->felem_size= av_get_bytes_per_sample(c->format);
193
194         switch(c->format){
195         case AV_SAMPLE_FMT_S16P:
196             c->filter_shift = 15;
197             break;
198         case AV_SAMPLE_FMT_S32P:
199             c->filter_shift = 30;
200             break;
201         case AV_SAMPLE_FMT_FLTP:
202         case AV_SAMPLE_FMT_DBLP:
203             c->filter_shift = 0;
204             break;
205         default:
206             av_log(NULL, AV_LOG_ERROR, "Unsupported sample format\n");
207             av_assert0(0);
208         }
209
210         if (filter_size/factor > INT32_MAX/256) {
211             av_log(NULL, AV_LOG_ERROR, "Filter length too large\n");
212             goto error;
213         }
214
215         c->phase_shift   = phase_shift;
216         c->phase_mask    = phase_count - 1;
217         c->linear        = linear;
218         c->factor        = factor;
219         c->filter_length = FFMAX((int)ceil(filter_size/factor), 1);
220         c->filter_alloc  = FFALIGN(c->filter_length, 8);
221         c->filter_bank   = av_calloc(c->filter_alloc, (phase_count+1)*c->felem_size);
222         c->filter_type   = filter_type;
223         c->kaiser_beta   = kaiser_beta;
224         if (!c->filter_bank)
225             goto error;
226         if (build_filter(c, (void*)c->filter_bank, factor, c->filter_length, c->filter_alloc, phase_count, 1<<c->filter_shift, filter_type, kaiser_beta))
227             goto error;
228         memcpy(c->filter_bank + (c->filter_alloc*phase_count+1)*c->felem_size, c->filter_bank, (c->filter_alloc-1)*c->felem_size);
229         memcpy(c->filter_bank + (c->filter_alloc*phase_count  )*c->felem_size, c->filter_bank + (c->filter_alloc - 1)*c->felem_size, c->felem_size);
230     }
231
232     c->compensation_distance= 0;
233     if(!av_reduce(&c->src_incr, &c->dst_incr, out_rate, in_rate * (int64_t)phase_count, INT32_MAX/2))
234         goto error;
235     c->ideal_dst_incr = c->dst_incr;
236     c->dst_incr_div   = c->dst_incr / c->src_incr;
237     c->dst_incr_mod   = c->dst_incr % c->src_incr;
238
239     c->index= -phase_count*((c->filter_length-1)/2);
240     c->frac= 0;
241
242     swri_resample_dsp_init(c);
243
244     return c;
245 error:
246     av_freep(&c->filter_bank);
247     av_free(c);
248     return NULL;
249 }
250
251 static void resample_free(ResampleContext **c){
252     if(!*c)
253         return;
254     av_freep(&(*c)->filter_bank);
255     av_freep(c);
256 }
257
258 static int set_compensation(ResampleContext *c, int sample_delta, int compensation_distance){
259     c->compensation_distance= compensation_distance;
260     if (compensation_distance)
261         c->dst_incr = c->ideal_dst_incr - c->ideal_dst_incr * (int64_t)sample_delta / compensation_distance;
262     else
263         c->dst_incr = c->ideal_dst_incr;
264
265     c->dst_incr_div   = c->dst_incr / c->src_incr;
266     c->dst_incr_mod   = c->dst_incr % c->src_incr;
267
268     return 0;
269 }
270
271 static int swri_resample(ResampleContext *c,
272                          uint8_t *dst, const uint8_t *src, int *consumed,
273                          int src_size, int dst_size, int update_ctx)
274 {
275     if (c->filter_length == 1 && c->phase_shift == 0) {
276         int index= c->index;
277         int frac= c->frac;
278         int64_t index2= (1LL<<32)*c->frac/c->src_incr + (1LL<<32)*index;
279         int64_t incr= (1LL<<32) * c->dst_incr / c->src_incr;
280         int new_size = (src_size * (int64_t)c->src_incr - frac + c->dst_incr - 1) / c->dst_incr;
281
282         dst_size= FFMIN(dst_size, new_size);
283         c->dsp.resample_one(dst, src, dst_size, index2, incr);
284
285         index += dst_size * c->dst_incr_div;
286         index += (frac + dst_size * (int64_t)c->dst_incr_mod) / c->src_incr;
287         av_assert2(index >= 0);
288         *consumed= index;
289         if (update_ctx) {
290             c->frac   = (frac + dst_size * (int64_t)c->dst_incr_mod) % c->src_incr;
291             c->index = 0;
292         }
293     } else {
294         int64_t end_index = (1LL + src_size - c->filter_length) << c->phase_shift;
295         int64_t delta_frac = (end_index - c->index) * c->src_incr - c->frac;
296         int delta_n = (delta_frac + c->dst_incr - 1) / c->dst_incr;
297
298         dst_size = FFMIN(dst_size, delta_n);
299         if (dst_size > 0) {
300             *consumed = c->dsp.resample(c, dst, src, dst_size, update_ctx);
301         } else {
302             *consumed = 0;
303         }
304     }
305
306     return dst_size;
307 }
308
309 static int multiple_resample(ResampleContext *c, AudioData *dst, int dst_size, AudioData *src, int src_size, int *consumed){
310     int i, ret= -1;
311     int av_unused mm_flags = av_get_cpu_flags();
312     int need_emms = c->format == AV_SAMPLE_FMT_S16P && ARCH_X86_32 &&
313                     (mm_flags & (AV_CPU_FLAG_MMX2 | AV_CPU_FLAG_SSE2)) == AV_CPU_FLAG_MMX2;
314     int64_t max_src_size = (INT64_MAX >> (c->phase_shift+1)) / c->src_incr;
315
316     if (c->compensation_distance)
317         dst_size = FFMIN(dst_size, c->compensation_distance);
318     src_size = FFMIN(src_size, max_src_size);
319
320     for(i=0; i<dst->ch_count; i++){
321         ret= swri_resample(c, dst->ch[i], src->ch[i],
322                            consumed, src_size, dst_size, i+1==dst->ch_count);
323     }
324     if(need_emms)
325         emms_c();
326
327     if (c->compensation_distance) {
328         c->compensation_distance -= ret;
329         if (!c->compensation_distance) {
330             c->dst_incr     = c->ideal_dst_incr;
331             c->dst_incr_div = c->dst_incr / c->src_incr;
332             c->dst_incr_mod = c->dst_incr % c->src_incr;
333         }
334     }
335
336     return ret;
337 }
338
339 static int64_t get_delay(struct SwrContext *s, int64_t base){
340     ResampleContext *c = s->resample;
341     int64_t num = s->in_buffer_count - (c->filter_length-1)/2;
342     num *= 1 << c->phase_shift;
343     num -= c->index;
344     num *= c->src_incr;
345     num -= c->frac;
346     return av_rescale(num, base, s->in_sample_rate*(int64_t)c->src_incr << c->phase_shift);
347 }
348
349 static int64_t get_out_samples(struct SwrContext *s, int in_samples) {
350     ResampleContext *c = s->resample;
351     // The + 2 are added to allow implementations to be slightly inaccurate, they should not be needed currently.
352     // They also make it easier to proof that changes and optimizations do not
353     // break the upper bound.
354     int64_t num = s->in_buffer_count + 2LL + in_samples;
355     num *= 1 << c->phase_shift;
356     num -= c->index;
357     num = av_rescale_rnd(num, s->out_sample_rate, ((int64_t)s->in_sample_rate) << c->phase_shift, AV_ROUND_UP) + 2;
358
359     if (c->compensation_distance) {
360         if (num > INT_MAX)
361             return AVERROR(EINVAL);
362
363         num = FFMAX(num, (num * c->ideal_dst_incr - 1) / c->dst_incr + 1);
364     }
365     return num;
366 }
367
368 static int resample_flush(struct SwrContext *s) {
369     AudioData *a= &s->in_buffer;
370     int i, j, ret;
371     if((ret = swri_realloc_audio(a, s->in_buffer_index + 2*s->in_buffer_count)) < 0)
372         return ret;
373     av_assert0(a->planar);
374     for(i=0; i<a->ch_count; i++){
375         for(j=0; j<s->in_buffer_count; j++){
376             memcpy(a->ch[i] + (s->in_buffer_index+s->in_buffer_count+j  )*a->bps,
377                 a->ch[i] + (s->in_buffer_index+s->in_buffer_count-j-1)*a->bps, a->bps);
378         }
379     }
380     s->in_buffer_count += (s->in_buffer_count+1)/2;
381     return 0;
382 }
383
384 // in fact the whole handle multiple ridiculously small buffers might need more thinking...
385 static int invert_initial_buffer(ResampleContext *c, AudioData *dst, const AudioData *src,
386                                  int in_count, int *out_idx, int *out_sz)
387 {
388     int n, ch, num = FFMIN(in_count + *out_sz, c->filter_length + 1), res;
389
390     if (c->index >= 0)
391         return 0;
392
393     if ((res = swri_realloc_audio(dst, c->filter_length * 2 + 1)) < 0)
394         return res;
395
396     // copy
397     for (n = *out_sz; n < num; n++) {
398         for (ch = 0; ch < src->ch_count; ch++) {
399             memcpy(dst->ch[ch] + ((c->filter_length + n) * c->felem_size),
400                    src->ch[ch] + ((n - *out_sz) * c->felem_size), c->felem_size);
401         }
402     }
403
404     // if not enough data is in, return and wait for more
405     if (num < c->filter_length + 1) {
406         *out_sz = num;
407         *out_idx = c->filter_length;
408         return INT_MAX;
409     }
410
411     // else invert
412     for (n = 1; n <= c->filter_length; n++) {
413         for (ch = 0; ch < src->ch_count; ch++) {
414             memcpy(dst->ch[ch] + ((c->filter_length - n) * c->felem_size),
415                    dst->ch[ch] + ((c->filter_length + n) * c->felem_size),
416                    c->felem_size);
417         }
418     }
419
420     res = num - *out_sz;
421     *out_idx = c->filter_length + (c->index >> c->phase_shift);
422     *out_sz = FFMAX(*out_sz + c->filter_length,
423                     1 + c->filter_length * 2) - *out_idx;
424     c->index &= c->phase_mask;
425
426     return FFMAX(res, 0);
427 }
428
429 struct Resampler const swri_resampler={
430   resample_init,
431   resample_free,
432   multiple_resample,
433   resample_flush,
434   set_compensation,
435   get_delay,
436   invert_initial_buffer,
437   get_out_samples,
438 };