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 *****************************************************************************/
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #include <vlc_charset.h>
40 #include "equalizer_presets.h"
42 * - add tables for other rates ( 22500, 11250, ...)
43 * - optimize a bit (you can hardly do slower ;)
44 * - add tables for more bands (15 and 32 would be cool), maybe with auto coeffs
45 * computation (not too hard once the Q is found).
46 * - support for external preset
47 * - callback to handle preset changes on the fly
51 /*****************************************************************************
53 *****************************************************************************/
54 static int Open ( vlc_object_t * );
55 static void Close( vlc_object_t * );
57 #define PRESET_TEXT N_( "Equalizer preset" )
58 #define PRESET_LONGTEXT N_("Preset to use for the equalizer." )
60 #define BANDS_TEXT N_( "Bands gain")
61 #define BANDS_LONGTEXT N_( \
62 "Don't use presets, but manually specified bands. You need to " \
63 "provide 10 values between -20dB and 20dB, separated by spaces, " \
64 "e.g. \"0 2 4 2 0 -2 -4 -2 0\"." )
66 #define TWOPASS_TEXT N_( "Two pass" )
67 #define TWOPASS_LONGTEXT N_( "Filter the audio twice. This provides a more " \
70 #define PREAMP_TEXT N_("Global gain" )
71 #define PREAMP_LONGTEXT N_("Set the global gain in dB (-20 ... 20)." )
74 set_description( N_("Equalizer with 10 bands") )
75 set_shortname( N_("Equalizer" ) )
76 set_capability( "audio filter", 0 )
77 set_category( CAT_AUDIO )
78 set_subcategory( SUBCAT_AUDIO_AFILTER )
80 add_string( "equalizer-preset", "flat", NULL, PRESET_TEXT,
81 PRESET_LONGTEXT, false )
82 change_string_list( preset_list, preset_list_text, 0 )
83 add_string( "equalizer-bands", NULL, NULL, BANDS_TEXT,
84 BANDS_LONGTEXT, true )
85 add_bool( "equalizer-2pass", 0, NULL, TWOPASS_TEXT,
86 TWOPASS_LONGTEXT, true )
87 add_float( "equalizer-preamp", 12.0, NULL, PREAMP_TEXT,
88 PREAMP_LONGTEXT, true )
89 set_callbacks( Open, Close )
90 add_shortcut( "equalizer" )
93 /*****************************************************************************
95 *****************************************************************************/
96 struct aout_filter_sys_t
98 /* Filter static config */
108 /* Filter dyn config */
109 float *f_amp; /* Per band amp */
110 float f_gamp; /* Global preamp */
117 /* Second filter state */
119 float y2[32][128][2];
123 static void DoWork( aout_instance_t *, aout_filter_t *,
124 aout_buffer_t *, aout_buffer_t * );
126 #define EQZ_IN_FACTOR (0.25)
127 static int EqzInit( aout_filter_t *, int );
128 static void EqzFilter( aout_filter_t *, float *, float *,
130 static void EqzClean( aout_filter_t * );
132 static int PresetCallback( vlc_object_t *, char const *,
133 vlc_value_t, vlc_value_t, void * );
134 static int PreampCallback( vlc_object_t *, char const *,
135 vlc_value_t, vlc_value_t, void * );
136 static int BandsCallback ( vlc_object_t *, char const *,
137 vlc_value_t, vlc_value_t, void * );
141 /*****************************************************************************
143 *****************************************************************************/
144 static int Open( vlc_object_t *p_this )
146 aout_filter_t *p_filter = (aout_filter_t *)p_this;
147 aout_filter_sys_t *p_sys;
150 if( p_filter->input.i_format != VLC_CODEC_FL32 ||
151 p_filter->output.i_format != VLC_CODEC_FL32 )
154 p_filter->input.i_format = VLC_CODEC_FL32;
155 p_filter->output.i_format = VLC_CODEC_FL32;
156 msg_Warn( p_filter, "bad input or output format" );
158 if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
161 memcpy( &p_filter->output, &p_filter->input,
162 sizeof(audio_sample_format_t) );
163 msg_Warn( p_filter, "input and output formats are not similar" );
171 p_filter->pf_do_work = DoWork;
172 p_filter->b_in_place = true;
174 /* Allocate structure */
175 p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
179 if( EqzInit( p_filter, p_filter->input.i_rate ) != VLC_SUCCESS )
188 /*****************************************************************************
189 * Close: close the plugin
190 *****************************************************************************/
191 static void Close( vlc_object_t *p_this )
193 aout_filter_t *p_filter = (aout_filter_t *)p_this;
194 aout_filter_sys_t *p_sys = p_filter->p_sys;
196 EqzClean( p_filter );
200 /*****************************************************************************
201 * DoWork: process samples buffer
202 *****************************************************************************
204 *****************************************************************************/
205 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
206 aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
209 p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
210 p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
212 EqzFilter( p_filter, (float*)p_out_buf->p_buffer,
213 (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
214 aout_FormatNbChannels( &p_filter->input ) );
217 /*****************************************************************************
219 *****************************************************************************/
230 } band[EQZ_BANDS_MAX];
234 /* Value from equ-xmms */
235 static const eqz_config_t eqz_config_44100_10b =
239 { 60, 0.003013, 0.993973, 1.993901 },
240 { 170, 0.008490, 0.983019, 1.982437 },
241 { 310, 0.015374, 0.969252, 1.967331 },
242 { 600, 0.029328, 0.941343, 1.934254 },
243 { 1000, 0.047918, 0.904163, 1.884869 },
244 { 3000, 0.130408, 0.739184, 1.582718 },
245 { 6000, 0.226555, 0.546889, 1.015267 },
246 { 12000, 0.344937, 0.310127, -0.181410 },
247 { 14000, 0.366438, 0.267123, -0.521151 },
248 { 16000, 0.379009, 0.241981, -0.808451 },
251 static const eqz_config_t eqz_config_48000_10b =
255 { 60, 0.002769, 0.994462, 1.994400 },
256 { 170, 0.007806, 0.984388, 1.983897 },
257 { 310, 0.014143, 0.971714, 1.970091 },
258 { 600, 0.027011, 0.945978, 1.939979 },
259 { 1000, 0.044203, 0.911595, 1.895241 },
260 { 3000, 0.121223, 0.757553, 1.623767 },
261 { 6000, 0.212888, 0.574224, 1.113145 },
262 { 12000, 0.331347, 0.337307, 0.000000 },
263 { 14000, 0.355263, 0.289473, -0.333740 },
264 { 16000, 0.371900, 0.256201, -0.628100 }
268 static inline float EqzConvertdB( float db )
271 * (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)
272 * db = 20*log( out / in ) with out = in + amp*iir(i/EQZ_IN_FACTOR)
273 * or iir(i) == i for the center freq so
274 * db = 20*log( 1 + amp/EQZ_IN_FACTOR )
275 * -> amp = EQZ_IN_FACTOR*(10^(db/20) - 1)
282 return EQZ_IN_FACTOR * ( pow( 10, db / 20.0 ) - 1.0 );
285 static int EqzInit( aout_filter_t *p_filter, int i_rate )
287 aout_filter_sys_t *p_sys = p_filter->p_sys;
288 const eqz_config_t *p_cfg;
290 vlc_value_t val1, val2, val3;
291 aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
293 /* Select the config */
294 if( i_rate == 48000 )
296 p_cfg = &eqz_config_48000_10b;
298 else if( i_rate == 44100 )
300 p_cfg = &eqz_config_44100_10b;
304 /* TODO compute the coeffs on the fly */
305 msg_Err( p_filter, "rate not supported" );
309 /* Create the static filter config */
310 p_sys->i_band = p_cfg->i_band;
311 p_sys->f_alpha = malloc( p_sys->i_band * sizeof(float) );
312 p_sys->f_beta = malloc( p_sys->i_band * sizeof(float) );
313 p_sys->f_gamma = malloc( p_sys->i_band * sizeof(float) );
314 if( !p_sys->f_alpha || !p_sys->f_beta || !p_sys->f_gamma )
316 free( p_sys->f_alpha );
317 free( p_sys->f_beta );
318 free( p_sys->f_gamma );
322 for( i = 0; i < p_sys->i_band; i++ )
324 p_sys->f_alpha[i] = p_cfg->band[i].f_alpha;
325 p_sys->f_beta[i] = p_cfg->band[i].f_beta;
326 p_sys->f_gamma[i] = p_cfg->band[i].f_gamma;
329 /* Filter dyn config */
330 p_sys->b_2eqz = false;
332 p_sys->f_amp = malloc( p_sys->i_band * sizeof(float) );
335 free( p_sys->f_alpha );
336 free( p_sys->f_beta );
337 free( p_sys->f_gamma );
340 for( i = 0; i < p_sys->i_band; i++ )
342 p_sys->f_amp[i] = 0.0;
346 for( ch = 0; ch < 32; ch++ )
351 p_sys->x2[ch][1] = 0.0;
353 for( i = 0; i < p_sys->i_band; i++ )
357 p_sys->y2[ch][i][0] =
358 p_sys->y2[ch][i][1] = 0.0;
362 var_Create( p_aout, "equalizer-bands", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
363 var_Create( p_aout, "equalizer-preset", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
365 p_sys->b_2eqz = var_CreateGetBool( p_aout, "equalizer-2pass" );
367 var_Create( p_aout, "equalizer-preamp", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
369 /* Get initial values */
370 var_Get( p_aout, "equalizer-preset", &val1 );
371 var_Get( p_aout, "equalizer-bands", &val2 );
372 var_Get( p_aout, "equalizer-preamp", &val3 );
374 p_sys->b_first = true;
375 PresetCallback( VLC_OBJECT( p_aout ), NULL, val1, val1, p_sys );
376 BandsCallback( VLC_OBJECT( p_aout ), NULL, val2, val2, p_sys );
377 PreampCallback( VLC_OBJECT( p_aout ), NULL, val3, val3, p_sys );
378 p_sys->b_first = false;
380 free( val1.psz_string );
382 /* Register preset bands (for intf) if : */
383 /* We have no bands info --> the preset info must be given to the intf */
384 /* or The bands info matches the preset */
385 if (p_sys->psz_newbands == NULL)
387 msg_Err(p_filter, "No preset selected");
388 free( val2.psz_string );
389 free( p_sys->f_amp );
390 free( p_sys->f_alpha );
391 free( p_sys->f_beta );
392 free( p_sys->f_gamma );
395 if( ( *(val2.psz_string) &&
396 strstr( p_sys->psz_newbands, val2.psz_string ) ) || !*val2.psz_string )
398 var_SetString( p_aout, "equalizer-bands", p_sys->psz_newbands );
399 if( p_sys->f_newpreamp == p_sys->f_gamp )
400 var_SetFloat( p_aout, "equalizer-preamp", p_sys->f_newpreamp );
402 free( val2.psz_string );
404 /* Add our own callbacks */
405 var_AddCallback( p_aout, "equalizer-preset", PresetCallback, p_sys );
406 var_AddCallback( p_aout, "equalizer-bands", BandsCallback, p_sys );
407 var_AddCallback( p_aout, "equalizer-preamp", PreampCallback, p_sys );
409 msg_Dbg( p_filter, "equalizer loaded for %d Hz with %d bands %d pass",
410 i_rate, p_sys->i_band, p_sys->b_2eqz ? 2 : 1 );
411 for( i = 0; i < p_sys->i_band; i++ )
413 msg_Dbg( p_filter, " %d Hz -> factor:%f alpha:%f beta:%f gamma:%f",
414 (int)p_cfg->band[i].f_frequency, p_sys->f_amp[i],
415 p_sys->f_alpha[i], p_sys->f_beta[i], p_sys->f_gamma[i]);
420 static void EqzFilter( aout_filter_t *p_filter, float *out, float *in,
421 int i_samples, int i_channels )
423 aout_filter_sys_t *p_sys = p_filter->p_sys;
426 for( i = 0; i < i_samples; i++ )
428 for( ch = 0; ch < i_channels; ch++ )
430 const float x = in[ch];
433 for( j = 0; j < p_sys->i_band; j++ )
435 float y = p_sys->f_alpha[j] * ( x - p_sys->x[ch][1] ) +
436 p_sys->f_gamma[j] * p_sys->y[ch][j][0] -
437 p_sys->f_beta[j] * p_sys->y[ch][j][1];
439 p_sys->y[ch][j][1] = p_sys->y[ch][j][0];
440 p_sys->y[ch][j][0] = y;
442 o += y * p_sys->f_amp[j];
444 p_sys->x[ch][1] = p_sys->x[ch][0];
450 const float x2 = EQZ_IN_FACTOR * x + o;
452 for( j = 0; j < p_sys->i_band; j++ )
454 float y = p_sys->f_alpha[j] * ( x2 - p_sys->x2[ch][1] ) +
455 p_sys->f_gamma[j] * p_sys->y2[ch][j][0] -
456 p_sys->f_beta[j] * p_sys->y2[ch][j][1];
458 p_sys->y2[ch][j][1] = p_sys->y2[ch][j][0];
459 p_sys->y2[ch][j][0] = y;
461 o += y * p_sys->f_amp[j];
463 p_sys->x2[ch][1] = p_sys->x2[ch][0];
464 p_sys->x2[ch][0] = x2;
466 /* We add source PCM + filtered PCM */
467 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x2 + o );
471 /* We add source PCM + filtered PCM */
472 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x + o );
481 static void EqzClean( aout_filter_t *p_filter )
483 aout_filter_sys_t *p_sys = p_filter->p_sys;
485 var_DelCallback( (aout_instance_t *)p_filter->p_parent,
486 "equalizer-bands", BandsCallback, p_sys );
487 var_DelCallback( (aout_instance_t *)p_filter->p_parent,
488 "equalizer-preset", PresetCallback, p_sys );
489 var_DelCallback( (aout_instance_t *)p_filter->p_parent,
490 "equalizer-preamp", PreampCallback, p_sys );
492 free( p_sys->f_alpha );
493 free( p_sys->f_beta );
494 free( p_sys->f_gamma );
496 free( p_sys->f_amp );
497 free( p_sys->psz_newbands );
501 static int PresetCallback( vlc_object_t *p_this, char const *psz_cmd,
502 vlc_value_t oldval, vlc_value_t newval, void *p_data )
504 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
505 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
506 aout_instance_t *p_aout = (aout_instance_t *)p_this;
508 char *psz_preset = newval.psz_string;
510 if( !*psz_preset || p_sys->i_band != 10 )
513 for( unsigned i = 0; eqz_preset_10b[i] != NULL; i++ )
515 if( !strcasecmp( eqz_preset_10b[i]->psz_name, psz_preset ) )
517 char *psz_newbands = NULL;
519 p_sys->f_gamp *= pow( 10, eqz_preset_10b[i]->f_preamp / 20.0 );
520 for( int j = 0; j < p_sys->i_band; j++ )
525 p_sys->f_amp[j] = EqzConvertdB( eqz_preset_10b[i]->f_amp[j] );
526 d = lldiv( eqz_preset_10b[i]->f_amp[j] * 10000000, 10000000 );
527 if( asprintf( &psz, "%s %lld.%07llu",
528 psz_newbands ? psz_newbands : "",
529 d.quot, d.rem ) == -1 )
531 free( psz_newbands );
536 if( p_sys->b_first == false )
538 var_SetString( p_aout, "equalizer-bands", psz_newbands );
539 var_SetFloat( p_aout, "equalizer-preamp",
540 eqz_preset_10b[i]->f_preamp );
541 free( psz_newbands );
545 p_sys->psz_newbands = psz_newbands;
546 p_sys->f_newpreamp = eqz_preset_10b[i]->f_preamp;
551 msg_Err( p_aout, "equalizer preset '%s' not found", psz_preset );
552 msg_Info( p_aout, "full list:" );
553 for( unsigned i = 0; eqz_preset_10b[i] != NULL; i++ )
554 msg_Info( p_aout, " - '%s'", eqz_preset_10b[i]->psz_name );
558 static int PreampCallback( vlc_object_t *p_this, char const *psz_cmd,
559 vlc_value_t oldval, vlc_value_t newval, void *p_data )
561 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
562 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
564 if( newval.f_float < -20.0 )
565 newval.f_float = -20.0;
566 else if( newval.f_float > 20.0 )
567 newval.f_float = 20.0;
568 p_sys->f_gamp = pow( 10, newval.f_float /20.0);
573 static int BandsCallback( vlc_object_t *p_this, char const *psz_cmd,
574 vlc_value_t oldval, vlc_value_t newval, void *p_data )
576 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
577 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
578 char *psz_bands = newval.psz_string;
583 /* Same thing for bands */
584 for( i = 0; i < p_sys->i_band; i++ )
588 if( *psz_bands == '\0' )
592 f = us_strtof( p, &psz_next );
595 break; /* no conversion */
597 p_sys->f_amp[i] = EqzConvertdB( f );
599 if( *psz_next == '\0' )
600 break; /* end of line */