cosmetics: fix some typos
[ffmpeg.git] / libswresample / swresample.c
1 /*
2  * Copyright (C) 2011 Michael Niedermayer (michaelni@gmx.at)
3  *
4  * This file is part of libswresample
5  *
6  * libswresample is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * libswresample is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with libswresample; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #include "libavutil/opt.h"
22 #include "swresample_internal.h"
23 #include "audioconvert.h"
24 #include "libavutil/avassert.h"
25 #include "libavutil/audioconvert.h"
26
27 #define  C30DB  M_SQRT2
28 #define  C15DB  1.189207115
29 #define C__0DB  1.0
30 #define C_15DB  0.840896415
31 #define C_30DB  M_SQRT1_2
32 #define C_45DB  0.594603558
33 #define C_60DB  0.5
34
35
36 //TODO split options array out?
37 #define OFFSET(x) offsetof(SwrContext,x)
38 static const AVOption options[]={
39 {"ich",  "input channel count", OFFSET( in.ch_count   ), AV_OPT_TYPE_INT, {.dbl=2}, 0, SWR_CH_MAX, 0},
40 {"och", "output channel count", OFFSET(out.ch_count   ), AV_OPT_TYPE_INT, {.dbl=2}, 0, SWR_CH_MAX, 0},
41 {"uch",   "used channel count", OFFSET(used_ch_count  ), AV_OPT_TYPE_INT, {.dbl=0}, 0, SWR_CH_MAX, 0},
42 {"isr",  "input sample rate"  , OFFSET( in_sample_rate), AV_OPT_TYPE_INT, {.dbl=48000}, 1, INT_MAX, 0},
43 {"osr", "output sample rate"  , OFFSET(out_sample_rate), AV_OPT_TYPE_INT, {.dbl=48000}, 1, INT_MAX, 0},
44 //{"ip" ,  "input planar"       , OFFSET( in.planar     ), AV_OPT_TYPE_INT, {.dbl=0},    0,       1, 0},
45 //{"op" , "output planar"       , OFFSET(out.planar     ), AV_OPT_TYPE_INT, {.dbl=0},    0,       1, 0},
46 {"isf",  "input sample format", OFFSET( in_sample_fmt ), AV_OPT_TYPE_INT, {.dbl=AV_SAMPLE_FMT_S16}, 0, AV_SAMPLE_FMT_NB-1+256, 0},
47 {"osf", "output sample format", OFFSET(out_sample_fmt ), AV_OPT_TYPE_INT, {.dbl=AV_SAMPLE_FMT_S16}, 0, AV_SAMPLE_FMT_NB-1+256, 0},
48 {"tsf", "internal sample format", OFFSET(int_sample_fmt ), AV_OPT_TYPE_INT, {.dbl=AV_SAMPLE_FMT_NONE}, -1, AV_SAMPLE_FMT_FLT, 0},
49 {"icl",  "input channel layout" , OFFSET( in_ch_layout), AV_OPT_TYPE_INT64, {.dbl=0}, 0, INT64_MAX, 0, "channel_layout"},
50 {"ocl",  "output channel layout", OFFSET(out_ch_layout), AV_OPT_TYPE_INT64, {.dbl=0}, 0, INT64_MAX, 0, "channel_layout"},
51 {"clev", "center mix level"     , OFFSET(clev)         , AV_OPT_TYPE_FLOAT, {.dbl=C_30DB}, 0, 4, 0},
52 {"slev", "sourround mix level"  , OFFSET(slev)         , AV_OPT_TYPE_FLOAT, {.dbl=C_30DB}, 0, 4, 0},
53 {"rmvol", "rematrix volume"     , OFFSET(rematrix_volume), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, -1000, 1000, 0},
54 {"flags", NULL                  , OFFSET(flags)        , AV_OPT_TYPE_FLAGS, {.dbl=0}, 0,  UINT_MAX, 0, "flags"},
55 {"res", "force resampling", 0, AV_OPT_TYPE_CONST, {.dbl=SWR_FLAG_RESAMPLE}, INT_MIN, INT_MAX, 0, "flags"},
56
57 {0}
58 };
59
60 static const char* context_to_name(void* ptr) {
61     return "SWR";
62 }
63
64 static const AVClass av_class = {
65     .class_name                = "SwrContext",
66     .item_name                 = context_to_name,
67     .option                    = options,
68     .version                   = LIBAVUTIL_VERSION_INT,
69     .log_level_offset_offset   = OFFSET(log_level_offset),
70     .parent_log_context_offset = OFFSET(log_ctx),
71 };
72
73 unsigned swresample_version(void)
74 {
75     av_assert0(LIBSWRESAMPLE_VERSION_MICRO >= 100);
76     return LIBSWRESAMPLE_VERSION_INT;
77 }
78
79 const char *swresample_configuration(void)
80 {
81     return FFMPEG_CONFIGURATION;
82 }
83
84 const char *swresample_license(void)
85 {
86 #define LICENSE_PREFIX "libswresample license: "
87     return LICENSE_PREFIX FFMPEG_LICENSE + sizeof(LICENSE_PREFIX) - 1;
88 }
89
90 int swr_set_channel_mapping(struct SwrContext *s, const int *channel_map){
91     if(!s || s->in_convert) // s needs to be allocated but not initialized
92         return AVERROR(EINVAL);
93     s->channel_map = channel_map;
94     return 0;
95 }
96
97 struct SwrContext *swr_alloc(void){
98     SwrContext *s= av_mallocz(sizeof(SwrContext));
99     if(s){
100         s->av_class= &av_class;
101         av_opt_set_defaults(s);
102     }
103     return s;
104 }
105
106 struct SwrContext *swr_alloc_set_opts(struct SwrContext *s,
107                                       int64_t out_ch_layout, enum AVSampleFormat out_sample_fmt, int out_sample_rate,
108                                       int64_t  in_ch_layout, enum AVSampleFormat  in_sample_fmt, int  in_sample_rate,
109                                       int log_offset, void *log_ctx){
110     if(!s) s= swr_alloc();
111     if(!s) return NULL;
112
113     s->log_level_offset= log_offset;
114     s->log_ctx= log_ctx;
115
116     av_opt_set_int(s, "ocl", out_ch_layout,   0);
117     av_opt_set_int(s, "osf", out_sample_fmt,  0);
118     av_opt_set_int(s, "osr", out_sample_rate, 0);
119     av_opt_set_int(s, "icl", in_ch_layout,    0);
120     av_opt_set_int(s, "isf", in_sample_fmt,   0);
121     av_opt_set_int(s, "isr", in_sample_rate,  0);
122     av_opt_set_int(s, "tsf", AV_SAMPLE_FMT_S16, 0);
123     av_opt_set_int(s, "ich", av_get_channel_layout_nb_channels(s-> in_ch_layout), 0);
124     av_opt_set_int(s, "och", av_get_channel_layout_nb_channels(s->out_ch_layout), 0);
125     av_opt_set_int(s, "uch", 0, 0);
126     return s;
127 }
128
129
130 static void free_temp(AudioData *a){
131     av_free(a->data);
132     memset(a, 0, sizeof(*a));
133 }
134
135 void swr_free(SwrContext **ss){
136     SwrContext *s= *ss;
137     if(s){
138         free_temp(&s->postin);
139         free_temp(&s->midbuf);
140         free_temp(&s->preout);
141         free_temp(&s->in_buffer);
142         swri_audio_convert_free(&s-> in_convert);
143         swri_audio_convert_free(&s->out_convert);
144         swri_audio_convert_free(&s->full_convert);
145         swri_resample_free(&s->resample);
146     }
147
148     av_freep(ss);
149 }
150
151 int swr_init(struct SwrContext *s){
152     s->in_buffer_index= 0;
153     s->in_buffer_count= 0;
154     s->resample_in_constraint= 0;
155     free_temp(&s->postin);
156     free_temp(&s->midbuf);
157     free_temp(&s->preout);
158     free_temp(&s->in_buffer);
159     swri_audio_convert_free(&s-> in_convert);
160     swri_audio_convert_free(&s->out_convert);
161     swri_audio_convert_free(&s->full_convert);
162
163     s-> in.planar= av_sample_fmt_is_planar(s-> in_sample_fmt);
164     s->out.planar= av_sample_fmt_is_planar(s->out_sample_fmt);
165     s-> in_sample_fmt= av_get_alt_sample_fmt(s-> in_sample_fmt, 0);
166     s->out_sample_fmt= av_get_alt_sample_fmt(s->out_sample_fmt, 0);
167
168     if(s-> in_sample_fmt >= AV_SAMPLE_FMT_NB){
169         av_log(s, AV_LOG_ERROR, "Requested input sample format %d is invalid\n", s->in_sample_fmt);
170         return AVERROR(EINVAL);
171     }
172     if(s->out_sample_fmt >= AV_SAMPLE_FMT_NB){
173         av_log(s, AV_LOG_ERROR, "Requested output sample format %d is invalid\n", s->out_sample_fmt);
174         return AVERROR(EINVAL);
175     }
176
177     if(   s->int_sample_fmt != AV_SAMPLE_FMT_S16
178         &&s->int_sample_fmt != AV_SAMPLE_FMT_FLT){
179         av_log(s, AV_LOG_ERROR, "Requested sample format %s is not supported internally, only float & S16 is supported\n", av_get_sample_fmt_name(s->int_sample_fmt));
180         return AVERROR(EINVAL);
181     }
182
183     //FIXME should we allow/support using FLT on material that doesnt need it ?
184     if(s->in_sample_fmt <= AV_SAMPLE_FMT_S16 || s->int_sample_fmt==AV_SAMPLE_FMT_S16){
185         s->int_sample_fmt= AV_SAMPLE_FMT_S16;
186     }else
187         s->int_sample_fmt= AV_SAMPLE_FMT_FLT;
188
189
190     if (s->out_sample_rate!=s->in_sample_rate || (s->flags & SWR_FLAG_RESAMPLE)){
191         s->resample = swri_resample_init(s->resample, s->out_sample_rate, s->in_sample_rate, 16, 10, 0, 0.8);
192     }else
193         swri_resample_free(&s->resample);
194     if(s->int_sample_fmt != AV_SAMPLE_FMT_S16 && s->resample){
195         av_log(s, AV_LOG_ERROR, "Resampling only supported with internal s16 currently\n"); //FIXME
196         return -1;
197     }
198
199     if(!s->used_ch_count)
200         s->used_ch_count= s->in.ch_count;
201
202     if(s->used_ch_count && s-> in_ch_layout && s->used_ch_count != av_get_channel_layout_nb_channels(s-> in_ch_layout)){
203         av_log(s, AV_LOG_WARNING, "Input channel layout has a different number of channels than the number of used channels, ignoring layout\n");
204         s-> in_ch_layout= 0;
205     }
206
207     if(!s-> in_ch_layout)
208         s-> in_ch_layout= av_get_default_channel_layout(s->used_ch_count);
209     if(!s->out_ch_layout)
210         s->out_ch_layout= av_get_default_channel_layout(s->out.ch_count);
211
212     s->rematrix= s->out_ch_layout  !=s->in_ch_layout || s->rematrix_volume!=1.0 ||
213                  s->rematrix_custom;
214
215 #define RSC 1 //FIXME finetune
216     if(!s-> in.ch_count)
217         s-> in.ch_count= av_get_channel_layout_nb_channels(s-> in_ch_layout);
218     if(!s->used_ch_count)
219         s->used_ch_count= s->in.ch_count;
220     if(!s->out.ch_count)
221         s->out.ch_count= av_get_channel_layout_nb_channels(s->out_ch_layout);
222
223     if(!s-> in.ch_count){
224         av_assert0(!s->in_ch_layout);
225         av_log(s, AV_LOG_ERROR, "Input channel count and layout are unset\n");
226         return -1;
227     }
228
229 av_assert0(s->used_ch_count);
230 av_assert0(s->out.ch_count);
231     s->resample_first= RSC*s->out.ch_count/s->in.ch_count - RSC < s->out_sample_rate/(float)s-> in_sample_rate - 1.0;
232
233     s-> in.bps= av_get_bytes_per_sample(s-> in_sample_fmt);
234     s->int_bps= av_get_bytes_per_sample(s->int_sample_fmt);
235     s->out.bps= av_get_bytes_per_sample(s->out_sample_fmt);
236
237     if(!s->resample && !s->rematrix && !s->channel_map){
238         s->full_convert = swri_audio_convert_alloc(s->out_sample_fmt,
239                                                    s-> in_sample_fmt, s-> in.ch_count, NULL, 0);
240         return 0;
241     }
242
243     s->in_convert = swri_audio_convert_alloc(s->int_sample_fmt,
244                                              s-> in_sample_fmt, s->used_ch_count, s->channel_map, 0);
245     s->out_convert= swri_audio_convert_alloc(s->out_sample_fmt,
246                                              s->int_sample_fmt, s->out.ch_count, NULL, 0);
247
248
249     s->postin= s->in;
250     s->preout= s->out;
251     s->midbuf= s->in;
252     s->in_buffer= s->in;
253     if(s->channel_map){
254         s->postin.ch_count=
255         s->midbuf.ch_count=
256         s->in_buffer.ch_count= s->used_ch_count;
257     }
258     if(!s->resample_first){
259         s->midbuf.ch_count= s->out.ch_count;
260         s->in_buffer.ch_count = s->out.ch_count;
261     }
262
263     s->in_buffer.bps = s->postin.bps = s->midbuf.bps = s->preout.bps =  s->int_bps;
264     s->in_buffer.planar = s->postin.planar = s->midbuf.planar = s->preout.planar =  1;
265
266
267     if(s->rematrix)
268         return swri_rematrix_init(s);
269
270     return 0;
271 }
272
273 static int realloc_audio(AudioData *a, int count){
274     int i, countb;
275     AudioData old;
276
277     if(a->count >= count)
278         return 0;
279
280     count*=2;
281
282     countb= FFALIGN(count*a->bps, 32);
283     old= *a;
284
285     av_assert0(a->planar);
286     av_assert0(a->bps);
287     av_assert0(a->ch_count);
288
289     a->data= av_malloc(countb*a->ch_count);
290     if(!a->data)
291         return AVERROR(ENOMEM);
292     for(i=0; i<a->ch_count; i++){
293         a->ch[i]= a->data + i*(a->planar ? countb : a->bps);
294         if(a->planar) memcpy(a->ch[i], old.ch[i], a->count*a->bps);
295     }
296     av_free(old.data);
297     a->count= count;
298
299     return 1;
300 }
301
302 static void copy(AudioData *out, AudioData *in,
303                  int count){
304     av_assert0(out->planar == in->planar);
305     av_assert0(out->bps == in->bps);
306     av_assert0(out->ch_count == in->ch_count);
307     if(out->planar){
308         int ch;
309         for(ch=0; ch<out->ch_count; ch++)
310             memcpy(out->ch[ch], in->ch[ch], count*out->bps);
311     }else
312         memcpy(out->ch[0], in->ch[0], count*out->ch_count*out->bps);
313 }
314
315 static void fill_audiodata(AudioData *out, uint8_t *in_arg [SWR_CH_MAX]){
316     int i;
317     if(out->planar){
318         for(i=0; i<out->ch_count; i++)
319             out->ch[i]= in_arg[i];
320     }else{
321         for(i=0; i<out->ch_count; i++)
322             out->ch[i]= in_arg[0] + i*out->bps;
323     }
324 }
325
326 /**
327  *
328  * out may be equal in.
329  */
330 static void buf_set(AudioData *out, AudioData *in, int count){
331     if(in->planar){
332         int ch;
333         for(ch=0; ch<out->ch_count; ch++)
334             out->ch[ch]= in->ch[ch] + count*out->bps;
335     }else
336         out->ch[0]= in->ch[0] + count*out->ch_count*out->bps;
337 }
338
339 /**
340  *
341  * @return number of samples output per channel
342  */
343 static int resample(SwrContext *s, AudioData *out_param, int out_count,
344                              const AudioData * in_param, int in_count){
345     AudioData in, out, tmp;
346     int ret_sum=0;
347     int border=0;
348
349     tmp=out=*out_param;
350     in =  *in_param;
351
352     do{
353         int ret, size, consumed;
354         if(!s->resample_in_constraint && s->in_buffer_count){
355             buf_set(&tmp, &s->in_buffer, s->in_buffer_index);
356             ret= swri_multiple_resample(s->resample, &out, out_count, &tmp, s->in_buffer_count, &consumed);
357             out_count -= ret;
358             ret_sum += ret;
359             buf_set(&out, &out, ret);
360             s->in_buffer_count -= consumed;
361             s->in_buffer_index += consumed;
362
363             if(!in_count)
364                 break;
365             if(s->in_buffer_count <= border){
366                 buf_set(&in, &in, -s->in_buffer_count);
367                 in_count += s->in_buffer_count;
368                 s->in_buffer_count=0;
369                 s->in_buffer_index=0;
370                 border = 0;
371             }
372         }
373
374         if(in_count && !s->in_buffer_count){
375             s->in_buffer_index=0;
376             ret= swri_multiple_resample(s->resample, &out, out_count, &in, in_count, &consumed);
377             out_count -= ret;
378             ret_sum += ret;
379             buf_set(&out, &out, ret);
380             in_count -= consumed;
381             buf_set(&in, &in, consumed);
382         }
383
384         //TODO is this check sane considering the advanced copy avoidance below
385         size= s->in_buffer_index + s->in_buffer_count + in_count;
386         if(   size > s->in_buffer.count
387            && s->in_buffer_count + in_count <= s->in_buffer_index){
388             buf_set(&tmp, &s->in_buffer, s->in_buffer_index);
389             copy(&s->in_buffer, &tmp, s->in_buffer_count);
390             s->in_buffer_index=0;
391         }else
392             if((ret=realloc_audio(&s->in_buffer, size)) < 0)
393                 return ret;
394
395         if(in_count){
396             int count= in_count;
397             if(s->in_buffer_count && s->in_buffer_count+2 < count && out_count) count= s->in_buffer_count+2;
398
399             buf_set(&tmp, &s->in_buffer, s->in_buffer_index + s->in_buffer_count);
400             copy(&tmp, &in, /*in_*/count);
401             s->in_buffer_count += count;
402             in_count -= count;
403             border += count;
404             buf_set(&in, &in, count);
405             s->resample_in_constraint= 0;
406             if(s->in_buffer_count != count || in_count)
407                 continue;
408         }
409         break;
410     }while(1);
411
412     s->resample_in_constraint= !!out_count;
413
414     return ret_sum;
415 }
416
417 int swr_convert(struct SwrContext *s, uint8_t *out_arg[SWR_CH_MAX], int out_count,
418                          const uint8_t *in_arg [SWR_CH_MAX], int  in_count){
419     AudioData *postin, *midbuf, *preout;
420     int ret/*, in_max*/;
421     AudioData * in= &s->in;
422     AudioData *out= &s->out;
423     AudioData preout_tmp, midbuf_tmp;
424
425     if(!s->resample){
426         if(in_count > out_count)
427             return -1;
428         out_count = in_count;
429     }
430
431     if(!in_arg){
432         if(s->in_buffer_count){
433             AudioData *a= &s->in_buffer;
434             int i, j, ret;
435             if((ret=realloc_audio(a, s->in_buffer_index + 2*s->in_buffer_count)) < 0)
436                 return ret;
437             av_assert0(a->planar);
438             for(i=0; i<a->ch_count; i++){
439                 for(j=0; j<s->in_buffer_count; j++){
440                     memcpy(a->ch[i] + (s->in_buffer_index+s->in_buffer_count+j  )*a->bps,
441                            a->ch[i] + (s->in_buffer_index+s->in_buffer_count-j-1)*a->bps, a->bps);
442                 }
443             }
444             s->in_buffer_count += (s->in_buffer_count+1)/2;
445             s->resample_in_constraint = 0;
446         }else{
447             return 0;
448         }
449     }else
450         fill_audiodata(in ,  (void*)in_arg);
451     fill_audiodata(out, out_arg);
452
453     if(s->full_convert){
454         av_assert0(!s->resample);
455         swri_audio_convert(s->full_convert, out, in, in_count);
456         return out_count;
457     }
458
459 //     in_max= out_count*(int64_t)s->in_sample_rate / s->out_sample_rate + resample_filter_taps;
460 //     in_count= FFMIN(in_count, in_in + 2 - s->hist_buffer_count);
461
462     if((ret=realloc_audio(&s->postin, in_count))<0)
463         return ret;
464     if(s->resample_first){
465         av_assert0(s->midbuf.ch_count == s->used_ch_count);
466         if((ret=realloc_audio(&s->midbuf, out_count))<0)
467             return ret;
468     }else{
469         av_assert0(s->midbuf.ch_count ==  s->out.ch_count);
470         if((ret=realloc_audio(&s->midbuf,  in_count))<0)
471             return ret;
472     }
473     if((ret=realloc_audio(&s->preout, out_count))<0)
474         return ret;
475
476     postin= &s->postin;
477
478     midbuf_tmp= s->midbuf;
479     midbuf= &midbuf_tmp;
480     preout_tmp= s->preout;
481     preout= &preout_tmp;
482
483     if(s->int_sample_fmt == s-> in_sample_fmt && s->in.planar)
484         postin= in;
485
486     if(s->resample_first ? !s->resample : !s->rematrix)
487         midbuf= postin;
488
489     if(s->resample_first ? !s->rematrix : !s->resample)
490         preout= midbuf;
491
492     if(s->int_sample_fmt == s->out_sample_fmt && s->out.planar){
493         if(preout==in){
494             out_count= FFMIN(out_count, in_count); //TODO check at the end if this is needed or redundant
495             av_assert0(s->in.planar); //we only support planar internally so it has to be, we support copying non planar though
496             copy(out, in, out_count);
497             return out_count;
498         }
499         else if(preout==postin) preout= midbuf= postin= out;
500         else if(preout==midbuf) preout= midbuf= out;
501         else                    preout= out;
502     }
503
504     if(in != postin){
505         swri_audio_convert(s->in_convert, postin, in, in_count);
506     }
507
508     if(s->resample_first){
509         if(postin != midbuf)
510             out_count= resample(s, midbuf, out_count, postin, in_count);
511         if(midbuf != preout)
512             swri_rematrix(s, preout, midbuf, out_count, preout==out);
513     }else{
514         if(postin != midbuf)
515             swri_rematrix(s, midbuf, postin, in_count, midbuf==out);
516         if(midbuf != preout)
517             out_count= resample(s, preout, out_count, midbuf, in_count);
518     }
519
520     if(preout != out){
521 //FIXME packed doesnt need more than 1 chan here!
522         swri_audio_convert(s->out_convert, out, preout, out_count);
523     }
524     if(!in_arg)
525         s->in_buffer_count = 0;
526     return out_count;
527 }
528