Moves volume icon update in the timer
[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 #include <math.h>
28
29 #include <vlc/vlc.h>
30
31 #include "vlc_aout.h"
32
33 #include "equalizer_presets.h"
34 /* TODO:
35  *  - add tables for other rates ( 22500, 11250, ...)
36  *  - optimize a bit (you can hardly do slower ;)
37  *  - add tables for more bands (15 and 32 would be cool), maybe with auto coeffs
38  *  computation (not too hard once the Q is found).
39  *  - support for external preset
40  *  - callback to handle preset changes on the fly
41  *  - ...
42  */
43
44 /*****************************************************************************
45  * Module descriptor
46  *****************************************************************************/
47 static int  Open ( vlc_object_t * );
48 static void Close( vlc_object_t * );
49
50 #define PRESET_TEXT N_( "Equalizer preset" )
51 #define PRESET_LONGTEXT N_("Preset to use for the equalizer." )
52
53 #define BANDS_TEXT N_( "Bands gain")
54 #define BANDS_LONGTEXT N_( \
55          "Don't use presets, but manually specified bands. You need to " \
56          "provide 10 values between -20dB and 20dB, separated by spaces, " \
57          "e.g. \"0 2 4 2 0 -2 -4 -2 0\"." )
58
59 #define TWOPASS_TEXT N_( "Two pass" )
60 #define TWOPASS_LONGTEXT N_( "Filter the audio twice. This provides a more "  \
61          "intense effect.")
62
63 #define PREAMP_TEXT N_("Global gain" )
64 #define PREAMP_LONGTEXT N_("Set the global gain in dB (-20 ... 20)." )
65
66 vlc_module_begin();
67     set_description( _("Equalizer with 10 bands") );
68     set_shortname( _("Equalizer" ) );
69     set_capability( "audio filter", 0 );
70     set_category( CAT_AUDIO );
71     set_subcategory( SUBCAT_AUDIO_AFILTER );
72
73     add_string( "equalizer-preset", "flat", NULL, PRESET_TEXT,
74                 PRESET_LONGTEXT, VLC_FALSE );
75         change_string_list( preset_list, preset_list_text, 0 );
76     add_string( "equalizer-bands", NULL, NULL, BANDS_TEXT,
77                 BANDS_LONGTEXT, VLC_TRUE );
78     add_bool( "equalizer-2pass", 0, NULL, TWOPASS_TEXT,
79               TWOPASS_LONGTEXT, VLC_TRUE );
80     add_float( "equalizer-preamp", 12.0, NULL, PREAMP_TEXT,
81                PREAMP_LONGTEXT, VLC_TRUE );
82     set_callbacks( Open, Close );
83     add_shortcut( "equalizer" );
84 vlc_module_end();
85
86 /*****************************************************************************
87  * Local prototypes
88  *****************************************************************************/
89 typedef struct aout_filter_sys_t
90 {
91     /* Filter static config */
92     int i_band;
93     float *f_alpha;
94     float *f_beta;
95     float *f_gamma;
96
97     float f_newpreamp;
98     char *psz_newbands;
99     vlc_bool_t b_first;
100
101     /* Filter dyn config */
102     float *f_amp;   /* Per band amp */
103     float f_gamp;   /* Global preamp */
104     vlc_bool_t b_2eqz;
105
106     /* Filter state */
107     float x[32][2];
108     float y[32][128][2];
109
110     /* Second filter state */
111     float x2[32][2];
112     float y2[32][128][2];
113
114 } aout_filter_sys_t;
115
116 static void DoWork( aout_instance_t *, aout_filter_t *,
117                     aout_buffer_t *, aout_buffer_t * );
118
119 #define EQZ_IN_FACTOR (0.25)
120 static int  EqzInit( aout_filter_t *, int );
121 static void EqzFilter( aout_instance_t *,aout_filter_t *, float *, float *,
122                         int, int );
123 static void EqzClean( aout_filter_t * );
124
125 static int PresetCallback( vlc_object_t *, char const *,
126                                            vlc_value_t, vlc_value_t, void * );
127 static int PreampCallback( vlc_object_t *, char const *,
128                                            vlc_value_t, vlc_value_t, void * );
129 static int BandsCallback ( vlc_object_t *, char const *,
130                                            vlc_value_t, vlc_value_t, void * );
131
132
133
134 /*****************************************************************************
135  * Open:
136  *****************************************************************************/
137 static int Open( vlc_object_t *p_this )
138 {
139     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
140     aout_filter_sys_t *p_sys;
141     vlc_bool_t         b_fit = VLC_TRUE;
142
143     if( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' ) ||
144         p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
145     {
146         b_fit = VLC_FALSE;
147         p_filter->input.i_format = VLC_FOURCC('f','l','3','2');
148         p_filter->output.i_format = VLC_FOURCC('f','l','3','2');
149         msg_Warn( p_filter, "bad input or output format" );
150     }
151     if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
152     {
153         b_fit = VLC_FALSE;
154         memcpy( &p_filter->output, &p_filter->input,
155                 sizeof(audio_sample_format_t) );
156         msg_Warn( p_filter, "input and output formats are not similar" );
157     }
158
159     if ( ! b_fit )
160     {
161         return VLC_EGENERIC;
162     }
163
164     p_filter->pf_do_work = DoWork;
165     p_filter->b_in_place = VLC_TRUE;
166
167     /* Allocate structure */
168     p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
169
170     if( EqzInit( p_filter, p_filter->input.i_rate ) )
171         return VLC_EGENERIC;
172
173     return VLC_SUCCESS;
174 }
175
176 /*****************************************************************************
177  * Close: close the plugin
178  *****************************************************************************/
179 static void Close( vlc_object_t *p_this )
180 {
181     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
182     aout_filter_sys_t *p_sys = p_filter->p_sys;
183
184     EqzClean( p_filter );
185     free( p_sys );
186 }
187
188 /*****************************************************************************
189  * DoWork: process samples buffer
190  *****************************************************************************
191  *
192  *****************************************************************************/
193 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
194                     aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
195 {
196     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
197     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
198
199     EqzFilter( p_aout, p_filter, (float*)p_out_buf->p_buffer,
200                (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
201                aout_FormatNbChannels( &p_filter->input ) );
202 }
203
204 /*****************************************************************************
205  * Equalizer stuff
206  *****************************************************************************/
207 typedef struct
208 {
209     int   i_band;
210
211     struct
212     {
213         float f_frequency;
214         float f_alpha;
215         float f_beta;
216         float f_gamma;
217     } band[EQZ_BANDS_MAX];
218
219 } eqz_config_t;
220
221 /* Value from equ-xmms */
222 static const eqz_config_t eqz_config_44100_10b =
223 {
224     10,
225     {
226         {    60, 0.003013, 0.993973, 1.993901 },
227         {   170, 0.008490, 0.983019, 1.982437 },
228         {   310, 0.015374, 0.969252, 1.967331 },
229         {   600, 0.029328, 0.941343, 1.934254 },
230         {  1000, 0.047918, 0.904163, 1.884869 },
231         {  3000, 0.130408, 0.739184, 1.582718 },
232         {  6000, 0.226555, 0.546889, 1.015267 },
233         { 12000, 0.344937, 0.310127, -0.181410 },
234         { 14000, 0.366438, 0.267123, -0.521151 },
235         { 16000, 0.379009, 0.241981, -0.808451 },
236     }
237 };
238 static const eqz_config_t eqz_config_48000_10b =
239 {
240     10,
241     {
242         {    60, 0.002769, 0.994462, 1.994400 },
243         {   170, 0.007806, 0.984388, 1.983897 },
244         {   310, 0.014143, 0.971714, 1.970091 },
245         {   600, 0.027011, 0.945978, 1.939979 },
246         {  1000, 0.044203, 0.911595, 1.895241 },
247         {  3000, 0.121223, 0.757553, 1.623767 },
248         {  6000, 0.212888, 0.574224, 1.113145 },
249         { 12000, 0.331347, 0.337307, 0.000000 },
250         { 14000, 0.355263, 0.289473, -0.333740 },
251         { 16000, 0.371900, 0.256201, -0.628100 }
252     }
253 };
254
255 static inline float EqzConvertdB( float db )
256 {
257     /* Map it to gain,
258      * (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)
259      * db = 20*log( out / in ) with out = in + amp*iir(i/EQZ_IN_FACTOR)
260      * or iir(i) == i for the center freq so
261      * db = 20*log( 1 + amp/EQZ_IN_FACTOR )
262      * -> amp = EQZ_IN_FACTOR*(10^(db/20) - 1)
263      **/
264
265     if( db < -20.0 )
266         db = -20.0;
267     else if(  db > 20.0 )
268         db = 20.0;
269     return EQZ_IN_FACTOR * ( pow( 10, db / 20.0 ) - 1.0 );
270 }
271
272 static int EqzInit( aout_filter_t *p_filter, int i_rate )
273 {
274     aout_filter_sys_t *p_sys = p_filter->p_sys;
275     const eqz_config_t *p_cfg;
276     int i, ch;
277     vlc_value_t val1, val2, val3;
278     aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
279
280     /* Select the config */
281     if( i_rate == 48000 )
282     {
283         p_cfg = &eqz_config_48000_10b;
284     }
285     else if( i_rate == 44100 )
286     {
287         p_cfg = &eqz_config_44100_10b;
288     }
289     else
290     {
291         /* TODO compute the coeffs on the fly */
292         msg_Err( p_filter, "rate not supported" );
293         return VLC_EGENERIC;
294     }
295
296     /* Create the static filter config */
297     p_sys->i_band = p_cfg->i_band;
298     p_sys->f_alpha = malloc( p_sys->i_band * sizeof(float) );
299     p_sys->f_beta  = malloc( p_sys->i_band * sizeof(float) );
300     p_sys->f_gamma = malloc( p_sys->i_band * sizeof(float) );
301     for( i = 0; i < p_sys->i_band; i++ )
302     {
303         p_sys->f_alpha[i] = p_cfg->band[i].f_alpha;
304         p_sys->f_beta[i]  = p_cfg->band[i].f_beta;
305         p_sys->f_gamma[i] = p_cfg->band[i].f_gamma;
306     }
307
308     /* Filter dyn config */
309     p_sys->b_2eqz = VLC_FALSE;
310     p_sys->f_gamp = 1.0;
311     p_sys->f_amp   = malloc( p_sys->i_band * sizeof(float) );
312     for( i = 0; i < p_sys->i_band; i++ )
313     {
314         p_sys->f_amp[i] = 0.0;
315     }
316
317     /* Filter state */
318     for( ch = 0; ch < 32; ch++ )
319     {
320         p_sys->x[ch][0]  =
321         p_sys->x[ch][1]  =
322         p_sys->x2[ch][0] =
323         p_sys->x2[ch][1] = 0.0;
324
325         for( i = 0; i < p_sys->i_band; i++ )
326         {
327             p_sys->y[ch][i][0]  =
328             p_sys->y[ch][i][1]  =
329             p_sys->y2[ch][i][0] =
330             p_sys->y2[ch][i][1] = 0.0;
331         }
332     }
333
334     var_CreateGetString( p_aout,"equalizer-bands" );
335     var_CreateGetString( p_aout, "equalizer-preset" );
336
337     p_sys->b_2eqz = var_CreateGetBool( p_aout, "equalizer-2pass" );
338
339     var_CreateGetFloat( p_aout, "equalizer-preamp" );
340
341     /* Get initial values */
342     var_Get( p_aout, "equalizer-preset", &val1 );
343     var_Get( p_aout, "equalizer-bands", &val2 );
344     var_Get( p_aout, "equalizer-preamp", &val3 );
345
346     p_sys->b_first = VLC_TRUE;
347     PresetCallback( VLC_OBJECT( p_aout ), NULL, val1, val1, p_sys );
348     BandsCallback(  VLC_OBJECT( p_aout ), NULL, val2, val2, p_sys );
349     PreampCallback( VLC_OBJECT( p_aout ), NULL, val3, val3, p_sys );
350     p_sys->b_first = VLC_FALSE;
351
352     /* Register preset bands (for intf) if : */
353     /* We have no bands info --> the preset info must be given to the intf */
354     /* or The bands info matches the preset */
355     if (p_sys->psz_newbands == NULL)
356     {
357         msg_Err(p_filter, "No preset selected");
358         return (VLC_EGENERIC);
359     }
360     if( ( *(val2.psz_string) &&
361         strstr( p_sys->psz_newbands, val2.psz_string ) ) || !*val2.psz_string )
362     {
363         var_SetString( p_aout, "equalizer-bands", p_sys->psz_newbands );
364         if( p_sys->f_newpreamp == p_sys->f_gamp )
365             var_SetFloat( p_aout, "equalizer-preamp", p_sys->f_newpreamp );
366     }
367
368     /* Add our own callbacks */
369     var_AddCallback( p_aout, "equalizer-preset", PresetCallback, p_sys );
370     var_AddCallback( p_aout, "equalizer-bands", BandsCallback, p_sys );
371     var_AddCallback( p_aout, "equalizer-preamp", PreampCallback, p_sys );
372
373     msg_Dbg( p_filter, "equalizer loaded for %d Hz with %d bands %d pass",
374                         i_rate, p_sys->i_band, p_sys->b_2eqz ? 2 : 1 );
375     for( i = 0; i < p_sys->i_band; i++ )
376     {
377         msg_Dbg( p_filter, "   %d Hz -> factor:%f alpha:%f beta:%f gamma:%f",
378                  (int)p_cfg->band[i].f_frequency, p_sys->f_amp[i],
379                  p_sys->f_alpha[i], p_sys->f_beta[i], p_sys->f_gamma[i]);
380     }
381     return VLC_SUCCESS;
382 }
383
384 static void EqzFilter( aout_instance_t *p_aout,
385                        aout_filter_t *p_filter, float *out, float *in,
386                        int i_samples, int i_channels )
387 {
388     aout_filter_sys_t *p_sys = p_filter->p_sys;
389     int i, ch, j;
390
391     for( i = 0; i < i_samples; i++ )
392     {
393         for( ch = 0; ch < i_channels; ch++ )
394         {
395             const float x = in[ch];
396             float o = 0.0;
397
398             for( j = 0; j < p_sys->i_band; j++ )
399             {
400                 float y = p_sys->f_alpha[j] * ( x - p_sys->x[ch][1] ) +
401                           p_sys->f_gamma[j] * p_sys->y[ch][j][0] -
402                           p_sys->f_beta[j]  * p_sys->y[ch][j][1];
403
404                 p_sys->y[ch][j][1] = p_sys->y[ch][j][0];
405                 p_sys->y[ch][j][0] = y;
406
407                 o += y * p_sys->f_amp[j];
408             }
409             p_sys->x[ch][1] = p_sys->x[ch][0];
410             p_sys->x[ch][0] = x;
411
412             /* Second filter */
413             if( p_sys->b_2eqz )
414             {
415                 const float x2 = EQZ_IN_FACTOR * x + o;
416                 o = 0.0;
417                 for( j = 0; j < p_sys->i_band; j++ )
418                 {
419                     float y = p_sys->f_alpha[j] * ( x2 - p_sys->x2[ch][1] ) +
420                               p_sys->f_gamma[j] * p_sys->y2[ch][j][0] -
421                               p_sys->f_beta[j]  * p_sys->y2[ch][j][1];
422
423                     p_sys->y2[ch][j][1] = p_sys->y2[ch][j][0];
424                     p_sys->y2[ch][j][0] = y;
425
426                     o += y * p_sys->f_amp[j];
427                 }
428                 p_sys->x2[ch][1] = p_sys->x2[ch][0];
429                 p_sys->x2[ch][0] = x2;
430
431                 /* We add source PCM + filtered PCM */
432                 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x2 + o );
433             }
434             else
435             {
436                 /* We add source PCM + filtered PCM */
437                 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x + o );
438             }
439         }
440
441         in  += i_channels;
442         out += i_channels;
443     }
444 }
445
446 static void EqzClean( aout_filter_t *p_filter )
447 {
448     aout_filter_sys_t *p_sys = p_filter->p_sys;
449
450     var_DelCallback( (aout_instance_t *)p_filter->p_parent,
451                         "equalizer-bands", BandsCallback, p_sys );
452     var_DelCallback( (aout_instance_t *)p_filter->p_parent,
453                         "equalizer-preset", PresetCallback, p_sys );
454     var_DelCallback( (aout_instance_t *)p_filter->p_parent,
455                         "equalizer-preamp", PreampCallback, p_sys );
456
457     free( p_sys->f_alpha );
458     free( p_sys->f_beta );
459     free( p_sys->f_gamma );
460
461     free( p_sys->f_amp );
462 }
463
464
465 static int PresetCallback( vlc_object_t *p_this, char const *psz_cmd,
466                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
467 {
468     aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
469     aout_instance_t *p_aout = (aout_instance_t *)p_this;
470
471     char *psz_preset = newval.psz_string;
472     char psz_newbands[120];
473
474     memset( psz_newbands, 0, 120 );
475
476     if( *psz_preset && p_sys->i_band == 10 )
477     {
478         int i;
479         /* */
480         for( i = 0; eqz_preset_10b[i] != NULL; i++ )
481         {
482             if( !strcasecmp( eqz_preset_10b[i]->psz_name, psz_preset ) )
483             {
484                 int j;
485                 p_sys->f_gamp *= pow( 10, eqz_preset_10b[i]->f_preamp / 20.0 );
486                 for( j = 0; j < p_sys->i_band; j++ )
487                 {
488                     lldiv_t div;
489                     p_sys->f_amp[j] = EqzConvertdB(
490                                         eqz_preset_10b[i]->f_amp[j] );
491                     div = lldiv( eqz_preset_10b[i]->f_amp[j] * 10000000,
492                                  10000000 );
493                     sprintf( psz_newbands, "%s "I64Fd".%07u", psz_newbands,
494                                       (int64_t)div.quot, (unsigned int) div.rem );
495                 }
496                 if( p_sys->b_first == VLC_FALSE )
497                 {
498                     var_SetString( p_aout, "equalizer-bands", psz_newbands );
499                     var_SetFloat( p_aout, "equalizer-preamp",
500                                     eqz_preset_10b[i]->f_preamp );
501                 }
502                 else
503                 {
504                     p_sys->psz_newbands = strdup( psz_newbands );
505                     p_sys->f_newpreamp = eqz_preset_10b[i]->f_preamp;
506                 }
507                 break;
508             }
509         }
510         if( eqz_preset_10b[i] == NULL )
511         {
512             msg_Err( p_aout, "equalizer preset '%s' not found", psz_preset );
513             msg_Dbg( p_aout, "full list:" );
514             for( i = 0; eqz_preset_10b[i] != NULL; i++ )
515                 msg_Dbg( p_aout, "  - '%s'", eqz_preset_10b[i]->psz_name );
516         }
517     }
518     return VLC_SUCCESS;
519 }
520
521 static int PreampCallback( vlc_object_t *p_this, char const *psz_cmd,
522                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
523 {
524     aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
525
526     if( newval.f_float < -20.0 )
527         newval.f_float = -20.0;
528     else if( newval.f_float > 20.0 )
529         newval.f_float = 20.0;
530     p_sys->f_gamp = pow( 10, newval.f_float /20.0);
531
532     return VLC_SUCCESS;
533 }
534
535 static int BandsCallback( vlc_object_t *p_this, char const *psz_cmd,
536                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
537 {
538     aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
539     char *psz_bands = newval.psz_string;
540
541     /* Same thing for bands */
542     if( *psz_bands )
543     {
544         char *p = psz_bands, *p_next;
545         int i;
546
547         for( i = 0; i < p_sys->i_band; i++ )
548         {
549             /* Read dB -20/20 */
550 #ifdef HAVE_STRTOF
551             float f = strtof( p, &p_next );
552 #else
553             float f = (float) strtod( p, &p_next );
554 #endif
555             if( !p_next || p_next == p ) break; /* strtof() failed */
556
557             p_sys->f_amp[i] = EqzConvertdB( f );
558
559             if( !*p ) break; /* end of line */
560             p=p_next+1;
561         }
562     }
563
564     return VLC_SUCCESS;
565 }