Added a callback on equalizer-2pass in equalizer filter.
[vlc.git] / modules / audio_filter / equalizer.c
1 /*****************************************************************************
2  * equalizer.c:
3  *****************************************************************************
4  * Copyright (C) 2004, 2006 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #include <math.h>
33
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #include <vlc_charset.h>
37
38 #include <vlc_aout.h>
39
40 #include "equalizer_presets.h"
41 /* TODO:
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
48  *  - ...
49  */
50
51 /*****************************************************************************
52  * Module descriptor
53  *****************************************************************************/
54 static int  Open ( vlc_object_t * );
55 static void Close( vlc_object_t * );
56
57 #define PRESET_TEXT N_( "Equalizer preset" )
58 #define PRESET_LONGTEXT N_("Preset to use for the equalizer." )
59
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\"." )
65
66 #define TWOPASS_TEXT N_( "Two pass" )
67 #define TWOPASS_LONGTEXT N_( "Filter the audio twice. This provides a more "  \
68          "intense effect.")
69
70 #define PREAMP_TEXT N_("Global gain" )
71 #define PREAMP_LONGTEXT N_("Set the global gain in dB (-20 ... 20)." )
72
73 vlc_module_begin ()
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 )
79
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" )
91 vlc_module_end ()
92
93 /*****************************************************************************
94  * Local prototypes
95  *****************************************************************************/
96 struct aout_filter_sys_t
97 {
98     /* Filter static config */
99     int i_band;
100     float *f_alpha;
101     float *f_beta;
102     float *f_gamma;
103
104     float f_newpreamp;
105     char *psz_newbands;
106     bool b_first;
107
108     /* Filter dyn config */
109     float *f_amp;   /* Per band amp */
110     float f_gamp;   /* Global preamp */
111     bool b_2eqz;
112
113     /* Filter state */
114     float x[32][2];
115     float y[32][128][2];
116
117     /* Second filter state */
118     float x2[32][2];
119     float y2[32][128][2];
120
121 };
122
123 static void DoWork( aout_instance_t *, aout_filter_t *,
124                     aout_buffer_t *, aout_buffer_t * );
125
126 #define EQZ_IN_FACTOR (0.25)
127 static int  EqzInit( aout_filter_t *, int );
128 static void EqzFilter( aout_filter_t *, float *, float *,
129                         int, int );
130 static void EqzClean( aout_filter_t * );
131
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 * );
138 static int TwoPassCallback( vlc_object_t *, char const *,
139                                            vlc_value_t, vlc_value_t, void * );
140
141
142
143 /*****************************************************************************
144  * Open:
145  *****************************************************************************/
146 static int Open( vlc_object_t *p_this )
147 {
148     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
149     aout_filter_sys_t *p_sys;
150     bool         b_fit = true;
151
152     if( p_filter->input.i_format != VLC_CODEC_FL32 ||
153         p_filter->output.i_format != VLC_CODEC_FL32 )
154     {
155         b_fit = false;
156         p_filter->input.i_format = VLC_CODEC_FL32;
157         p_filter->output.i_format = VLC_CODEC_FL32;
158         msg_Warn( p_filter, "bad input or output format" );
159     }
160     if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
161     {
162         b_fit = false;
163         memcpy( &p_filter->output, &p_filter->input,
164                 sizeof(audio_sample_format_t) );
165         msg_Warn( p_filter, "input and output formats are not similar" );
166     }
167
168     if ( ! b_fit )
169     {
170         return VLC_EGENERIC;
171     }
172
173     p_filter->pf_do_work = DoWork;
174     p_filter->b_in_place = true;
175
176     /* Allocate structure */
177     p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
178     if( !p_sys )
179         return VLC_ENOMEM;
180
181     if( EqzInit( p_filter, p_filter->input.i_rate ) != VLC_SUCCESS )
182     {
183         free( p_sys );
184         return VLC_EGENERIC;
185     }
186
187     return VLC_SUCCESS;
188 }
189
190 /*****************************************************************************
191  * Close: close the plugin
192  *****************************************************************************/
193 static void Close( vlc_object_t *p_this )
194 {
195     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
196     aout_filter_sys_t *p_sys = p_filter->p_sys;
197
198     EqzClean( p_filter );
199     free( p_sys );
200 }
201
202 /*****************************************************************************
203  * DoWork: process samples buffer
204  *****************************************************************************
205  *
206  *****************************************************************************/
207 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
208                     aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
209 {
210     VLC_UNUSED(p_aout);
211     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
212     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
213
214     EqzFilter( p_filter, (float*)p_out_buf->p_buffer,
215                (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
216                aout_FormatNbChannels( &p_filter->input ) );
217 }
218
219 /*****************************************************************************
220  * Equalizer stuff
221  *****************************************************************************/
222 typedef struct
223 {
224     int   i_band;
225
226     struct
227     {
228         float f_frequency;
229         float f_alpha;
230         float f_beta;
231         float f_gamma;
232     } band[EQZ_BANDS_MAX];
233
234 } eqz_config_t;
235
236 /* Value from equ-xmms */
237 static const eqz_config_t eqz_config_44100_10b =
238 {
239     10,
240     {
241         {    60, 0.003013, 0.993973, 1.993901 },
242         {   170, 0.008490, 0.983019, 1.982437 },
243         {   310, 0.015374, 0.969252, 1.967331 },
244         {   600, 0.029328, 0.941343, 1.934254 },
245         {  1000, 0.047918, 0.904163, 1.884869 },
246         {  3000, 0.130408, 0.739184, 1.582718 },
247         {  6000, 0.226555, 0.546889, 1.015267 },
248         { 12000, 0.344937, 0.310127, -0.181410 },
249         { 14000, 0.366438, 0.267123, -0.521151 },
250         { 16000, 0.379009, 0.241981, -0.808451 },
251     }
252 };
253 static const eqz_config_t eqz_config_48000_10b =
254 {
255     10,
256     {
257         {    60, 0.002769, 0.994462, 1.994400 },
258         {   170, 0.007806, 0.984388, 1.983897 },
259         {   310, 0.014143, 0.971714, 1.970091 },
260         {   600, 0.027011, 0.945978, 1.939979 },
261         {  1000, 0.044203, 0.911595, 1.895241 },
262         {  3000, 0.121223, 0.757553, 1.623767 },
263         {  6000, 0.212888, 0.574224, 1.113145 },
264         { 12000, 0.331347, 0.337307, 0.000000 },
265         { 14000, 0.355263, 0.289473, -0.333740 },
266         { 16000, 0.371900, 0.256201, -0.628100 }
267     }
268 };
269
270 static inline float EqzConvertdB( float db )
271 {
272     /* Map it to gain,
273      * (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)
274      * db = 20*log( out / in ) with out = in + amp*iir(i/EQZ_IN_FACTOR)
275      * or iir(i) == i for the center freq so
276      * db = 20*log( 1 + amp/EQZ_IN_FACTOR )
277      * -> amp = EQZ_IN_FACTOR*(10^(db/20) - 1)
278      **/
279
280     if( db < -20.0 )
281         db = -20.0;
282     else if(  db > 20.0 )
283         db = 20.0;
284     return EQZ_IN_FACTOR * ( pow( 10, db / 20.0 ) - 1.0 );
285 }
286
287 static int EqzInit( aout_filter_t *p_filter, int i_rate )
288 {
289     aout_filter_sys_t *p_sys = p_filter->p_sys;
290     const eqz_config_t *p_cfg;
291     int i, ch;
292     vlc_value_t val1, val2, val3;
293     aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
294
295     /* Select the config */
296     if( i_rate == 48000 )
297     {
298         p_cfg = &eqz_config_48000_10b;
299     }
300     else if( i_rate == 44100 )
301     {
302         p_cfg = &eqz_config_44100_10b;
303     }
304     else
305     {
306         /* TODO compute the coeffs on the fly */
307         msg_Err( p_filter, "rate not supported" );
308         return VLC_EGENERIC;
309     }
310
311     /* Create the static filter config */
312     p_sys->i_band = p_cfg->i_band;
313     p_sys->f_alpha = malloc( p_sys->i_band * sizeof(float) );
314     p_sys->f_beta  = malloc( p_sys->i_band * sizeof(float) );
315     p_sys->f_gamma = malloc( p_sys->i_band * sizeof(float) );
316     if( !p_sys->f_alpha || !p_sys->f_beta || !p_sys->f_gamma )
317     {
318         free( p_sys->f_alpha );
319         free( p_sys->f_beta );
320         free( p_sys->f_gamma );
321         return VLC_ENOMEM;
322     }
323
324     for( i = 0; i < p_sys->i_band; i++ )
325     {
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;
329     }
330
331     /* Filter dyn config */
332     p_sys->b_2eqz = false;
333     p_sys->f_gamp = 1.0;
334     p_sys->f_amp  = malloc( p_sys->i_band * sizeof(float) );
335     if( !p_sys->f_amp )
336     {
337         free( p_sys->f_alpha );
338         free( p_sys->f_beta );
339         free( p_sys->f_gamma );
340         return VLC_ENOMEM;
341     }
342     for( i = 0; i < p_sys->i_band; i++ )
343     {
344         p_sys->f_amp[i] = 0.0;
345     }
346
347     /* Filter state */
348     for( ch = 0; ch < 32; ch++ )
349     {
350         p_sys->x[ch][0]  =
351         p_sys->x[ch][1]  =
352         p_sys->x2[ch][0] =
353         p_sys->x2[ch][1] = 0.0;
354
355         for( i = 0; i < p_sys->i_band; i++ )
356         {
357             p_sys->y[ch][i][0]  =
358             p_sys->y[ch][i][1]  =
359             p_sys->y2[ch][i][0] =
360             p_sys->y2[ch][i][1] = 0.0;
361         }
362     }
363
364     var_Create( p_aout, "equalizer-bands", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
365     var_Create( p_aout, "equalizer-preset", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
366
367     p_sys->b_2eqz = var_CreateGetBool( p_aout, "equalizer-2pass" );
368
369     var_Create( p_aout, "equalizer-preamp", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
370
371     /* Get initial values */
372     var_Get( p_aout, "equalizer-preset", &val1 );
373     var_Get( p_aout, "equalizer-bands", &val2 );
374     var_Get( p_aout, "equalizer-preamp", &val3 );
375
376     p_sys->b_first = true;
377     PresetCallback( VLC_OBJECT( p_aout ), NULL, val1, val1, p_sys );
378     BandsCallback(  VLC_OBJECT( p_aout ), NULL, val2, val2, p_sys );
379     PreampCallback( VLC_OBJECT( p_aout ), NULL, val3, val3, p_sys );
380     p_sys->b_first = false;
381
382     free( val1.psz_string );
383
384     /* Register preset bands (for intf) if : */
385     /* We have no bands info --> the preset info must be given to the intf */
386     /* or The bands info matches the preset */
387     if (p_sys->psz_newbands == NULL)
388     {
389         msg_Err(p_filter, "No preset selected");
390         free( val2.psz_string );
391         free( p_sys->f_amp );
392         free( p_sys->f_alpha );
393         free( p_sys->f_beta );
394         free( p_sys->f_gamma );
395         return VLC_EGENERIC;
396     }
397     if( ( *(val2.psz_string) &&
398         strstr( p_sys->psz_newbands, val2.psz_string ) ) || !*val2.psz_string )
399     {
400         var_SetString( p_aout, "equalizer-bands", p_sys->psz_newbands );
401         if( p_sys->f_newpreamp == p_sys->f_gamp )
402             var_SetFloat( p_aout, "equalizer-preamp", p_sys->f_newpreamp );
403     }
404     free( val2.psz_string );
405
406     /* Add our own callbacks */
407     var_AddCallback( p_aout, "equalizer-preset", PresetCallback, p_sys );
408     var_AddCallback( p_aout, "equalizer-bands", BandsCallback, p_sys );
409     var_AddCallback( p_aout, "equalizer-preamp", PreampCallback, p_sys );
410     var_AddCallback( p_aout, "equalizer-2pass", TwoPassCallback, p_sys );
411
412     msg_Dbg( p_filter, "equalizer loaded for %d Hz with %d bands %d pass",
413                         i_rate, p_sys->i_band, p_sys->b_2eqz ? 2 : 1 );
414     for( i = 0; i < p_sys->i_band; i++ )
415     {
416         msg_Dbg( p_filter, "   %d Hz -> factor:%f alpha:%f beta:%f gamma:%f",
417                  (int)p_cfg->band[i].f_frequency, p_sys->f_amp[i],
418                  p_sys->f_alpha[i], p_sys->f_beta[i], p_sys->f_gamma[i]);
419     }
420     return VLC_SUCCESS;
421 }
422
423 static void EqzFilter( aout_filter_t *p_filter, float *out, float *in,
424                        int i_samples, int i_channels )
425 {
426     aout_filter_sys_t *p_sys = p_filter->p_sys;
427     int i, ch, j;
428
429     for( i = 0; i < i_samples; i++ )
430     {
431         for( ch = 0; ch < i_channels; ch++ )
432         {
433             const float x = in[ch];
434             float o = 0.0;
435
436             for( j = 0; j < p_sys->i_band; j++ )
437             {
438                 float y = p_sys->f_alpha[j] * ( x - p_sys->x[ch][1] ) +
439                           p_sys->f_gamma[j] * p_sys->y[ch][j][0] -
440                           p_sys->f_beta[j]  * p_sys->y[ch][j][1];
441
442                 p_sys->y[ch][j][1] = p_sys->y[ch][j][0];
443                 p_sys->y[ch][j][0] = y;
444
445                 o += y * p_sys->f_amp[j];
446             }
447             p_sys->x[ch][1] = p_sys->x[ch][0];
448             p_sys->x[ch][0] = x;
449
450             /* Second filter */
451             if( p_sys->b_2eqz )
452             {
453                 const float x2 = EQZ_IN_FACTOR * x + o;
454                 o = 0.0;
455                 for( j = 0; j < p_sys->i_band; j++ )
456                 {
457                     float y = p_sys->f_alpha[j] * ( x2 - p_sys->x2[ch][1] ) +
458                               p_sys->f_gamma[j] * p_sys->y2[ch][j][0] -
459                               p_sys->f_beta[j]  * p_sys->y2[ch][j][1];
460
461                     p_sys->y2[ch][j][1] = p_sys->y2[ch][j][0];
462                     p_sys->y2[ch][j][0] = y;
463
464                     o += y * p_sys->f_amp[j];
465                 }
466                 p_sys->x2[ch][1] = p_sys->x2[ch][0];
467                 p_sys->x2[ch][0] = x2;
468
469                 /* We add source PCM + filtered PCM */
470                 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x2 + o );
471             }
472             else
473             {
474                 /* We add source PCM + filtered PCM */
475                 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x + o );
476             }
477         }
478
479         in  += i_channels;
480         out += i_channels;
481     }
482 }
483
484 static void EqzClean( aout_filter_t *p_filter )
485 {
486     aout_filter_sys_t *p_sys = p_filter->p_sys;
487
488     var_DelCallback( (aout_instance_t *)p_filter->p_parent,
489                         "equalizer-bands", BandsCallback, p_sys );
490     var_DelCallback( (aout_instance_t *)p_filter->p_parent,
491                         "equalizer-preset", PresetCallback, p_sys );
492     var_DelCallback( (aout_instance_t *)p_filter->p_parent,
493                         "equalizer-preamp", PreampCallback, p_sys );
494     var_DelCallback( (aout_instance_t *)p_filter->p_parent,
495                         "equalizer-2pass", TwoPassCallback, p_sys );
496
497     free( p_sys->f_alpha );
498     free( p_sys->f_beta );
499     free( p_sys->f_gamma );
500
501     free( p_sys->f_amp );
502     free( p_sys->psz_newbands );
503 }
504
505
506 static int PresetCallback( vlc_object_t *p_this, char const *psz_cmd,
507                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
508 {
509     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
510     aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
511     aout_instance_t *p_aout = (aout_instance_t *)p_this;
512
513     char *psz_preset = newval.psz_string;
514
515     if( !*psz_preset || p_sys->i_band != 10 )
516         return VLC_SUCCESS;
517
518     for( unsigned i = 0; eqz_preset_10b[i] != NULL; i++ )
519     {
520         if( !strcasecmp( eqz_preset_10b[i]->psz_name, psz_preset ) )
521         {
522             char *psz_newbands = NULL;
523
524             p_sys->f_gamp *= pow( 10, eqz_preset_10b[i]->f_preamp / 20.0 );
525             for( int j = 0; j < p_sys->i_band; j++ )
526             {
527                 lldiv_t d;
528                 char *psz;
529
530                 p_sys->f_amp[j] = EqzConvertdB( eqz_preset_10b[i]->f_amp[j] );
531                 d = lldiv( eqz_preset_10b[i]->f_amp[j] * 10000000, 10000000 );
532                 if( asprintf( &psz, "%s %lld.%07llu",
533                               psz_newbands ? psz_newbands : "",
534                               d.quot, d.rem ) == -1 )
535                 {
536                     free( psz_newbands );
537                     return VLC_ENOMEM;
538                 }
539                 free( psz_newbands );
540                 psz_newbands = psz;
541             }
542             if( p_sys->b_first == false )
543             {
544                 var_SetString( p_aout, "equalizer-bands", psz_newbands );
545                 var_SetFloat( p_aout, "equalizer-preamp",
546                               eqz_preset_10b[i]->f_preamp );
547                 free( psz_newbands );
548             }
549             else
550             {
551                 p_sys->psz_newbands = psz_newbands;
552                 p_sys->f_newpreamp = eqz_preset_10b[i]->f_preamp;
553             }
554             return VLC_SUCCESS;
555         }
556     }
557     msg_Err( p_aout, "equalizer preset '%s' not found", psz_preset );
558     msg_Info( p_aout, "full list:" );
559     for( unsigned i = 0; eqz_preset_10b[i] != NULL; i++ )
560          msg_Info( p_aout, "  - '%s'", eqz_preset_10b[i]->psz_name );
561     return VLC_SUCCESS;
562 }
563
564 static int PreampCallback( vlc_object_t *p_this, char const *psz_cmd,
565                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
566 {
567     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
568     aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
569
570     if( newval.f_float < -20.0 )
571         newval.f_float = -20.0;
572     else if( newval.f_float > 20.0 )
573         newval.f_float = 20.0;
574     p_sys->f_gamp = pow( 10, newval.f_float /20.0);
575
576     return VLC_SUCCESS;
577 }
578
579 static int BandsCallback( vlc_object_t *p_this, char const *psz_cmd,
580                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
581 {
582     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
583     aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
584     char *psz_bands = newval.psz_string;
585     char *psz_next;
586     char *p = psz_bands;
587     int i;
588
589     /* Same thing for bands */
590     for( i = 0; i < p_sys->i_band; i++ )
591     {
592         float f;
593
594         if( *psz_bands == '\0' )
595             break;
596
597         /* Read dB -20/20 */
598         f = us_strtof( p, &psz_next );
599
600         if( psz_next == p )
601             break; /* no conversion */
602
603         p_sys->f_amp[i] = EqzConvertdB( f );
604
605         if( *psz_next == '\0' )
606             break; /* end of line */
607         p = &psz_next[1];
608     }
609     return VLC_SUCCESS;
610 }
611 static int TwoPassCallback( vlc_object_t *p_this, char const *psz_cmd,
612                             vlc_value_t oldval, vlc_value_t newval, void *p_data )
613 {
614     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
615     aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
616
617     /* FIXME lock (same for all other callbacks) */
618     p_sys->b_2eqz = newval.b_bool;
619 }
620