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 /// \bug [String] missing dot
57 #define BANDS_LONGTEXT N_( \
58 "Don't use presets, but manually specified bands. You need to " \
59 "provide 10 values between -20dB and 20dB, separated by spaces, " \
60 "e.g. \"0 2 4 2 0 -2 -4 -2 0\"" )
62 #define TWOPASS_TEXT N_( "Two pass" )
63 #define TWOPASS_LONGTEXT N_( "Filter the audio twice. This provides a more " \
66 #define PREAMP_TEXT N_("Global gain" )
67 #define PREAMP_LONGTEXT N_("Set the global gain in dB (-20 ... 20)." )
70 set_description( _("Equalizer with 10 bands") );
71 set_shortname( _("Equalizer" ) );
72 set_capability( "audio filter", 0 );
73 set_category( CAT_AUDIO );
74 set_subcategory( SUBCAT_AUDIO_AFILTER );
76 add_string( "equalizer-preset", "flat", NULL, PRESET_TEXT,
77 PRESET_LONGTEXT, VLC_FALSE );
78 change_string_list( preset_list, preset_list_text, 0 );
79 add_string( "equalizer-bands", NULL, NULL, BANDS_TEXT,
80 BANDS_LONGTEXT, VLC_TRUE );
81 add_bool( "equalizer-2pass", 0, NULL, TWOPASS_TEXT,
82 TWOPASS_LONGTEXT, VLC_TRUE );
83 add_float( "equalizer-preamp", 12.0, NULL, PREAMP_TEXT,
84 PREAMP_LONGTEXT, VLC_TRUE );
85 set_callbacks( Open, Close );
86 add_shortcut( "equalizer" );
89 /*****************************************************************************
91 *****************************************************************************/
92 typedef struct aout_filter_sys_t
94 /* Filter static config */
104 /* Filter dyn config */
105 float *f_amp; /* Per band amp */
106 float f_gamp; /* Global preamp */
113 /* Second filter state */
115 float y2[32][128][2];
119 static void DoWork( aout_instance_t *, aout_filter_t *,
120 aout_buffer_t *, aout_buffer_t * );
122 #define EQZ_IN_FACTOR (0.25)
123 static int EqzInit( aout_filter_t *, int );
124 static void EqzFilter( aout_instance_t *,aout_filter_t *, float *, float *,
126 static void EqzClean( aout_filter_t * );
128 static int PresetCallback( vlc_object_t *, char const *,
129 vlc_value_t, vlc_value_t, void * );
130 static int PreampCallback( vlc_object_t *, char const *,
131 vlc_value_t, vlc_value_t, void * );
132 static int BandsCallback ( vlc_object_t *, char const *,
133 vlc_value_t, vlc_value_t, void * );
137 /*****************************************************************************
139 *****************************************************************************/
140 static int Open( vlc_object_t *p_this )
142 aout_filter_t *p_filter = (aout_filter_t *)p_this;
143 aout_filter_sys_t *p_sys;
144 vlc_bool_t b_fit = VLC_TRUE;
146 if( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' ) ||
147 p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
150 p_filter->input.i_format = VLC_FOURCC('f','l','3','2');
151 p_filter->output.i_format = VLC_FOURCC('f','l','3','2');
152 msg_Warn( p_filter, "bad input or output format" );
154 if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
157 memcpy( &p_filter->output, &p_filter->input,
158 sizeof(audio_sample_format_t) );
159 msg_Warn( p_filter, "input and output formats are not similar" );
167 p_filter->pf_do_work = DoWork;
168 p_filter->b_in_place = VLC_TRUE;
170 /* Allocate structure */
171 p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
173 if( EqzInit( p_filter, p_filter->input.i_rate ) )
179 /*****************************************************************************
180 * Close: close the plugin
181 *****************************************************************************/
182 static void Close( vlc_object_t *p_this )
184 aout_filter_t *p_filter = (aout_filter_t *)p_this;
185 aout_filter_sys_t *p_sys = p_filter->p_sys;
187 EqzClean( p_filter );
191 /*****************************************************************************
192 * DoWork: process samples buffer
193 *****************************************************************************
195 *****************************************************************************/
196 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
197 aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
199 p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
200 p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
202 EqzFilter( p_aout, p_filter, (float*)p_out_buf->p_buffer,
203 (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
204 aout_FormatNbChannels( &p_filter->input ) );
207 /*****************************************************************************
209 *****************************************************************************/
220 } band[EQZ_BANDS_MAX];
224 /* Value from equ-xmms */
225 static const eqz_config_t eqz_config_44100_10b =
229 { 60, 0.003013, 0.993973, 1.993901 },
230 { 170, 0.008490, 0.983019, 1.982437 },
231 { 310, 0.015374, 0.969252, 1.967331 },
232 { 600, 0.029328, 0.941343, 1.934254 },
233 { 1000, 0.047918, 0.904163, 1.884869 },
234 { 3000, 0.130408, 0.739184, 1.582718 },
235 { 6000, 0.226555, 0.546889, 1.015267 },
236 { 12000, 0.344937, 0.310127, -0.181410 },
237 { 14000, 0.366438, 0.267123, -0.521151 },
238 { 16000, 0.379009, 0.241981, -0.808451 },
241 static const eqz_config_t eqz_config_48000_10b =
245 { 60, 0.002769, 0.994462, 1.994400 },
246 { 170, 0.007806, 0.984388, 1.983897 },
247 { 310, 0.014143, 0.971714, 1.970091 },
248 { 600, 0.027011, 0.945978, 1.939979 },
249 { 1000, 0.044203, 0.911595, 1.895241 },
250 { 3000, 0.121223, 0.757553, 1.623767 },
251 { 6000, 0.212888, 0.574224, 1.113145 },
252 { 12000, 0.331347, 0.337307, 0.000000 },
253 { 14000, 0.355263, 0.289473, -0.333740 },
254 { 16000, 0.371900, 0.256201, -0.628100 }
258 static inline float EqzConvertdB( float db )
261 * (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)
262 * db = 20*log( out / in ) with out = in + amp*iir(i/EQZ_IN_FACTOR)
263 * or iir(i) == i for the center freq so
264 * db = 20*log( 1 + amp/EQZ_IN_FACTOR )
265 * -> amp = EQZ_IN_FACTOR*(10^(db/20) - 1)
272 return EQZ_IN_FACTOR * ( pow( 10, db / 20.0 ) - 1.0 );
275 static int EqzInit( aout_filter_t *p_filter, int i_rate )
277 aout_filter_sys_t *p_sys = p_filter->p_sys;
278 const eqz_config_t *p_cfg;
280 vlc_value_t val1, val2, val3;
281 aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
283 /* Select the config */
284 if( i_rate == 48000 )
286 p_cfg = &eqz_config_48000_10b;
288 else if( i_rate == 44100 )
290 p_cfg = &eqz_config_44100_10b;
294 /* TODO compute the coeffs on the fly */
295 msg_Err( p_filter, "rate not supported" );
299 /* Create the static filter config */
300 p_sys->i_band = p_cfg->i_band;
301 p_sys->f_alpha = malloc( p_sys->i_band * sizeof(float) );
302 p_sys->f_beta = malloc( p_sys->i_band * sizeof(float) );
303 p_sys->f_gamma = malloc( p_sys->i_band * sizeof(float) );
304 for( i = 0; i < p_sys->i_band; i++ )
306 p_sys->f_alpha[i] = p_cfg->band[i].f_alpha;
307 p_sys->f_beta[i] = p_cfg->band[i].f_beta;
308 p_sys->f_gamma[i] = p_cfg->band[i].f_gamma;
311 /* Filter dyn config */
312 p_sys->b_2eqz = VLC_FALSE;
314 p_sys->f_amp = malloc( p_sys->i_band * sizeof(float) );
315 for( i = 0; i < p_sys->i_band; i++ )
317 p_sys->f_amp[i] = 0.0;
321 for( ch = 0; ch < 32; ch++ )
326 p_sys->x2[ch][1] = 0.0;
328 for( i = 0; i < p_sys->i_band; i++ )
332 p_sys->y2[ch][i][0] =
333 p_sys->y2[ch][i][1] = 0.0;
337 var_CreateGetString( p_aout,"equalizer-bands" );
338 var_CreateGetString( p_aout, "equalizer-preset" );
340 p_sys->b_2eqz = var_CreateGetBool( p_aout, "equalizer-2pass" );
342 var_CreateGetFloat( p_aout, "equalizer-preamp" );
344 /* Get initial values */
345 var_Get( p_aout, "equalizer-preset", &val1 );
346 var_Get( p_aout, "equalizer-bands", &val2 );
347 var_Get( p_aout, "equalizer-preamp", &val3 );
349 p_sys->b_first = VLC_TRUE;
350 PresetCallback( VLC_OBJECT( p_aout ), NULL, val1, val1, p_sys );
351 BandsCallback( VLC_OBJECT( p_aout ), NULL, val2, val2, p_sys );
352 PreampCallback( VLC_OBJECT( p_aout ), NULL, val3, val3, p_sys );
353 p_sys->b_first = VLC_FALSE;
355 /* Register preset bands (for intf) if : */
356 /* We have no bands info --> the preset info must be given to the intf */
357 /* or The bands info matches the preset */
358 if (p_sys->psz_newbands == NULL)
360 msg_Err(p_filter, "No preset selected");
361 return (VLC_EGENERIC);
363 if( ( *(val2.psz_string) &&
364 strstr( p_sys->psz_newbands, val2.psz_string ) ) || !*val2.psz_string )
366 var_SetString( p_aout, "equalizer-bands", p_sys->psz_newbands );
367 if( p_sys->f_newpreamp == p_sys->f_gamp )
368 var_SetFloat( p_aout, "equalizer-preamp", p_sys->f_newpreamp );
371 /* Add our own callbacks */
372 var_AddCallback( p_aout, "equalizer-preset", PresetCallback, p_sys );
373 var_AddCallback( p_aout, "equalizer-bands", BandsCallback, p_sys );
374 var_AddCallback( p_aout, "equalizer-preamp", PreampCallback, p_sys );
376 msg_Dbg( p_filter, "equalizer loaded for %d Hz with %d bands %d pass",
377 i_rate, p_sys->i_band, p_sys->b_2eqz ? 2 : 1 );
378 for( i = 0; i < p_sys->i_band; i++ )
380 msg_Dbg( p_filter, " %d Hz -> factor:%f alpha:%f beta:%f gamma:%f",
381 (int)p_cfg->band[i].f_frequency, p_sys->f_amp[i],
382 p_sys->f_alpha[i], p_sys->f_beta[i], p_sys->f_gamma[i]);
387 static void EqzFilter( aout_instance_t *p_aout,
388 aout_filter_t *p_filter, float *out, float *in,
389 int i_samples, int i_channels )
391 aout_filter_sys_t *p_sys = p_filter->p_sys;
394 for( i = 0; i < i_samples; i++ )
396 for( ch = 0; ch < i_channels; ch++ )
398 const float x = in[ch];
401 for( j = 0; j < p_sys->i_band; j++ )
403 float y = p_sys->f_alpha[j] * ( x - p_sys->x[ch][1] ) +
404 p_sys->f_gamma[j] * p_sys->y[ch][j][0] -
405 p_sys->f_beta[j] * p_sys->y[ch][j][1];
407 p_sys->y[ch][j][1] = p_sys->y[ch][j][0];
408 p_sys->y[ch][j][0] = y;
410 o += y * p_sys->f_amp[j];
412 p_sys->x[ch][1] = p_sys->x[ch][0];
418 const float x2 = EQZ_IN_FACTOR * x + o;
420 for( j = 0; j < p_sys->i_band; j++ )
422 float y = p_sys->f_alpha[j] * ( x2 - p_sys->x2[ch][1] ) +
423 p_sys->f_gamma[j] * p_sys->y2[ch][j][0] -
424 p_sys->f_beta[j] * p_sys->y2[ch][j][1];
426 p_sys->y2[ch][j][1] = p_sys->y2[ch][j][0];
427 p_sys->y2[ch][j][0] = y;
429 o += y * p_sys->f_amp[j];
431 p_sys->x2[ch][1] = p_sys->x2[ch][0];
432 p_sys->x2[ch][0] = x2;
434 /* We add source PCM + filtered PCM */
435 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x2 + o );
439 /* We add source PCM + filtered PCM */
440 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x + o );
449 static void EqzClean( aout_filter_t *p_filter )
451 aout_filter_sys_t *p_sys = p_filter->p_sys;
453 var_DelCallback( (aout_instance_t *)p_filter->p_parent,
454 "equalizer-bands", BandsCallback, p_sys );
455 var_DelCallback( (aout_instance_t *)p_filter->p_parent,
456 "equalizer-preset", PresetCallback, p_sys );
457 var_DelCallback( (aout_instance_t *)p_filter->p_parent,
458 "equalizer-preamp", PreampCallback, p_sys );
460 free( p_sys->f_alpha );
461 free( p_sys->f_beta );
462 free( p_sys->f_gamma );
464 free( p_sys->f_amp );
468 static int PresetCallback( vlc_object_t *p_this, char const *psz_cmd,
469 vlc_value_t oldval, vlc_value_t newval, void *p_data )
471 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
472 aout_instance_t *p_aout = (aout_instance_t *)p_this;
474 char *psz_preset = newval.psz_string;
475 char psz_newbands[120];
477 memset( psz_newbands, 0, 120 );
479 if( *psz_preset && p_sys->i_band == 10 )
483 for( i = 0; eqz_preset_10b[i] != NULL; i++ )
485 if( !strcasecmp( eqz_preset_10b[i]->psz_name, psz_preset ) )
488 p_sys->f_gamp *= pow( 10, eqz_preset_10b[i]->f_preamp / 20.0 );
489 for( j = 0; j < p_sys->i_band; j++ )
492 p_sys->f_amp[j] = EqzConvertdB(
493 eqz_preset_10b[i]->f_amp[j] );
494 div = lldiv( eqz_preset_10b[i]->f_amp[j] * 10000000,
496 sprintf( psz_newbands, "%s "I64Fd".%07u", psz_newbands,
497 div.quot, (unsigned int) div.rem );
499 if( p_sys->b_first == VLC_FALSE )
501 var_SetString( p_aout, "equalizer-bands", psz_newbands );
502 var_SetFloat( p_aout, "equalizer-preamp",
503 eqz_preset_10b[i]->f_preamp );
507 p_sys->psz_newbands = strdup( psz_newbands );
508 p_sys->f_newpreamp = eqz_preset_10b[i]->f_preamp;
513 if( eqz_preset_10b[i] == NULL )
515 msg_Err( p_aout, "equalizer preset '%s' not found", psz_preset );
516 msg_Dbg( p_aout, "full list:" );
517 for( i = 0; eqz_preset_10b[i] != NULL; i++ )
518 msg_Dbg( p_aout, " - '%s'", eqz_preset_10b[i]->psz_name );
524 static int PreampCallback( vlc_object_t *p_this, char const *psz_cmd,
525 vlc_value_t oldval, vlc_value_t newval, void *p_data )
527 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
529 if( newval.f_float < -20.0 )
530 newval.f_float = -20.0;
531 else if( newval.f_float > 20.0 )
532 newval.f_float = 20.0;
533 p_sys->f_gamp = pow( 10, newval.f_float /20.0);
538 static int BandsCallback( vlc_object_t *p_this, char const *psz_cmd,
539 vlc_value_t oldval, vlc_value_t newval, void *p_data )
541 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
542 char *psz_bands = newval.psz_string;
544 /* Same thing for bands */
547 char *p = psz_bands, *p_next;
550 for( i = 0; i < p_sys->i_band; i++ )
554 float f = strtof( p, &p_next );
556 float f = (float) strtod( p, &p_next );
558 if( !p_next || p_next == p ) break; /* strtof() failed */
560 p_sys->f_amp[i] = EqzConvertdB( f );
562 if( !*p ) break; /* end of line */