equalizer.c 18.7 KB
Newer Older
1 2 3
/*****************************************************************************
 * equalizer.c:
 *****************************************************************************
4
 * Copyright (C) 2004, 2006 the VideoLAN team
5
 * $Id$
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23 24 25 26 27 28
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <math.h>

29 30 31 32
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

33 34
#include <vlc/vlc.h>

Clément Stenac's avatar
Clément Stenac committed
35
#include "vlc_aout.h"
36

Jérome Decoodt's avatar
Jérome Decoodt committed
37
#include "equalizer_presets.h"
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
/* TODO:
 *  - add tables for other rates ( 22500, 11250, ...)
 *  - optimize a bit (you can hardly do slower ;)
 *  - add tables for more bands (15 and 32 would be cool), maybe with auto coeffs
 *  computation (not too hard once the Q is found).
 *  - support for external preset
 *  - callback to handle preset changes on the fly
 *  - ...
 */

/*****************************************************************************
 * Module descriptor
 *****************************************************************************/
static int  Open ( vlc_object_t * );
static void Close( vlc_object_t * );

#define PRESET_TEXT N_( "Equalizer preset" )
55
#define PRESET_LONGTEXT N_("Preset to use for the equalizer." )
56 57

#define BANDS_TEXT N_( "Bands gain")
58
#define BANDS_LONGTEXT N_( \
59 60
         "Don't use presets, but manually specified bands. You need to " \
         "provide 10 values between -20dB and 20dB, separated by spaces, " \
Christophe Mutricy's avatar
Christophe Mutricy committed
61
         "e.g. \"0 2 4 2 0 -2 -4 -2 0\"." )
62 63

#define TWOPASS_TEXT N_( "Two pass" )
64
#define TWOPASS_LONGTEXT N_( "Filter the audio twice. This provides a more "  \
65
         "intense effect.")
66 67

#define PREAMP_TEXT N_("Global gain" )
68
#define PREAMP_LONGTEXT N_("Set the global gain in dB (-20 ... 20)." )
69 70

vlc_module_begin();
71
    set_description( _("Equalizer with 10 bands") );
72
    set_shortname( _("Equalizer" ) );
73
    set_capability( "audio filter", 0 );
Clément Stenac's avatar
Clément Stenac committed
74 75 76
    set_category( CAT_AUDIO );
    set_subcategory( SUBCAT_AUDIO_AFILTER );

77
    add_string( "equalizer-preset", "flat", NULL, PRESET_TEXT,
78
                PRESET_LONGTEXT, false );
79
        change_string_list( preset_list, preset_list_text, 0 );
80
    add_string( "equalizer-bands", NULL, NULL, BANDS_TEXT,
81
                BANDS_LONGTEXT, true );
82
    add_bool( "equalizer-2pass", 0, NULL, TWOPASS_TEXT,
83
              TWOPASS_LONGTEXT, true );
84
    add_float( "equalizer-preamp", 12.0, NULL, PREAMP_TEXT,
85
               PREAMP_LONGTEXT, true );
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
    set_callbacks( Open, Close );
    add_shortcut( "equalizer" );
vlc_module_end();

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
typedef struct aout_filter_sys_t
{
    /* Filter static config */
    int i_band;
    float *f_alpha;
    float *f_beta;
    float *f_gamma;

101 102
    float f_newpreamp;
    char *psz_newbands;
103
    bool b_first;
104

105 106 107
    /* Filter dyn config */
    float *f_amp;   /* Per band amp */
    float f_gamp;   /* Global preamp */
108
    bool b_2eqz;
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123

    /* Filter state */
    float x[32][2];
    float y[32][128][2];

    /* Second filter state */
    float x2[32][2];
    float y2[32][128][2];

} aout_filter_sys_t;

static void DoWork( aout_instance_t *, aout_filter_t *,
                    aout_buffer_t *, aout_buffer_t * );

#define EQZ_IN_FACTOR (0.25)
124
static int  EqzInit( aout_filter_t *, int );
Rafaël Carré's avatar
Rafaël Carré committed
125
static void EqzFilter( aout_filter_t *, float *, float *,
126
                        int, int );
127 128
static void EqzClean( aout_filter_t * );

