1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2004-2009 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", false, 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];
124 static void DoWork( aout_instance_t *, aout_filter_t *,
125 aout_buffer_t *, aout_buffer_t * );
127 #define EQZ_IN_FACTOR (0.25)
128 static int EqzInit( aout_filter_t *, int );
129 static void EqzFilter( aout_filter_t *, float *, float *,
131 static void EqzClean( aout_filter_t * );
133 static int PresetCallback ( vlc_object_t *, char const *, vlc_value_t,
134 vlc_value_t, void * );
135 static int PreampCallback ( vlc_object_t *, char const *, vlc_value_t,
136 vlc_value_t, void * );
137 static int BandsCallback ( vlc_object_t *, char const *, vlc_value_t,
138 vlc_value_t, void * );
139 static int TwoPassCallback( vlc_object_t *, char const *, vlc_value_t,
140 vlc_value_t, void * );
144 /*****************************************************************************
146 *****************************************************************************/
147 static int Open( vlc_object_t *p_this )
149 aout_filter_t *p_filter = (aout_filter_t *)p_this;
150 aout_filter_sys_t *p_sys;
153 if( p_filter->fmt_in.audio.i_format != VLC_CODEC_FL32 ||
154 p_filter->fmt_out.audio.i_format != VLC_CODEC_FL32 )
157 p_filter->fmt_in.audio.i_format = VLC_CODEC_FL32;
158 p_filter->fmt_out.audio.i_format = VLC_CODEC_FL32;
159 msg_Warn( p_filter, "bad input or output format" );
161 if ( !AOUT_FMTS_SIMILAR( &p_filter->fmt_in.audio, &p_filter->fmt_out.audio ) )
164 memcpy( &p_filter->fmt_out.audio, &p_filter->fmt_in.audio,
165 sizeof(audio_sample_format_t) );
166 msg_Warn( p_filter, "input and output formats are not similar" );
174 p_filter->pf_do_work = DoWork;
175 p_filter->b_in_place = true;
177 /* Allocate structure */
178 p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
182 vlc_mutex_init( &p_sys->lock );
183 if( EqzInit( p_filter, p_filter->fmt_in.audio.i_rate ) != VLC_SUCCESS )
185 vlc_mutex_destroy( &p_sys->lock );
193 /*****************************************************************************
194 * Close: close the plugin
195 *****************************************************************************/
196 static void Close( vlc_object_t *p_this )
198 aout_filter_t *p_filter = (aout_filter_t *)p_this;
199 aout_filter_sys_t *p_sys = p_filter->p_sys;
201 EqzClean( p_filter );
202 vlc_mutex_destroy( &p_sys->lock );
206 /*****************************************************************************
207 * DoWork: process samples buffer
208 *****************************************************************************
210 *****************************************************************************/
211 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
212 aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
215 p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
216 p_out_buf->i_buffer = p_in_buf->i_buffer;
218 EqzFilter( p_filter, (float*)p_out_buf->p_buffer,
219 (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
220 aout_FormatNbChannels( &p_filter->fmt_in.audio ) );
223 /*****************************************************************************
225 *****************************************************************************/
236 } band[EQZ_BANDS_MAX];
240 /* Value from equ-xmms */
241 static const eqz_config_t eqz_config_44100_10b =
245 { 60, 0.003013, 0.993973, 1.993901 },
246 { 170, 0.008490, 0.983019, 1.982437 },
247 { 310, 0.015374, 0.969252, 1.967331 },
248 { 600, 0.029328, 0.941343, 1.934254 },
249 { 1000, 0.047918, 0.904163, 1.884869 },
250 { 3000, 0.130408, 0.739184, 1.582718 },
251 { 6000, 0.226555, 0.546889, 1.015267 },
252 { 12000, 0.344937, 0.310127, -0.181410 },
253 { 14000, 0.366438, 0.267123, -0.521151 },
254 { 16000, 0.379009, 0.241981, -0.808451 },
257 static const eqz_config_t eqz_config_48000_10b =
261 { 60, 0.002769, 0.994462, 1.994400 },
262 { 170, 0.007806, 0.984388, 1.983897 },
263 { 310, 0.014143, 0.971714, 1.970091 },
264 { 600, 0.027011, 0.945978, 1.939979 },
265 { 1000, 0.044203, 0.911595, 1.895241 },
266 { 3000, 0.121223, 0.757553, 1.623767 },
267 { 6000, 0.212888, 0.574224, 1.113145 },
268 { 12000, 0.331347, 0.337307, 0.000000 },
269 { 14000, 0.355263, 0.289473, -0.333740 },
270 { 16000, 0.371900, 0.256201, -0.628100 }
274 static inline float EqzConvertdB( float db )
277 * (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)
278 * db = 20*log( out / in ) with out = in + amp*iir(i/EQZ_IN_FACTOR)
279 * or iir(i) == i for the center freq so
280 * db = 20*log( 1 + amp/EQZ_IN_FACTOR )
281 * -> amp = EQZ_IN_FACTOR*(10^(db/20) - 1)
288 return EQZ_IN_FACTOR * ( pow( 10, db / 20.0 ) - 1.0 );
291 static int EqzInit( aout_filter_t *p_filter, int i_rate )
293 aout_filter_sys_t *p_sys = p_filter->p_sys;
294 const eqz_config_t *p_cfg;
296 vlc_value_t val1, val2, val3;
297 aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
298 int i_ret = VLC_ENOMEM;
300 /* Select the config */
301 if( i_rate == 48000 )
303 p_cfg = &eqz_config_48000_10b;
305 else if( i_rate == 44100 )
307 p_cfg = &eqz_config_44100_10b;
311 /* TODO compute the coeffs on the fly */
312 msg_Err( p_filter, "rate not supported" );
316 /* Create the static filter config */
317 p_sys->i_band = p_cfg->i_band;
318 p_sys->f_alpha = malloc( p_sys->i_band * sizeof(float) );
319 p_sys->f_beta = malloc( p_sys->i_band * sizeof(float) );
320 p_sys->f_gamma = malloc( p_sys->i_band * sizeof(float) );
321 if( !p_sys->f_alpha || !p_sys->f_beta || !p_sys->f_gamma )
324 for( i = 0; i < p_sys->i_band; i++ )
326 p_sys->f_alpha[i] = p_cfg->band[i].f_alpha;
327 p_sys->f_beta[i] = p_cfg->band[i].f_beta;
328 p_sys->f_gamma[i] = p_cfg->band[i].f_gamma;
331 /* Filter dyn config */
332 p_sys->b_2eqz = false;
334 p_sys->f_amp = malloc( p_sys->i_band * sizeof(float) );
338 for( i = 0; i < p_sys->i_band; i++ )
340 p_sys->f_amp[i] = 0.0;
344 for( ch = 0; ch < 32; ch++ )
349 p_sys->x2[ch][1] = 0.0;
351 for( i = 0; i < p_sys->i_band; i++ )
355 p_sys->y2[ch][i][0] =
356 p_sys->y2[ch][i][1] = 0.0;
360 var_Create( p_aout, "equalizer-bands", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
361 var_Create( p_aout, "equalizer-preset", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
363 p_sys->b_2eqz = var_CreateGetBool( p_aout, "equalizer-2pass" );
365 var_Create( p_aout, "equalizer-preamp", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
367 /* Get initial values */
368 var_Get( p_aout, "equalizer-preset", &val1 );
369 var_Get( p_aout, "equalizer-bands", &val2 );
370 var_Get( p_aout, "equalizer-preamp", &val3 );
372 p_sys->b_first = true;
373 PresetCallback( VLC_OBJECT( p_aout ), NULL, val1, val1, p_sys );
374 BandsCallback( VLC_OBJECT( p_aout ), NULL, val2, val2, p_sys );
375 PreampCallback( VLC_OBJECT( p_aout ), NULL, val3, val3, p_sys );
376 p_sys->b_first = false;
378 free( val1.psz_string );
380 /* Register preset bands (for intf) if : */
381 /* We have no bands info --> the preset info must be given to the intf */
382 /* or The bands info matches the preset */
383 if (p_sys->psz_newbands == NULL)
385 msg_Err(p_filter, "No preset selected");
386 free( val2.psz_string );
387 free( p_sys->f_amp );
388 i_ret = VLC_EGENERIC;
391 if( ( *(val2.psz_string) &&
392 strstr( p_sys->psz_newbands, val2.psz_string ) ) || !*val2.psz_string )
394 var_SetString( p_aout, "equalizer-bands", p_sys->psz_newbands );
395 if( p_sys->f_newpreamp == p_sys->f_gamp )
396 var_SetFloat( p_aout, "equalizer-preamp", p_sys->f_newpreamp );
398 free( val2.psz_string );
400 /* Add our own callbacks */
401 var_AddCallback( p_aout, "equalizer-preset", PresetCallback, p_sys );
402 var_AddCallback( p_aout, "equalizer-bands", BandsCallback, p_sys );
403 var_AddCallback( p_aout, "equalizer-preamp", PreampCallback, p_sys );
404 var_AddCallback( p_aout, "equalizer-2pass", TwoPassCallback, p_sys );
406 msg_Dbg( p_filter, "equalizer loaded for %d Hz with %d bands %d pass",
407 i_rate, p_sys->i_band, p_sys->b_2eqz ? 2 : 1 );
408 for( i = 0; i < p_sys->i_band; i++ )
410 msg_Dbg( p_filter, " %d Hz -> factor:%f alpha:%f beta:%f gamma:%f",
411 (int)p_cfg->band[i].f_frequency, p_sys->f_amp[i],
412 p_sys->f_alpha[i], p_sys->f_beta[i], p_sys->f_gamma[i]);
417 free( p_sys->f_alpha );
418 free( p_sys->f_beta );
419 free( p_sys->f_gamma );
423 static void EqzFilter( aout_filter_t *p_filter, float *out, float *in,
424 int i_samples, int i_channels )
426 aout_filter_sys_t *p_sys = p_filter->p_sys;
429 vlc_mutex_lock( &p_sys->lock );
430 for( i = 0; i < i_samples; i++ )
432 for( ch = 0; ch < i_channels; ch++ )
434 const float x = in[ch];
437 for( j = 0; j < p_sys->i_band; j++ )
439 float y = p_sys->f_alpha[j] * ( x - p_sys->x[ch][1] ) +
440 p_sys->f_gamma[j] * p_sys->y[ch][j][0] -
441 p_sys->f_beta[j] * p_sys->y[ch][j][1];
443 p_sys->y[ch][j][1] = p_sys->y[ch][j][0];
444 p_sys->y[ch][j][0] = y;
446 o += y * p_sys->f_amp[j];
448 p_sys->x[ch][1] = p_sys->x[ch][0];
454 const float x2 = EQZ_IN_FACTOR * x + o;
456 for( j = 0; j < p_sys->i_band; j++ )
458 float y = p_sys->f_alpha[j] * ( x2 - p_sys->x2[ch][1] ) +
459 p_sys->f_gamma[j] * p_sys->y2[ch][j][0] -
460 p_sys->f_beta[j] * p_sys->y2[ch][j][1];
462 p_sys->y2[ch][j][1] = p_sys->y2[ch][j][0];
463 p_sys->y2[ch][j][0] = y;
465 o += y * p_sys->f_amp[j];
467 p_sys->x2[ch][1] = p_sys->x2[ch][0];
468 p_sys->x2[ch][0] = x2;
470 /* We add source PCM + filtered PCM */
471 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x2 + o );
475 /* We add source PCM + filtered PCM */
476 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x + o );
483 vlc_mutex_unlock( &p_sys->lock );
486 static void EqzClean( aout_filter_t *p_filter )
488 aout_filter_sys_t *p_sys = p_filter->p_sys;
489 aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
491 var_DelCallback( p_aout, "equalizer-bands", BandsCallback, p_sys );
492 var_DelCallback( p_aout, "equalizer-preset", PresetCallback, p_sys );
493 var_DelCallback( p_aout, "equalizer-preamp", PreampCallback, p_sys );
494 var_DelCallback( p_aout, "equalizer-2pass", TwoPassCallback, p_sys );
496 free( p_sys->f_alpha );
497 free( p_sys->f_beta );
498 free( p_sys->f_gamma );
500 free( p_sys->f_amp );
501 free( p_sys->psz_newbands );
505 static int PresetCallback( vlc_object_t *p_this, char const *psz_cmd,
506 vlc_value_t oldval, vlc_value_t newval, void *p_data )
508 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
509 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
510 aout_instance_t *p_aout = (aout_instance_t *)p_this;
512 const char *psz_preset = newval.psz_string;
514 vlc_mutex_lock( &p_sys->lock );
515 if( !*psz_preset || p_sys->i_band != 10 )
517 vlc_mutex_unlock( &p_sys->lock );
521 for( unsigned i = 0; eqz_preset_10b[i] != NULL; i++ )
523 if( !strcasecmp( eqz_preset_10b[i]->psz_name, psz_preset ) )
525 char *psz_newbands = NULL;
527 p_sys->f_gamp *= pow( 10, eqz_preset_10b[i]->f_preamp / 20.0 );
528 for( int j = 0; j < p_sys->i_band; j++ )
533 p_sys->f_amp[j] = EqzConvertdB( eqz_preset_10b[i]->f_amp[j] );
534 d = lldiv( eqz_preset_10b[i]->f_amp[j] * 10000000, 10000000 );
535 if( asprintf( &psz, "%s %lld.%07llu",
536 psz_newbands ? psz_newbands : "",
537 d.quot, d.rem ) == -1 )
539 free( psz_newbands );
540 vlc_mutex_unlock( &p_sys->lock );
543 free( psz_newbands );
546 if( p_sys->b_first == false )
548 vlc_mutex_unlock( &p_sys->lock );
549 var_SetString( p_aout, "equalizer-bands", psz_newbands );
550 var_SetFloat( p_aout, "equalizer-preamp",
551 eqz_preset_10b[i]->f_preamp );
552 free( psz_newbands );
556 p_sys->psz_newbands = psz_newbands;
557 p_sys->f_newpreamp = eqz_preset_10b[i]->f_preamp;
558 vlc_mutex_unlock( &p_sys->lock );
563 msg_Err( p_aout, "equalizer preset '%s' not found", psz_preset );
564 msg_Info( p_aout, "full list:" );
565 for( unsigned i = 0; eqz_preset_10b[i] != NULL; i++ )
566 msg_Info( p_aout, " - '%s'", eqz_preset_10b[i]->psz_name );
570 static int PreampCallback( vlc_object_t *p_this, char const *psz_cmd,
571 vlc_value_t oldval, vlc_value_t newval, void *p_data )
573 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
574 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
576 if( newval.f_float < -20.0 )
577 newval.f_float = -20.0;
578 else if( newval.f_float > 20.0 )
579 newval.f_float = 20.0;
581 vlc_mutex_lock( &p_sys->lock );
582 p_sys->f_gamp = pow( 10, newval.f_float /20.0);
583 vlc_mutex_unlock( &p_sys->lock );
588 static int BandsCallback( vlc_object_t *p_this, char const *psz_cmd,
589 vlc_value_t oldval, vlc_value_t newval, void *p_data )
591 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
592 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
593 const char *psz_bands = newval.psz_string;
594 const char *p = psz_bands;
597 /* Same thing for bands */
598 vlc_mutex_lock( &p_sys->lock );
599 for( int i = 0; i < p_sys->i_band; i++ )
603 if( *psz_bands == '\0' )
607 f = us_strtof( p, &psz_next );
610 break; /* no conversion */
612 p_sys->f_amp[i] = EqzConvertdB( f );
614 if( *psz_next == '\0' )
615 break; /* end of line */
618 vlc_mutex_unlock( &p_sys->lock );
621 static int TwoPassCallback( vlc_object_t *p_this, char const *psz_cmd,
622 vlc_value_t oldval, vlc_value_t newval, void *p_data )
624 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
625 aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
627 vlc_mutex_lock( &p_sys->lock );
628 p_sys->b_2eqz = newval.b_bool;
629 vlc_mutex_unlock( &p_sys->lock );