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