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