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 *****************************************************************************/
37 #include "equalizer_presets.h"
39 * - add tables for other rates ( 22500, 11250, ...)
40 * - optimize a bit (you can hardly do slower ;)
41 * - add tables for more bands (15 and 32 would be cool), maybe with auto coeffs
42 * computation (not too hard once the Q is found).
43 * - support for external preset
44 * - callback to handle preset changes on the fly
48 /*****************************************************************************
50 *****************************************************************************/
51 static int Open ( vlc_object_t * );
52 static void Close( vlc_object_t * );
54 #define PRESET_TEXT N_( "Equalizer preset" )
55 #define PRESET_LONGTEXT N_("Preset to use for the equalizer." )
57 #define BANDS_TEXT N_( "Bands gain")
58 #define BANDS_LONGTEXT N_( \
59 "Don't use presets, but manually specified bands. You need to " \
60 "provide 10 values between -20dB and 20dB, separated by spaces, " \
61 "e.g. \"0 2 4 2 0 -2 -4 -2 0\"." )
63 #define TWOPASS_TEXT N_( "Two pass" )
64 #define TWOPASS_LONGTEXT N_( "Filter the audio twice. This provides a more " \
67 #define PREAMP_TEXT N_("Global gain" )
68 #define PREAMP_LONGTEXT N_("Set the global gain in dB (-20 ... 20)." )
71 set_description( _("Equalizer with 10 bands") );
72 set_shortname( _("Equalizer" ) );
73 set_capability( "audio filter", 0 );
74 set_category( CAT_AUDIO );
75 set_subcategory( SUBCAT_AUDIO_AFILTER );
77 add_string( "equalizer-preset", "flat", NULL, PRESET_TEXT,
78 PRESET_LONGTEXT, VLC_FALSE );
79 change_string_list( preset_list, preset_list_text, 0 );
80 add_string( "equalizer-bands", NULL, NULL, BANDS_TEXT,
81 BANDS_LONGTEXT, VLC_TRUE );
82 add_bool( "equalizer-2pass", 0, NULL, TWOPASS_TEXT,
83 TWOPASS_LONGTEXT, VLC_TRUE );
84 add_float( "equalizer-preamp", 12.0, NULL, PREAMP_TEXT,
85 PREAMP_LONGTEXT, VLC_TRUE );
86 set_callbacks( Open, Close );
87 add_shortcut( "equalizer" );
90 /*****************************************************************************
92 *****************************************************************************/
93 typedef struct aout_filter_sys_t
95 /* Filter static config */
105 /* Filter dyn config */
106 float *f_amp; /* Per band amp */
107 float f_gamp; /* Global preamp */
114 /* Second filter state */
116 float y2[32][128][2];
120 static void DoWork( aout_instance_t *, aout_filter_t *,
121 aout_buffer_t *, aout_buffer_t * );
123 #define EQZ_IN_FACTOR (0.25)
124 static int EqzInit( aout_filter_t *, int );
125 static void EqzFilter( aout_instance_t *,aout_filter_t *, float *, float *,
127 static void EqzClean( aout_filter_t * );
129 static int PresetCallback( vlc_object_t *, char const *,
130 vlc_value_t, vlc_value_t, void * );
131 static int PreampCallback( vlc_object_t *, char const *,
132 vlc_value_t, vlc_value_t, void * );
133 static int BandsCallback ( vlc_object_t *, char const *,
134 vlc_value_t, vlc_value_t, void * );
138 /*****************************************************************************
140 *****************************************************************************/
141 static int Open( vlc_object_t *p_this )
143 aout_filter_t *p_filter = (aout_filter_t *)p_this;
144 aout_filter_sys_t *p_sys;
145 vlc_bool_t b_fit = VLC_TRUE;
147 if( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' ) ||
148 p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
151 p_filter->input.i_format = VLC_FOURCC('f','l','3','2');
152 p_filter->output.i_format = VLC_FOURCC('f','l','3','2');
153 msg_Warn( p_filter, "bad input or output format" );
155 if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
158 memcpy( &p_filter->output, &p_filter->input,
159 sizeof(audio_sample_format_t) );
160 msg_Warn( p_filter, "input and output formats are not similar" );
168 p_filter->pf_do_work = DoWork;
169 p_filter->b_in_place = VLC_TRUE;
171 /* Allocate structure */
172 p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
174 if( EqzInit( p_filter, p_filter->input.i_rate ) )
180 /*****************************************************************************
181 * Close: close the plugin
182 *****************************************************************************/
183 static void Close( vlc_object_t *p_this )
185 aout_filter_t *p_filter = (aout_filter_t *)p_this;
186 aout_filter_sys_t *p_sys = p_filter->p_sys;
188 EqzClean( p_filter );
192 /*****************************************************************************
193 * DoWork: process samples buffer
194 *****************************************************************************
196 *****************************************************************************/
197 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
198 aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
200 p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
201 p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
203 EqzFilter( p_aout, p_filter, (float*)p_out_buf->p_buffer,
204 (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
205 aout_FormatNbChannels( &p_filter->input ) );
208 /*****************************************************************************
210 *****************************************************************************/
221 } band[EQZ_BANDS_MAX];
225 /* Value from equ-xmms */
226 static const eqz_config_t eqz_config_44100_10b =
230 { 60, 0.003013, 0.993973, 1.993901 },
231 { 170, 0.008490, 0.983019, 1.982437 },
232 { 310, 0.015374, 0.969252, 1.967331 },
233 { 600, 0.029328, 0.941343, 1.934254 },
234 { 1000, 0.047918, 0.904163, 1.884869 },
235 { 3000, 0.130408, 0.739184, 1.582718 },
236 { 6000, 0.226555, 0.546889, 1.015267 },
237 { 12000, 0.344937, 0.310127, -0.181410 },
238 { 14000, 0.366438, 0.267123, -0.521151 },
239 { 16000, 0.379009, 0.241981, -0.808451 },
242 static const eqz_config_t eqz_config_48000_10b =
246 { 60, 0.002769, 0.994462, 1.994400 },
247 { 170, 0.007806, 0.984388, 1.983897 },
248 { 310, 0.014143, 0.971714, 1.970091 },
249 { 600, 0.027011, 0.945978, 1.939979 },
250 { 1000, 0.044203, 0.911595, 1.895241 },
251 { 3000, 0.121223, 0.757553, 1.623767 },
252 { 6000, 0.212888, 0.574224, 1.113145 },
253 { 12000, 0.331347, 0.337307, 0.000000 },
254 { 14000, 0.355263, 0.289473, -0.333740 },
255 { 16000, 0.371900, 0.256201, -0.628100 }
259 static inline float EqzConvertdB( float db )
262 * (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)
263 * db = 20*log( out / in ) with out = in + amp*iir(i/EQZ_IN_FACTOR)
264 * or iir(i) == i for the center freq so
265 * db = 20*log( 1 + amp/EQZ_IN_FACTOR )
266 * -> amp = EQZ_IN_FACTOR*(10^(db/20) - 1)
273 return EQZ_IN_FACTOR * ( pow( 10, db / 20.0 ) - 1.0 );
276 static int EqzInit( aout_filter_t *p_filter, int i_rate )
278 aout_filter_sys_t *p_sys = p_filter->p_sys;
279 const eqz_config_t *p_cfg;
281 vlc_value_t val1, val2, val3;
282 aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
284 /* Select the config */
285 if( i_rate == 48000 )
287 p_cfg = &eqz_config_48000_10b;
289 else if( i_rate == 44100 )
291 p_cfg = &eqz_config_44100_10b;
295 /* TODO compute the coeffs on the fly */
296 msg_Err( p_filter, "rate not supported" );
300 /* Create the static filter config */
301 p_sys->i_band = p_cfg->i_band;
302 p_sys->f_alpha = malloc( p_sys->i_band * sizeof(float) );
303 p_sys->f_beta = malloc( p_sys->i_band * sizeof(float) );
304 p_sys->f_gamma = malloc( p_sys->i_band * sizeof(float) );
305 for( i = 0; i < p_sys->i_band; i++ )
307 p_sys->f_alpha[i] = p_cfg->band[i].f_alpha;
308 p_sys->f_beta[i] = p_cfg->band[i].f_beta;
309 p_sys->f_gamma[i] = p_cfg->band[i].f_gamma;
312 /* Filter dyn config */
313 p_sys->b_2eqz = VLC_FALSE;
315 p_sys->f_amp = malloc( p_sys->i_band * sizeof(float) );
316 for( i = 0; i < p_sys->i_band; i++ )
318 p_sys->f_amp[i] = 0.0;
322 for( ch = 0; ch < 32; ch++ )
327 p_sys->x2[ch][1] = 0.0;
329 for( i = 0; i < p_sys->i_band; i++ )
333 p_sys->y2[ch][i][0] =
334 p_sys->y2[ch][i][1] = 0.0;
338 var_CreateGetString( p_aout,"equalizer-bands" );
339 var_CreateGetString( p_aout, "equalizer-preset" );
341 p_sys->b_2eqz = var_CreateGetBool( p_aout, "equalizer-2pass" );
343 var_CreateGetFloat( p_aout, "equalizer-preamp" );
345 /* Get initial values */
346 var_Get( p_aout, "equalizer-preset", &val1 );
347 var_Get( p_aout, "equalizer-bands", &val2 );
348 var_Get( p_aout, "equalizer-preamp", &val3 );
350 p_sys->b_first = VLC_TRUE;
351 PresetCallback( VLC_OBJECT( p_aout ), NULL, val1, val1, p_sys );
352 BandsCallback( VLC_OBJECT( p_aout ), NULL, val2, val2, p_sys );
353 PreampCallback( VLC_OBJECT( p_aout ), NULL, val3, val3, p_sys );
354 p_sys->b_first = VLC_FALSE;
356 /* Register preset bands (for intf) if : */
357 /* We have no bands info --> the preset info must be given to the intf */
358 /* or The bands info matches the preset */
359 if (p_sys->psz_newbands == NULL)
361 msg_Err(p_filter, "No preset selected");
362 return (VLC_EGENERIC);
364 if( ( *(val2.psz_string) &&
365 strstr( p_sys->psz_newbands, val2.psz_string ) ) || !*val2.psz_string )
367 var_SetString( p_aout, "equalizer-bands", p_sys->psz_newbands );
368 if( p_sys->f_newpreamp == p_sys->f_gamp )
369 var_SetFloat( p_aout, "equalizer-preamp", p_sys->f_newpreamp );
372 /* Add our own callbacks */
373 var_AddCallback( p_aout, "equalizer-preset", PresetCallback, p_sys );
374 var_AddCallback( p_aout, "equalizer-bands", BandsCallback, p_sys );
375 var_AddCallback( p_aout, "equalizer-preamp", PreampCallback, p_sys );
377 msg_Dbg( p_filter, "equalizer loaded for %d Hz with %d bands %d pass",
378 i_rate, p_sys->i_band, p_sys->b_2eqz ? 2 : 1 );
379 for( i = 0; i < p_sys->i_band; i++ )
381 msg_Dbg( p_filter, " %d Hz -> factor:%f alpha:%f beta:%f gamma:%f",
382 (int)p_cfg->band[i].f_frequency, p_sys->f_amp[i],
383 p_sys->f_alpha[i], p_sys->f_beta[i], p_sys->f_gamma[i]);
388 static void EqzFilter( aout_instance_t *p_aout,
389 aout_filter_t *p_filter, float *out, float *in,
390 int i_samples, int i_channels )
392 aout_filter_sys_t *p_sys = p_filter->p_sys;
395 for( i = 0; i < i_samples; i++ )
397 for( ch = 0; ch < i_channels; ch++ )
399 const float x = in[ch];
402 for( j = 0; j < p_sys->i_band; j++ )
404 float y = p_sys->f_alpha[j] * ( x - p_sys->x[ch][1] ) +
405 p_sys->f_gamma[j] * p_sys->y[ch][j][0] -
406 p_sys->f_beta[j] * p_sys->y[ch][j][1];
408 p_sys->y[ch][j][1] = p_sys->y[ch][j][0];
409 p_sys->y[ch][j][0] = y;
411 o += y * p_sys->f_amp[j];
413 p_sys->x[ch][1] = p_sys->x[ch][0];
419 const float x2 = EQZ_IN_FACTOR * x + o;
421 for( j = 0; j < p_sys->i_band; j++ )
423 float y = p_sys->f_alpha[j] * ( x2 - p_sys->x2[ch][1] ) +
424 p_sys->f_gamma[j] * p_sys->y2[ch][j][0] -
425 p_sys->f_beta[j] * p_sys->y2[ch][j][1];
427 p_sys->y2[ch][j][1] = p_sys->y2[ch][j][0];
428 p_sys->y2[ch][j][0] = y;
430 o += y * p_sys->f_amp[j];
432 p_sys->x2[ch][1] = p_sys->x2[ch][0];
433 p_sys->x2[ch][0] = x2;
435 /* We add source PCM + filtered PCM */
436 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x2 + o );
440 /* We add source PCM + filtered PCM */
441 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x + o );
450 static void EqzClean( aout_filter_t *p_filter )
452 aout_filter_sys_t *p_sys = p_filter->p_sys;
454 var_DelCallback( (aout_instance_t *)p_filter->p_parent,
455 "equalizer-bands", BandsCallback, p_sys );
456 var_DelCallback( (aout_instance_t *)p_filter->p_parent,
457 "equalizer-preset", PresetCallback, p_sys );
458 var_DelCallback( (aout_instance_t *)p_filter->p_parent,
459 "equalizer-preamp", PreampCallback, p_sys );
461 free( p_sys->f_alpha );
462 free( p_sys->f_beta );
463 free( p_sys->f_gamma );
465 free( p_sys->f_amp );
469 static int PresetCallback( vlc_object_t *p_this, char const *psz_cmd,
470 vlc_value_t oldval, vlc_value_t newval, void *p_data )
472 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
473 aout_instance_t *p_aout = (aout_instance_t *)p_this;
475 char *psz_preset = newval.psz_string;
476 char psz_newbands[120];
478 memset( psz_newbands, 0, 120 );
480 if( *psz_preset && p_sys->i_band == 10 )
484 for( i = 0; eqz_preset_10b[i] != NULL; i++ )
486 if( !strcasecmp( eqz_preset_10b[i]->psz_name, psz_preset ) )
489 p_sys->f_gamp *= pow( 10, eqz_preset_10b[i]->f_preamp / 20.0 );
490 for( j = 0; j < p_sys->i_band; j++ )
493 p_sys->f_amp[j] = EqzConvertdB(
494 eqz_preset_10b[i]->f_amp[j] );
495 div = lldiv( eqz_preset_10b[i]->f_amp[j] * 10000000,
497 sprintf( psz_newbands, "%s "I64Fd".%07u", psz_newbands,
498 (int64_t)div.quot, (unsigned int) div.rem );
500 if( p_sys->b_first == VLC_FALSE )
502 var_SetString( p_aout, "equalizer-bands", psz_newbands );
503 var_SetFloat( p_aout, "equalizer-preamp",
504 eqz_preset_10b[i]->f_preamp );
508 p_sys->psz_newbands = strdup( psz_newbands );
509 p_sys->f_newpreamp = eqz_preset_10b[i]->f_preamp;
514 if( eqz_preset_10b[i] == NULL )
516 msg_Err( p_aout, "equalizer preset '%s' not found", psz_preset );
517 msg_Dbg( p_aout, "full list:" );
518 for( i = 0; eqz_preset_10b[i] != NULL; i++ )
519 msg_Dbg( p_aout, " - '%s'", eqz_preset_10b[i]->psz_name );
525 static int PreampCallback( vlc_object_t *p_this, char const *psz_cmd,
526 vlc_value_t oldval, vlc_value_t newval, void *p_data )
528 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
530 if( newval.f_float < -20.0 )
531 newval.f_float = -20.0;
532 else if( newval.f_float > 20.0 )
533 newval.f_float = 20.0;
534 p_sys->f_gamp = pow( 10, newval.f_float /20.0);
539 static int BandsCallback( vlc_object_t *p_this, char const *psz_cmd,
540 vlc_value_t oldval, vlc_value_t newval, void *p_data )
542 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
543 char *psz_bands = newval.psz_string;
545 /* Same thing for bands */
548 char *p = psz_bands, *p_next;
551 for( i = 0; i < p_sys->i_band; i++ )
555 float f = strtof( p, &p_next );
557 float f = (float) strtod( p, &p_next );
559 if( !p_next || p_next == p ) break; /* strtof() failed */
561 p_sys->f_amp[i] = EqzConvertdB( f );
563 if( !*p ) break; /* end of line */