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 *****************************************************************************/
27 #include <stdlib.h> /* malloc(), free() */
33 #include "aout_internal.h"
35 #include "equalizer_presets.h"
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
46 /*****************************************************************************
48 *****************************************************************************/
49 static int Open ( vlc_object_t * );
50 static void Close( vlc_object_t * );
52 #define PRESET_TEXT N_( "Equalizer preset" )
53 #define PRESET_LONGTEXT N_("Preset to use for the equalizer." )
55 #define BANDS_TEXT N_( "Bands gain")
56 #define BANDS_LONGTEXT N_( \
57 "Don't use presets, but manually specified bands. You need to " \
58 "provide 10 values between -20dB and 20dB, separated by spaces, " \
59 "e.g. \"0 2 4 2 0 -2 -4 -2 0\"" )
61 #define TWOPASS_TEXT N_( "Two pass" )
62 #define TWOPASS_LONGTEXT N_( "Filter the audio twice. This provides a more " \
65 #define PREAMP_TEXT N_("Global gain" )
66 #define PREAMP_LONGTEXT N_("Set the global gain in dB (-20 ... 20)." )
69 set_description( _("Equalizer with 10 bands") );
70 set_shortname( N_("Equalizer" ) );
71 set_capability( "audio filter", 0 );
72 set_category( CAT_AUDIO );
73 set_subcategory( SUBCAT_AUDIO_AFILTER );
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" );
88 /*****************************************************************************
90 *****************************************************************************/
91 typedef struct aout_filter_sys_t
93 /* Filter static config */
103 /* Filter dyn config */
104 float *f_amp; /* Per band amp */
105 float f_gamp; /* Global preamp */
112 /* Second filter state */
114 float y2[32][128][2];
118 static void DoWork( aout_instance_t *, aout_filter_t *,
119 aout_buffer_t *, aout_buffer_t * );
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 *,
125 static void EqzClean( aout_filter_t * );
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 * );
136 /*****************************************************************************
138 *****************************************************************************/
139 static int Open( vlc_object_t *p_this )
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;
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') )
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" );
153 if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
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" );
166 p_filter->pf_do_work = DoWork;
167 p_filter->b_in_place = VLC_TRUE;
169 /* Allocate structure */
170 p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
172 if( EqzInit( p_filter, p_filter->input.i_rate ) )
178 /*****************************************************************************
179 * Close: close the plugin
180 *****************************************************************************/
181 static void Close( vlc_object_t *p_this )
183 aout_filter_t *p_filter = (aout_filter_t *)p_this;
184 aout_filter_sys_t *p_sys = p_filter->p_sys;
186 EqzClean( p_filter );
190 /*****************************************************************************
191 * DoWork: process samples buffer
192 *****************************************************************************
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 )
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;
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 ) );
206 /*****************************************************************************
208 *****************************************************************************/
219 } band[EQZ_BANDS_MAX];
223 /* Value from equ-xmms */
224 static const eqz_config_t eqz_config_44100_10b =
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 },
240 static const eqz_config_t eqz_config_48000_10b =
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 }
257 static inline float EqzConvertdB( float db )
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)
271 return EQZ_IN_FACTOR * ( pow( 10, db / 20.0 ) - 1.0 );
274 static int EqzInit( aout_filter_t *p_filter, int i_rate )
276 aout_filter_sys_t *p_sys = p_filter->p_sys;
277 const eqz_config_t *p_cfg;
279 vlc_value_t val1, val2, val3;
280 aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
282 /* Select the config */
283 if( i_rate == 48000 )
285 p_cfg = &eqz_config_48000_10b;
287 else if( i_rate == 44100 )
289 p_cfg = &eqz_config_44100_10b;
293 /* TODO compute the coeffs on the fly */
294 msg_Err( p_filter, "rate not supported" );
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++ )
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;
310 /* Filter dyn config */
311 p_sys->b_2eqz = VLC_FALSE;
313 p_sys->f_amp = malloc( p_sys->i_band * sizeof(float) );
314 for( i = 0; i < p_sys->i_band; i++ )
316 p_sys->f_amp[i] = 0.0;
320 for( ch = 0; ch < 32; ch++ )
325 p_sys->x2[ch][1] = 0.0;
327 for( i = 0; i < p_sys->i_band; i++ )
331 p_sys->y2[ch][i][0] =
332 p_sys->y2[ch][i][1] = 0.0;
336 var_CreateGetString( p_aout,"equalizer-bands" );
337 var_CreateGetString( p_aout, "equalizer-preset" );
339 p_sys->b_2eqz = var_CreateGetBool( p_aout, "equalizer-2pass" );
341 var_CreateGetFloat( p_aout, "equalizer-preamp" );
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 );
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;
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)
359 msg_Err(p_filter, "No preset selected");
360 return (VLC_EGENERIC);
362 if( ( *(val2.psz_string) &&
363 strstr( p_sys->psz_newbands, val2.psz_string ) ) || !*val2.psz_string )
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 );
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 );
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++ )
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]);
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 )
390 aout_filter_sys_t *p_sys = p_filter->p_sys;
393 for( i = 0; i < i_samples; i++ )
395 for( ch = 0; ch < i_channels; ch++ )
397 const float x = in[ch];
400 for( j = 0; j < p_sys->i_band; j++ )
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];
406 p_sys->y[ch][j][1] = p_sys->y[ch][j][0];
407 p_sys->y[ch][j][0] = y;
409 o += y * p_sys->f_amp[j];
411 p_sys->x[ch][1] = p_sys->x[ch][0];
417 const float x2 = EQZ_IN_FACTOR * x + o;
419 for( j = 0; j < p_sys->i_band; j++ )
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];
425 p_sys->y2[ch][j][1] = p_sys->y2[ch][j][0];
426 p_sys->y2[ch][j][0] = y;
428 o += y * p_sys->f_amp[j];
430 p_sys->x2[ch][1] = p_sys->x2[ch][0];
431 p_sys->x2[ch][0] = x2;
433 /* We add source PCM + filtered PCM */
434 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x2 + o );
438 /* We add source PCM + filtered PCM */
439 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x + o );
448 static void EqzClean( aout_filter_t *p_filter )
450 aout_filter_sys_t *p_sys = p_filter->p_sys;
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 );
459 free( p_sys->f_alpha );
460 free( p_sys->f_beta );
461 free( p_sys->f_gamma );
463 free( p_sys->f_amp );
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 )
470 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
471 aout_instance_t *p_aout = (aout_instance_t *)p_this;
473 char *psz_preset = newval.psz_string;
474 char psz_newbands[120];
476 memset( psz_newbands, 0, 120 );
478 if( *psz_preset && p_sys->i_band == 10 )
482 for( i = 0; eqz_preset_10b[i] != NULL; i++ )
484 if( !strcasecmp( eqz_preset_10b[i]->psz_name, psz_preset ) )
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++ )
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,
495 sprintf( psz_newbands, "%s "I64Fd".%07u", psz_newbands,
496 div.quot, (unsigned int) div.rem );
498 if( p_sys->b_first == VLC_FALSE )
500 var_SetString( p_aout, "equalizer-bands", psz_newbands );
501 var_SetFloat( p_aout, "equalizer-preamp",
502 eqz_preset_10b[i]->f_preamp );
506 p_sys->psz_newbands = strdup( psz_newbands );
507 p_sys->f_newpreamp = eqz_preset_10b[i]->f_preamp;
512 if( eqz_preset_10b[i] == NULL )
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 );
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 )
526 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
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);
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 )
540 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
541 char *psz_bands = newval.psz_string;
543 /* Same thing for bands */
546 char *p = psz_bands, *p_next;
549 for( i = 0; i < p_sys->i_band; i++ )
553 float f = strtof( p, &p_next );
555 float f = (float) strtod( p, &p_next );
557 if( !p_next || p_next == p ) break; /* strtof() failed */
559 p_sys->f_amp[i] = EqzConvertdB( f );
561 if( !*p ) break; /* end of line */