resample2: use av_assert()
[ffmpeg.git] / libavcodec / resample2.c
1 /*
2  * audio resampling
3  * Copyright (c) 2004 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 "avcodec.h"
30 #include "dsputil.h"
31
32 #ifndef CONFIG_RESAMPLE_HP
33 #define FILTER_SHIFT 15
34
35 #define FELEM int16_t
36 #define FELEM2 int32_t
37 #define FELEML int64_t
38 #define FELEM_MAX INT16_MAX
39 #define FELEM_MIN INT16_MIN
40 #define WINDOW_TYPE 9
41 #elif !defined(CONFIG_RESAMPLE_AUDIOPHILE_KIDDY_MODE)
42 #define FILTER_SHIFT 30
43
44 #define FELEM int32_t
45 #define FELEM2 int64_t
46 #define FELEML int64_t
47 #define FELEM_MAX INT32_MAX
48 #define FELEM_MIN INT32_MIN
49 #define WINDOW_TYPE 12
50 #else
51 #define FILTER_SHIFT 0
52
53 #define FELEM double
54 #define FELEM2 double
55 #define FELEML double
56 #define WINDOW_TYPE 24
57 #endif
58
59
60 typedef struct AVResampleContext{
61     const AVClass *av_class;
62     FELEM *filter_bank;
63     int filter_length;
64     int ideal_dst_incr;
65     int dst_incr;
66     int index;
67     int frac;
68     int src_incr;
69     int compensation_distance;
70     int phase_shift;
71     int phase_mask;
72     int linear;
73 }AVResampleContext;
74
75 /**
76  * 0th order modified bessel function of the first kind.
77  */
78 static double bessel(double x){
79     double v=1;
80     double lastv=0;
81     double t=1;
82     int i;
83
84     x= x*x/4;
85     for(i=1; v != lastv; i++){
86         lastv=v;
87         t *= x/(i*i);
88         v += t;
89     }
90     return v;
91 }
92
93 /**
94  * Build a polyphase filterbank.
95  * @param factor resampling factor
96  * @param scale wanted sum of coefficients for each filter
97  * @param type 0->cubic, 1->blackman nuttall windowed sinc, 2..16->kaiser windowed sinc beta=2..16
98  * @return 0 on success, negative on error
99  */
100 static int build_filter(FELEM *filter, double factor, int tap_count, int phase_count, int scale, int type){
101     int ph, i;
102     double x, y, w;
103     double *tab = av_malloc(tap_count * sizeof(*tab));
104     const int center= (tap_count-1)/2;
105
106     if (!tab)
107         return AVERROR(ENOMEM);
108
109     /* if upsampling, only need to interpolate, no filter */
110     if (factor > 1.0)
111         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(type){
120             case 0:{
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             case 1:
127                 w = 2.0*x / (factor*tap_count) + M_PI;
128                 y *= 0.3635819 - 0.4891775 * cos(w) + 0.1365995 * cos(2*w) - 0.0106411 * cos(3*w);
129                 break;
130             default:
131                 w = 2.0*x / (factor*tap_count*M_PI);
132                 y *= bessel(type*sqrt(FFMAX(1-w*w, 0)));
133                 break;
134             }
135
136             tab[i] = y;
137             norm += y;
138         }
139
140         /* normalize so that an uniform color remains the same */
141         for(i=0;i<tap_count;i++) {
142 #ifdef CONFIG_RESAMPLE_AUDIOPHILE_KIDDY_MODE
143             filter[ph * tap_count + i] = tab[i] / norm;
144 #else
145             filter[ph * tap_count + i] = av_clip(lrintf(tab[i] * scale / norm), FELEM_MIN, FELEM_MAX);
146 #endif
147         }
148     }
149 #if 0
150     {
151 #define LEN 1024
152         int j,k;
153         double sine[LEN + tap_count];
154         double filtered[LEN];
155         double maxff=-2, minff=2, maxsf=-2, minsf=2;
156         for(i=0; i<LEN; i++){
157             double ss=0, sf=0, ff=0;
158             for(j=0; j<LEN+tap_count; j++)
159                 sine[j]= cos(i*j*M_PI/LEN);
160             for(j=0; j<LEN; j++){
161                 double sum=0;
162                 ph=0;
163                 for(k=0; k<tap_count; k++)
164                     sum += filter[ph * tap_count + k] * sine[k+j];
165                 filtered[j]= sum / (1<<FILTER_SHIFT);
166                 ss+= sine[j + center] * sine[j + center];
167                 ff+= filtered[j] * filtered[j];
168                 sf+= sine[j + center] * filtered[j];
169             }
170             ss= sqrt(2*ss/LEN);
171             ff= sqrt(2*ff/LEN);
172             sf= 2*sf/LEN;
173             maxff= FFMAX(maxff, ff);
174             minff= FFMIN(minff, ff);
175             maxsf= FFMAX(maxsf, sf);
176             minsf= FFMIN(minsf, sf);
177             if(i%11==0){
178                 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);
179                 minff=minsf= 2;
180                 maxff=maxsf= -2;
181             }
182         }
183     }
184 #endif
185
186     av_free(tab);
187     return 0;
188 }
189
190 AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_size, int phase_shift, int linear, double cutoff){
191     AVResampleContext *c= av_mallocz(sizeof(AVResampleContext));
192     double factor= FFMIN(out_rate * cutoff / in_rate, 1.0);
193     int phase_count= 1<<phase_shift;
194
195     if (!c)
196         return NULL;
197
198     c->phase_shift= phase_shift;
199     c->phase_mask= phase_count-1;
200     c->linear= linear;
201
202     c->filter_length= FFMAX((int)ceil(filter_size/factor), 1);
203     c->filter_bank= av_mallocz(c->filter_length*(phase_count+1)*sizeof(FELEM));
204     if (!c->filter_bank)
205         goto error;
206     if (build_filter(c->filter_bank, factor, c->filter_length, phase_count, 1<<FILTER_SHIFT, WINDOW_TYPE))
207         goto error;
208     memcpy(&c->filter_bank[c->filter_length*phase_count+1], c->filter_bank, (c->filter_length-1)*sizeof(FELEM));
209     c->filter_bank[c->filter_length*phase_count]= c->filter_bank[c->filter_length - 1];
210
211     if(!av_reduce(&c->src_incr, &c->dst_incr, out_rate, in_rate * (int64_t)phase_count, INT32_MAX/2))
212         goto error;
213     c->ideal_dst_incr= c->dst_incr;
214
215     c->index= -phase_count*((c->filter_length-1)/2);
216
217     return c;
218 error:
219     av_free(c->filter_bank);
220     av_free(c);
221     return NULL;
222 }
223
224 void av_resample_close(AVResampleContext *c){
225     av_freep(&c->filter_bank);
226     av_freep(&c);
227 }
228
229 void av_resample_compensate(AVResampleContext *c, int sample_delta, int compensation_distance){
230 //    sample_delta += (c->ideal_dst_incr - c->dst_incr)*(int64_t)c->compensation_distance / c->ideal_dst_incr;
231     c->compensation_distance= compensation_distance;
232     c->dst_incr = c->ideal_dst_incr - c->ideal_dst_incr * (int64_t)sample_delta / compensation_distance;
233 }
234
235 int av_resample(AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx){
236     int dst_index, i;
237     int index= c->index;
238     int frac= c->frac;
239     int dst_incr_frac= c->dst_incr % c->src_incr;
240     int dst_incr=      c->dst_incr / c->src_incr;
241     int compensation_distance= c->compensation_distance;
242
243   if(compensation_distance == 0 && c->filter_length == 1 && c->phase_shift==0){
244         int64_t index2= ((int64_t)index)<<32;
245         int64_t incr= (1LL<<32) * c->dst_incr / c->src_incr;
246         dst_size= FFMIN(dst_size, (src_size-1-index) * (int64_t)c->src_incr / c->dst_incr);
247
248         for(dst_index=0; dst_index < dst_size; dst_index++){
249             dst[dst_index] = src[index2>>32];
250             index2 += incr;
251         }
252         index += dst_index * dst_incr;
253         index += (frac + dst_index * (int64_t)dst_incr_frac) / c->src_incr;
254         frac   = (frac + dst_index * (int64_t)dst_incr_frac) % c->src_incr;
255   }else{
256     for(dst_index=0; dst_index < dst_size; dst_index++){
257         FELEM *filter= c->filter_bank + c->filter_length*(index & c->phase_mask);
258         int sample_index= index >> c->phase_shift;
259         FELEM2 val=0;
260
261         if(sample_index < 0){
262             for(i=0; i<c->filter_length; i++)
263                 val += src[FFABS(sample_index + i) % src_size] * filter[i];
264         }else if(sample_index + c->filter_length > src_size){
265             break;
266         }else if(c->linear){
267             FELEM2 v2=0;
268             for(i=0; i<c->filter_length; i++){
269                 val += src[sample_index + i] * (FELEM2)filter[i];
270                 v2  += src[sample_index + i] * (FELEM2)filter[i + c->filter_length];
271             }
272             val+=(v2-val)*(FELEML)frac / c->src_incr;
273         }else{
274             for(i=0; i<c->filter_length; i++){
275                 val += src[sample_index + i] * (FELEM2)filter[i];
276             }
277         }
278
279 #ifdef CONFIG_RESAMPLE_AUDIOPHILE_KIDDY_MODE
280         dst[dst_index] = av_clip_int16(lrintf(val));
281 #else
282         val = (val + (1<<(FILTER_SHIFT-1)))>>FILTER_SHIFT;
283         dst[dst_index] = (unsigned)(val + 32768) > 65535 ? (val>>31) ^ 32767 : val;
284 #endif
285
286         frac += dst_incr_frac;
287         index += dst_incr;
288         if(frac >= c->src_incr){
289             frac -= c->src_incr;
290             index++;
291         }
292
293         if(dst_index + 1 == compensation_distance){
294             compensation_distance= 0;
295             dst_incr_frac= c->ideal_dst_incr % c->src_incr;
296             dst_incr=      c->ideal_dst_incr / c->src_incr;
297         }
298     }
299   }
300     *consumed= FFMAX(index, 0) >> c->phase_shift;
301     if(index>=0) index &= c->phase_mask;
302
303     if(compensation_distance){
304         compensation_distance -= dst_index;
305         av_assert2(compensation_distance > 0);
306     }
307     if(update_ctx){
308         c->frac= frac;
309         c->index= index;
310         c->dst_incr= dst_incr_frac + c->src_incr*dst_incr;
311         c->compensation_distance= compensation_distance;
312     }
313 #if 0
314     if(update_ctx && !c->compensation_distance){
315 #undef rand
316         av_resample_compensate(c, rand() % (8000*2) - 8000, 8000*2);
317 av_log(NULL, AV_LOG_DEBUG, "%d %d %d\n", c->dst_incr, c->ideal_dst_incr, c->compensation_distance);
318     }
319 #endif
320
321     return dst_index;
322 }