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