129 130 131 132 133 134 135 136 137
static int PresetCallback( vlc_object_t *, char const *,
                                           vlc_value_t, vlc_value_t, void * );
static int PreampCallback( vlc_object_t *, char const *,
                                           vlc_value_t, vlc_value_t, void * );
static int BandsCallback ( vlc_object_t *, char const *,
                                           vlc_value_t, vlc_value_t, void * );



138 139 140 141 142 143 144
/*****************************************************************************
 * Open:
 *****************************************************************************/
static int Open( vlc_object_t *p_this )
{
    aout_filter_t     *p_filter = (aout_filter_t *)p_this;
    aout_filter_sys_t *p_sys;
145
    bool         b_fit = true;
146 147 148 149

    if( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' ) ||
        p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
    {
150
        b_fit = false;
151 152
        p_filter->input.i_format = VLC_FOURCC('f','l','3','2');
        p_filter->output.i_format = VLC_FOURCC('f','l','3','2');
153
        msg_Warn( p_filter, "bad input or output format" );
154 155 156
    }
    if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
    {
157
        b_fit = false;
158 159
        memcpy( &p_filter->output, &p_filter->input,
                sizeof(audio_sample_format_t) );
160
        msg_Warn( p_filter, "input and output formats are not similar" );
161 162 163 164
    }

    if ( ! b_fit )
    {
165 166 167 168
        return VLC_EGENERIC;
    }

    p_filter->pf_do_work = DoWork;
169
    p_filter->b_in_place = true;
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199

    /* Allocate structure */
    p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );

    if( EqzInit( p_filter, p_filter->input.i_rate ) )
        return VLC_EGENERIC;

    return VLC_SUCCESS;
}

/*****************************************************************************
 * Close: close the plugin
 *****************************************************************************/
static void Close( vlc_object_t *p_this )
{
    aout_filter_t     *p_filter = (aout_filter_t *)p_this;
    aout_filter_sys_t *p_sys = p_filter->p_sys;

    EqzClean( p_filter );
    free( p_sys );
}

/*****************************************************************************
 * DoWork: process samples buffer
 *****************************************************************************
 *
 *****************************************************************************/
