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

   1 /*****************************************************************************
   2  * equalizer.c:
   3  *****************************************************************************
   4  * Copyright (C) 2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   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 #include <stdlib.h>                                      /* malloc(), free() */
  28 #include <math.h>
  29
  30 #include <vlc/vlc.h>
  31
  32 #include <vlc/aout.h>
  33 #include "aout_internal.h"
  34
  35 #include "equalizer_presets.h"
  36 /* TODO:
  37  *  - add tables for other rates ( 22500, 11250, ...)
  38  *  - optimize a bit (you can hardly do slower ;)
  39  *  - add tables for more bands (15 and 32 would be cool), maybe with auto coeffs
  40  *  computation (not too hard once the Q is found).
  41  *  - support for external preset
  42  *  - callback to handle preset changes on the fly
  43  *  - ...
  44  */
  45
  46 /*****************************************************************************
  47  * Module descriptor
  48  *****************************************************************************/
  49 static int  Open ( vlc_object_t * );
  50 static void Close( vlc_object_t * );
  51
  52 #define PRESET_TEXT N_( "Equalizer preset" )
  53 #define PRESET_LONGTEXT N_("Preset to use for the equalizer." )
  54
  55 #define BANDS_TEXT N_( "Bands gain")
  56 #define BANDS_LONGTEXT N_( \
  57          "Don't use presets, manually specify bands. You need to provide " \
  58          "10 values between -20dB and 20dB, separated by spaces, like " \
  59          "\"0 2 4 2 0 -2 -4 -2 0\"" )
  60
  61 #define TWOPASS_TEXT N_( "Two pass" )
  62 #define TWOPASS_LONGTEXT N_( "Filter twice the audio. This provides a more"  \
  63          "intense effect.")
  64
  65 #define PREAMP_TEXT N_("Global gain" )
  66 #define PREAMP_LONGTEXT N_("Set the global gain in dB (-20 ... 20)." )
  67
  68 vlc_module_begin();
  69     set_description( _("Equalizer 10 bands") );
  70     set_shortname( N_("Equalizer" ) );
  71     set_capability( "audio filter", 0 );
  72     set_category( CAT_AUDIO );
  73     set_subcategory( SUBCAT_AUDIO_AFILTER );
  74
  75     add_string( "equalizer-preset", "flat", NULL, PRESET_TEXT,
  76                 PRESET_LONGTEXT, VLC_FALSE );
  77         change_string_list( preset_list, preset_list_text, 0 );
  78     add_string( "equalizer-bands", NULL, NULL, BANDS_TEXT,
  79                 BANDS_LONGTEXT, VLC_TRUE );
  80     add_bool( "equalizer-2pass", 0, NULL, TWOPASS_TEXT,
  81               TWOPASS_LONGTEXT, VLC_TRUE );
  82     add_float( "equalizer-preamp", 12.0, NULL, PREAMP_TEXT,
  83                PREAMP_LONGTEXT, VLC_TRUE );
  84     set_callbacks( Open, Close );
  85     add_shortcut( "equalizer" );
  86 vlc_module_end();
  87
  88 /*****************************************************************************
  89  * Local prototypes
  90  *****************************************************************************/
  91 typedef struct aout_filter_sys_t
  92 {
  93     /* Filter static config */
  94     int i_band;
  95     float *f_alpha;
  96     float *f_beta;
  97     float *f_gamma;
  98
  99     float f_newpreamp;
 100     char *psz_newbands;
 101     vlc_bool_t b_first;
 102
 103     /* Filter dyn config */
 104     float *f_amp;   /* Per band amp */
 105     float f_gamp;   /* Global preamp */
 106     vlc_bool_t b_2eqz;
 107
 108     /* Filter state */
 109     float x[32][2];
 110     float y[32][128][2];
 111
 112     /* Second filter state */
 113     float x2[32][2];
 114     float y2[32][128][2];
 115
 116 } aout_filter_sys_t;
 117
 118 static void DoWork( aout_instance_t *, aout_filter_t *,
 119                     aout_buffer_t *, aout_buffer_t * );
 120
 121 #define EQZ_IN_FACTOR (0.25)
 122 static int  EqzInit( aout_filter_t *, int );
 123 static void EqzFilter( aout_instance_t *,aout_filter_t *, float *, float *,
 124                         int, int );
 125 static void EqzClean( aout_filter_t * );
 126
 127 static int PresetCallback( vlc_object_t *, char const *,
 128                                            vlc_value_t, vlc_value_t, void * );
 129 static int PreampCallback( vlc_object_t *, char const *,
 130                                            vlc_value_t, vlc_value_t, void * );
 131 static int BandsCallback ( vlc_object_t *, char const *,
 132                                            vlc_value_t, vlc_value_t, void * );
 133
 134
 135
 136 /*****************************************************************************
 137  * Open:
 138  *****************************************************************************/
 139 static int Open( vlc_object_t *p_this )
 140 {
 141     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
 142     aout_filter_sys_t *p_sys;
 143     vlc_bool_t         b_fit = VLC_TRUE;
 144
 145     if( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' ) ||
 146         p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
 147     {
 148         b_fit = VLC_FALSE;
 149         p_filter->input.i_format = VLC_FOURCC('f','l','3','2');
 150         p_filter->output.i_format = VLC_FOURCC('f','l','3','2');
 151         msg_Warn( p_filter, "Bad input or output format" );
 152     }
 153     if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
 154     {
 155         b_fit = VLC_FALSE;
 156         memcpy( &p_filter->output, &p_filter->input,
 157                 sizeof(audio_sample_format_t) );
 158         msg_Warn( p_filter, "input and output formats are not similar" );
 159     }
 160
 161     if ( ! b_fit )
 162     {
 163         return VLC_EGENERIC;
 164     }
 165
 166     p_filter->pf_do_work = DoWork;
 167     p_filter->b_in_place = VLC_TRUE;
 168
 169     /* Allocate structure */
 170     p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
 171
 172     if( EqzInit( p_filter, p_filter->input.i_rate ) )
 173         return VLC_EGENERIC;
 174
 175     return VLC_SUCCESS;
 176 }
 177
 178 /*****************************************************************************
 179  * Close: close the plugin
 180  *****************************************************************************/
 181 static void Close( vlc_object_t *p_this )
 182 {
 183     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
 184     aout_filter_sys_t *p_sys = p_filter->p_sys;
 185
 186     EqzClean( p_filter );
 187     free( p_sys );
 188 }
 189
 190 /*****************************************************************************
 191  * DoWork: process samples buffer
 192  *****************************************************************************
 193  *
 194  *****************************************************************************/
 195 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
 196                     aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
 197 {
 198     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
 199     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
 200
 201     EqzFilter( p_aout, p_filter, (float*)p_out_buf->p_buffer,
 202                (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
 203                aout_FormatNbChannels( &p_filter->input ) );
 204 }
 205
 206 /*****************************************************************************
 207  * Equalizer stuff
 208  *****************************************************************************/
 209 typedef struct
 210 {
 211     int   i_band;
 212
 213     struct
 214     {
 215         float f_frequency;
 216         float f_alpha;
 217         float f_beta;
 218         float f_gamma;
 219     } band[EQZ_BANDS_MAX];
 220
 221 } eqz_config_t;
 222
 223 /* Value from equ-xmms */
 224 static const eqz_config_t eqz_config_44100_10b =
 225 {
 226     10,
 227     {
 228         {    60, 0.003013, 0.993973, 1.993901 },
 229         {   170, 0.008490, 0.983019, 1.982437 },
 230         {   310, 0.015374, 0.969252, 1.967331 },
 231         {   600, 0.029328, 0.941343, 1.934254 },
 232         {  1000, 0.047918, 0.904163, 1.884869 },
 233         {  3000, 0.130408, 0.739184, 1.582718 },
 234         {  6000, 0.226555, 0.546889, 1.015267 },
 235         { 12000, 0.344937, 0.310127, -0.181410 },
 236         { 14000, 0.366438, 0.267123, -0.521151 },
 237         { 16000, 0.379009, 0.241981, -0.808451 },
 238     }
 239 };
 240 static const eqz_config_t eqz_config_48000_10b =
 241 {
 242     10,
 243     {
 244         {    60, 0.002769, 0.994462, 1.994400 },
 245         {   170, 0.007806, 0.984388, 1.983897 },
 246         {   310, 0.014143, 0.971714, 1.970091 },
 247         {   600, 0.027011, 0.945978, 1.939979 },
 248         {  1000, 0.044203, 0.911595, 1.895241 },
 249         {  3000, 0.121223, 0.757553, 1.623767 },
 250         {  6000, 0.212888, 0.574224, 1.113145 },
 251         { 12000, 0.331347, 0.337307, 0.000000 },
 252         { 14000, 0.355263, 0.289473, -0.333740 },
 253         { 16000, 0.371900, 0.256201, -0.628100 }
 254     }
 255 };
 256
 257 static inline float EqzConvertdB( float db )
 258 {
 259     /* Map it to gain,
 260      * (we do as if the input of iir is /EQZ_IN_FACTOR, but in fact it's the non iir data that is *EQZ_IN_FACTOR)
 261      * db = 20*log( out / in ) with out = in + amp*iir(i/EQZ_IN_FACTOR)
 262      * or iir(i) == i for the center freq so
 263      * db = 20*log( 1 + amp/EQZ_IN_FACTOR )
 264      * -> amp = EQZ_IN_FACTOR*(10^(db/20) - 1)
 265      **/
 266
 267     if( db < -20.0 )
 268         db = -20.0;
 269     else if(  db > 20.0 )
 270         db = 20.0;
 271     return EQZ_IN_FACTOR * ( pow( 10, db / 20.0 ) - 1.0 );
 272 }
 273
 274 static int EqzInit( aout_filter_t *p_filter, int i_rate )
 275 {
 276     aout_filter_sys_t *p_sys = p_filter->p_sys;
 277     const eqz_config_t *p_cfg;
 278     int i, ch;
 279     vlc_value_t val1, val2, val3;
 280     aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
 281
 282     /* Select the config */
 283     if( i_rate == 48000 )
 284     {
 285         p_cfg = &eqz_config_48000_10b;
 286     }
 287     else if( i_rate == 44100 )
 288     {
 289         p_cfg = &eqz_config_44100_10b;
 290     }
 291     else
 292     {
 293         /* TODO compute the coeffs on the fly */
 294         msg_Err( p_filter, "unsupported rate" );
 295         return VLC_EGENERIC;
 296     }
 297
 298     /* Create the static filter config */
 299     p_sys->i_band = p_cfg->i_band;
 300     p_sys->f_alpha = malloc( p_sys->i_band * sizeof(float) );
 301     p_sys->f_beta  = malloc( p_sys->i_band * sizeof(float) );
 302     p_sys->f_gamma = malloc( p_sys->i_band * sizeof(float) );
 303     for( i = 0; i < p_sys->i_band; i++ )
 304     {
 305         p_sys->f_alpha[i] = p_cfg->band[i].f_alpha;
 306         p_sys->f_beta[i]  = p_cfg->band[i].f_beta;
 307         p_sys->f_gamma[i] = p_cfg->band[i].f_gamma;
 308     }
 309
 310     /* Filter dyn config */
 311     p_sys->b_2eqz = VLC_FALSE;
 312     p_sys->f_gamp = 1.0;
 313     p_sys->f_amp   = malloc( p_sys->i_band * sizeof(float) );
 314     for( i = 0; i < p_sys->i_band; i++ )
 315     {
 316         p_sys->f_amp[i] = 0.0;
 317     }
 318
 319     /* Filter state */
 320     for( ch = 0; ch < 32; ch++ )
 321     {
 322         p_sys->x[ch][0]  =
 323         p_sys->x[ch][1]  =
 324         p_sys->x2[ch][0] =
 325         p_sys->x2[ch][1] = 0.0;
 326
 327         for( i = 0; i < p_sys->i_band; i++ )
 328         {
 329             p_sys->y[ch][i][0]  =
 330             p_sys->y[ch][i][1]  =
 331             p_sys->y2[ch][i][0] =
 332             p_sys->y2[ch][i][1] = 0.0;
 333         }
 334     }
 335
 336     var_CreateGetString( p_aout,"equalizer-bands" );
 337     var_CreateGetString( p_aout, "equalizer-preset" );
 338
 339     p_sys->b_2eqz = var_CreateGetBool( p_aout, "equalizer-2pass" );
 340
 341     var_CreateGetFloat( p_aout, "equalizer-preamp" );
 342
 343     /* Get initial values */
 344     var_Get( p_aout, "equalizer-preset", &val1 );
 345     var_Get( p_aout, "equalizer-bands", &val2 );
 346     var_Get( p_aout, "equalizer-preamp", &val3 );
 347
 348     p_sys->b_first = VLC_TRUE;
 349     PresetCallback( VLC_OBJECT( p_aout ), NULL, val1, val1, p_sys );
 350     BandsCallback(  VLC_OBJECT( p_aout ), NULL, val2, val2, p_sys );
 351     PreampCallback( VLC_OBJECT( p_aout ), NULL, val3, val3, p_sys );
 352     p_sys->b_first = VLC_FALSE;
 353
 354     /* Register preset bands (for intf) if : */
 355     /* We have no bands info --> the preset info must be given to the intf */
 356     /* or The bands info matches the preset */
 357     if (p_sys->psz_newbands == NULL)
 358     {
 359         msg_Err(p_filter, "No preset selected");
 360         return (VLC_EGENERIC);
 361     }
 362     if( ( *(val2.psz_string) &&
 363         strstr( p_sys->psz_newbands, val2.psz_string ) ) || !*val2.psz_string )
 364     {
 365         var_SetString( p_aout, "equalizer-bands", p_sys->psz_newbands );
 366         if( p_sys->f_newpreamp == p_sys->f_gamp )
 367             var_SetFloat( p_aout, "equalizer-preamp", p_sys->f_newpreamp );
 368     }
 369
 370     /* Add our own callbacks */
 371     var_AddCallback( p_aout, "equalizer-preset", PresetCallback, p_sys );
 372     var_AddCallback( p_aout, "equalizer-bands", BandsCallback, p_sys );
 373     var_AddCallback( p_aout, "equalizer-preamp", PreampCallback, p_sys );
 374
 375     msg_Dbg( p_filter, "equalizer loaded for %d Hz with %d bands %d pass",
 376                         i_rate, p_sys->i_band, p_sys->b_2eqz ? 2 : 1 );
 377     for( i = 0; i < p_sys->i_band; i++ )
 378     {
 379         msg_Dbg( p_filter, "   %d Hz -> factor:%f alpha:%f beta:%f gamma:%f",
 380                  (int)p_cfg->band[i].f_frequency, p_sys->f_amp[i],
 381                  p_sys->f_alpha[i], p_sys->f_beta[i], p_sys->f_gamma[i]);
 382     }
 383     return VLC_SUCCESS;
 384 }
 385
 386 static void EqzFilter( aout_instance_t *p_aout,
 387                        aout_filter_t *p_filter, float *out, float *in,
 388                        int i_samples, int i_channels )
 389 {
 390     aout_filter_sys_t *p_sys = p_filter->p_sys;
 391     int i, ch, j;
 392
 393     for( i = 0; i < i_samples; i++ )
 394     {
 395         for( ch = 0; ch < i_channels; ch++ )
 396         {
 397             const float x = in[ch];
 398             float o = 0.0;
 399
 400             for( j = 0; j < p_sys->i_band; j++ )
 401             {
 402                 float y = p_sys->f_alpha[j] * ( x - p_sys->x[ch][1] ) +
 403                           p_sys->f_gamma[j] * p_sys->y[ch][j][0] -
 404                           p_sys->f_beta[j]  * p_sys->y[ch][j][1];
 405
 406                 p_sys->y[ch][j][1] = p_sys->y[ch][j][0];
 407                 p_sys->y[ch][j][0] = y;
 408
 409                 o += y * p_sys->f_amp[j];
 410             }
 411             p_sys->x[ch][1] = p_sys->x[ch][0];
 412             p_sys->x[ch][0] = x;
 413
 414             /* Second filter */
 415             if( p_sys->b_2eqz )
 416             {
 417                 const float x2 = EQZ_IN_FACTOR * x + o;
 418                 o = 0.0;
 419                 for( j = 0; j < p_sys->i_band; j++ )
 420                 {
 421                     float y = p_sys->f_alpha[j] * ( x2 - p_sys->x2[ch][1] ) +
 422                               p_sys->f_gamma[j] * p_sys->y2[ch][j][0] -
 423                               p_sys->f_beta[j]  * p_sys->y2[ch][j][1];
 424
 425                     p_sys->y2[ch][j][1] = p_sys->y2[ch][j][0];
 426                     p_sys->y2[ch][j][0] = y;
 427
 428                     o += y * p_sys->f_amp[j];
 429                 }
 430                 p_sys->x2[ch][1] = p_sys->x2[ch][0];
 431                 p_sys->x2[ch][0] = x2;
 432
 433                 /* We add source PCM + filtered PCM */
 434                 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x2 + o );
 435             }
 436             else
 437             {
 438                 /* We add source PCM + filtered PCM */
 439                 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x + o );
 440             }
 441         }
 442
 443         in  += i_channels;
 444         out += i_channels;
 445     }
 446 }
 447
 448 static void EqzClean( aout_filter_t *p_filter )
 449 {
 450     aout_filter_sys_t *p_sys = p_filter->p_sys;
 451
 452     var_DelCallback( (aout_instance_t *)p_filter->p_parent,
 453                         "equalizer-bands", BandsCallback, p_sys );
 454     var_DelCallback( (aout_instance_t *)p_filter->p_parent,
 455                         "equalizer-preset", PresetCallback, p_sys );
 456     var_DelCallback( (aout_instance_t *)p_filter->p_parent,
 457                         "equalizer-preamp", PreampCallback, p_sys );
 458
 459     free( p_sys->f_alpha );
 460     free( p_sys->f_beta );
 461     free( p_sys->f_gamma );
 462
 463     free( p_sys->f_amp );
 464 }
 465
 466
 467 static int PresetCallback( vlc_object_t *p_this, char const *psz_cmd,
 468                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 469 {
 470     aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
 471     aout_instance_t *p_aout = (aout_instance_t *)p_this;
 472
 473     char *psz_preset = newval.psz_string;
 474     char psz_newbands[120];
 475
 476     memset( psz_newbands, 0, 120 );
 477
 478     if( *psz_preset && p_sys->i_band == 10 )
 479     {
 480         int i;
 481         /* */
 482         for( i = 0; eqz_preset_10b[i] != NULL; i++ )
 483         {
 484             if( !strcasecmp( eqz_preset_10b[i]->psz_name, psz_preset ) )
 485             {
 486                 int j;
 487                 p_sys->f_gamp *= pow( 10, eqz_preset_10b[i]->f_preamp / 20.0 );
 488                 for( j = 0; j < p_sys->i_band; j++ )
 489                 {
 490                     lldiv_t div;
 491                     p_sys->f_amp[j] = EqzConvertdB(
 492                                         eqz_preset_10b[i]->f_amp[j] );
 493                     div = lldiv( eqz_preset_10b[i]->f_amp[j] * 10000000,
 494                                  10000000 );
 495                     sprintf( psz_newbands, "%s "I64Fd".%07u", psz_newbands,
 496                                       div.quot, (unsigned int) div.rem );
 497                 }
 498                 if( p_sys->b_first == VLC_FALSE )
 499                 {
 500                     var_SetString( p_aout, "equalizer-bands", psz_newbands );
 501                     var_SetFloat( p_aout, "equalizer-preamp",
 502                                     eqz_preset_10b[i]->f_preamp );
 503                 }
 504                 else
 505                 {
 506                     p_sys->psz_newbands = strdup( psz_newbands );
 507                     p_sys->f_newpreamp = eqz_preset_10b[i]->f_preamp;
 508                 }
 509                 break;
 510             }
 511         }
 512         if( eqz_preset_10b[i] == NULL )
 513         {
 514             msg_Err( p_aout, "equalizer preset '%s' not found", psz_preset );
 515             msg_Dbg( p_aout, "full list:" );
 516             for( i = 0; eqz_preset_10b[i] != NULL; i++ )
 517                 msg_Dbg( p_aout, "  - '%s'", eqz_preset_10b[i]->psz_name );
 518         }
 519     }
 520     return VLC_SUCCESS;
 521 }
 522
 523 static int PreampCallback( vlc_object_t *p_this, char const *psz_cmd,
 524                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 525 {
 526     aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
 527
 528     if( newval.f_float < -20.0 )
 529         newval.f_float = -20.0;
 530     else if( newval.f_float > 20.0 )
 531         newval.f_float = 20.0;
 532     p_sys->f_gamp = pow( 10, newval.f_float /20.0);
 533
 534     return VLC_SUCCESS;
 535 }
 536
 537 static int BandsCallback( vlc_object_t *p_this, char const *psz_cmd,
 538                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 539 {
 540     aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
 541     char *psz_bands = newval.psz_string;
 542
 543     /* Same thing for bands */
 544     if( *psz_bands )
 545     {
 546         char *p = psz_bands, *p_next;
 547         int i;
 548
 549         for( i = 0; i < p_sys->i_band; i++ )
 550         {
 551             /* Read dB -20/20 */
 552 #ifdef HAVE_STRTOF
 553             float f = strtof( p, &p_next );
 554 #else
 555             float f = (float) strtod( p, &p_next );
 556 #endif
 557             if( !p_next || p_next == p ) break; /* strtof() failed */
 558
 559             p_sys->f_amp[i] = EqzConvertdB( f );
 560
 561             if( !*p ) break; /* end of line */
 562             p=p_next+1;
 563         }
 564     }
 565
 566     return VLC_SUCCESS;
 567 }