1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2004, 2006 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
33 #include "equalizer_presets.h"
35 * - add tables for other rates ( 22500, 11250, ...)
36 * - optimize a bit (you can hardly do slower ;)
37 * - add tables for more bands (15 and 32 would be cool), maybe with auto coeffs
38 * computation (not too hard once the Q is found).
39 * - support for external preset
40 * - callback to handle preset changes on the fly
44 /*****************************************************************************
46 *****************************************************************************/
47 static int Open ( vlc_object_t * );
48 static void Close( vlc_object_t * );
50 #define PRESET_TEXT N_( "Equalizer preset" )
51 #define PRESET_LONGTEXT N_("Preset to use for the equalizer." )
53 #define BANDS_TEXT N_( "Bands gain")
54 #define BANDS_LONGTEXT N_( \
55 "Don't use presets, but manually specified bands. You need to " \
56 "provide 10 values between -20dB and 20dB, separated by spaces, " \
57 "e.g. \"0 2 4 2 0 -2 -4 -2 0\"." )
59 #define TWOPASS_TEXT N_( "Two pass" )
60 #define TWOPASS_LONGTEXT N_( "Filter the audio twice. This provides a more " \
63 #define PREAMP_TEXT N_("Global gain" )
64 #define PREAMP_LONGTEXT N_("Set the global gain in dB (-20 ... 20)." )
67 set_description( _("Equalizer with 10 bands") );
68 set_shortname( _("Equalizer" ) );
69 set_capability( "audio filter", 0 );
70 set_category( CAT_AUDIO );
71 set_subcategory( SUBCAT_AUDIO_AFILTER );
73 add_string( "equalizer-preset", "flat", NULL, PRESET_TEXT,
74 PRESET_LONGTEXT, VLC_FALSE );
75 change_string_list( preset_list, preset_list_text, 0 );
76 add_string( "equalizer-bands", NULL, NULL, BANDS_TEXT,
77 BANDS_LONGTEXT, VLC_TRUE );
78 add_bool( "equalizer-2pass", 0, NULL, TWOPASS_TEXT,
79 TWOPASS_LONGTEXT, VLC_TRUE );
80 add_float( "equalizer-preamp", 12.0, NULL, PREAMP_TEXT,
81 PREAMP_LONGTEXT, VLC_TRUE );
82 set_callbacks( Open, Close );
83 add_shortcut( "equalizer" );
86 /*****************************************************************************
88 *****************************************************************************/
89 typedef struct aout_filter_sys_t
91 /* Filter static config */
101 /* Filter dyn config */
102 float *f_amp; /* Per band amp */
103 float f_gamp; /* Global preamp */
110 /* Second filter state */
112 float y2[32][128][2];
116 static void DoWork( aout_instance_t *, aout_filter_t *,
117 aout_buffer_t *, aout_buffer_t * );
119 #define EQZ_IN_FACTOR (0.25)
120 static int EqzInit( aout_filter_t *, int );
121 static void EqzFilter( aout_instance_t *,aout_filter_t *, float *, float *,
123 static void EqzClean( aout_filter_t * );
125 static int PresetCallback( vlc_object_t *, char const *,
126 vlc_value_t, vlc_value_t, void * );
127 static int PreampCallback( vlc_object_t *, char const *,
128 vlc_value_t, vlc_value_t, void * );
129 static int BandsCallback ( vlc_object_t *, char const *,
130 vlc_value_t, vlc_value_t, void * );
134 /*****************************************************************************
136 *****************************************************************************/
137 static int Open( vlc_object_t *p_this )
139 aout_filter_t *p_filter = (aout_filter_t *)p_this;
140 aout_filter_sys_t *p_sys;
141 vlc_bool_t b_fit = VLC_TRUE;
143 if( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' ) ||
144 p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
147 p_filter->input.i_format = VLC_FOURCC('f','l','3','2');
148 p_filter->output.i_format = VLC_FOURCC('f','l','3','2');
149 msg_Warn( p_filter, "bad input or output format" );
151 if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
154 memcpy( &p_filter->output, &p_filter->input,
155 sizeof(audio_sample_format_t) );
156 msg_Warn( p_filter, "input and output formats are not similar" );
164 p_filter->pf_do_work = DoWork;
165 p_filter->b_in_place = VLC_TRUE;
167 /* Allocate structure */
168 p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
170 if( EqzInit( p_filter, p_filter->input.i_rate ) )
176 /*****************************************************************************
177 * Close: close the plugin
178 *****************************************************************************/
179 static void Close( vlc_object_t *p_this )
181 aout_filter_t *p_filter = (aout_filter_t *)p_this;
182 aout_filter_sys_t *p_sys = p_filter->p_sys;
184 EqzClean( p_filter );
188 /*****************************************************************************
189 * DoWork: process samples buffer
190 *****************************************************************************
192 *****************************************************************************/
193 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
194 aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
196 p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
197 p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
199 EqzFilter( p_aout, p_filter, (float*)p_out_buf->p_buffer,
200 (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
201 aout_FormatNbChannels( &p_filter->input ) );
204 /*****************************************************************************
206 *****************************************************************************/
217 } band[EQZ_BANDS_MAX];
221 /* Value from equ-xmms */
222 static const eqz_config_t eqz_config_44100_10b =
226 { 60, 0.003013, 0.993973, 1.993901 },
227 { 170, 0.008490, 0.983019, 1.982437 },
228 { 310, 0.015374, 0.969252, 1.967331 },
229 { 600, 0.029328, 0.941343, 1.934254 },
230 { 1000, 0.047918, 0.904163, 1.884869 },
231 { 3000, 0.130408, 0.739184, 1.582718 },
232 { 6000, 0.226555, 0.546889, 1.015267 },
233 { 12000, 0.344937, 0.310127, -0.181410 },
234 { 14000, 0.366438, 0.267123, -0.521151 },
235 { 16000, 0.379009, 0.241981, -0.808451 },
238 static const eqz_config_t eqz_config_48000_10b =
242 { 60, 0.002769, 0.994462, 1.994400 },
243 { 170, 0.007806, 0.984388, 1.983897 },
244 { 310, 0.014143, 0.971714, 1.970091 },
245 { 600, 0.027011, 0.945978, 1.939979 },
246 { 1000, 0.044203, 0.911595, 1.895241 },
247 { 3000, 0.121223, 0.757553, 1.623767 },
248 { 6000, 0.212888, 0.574224, 1.113145 },
249 { 12000, 0.331347, 0.337307, 0.000000 },
250 { 14000, 0.355263, 0.289473, -0.333740 },
251 { 16000, 0.371900, 0.256201, -0.628100 }
255 static inline float EqzConvertdB( float db )
258 * (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)
259 * db = 20*log( out / in ) with out = in + amp*iir(i/EQZ_IN_FACTOR)
260 * or iir(i) == i for the center freq so
261 * db = 20*log( 1 + amp/EQZ_IN_FACTOR )
262 * -> amp = EQZ_IN_FACTOR*(10^(db/20) - 1)
269 return EQZ_IN_FACTOR * ( pow( 10, db / 20.0 ) - 1.0 );
272 static int EqzInit( aout_filter_t *p_filter, int i_rate )
274 aout_filter_sys_t *p_sys = p_filter->p_sys;
275 const eqz_config_t *p_cfg;
277 vlc_value_t val1, val2, val3;
278 aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
280 /* Select the config */
281 if( i_rate == 48000 )
283 p_cfg = &eqz_config_48000_10b;
285 else if( i_rate == 44100 )
287 p_cfg = &eqz_config_44100_10b;
291 /* TODO compute the coeffs on the fly */
292 msg_Err( p_filter, "rate not supported" );
296 /* Create the static filter config */
297 p_sys->i_band = p_cfg->i_band;
298 p_sys->f_alpha = malloc( p_sys->i_band * sizeof(float) );
299 p_sys->f_beta = malloc( p_sys->i_band * sizeof(float) );
300 p_sys->f_gamma = malloc( p_sys->i_band * sizeof(float) );
301 for( i = 0; i < p_sys->i_band; i++ )
303 p_sys->f_alpha[i] = p_cfg->band[i].f_alpha;
304 p_sys->f_beta[i] = p_cfg->band[i].f_beta;
305 p_sys->f_gamma[i] = p_cfg->band[i].f_gamma;
308 /* Filter dyn config */
309 p_sys->b_2eqz = VLC_FALSE;
311 p_sys->f_amp = malloc( p_sys->i_band * sizeof(float) );
312 for( i = 0; i < p_sys->i_band; i++ )
314 p_sys->f_amp[i] = 0.0;
318 for( ch = 0; ch < 32; ch++ )
323 p_sys->x2[ch][1] = 0.0;
325 for( i = 0; i < p_sys->i_band; i++ )
329 p_sys->y2[ch][i][0] =
330 p_sys->y2[ch][i][1] = 0.0;
334 var_CreateGetString( p_aout,"equalizer-bands" );
335 var_CreateGetString( p_aout, "equalizer-preset" );
337 p_sys->b_2eqz = var_CreateGetBool( p_aout, "equalizer-2pass" );
339 var_CreateGetFloat( p_aout, "equalizer-preamp" );
341 /* Get initial values */
342 var_Get( p_aout, "equalizer-preset", &val1 );
343 var_Get( p_aout, "equalizer-bands", &val2 );
344 var_Get( p_aout, "equalizer-preamp", &val3 );
346 p_sys->b_first = VLC_TRUE;
347 PresetCallback( VLC_OBJECT( p_aout ), NULL, val1, val1, p_sys );
348 BandsCallback( VLC_OBJECT( p_aout ), NULL, val2, val2, p_sys );
349 PreampCallback( VLC_OBJECT( p_aout ), NULL, val3, val3, p_sys );
350 p_sys->b_first = VLC_FALSE;
352 /* Register preset bands (for intf) if : */
353 /* We have no bands info --> the preset info must be given to the intf */
354 /* or The bands info matches the preset */
355 if (p_sys->psz_newbands == NULL)
357 msg_Err(p_filter, "No preset selected");
358 return (VLC_EGENERIC);
360 if( ( *(val2.psz_string) &&
361 strstr( p_sys->psz_newbands, val2.psz_string ) ) || !*val2.psz_string )
363 var_SetString( p_aout, "equalizer-bands", p_sys->psz_newbands );
364 if( p_sys->f_newpreamp == p_sys->f_gamp )
365 var_SetFloat( p_aout, "equalizer-preamp", p_sys->f_newpreamp );
368 /* Add our own callbacks */
369 var_AddCallback( p_aout, "equalizer-preset", PresetCallback, p_sys );
370 var_AddCallback( p_aout, "equalizer-bands", BandsCallback, p_sys );
371 var_AddCallback( p_aout, "equalizer-preamp", PreampCallback, p_sys );
373 msg_Dbg( p_filter, "equalizer loaded for %d Hz with %d bands %d pass",
374 i_rate, p_sys->i_band, p_sys->b_2eqz ? 2 : 1 );
375 for( i = 0; i < p_sys->i_band; i++ )
377 msg_Dbg( p_filter, " %d Hz -> factor:%f alpha:%f beta:%f gamma:%f",
378 (int)p_cfg->band[i].f_frequency, p_sys->f_amp[i],
379 p_sys->f_alpha[i], p_sys->f_beta[i], p_sys->f_gamma[i]);
384 static void EqzFilter( aout_instance_t *p_aout,
385 aout_filter_t *p_filter, float *out, float *in,
386 int i_samples, int i_channels )
388 aout_filter_sys_t *p_sys = p_filter->p_sys;
391 for( i = 0; i < i_samples; i++ )
393 for( ch = 0; ch < i_channels; ch++ )
395 const float x = in[ch];
398 for( j = 0; j < p_sys->i_band; j++ )
400 float y = p_sys->f_alpha[j] * ( x - p_sys->x[ch][1] ) +
401 p_sys->f_gamma[j] * p_sys->y[ch][j][0] -
402 p_sys->f_beta[j] * p_sys->y[ch][j][1];
404 p_sys->y[ch][j][1] = p_sys->y[ch][j][0];
405 p_sys->y[ch][j][0] = y;
407 o += y * p_sys->f_amp[j];
409 p_sys->x[ch][1] = p_sys->x[ch][0];
415 const float x2 = EQZ_IN_FACTOR * x + o;
417 for( j = 0; j < p_sys->i_band; j++ )
419 float y = p_sys->f_alpha[j] * ( x2 - p_sys->x2[ch][1] ) +
420 p_sys->f_gamma[j] * p_sys->y2[ch][j][0] -
421 p_sys->f_beta[j] * p_sys->y2[ch][j][1];
423 p_sys->y2[ch][j][1] = p_sys->y2[ch][j][0];
424 p_sys->y2[ch][j][0] = y;
426 o += y * p_sys->f_amp[j];
428 p_sys->x2[ch][1] = p_sys->x2[ch][0];
429 p_sys->x2[ch][0] = x2;
431 /* We add source PCM + filtered PCM */
432 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x2 + o );
436 /* We add source PCM + filtered PCM */
437 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x + o );
446 static void EqzClean( aout_filter_t *p_filter )
448 aout_filter_sys_t *p_sys = p_filter->p_sys;
450 var_DelCallback( (aout_instance_t *)p_filter->p_parent,
451 "equalizer-bands", BandsCallback, p_sys );
452 var_DelCallback( (aout_instance_t *)p_filter->p_parent,
453 "equalizer-preset", PresetCallback, p_sys );
454 var_DelCallback( (aout_instance_t *)p_filter->p_parent,
455 "equalizer-preamp", PreampCallback, p_sys );
457 free( p_sys->f_alpha );
458 free( p_sys->f_beta );
459 free( p_sys->f_gamma );
461 free( p_sys->f_amp );
465 static int PresetCallback( vlc_object_t *p_this, char const *psz_cmd,
466 vlc_value_t oldval, vlc_value_t newval, void *p_data )
468 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
469 aout_instance_t *p_aout = (aout_instance_t *)p_this;
471 char *psz_preset = newval.psz_string;
472 char psz_newbands[120];
474 memset( psz_newbands, 0, 120 );
476 if( *psz_preset && p_sys->i_band == 10 )
480 for( i = 0; eqz_preset_10b[i] != NULL; i++ )
482 if( !strcasecmp( eqz_preset_10b[i]->psz_name, psz_preset ) )
485 p_sys->f_gamp *= pow( 10, eqz_preset_10b[i]->f_preamp / 20.0 );
486 for( j = 0; j < p_sys->i_band; j++ )
489 p_sys->f_amp[j] = EqzConvertdB(
490 eqz_preset_10b[i]->f_amp[j] );
491 div = lldiv( eqz_preset_10b[i]->f_amp[j] * 10000000,
493 sprintf( psz_newbands, "%s "I64Fd".%07u", psz_newbands,
494 (int64_t)div.quot, (unsigned int) div.rem );
496 if( p_sys->b_first == VLC_FALSE )
498 var_SetString( p_aout, "equalizer-bands", psz_newbands );
499 var_SetFloat( p_aout, "equalizer-preamp",
500 eqz_preset_10b[i]->f_preamp );
504 p_sys->psz_newbands = strdup( psz_newbands );
505 p_sys->f_newpreamp = eqz_preset_10b[i]->f_preamp;
510 if( eqz_preset_10b[i] == NULL )
512 msg_Err( p_aout, "equalizer preset '%s' not found", psz_preset );
513 msg_Dbg( p_aout, "full list:" );
514 for( i = 0; eqz_preset_10b[i] != NULL; i++ )
515 msg_Dbg( p_aout, " - '%s'", eqz_preset_10b[i]->psz_name );
521 static int PreampCallback( vlc_object_t *p_this, char const *psz_cmd,
522 vlc_value_t oldval, vlc_value_t newval, void *p_data )
524 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
526 if( newval.f_float < -20.0 )
527 newval.f_float = -20.0;
528 else if( newval.f_float > 20.0 )
529 newval.f_float = 20.0;
530 p_sys->f_gamp = pow( 10, newval.f_float /20.0);
535 static int BandsCallback( vlc_object_t *p_this, char const *psz_cmd,
536 vlc_value_t oldval, vlc_value_t newval, void *p_data )
538 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
539 char *psz_bands = newval.psz_string;
541 /* Same thing for bands */
544 char *p = psz_bands, *p_next;
547 for( i = 0; i < p_sys->i_band; i++ )
551 float f = strtof( p, &p_next );
553 float f = (float) strtod( p, &p_next );
555 if( !p_next || p_next == p ) break; /* strtof() failed */
557 p_sys->f_amp[i] = EqzConvertdB( f );
559 if( !*p ) break; /* end of line */