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