swr: change sample format representation so as to maintain the planer/packed distinction.
[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/log.h"
29 #include "libavutil/avassert.h"
30 #include "swresample_internal.h"
31
32 #define WINDOW_TYPE 9
33
34
35
36 typedef struct ResampleContext {
37     const AVClass *av_class;
38     uint8_t *filter_bank;
39     int filter_length;
40     int ideal_dst_incr;
41     int dst_incr;
42     int index;
43     int frac;
44     int src_incr;
45     int compensation_distance;
46     int phase_shift;
47     int phase_mask;
48     int linear;
49     double factor;
50     enum AVSampleFormat format;
51     int felem_size;
52     int filter_shift;
53 } ResampleContext;
54
55 /**
56  * 0th order modified bessel function of the first kind.
57  */
58 static double bessel(double x){
59     double v=1;
60     double lastv=0;
61     double t=1;
62     int i;
63     static const double inv[100]={
64  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),
65  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),
66  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),
67  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),
68  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),
69  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),
70  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),
71  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),
72  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),
73  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)
74     };
75
76     x= x*x/4;
77     for(i=0; v != lastv; i++){
78         lastv=v;
79         t *= x*inv[i];
80         v += t;
81     }
82     return v;
83 }
84
85 /**
86  * builds a polyphase filterbank.
87  * @param factor resampling factor
88  * @param scale wanted sum of coefficients for each filter
89  * @param type 0->cubic, 1->blackman nuttall windowed sinc, 2..16->kaiser windowed sinc beta=2..16
90  * @return 0 on success, negative on error
91  */
92 static int build_filter(ResampleContext *c, void *filter, double factor, int tap_count, int phase_count, int scale, int type){
93     int ph, i;
94     double x, y, w;
95     double *tab = av_malloc(tap_count * sizeof(*tab));
96     const int center= (tap_count-1)/2;
97
98     if (!tab)
99         return AVERROR(ENOMEM);
100
101     /* if upsampling, only need to interpolate, no filter */
102     if (factor > 1.0)
103         factor = 1.0;
104
105     for(ph=0;ph<phase_count;ph++) {
106         double norm = 0;
107         for(i=0;i<tap_count;i++) {
108             x = M_PI * ((double)(i - center) - (double)ph / phase_count) * factor;
109             if (x == 0) y = 1.0;
110             else        y = sin(x) / x;
111             switch(type){
112             case 0:{
113                 const float d= -0.5; //first order derivative = -0.5
114                 x = fabs(((double)(i - center) - (double)ph / phase_count) * factor);
115                 if(x<1.0) y= 1 - 3*x*x + 2*x*x*x + d*(            -x*x + x*x*x);
116                 else      y=                       d*(-4 + 8*x - 5*x*x + x*x*x);
117                 break;}
118             case 1:
119                 w = 2.0*x / (factor*tap_count) + M_PI;
120                 y *= 0.3635819 - 0.4891775 * cos(w) + 0.1365995 * cos(2*w) - 0.0106411 * cos(3*w);
121                 break;
122             default:
123                 w = 2.0*x / (factor*tap_count*M_PI);
124                 y *= bessel(type*sqrt(FFMAX(1-w*w, 0)));
125                 break;
126             }
127
128             tab[i] = y;
129             norm += y;
130         }
131
132         /* normalize so that an uniform color remains the same */
133         switch(c->format){
134         case AV_SAMPLE_FMT_S16P:
135             for(i=0;i<tap_count;i++)
136                 ((int16_t*)filter)[ph * tap_count + i] = av_clip(lrintf(tab[i] * scale / norm), INT16_MIN, INT16_MAX);
137             break;
138         case AV_SAMPLE_FMT_S32P:
139             for(i=0;i<tap_count;i++)
140                 ((int32_t*)filter)[ph * tap_count + i] = av_clip(lrintf(tab[i] * scale / norm), INT32_MIN, INT32_MAX);
141             break;
142         case AV_SAMPLE_FMT_FLTP:
143             for(i=0;i<tap_count;i++)
144                 ((float*)filter)[ph * tap_count + i] = tab[i] * scale / norm;
145             break;
146         case AV_SAMPLE_FMT_DBLP:
147             for(i=0;i<tap_count;i++)
148                 ((double*)filter)[ph * tap_count + i] = tab[i] * scale / norm;
149             break;
150         }
151     }
152 #if 0
153     {
154 #define LEN 1024
155         int j,k;
156         double sine[LEN + tap_count];
157         double filtered[LEN];
158         double maxff=-2, minff=2, maxsf=-2, minsf=2;
159         for(i=0; i<LEN; i++){
160             double ss=0, sf=0, ff=0;
161             for(j=0; j<LEN+tap_count; j++)
162                 sine[j]= cos(i*j*M_PI/LEN);
163             for(j=0; j<LEN; j++){
164                 double sum=0;
165                 ph=0;
166                 for(k=0; k<tap_count; k++)
167                     sum += filter[ph * tap_count + k] * sine[k+j];
168                 filtered[j]= sum / (1<<FILTER_SHIFT);
169                 ss+= sine[j + center] * sine[j + center];
170                 ff+= filtered[j] * filtered[j];
171                 sf+= sine[j + center] * filtered[j];
172             }
173             ss= sqrt(2*ss/LEN);
174             ff= sqrt(2*ff/LEN);
175             sf= 2*sf/LEN;
176             maxff= FFMAX(maxff, ff);
177             minff= FFMIN(minff, ff);
178             maxsf= FFMAX(maxsf, sf);
179             minsf= FFMIN(minsf, sf);
180             if(i%11==0){
181                 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);
182                 minff=minsf= 2;
183                 maxff=maxsf= -2;
184             }
185         }
186     }
187 #endif
188
189     av_free(tab);
190     return 0;
191 }
192
193 ResampleContext *swri_resample_init(ResampleContext *c, int out_rate, int in_rate, int filter_size, int phase_shift, int linear, double cutoff, enum AVSampleFormat format){
194     double factor= FFMIN(out_rate * cutoff / in_rate, 1.0);
195     int phase_count= 1<<phase_shift;
196
197     if (!c || c->phase_shift != phase_shift || c->linear!=linear || c->factor != factor
198            || c->filter_length != FFMAX((int)ceil(filter_size/factor), 1) || c->format != format) {
199         c = av_mallocz(sizeof(*c));
200         if (!c)
201             return NULL;
202
203         c->format= format;
204
205         c->felem_size= av_get_bytes_per_sample(c->format);
206
207         switch(c->format){
208         case AV_SAMPLE_FMT_S16P:
209             c->filter_shift = 15;
210             break;
211         case AV_SAMPLE_FMT_S32P:
212             c->filter_shift = 30;
213             break;
214         case AV_SAMPLE_FMT_FLTP:
215         case AV_SAMPLE_FMT_DBLP:
216             c->filter_shift = 0;
217             break;
218         default:
219             av_log(NULL, AV_LOG_ERROR, "Unsupported sample format\n");
220             return NULL;
221         }
222
223         c->phase_shift   = phase_shift;
224         c->phase_mask    = phase_count - 1;
225         c->linear        = linear;
226         c->factor        = factor;
227         c->filter_length = FFMAX((int)ceil(filter_size/factor), 1);
228         c->filter_bank   = av_mallocz(c->filter_length*(phase_count+1)*c->felem_size);
229         if (!c->filter_bank)
230             goto error;
231         if (build_filter(c, (void*)c->filter_bank, factor, c->filter_length, phase_count, 1<<c->filter_shift, WINDOW_TYPE))
232             goto error;
233         memcpy(c->filter_bank + (c->filter_length*phase_count+1)*c->felem_size, c->filter_bank, (c->filter_length-1)*c->felem_size);
234         memcpy(c->filter_bank + (c->filter_length*phase_count  )*c->felem_size, c->filter_bank + (c->filter_length - 1)*c->felem_size, c->felem_size);
235     }
236
237     c->compensation_distance= 0;
238     if(!av_reduce(&c->src_incr, &c->dst_incr, out_rate, in_rate * (int64_t)phase_count, INT32_MAX/2))
239         goto error;
240     c->ideal_dst_incr= c->dst_incr;
241
242     c->index= -phase_count*((c->filter_length-1)/2);
243     c->frac= 0;
244
245     return c;
246 error:
247     av_free(c->filter_bank);
248     av_free(c);
249     return NULL;
250 }
251
252 void swri_resample_free(ResampleContext **c){
253     if(!*c)
254         return;
255     av_freep(&(*c)->filter_bank);
256     av_freep(c);
257 }
258
259 int swr_set_compensation(struct SwrContext *s, int sample_delta, int compensation_distance){
260     ResampleContext *c;
261     int ret;
262
263     if (!s || compensation_distance < 0)
264         return AVERROR(EINVAL);
265     if (!compensation_distance && sample_delta)
266         return AVERROR(EINVAL);
267     if (!s->resample) {
268         s->flags |= SWR_FLAG_RESAMPLE;
269         ret = swr_init(s);
270         if (ret < 0)
271             return ret;
272     }
273     c= s->resample;
274     c->compensation_distance= compensation_distance;
275     if (compensation_distance)
276         c->dst_incr = c->ideal_dst_incr - c->ideal_dst_incr * (int64_t)sample_delta / compensation_distance;
277     else
278         c->dst_incr = c->ideal_dst_incr;
279     return 0;
280 }
281
282 #define RENAME(N) N ## _int16
283 #define FILTER_SHIFT 15
284 #define DELEM  int16_t
285 #define FELEM  int16_t
286 #define FELEM2 int32_t
287 #define FELEML int64_t
288 #define FELEM_MAX INT16_MAX
289 #define FELEM_MIN INT16_MIN
290 #define OUT(d, v) v = (v + (1<<(FILTER_SHIFT-1)))>>FILTER_SHIFT;\
291                   d = (unsigned)(v + 32768) > 65535 ? (v>>31) ^ 32767 : v
292 #include "resample_template.c"
293
294 #undef RENAME
295 #undef FELEM
296 #undef FELEM2
297 #undef DELEM
298 #undef FELEML
299 #undef OUT
300 #undef FELEM_MIN
301 #undef FELEM_MAX
302 #undef FILTER_SHIFT
303
304
305 #define RENAME(N) N ## _int32
306 #define FILTER_SHIFT 30
307 #define DELEM  int32_t
308 #define FELEM  int32_t
309 #define FELEM2 int64_t
310 #define FELEML int64_t
311 #define FELEM_MAX INT32_MAX
312 #define FELEM_MIN INT32_MIN
313 #define OUT(d, v) v = (v + (1<<(FILTER_SHIFT-1)))>>FILTER_SHIFT;\
314                   d = (uint64_t)(v + 0x80000000) > 0xFFFFFFFF ? (v>>63) ^ 0x7FFFFFFF : v
315 #include "resample_template.c"
316
317 #undef RENAME
318 #undef FELEM
319 #undef FELEM2
320 #undef DELEM
321 #undef FELEML
322 #undef OUT
323 #undef FELEM_MIN
324 #undef FELEM_MAX
325 #undef FILTER_SHIFT
326
327
328 #define RENAME(N) N ## _float
329 #define FILTER_SHIFT 0
330 #define DELEM  float
331 #define FELEM  float
332 #define FELEM2 float
333 #define FELEML float
334 #define OUT(d, v) d = v
335 #include "resample_template.c"
336
337 #undef RENAME
338 #undef FELEM
339 #undef FELEM2
340 #undef DELEM
341 #undef FELEML
342 #undef OUT
343 #undef FELEM_MIN
344 #undef FELEM_MAX
345 #undef FILTER_SHIFT
346
347
348 #define RENAME(N) N ## _double
349 #define FILTER_SHIFT 0
350 #define DELEM  double
351 #define FELEM  double
352 #define FELEM2 double
353 #define FELEML double
354 #define OUT(d, v) d = v
355 #include "resample_template.c"
356
357
358 int swri_multiple_resample(ResampleContext *c, AudioData *dst, int dst_size, AudioData *src, int src_size, int *consumed){
359     int i, ret= -1;
360
361     for(i=0; i<dst->ch_count; i++){
362         if(c->format == AV_SAMPLE_FMT_S16P) ret= swri_resample_int16(c, (int16_t*)dst->ch[i], (const int16_t*)src->ch[i], consumed, src_size, dst_size, i+1==dst->ch_count);
363         if(c->format == AV_SAMPLE_FMT_S32P) ret= swri_resample_int32(c, (int32_t*)dst->ch[i], (const int32_t*)src->ch[i], consumed, src_size, dst_size, i+1==dst->ch_count);
364         if(c->format == AV_SAMPLE_FMT_FLTP) ret= swri_resample_float(c, (float  *)dst->ch[i], (const float  *)src->ch[i], consumed, src_size, dst_size, i+1==dst->ch_count);
365         if(c->format == AV_SAMPLE_FMT_DBLP) ret= swri_resample_double(c,(double *)dst->ch[i], (const double *)src->ch[i], consumed, src_size, dst_size, i+1==dst->ch_count);
366     }
367
368     return ret;
369 }