static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
                    aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
{
Rafaël Carré's avatar
Rafaël Carré committed
200
    VLC_UNUSED(p_aout);
201 202 203
    p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
    p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;

Rafaël Carré's avatar
Rafaël Carré committed
204
    EqzFilter( p_filter, (float*)p_out_buf->p_buffer,
205 206
               (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
               aout_FormatNbChannels( &p_filter->input ) );
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
}

/*****************************************************************************
 * Equalizer stuff
 *****************************************************************************/
typedef struct
{
    int   i_band;

    struct
    {
        float f_frequency;
        float f_alpha;
        float f_beta;
        float f_gamma;
222
    } band[EQZ_BANDS_MAX];
223

224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
} eqz_config_t;

/* Value from equ-xmms */
static const eqz_config_t eqz_config_44100_10b =
{
    10,
    {
        {    60, 0.003013, 0.993973, 1.993901 },
        {   170, 0.008490, 0.983019, 1.982437 },
        {   310, 0.015374, 0.969252, 1.967331 },
        {   600, 0.029328, 0.941343, 1.934254 },
        {  1000, 0.047918, 0.904163, 1.884869 },
        {  3000, 0.130408, 0.739184, 1.582718 },
        {  6000, 0.226555, 0.546889, 1.015267 },
        { 12000, 0.344937, 0.310127, -0.181410 },
        { 14000, 0.366438, 0.267123, -0.521151 },
        { 16000, 0.379009, 0.241981, -0.808451 },
    }
};
static const eqz_config_t eqz_config_48000_10b =
{
    10,
    {
        {    60, 0.002769, 0.994462, 1.994400 },
        {   170, 0.007806, 0.984388, 1.983897 },
        {   310, 0.014143, 0.971714, 1.970091 },
        {   600, 0.027011, 0.945978, 1.939979 },
        {  1000, 0.044203, 0.911595, 1.895241 },
        {  3000, 0.121223, 0.757553, 1.623767 },
        {  6000, 0.212888, 0.574224, 1.113145 },
        { 12000, 0.331347, 0.337307, 0.000000 },
        { 14000, 0.355263, 0.289473, -0.333740 },
        { 16000, 0.371900, 0.256201, -0.628100 }
    }
};

static inline float EqzConvertdB( float db )
{
    /* Map it to gain,
     * (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)
     * db = 20*log( out / in ) with out = in + amp*iir(i/EQZ_IN_FACTOR)
     * or iir(i) == i for the center freq so
     * db = 20*log( 1 + amp/EQZ_IN_FACTOR )
     * -> amp = EQZ_IN_FACTOR*(10^(db/20) - 1)
     **/

    if( db < -20.0 )
        db = -20.0;
    else if(  db > 20.0 )
        db = 20.0;
    return EQZ_IN_FACTOR * ( pow( 10, db / 20.0 ) - 1.0 );
}

static int EqzInit( aout_filter_t *p_filter, int i_rate )
{
    aout_filter_sys_t *p_sys = p_filter->p_sys;
    const eqz_config_t *p_cfg;
    int i, ch;
282 283
    vlc_value_t val1, val2, val3;
    aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
284 285 286 287 288 289 290 291 292 293 294 295 296

    /* Select the config */
    if( i_rate == 48000 )
    {
        p_cfg = &eqz_config_48000_10b;
    }
    else if( i_rate == 44100 )
    {
        p_cfg = &eqz_config_44100_10b;
    }
    else
    {
        /* TODO compute the coeffs on the fly */
297
        msg_Err( p_filter, "rate not supported" );
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
        return VLC_EGENERIC;
    }

    /* Create the static filter config */
    p_sys->i_band = p_cfg->i_band;
    p_sys->f_alpha = malloc( p_sys->i_band * sizeof(float) );
    p_sys->f_beta  = malloc( p_sys->i_band * sizeof(float) );
    p_sys->f_gamma = malloc( p_sys->i_band * sizeof(float) );
    for( i = 0; i < p_sys->i_band; i++ )
    {
        p_sys->f_alpha[i] = p_cfg->band[i].f_alpha;
        p_sys->f_beta[i]  = p_cfg->band[i].f_beta;
        p_sys->f_gamma[i] = p_cfg->band[i].f_gamma;
    }

    /* Filter dyn config */
314
    p_sys->b_2eqz = false;
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
    p_sys->f_gamp = 1.0;
    p_sys->f_amp   = malloc( p_sys->i_band * sizeof(float) );
    for( i = 0; i < p_sys->i_band; i++ )
    {
        p_sys->f_amp[i] = 0.0;
    }

    /* Filter state */
    for( ch = 0; ch < 32; ch++ )
    {
        p_sys->x[ch][0]  =
        p_sys->x[ch][1]  =
        p_sys->x2[ch][0] =
        p_sys->x2[ch][1] = 0.0;

        for( i = 0; i < p_sys->i_band; i++ )
        {
            p_sys->y[ch][i][0]  =
            p_sys->y[ch][i][1]  =
            p_sys->y2[ch][i][0] =
            p_sys->y2[ch][i][1] = 0.0;
        }
    }

339 340
    var_CreateGetString( p_aout,"equalizer-bands" );
    var_CreateGetString( p_aout, "equalizer-preset" );
341

342
    p_sys->b_2eqz = var_CreateGetBool( p_aout, "equalizer-2pass" );
343

344
    var_CreateGetFloat( p_aout, "equalizer-preamp" );
345

346 347 348 349
    /* Get initial values */
    var_Get( p_aout, "equalizer-preset", &val1 );
    var_Get( p_aout, "equalizer-bands", &val2 );
    var_Get( p_aout, "equalizer-preamp", &val3 );
350

351
    p_sys->b_first = true;
352 353 354
    PresetCallback( VLC_OBJECT( p_aout ), NULL, val1, val1, p_sys );
    BandsCallback(  VLC_OBJECT( p_aout ), NULL, val2, val2, p_sys );
    PreampCallback( VLC_OBJECT( p_aout ), NULL, val3, val3, p_sys );
355
    p_sys->b_first = false;
356 357 358 359

    /* Register preset bands (for intf) if : */
    /* We have no bands info --> the preset info must be given to the intf */
    /* or The bands info matches the preset */
360 361 362 363 364
    if (p_sys->psz_newbands == NULL)
    {
        msg_Err(p_filter, "No preset selected");
        return (VLC_EGENERIC);
    }
365 366 367 368
    if( ( *(val2.psz_string) &&
        strstr( p_sys->psz_newbands, val2.psz_string ) ) || !*val2.psz_string )
    {
        var_SetString( p_aout, "equalizer-bands", p_sys->psz_newbands );
369 370
        if( p_sys->f_newpreamp == p_sys->f_gamp )
            var_SetFloat( p_aout, "equalizer-preamp", p_sys->f_newpreamp );
371
    }
372 373 374 375 376

    /* Add our own callbacks */
    var_AddCallback( p_aout, "equalizer-preset", PresetCallback, p_sys );
    var_AddCallback( p_aout, "equalizer-bands", BandsCallback, p_sys );
    var_AddCallback( p_aout, "equalizer-preamp", PreampCallback, p_sys );
377 378

    msg_Dbg( p_filter, "equalizer loaded for %d Hz with %d bands %d pass",
379
                        i_rate, p_sys->i_band, p_sys->b_2eqz ? 2 : 1 );
380 381 382 383 384 385 386 387 388
    for( i = 0; i < p_sys->i_band; i++ )
    {
        msg_Dbg( p_filter, "   %d Hz -> factor:%f alpha:%f beta:%f gamma:%f",
                 (int)p_cfg->band[i].f_frequency, p_sys->f_amp[i],
                 p_sys->f_alpha[i], p_sys->f_beta[i], p_sys->f_gamma[i]);
    }
    return VLC_SUCCESS;
}

Rafaël Carré's avatar
Rafaël Carré committed
389
static void EqzFilter( aout_filter_t *p_filter, float *out, float *in,
390
                       int i_samples, int i_channels )
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
{
    aout_filter_sys_t *p_sys = p_filter->p_sys;
    int i, ch, j;

    for( i = 0; i < i_samples; i++ )
    {
        for( ch = 0; ch < i_channels; ch++ )
        {
            const float x = in[ch];
            float o = 0.0;

            for( j = 0; j < p_sys->i_band; j++ )
            {
                float y = p_sys->f_alpha[j] * ( x - p_sys->x[ch][1] ) +
                          p_sys->f_gamma[j] * p_sys->y[ch][j][0] -
                          p_sys->f_beta[j]  * p_sys->y[ch][j][1];

                p_sys->y[ch][j][1] = p_sys->y[ch][j][0];
                p_sys->y[ch][j][0] = y;

                o += y * p_sys->f_amp[j];
            }
            p_sys->x[ch][1] = p_sys->x[ch][0];
            p_sys->x[ch][0] = x;

            /* Second filter */
            if( p_sys->b_2eqz )
            {
                const float x2 = EQZ_IN_FACTOR * x + o;
                o = 0.0;
                for( j = 0; j < p_sys->i_band; j++ )
                {
                    float y = p_sys->f_alpha[j] * ( x2 - p_sys->x2[ch][1] ) +
                              p_sys->f_gamma[j] * p_sys->y2[ch][j][0] -
                              p_sys->f_beta[j]  * p_sys->y2[ch][j][1];

                    p_sys->y2[ch][j][1] = p_sys->y2[ch][j][0];
                    p_sys->y2[ch][j][0] = y;

                    o += y * p_sys->f_amp[j];
                }
                p_sys->x2[ch][1] = p_sys->x2[ch][0];
                p_sys->x2[ch][0] = x2;

                /* We add source PCM + filtered PCM */
                out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x2 + o );
            }
            else
            {
                /* We add source PCM + filtered PCM */
                out[ch] = p_sys->f_gamp *( EQZ_IN_FACTOR * x + o );
            }
        }

        in  += i_channels;
        out += i_channels;
    }
}

