mpeg4videoenc: ensure SAR is within the supported range
[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
33 typedef struct ResampleContext {
34     const AVClass *av_class;
35     uint8_t *filter_bank;
36     int filter_length;
37     int filter_alloc;
38     int ideal_dst_incr;
39     int dst_incr;
40     int index;
41     int frac;
42     int src_incr;
43     int compensation_distance;
44     int phase_shift;
45     int phase_mask;
46     int linear;
47     enum SwrFilterType filter_type;
48     int kaiser_beta;
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 filter_type  filter type
90  * @param kaiser_beta  kaiser window beta
91  * @return 0 on success, negative on error
92  */
93 static int build_filter(ResampleContext *c, void *filter, double factor, int tap_count, int alloc, int phase_count, int scale,
94                         int filter_type, int kaiser_beta){
95     int ph, i;
96     double x, y, w;
97     double *tab = av_malloc(tap_count * sizeof(*tab));
98     const int center= (tap_count-1)/2;
99
100     if (!tab)
101         return AVERROR(ENOMEM);
102
103     /* if upsampling, only need to interpolate, no filter */
104     if (factor > 1.0)
105         factor = 1.0;
106
107     for(ph=0;ph<phase_count;ph++) {
108         double norm = 0;
109         for(i=0;i<tap_count;i++) {
110             x = M_PI * ((double)(i - center) - (double)ph / phase_count) * factor;
111             if (x == 0) y = 1.0;
112             else        y = sin(x) / x;
113             switch(filter_type){
114             case SWR_FILTER_TYPE_CUBIC:{
115                 const float d= -0.5; //first order derivative = -0.5
116                 x = fabs(((double)(i - center) - (double)ph / phase_count) * factor);
117                 if(x<1.0) y= 1 - 3*x*x + 2*x*x*x + d*(            -x*x + x*x*x);
118                 else      y=                       d*(-4 + 8*x - 5*x*x + x*x*x);
119                 break;}
120             case SWR_FILTER_TYPE_BLACKMAN_NUTTALL:
121                 w = 2.0*x / (factor*tap_count) + M_PI;
122                 y *= 0.3635819 - 0.4891775 * cos(w) + 0.1365995 * cos(2*w) - 0.0106411 * cos(3*w);
123                 break;
124             case SWR_FILTER_TYPE_KAISER:
125                 w = 2.0*x / (factor*tap_count*M_PI);
126                 y *= bessel(kaiser_beta*sqrt(FFMAX(1-w*w, 0)));
127                 break;
128             default:
129                 av_assert0(0);
130             }
131
132             tab[i] = y;
133             norm += y;
134         }
135
136         /* normalize so that an uniform color remains the same */
137         switch(c->format){
138         case AV_SAMPLE_FMT_S16P:
139             for(i=0;i<tap_count;i++)
140                 ((int16_t*)filter)[ph * alloc + i] = av_clip(lrintf(tab[i] * scale / norm), INT16_MIN, INT16_MAX);
141             break;
142         case AV_SAMPLE_FMT_S32P:
143             for(i=0;i<tap_count;i++)
144                 ((int32_t*)filter)[ph * alloc + i] = av_clip(lrintf(tab[i] * scale / norm), INT32_MIN, INT32_MAX);
145             break;
146         case AV_SAMPLE_FMT_FLTP:
147             for(i=0;i<tap_count;i++)
148                 ((float*)filter)[ph * alloc + i] = tab[i] * scale / norm;
149             break;
150         case AV_SAMPLE_FMT_DBLP:
151             for(i=0;i<tap_count;i++)
152                 ((double*)filter)[ph * alloc + i] = tab[i] * scale / norm;
153             break;
154         }
155     }
156 #if 0
157     {
158 #define LEN 1024
159         int j,k;
160         double sine[LEN + tap_count];
161         double filtered[LEN];
162         double maxff=-2, minff=2, maxsf=-2, minsf=2;
163         for(i=0; i<LEN; i++){
164             double ss=0, sf=0, ff=0;
165             for(j=0; j<LEN+tap_count; j++)
166                 sine[j]= cos(i*j*M_PI/LEN);
167             for(j=0; j<LEN; j++){
168                 double sum=0;
169                 ph=0;
170                 for(k=0; k<tap_count; k++)
171                     sum += filter[ph * tap_count + k] * sine[k+j];
172                 filtered[j]= sum / (1<<FILTER_SHIFT);
173                 ss+= sine[j + center] * sine[j + center];
174                 ff+= filtered[j] * filtered[j];
175                 sf+= sine[j + center] * filtered[j];
176             }
177             ss= sqrt(2*ss/LEN);
178             ff= sqrt(2*ff/LEN);
179             sf= 2*sf/LEN;
180             maxff= FFMAX(maxff, ff);
181             minff= FFMIN(minff, ff);
182             maxsf= FFMAX(maxsf, sf);
183             minsf= FFMIN(minsf, sf);
184             if(i%11==0){
185                 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);
186                 minff=minsf= 2;
187                 maxff=maxsf= -2;
188             }
189         }
190     }
191 #endif
192
193     av_free(tab);
194     return 0;
195 }
196
197 ResampleContext *swri_resample_init(ResampleContext *c, int out_rate, int in_rate, int filter_size, int phase_shift, int linear,
198                                     double cutoff, enum AVSampleFormat format, enum SwrFilterType filter_type, int kaiser_beta){
199     double factor= FFMIN(out_rate * cutoff / in_rate, 1.0);
200     int phase_count= 1<<phase_shift;
201
202     if (!c || c->phase_shift != phase_shift || c->linear!=linear || c->factor != factor
203            || c->filter_length != FFMAX((int)ceil(filter_size/factor), 1) || c->format != format
204            || c->filter_type != filter_type || c->kaiser_beta != kaiser_beta) {
205         c = av_mallocz(sizeof(*c));
206         if (!c)
207             return NULL;
208
209         c->format= format;
210
211         c->felem_size= av_get_bytes_per_sample(c->format);
212
213         switch(c->format){
214         case AV_SAMPLE_FMT_S16P:
215             c->filter_shift = 15;
216             break;
217         case AV_SAMPLE_FMT_S32P:
218             c->filter_shift = 30;
219             break;
220         case AV_SAMPLE_FMT_FLTP:
221         case AV_SAMPLE_FMT_DBLP:
222             c->filter_shift = 0;
223             break;
224         default:
225             av_log(NULL, AV_LOG_ERROR, "Unsupported sample format\n");
226             return NULL;
227         }
228
229         c->phase_shift   = phase_shift;
230         c->phase_mask    = phase_count - 1;
231         c->linear        = linear;
232         c->factor        = factor;
233         c->filter_length = FFMAX((int)ceil(filter_size/factor), 1);
234         c->filter_alloc  = FFALIGN(c->filter_length, 8);
235         c->filter_bank   = av_mallocz(c->filter_alloc*(phase_count+1)*c->felem_size);
236         c->filter_type   = filter_type;
237         c->kaiser_beta   = kaiser_beta;
238         if (!c->filter_bank)
239             goto error;
240         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))
241             goto error;
242         memcpy(c->filter_bank + (c->filter_alloc*phase_count+1)*c->felem_size, c->filter_bank, (c->filter_alloc-1)*c->felem_size);
243         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);
244     }
245
246     c->compensation_distance= 0;
247     if(!av_reduce(&c->src_incr, &c->dst_incr, out_rate, in_rate * (int64_t)phase_count, INT32_MAX/2))
248         goto error;
249     c->ideal_dst_incr= c->dst_incr;
250
251     c->index= -phase_count*((c->filter_length-1)/2);
252     c->frac= 0;
253
254     return c;
255 error:
256     av_free(c->filter_bank);
257     av_free(c);
258     return NULL;
259 }
260
261 void swri_resample_free(ResampleContext **c){
262     if(!*c)
263         return;
264     av_freep(&(*c)->filter_bank);
265     av_freep(c);
266 }
267
268 int swr_set_compensation(struct SwrContext *s, int sample_delta, int compensation_distance){
269     ResampleContext *c;
270     int ret;
271
272     if (!s || compensation_distance < 0)
273         return AVERROR(EINVAL);
274     if (!compensation_distance && sample_delta)
275         return AVERROR(EINVAL);
276     if (!s->resample) {
277         s->flags |= SWR_FLAG_RESAMPLE;
278         ret = swr_init(s);
279         if (ret < 0)
280             return ret;
281     }
282     c= s->resample;
283     c->compensation_distance= compensation_distance;
284     if (compensation_distance)
285         c->dst_incr = c->ideal_dst_incr - c->ideal_dst_incr * (int64_t)sample_delta / compensation_distance;
286     else
287         c->dst_incr = c->ideal_dst_incr;
288     return 0;
289 }
290
291 #define RENAME(N) N ## _int16
292 #define FILTER_SHIFT 15
293 #define DELEM  int16_t
294 #define FELEM  int16_t
295 #define FELEM2 int32_t
296 #define FELEML int64_t
297 #define FELEM_MAX INT16_MAX
298 #define FELEM_MIN INT16_MIN
299 #define OUT(d, v) v = (v + (1<<(FILTER_SHIFT-1)))>>FILTER_SHIFT;\
300                   d = (unsigned)(v + 32768) > 65535 ? (v>>31) ^ 32767 : v
301 #include "resample_template.c"
302
303 #undef RENAME
304 #undef FELEM
305 #undef FELEM2
306 #undef DELEM
307 #undef FELEML
308 #undef OUT
309 #undef FELEM_MIN
310 #undef FELEM_MAX
311 #undef FILTER_SHIFT
312
313
314 #define RENAME(N) N ## _int32
315 #define FILTER_SHIFT 30
316 #define DELEM  int32_t
317 #define FELEM  int32_t
318 #define FELEM2 int64_t
319 #define FELEML int64_t
320 #define FELEM_MAX INT32_MAX
321 #define FELEM_MIN INT32_MIN
322 #define OUT(d, v) v = (v + (1<<(FILTER_SHIFT-1)))>>FILTER_SHIFT;\
323                   d = (uint64_t)(v + 0x80000000) > 0xFFFFFFFF ? (v>>63) ^ 0x7FFFFFFF : v
324 #include "resample_template.c"
325
326 #undef RENAME
327 #undef FELEM
328 #undef FELEM2
329 #undef DELEM
330 #undef FELEML
331 #undef OUT
332 #undef FELEM_MIN
333 #undef FELEM_MAX
334 #undef FILTER_SHIFT
335
336
337 #define RENAME(N) N ## _float
338 #define FILTER_SHIFT 0
339 #define DELEM  float
340 #define FELEM  float
341 #define FELEM2 float
342 #define FELEML float
343 #define OUT(d, v) d = v
344 #include "resample_template.c"
345
346 #undef RENAME
347 #undef FELEM
348 #undef FELEM2
349 #undef DELEM
350 #undef FELEML
351 #undef OUT
352 #undef FELEM_MIN
353 #undef FELEM_MAX
354 #undef FILTER_SHIFT
355
356
357 #define RENAME(N) N ## _double
358 #define FILTER_SHIFT 0
359 #define DELEM  double
360 #define FELEM  double
361 #define FELEM2 double
362 #define FELEML double
363 #define OUT(d, v) d = v
364 #include "resample_template.c"
365
366 #undef RENAME
367 #undef FELEM
368 #undef FELEM2
369 #undef DELEM
370 #undef FELEML
371 #undef OUT
372 #undef FELEM_MIN
373 #undef FELEM_MAX
374 #undef FILTER_SHIFT
375
376 // XXX FIXME the whole C loop should be written in asm so this x86 specific code here isnt needed
377 #if ARCH_X86
378 #include "x86/resample_mmx.h"
379 #define COMMON_CORE COMMON_CORE_INT16_MMX2
380 #define RENAME(N) N ## _int16_mmx2
381 #define FILTER_SHIFT 15
382 #define DELEM  int16_t
383 #define FELEM  int16_t
384 #define FELEM2 int32_t
385 #define FELEML int64_t
386 #define FELEM_MAX INT16_MAX
387 #define FELEM_MIN INT16_MIN
388 #define OUT(d, v) v = (v + (1<<(FILTER_SHIFT-1)))>>FILTER_SHIFT;\
389                   d = (unsigned)(v + 32768) > 65535 ? (v>>31) ^ 32767 : v
390 #include "resample_template.c"
391
392 #undef COMMON_CORE
393 #undef RENAME
394 #undef FELEM
395 #undef FELEM2
396 #undef DELEM
397 #undef FELEML
398 #undef OUT
399 #undef FELEM_MIN
400 #undef FELEM_MAX
401 #undef FILTER_SHIFT
402
403 #if HAVE_SSSE3
404 #define COMMON_CORE COMMON_CORE_INT16_SSSE3
405 #define RENAME(N) N ## _int16_ssse3
406 #define FILTER_SHIFT 15
407 #define DELEM  int16_t
408 #define FELEM  int16_t
409 #define FELEM2 int32_t
410 #define FELEML int64_t
411 #define FELEM_MAX INT16_MAX
412 #define FELEM_MIN INT16_MIN
413 #define OUT(d, v) v = (v + (1<<(FILTER_SHIFT-1)))>>FILTER_SHIFT;\
414                   d = (unsigned)(v + 32768) > 65535 ? (v>>31) ^ 32767 : v
415 #include "resample_template.c"
416 #endif
417 #endif // ARCH_X86
418
419 int swri_multiple_resample(ResampleContext *c, AudioData *dst, int dst_size, AudioData *src, int src_size, int *consumed){
420     int i, ret= -1;
421     int mm_flags = av_get_cpu_flags();
422     int need_emms= 0;
423
424     for(i=0; i<dst->ch_count; i++){
425 #if ARCH_X86
426 #if HAVE_SSSE3
427              if(c->format == AV_SAMPLE_FMT_S16P && (mm_flags&AV_CPU_FLAG_SSSE3)) ret= swri_resample_int16_ssse3(c, (int16_t*)dst->ch[i], (const int16_t*)src->ch[i], consumed, src_size, dst_size, i+1==dst->ch_count);
428         else
429 #endif
430              if(c->format == AV_SAMPLE_FMT_S16P && (mm_flags&AV_CPU_FLAG_MMX2 )){
431                  ret= swri_resample_int16_mmx2 (c, (int16_t*)dst->ch[i], (const int16_t*)src->ch[i], consumed, src_size, dst_size, i+1==dst->ch_count);
432                  need_emms= 1;
433              } else
434 #endif
435              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);
436         else 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);
437         else 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);
438         else 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);
439     }
440     if(need_emms)
441         emms_c();
442     return ret;
443 }
444
445 int64_t swr_get_delay(struct SwrContext *s, int64_t base){
446     ResampleContext *c = s->resample;
447     if(c){
448         int64_t num = s->in_buffer_count - (c->filter_length-1)/2;
449         num <<= c->phase_shift;
450         num -= c->index;
451         num *= c->src_incr;
452         num -= c->frac;
453
454         return av_rescale(num, base, s->in_sample_rate*(int64_t)c->src_incr << c->phase_shift);
455     }else{
456         return (s->in_buffer_count*base + (s->in_sample_rate>>1))/ s->in_sample_rate;
457     }
458 }