* equalizer: simple (and slow) 10 bands equalizer using a IIR filter.
[vlc.git] / modules / audio_filter / equalizer.c
1 /*****************************************************************************
2  * equalizer.c:
3  *****************************************************************************
4  * Copyright (C) 2004 VideoLAN
5  * $Id: goom.c 8019 2004-06-22 19:35:01Z fenrir $
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., 59 Temple Place - Suite 330, Boston, MA  02111, 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 #include "aout_internal.h"
34
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 PRESET_TEXT
53
54 #define BANDS_TEXT N_( "Bands gain")
55 #define BANDS_LONGTEXT N_( "Override preset bands gain in dB (-20 ... 20)" )
56
57 #define TWOPASS_TEXT N_( "Two pass" )
58 #define TWOPASS_LONGTEXT N_( "Filter twice the audio" )
59
60 #define PREAMP_TEXT N_("Global gain" )
61 #define PREAMP_LONGTEXT N_("Set the global gain in dB (-20 ... 20)" )
62
63 static char *preset_list[] = {
64     "flat", "classical", "club", "dance", "fullbass", "fullbasstreeble",
65     "fulltreeble", "headphones","largehall", "live", "party", "pop", "reggae",
66     "rock", "ska", "soft", "softrock", "techno"
67 };
68 static char *preset_list_text[] = {
69     N_("Flat"), N_("Classical"), N_("Club"), N_("Dance"), N_("Full bass"),
70     N_("Full bass and treeble"), N_("Full treeble"), N_("Laptop speakers and Headphones"),
71     N_("Large Hall"), N_("Live"), N_("Party"), N_("Pop"), N_("Reggae"),
72     N_("Rock"), N_("Ska"), N_("Soft"), N_("Soft rock"), N_("Techno"),
73 };
74
75 vlc_module_begin();
76     set_description( _("Equalizer 10 bands") );
77     set_capability( "audio filter", 0 );
78     add_string( "equalizer-preset", "flat", NULL, PRESET_TEXT, PRESET_LONGTEXT, VLC_TRUE );
79         change_string_list( preset_list, preset_list_text, 0 );
80     add_string( "equalizer-bands", NULL, NULL, BANDS_TEXT, BANDS_LONGTEXT, VLC_TRUE );
81     add_bool( "equalizer-2pass", 0, NULL, TWOPASS_TEXT, TWOPASS_LONGTEXT, VLC_TRUE );
82     add_float( "equalizer-preamp", 0.0, NULL, PREAMP_TEXT, PREAMP_LONGTEXT, VLC_TRUE );
83     set_callbacks( Open, Close );
84     add_shortcut( "equalizer" );
85 vlc_module_end();
86
87 /*****************************************************************************
88  * Local prototypes
89  *****************************************************************************/
90
91 typedef struct aout_filter_sys_t
92 {
93     /* Filter static config */
94     int i_band;
95     float *f_alpha;
96     float *f_beta;
97     float *f_gamma;
98
99     /* Filter dyn config */
100     float *f_amp;   /* Per band amp */
101     float f_gamp;   /* Global preamp */
102     vlc_bool_t b_2eqz;
103
104     /* Filter state */
105     float x[32][2];
106     float y[32][128][2];
107
108     /* Second filter state */
109     float x2[32][2];
110     float y2[32][128][2];
111
112 } aout_filter_sys_t;
113
114 static void DoWork( aout_instance_t *, aout_filter_t *,
115                     aout_buffer_t *, aout_buffer_t * );
116
117 #define EQZ_IN_FACTOR (0.25)
118 static int  EqzInit( aout_filter_t *, int i_rate );
119 static void EqzFilter( aout_filter_t *, float *out, float *in, int i_samples, int i_channels );
120 static void EqzClean( aout_filter_t * );
121
122 /*****************************************************************************
123  * Open:
124  *****************************************************************************/
125 static int Open( vlc_object_t *p_this )
126 {
127     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
128     aout_filter_sys_t *p_sys;
129
130     if( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' ) ||
131         p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
132     {
133         msg_Warn( p_filter, "Bad input or output format" );
134         return VLC_EGENERIC;
135     }
136     if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
137     {
138         msg_Warn( p_filter, "input and output formats are not similar" );
139         return VLC_EGENERIC;
140     }
141
142     p_filter->pf_do_work = DoWork;
143     p_filter->b_in_place = VLC_TRUE;
144
145     /* Allocate structure */
146     p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
147
148     if( EqzInit( p_filter, p_filter->input.i_rate ) )
149         return VLC_EGENERIC;
150
151     return VLC_SUCCESS;
152 }
153
154 /*****************************************************************************
155  * Close: close the plugin
156  *****************************************************************************/
157 static void Close( vlc_object_t *p_this )
158 {
159     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
160     aout_filter_sys_t *p_sys = p_filter->p_sys;
161
162     EqzClean( p_filter );
163     free( p_sys );
164 }
165
166 /*****************************************************************************
167  * DoWork: process samples buffer
168  *****************************************************************************
169  *
170  *****************************************************************************/
171 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
172                     aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
173 {
174     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
175     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
176
177     EqzFilter( p_filter, (float*)p_out_buf->p_buffer, (float*)p_in_buf->p_buffer,
178                p_in_buf->i_nb_samples, aout_FormatNbChannels( &p_filter->input ) );
179 }
180
181 /*****************************************************************************
182  * Equalizer stuff
183  *****************************************************************************/
184 typedef struct
185 {
186     int   i_band;
187
188     struct
189     {
190         float f_frequency;
191         float f_alpha;
192         float f_beta;
193         float f_gamma;
194     } band[];
195 } eqz_config_t;
196
197 /* Value from equ-xmms */
198 static const eqz_config_t eqz_config_44100_10b =
199 {
200     10,
201     {
202         {    60, 0.003013, 0.993973, 1.993901 },
203         {   170, 0.008490, 0.983019, 1.982437 },
204         {   310, 0.015374, 0.969252, 1.967331 },
205         {   600, 0.029328, 0.941343, 1.934254 },
206         {  1000, 0.047918, 0.904163, 1.884869 },
207         {  3000, 0.130408, 0.739184, 1.582718 },
208         {  6000, 0.226555, 0.546889, 1.015267 },
209         { 12000, 0.344937, 0.310127, -0.181410 },
210         { 14000, 0.366438, 0.267123, -0.521151 },
211         { 16000, 0.379009, 0.241981, -0.808451 },
212     }
213 };
214 static const eqz_config_t eqz_config_48000_10b =
215 {
216     10,
217     {
218         {    60, 0.002769, 0.994462, 1.994400 },
219         {   170, 0.007806, 0.984388, 1.983897 },
220         {   310, 0.014143, 0.971714, 1.970091 },
221         {   600, 0.027011, 0.945978, 1.939979 },
222         {  1000, 0.044203, 0.911595, 1.895241 },
223         {  3000, 0.121223, 0.757553, 1.623767 },
224         {  6000, 0.212888, 0.574224, 1.113145 },
225         { 12000, 0.331347, 0.337307, 0.000000 },
226         { 14000, 0.355263, 0.289473, -0.333740 },
227         { 16000, 0.371900, 0.256201, -0.628100 }
228     }
229 };
230
231 typedef struct
232 {
233     char *psz_name;
234     int  i_band;
235     float f_amp[];
236 } eqz_preset_t;
237
238 static const eqz_preset_t eqz_preset_flat_10b=
239 {
240     "flat", 10,
241     { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 },
242 };
243 static const eqz_preset_t eqz_preset_classical_10b=
244 {
245     "classical", 10,
246     { -1.11022e-15, -1.11022e-15, -1.11022e-15, -1.11022e-15, -1.11022e-15, -1.11022e-15, -7.2, -7.2, -7.2, -9.6 }
247 };
248 static const eqz_preset_t eqz_preset_club_10b=
249 {
250     "club", 10,
251     { -1.11022e-15, -1.11022e-15, 8, 5.6, 5.6, 5.6, 3.2, -1.11022e-15, -1.11022e-15, -1.11022e-15 }
252 };
253 static const eqz_preset_t eqz_preset_dance_10b=
254 {
255     "dance", 10,
256     { 9.6, 7.2, 2.4, -1.11022e-15, -1.11022e-15, -5.6, -7.2, -7.2, -1.11022e-15, -1.11022e-15 }
257 };
258 static const eqz_preset_t eqz_preset_fullbass_10b=
259 {
260     "fullbass", 10,
261     { -8, 9.6, 9.6, 5.6, 1.6, -4, -8, -10.4, -11.2, -11.2  }
262 };
263 static const eqz_preset_t eqz_preset_fullbasstreeble_10b=
264 {
265     "fullbasstreeble", 10,
266     { 7.2, 5.6, -1.11022e-15, -7.2, -4.8, 1.6, 8, 11.2, 12, 12 }
267 };
268
269 static const eqz_preset_t eqz_preset_fulltreeble_10b=
270 {
271     "fulltreeble", 10,
272     { -9.6, -9.6, -9.6, -4, 2.4, 11.2, 16, 16, 16, 16.8 }
273 };
274 static const eqz_preset_t eqz_preset_headphones_10b=
275 {
276     "headphones", 10,
277     { 4.8, 11.2, 5.6, -3.2, -2.4, 1.6, 4.8, 9.6, 12.8, 14.4 }
278 };
279 static const eqz_preset_t eqz_preset_largehall_10b=
280 {
281     "largehall", 10,
282     { 10.4, 10.4, 5.6, 5.6, -1.11022e-15, -4.8, -4.8, -4.8, -1.11022e-15, -1.11022e-15 }
283 };
284 static const eqz_preset_t eqz_preset_live_10b=
285 {
286     "live", 10,
287     { -4.8, -1.11022e-15, 4, 5.6, 5.6, 5.6, 4, 2.4, 2.4, 2.4 }
288 };
289 static const eqz_preset_t eqz_preset_party_10b=
290 {
291     "party", 10,
292     { 7.2, 7.2, -1.11022e-15, -1.11022e-15, -1.11022e-15, -1.11022e-15, -1.11022e-15, -1.11022e-15, 7.2, 7.2 }
293 };
294 static const eqz_preset_t eqz_preset_pop_10b=
295 {
296     "pop", 10,
297     { -1.6, 4.8, 7.2, 8, 5.6, -1.11022e-15, -2.4, -2.4, -1.6, -1.6 }
298 };
299 static const eqz_preset_t eqz_preset_reggae_10b=
300 {
301     "reggae", 10,
302     { -1.11022e-15, -1.11022e-15, -1.11022e-15, -5.6, -1.11022e-15, 6.4, 6.4, -1.11022e-15, -1.11022e-15, -1.11022e-15 }
303 };
304 static const eqz_preset_t eqz_preset_rock_10b=
305 {
306     "rock", 10,
307     { 8, 4.8, -5.6, -8, -3.2, 4, 8.8, 11.2, 11.2, 11.2 }
308 };
309 static const eqz_preset_t eqz_preset_ska_10b=
310 {
311     "ska", 10,
312     { -2.4, -4.8, -4, -1.11022e-15, 4, 5.6, 8.8, 9.6, 11.2, 9.6 }
313 };
314 static const eqz_preset_t eqz_preset_soft_10b=
315 {
316     "soft", 10,
317     { 4.8, 1.6, -1.11022e-15, -2.4, -1.11022e-15, 4, 8, 9.6, 11.2, 12 }
318 };
319 static const eqz_preset_t eqz_preset_softrock_10b=
320 {
321     "softrock", 10,
322     { 4, 4, 2.4, -1.11022e-15, -4, -5.6, -3.2, -1.11022e-15, 2.4, 8.8 }
323 };
324 static const eqz_preset_t eqz_preset_techno_10b=
325 {
326     "techno", 10,
327     { 8, 5.6, -1.11022e-15, -5.6, -4.8, -1.11022e-15, 8, 9.6, 9.6, 8.8 }
328 };
329
330 static const eqz_preset_t *eqz_preset_10b[] =
331 {
332     &eqz_preset_flat_10b,
333     &eqz_preset_classical_10b,
334     &eqz_preset_club_10b,
335     &eqz_preset_dance_10b,
336     &eqz_preset_fullbass_10b,
337     &eqz_preset_fullbasstreeble_10b,
338     &eqz_preset_fulltreeble_10b,
339     &eqz_preset_headphones_10b,
340     &eqz_preset_largehall_10b,
341     &eqz_preset_live_10b,
342     &eqz_preset_party_10b,
343     &eqz_preset_pop_10b,
344     &eqz_preset_reggae_10b,
345     &eqz_preset_rock_10b,
346     &eqz_preset_ska_10b,
347     &eqz_preset_soft_10b,
348     &eqz_preset_softrock_10b,
349     &eqz_preset_techno_10b,
350     NULL
351 };
352
353
354 static inline float EqzConvertdB( float db )
355 {
356     /* Map it to gain,
357      * (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)
358      * db = 20*log( out / in ) with out = in + amp*iir(i/EQZ_IN_FACTOR)
359      * or iir(i) == i for the center freq so
360      * db = 20*log( 1 + amp/EQZ_IN_FACTOR )
361      * -> amp = EQZ_IN_FACTOR*(10^(db/20) - 1)
362      **/
363
364     if( db < -20.0 )
365         db = -20.0;
366     else if(  db > 20.0 )
367         db = 20.0;
368     return EQZ_IN_FACTOR * ( pow( 10, db / 20.0 ) - 1.0 );
369 }
370
371 static int EqzInit( aout_filter_t *p_filter, int i_rate )
372 {
373     aout_filter_sys_t *p_sys = p_filter->p_sys;
374     const eqz_config_t *p_cfg;
375     char *psz;
376     int i, ch;
377     float f_float;
378
379     /* Select the config */
380     if( i_rate == 48000 )
381     {
382         p_cfg = &eqz_config_48000_10b;
383     }
384     else if( i_rate == 44100 )
385     {
386         p_cfg = &eqz_config_44100_10b;
387     }
388     else
389     {
390         /* TODO compute the coeffs on the fly */
391         msg_Err( p_filter, "unsupported rate" );
392         return VLC_EGENERIC;
393     }
394
395     /* Create the static filter config */
396     p_sys->i_band = p_cfg->i_band;
397     p_sys->f_alpha = malloc( p_sys->i_band * sizeof(float) );
398     p_sys->f_beta  = malloc( p_sys->i_band * sizeof(float) );
399     p_sys->f_gamma = malloc( p_sys->i_band * sizeof(float) );
400     for( i = 0; i < p_sys->i_band; i++ )
401     {
402         p_sys->f_alpha[i] = p_cfg->band[i].f_alpha;
403         p_sys->f_beta[i]  = p_cfg->band[i].f_beta;
404         p_sys->f_gamma[i] = p_cfg->band[i].f_gamma;
405     }
406
407     /* Filter dyn config */
408     p_sys->b_2eqz = VLC_FALSE;
409     p_sys->f_gamp = 1.0;
410     p_sys->f_amp   = malloc( p_sys->i_band * sizeof(float) );
411     for( i = 0; i < p_sys->i_band; i++ )
412     {
413         p_sys->f_amp[i] = 0.0;
414     }
415
416     /* Filter state */
417     for( ch = 0; ch < 32; ch++ )
418     {
419         p_sys->x[ch][0]  =
420         p_sys->x[ch][1]  =
421         p_sys->x2[ch][0] =
422         p_sys->x2[ch][1] = 0.0;
423
424         for( i = 0; i < p_sys->i_band; i++ )
425         {
426             p_sys->y[ch][i][0]  =
427             p_sys->y[ch][i][1]  =
428             p_sys->y2[ch][i][0] =
429             p_sys->y2[ch][i][1] = 0.0;
430         }
431     }
432
433     /* Now parse config */
434     p_sys->b_2eqz = var_CreateGetBool( p_filter, "equalizer-2pass" );
435     f_float = var_CreateGetFloat( p_filter, "equalizer-preamp" );
436     if( f_float < -20.0 )
437         f_float = -20.0;
438     else if( f_float > 20.0 )
439         f_float = 20.0;
440     p_sys->f_gamp = pow( 10, f_float /20.0);
441
442     psz = var_CreateGetString( p_filter, "equalizer-preset" );
443     if( *psz && p_sys->i_band == 10 )
444     {
445         int i;
446         /* */
447         for( i = 0; eqz_preset_10b[i] != NULL; i++ )
448         {
449             if( !strcasecmp( eqz_preset_10b[i]->psz_name, psz ) )
450             {
451                 int j;
452                 for( j = 0; j < p_sys->i_band; j++ )
453                     p_sys->f_amp[j] = EqzConvertdB( eqz_preset_10b[i]->f_amp[j] );
454                 break;
455             }
456         }
457         if( eqz_preset_10b[i] == NULL )
458         {
459             msg_Err( p_filter, "equalizer preset '%s' not found", psz );
460             msg_Dbg( p_filter, "full list:" );
461             for( i = 0; eqz_preset_10b[i] != NULL; i++ )
462                 msg_Dbg( p_filter, "  - '%s'", eqz_preset_10b[i]->psz_name );
463         }
464     }
465     free( psz );
466
467     psz = var_CreateGetString( p_filter, "equalizer-bands" );
468     if( *psz )
469     {
470         char *p = psz;
471         int i;
472         for( i = 0; i < p_sys->i_band; i++ )
473         {
474             float f;
475
476             /* Read dB -20/20*/
477             f = strtof( p, &p );
478
479             p_sys->f_amp[i] = EqzConvertdB( f );
480
481             if( p == NULL )
482                 break;
483             p++;
484             if( *p == '\0' )
485                 break;
486         }
487     }
488     free( psz );
489
490     msg_Dbg( p_filter, "equalizer loaded for %d Hz with %d bands %d pass",
491              i_rate, p_sys->i_band, p_sys->b_2eqz ? 2 : 1 );
492     for( i = 0; i < p_sys->i_band; i++ )
493     {
494         msg_Dbg( p_filter, "   %d Hz -> factor:%f alpha:%f beta:%f gamma:%f",
495                  (int)p_cfg->band[i].f_frequency, p_sys->f_amp[i],
496                  p_sys->f_alpha[i], p_sys->f_beta[i], p_sys->f_gamma[i]);
497     }
498     return VLC_SUCCESS;
499 }
500
501 static void EqzFilter( aout_filter_t *p_filter, float *out, float *in, int i_samples, int i_channels )
502 {
503     aout_filter_sys_t *p_sys = p_filter->p_sys;
504     int i, ch, j;
505
506     for( i = 0; i < i_samples; i++ )
507     {
508         for( ch = 0; ch < i_channels; ch++ )
509         {
510             const float x = in[ch];
511             float o = 0.0;
512
513             for( j = 0; j < p_sys->i_band; j++ )
514             {
515                 float y = p_sys->f_alpha[j] * ( x - p_sys->x[ch][1] ) +
516                           p_sys->f_gamma[j] * p_sys->y[ch][j][0] -
517                           p_sys->f_beta[j]  * p_sys->y[ch][j][1];
518
519                 p_sys->y[ch][j][1] = p_sys->y[ch][j][0];
520                 p_sys->y[ch][j][0] = y;
521
522                 o += y * p_sys->f_amp[j];
523             }
524             p_sys->x[ch][1] = p_sys->x[ch][0];
525             p_sys->x[ch][0] = x;
526
527             /* Second filter */
528             if( p_sys->b_2eqz )
529             {
530                 const float x2 = EQZ_IN_FACTOR * x + o;
531                 o = 0.0;
532                 for( j = 0; j < p_sys->i_band; j++ )
533                 {
534                     float y = p_sys->f_alpha[j] * ( x2 - p_sys->x2[ch][1] ) +
535                               p_sys->f_gamma[j] * p_sys->y2[ch][j][0] -
536                               p_sys->f_beta[j]  * p_sys->y2[ch][j][1];
537
538                     p_sys->y2[ch][j][1] = p_sys->y2[ch][j][0];
539                     p_sys->y2[ch][j][0] = y;
540
541                     o += y * p_sys->f_amp[j];
542                 }
543                 p_sys->x2[ch][1] = p_sys->x2[ch][0];
544                 p_sys->x2[ch][0] = x2;
545
546                 /* We add source PCM + filtered PCM */
547                 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x2 + o );
548             }
549             else
550             {
551                 /* We add source PCM + filtered PCM */
552                 out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x + o );
553             }
554         }
555
556         in  += i_channels;
557         out += i_channels;
558     }
559 }
560
561 static void EqzClean( aout_filter_t *p_filter )
562 {
563     aout_filter_sys_t *p_sys = p_filter->p_sys;
564
565     free( p_sys->f_alpha );
566     free( p_sys->f_beta );
567     free( p_sys->f_gamma );
568
569     free( p_sys->f_amp );
570 }
571