1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2004-2012 VLC authors and VideoLAN
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #include <vlc_charset.h>
39 #include <vlc_filter.h>
41 #include "equalizer_presets.h"
44 * - optimize a bit (you can hardly do slower ;)
45 * - add tables for more bands (15 and 32 would be cool), maybe with auto coeffs
46 * computation (not too hard once the Q is found).
47 * - support for external preset
48 * - callback to handle preset changes on the fly
52 /*****************************************************************************
54 *****************************************************************************/
55 static int Open ( vlc_object_t * );
56 static void Close( vlc_object_t * );
58 #define PRESET_TEXT N_( "Equalizer preset" )
59 #define PRESET_LONGTEXT N_("Preset to use for the equalizer." )
61 #define BANDS_TEXT N_( "Bands gain")
62 #define BANDS_LONGTEXT N_( \
63 "Don't use presets, but manually specified bands. You need to " \
64 "provide 10 values between -20dB and 20dB, separated by spaces, " \
65 "e.g. \"0 2 4 2 0 -2 -4 -2 0 2\"." )
67 #define VLC_BANDS_TEXT N_( "Use VLC frequency bands" )
68 #define VLC_BANDS_LONGTEXT N_( \
69 "Use the VLC frequency bands. Otherwise, use the ISO Standard " \
72 #define TWOPASS_TEXT N_( "Two pass" )
73 #define TWOPASS_LONGTEXT N_( "Filter the audio twice. This provides a more " \
76 #define PREAMP_TEXT N_("Global gain" )
77 #define PREAMP_LONGTEXT N_("Set the global gain in dB (-20 ... 20)." )
80 set_description( N_("Equalizer with 10 bands") )
81 set_shortname( N_("Equalizer" ) )
82 set_capability( "audio filter", 0 )
83 set_category( CAT_AUDIO )
84 set_subcategory( SUBCAT_AUDIO_AFILTER )
86 add_string( "equalizer-preset", "flat", PRESET_TEXT,
87 PRESET_LONGTEXT, false )
88 change_string_list( preset_list, preset_list_text )
89 add_string( "equalizer-bands", NULL, BANDS_TEXT,
90 BANDS_LONGTEXT, true )
91 add_bool( "equalizer-2pass", false, TWOPASS_TEXT,
92 TWOPASS_LONGTEXT, true )
93 add_bool( "equalizer-vlcfreqs", true, VLC_BANDS_TEXT,
94 VLC_BANDS_LONGTEXT, true )
95 add_float( "equalizer-preamp", 12.0, PREAMP_TEXT,
96 PREAMP_LONGTEXT, true )
97 set_callbacks( Open, Close )
98 add_shortcut( "equalizer" )
101 /*****************************************************************************
103 *****************************************************************************/
106 /* Filter static config */
116 /* Filter dyn config */
117 float *f_amp; /* Per band amp */
118 float f_gamp; /* Global preamp */
125 /* Second filter state */
127 float y2[32][128][2];
132 static block_t *DoWork( filter_t *, block_t * );
134 #define EQZ_IN_FACTOR (0.25)
135 static int EqzInit( filter_t *, int );
136 static void EqzFilter( filter_t *, float *, float *, int, int );
137 static void EqzClean( filter_t * );
139 static int PresetCallback ( vlc_object_t *, char const *, vlc_value_t,
140 vlc_value_t, void * );
141 static int PreampCallback ( vlc_object_t *, char const *, vlc_value_t,
142 vlc_value_t, void * );
143 static int BandsCallback ( vlc_object_t *, char const *, vlc_value_t,
144 vlc_value_t, void * );
145 static int TwoPassCallback( vlc_object_t *, char const *, vlc_value_t,
146 vlc_value_t, void * );
150 /*****************************************************************************
152 *****************************************************************************/
153 static int Open( vlc_object_t *p_this )
155 filter_t *p_filter = (filter_t *)p_this;
157 /* Allocate structure */
158 filter_sys_t *p_sys = p_filter->p_sys = malloc( sizeof( *p_sys ) );
162 vlc_mutex_init( &p_sys->lock );
163 if( EqzInit( p_filter, p_filter->fmt_in.audio.i_rate ) != VLC_SUCCESS )
165 vlc_mutex_destroy( &p_sys->lock );
170 p_filter->fmt_in.audio.i_format = VLC_CODEC_FL32;
171 p_filter->fmt_out.audio = p_filter->fmt_in.audio;
172 p_filter->pf_audio_filter = DoWork;
177 /*****************************************************************************
178 * Close: close the plugin
179 *****************************************************************************/
180 static void Close( vlc_object_t *p_this )
182 filter_t *p_filter = (filter_t *)p_this;
183 filter_sys_t *p_sys = p_filter->p_sys;
185 EqzClean( p_filter );
186 vlc_mutex_destroy( &p_sys->lock );
190 /*****************************************************************************
191 * DoWork: process samples buffer
192 *****************************************************************************
194 *****************************************************************************/
195 static block_t * DoWork( filter_t * p_filter, block_t * p_in_buf )
197 EqzFilter( p_filter, (float*)p_in_buf->p_buffer,
198 (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
199 aout_FormatNbChannels( &p_filter->fmt_in.audio ) );
203 /*****************************************************************************
205 *****************************************************************************/
216 } band[EQZ_BANDS_MAX];
220 /* The frequency tables */
221 static const float f_vlc_frequency_table_10b[EQZ_BANDS_MAX] =
223 60, 170, 310, 600, 1000, 3000, 6000, 12000, 14000, 16000,
226 static const float f_iso_frequency_table_10b[EQZ_BANDS_MAX] =
228 31.25, 62.5, 125, 250, 500, 1000, 2000, 4000, 8000, 16000,
231 /* Equalizer coefficient calculation function based on equ-xmms */
232 static void EqzCoeffs( int i_rate, float f_octave_percent,
233 bool b_use_vlc_freqs,
234 eqz_config_t *p_eqz_config )
236 const float *f_freq_table_10b = b_use_vlc_freqs
237 ? f_vlc_frequency_table_10b
238 : f_iso_frequency_table_10b;
239 float f_rate = (float) i_rate;
240 float f_nyquist_freq = 0.5 * f_rate;
241 float f_octave_factor = pow( 2.0, 0.5 * f_octave_percent );
242 float f_octave_factor_1 = 0.5 * ( f_octave_factor + 1.0 );
243 float f_octave_factor_2 = 0.5 * ( f_octave_factor - 1.0 );
245 p_eqz_config->i_band = EQZ_BANDS_MAX;
247 for( int i = 0; i < EQZ_BANDS_MAX; i++ )
249 float f_freq = f_freq_table_10b[i];
251 p_eqz_config->band[i].f_frequency = f_freq;
253 if( f_freq <= f_nyquist_freq )
255 float f_theta_1 = ( 2.0 * M_PI * f_freq ) / f_rate;
256 float f_theta_2 = f_theta_1 / f_octave_factor;
257 float f_sin = sin( f_theta_2 ) * 0.5;
258 float f_sin_prd = sin( f_theta_2 * f_octave_factor_1 )
259 * sin( f_theta_2 * f_octave_factor_2 );
260 /* The equation from equ-xmms simplifies to something similar to
261 * this when you restrict the domain to all valid frequencies at or
262 * below the Nyquist frequency (the interval 0 <= f_theta_1 <= Pi).
263 * (This result for the root is twice that returned by equ-xmms,
264 * but the more efficient calculations for alpha, beta, and gamma
265 * below compensate for this.) */
266 float f_root = ( f_sin - f_sin_prd ) / ( f_sin + f_sin_prd );
268 p_eqz_config->band[i].f_alpha = ( 1.0 - f_root ) * 0.5;
269 p_eqz_config->band[i].f_beta = f_root;
270 p_eqz_config->band[i].f_gamma = ( 1.0 + f_root ) * cos( f_theta_1 );
274 /* Any frequency beyond the Nyquist frequency is no good... */
275 p_eqz_config->band[i].f_alpha =
276 p_eqz_config->band[i].f_beta =
277 p_eqz_config->band[i].f_gamma = 0.0;
282 static inline float EqzConvertdB( float db )
285 * (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)
286 * db = 20*log( out / in ) with out = in + amp*iir(i/EQZ_IN_FACTOR)
287 * or iir(i) == i for the center freq so
288 * db = 20*log( 1 + amp/EQZ_IN_FACTOR )
289 * -> amp = EQZ_IN_FACTOR*(10^(db/20) - 1)
296 return EQZ_IN_FACTOR * ( pow( 10, db / 20.0 ) - 1.0 );
299 static int EqzInit( filter_t *p_filter, int i_rate )
301 filter_sys_t *p_sys = p_filter->p_sys;
304 vlc_value_t val1, val2, val3;
305 vlc_object_t *p_aout = p_filter->p_parent;
306 int i_ret = VLC_ENOMEM;
308 bool b_vlcFreqs = var_InheritBool( p_aout, "equalizer-vlcfreqs" );
309 EqzCoeffs( i_rate, 1.0, b_vlcFreqs, &cfg );
311 /* Create the static filter config */
312 p_sys->i_band = cfg.i_band;
313 p_sys->f_alpha = malloc( p_sys->i_band * sizeof(float) );
314 p_sys->f_beta = malloc( p_sys->i_band * sizeof(float) );
315 p_sys->f_gamma = malloc( p_sys->i_band * sizeof(float) );
316 if( !p_sys->f_alpha || !p_sys->f_beta || !p_sys->f_gamma )
319 for( i = 0; i < p_sys->i_band; i++ )
321 p_sys->f_alpha[i] = cfg.band[i].f_alpha;
322 p_sys->f_beta[i] = cfg.band[i].f_beta;
323 p_sys->f_gamma[i] = cfg.band[i].f_gamma;
326 /* Filter dyn config */
327 p_sys->b_2eqz = false;
329 p_sys->f_amp = malloc( p_sys->i_band * sizeof(float) );
333 for( i = 0; i < p_sys->i_band; i++ )
335 p_sys->f_amp[i] = 0.0;
339 for( ch = 0; ch < 32; ch++ )
344 p_sys->x2[ch][1] = 0.0;
346 for( i = 0; i < p_sys->i_band; i++ )
350 p_sys->y2[ch][i][0] =
351 p_sys->y2[ch][i][1] = 0.0;
355 var_Create( p_aout, "equalizer-bands", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
356 var_Create( p_aout, "equalizer-preset", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
358 p_sys->b_2eqz = var_CreateGetBool( p_aout, "equalizer-2pass" );
360 var_Create( p_aout, "equalizer-preamp", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
362 /* Get initial values */
363 var_Get( p_aout, "equalizer-preset", &val1 );
364 var_Get( p_aout, "equalizer-bands", &val2 );
365 var_Get( p_aout, "equalizer-preamp", &val3 );
367 p_sys->b_first = true;
368 PresetCallback( VLC_OBJECT( p_aout ), NULL, val1, val1, p_sys );
369 BandsCallback( VLC_OBJECT( p_aout ), NULL, val2, val2, p_sys );
370 PreampCallback( VLC_OBJECT( p_aout ), NULL, val3, val3, p_sys );
371 p_sys->b_first = false;
373 free( val1.psz_string );
375 /* Register preset bands (for intf) if : */
376 /* We have no bands info --> the preset info must be given to the intf */
377 /* or The bands info matches the preset */
378 if (p_sys->psz_newbands == NULL)
380 msg_Err(p_filter, "No preset selected");
381 free( val2.psz_string );
382 free( p_sys->f_amp );
383 i_ret = VLC_EGENERIC;
386 if( ( *(val2.psz_string) &&
387 strstr( p_sys->psz_newbands, val2.psz_string ) ) || !*val2.psz_string )
389 var_SetString( p_aout, "equalizer-bands", p_sys->psz_newbands );
390 if( p_sys->f_newpreamp == p_sys->f_gamp )
391 var_SetFloat( p_aout, "equalizer-preamp", p_sys->f_newpreamp );
393 free( val2.psz_string );
395 /* Add our own callbacks */
396 var_AddCallback( p_aout, "equalizer-preset", PresetCallback, p_sys );
397 var_AddCallback( p_aout, "equalizer-bands", BandsCallback, p_sys );
398 var_AddCallback( p_aout, "equalizer-preamp", PreampCallback, p_sys );
399 var_AddCallback( p_aout, "equalizer-2pass", TwoPassCallback, p_sys );
401 msg_Dbg( p_filter, "equalizer loaded for %d Hz with %d bands %d pass",
402 i_rate, p_sys->i_band, p_sys->b_2eqz ? 2 : 1 );
403 for( i = 0; i < p_sys->i_band; i++ )
405 msg_Dbg( p_filter, " %.2f Hz -> factor:%f alpha:%f beta:%f gamma:%f",
406 cfg.band[i].f_frequency, p_sys->f_amp[i],
407 p_sys->f_alpha[i], p_sys->f_beta[i], p_sys->f_gamma[i]);
412 free( p_sys->f_alpha );
413 free( p_sys->f_beta );
414 free( p_sys->f_gamma );
418 static void EqzFilter( filter_t *p_filter, float *out, float *in,
419 int i_samples, int i_channels )
421 filter_sys_t *p_sys = p_filter->p_sys;
424 vlc_mutex_lock( &p_sys->lock );
425 for( i = 0; i < i_samples; i++ )
427 for( ch = 0; ch < i_channels; ch++ )
429 const float x = in[ch];
432 for( j = 0; j < p_sys->i_band; j++ )
434 float y = p_sys->f_alpha[j] * ( x - p_sys->x[ch][1] ) +
435 p_sys->f_gamma[j] * p_sys->y[ch][j][0] -
436 p_sys->f_beta[j] * p_sys->y[ch][j][1];
438 p_sys->y[ch][j][1] = p_sys->y[ch][j][0];
439 p_sys->y[ch][j][0] = y;
441 o += y * p_sys->f_amp[j];
443 p_sys->x[ch][1] = p_sys->x[ch][0];
449 const float x2 = EQZ_IN_FACTOR * x + o;
451 for( j = 0; j < p_sys->i_band; j++ )
453 float y = p_sys->f_alpha[j] * ( x2 - p_sys->x2[ch][1] ) +
454 p_sys->f_gamma[j] * p_sys->y2[ch][j][0] -
455 p_sys->f_beta[j] * p_sys->y2[ch][j][1];
457 p_sys->y2[ch][j][1] = p_sys->y2[ch][j][0];
458 p_sys->y2[ch][j][0] = y;
460 o += y * p_sys->f_amp[j];
462 p_sys->x2[ch][1] = p_sys->x2[ch][0];
463 p_sys->x2[ch][0] = x2;
465 /* We add source PCM + filtered PCM */
466 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x2 + o );
470 /* We add source PCM + filtered PCM */
471 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x + o );
478 vlc_mutex_unlock( &p_sys->lock );
481 static void EqzClean( filter_t *p_filter )
483 filter_sys_t *p_sys = p_filter->p_sys;
484 vlc_object_t *p_aout = p_filter->p_parent;
486 var_DelCallback( p_aout, "equalizer-bands", BandsCallback, p_sys );
487 var_DelCallback( p_aout, "equalizer-preset", PresetCallback, p_sys );
488 var_DelCallback( p_aout, "equalizer-preamp", PreampCallback, p_sys );
489 var_DelCallback( p_aout, "equalizer-2pass", TwoPassCallback, p_sys );
491 free( p_sys->f_alpha );
492 free( p_sys->f_beta );
493 free( p_sys->f_gamma );
495 free( p_sys->f_amp );
496 free( p_sys->psz_newbands );
500 static int PresetCallback( vlc_object_t *p_aout, char const *psz_cmd,
501 vlc_value_t oldval, vlc_value_t newval, void *p_data )
503 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
504 filter_sys_t *p_sys = p_data;
506 const char *psz_preset = newval.psz_string;
508 vlc_mutex_lock( &p_sys->lock );
509 if( !*psz_preset || p_sys->i_band != 10 )
511 vlc_mutex_unlock( &p_sys->lock );
515 for( unsigned i = 0; i < NB_PRESETS; i++ )
517 if( !strcasecmp( eqz_preset_10b[i].psz_name, psz_preset ) )
519 char *psz_newbands = NULL;
521 p_sys->f_gamp *= pow( 10, eqz_preset_10b[i].f_preamp / 20.0 );
522 for( int j = 0; j < p_sys->i_band; j++ )
527 p_sys->f_amp[j] = EqzConvertdB( eqz_preset_10b[i].f_amp[j] );
528 d = lldiv( eqz_preset_10b[i].f_amp[j] * 10000000, 10000000 );
529 if( asprintf( &psz, "%s %lld.%07llu",
530 psz_newbands ? psz_newbands : "",
531 d.quot, d.rem ) == -1 )
533 free( psz_newbands );
534 vlc_mutex_unlock( &p_sys->lock );
537 free( psz_newbands );
540 if( !p_sys->b_first )
542 vlc_mutex_unlock( &p_sys->lock );
543 var_SetString( p_aout, "equalizer-bands", psz_newbands );
544 var_SetFloat( p_aout, "equalizer-preamp",
545 eqz_preset_10b[i].f_preamp );
546 free( psz_newbands );
550 p_sys->psz_newbands = psz_newbands;
551 p_sys->f_newpreamp = eqz_preset_10b[i].f_preamp;
552 vlc_mutex_unlock( &p_sys->lock );
557 vlc_mutex_unlock( &p_sys->lock );
558 msg_Err( p_aout, "equalizer preset '%s' not found", psz_preset );
559 msg_Info( p_aout, "full list:" );
560 for( unsigned i = 0; i < NB_PRESETS; i++ )
561 msg_Info( p_aout, " - '%s'", eqz_preset_10b[i].psz_name );
565 static int PreampCallback( vlc_object_t *p_this, char const *psz_cmd,
566 vlc_value_t oldval, vlc_value_t newval, void *p_data )
568 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
569 filter_sys_t *p_sys = p_data;
571 if( newval.f_float < -20.0 )
572 newval.f_float = -20.0;
573 else if( newval.f_float > 20.0 )
574 newval.f_float = 20.0;
576 vlc_mutex_lock( &p_sys->lock );
577 p_sys->f_gamp = pow( 10, newval.f_float /20.0);
578 vlc_mutex_unlock( &p_sys->lock );
583 static int BandsCallback( vlc_object_t *p_this, char const *psz_cmd,
584 vlc_value_t oldval, vlc_value_t newval, void *p_data )
586 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
587 filter_sys_t *p_sys = p_data;
588 const char *psz_bands = newval.psz_string;
589 const char *p = psz_bands;
592 /* Same thing for bands */
593 vlc_mutex_lock( &p_sys->lock );
594 for( int i = 0; i < p_sys->i_band; i++ )
598 if( *psz_bands == '\0' )
602 f = us_strtof( p, &psz_next );
605 break; /* no conversion */
607 p_sys->f_amp[i] = EqzConvertdB( f );
609 if( *psz_next == '\0' )
610 break; /* end of line */
613 vlc_mutex_unlock( &p_sys->lock );
616 static int TwoPassCallback( vlc_object_t *p_this, char const *psz_cmd,
617 vlc_value_t oldval, vlc_value_t newval, void *p_data )
619 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
620 filter_sys_t *p_sys = p_data;
622 vlc_mutex_lock( &p_sys->lock );
623 p_sys->b_2eqz = newval.b_bool;
624 vlc_mutex_unlock( &p_sys->lock );