git.sesse.net Git - vlc/blob - modules/audio_filter/normvol.c

   1 /*****************************************************************************
   2  * normvol.c: volume normalizer
   3  *****************************************************************************
   4  * Copyright (C) 2001, 2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   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  * TODO:
  26  *
  27  * We should detect fast power increases and react faster to these
  28  * This way, we can increase the buffer size to get a more stable filter */
  29
  30
  31 /*****************************************************************************
  32  * Preamble
  33  *****************************************************************************/
  34
  35 #ifdef HAVE_CONFIG_H
  36 # include "config.h"
  37 #endif
  38
  39 #include <errno.h>                                                 /* ENOMEM */
  40 #include <ctype.h>
  41 #include <signal.h>
  42
  43 #include <math.h>
  44
  45
  46 #include <vlc_common.h>
  47 #include <vlc_plugin.h>
  48
  49 #include <vlc_aout.h>
  50
  51 /*****************************************************************************
  52  * Local prototypes
  53  *****************************************************************************/
  54
  55 static int  Open     ( vlc_object_t * );
  56 static void Close    ( vlc_object_t * );
  57 static void DoWork   ( aout_instance_t * , aout_filter_t *,
  58                 aout_buffer_t * , aout_buffer_t *);
  59
  60 struct aout_filter_sys_t
  61 {
  62     int i_nb;
  63     float *p_last;
  64     float f_max;
  65 };
  66
  67 /*****************************************************************************
  68  * Module descriptor
  69  *****************************************************************************/
  70 #define BUFF_TEXT N_("Number of audio buffers" )
  71 #define BUFF_LONGTEXT N_("This is the number of audio buffers on which the " \
  72                 "power measurement is made. A higher number of buffers will " \
  73                 "increase the response time of the filter to a spike " \
  74                 "but will make it less sensitive to short variations." )
  75
  76 #define LEVEL_TEXT N_("Max level" )
  77 #define LEVEL_LONGTEXT N_("If the average power over the last N buffers " \
  78                "is higher than this value, the volume will be normalized. " \
  79                "This value is a positive floating point number. A value " \
  80                "between 0.5 and 10 seems sensible." )
  81
  82 vlc_module_begin ()
  83     set_description( N_("Volume normalizer") )
  84     set_shortname( N_("Volume normalizer") )
  85     set_category( CAT_AUDIO )
  86     set_subcategory( SUBCAT_AUDIO_AFILTER )
  87     add_shortcut( "volnorm" )
  88     add_integer( "norm-buff-size", 20 ,NULL ,BUFF_TEXT, BUFF_LONGTEXT,
  89                  true )
  90     add_float( "norm-max-level", 2.0, NULL, LEVEL_TEXT,
  91                LEVEL_LONGTEXT, true )
  92     set_capability( "audio filter", 0 )
  93     set_callbacks( Open, Close )
  94 vlc_module_end ()
  95
  96 /*****************************************************************************
  97  * Open: initialize and create stuff
  98  *****************************************************************************/
  99 static int Open( vlc_object_t *p_this )
 100 {
 101     aout_filter_t *p_filter = (aout_filter_t*)p_this;
 102     bool b_fit = true;
 103     int i_channels;
 104     aout_filter_sys_t *p_sys;
 105
 106     if( p_filter->input.i_format != VLC_CODEC_FL32 ||
 107         p_filter->output.i_format != VLC_CODEC_FL32 )
 108     {
 109         b_fit = false;
 110         p_filter->input.i_format = VLC_CODEC_FL32;
 111         p_filter->output.i_format = VLC_CODEC_FL32;
 112         msg_Warn( p_filter, "bad input or output format" );
 113     }
 114
 115     if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
 116     {
 117         b_fit = false;
 118         memcpy( &p_filter->output, &p_filter->input,
 119                 sizeof(audio_sample_format_t) );
 120         msg_Warn( p_filter, "input and output formats are not similar" );
 121     }
 122
 123     if ( ! b_fit )
 124     {
 125         return VLC_EGENERIC;
 126     }
 127
 128     p_filter->pf_do_work = DoWork;
 129     p_filter->b_in_place = true;
 130
 131     i_channels = aout_FormatNbChannels( &p_filter->input );
 132
 133     p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
 134     if( !p_sys )
 135         return VLC_ENOMEM;
 136     p_sys->i_nb = var_CreateGetInteger( p_filter->p_parent, "norm-buff-size" );
 137     p_sys->f_max = var_CreateGetFloat( p_filter->p_parent, "norm-max-level" );
 138
 139     if( p_sys->f_max <= 0 ) p_sys->f_max = 0.01;
 140
 141     /* We need to store (nb_buffers+1)*nb_channels floats */
 142     p_sys->p_last = calloc( i_channels * (p_filter->p_sys->i_nb + 2), sizeof(float) );
 143     if( !p_sys->p_last )
 144     {
 145         free( p_sys );
 146         return VLC_ENOMEM;
 147     }
 148
 149     return VLC_SUCCESS;
 150 }
 151
 152 /*****************************************************************************
 153  * DoWork : normalizes and sends a buffer
 154  *****************************************************************************/
 155  static void DoWork( aout_instance_t *p_aout, aout_filter_t *p_filter,
 156                      aout_buffer_t *p_in_buf, aout_buffer_t *p_out_buf )
 157 {
 158     float *pf_sum;
 159     float *pf_gain;
 160     float f_average = 0;
 161     int i, i_chan;
 162
 163     int i_samples = p_in_buf->i_nb_samples;
 164     int i_channels = aout_FormatNbChannels( &p_filter->input );
 165     float *p_out = (float*)p_out_buf->p_buffer;
 166     float *p_in =  (float*)p_in_buf->p_buffer;
 167
 168     struct aout_filter_sys_t *p_sys = p_filter->p_sys;
 169
 170     pf_sum = calloc( i_channels, sizeof(float) );
 171     if( !pf_sum )
 172         return;
 173
 174     pf_gain = malloc( sizeof(float) * i_channels );
 175     if( !pf_gain )
 176     {
 177         free( pf_sum );
 178         return;
 179     }
 180
 181     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
 182     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
 183
 184     /* Calculate the average power level on this buffer */
 185     for( i = 0 ; i < i_samples; i++ )
 186     {
 187         for( i_chan = 0; i_chan < i_channels; i_chan++ )
 188         {
 189             float f_sample = p_in[i_chan];
 190             float f_square = pow( f_sample, 2 );
 191             pf_sum[i_chan] += f_square;
 192         }
 193         p_in += i_channels;
 194     }
 195
 196     /* sum now contains for each channel the sigma(value²) */
 197     for( i_chan = 0; i_chan < i_channels; i_chan++ )
 198     {
 199         /* Shift our lastbuff */
 200         memmove( &p_sys->p_last[ i_chan * p_sys->i_nb],
 201                         &p_sys->p_last[i_chan * p_sys->i_nb + 1],
 202                  (p_sys->i_nb-1) * sizeof( float ) );
 203
 204         /* Insert the new average : sqrt(sigma(value²)) */
 205         p_sys->p_last[ i_chan * p_sys->i_nb + p_sys->i_nb - 1] =
 206                 sqrt( pf_sum[i_chan] );
 207
 208         pf_sum[i_chan] = 0;
 209
 210         /* Get the average power on the lastbuff */
 211         f_average = 0;
 212         for( i = 0; i < p_sys->i_nb ; i++)
 213         {
 214             f_average += p_sys->p_last[ i_chan * p_sys->i_nb + i ];
 215         }
 216         f_average = f_average / p_sys->i_nb;
 217
 218         /* Seuil arbitraire */
 219         p_sys->f_max = var_GetFloat( p_aout, "norm-max-level" );
 220
 221         //fprintf(stderr,"Average %f, max %f\n", f_average, p_sys->f_max );
 222         if( f_average > p_sys->f_max )
 223         {
 224              pf_gain[i_chan] = f_average / p_sys->f_max;
 225         }
 226         else
 227         {
 228            pf_gain[i_chan] = 1;
 229         }
 230     }
 231
 232     /* Apply gain */
 233     for( i = 0; i < i_samples; i++)
 234     {
 235         for( i_chan = 0; i_chan < i_channels; i_chan++ )
 236         {
 237             p_out[i_chan] /= pf_gain[i_chan];
 238         }
 239         p_out += i_channels;
 240     }
 241
 242     free( pf_sum );
 243     free( pf_gain );
 244
 245     return;
 246 }
 247
 248 /**********************************************************************
 249  * Close
 250  **********************************************************************/
 251 static void Close( vlc_object_t *p_this )
 252 {
 253     aout_filter_t *p_filter = (aout_filter_t*)p_this;
 254     aout_filter_sys_t *p_sys = p_filter->p_sys;
 255
 256     if( p_sys )
 257     {
 258         free( p_sys->p_last );
 259         free( p_sys );
 260     }
 261 }