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