static void EqzClean( aout_filter_t *p_filter )
{
    aout_filter_sys_t *p_sys = p_filter->p_sys;

454 455 456 457 458 459 460
    var_DelCallback( (aout_instance_t *)p_filter->p_parent,
                        "equalizer-bands", BandsCallback, p_sys );
    var_DelCallback( (aout_instance_t *)p_filter->p_parent,
                        "equalizer-preset", PresetCallback, p_sys );
    var_DelCallback( (aout_instance_t *)p_filter->p_parent,
                        "equalizer-preamp", PreampCallback, p_sys );

461 462 463 464 465
    free( p_sys->f_alpha );
    free( p_sys->f_beta );
    free( p_sys->f_gamma );

    free( p_sys->f_amp );
466 467 468 469
}


static int PresetCallback( vlc_object_t *p_this, char const *psz_cmd,
470
                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
471
{
Rafaël Carré's avatar
Rafaël Carré committed
472
    VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
    aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
    aout_instance_t *p_aout = (aout_instance_t *)p_this;

    char *psz_preset = newval.psz_string;
    char psz_newbands[120];

    memset( psz_newbands, 0, 120 );

    if( *psz_preset && p_sys->i_band == 10 )
    {
        int i;
        /* */
        for( i = 0; eqz_preset_10b[i] != NULL; i++ )
        {
            if( !strcasecmp( eqz_preset_10b[i]->psz_name, psz_preset ) )
            {
                int j;
                p_sys->f_gamp *= pow( 10, eqz_preset_10b[i]->f_preamp / 20.0 );
                for( j = 0; j < p_sys->i_band; j++ )
                {
493
                    lldiv_t div;
494 495
                    p_sys->f_amp[j] = EqzConvertdB(
                                        eqz_preset_10b[i]->f_amp[j] );
496 497
                    div = lldiv( eqz_preset_10b[i]->f_amp[j] * 10000000,
                                 10000000 );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
498
                    sprintf( psz_newbands, "%s %"PRId64".%07u", psz_newbands,
Laurent Aimar's avatar
Laurent Aimar committed
499
                                      (int64_t)div.quot, (unsigned int) div.rem );
500
                }
501
                if( p_sys->b_first == false )
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
                {
                    var_SetString( p_aout, "equalizer-bands", psz_newbands );
                    var_SetFloat( p_aout, "equalizer-preamp",
                                    eqz_preset_10b[i]->f_preamp );
                }
                else
                {
                    p_sys->psz_newbands = strdup( psz_newbands );
                    p_sys->f_newpreamp = eqz_preset_10b[i]->f_preamp;
                }
                break;
            }
        }
        if( eqz_preset_10b[i] == NULL )
        {
            msg_Err( p_aout, "equalizer preset '%s' not found", psz_preset );
            msg_Dbg( p_aout, "full list:" );
            for( i = 0; eqz_preset_10b[i] != NULL; i++ )
                msg_Dbg( p_aout, "  - '%s'", eqz_preset_10b[i]->psz_name );
        }
    }
    return VLC_SUCCESS;
}

static int PreampCallback( vlc_object_t *p_this, char const *psz_cmd,
527
                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
528
{
Rafaël Carré's avatar
Rafaël Carré committed
529
    VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
530 531 532 533 534 535 536 537 538 539 540 541
    aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;

    if( newval.f_float < -20.0 )
        newval.f_float = -20.0;
    else if( newval.f_float > 20.0 )
        newval.f_float = 20.0;
    p_sys->f_gamp = pow( 10, newval.f_float /20.0);

    return VLC_SUCCESS;
}

static int BandsCallback( vlc_object_t *p_this, char const *psz_cmd,
542
                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
543
{
Rafaël Carré's avatar
Rafaël Carré committed
544
    VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
545 546 547 548 549 550
    aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
    char *psz_bands = newval.psz_string;

    /* Same thing for bands */
    if( *psz_bands )
    {
551
        char *p = psz_bands, *p_next;
552
        int i;
553

554 555
        for( i = 0; i < p_sys->i_band; i++ )
        {
556
            /* Read dB -20/20 */
557
#ifdef HAVE_STRTOF
558
            float f = strtof( p, &p_next );
559 560 561
#else
            float f = (float) strtod( p, &p_next );
#endif
562
            if( !p_next || p_next == p ) break; /* strtof() failed */
563 564 565

            p_sys->f_amp[i] = EqzConvertdB( f );

566
            if( !*p ) break; /* end of line */
567
            p=p_next+1;
568 569
        }
    }
570

571
    return VLC_SUCCESS;
572
}