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>
39 #include <vlc_filter.h>
41 #include "equalizer_presets.h"
43 * - add tables for other rates ( 22500, 11250, ...)
44 * - optimize a bit (you can hardly do slower ;)
45 * - add tables for more bands (15 and 32 would be cool), maybe with auto coeffs
46 * computation (not too hard once the Q is found).
47 * - support for external preset
48 * - callback to handle preset changes on the fly
52 /*****************************************************************************
54 *****************************************************************************/
55 static int Open ( vlc_object_t
* );
56 static void Close( vlc_object_t
* );
58 #define PRESET_TEXT N_( "Equalizer preset" )
59 #define PRESET_LONGTEXT N_("Preset to use for the equalizer." )
61 #define BANDS_TEXT N_( "Bands gain")
62 #define BANDS_LONGTEXT N_( \
63 "Don't use presets, but manually specified bands. You need to " \
64 "provide 10 values between -20dB and 20dB, separated by spaces, " \
65 "e.g. \"0 2 4 2 0 -2 -4 -2 0 2\"." )
67 #define TWOPASS_TEXT N_( "Two pass" )
68 #define TWOPASS_LONGTEXT N_( "Filter the audio twice. This provides a more " \
71 #define PREAMP_TEXT N_("Global gain" )
72 #define PREAMP_LONGTEXT N_("Set the global gain in dB (-20 ... 20)." )
75 set_description( N_("Equalizer with 10 bands") )
76 set_shortname( N_("Equalizer" ) )
77 set_capability( "audio filter", 0 )
78 set_category( CAT_AUDIO
)
79 set_subcategory( SUBCAT_AUDIO_AFILTER
)
81 add_string( "equalizer-preset", "flat", PRESET_TEXT
,
82 PRESET_LONGTEXT
, false )
83 change_string_list( preset_list
, preset_list_text
, 0 )
84 add_string( "equalizer-bands", NULL
, BANDS_TEXT
,
85 BANDS_LONGTEXT
, true )
86 add_bool( "equalizer-2pass", false, NULL
, TWOPASS_TEXT
,
87 TWOPASS_LONGTEXT
, true )
88 add_float( "equalizer-preamp", 12.0, NULL
, PREAMP_TEXT
,
89 PREAMP_LONGTEXT
, true )
90 set_callbacks( Open
, Close
)
91 add_shortcut( "equalizer" )
94 /*****************************************************************************
96 *****************************************************************************/
99 /* Filter static config */
109 /* Filter dyn config */
110 float *f_amp
; /* Per band amp */
111 float f_gamp
; /* Global preamp */
118 /* Second filter state */
120 float y2
[32][128][2];
125 static block_t
*DoWork( filter_t
*, block_t
* );
127 #define EQZ_IN_FACTOR (0.25)
128 static int EqzInit( filter_t
*, int );
129 static void EqzFilter( filter_t
*, float *, float *, int, int );
130 static void EqzClean( filter_t
* );
132 static int PresetCallback ( vlc_object_t
*, char const *, vlc_value_t
,
133 vlc_value_t
, void * );
134 static int PreampCallback ( vlc_object_t
*, char const *, vlc_value_t
,
135 vlc_value_t
, void * );
136 static int BandsCallback ( vlc_object_t
*, char const *, vlc_value_t
,
137 vlc_value_t
, void * );
138 static int TwoPassCallback( vlc_object_t
*, char const *, vlc_value_t
,
139 vlc_value_t
, void * );
143 /*****************************************************************************
145 *****************************************************************************/
146 static int Open( vlc_object_t
*p_this
)
148 filter_t
*p_filter
= (filter_t
*)p_this
;
151 if( p_filter
->fmt_in
.audio
.i_format
!= VLC_CODEC_FL32
||
152 p_filter
->fmt_out
.audio
.i_format
!= VLC_CODEC_FL32
)
154 p_filter
->fmt_in
.audio
.i_format
= VLC_CODEC_FL32
;
155 p_filter
->fmt_out
.audio
.i_format
= VLC_CODEC_FL32
;
156 msg_Warn( p_filter
, "bad input or output format" );
159 if ( !AOUT_FMTS_SIMILAR( &p_filter
->fmt_in
.audio
, &p_filter
->fmt_out
.audio
) )
161 memcpy( &p_filter
->fmt_out
.audio
, &p_filter
->fmt_in
.audio
,
162 sizeof(audio_sample_format_t
) );
163 msg_Warn( p_filter
, "input and output formats are not similar" );
167 p_filter
->pf_audio_filter
= DoWork
;
169 /* Allocate structure */
170 p_sys
= p_filter
->p_sys
= malloc( sizeof( *p_sys
) );
174 vlc_mutex_init( &p_sys
->lock
);
175 if( EqzInit( p_filter
, p_filter
->fmt_in
.audio
.i_rate
) != VLC_SUCCESS
)
177 vlc_mutex_destroy( &p_sys
->lock
);
185 /*****************************************************************************
186 * Close: close the plugin
187 *****************************************************************************/
188 static void Close( vlc_object_t
*p_this
)
190 filter_t
*p_filter
= (filter_t
*)p_this
;
191 filter_sys_t
*p_sys
= p_filter
->p_sys
;
193 EqzClean( p_filter
);
194 vlc_mutex_destroy( &p_sys
->lock
);
198 /*****************************************************************************
199 * DoWork: process samples buffer
200 *****************************************************************************
202 *****************************************************************************/
203 static block_t
* DoWork( filter_t
* p_filter
, block_t
* p_in_buf
)
205 EqzFilter( p_filter
, (float*)p_in_buf
->p_buffer
,
206 (float*)p_in_buf
->p_buffer
, p_in_buf
->i_nb_samples
,
207 aout_FormatNbChannels( &p_filter
->fmt_in
.audio
) );
211 /*****************************************************************************
213 *****************************************************************************/
224 } band
[EQZ_BANDS_MAX
];
228 /* Value from equ-xmms */
229 static const eqz_config_t eqz_config_44100_10b
=
233 { 60, 0.003013, 0.993973, 1.993901 },
234 { 170, 0.008490, 0.983019, 1.982437 },
235 { 310, 0.015374, 0.969252, 1.967331 },
236 { 600, 0.029328, 0.941343, 1.934254 },
237 { 1000, 0.047918, 0.904163, 1.884869 },
238 { 3000, 0.130408, 0.739184, 1.582718 },
239 { 6000, 0.226555, 0.546889, 1.015267 },
240 { 12000, 0.344937, 0.310127, -0.181410 },
241 { 14000, 0.366438, 0.267123, -0.521151 },
242 { 16000, 0.379009, 0.241981, -0.808451 },
245 static const eqz_config_t eqz_config_48000_10b
=
249 { 60, 0.002769, 0.994462, 1.994400 },
250 { 170, 0.007806, 0.984388, 1.983897 },
251 { 310, 0.014143, 0.971714, 1.970091 },
252 { 600, 0.027011, 0.945978, 1.939979 },
253 { 1000, 0.044203, 0.911595, 1.895241 },
254 { 3000, 0.121223, 0.757553, 1.623767 },
255 { 6000, 0.212888, 0.574224, 1.113145 },
256 { 12000, 0.331347, 0.337307, 0.000000 },
257 { 14000, 0.355263, 0.289473, -0.333740 },
258 { 16000, 0.371900, 0.256201, -0.628100 }
262 static inline float EqzConvertdB( float db
)
265 * (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)
266 * db = 20*log( out / in ) with out = in + amp*iir(i/EQZ_IN_FACTOR)
267 * or iir(i) == i for the center freq so
268 * db = 20*log( 1 + amp/EQZ_IN_FACTOR )
269 * -> amp = EQZ_IN_FACTOR*(10^(db/20) - 1)
276 return EQZ_IN_FACTOR
* ( pow( 10, db
/ 20.0 ) - 1.0 );
279 static int EqzInit( filter_t
*p_filter
, int i_rate
)
281 filter_sys_t
*p_sys
= p_filter
->p_sys
;
282 const eqz_config_t
*p_cfg
;
284 vlc_value_t val1
, val2
, val3
;
285 vlc_object_t
*p_aout
= p_filter
->p_parent
;
286 int i_ret
= VLC_ENOMEM
;
288 /* Select the config */
289 if( i_rate
== 48000 )
291 p_cfg
= &eqz_config_48000_10b
;
293 else if( i_rate
== 44100 )
295 p_cfg
= &eqz_config_44100_10b
;
299 /* TODO compute the coeffs on the fly */
300 msg_Err( p_filter
, "rate not supported" );
304 /* Create the static filter config */
305 p_sys
->i_band
= p_cfg
->i_band
;
306 p_sys
->f_alpha
= malloc( p_sys
->i_band
* sizeof(float) );
307 p_sys
->f_beta
= malloc( p_sys
->i_band
* sizeof(float) );
308 p_sys
->f_gamma
= malloc( p_sys
->i_band
* sizeof(float) );
309 if( !p_sys
->f_alpha
|| !p_sys
->f_beta
|| !p_sys
->f_gamma
)
312 for( i
= 0; i
< p_sys
->i_band
; i
++ )
314 p_sys
->f_alpha
[i
] = p_cfg
->band
[i
].f_alpha
;
315 p_sys
->f_beta
[i
] = p_cfg
->band
[i
].f_beta
;
316 p_sys
->f_gamma
[i
] = p_cfg
->band
[i
].f_gamma
;
319 /* Filter dyn config */
320 p_sys
->b_2eqz
= false;
322 p_sys
->f_amp
= malloc( p_sys
->i_band
* sizeof(float) );
326 for( i
= 0; i
< p_sys
->i_band
; i
++ )
328 p_sys
->f_amp
[i
] = 0.0;
332 for( ch
= 0; ch
< 32; ch
++ )
337 p_sys
->x2
[ch
][1] = 0.0;
339 for( i
= 0; i
< p_sys
->i_band
; i
++ )
343 p_sys
->y2
[ch
][i
][0] =
344 p_sys
->y2
[ch
][i
][1] = 0.0;
348 var_Create( p_aout
, "equalizer-bands", VLC_VAR_STRING
| VLC_VAR_DOINHERIT
);
349 var_Create( p_aout
, "equalizer-preset", VLC_VAR_STRING
| VLC_VAR_DOINHERIT
);
351 p_sys
->b_2eqz
= var_CreateGetBool( p_aout
, "equalizer-2pass" );
353 var_Create( p_aout
, "equalizer-preamp", VLC_VAR_FLOAT
| VLC_VAR_DOINHERIT
);
355 /* Get initial values */
356 var_Get( p_aout
, "equalizer-preset", &val1
);
357 var_Get( p_aout
, "equalizer-bands", &val2
);
358 var_Get( p_aout
, "equalizer-preamp", &val3
);
360 p_sys
->b_first
= true;
361 PresetCallback( VLC_OBJECT( p_aout
), NULL
, val1
, val1
, p_sys
);
362 BandsCallback( VLC_OBJECT( p_aout
), NULL
, val2
, val2
, p_sys
);
363 PreampCallback( VLC_OBJECT( p_aout
), NULL
, val3
, val3
, p_sys
);
364 p_sys
->b_first
= false;
366 free( val1
.psz_string
);
368 /* Register preset bands (for intf) if : */
369 /* We have no bands info --> the preset info must be given to the intf */
370 /* or The bands info matches the preset */
371 if (p_sys
->psz_newbands
== NULL
)
373 msg_Err(p_filter
, "No preset selected");
374 free( val2
.psz_string
);
375 free( p_sys
->f_amp
);
376 i_ret
= VLC_EGENERIC
;
379 if( ( *(val2
.psz_string
) &&
380 strstr( p_sys
->psz_newbands
, val2
.psz_string
) ) || !*val2
.psz_string
)
382 var_SetString( p_aout
, "equalizer-bands", p_sys
->psz_newbands
);
383 if( p_sys
->f_newpreamp
== p_sys
->f_gamp
)
384 var_SetFloat( p_aout
, "equalizer-preamp", p_sys
->f_newpreamp
);
386 free( val2
.psz_string
);
388 /* Add our own callbacks */
389 var_AddCallback( p_aout
, "equalizer-preset", PresetCallback
, p_sys
);
390 var_AddCallback( p_aout
, "equalizer-bands", BandsCallback
, p_sys
);
391 var_AddCallback( p_aout
, "equalizer-preamp", PreampCallback
, p_sys
);
392 var_AddCallback( p_aout
, "equalizer-2pass", TwoPassCallback
, p_sys
);
394 msg_Dbg( p_filter
, "equalizer loaded for %d Hz with %d bands %d pass",
395 i_rate
, p_sys
->i_band
, p_sys
->b_2eqz
? 2 : 1 );
396 for( i
= 0; i
< p_sys
->i_band
; i
++ )
398 msg_Dbg( p_filter
, " %d Hz -> factor:%f alpha:%f beta:%f gamma:%f",
399 (int)p_cfg
->band
[i
].f_frequency
, p_sys
->f_amp
[i
],
400 p_sys
->f_alpha
[i
], p_sys
->f_beta
[i
], p_sys
->f_gamma
[i
]);
405 free( p_sys
->f_alpha
);
406 free( p_sys
->f_beta
);
407 free( p_sys
->f_gamma
);
411 static void EqzFilter( filter_t
*p_filter
, float *out
, float *in
,
412 int i_samples
, int i_channels
)
414 filter_sys_t
*p_sys
= p_filter
->p_sys
;
417 vlc_mutex_lock( &p_sys
->lock
);
418 for( i
= 0; i
< i_samples
; i
++ )
420 for( ch
= 0; ch
< i_channels
; ch
++ )
422 const float x
= in
[ch
];
425 for( j
= 0; j
< p_sys
->i_band
; j
++ )
427 float y
= p_sys
->f_alpha
[j
] * ( x
- p_sys
->x
[ch
][1] ) +
428 p_sys
->f_gamma
[j
] * p_sys
->y
[ch
][j
][0] -
429 p_sys
->f_beta
[j
] * p_sys
->y
[ch
][j
][1];
431 p_sys
->y
[ch
][j
][1] = p_sys
->y
[ch
][j
][0];
432 p_sys
->y
[ch
][j
][0] = y
;
434 o
+= y
* p_sys
->f_amp
[j
];
436 p_sys
->x
[ch
][1] = p_sys
->x
[ch
][0];
442 const float x2
= EQZ_IN_FACTOR
* x
+ o
;
444 for( j
= 0; j
< p_sys
->i_band
; j
++ )
446 float y
= p_sys
->f_alpha
[j
] * ( x2
- p_sys
->x2
[ch
][1] ) +
447 p_sys
->f_gamma
[j
] * p_sys
->y2
[ch
][j
][0] -
448 p_sys
->f_beta
[j
] * p_sys
->y2
[ch
][j
][1];
450 p_sys
->y2
[ch
][j
][1] = p_sys
->y2
[ch
][j
][0];
451 p_sys
->y2
[ch
][j
][0] = y
;
453 o
+= y
* p_sys
->f_amp
[j
];
455 p_sys
->x2
[ch
][1] = p_sys
->x2
[ch
][0];
456 p_sys
->x2
[ch
][0] = x2
;
458 /* We add source PCM + filtered PCM */
459 out
[ch
] = p_sys
->f_gamp
*( EQZ_IN_FACTOR
* x2
+ o
);
463 /* We add source PCM + filtered PCM */
464 out
[ch
] = p_sys
->f_gamp
*( EQZ_IN_FACTOR
* x
+ o
);
471 vlc_mutex_unlock( &p_sys
->lock
);
474 static void EqzClean( filter_t
*p_filter
)
476 filter_sys_t
*p_sys
= p_filter
->p_sys
;
477 vlc_object_t
*p_aout
= p_filter
->p_parent
;
479 var_DelCallback( p_aout
, "equalizer-bands", BandsCallback
, p_sys
);
480 var_DelCallback( p_aout
, "equalizer-preset", PresetCallback
, p_sys
);
481 var_DelCallback( p_aout
, "equalizer-preamp", PreampCallback
, p_sys
);
482 var_DelCallback( p_aout
, "equalizer-2pass", TwoPassCallback
, p_sys
);
484 free( p_sys
->f_alpha
);
485 free( p_sys
->f_beta
);
486 free( p_sys
->f_gamma
);
488 free( p_sys
->f_amp
);
489 free( p_sys
->psz_newbands
);
493 static int PresetCallback( vlc_object_t
*p_aout
, char const *psz_cmd
,
494 vlc_value_t oldval
, vlc_value_t newval
, void *p_data
)
496 VLC_UNUSED(psz_cmd
); VLC_UNUSED(oldval
);
497 filter_sys_t
*p_sys
= p_data
;
499 const char *psz_preset
= newval
.psz_string
;
501 vlc_mutex_lock( &p_sys
->lock
);
502 if( !*psz_preset
|| p_sys
->i_band
!= 10 )
504 vlc_mutex_unlock( &p_sys
->lock
);
508 for( unsigned i
= 0; eqz_preset_10b
[i
] != NULL
; i
++ )
510 if( !strcasecmp( eqz_preset_10b
[i
]->psz_name
, psz_preset
) )
512 char *psz_newbands
= NULL
;
514 p_sys
->f_gamp
*= pow( 10, eqz_preset_10b
[i
]->f_preamp
/ 20.0 );
515 for( int j
= 0; j
< p_sys
->i_band
; j
++ )
520 p_sys
->f_amp
[j
] = EqzConvertdB( eqz_preset_10b
[i
]->f_amp
[j
] );
521 d
= lldiv( eqz_preset_10b
[i
]->f_amp
[j
] * 10000000, 10000000 );
522 if( asprintf( &psz
, "%s %lld.%07llu",
523 psz_newbands
? psz_newbands
: "",
524 d
.quot
, d
.rem
) == -1 )
526 free( psz_newbands
);
527 vlc_mutex_unlock( &p_sys
->lock
);
530 free( psz_newbands
);
533 if( p_sys
->b_first
== false )
535 vlc_mutex_unlock( &p_sys
->lock
);
536 var_SetString( p_aout
, "equalizer-bands", psz_newbands
);
537 var_SetFloat( p_aout
, "equalizer-preamp",
538 eqz_preset_10b
[i
]->f_preamp
);
539 free( psz_newbands
);
543 p_sys
->psz_newbands
= psz_newbands
;
544 p_sys
->f_newpreamp
= eqz_preset_10b
[i
]->f_preamp
;
545 vlc_mutex_unlock( &p_sys
->lock
);
550 vlc_mutex_unlock( &p_sys
->lock
);
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 filter_sys_t
*p_sys
= 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;
569 vlc_mutex_lock( &p_sys
->lock
);
570 p_sys
->f_gamp
= pow( 10, newval
.f_float
/20.0);
571 vlc_mutex_unlock( &p_sys
->lock
);
576 static int BandsCallback( vlc_object_t
*p_this
, char const *psz_cmd
,
577 vlc_value_t oldval
, vlc_value_t newval
, void *p_data
)
579 VLC_UNUSED(p_this
); VLC_UNUSED(psz_cmd
); VLC_UNUSED(oldval
);
580 filter_sys_t
*p_sys
= p_data
;
581 const char *psz_bands
= newval
.psz_string
;
582 const char *p
= psz_bands
;
585 /* Same thing for bands */
586 vlc_mutex_lock( &p_sys
->lock
);
587 for( int i
= 0; i
< p_sys
->i_band
; i
++ )
591 if( *psz_bands
== '\0' )
595 f
= us_strtof( p
, &psz_next
);
598 break; /* no conversion */
600 p_sys
->f_amp
[i
] = EqzConvertdB( f
);
602 if( *psz_next
== '\0' )
603 break; /* end of line */
606 vlc_mutex_unlock( &p_sys
->lock
);
609 static int TwoPassCallback( vlc_object_t
*p_this
, char const *psz_cmd
,
610 vlc_value_t oldval
, vlc_value_t newval
, void *p_data
)
612 VLC_UNUSED(p_this
); VLC_UNUSED(psz_cmd
); VLC_UNUSED(oldval
);
613 filter_sys_t
*p_sys
= p_data
;
615 vlc_mutex_lock( &p_sys
->lock
);
616 p_sys
->b_2eqz
= newval
.b_bool
;
617 vlc_mutex_unlock( &p_sys
->lock
);