1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2004 VideoLAN
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., 59 Temple Place - Suite 330, Boston, MA 02111, 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 PRESET_TEXT
55 #define BANDS_TEXT N_( "Bands gain")
56 #define BANDS_LONGTEXT N_( "Override preset bands gain in dB (-20 ... 20)" )
58 #define TWOPASS_TEXT N_( "Two pass" )
59 #define TWOPASS_LONGTEXT N_( "Filter twice the audio" )
61 #define PREAMP_TEXT N_("Global gain" )
62 #define PREAMP_LONGTEXT N_("Set the global gain in dB (-20 ... 20)" )
65 set_description( _("Equalizer 10 bands") );
66 set_capability( "audio filter", 0 );
67 set_category( CAT_AUDIO );
68 set_subcategory( SUBCAT_AUDIO_AFILTER );
70 add_string( "equalizer-preset", "flat", NULL, PRESET_TEXT,
71 PRESET_LONGTEXT, VLC_TRUE );
72 change_string_list( preset_list, preset_list_text, 0 );
73 add_string( "equalizer-bands", NULL, NULL, BANDS_TEXT,
74 BANDS_LONGTEXT, VLC_TRUE );
75 add_bool( "equalizer-2pass", 0, NULL, TWOPASS_TEXT,
76 TWOPASS_LONGTEXT, VLC_TRUE );
77 add_float( "equalizer-preamp", 12.0, NULL, PREAMP_TEXT,
78 PREAMP_LONGTEXT, VLC_TRUE );
79 set_callbacks( Open, Close );
80 add_shortcut( "equalizer" );
83 /*****************************************************************************
85 *****************************************************************************/
86 typedef struct aout_filter_sys_t
88 /* Filter static config */
98 /* Filter dyn config */
99 float *f_amp; /* Per band amp */
100 float f_gamp; /* Global preamp */
107 /* Second filter state */
109 float y2[32][128][2];
113 static void DoWork( aout_instance_t *, aout_filter_t *,
114 aout_buffer_t *, aout_buffer_t * );
116 #define EQZ_IN_FACTOR (0.25)
117 static int EqzInit( aout_filter_t *, int );
118 static void EqzFilter( aout_instance_t *,aout_filter_t *, float *, float *,
120 static void EqzClean( aout_filter_t * );
122 static int PresetCallback( vlc_object_t *, char const *,
123 vlc_value_t, vlc_value_t, void * );
124 static int PreampCallback( vlc_object_t *, char const *,
125 vlc_value_t, vlc_value_t, void * );
126 static int BandsCallback ( vlc_object_t *, char const *,
127 vlc_value_t, vlc_value_t, void * );
131 /*****************************************************************************
133 *****************************************************************************/
134 static int Open( vlc_object_t *p_this )
136 aout_filter_t *p_filter = (aout_filter_t *)p_this;
137 aout_filter_sys_t *p_sys;
139 if( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' ) ||
140 p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
142 msg_Warn( p_filter, "Bad input or output format" );
145 if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
147 msg_Warn( p_filter, "input and output formats are not similar" );
151 p_filter->pf_do_work = DoWork;
152 p_filter->b_in_place = VLC_TRUE;
154 /* Allocate structure */
155 p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
157 if( EqzInit( p_filter, p_filter->input.i_rate ) )
163 /*****************************************************************************
164 * Close: close the plugin
165 *****************************************************************************/
166 static void Close( vlc_object_t *p_this )
168 aout_filter_t *p_filter = (aout_filter_t *)p_this;
169 aout_filter_sys_t *p_sys = p_filter->p_sys;
171 EqzClean( p_filter );
175 /*****************************************************************************
176 * DoWork: process samples buffer
177 *****************************************************************************
179 *****************************************************************************/
180 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
181 aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
183 p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
184 p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
186 EqzFilter( p_aout, p_filter, (float*)p_out_buf->p_buffer,
187 (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
188 aout_FormatNbChannels( &p_filter->input ) );
191 /*****************************************************************************
193 *****************************************************************************/
204 } band[EQZ_BANDS_MAX];
208 /* Value from equ-xmms */
209 static const eqz_config_t eqz_config_44100_10b =
213 { 60, 0.003013, 0.993973, 1.993901 },
214 { 170, 0.008490, 0.983019, 1.982437 },
215 { 310, 0.015374, 0.969252, 1.967331 },
216 { 600, 0.029328, 0.941343, 1.934254 },
217 { 1000, 0.047918, 0.904163, 1.884869 },
218 { 3000, 0.130408, 0.739184, 1.582718 },
219 { 6000, 0.226555, 0.546889, 1.015267 },
220 { 12000, 0.344937, 0.310127, -0.181410 },
221 { 14000, 0.366438, 0.267123, -0.521151 },
222 { 16000, 0.379009, 0.241981, -0.808451 },
225 static const eqz_config_t eqz_config_48000_10b =
229 { 60, 0.002769, 0.994462, 1.994400 },
230 { 170, 0.007806, 0.984388, 1.983897 },
231 { 310, 0.014143, 0.971714, 1.970091 },
232 { 600, 0.027011, 0.945978, 1.939979 },
233 { 1000, 0.044203, 0.911595, 1.895241 },
234 { 3000, 0.121223, 0.757553, 1.623767 },
235 { 6000, 0.212888, 0.574224, 1.113145 },
236 { 12000, 0.331347, 0.337307, 0.000000 },
237 { 14000, 0.355263, 0.289473, -0.333740 },
238 { 16000, 0.371900, 0.256201, -0.628100 }
242 static inline float EqzConvertdB( float db )
245 * (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)
246 * db = 20*log( out / in ) with out = in + amp*iir(i/EQZ_IN_FACTOR)
247 * or iir(i) == i for the center freq so
248 * db = 20*log( 1 + amp/EQZ_IN_FACTOR )
249 * -> amp = EQZ_IN_FACTOR*(10^(db/20) - 1)
256 return EQZ_IN_FACTOR * ( pow( 10, db / 20.0 ) - 1.0 );
259 static int EqzInit( aout_filter_t *p_filter, int i_rate )
261 aout_filter_sys_t *p_sys = p_filter->p_sys;
262 const eqz_config_t *p_cfg;
264 vlc_value_t val1, val2, val3;
265 aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
267 /* Select the config */
268 if( i_rate == 48000 )
270 p_cfg = &eqz_config_48000_10b;
272 else if( i_rate == 44100 )
274 p_cfg = &eqz_config_44100_10b;
278 /* TODO compute the coeffs on the fly */
279 msg_Err( p_filter, "unsupported rate" );
283 /* Create the static filter config */
284 p_sys->i_band = p_cfg->i_band;
285 p_sys->f_alpha = malloc( p_sys->i_band * sizeof(float) );
286 p_sys->f_beta = malloc( p_sys->i_band * sizeof(float) );
287 p_sys->f_gamma = malloc( p_sys->i_band * sizeof(float) );
288 for( i = 0; i < p_sys->i_band; i++ )
290 p_sys->f_alpha[i] = p_cfg->band[i].f_alpha;
291 p_sys->f_beta[i] = p_cfg->band[i].f_beta;
292 p_sys->f_gamma[i] = p_cfg->band[i].f_gamma;
295 /* Filter dyn config */
296 p_sys->b_2eqz = VLC_FALSE;
298 p_sys->f_amp = malloc( p_sys->i_band * sizeof(float) );
299 for( i = 0; i < p_sys->i_band; i++ )
301 p_sys->f_amp[i] = 0.0;
305 for( ch = 0; ch < 32; ch++ )
310 p_sys->x2[ch][1] = 0.0;
312 for( i = 0; i < p_sys->i_band; i++ )
316 p_sys->y2[ch][i][0] =
317 p_sys->y2[ch][i][1] = 0.0;
321 var_CreateGetString( p_aout,"equalizer-bands" );
322 var_CreateGetString( p_aout, "equalizer-preset" );
324 p_sys->b_2eqz = var_CreateGetBool( p_aout, "equalizer-2pass" );
326 var_CreateGetFloat( p_aout, "equalizer-preamp" );
328 /* Get initial values */
329 var_Get( p_aout, "equalizer-preset", &val1 );
330 var_Get( p_aout, "equalizer-bands", &val2 );
331 var_Get( p_aout, "equalizer-preamp", &val3 );
333 p_sys->b_first = VLC_TRUE;
334 PresetCallback( VLC_OBJECT( p_aout ), NULL, val1, val1, p_sys );
335 BandsCallback( VLC_OBJECT( p_aout ), NULL, val2, val2, p_sys );
336 PreampCallback( VLC_OBJECT( p_aout ), NULL, val3, val3, p_sys );
337 p_sys->b_first = VLC_FALSE;
339 /* Register preset bands (for intf) if : */
340 /* We have no bands info --> the preset info must be given to the intf */
341 /* or The bands info matches the preset */
342 if (p_sys->psz_newbands == NULL)
344 msg_Err(p_filter, "No preset selected");
345 return (VLC_EGENERIC);
347 if( ( *(val2.psz_string) &&
348 strstr( p_sys->psz_newbands, val2.psz_string ) ) || !*val2.psz_string )
350 var_SetString( p_aout, "equalizer-bands", p_sys->psz_newbands );
351 var_SetFloat( p_aout, "equalizer-preamp", p_sys->f_newpreamp );
354 /* Add our own callbacks */
355 var_AddCallback( p_aout, "equalizer-preset", PresetCallback, p_sys );
356 var_AddCallback( p_aout, "equalizer-bands", BandsCallback, p_sys );
357 var_AddCallback( p_aout, "equalizer-preamp", PreampCallback, p_sys );
359 msg_Dbg( p_filter, "equalizer loaded for %d Hz with %d bands %d pass",
360 i_rate, p_sys->i_band, p_sys->b_2eqz ? 2 : 1 );
361 for( i = 0; i < p_sys->i_band; i++ )
363 msg_Dbg( p_filter, " %d Hz -> factor:%f alpha:%f beta:%f gamma:%f",
364 (int)p_cfg->band[i].f_frequency, p_sys->f_amp[i],
365 p_sys->f_alpha[i], p_sys->f_beta[i], p_sys->f_gamma[i]);
370 static void EqzFilter( aout_instance_t *p_aout,
371 aout_filter_t *p_filter, float *out, float *in,
372 int i_samples, int i_channels )
374 aout_filter_sys_t *p_sys = p_filter->p_sys;
377 for( i = 0; i < i_samples; i++ )
379 for( ch = 0; ch < i_channels; ch++ )
381 const float x = in[ch];
384 for( j = 0; j < p_sys->i_band; j++ )
386 float y = p_sys->f_alpha[j] * ( x - p_sys->x[ch][1] ) +
387 p_sys->f_gamma[j] * p_sys->y[ch][j][0] -
388 p_sys->f_beta[j] * p_sys->y[ch][j][1];
390 p_sys->y[ch][j][1] = p_sys->y[ch][j][0];
391 p_sys->y[ch][j][0] = y;
393 o += y * p_sys->f_amp[j];
395 p_sys->x[ch][1] = p_sys->x[ch][0];
401 const float x2 = EQZ_IN_FACTOR * x + o;
403 for( j = 0; j < p_sys->i_band; j++ )
405 float y = p_sys->f_alpha[j] * ( x2 - p_sys->x2[ch][1] ) +
406 p_sys->f_gamma[j] * p_sys->y2[ch][j][0] -
407 p_sys->f_beta[j] * p_sys->y2[ch][j][1];
409 p_sys->y2[ch][j][1] = p_sys->y2[ch][j][0];
410 p_sys->y2[ch][j][0] = y;
412 o += y * p_sys->f_amp[j];
414 p_sys->x2[ch][1] = p_sys->x2[ch][0];
415 p_sys->x2[ch][0] = x2;
417 /* We add source PCM + filtered PCM */
418 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x2 + o );
422 /* We add source PCM + filtered PCM */
423 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x + o );
432 static void EqzClean( aout_filter_t *p_filter )
434 aout_filter_sys_t *p_sys = p_filter->p_sys;
436 var_DelCallback( (aout_instance_t *)p_filter->p_parent,
437 "equalizer-bands", BandsCallback, p_sys );
438 var_DelCallback( (aout_instance_t *)p_filter->p_parent,
439 "equalizer-preset", PresetCallback, p_sys );
440 var_DelCallback( (aout_instance_t *)p_filter->p_parent,
441 "equalizer-preamp", PreampCallback, p_sys );
443 free( p_sys->f_alpha );
444 free( p_sys->f_beta );
445 free( p_sys->f_gamma );
447 free( p_sys->f_amp );
451 static int PresetCallback( vlc_object_t *p_this, char const *psz_cmd,
452 vlc_value_t oldval, vlc_value_t newval, void *p_data )
454 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
455 aout_instance_t *p_aout = (aout_instance_t *)p_this;
457 char *psz_preset = newval.psz_string;
458 char psz_newbands[120];
460 memset( psz_newbands, 0, 120 );
462 if( *psz_preset && p_sys->i_band == 10 )
466 for( i = 0; eqz_preset_10b[i] != NULL; i++ )
468 if( !strcasecmp( eqz_preset_10b[i]->psz_name, psz_preset ) )
471 p_sys->f_gamp *= pow( 10, eqz_preset_10b[i]->f_preamp / 20.0 );
472 for( j = 0; j < p_sys->i_band; j++ )
474 p_sys->f_amp[j] = EqzConvertdB(
475 eqz_preset_10b[i]->f_amp[j] );
476 sprintf( psz_newbands, "%s %f", psz_newbands,
477 eqz_preset_10b[i]->f_amp[j] );
479 if( p_sys->b_first == VLC_FALSE )
481 var_SetString( p_aout, "equalizer-bands", psz_newbands );
482 var_SetFloat( p_aout, "equalizer-preamp",
483 eqz_preset_10b[i]->f_preamp );
487 p_sys->psz_newbands = strdup( psz_newbands );
488 p_sys->f_newpreamp = eqz_preset_10b[i]->f_preamp;
493 if( eqz_preset_10b[i] == NULL )
495 msg_Err( p_aout, "equalizer preset '%s' not found", psz_preset );
496 msg_Dbg( p_aout, "full list:" );
497 for( i = 0; eqz_preset_10b[i] != NULL; i++ )
498 msg_Dbg( p_aout, " - '%s'", eqz_preset_10b[i]->psz_name );
504 static int PreampCallback( vlc_object_t *p_this, char const *psz_cmd,
505 vlc_value_t oldval, vlc_value_t newval, void *p_data )
507 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
509 if( newval.f_float < -20.0 )
510 newval.f_float = -20.0;
511 else if( newval.f_float > 20.0 )
512 newval.f_float = 20.0;
513 p_sys->f_gamp = pow( 10, newval.f_float /20.0);
518 static int BandsCallback( vlc_object_t *p_this, char const *psz_cmd,
519 vlc_value_t oldval, vlc_value_t newval, void *p_data )
521 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
522 char *psz_bands = newval.psz_string;
524 /* Same thing for bands */
527 char *p = psz_bands, *p_next;
530 for( i = 0; i < p_sys->i_band; i++ )
534 float f = strtof( p, &p_next );
536 float f = (float) strtod( p, &p_next );
538 if( !p_next || p_next == p ) break; /* strtof() failed */
540 p_sys->f_amp[i] = EqzConvertdB( f );
542 if( !*p ) break; /* end of line */