git.sesse.net Git - vlc/blob - modules/audio_filter/resampler/bandlimited.c

   1 /*****************************************************************************
   2  * bandlimited.c : band-limited interpolation resampler
   3  *****************************************************************************
   4  * Copyright (C) 2002, 2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Gildas Bazin <gbazin@netcourrier.com>
   8  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble:
  26  *
  27  * This implementation of the band-limited interpolationis based on the
  28  * following paper:
  29  * http://ccrma-www.stanford.edu/~jos/resample/resample.html
  30  *
  31  * It uses a Kaiser-windowed sinc-function low-pass filter and the width of the
  32  * filter is 13 samples.
  33  *
  34  *****************************************************************************/
  35
  36 #ifdef HAVE_CONFIG_H
  37 # include "config.h"
  38 #endif
  39
  40 #include <vlc_common.h>
  41 #include <vlc_plugin.h>
  42 #include <vlc_aout.h>
  43
  44 #include "bandlimited.h"
  45
  46 /*****************************************************************************
  47  * Local prototypes
  48  *****************************************************************************/
  49 static int  Create    ( vlc_object_t * );
  50 static void Close     ( vlc_object_t * );
  51 static void DoWork    ( aout_instance_t *, aout_filter_t *, aout_buffer_t *,
  52                         aout_buffer_t * );
  53
  54 static void FilterFloatUP( float Imp[], float ImpD[], uint16_t Nwing,
  55                            float *f_in, float *f_out, uint32_t ui_remainder,
  56                            uint32_t ui_output_rate, int16_t Inc,
  57                            int i_nb_channels );
  58
  59 static void FilterFloatUD( float Imp[], float ImpD[], uint16_t Nwing,
  60                            float *f_in, float *f_out, uint32_t ui_remainder,
  61                            uint32_t ui_output_rate, uint32_t ui_input_rate,
  62                            int16_t Inc, int i_nb_channels );
  63
  64 /*****************************************************************************
  65  * Local structures
  66  *****************************************************************************/
  67 struct aout_filter_sys_t
  68 {
  69     int32_t *p_buf;                        /* this filter introduces a delay */
  70     int i_buf_size;
  71
  72     int i_old_rate;
  73     double d_old_factor;
  74     int i_old_wing;
  75
  76     unsigned int i_remainder;                /* remainder of previous sample */
  77
  78     audio_date_t end_date;
  79 };
  80
  81 /*****************************************************************************
  82  * Module descriptor
  83  *****************************************************************************/
  84 vlc_module_begin();
  85     set_category( CAT_AUDIO );
  86     set_subcategory( SUBCAT_AUDIO_MISC );
  87     set_description( N_("Audio filter for band-limited interpolation resampling") );
  88     set_capability( "audio filter", 20 );
  89     set_callbacks( Create, Close );
  90 vlc_module_end();
  91
  92 /*****************************************************************************
  93  * Create: allocate linear resampler
  94  *****************************************************************************/
  95 static int Create( vlc_object_t *p_this )
  96 {
  97     aout_filter_t * p_filter = (aout_filter_t *)p_this;
  98     double d_factor;
  99     int i_filter_wing;
 100
 101     if ( p_filter->input.i_rate == p_filter->output.i_rate
 102           || p_filter->input.i_format != p_filter->output.i_format
 103           || p_filter->input.i_physical_channels
 104               != p_filter->output.i_physical_channels
 105           || p_filter->input.i_original_channels
 106               != p_filter->output.i_original_channels
 107           || p_filter->input.i_format != VLC_FOURCC('f','l','3','2') )
 108     {
 109         return VLC_EGENERIC;
 110     }
 111
 112 #if !defined( __APPLE__ )
 113     if( !config_GetInt( p_this, "hq-resampling" ) )
 114     {
 115         return VLC_EGENERIC;
 116     }
 117 #endif
 118
 119     /* Allocate the memory needed to store the module's structure */
 120     p_filter->p_sys = malloc( sizeof(struct aout_filter_sys_t) );
 121     if( p_filter->p_sys == NULL )
 122     {
 123         msg_Err( p_filter, "out of memory" );
 124         return VLC_ENOMEM;
 125     }
 126
 127     /* Calculate worst case for the length of the filter wing */
 128     d_factor = (double)p_filter->output.i_rate
 129                         / p_filter->input.i_rate / AOUT_MAX_INPUT_RATE;
 130     i_filter_wing = ((SMALL_FILTER_NMULT + 1)/2.0)
 131                       * __MAX(1.0, 1.0/d_factor) + 10;
 132     p_filter->p_sys->i_buf_size = aout_FormatNbChannels( &p_filter->input ) *
 133         sizeof(int32_t) * 2 * i_filter_wing;
 134
 135     /* Allocate enough memory to buffer previous samples */
 136     p_filter->p_sys->p_buf = malloc( p_filter->p_sys->i_buf_size );
 137     if( p_filter->p_sys->p_buf == NULL )
 138     {
 139         msg_Err( p_filter, "out of memory" );
 140         return VLC_ENOMEM;
 141     }
 142
 143     p_filter->p_sys->i_old_wing = 0;
 144     p_filter->pf_do_work = DoWork;
 145
 146     /* We don't want a new buffer to be created because we're not sure we'll
 147      * actually need to resample anything. */
 148     p_filter->b_in_place = true;
 149
 150     return VLC_SUCCESS;
 151 }
 152
 153 /*****************************************************************************
 154  * Close: free our resources
 155  *****************************************************************************/
 156 static void Close( vlc_object_t * p_this )
 157 {
 158     aout_filter_t * p_filter = (aout_filter_t *)p_this;
 159     free( p_filter->p_sys->p_buf );
 160     free( p_filter->p_sys );
 161 }
 162
 163 /*****************************************************************************
 164  * DoWork: convert a buffer
 165  *****************************************************************************/
 166 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
 167                     aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
 168 {
 169     float *p_in, *p_in_orig, *p_out = (float *)p_out_buf->p_buffer;
 170
 171     int i_nb_channels = aout_FormatNbChannels( &p_filter->input );
 172     int i_in_nb = p_in_buf->i_nb_samples;
 173     int i_in, i_out = 0;
 174     double d_factor, d_scale_factor, d_old_scale_factor;
 175     int i_filter_wing;
 176 #if 0
 177     int i;
 178 #endif
 179
 180     /* Check if we really need to run the resampler */
 181     if( p_aout->mixer.mixer.i_rate == p_filter->input.i_rate )
 182     {
 183         if( /*p_filter->b_continuity && /--* What difference does it make ? :) */
 184             p_filter->p_sys->i_old_wing &&
 185             p_in_buf->i_size >=
 186               p_in_buf->i_nb_bytes + p_filter->p_sys->i_old_wing *
 187               p_filter->input.i_bytes_per_frame )
 188         {
 189             /* output the whole thing with the samples from last time */
 190             memmove( ((float *)(p_in_buf->p_buffer)) +
 191                      i_nb_channels * p_filter->p_sys->i_old_wing,
 192                      p_in_buf->p_buffer, p_in_buf->i_nb_bytes );
 193             memcpy( p_in_buf->p_buffer, p_filter->p_sys->p_buf +
 194                     i_nb_channels * p_filter->p_sys->i_old_wing,
 195                     p_filter->p_sys->i_old_wing *
 196                     p_filter->input.i_bytes_per_frame );
 197
 198             p_out_buf->i_nb_samples = p_in_buf->i_nb_samples +
 199                 p_filter->p_sys->i_old_wing;
 200
 201             p_out_buf->start_date = aout_DateGet( &p_filter->p_sys->end_date );
 202             p_out_buf->end_date =
 203                 aout_DateIncrement( &p_filter->p_sys->end_date,
 204                                     p_out_buf->i_nb_samples );
 205
 206             p_out_buf->i_nb_bytes = p_out_buf->i_nb_samples *
 207                 p_filter->input.i_bytes_per_frame;
 208         }
 209         p_filter->b_continuity = false;
 210         p_filter->p_sys->i_old_wing = 0;
 211         return;
 212     }
 213
 214     if( !p_filter->b_continuity )
 215     {
 216         /* Continuity in sound samples has been broken, we'd better reset
 217          * everything. */
 218         p_filter->b_continuity = true;
 219         p_filter->p_sys->i_remainder = 0;
 220         aout_DateInit( &p_filter->p_sys->end_date, p_filter->output.i_rate );
 221         aout_DateSet( &p_filter->p_sys->end_date, p_in_buf->start_date );
 222         p_filter->p_sys->i_old_rate   = p_filter->input.i_rate;
 223         p_filter->p_sys->d_old_factor = 1;
 224         p_filter->p_sys->i_old_wing   = 0;
 225     }
 226
 227 #if 0
 228     msg_Err( p_filter, "old rate: %i, old factor: %f, old wing: %i, i_in: %i",
 229              p_filter->p_sys->i_old_rate, p_filter->p_sys->d_old_factor,
 230              p_filter->p_sys->i_old_wing, i_in_nb );
 231 #endif
 232
 233     /* Prepare the source buffer */
 234     i_in_nb += (p_filter->p_sys->i_old_wing * 2);
 235 #ifdef HAVE_ALLOCA
 236     p_in = p_in_orig = (float *)alloca( i_in_nb *
 237                                         p_filter->input.i_bytes_per_frame );
 238 #else
 239     p_in = p_in_orig = (float *)malloc( i_in_nb *
 240                                         p_filter->input.i_bytes_per_frame );
 241 #endif
 242     if( p_in == NULL )
 243     {
 244         return;
 245     }
 246
 247     /* Copy all our samples in p_in */
 248     if( p_filter->p_sys->i_old_wing )
 249     {
 250         vlc_memcpy( p_in, p_filter->p_sys->p_buf,
 251                     p_filter->p_sys->i_old_wing * 2 *
 252                       p_filter->input.i_bytes_per_frame );
 253     }
 254     vlc_memcpy( p_in + p_filter->p_sys->i_old_wing * 2 * i_nb_channels,
 255                 p_in_buf->p_buffer,
 256                 p_in_buf->i_nb_samples * p_filter->input.i_bytes_per_frame );
 257
 258     /* Make sure the output buffer is reset */
 259     memset( p_out, 0, p_out_buf->i_size );
 260
 261     /* Calculate the new length of the filter wing */
 262     d_factor = (double)p_aout->mixer.mixer.i_rate / p_filter->input.i_rate;
 263     i_filter_wing = ((SMALL_FILTER_NMULT+1)/2.0) * __MAX(1.0,1.0/d_factor) + 1;
 264
 265     /* Account for increased filter gain when using factors less than 1 */
 266     d_old_scale_factor = SMALL_FILTER_SCALE *
 267         p_filter->p_sys->d_old_factor + 0.5;
 268     d_scale_factor = SMALL_FILTER_SCALE * d_factor + 0.5;
 269
 270     /* Apply the old rate until we have enough samples for the new one */
 271     i_in = p_filter->p_sys->i_old_wing;
 272     p_in += p_filter->p_sys->i_old_wing * i_nb_channels;
 273     for( ; i_in < i_filter_wing &&
 274            (i_in + p_filter->p_sys->i_old_wing) < i_in_nb; i_in++ )
 275     {
 276         if( p_filter->p_sys->d_old_factor == 1 )
 277         {
 278             /* Just copy the samples */
 279             memcpy( p_out, p_in,
 280                     p_filter->input.i_bytes_per_frame );
 281             p_in += i_nb_channels;
 282             p_out += i_nb_channels;
 283             i_out++;
 284             continue;
 285         }
 286
 287         while( p_filter->p_sys->i_remainder < p_filter->output.i_rate )
 288         {
 289
 290             if( p_filter->p_sys->d_old_factor >= 1 )
 291             {
 292                 /* FilterFloatUP() is faster if we can use it */
 293
 294                 /* Perform left-wing inner product */
 295                 FilterFloatUP( SMALL_FILTER_FLOAT_IMP, SMALL_FILTER_FLOAT_IMPD,
 296                                SMALL_FILTER_NWING, p_in, p_out,
 297                                p_filter->p_sys->i_remainder,
 298                                p_filter->output.i_rate,
 299                                -1, i_nb_channels );
 300                 /* Perform right-wing inner product */
 301                 FilterFloatUP( SMALL_FILTER_FLOAT_IMP, SMALL_FILTER_FLOAT_IMPD,
 302                                SMALL_FILTER_NWING, p_in + i_nb_channels, p_out,
 303                                p_filter->output.i_rate -
 304                                p_filter->p_sys->i_remainder,
 305                                p_filter->output.i_rate,
 306                                1, i_nb_channels );
 307
 308 #if 0
 309                 /* Normalize for unity filter gain */
 310                 for( i = 0; i < i_nb_channels; i++ )
 311                 {
 312                     *(p_out+i) *= d_old_scale_factor;
 313                 }
 314 #endif
 315
 316                 /* Sanity check */
 317                 if( p_out_buf->i_size/p_filter->input.i_bytes_per_frame
 318                     <= (unsigned int)i_out+1 )
 319                 {
 320                     p_out += i_nb_channels;
 321                     i_out++;
 322                     p_filter->p_sys->i_remainder += p_filter->input.i_rate;
 323                     break;
 324                 }
 325             }
 326             else
 327             {
 328                 /* Perform left-wing inner product */
 329                 FilterFloatUD( SMALL_FILTER_FLOAT_IMP, SMALL_FILTER_FLOAT_IMPD,
 330                                SMALL_FILTER_NWING, p_in, p_out,
 331                                p_filter->p_sys->i_remainder,
 332                                p_filter->output.i_rate, p_filter->input.i_rate,
 333                                -1, i_nb_channels );
 334                 /* Perform right-wing inner product */
 335                 FilterFloatUD( SMALL_FILTER_FLOAT_IMP, SMALL_FILTER_FLOAT_IMPD,
 336                                SMALL_FILTER_NWING, p_in + i_nb_channels, p_out,
 337                                p_filter->output.i_rate -
 338                                p_filter->p_sys->i_remainder,
 339                                p_filter->output.i_rate, p_filter->input.i_rate,
 340                                1, i_nb_channels );
 341             }
 342
 343             p_out += i_nb_channels;
 344             i_out++;
 345
 346             p_filter->p_sys->i_remainder += p_filter->input.i_rate;
 347         }
 348
 349         p_in += i_nb_channels;
 350         p_filter->p_sys->i_remainder -= p_filter->output.i_rate;
 351     }
 352
 353     /* Apply the new rate for the rest of the samples */
 354     if( i_in < i_in_nb - i_filter_wing )
 355     {
 356         p_filter->p_sys->i_old_rate   = p_filter->input.i_rate;
 357         p_filter->p_sys->d_old_factor = d_factor;
 358         p_filter->p_sys->i_old_wing   = i_filter_wing;
 359     }
 360     for( ; i_in < i_in_nb - i_filter_wing; i_in++ )
 361     {
 362         while( p_filter->p_sys->i_remainder < p_filter->output.i_rate )
 363         {
 364
 365             if( d_factor >= 1 )
 366             {
 367                 /* FilterFloatUP() is faster if we can use it */
 368
 369                 /* Perform left-wing inner product */
 370                 FilterFloatUP( SMALL_FILTER_FLOAT_IMP, SMALL_FILTER_FLOAT_IMPD,
 371                                SMALL_FILTER_NWING, p_in, p_out,
 372                                p_filter->p_sys->i_remainder,
 373                                p_filter->output.i_rate,
 374                                -1, i_nb_channels );
 375
 376                 /* Perform right-wing inner product */
 377                 FilterFloatUP( SMALL_FILTER_FLOAT_IMP, SMALL_FILTER_FLOAT_IMPD,
 378                                SMALL_FILTER_NWING, p_in + i_nb_channels, p_out,
 379                                p_filter->output.i_rate -
 380                                p_filter->p_sys->i_remainder,
 381                                p_filter->output.i_rate,
 382                                1, i_nb_channels );
 383
 384 #if 0
 385                 /* Normalize for unity filter gain */
 386                 for( i = 0; i < i_nb_channels; i++ )
 387                 {
 388                     *(p_out+i) *= d_old_scale_factor;
 389                 }
 390 #endif
 391                 /* Sanity check */
 392                 if( p_out_buf->i_size/p_filter->input.i_bytes_per_frame
 393                     <= (unsigned int)i_out+1 )
 394                 {
 395                     p_out += i_nb_channels;
 396                     i_out++;
 397                     p_filter->p_sys->i_remainder += p_filter->input.i_rate;
 398                     break;
 399                 }
 400             }
 401             else
 402             {
 403                 /* Perform left-wing inner product */
 404                 FilterFloatUD( SMALL_FILTER_FLOAT_IMP, SMALL_FILTER_FLOAT_IMPD,
 405                                SMALL_FILTER_NWING, p_in, p_out,
 406                                p_filter->p_sys->i_remainder,
 407                                p_filter->output.i_rate, p_filter->input.i_rate,
 408                                -1, i_nb_channels );
 409                 /* Perform right-wing inner product */
 410                 FilterFloatUD( SMALL_FILTER_FLOAT_IMP, SMALL_FILTER_FLOAT_IMPD,
 411                                SMALL_FILTER_NWING, p_in + i_nb_channels, p_out,
 412                                p_filter->output.i_rate -
 413                                p_filter->p_sys->i_remainder,
 414                                p_filter->output.i_rate, p_filter->input.i_rate,
 415                                1, i_nb_channels );
 416             }
 417
 418             p_out += i_nb_channels;
 419             i_out++;
 420
 421             p_filter->p_sys->i_remainder += p_filter->input.i_rate;
 422         }
 423
 424         p_in += i_nb_channels;
 425         p_filter->p_sys->i_remainder -= p_filter->output.i_rate;
 426     }
 427
 428     /* Buffer i_filter_wing * 2 samples for next time */
 429     if( p_filter->p_sys->i_old_wing )
 430     {
 431         memcpy( p_filter->p_sys->p_buf,
 432                 p_in_orig + (i_in_nb - 2 * p_filter->p_sys->i_old_wing) *
 433                 i_nb_channels, (2 * p_filter->p_sys->i_old_wing) *
 434                 p_filter->input.i_bytes_per_frame );
 435     }
 436
 437 #if 0
 438     msg_Err( p_filter, "p_out size: %i, nb bytes out: %i", p_out_buf->i_size,
 439              i_out * p_filter->input.i_bytes_per_frame );
 440 #endif
 441
 442     /* Free the temp buffer */
 443 #ifndef HAVE_ALLOCA
 444     free( p_in_orig );
 445 #endif
 446
 447     /* Finalize aout buffer */
 448     p_out_buf->i_nb_samples = i_out;
 449     p_out_buf->start_date = aout_DateGet( &p_filter->p_sys->end_date );
 450     p_out_buf->end_date = aout_DateIncrement( &p_filter->p_sys->end_date,
 451                                               p_out_buf->i_nb_samples );
 452
 453     p_out_buf->i_nb_bytes = p_out_buf->i_nb_samples *
 454         i_nb_channels * sizeof(int32_t);
 455
 456 }
 457
 458 void FilterFloatUP( float Imp[], float ImpD[], uint16_t Nwing, float *p_in,
 459                     float *p_out, uint32_t ui_remainder,
 460                     uint32_t ui_output_rate, int16_t Inc, int i_nb_channels )
 461 {
 462     float *Hp, *Hdp, *End;
 463     float t, temp;
 464     uint32_t ui_linear_remainder;
 465     int i;
 466
 467     Hp = &Imp[(ui_remainder<<Nhc)/ui_output_rate];
 468     Hdp = &ImpD[(ui_remainder<<Nhc)/ui_output_rate];
 469
 470     End = &Imp[Nwing];
 471
 472     ui_linear_remainder = (ui_remainder<<Nhc) -
 473                             (ui_remainder<<Nhc)/ui_output_rate*ui_output_rate;
 474
 475     if (Inc == 1)               /* If doing right wing...              */
 476     {                           /* ...drop extra coeff, so when Ph is  */
 477         End--;                  /*    0.5, we don't do too many mult's */
 478         if (ui_remainder == 0)  /* If the phase is zero...           */
 479         {                       /* ...then we've already skipped the */
 480             Hp += Npc;          /*    first sample, so we must also  */
 481             Hdp += Npc;         /*    skip ahead in Imp[] and ImpD[] */
 482         }
 483     }
 484
 485     while (Hp < End) {
 486         t = *Hp;                /* Get filter coeff */
 487                                 /* t is now interp'd filter coeff */
 488         t += *Hdp * ui_linear_remainder / ui_output_rate / Npc;
 489         for( i = 0; i < i_nb_channels; i++ )
 490         {
 491             temp = t;
 492             temp *= *(p_in+i);  /* Mult coeff by input sample */
 493             *(p_out+i) += temp; /* The filter output */
 494         }
 495         Hdp += Npc;             /* Filter coeff differences step */
 496         Hp += Npc;              /* Filter coeff step */
 497         p_in += (Inc * i_nb_channels); /* Input signal step */
 498     }
 499 }
 500
 501 void FilterFloatUD( float Imp[], float ImpD[], uint16_t Nwing, float *p_in,
 502                     float *p_out, uint32_t ui_remainder,
 503                     uint32_t ui_output_rate, uint32_t ui_input_rate,
 504                     int16_t Inc, int i_nb_channels )
 505 {
 506     float *Hp, *Hdp, *End;
 507     float t, temp;
 508     uint32_t ui_linear_remainder;
 509     int i, ui_counter = 0;
 510
 511     Hp = Imp + (ui_remainder<<Nhc) / ui_input_rate;
 512     Hdp = ImpD  + (ui_remainder<<Nhc) / ui_input_rate;
 513
 514     End = &Imp[Nwing];
 515
 516     if (Inc == 1)               /* If doing right wing...              */
 517     {                           /* ...drop extra coeff, so when Ph is  */
 518         End--;                  /*    0.5, we don't do too many mult's */
 519         if (ui_remainder == 0)  /* If the phase is zero...           */
 520         {                       /* ...then we've already skipped the */
 521             Hp = Imp +          /* first sample, so we must also  */
 522                   (ui_output_rate << Nhc) / ui_input_rate;
 523             Hdp = ImpD +        /* skip ahead in Imp[] and ImpD[] */
 524                   (ui_output_rate << Nhc) / ui_input_rate;
 525             ui_counter++;
 526         }
 527     }
 528
 529     while (Hp < End) {
 530         t = *Hp;                /* Get filter coeff */
 531                                 /* t is now interp'd filter coeff */
 532         ui_linear_remainder =
 533           ((ui_output_rate * ui_counter + ui_remainder)<< Nhc) -
 534           ((ui_output_rate * ui_counter + ui_remainder)<< Nhc) /
 535           ui_input_rate * ui_input_rate;
 536         t += *Hdp * ui_linear_remainder / ui_input_rate / Npc;
 537         for( i = 0; i < i_nb_channels; i++ )
 538         {
 539             temp = t;
 540             temp *= *(p_in+i);  /* Mult coeff by input sample */
 541             *(p_out+i) += temp; /* The filter output */
 542         }
 543
 544         ui_counter++;
 545
 546         /* Filter coeff step */
 547         Hp = Imp + ((ui_output_rate * ui_counter + ui_remainder)<< Nhc)
 548                     / ui_input_rate;
 549         /* Filter coeff differences step */
 550         Hdp = ImpD + ((ui_output_rate * ui_counter + ui_remainder)<< Nhc)
 551                      / ui_input_rate;
 552
 553         p_in += (Inc * i_nb_channels); /* Input signal step */
 554     }
 555 }