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

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