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