1 /*****************************************************************************
2 * bandlimited.c : band-limited interpolation resampler
3 *****************************************************************************
4 * Copyright (C) 2002, 2006 the VideoLAN team
7 * Authors: Gildas Bazin <gbazin@netcourrier.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
27 * This implementation of the band-limited interpolationis based on the
29 * http://ccrma-www.stanford.edu/~jos/resample/resample.html
31 * It uses a Kaiser-windowed sinc-function low-pass filter and the width of the
32 * filter is 13 samples.
34 *****************************************************************************/
40 #include <vlc_common.h>
41 #include <vlc_plugin.h>
43 #include <vlc_filter.h>
44 #include <vlc_block.h>
46 #include "bandlimited.h"
48 /*****************************************************************************
50 *****************************************************************************/
51 static int Create ( vlc_object_t * );
52 static void Close ( vlc_object_t * );
53 static void DoWork ( aout_instance_t *, aout_filter_t *, aout_buffer_t *,
57 static int OpenFilter ( vlc_object_t * );
58 static void CloseFilter( vlc_object_t * );
59 static block_t *Resample( filter_t *, block_t * );
62 static void FilterFloatUP( const float Imp[], const float ImpD[], uint16_t Nwing,
63 float *f_in, float *f_out, uint32_t ui_remainder,
64 uint32_t ui_output_rate, int16_t Inc,
67 static void FilterFloatUD( const float Imp[], const float ImpD[], uint16_t Nwing,
68 float *f_in, float *f_out, uint32_t ui_remainder,
69 uint32_t ui_output_rate, uint32_t ui_input_rate,
70 int16_t Inc, int i_nb_channels );
72 /*****************************************************************************
74 *****************************************************************************/
77 int32_t *p_buf; /* this filter introduces a delay */
84 unsigned int i_remainder; /* remainder of previous sample */
86 audio_date_t end_date;
92 /*****************************************************************************
94 *****************************************************************************/
96 set_category( CAT_AUDIO )
97 set_subcategory( SUBCAT_AUDIO_MISC )
98 set_description( N_("Audio filter for band-limited interpolation resampling") )
99 set_capability( "audio filter", 20 )
100 set_callbacks( Create, Close )
103 set_description( _("Audio filter for band-limited interpolation resampling") )
104 set_capability( "audio filter2", 20 )
105 set_callbacks( OpenFilter, CloseFilter )
108 /*****************************************************************************
109 * Create: allocate linear resampler
110 *****************************************************************************/
111 static int Create( vlc_object_t *p_this )
113 aout_filter_t * p_filter = (aout_filter_t *)p_this;
114 struct filter_sys_t * p_sys;
118 if ( p_filter->input.i_rate == p_filter->output.i_rate
119 || p_filter->input.i_format != p_filter->output.i_format
120 || p_filter->input.i_physical_channels
121 != p_filter->output.i_physical_channels
122 || p_filter->input.i_original_channels
123 != p_filter->output.i_original_channels
124 || p_filter->input.i_format != VLC_FOURCC('f','l','3','2') )
129 #if !defined( __APPLE__ )
130 if( !config_GetInt( p_this, "hq-resampling" ) )
136 /* Allocate the memory needed to store the module's structure */
137 p_sys = malloc( sizeof(filter_sys_t) );
140 p_filter->p_sys = (struct aout_filter_sys_t *)p_sys;
142 /* Calculate worst case for the length of the filter wing */
143 d_factor = (double)p_filter->output.i_rate
144 / p_filter->input.i_rate / AOUT_MAX_INPUT_RATE;
145 i_filter_wing = ((SMALL_FILTER_NMULT + 1)/2.0)
146 * __MAX(1.0, 1.0/d_factor) + 10;
147 p_sys->i_buf_size = aout_FormatNbChannels( &p_filter->input ) *
148 sizeof(int32_t) * 2 * i_filter_wing;
150 /* Allocate enough memory to buffer previous samples */
151 p_sys->p_buf = malloc( p_sys->i_buf_size );
152 if( p_sys->p_buf == NULL )
158 p_sys->i_old_wing = 0;
159 p_sys->b_filter2 = false; /* It seams to be a good valuefor this module */
160 p_filter->pf_do_work = DoWork;
162 /* We don't want a new buffer to be created because we're not sure we'll
163 * actually need to resample anything. */
164 p_filter->b_in_place = true;
169 /*****************************************************************************
170 * Close: free our resources
171 *****************************************************************************/
172 static void Close( vlc_object_t * p_this )
174 aout_filter_t * p_filter = (aout_filter_t *)p_this;
175 filter_sys_t *p_sys = (filter_sys_t *)p_filter->p_sys;
176 free( p_sys->p_buf );
180 /*****************************************************************************
181 * DoWork: convert a buffer
182 *****************************************************************************/
183 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
184 aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
186 filter_sys_t *p_sys = (filter_sys_t *)p_filter->p_sys;
187 float *p_in, *p_in_orig, *p_out = (float *)p_out_buf->p_buffer;
189 int i_nb_channels = aout_FormatNbChannels( &p_filter->input );
190 int i_in_nb = p_in_buf->i_nb_samples;
192 unsigned int i_out_rate;
193 double d_factor, d_scale_factor, d_old_scale_factor;
196 if( p_sys->b_filter2 )
197 i_out_rate = p_filter->output.i_rate;
199 i_out_rate = p_aout->mixer.mixer.i_rate;
201 /* Check if we really need to run the resampler */
202 if( i_out_rate == p_filter->input.i_rate )
204 if( /*p_filter->b_continuity && /--* What difference does it make ? :) */
207 p_in_buf->i_nb_bytes + p_sys->i_old_wing *
208 p_filter->input.i_bytes_per_frame )
210 /* output the whole thing with the samples from last time */
211 memmove( ((float *)(p_in_buf->p_buffer)) +
212 i_nb_channels * p_sys->i_old_wing,
213 p_in_buf->p_buffer, p_in_buf->i_nb_bytes );
214 memcpy( p_in_buf->p_buffer, p_sys->p_buf +
215 i_nb_channels * p_sys->i_old_wing,
217 p_filter->input.i_bytes_per_frame );
219 p_out_buf->i_nb_samples = p_in_buf->i_nb_samples +
222 p_out_buf->start_date = aout_DateGet( &p_sys->end_date );
223 p_out_buf->end_date =
224 aout_DateIncrement( &p_sys->end_date,
225 p_out_buf->i_nb_samples );
227 p_out_buf->i_nb_bytes = p_out_buf->i_nb_samples *
228 p_filter->input.i_bytes_per_frame;
230 p_filter->b_continuity = false;
231 p_sys->i_old_wing = 0;
235 if( !p_filter->b_continuity )
237 /* Continuity in sound samples has been broken, we'd better reset
239 p_filter->b_continuity = true;
240 p_sys->i_remainder = 0;
241 aout_DateInit( &p_sys->end_date, i_out_rate );
242 aout_DateSet( &p_sys->end_date, p_in_buf->start_date );
243 p_sys->i_old_rate = p_filter->input.i_rate;
244 p_sys->d_old_factor = 1;
245 p_sys->i_old_wing = 0;
249 msg_Err( p_filter, "old rate: %i, old factor: %f, old wing: %i, i_in: %i",
250 p_sys->i_old_rate, p_sys->d_old_factor,
251 p_sys->i_old_wing, i_in_nb );
254 /* Prepare the source buffer */
255 i_in_nb += (p_sys->i_old_wing * 2);
257 p_in = p_in_orig = (float *)alloca( i_in_nb *
258 p_filter->input.i_bytes_per_frame );
260 p_in = p_in_orig = (float *)malloc( i_in_nb *
261 p_filter->input.i_bytes_per_frame );
268 /* Copy all our samples in p_in */
269 if( p_sys->i_old_wing )
271 vlc_memcpy( p_in, p_sys->p_buf,
272 p_sys->i_old_wing * 2 *
273 p_filter->input.i_bytes_per_frame );
275 vlc_memcpy( p_in + p_sys->i_old_wing * 2 * i_nb_channels,
277 p_in_buf->i_nb_samples * p_filter->input.i_bytes_per_frame );
279 /* Make sure the output buffer is reset */
280 memset( p_out, 0, p_out_buf->i_size );
282 /* Calculate the new length of the filter wing */
283 d_factor = (double)i_out_rate / p_filter->input.i_rate;
284 i_filter_wing = ((SMALL_FILTER_NMULT+1)/2.0) * __MAX(1.0,1.0/d_factor) + 1;
286 /* Account for increased filter gain when using factors less than 1 */
287 d_old_scale_factor = SMALL_FILTER_SCALE *
288 p_sys->d_old_factor + 0.5;
289 d_scale_factor = SMALL_FILTER_SCALE * d_factor + 0.5;
291 /* Apply the old rate until we have enough samples for the new one */
292 i_in = p_sys->i_old_wing;
293 p_in += p_sys->i_old_wing * i_nb_channels;
294 for( ; i_in < i_filter_wing &&
295 (i_in + p_sys->i_old_wing) < i_in_nb; i_in++ )
297 if( p_sys->d_old_factor == 1 )
299 /* Just copy the samples */
301 p_filter->input.i_bytes_per_frame );
302 p_in += i_nb_channels;
303 p_out += i_nb_channels;
308 while( p_sys->i_remainder < p_filter->output.i_rate )
311 if( p_sys->d_old_factor >= 1 )
313 /* FilterFloatUP() is faster if we can use it */
315 /* Perform left-wing inner product */
316 FilterFloatUP( SMALL_FILTER_FLOAT_IMP, SMALL_FILTER_FLOAT_IMPD,
317 SMALL_FILTER_NWING, p_in, p_out,
319 p_filter->output.i_rate,
321 /* Perform right-wing inner product */
322 FilterFloatUP( SMALL_FILTER_FLOAT_IMP, SMALL_FILTER_FLOAT_IMPD,
323 SMALL_FILTER_NWING, p_in + i_nb_channels, p_out,
324 p_filter->output.i_rate -
326 p_filter->output.i_rate,
330 /* Normalize for unity filter gain */
331 for( i = 0; i < i_nb_channels; i++ )
333 *(p_out+i) *= d_old_scale_factor;
338 if( p_out_buf->i_size/p_filter->input.i_bytes_per_frame
339 <= (unsigned int)i_out+1 )
341 p_out += i_nb_channels;
343 p_sys->i_remainder += p_filter->input.i_rate;
349 /* Perform left-wing inner product */
350 FilterFloatUD( SMALL_FILTER_FLOAT_IMP, SMALL_FILTER_FLOAT_IMPD,
351 SMALL_FILTER_NWING, p_in, p_out,
353 p_filter->output.i_rate, p_filter->input.i_rate,
355 /* Perform right-wing inner product */
356 FilterFloatUD( SMALL_FILTER_FLOAT_IMP, SMALL_FILTER_FLOAT_IMPD,
357 SMALL_FILTER_NWING, p_in + i_nb_channels, p_out,
358 p_filter->output.i_rate -
360 p_filter->output.i_rate, p_filter->input.i_rate,
364 p_out += i_nb_channels;
367 p_sys->i_remainder += p_filter->input.i_rate;
370 p_in += i_nb_channels;
371 p_sys->i_remainder -= p_filter->output.i_rate;
374 /* Apply the new rate for the rest of the samples */
375 if( i_in < i_in_nb - i_filter_wing )
377 p_sys->i_old_rate = p_filter->input.i_rate;
378 p_sys->d_old_factor = d_factor;
379 p_sys->i_old_wing = i_filter_wing;
381 for( ; i_in < i_in_nb - i_filter_wing; i_in++ )
383 while( p_sys->i_remainder < p_filter->output.i_rate )
388 /* FilterFloatUP() is faster if we can use it */
390 /* Perform left-wing inner product */
391 FilterFloatUP( SMALL_FILTER_FLOAT_IMP, SMALL_FILTER_FLOAT_IMPD,
392 SMALL_FILTER_NWING, p_in, p_out,
394 p_filter->output.i_rate,
397 /* Perform right-wing inner product */
398 FilterFloatUP( SMALL_FILTER_FLOAT_IMP, SMALL_FILTER_FLOAT_IMPD,
399 SMALL_FILTER_NWING, p_in + i_nb_channels, p_out,
400 p_filter->output.i_rate -
402 p_filter->output.i_rate,
406 /* Normalize for unity filter gain */
407 for( int i = 0; i < i_nb_channels; i++ )
409 *(p_out+i) *= d_old_scale_factor;
413 if( p_out_buf->i_size/p_filter->input.i_bytes_per_frame
414 <= (unsigned int)i_out+1 )
416 p_out += i_nb_channels;
418 p_sys->i_remainder += p_filter->input.i_rate;
424 /* Perform left-wing inner product */
425 FilterFloatUD( SMALL_FILTER_FLOAT_IMP, SMALL_FILTER_FLOAT_IMPD,
426 SMALL_FILTER_NWING, p_in, p_out,
428 p_filter->output.i_rate, p_filter->input.i_rate,
430 /* Perform right-wing inner product */
431 FilterFloatUD( SMALL_FILTER_FLOAT_IMP, SMALL_FILTER_FLOAT_IMPD,
432 SMALL_FILTER_NWING, p_in + i_nb_channels, p_out,
433 p_filter->output.i_rate -
435 p_filter->output.i_rate, p_filter->input.i_rate,
439 p_out += i_nb_channels;
442 p_sys->i_remainder += p_filter->input.i_rate;
445 p_in += i_nb_channels;
446 p_sys->i_remainder -= p_filter->output.i_rate;
449 /* Buffer i_filter_wing * 2 samples for next time */
450 if( p_sys->i_old_wing )
452 memcpy( p_sys->p_buf,
453 p_in_orig + (i_in_nb - 2 * p_sys->i_old_wing) *
454 i_nb_channels, (2 * p_sys->i_old_wing) *
455 p_filter->input.i_bytes_per_frame );
459 msg_Err( p_filter, "p_out size: %i, nb bytes out: %i", p_out_buf->i_size,
460 i_out * p_filter->input.i_bytes_per_frame );
463 /* Free the temp buffer */
468 /* Finalize aout buffer */
469 p_out_buf->i_nb_samples = i_out;
470 p_out_buf->start_date = aout_DateGet( &p_sys->end_date );
471 p_out_buf->end_date = aout_DateIncrement( &p_sys->end_date,
472 p_out_buf->i_nb_samples );
474 p_out_buf->i_nb_bytes = p_out_buf->i_nb_samples *
475 i_nb_channels * sizeof(int32_t);
479 /*****************************************************************************
481 *****************************************************************************/
482 static int OpenFilter( vlc_object_t *p_this )
484 filter_t *p_filter = (filter_t *)p_this;
486 unsigned int i_out_rate = p_filter->fmt_out.audio.i_rate;
490 if( p_filter->fmt_in.audio.i_rate == p_filter->fmt_out.audio.i_rate ||
491 p_filter->fmt_in.i_codec != VLC_FOURCC('f','l','3','2') )
496 #if !defined( SYS_DARWIN )
497 if( !config_GetInt( p_this, "hq-resampling" ) )
503 /* Allocate the memory needed to store the module's structure */
504 p_filter->p_sys = p_sys = malloc( sizeof(struct filter_sys_t) );
508 /* Calculate worst case for the length of the filter wing */
509 d_factor = (double)i_out_rate / p_filter->fmt_in.audio.i_rate;
510 i_filter_wing = ((SMALL_FILTER_NMULT + 1)/2.0)
511 * __MAX(1.0, 1.0/d_factor) + 10;
512 p_filter->p_sys->i_buf_size = p_filter->fmt_in.audio.i_channels *
513 sizeof(int32_t) * 2 * i_filter_wing;
515 /* Allocate enough memory to buffer previous samples */
516 p_filter->p_sys->p_buf = malloc( p_filter->p_sys->i_buf_size );
517 if( p_filter->p_sys->p_buf == NULL )
523 p_filter->p_sys->i_old_wing = 0;
524 p_sys->b_first = true;
525 p_sys->b_filter2 = true;
526 p_filter->pf_audio_filter = Resample;
528 msg_Dbg( p_this, "%4.4s/%iKHz/%i->%4.4s/%iKHz/%i",
529 (char *)&p_filter->fmt_in.i_codec,
530 p_filter->fmt_in.audio.i_rate,
531 p_filter->fmt_in.audio.i_channels,
532 (char *)&p_filter->fmt_out.i_codec,
533 p_filter->fmt_out.audio.i_rate,
534 p_filter->fmt_out.audio.i_channels);
536 p_filter->fmt_out = p_filter->fmt_in;
537 p_filter->fmt_out.audio.i_rate = i_out_rate;
542 /*****************************************************************************
543 * CloseFilter : deallocate data structures
544 *****************************************************************************/
545 static void CloseFilter( vlc_object_t *p_this )
547 filter_t *p_filter = (filter_t *)p_this;
548 free( p_filter->p_sys->p_buf );
549 free( p_filter->p_sys );
552 /*****************************************************************************
554 *****************************************************************************/
555 static block_t *Resample( filter_t *p_filter, block_t *p_block )
557 aout_filter_t aout_filter;
558 aout_buffer_t in_buf, out_buf;
561 int i_bytes_per_frame;
563 if( !p_block || !p_block->i_samples )
566 block_Release( p_block );
570 i_bytes_per_frame = p_filter->fmt_out.audio.i_channels *
571 p_filter->fmt_out.audio.i_bitspersample / 8;
573 i_out_size = i_bytes_per_frame * ( 1 + (p_block->i_samples *
574 p_filter->fmt_out.audio.i_rate / p_filter->fmt_in.audio.i_rate));
576 p_out = p_filter->pf_audio_buffer_new( p_filter, i_out_size );
579 msg_Warn( p_filter, "can't get output buffer" );
580 block_Release( p_block );
584 p_out->i_samples = i_out_size / i_bytes_per_frame;
585 p_out->i_dts = p_block->i_dts;
586 p_out->i_pts = p_block->i_pts;
587 p_out->i_length = p_block->i_length;
589 aout_filter.p_sys = (struct aout_filter_sys_t *)p_filter->p_sys;
590 aout_filter.input = p_filter->fmt_in.audio;
591 aout_filter.input.i_bytes_per_frame = p_filter->fmt_in.audio.i_channels *
592 p_filter->fmt_in.audio.i_bitspersample / 8;
593 aout_filter.output = p_filter->fmt_out.audio;
594 aout_filter.output.i_bytes_per_frame = p_filter->fmt_out.audio.i_channels *
595 p_filter->fmt_out.audio.i_bitspersample / 8;
596 aout_filter.b_continuity = !p_filter->p_sys->b_first;
597 p_filter->p_sys->b_first = false;
599 in_buf.p_buffer = p_block->p_buffer;
600 in_buf.i_nb_bytes = in_buf.i_size = p_block->i_buffer;
601 in_buf.i_nb_samples = p_block->i_samples;
602 out_buf.p_buffer = p_out->p_buffer;
603 out_buf.i_nb_bytes = out_buf.i_size = p_out->i_buffer;
604 out_buf.i_nb_samples = p_out->i_samples;
606 DoWork( (aout_instance_t *)p_filter, &aout_filter, &in_buf, &out_buf );
608 block_Release( p_block );
610 p_out->i_buffer = out_buf.i_nb_bytes;
611 p_out->i_samples = out_buf.i_nb_samples;
616 void FilterFloatUP( const float Imp[], const float ImpD[], uint16_t Nwing, float *p_in,
617 float *p_out, uint32_t ui_remainder,
618 uint32_t ui_output_rate, int16_t Inc, int i_nb_channels )
620 const float *Hp, *Hdp, *End;
622 uint32_t ui_linear_remainder;
625 Hp = &Imp[(ui_remainder<<Nhc)/ui_output_rate];
626 Hdp = &ImpD[(ui_remainder<<Nhc)/ui_output_rate];
630 ui_linear_remainder = (ui_remainder<<Nhc) -
631 (ui_remainder<<Nhc)/ui_output_rate*ui_output_rate;
633 if (Inc == 1) /* If doing right wing... */
634 { /* ...drop extra coeff, so when Ph is */
635 End--; /* 0.5, we don't do too many mult's */
636 if (ui_remainder == 0) /* If the phase is zero... */
637 { /* ...then we've already skipped the */
638 Hp += Npc; /* first sample, so we must also */
639 Hdp += Npc; /* skip ahead in Imp[] and ImpD[] */
644 t = *Hp; /* Get filter coeff */
645 /* t is now interp'd filter coeff */
646 t += *Hdp * ui_linear_remainder / ui_output_rate / Npc;
647 for( i = 0; i < i_nb_channels; i++ )
650 temp *= *(p_in+i); /* Mult coeff by input sample */
651 *(p_out+i) += temp; /* The filter output */
653 Hdp += Npc; /* Filter coeff differences step */
654 Hp += Npc; /* Filter coeff step */
655 p_in += (Inc * i_nb_channels); /* Input signal step */
659 void FilterFloatUD( const float Imp[], const float ImpD[], uint16_t Nwing, float *p_in,
660 float *p_out, uint32_t ui_remainder,
661 uint32_t ui_output_rate, uint32_t ui_input_rate,
662 int16_t Inc, int i_nb_channels )
664 const float *Hp, *Hdp, *End;
666 uint32_t ui_linear_remainder;
667 int i, ui_counter = 0;
669 Hp = Imp + (ui_remainder<<Nhc) / ui_input_rate;
670 Hdp = ImpD + (ui_remainder<<Nhc) / ui_input_rate;
674 if (Inc == 1) /* If doing right wing... */
675 { /* ...drop extra coeff, so when Ph is */
676 End--; /* 0.5, we don't do too many mult's */
677 if (ui_remainder == 0) /* If the phase is zero... */
678 { /* ...then we've already skipped the */
679 Hp = Imp + /* first sample, so we must also */
680 (ui_output_rate << Nhc) / ui_input_rate;
681 Hdp = ImpD + /* skip ahead in Imp[] and ImpD[] */
682 (ui_output_rate << Nhc) / ui_input_rate;
688 t = *Hp; /* Get filter coeff */
689 /* t is now interp'd filter coeff */
690 ui_linear_remainder =
691 ((ui_output_rate * ui_counter + ui_remainder)<< Nhc) -
692 ((ui_output_rate * ui_counter + ui_remainder)<< Nhc) /
693 ui_input_rate * ui_input_rate;
694 t += *Hdp * ui_linear_remainder / ui_input_rate / Npc;
695 for( i = 0; i < i_nb_channels; i++ )
698 temp *= *(p_in+i); /* Mult coeff by input sample */
699 *(p_out+i) += temp; /* The filter output */
704 /* Filter coeff step */
705 Hp = Imp + ((ui_output_rate * ui_counter + ui_remainder)<< Nhc)
707 /* Filter coeff differences step */
708 Hdp = ImpD + ((ui_output_rate * ui_counter + ui_remainder)<< Nhc)
711 p_in += (Inc * i_nb_channels); /* Input signal step */