* all: added a new access_filter module: record + one hotkey to start/stop
[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 typedef struct aout_filter_sys_t
60 {
61     int i_nb;
62     float *p_last;
63     float f_max;
64 } aout_filter_sys_t;
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     set_shortname( N_("Volume normalizer") );
84     set_category( CAT_AUDIO );
85     set_subcategory( SUBCAT_AUDIO_AFILTER );
86     add_shortcut( "volnorm" );
87     add_integer( "norm-buff-size", 20 ,NULL ,BUFF_TEXT, BUFF_LONGTEXT,
88                  VLC_TRUE);
89     add_float( "norm-max-level", 2.0, NULL, LEVEL_TEXT,
90                LEVEL_LONGTEXT, VLC_TRUE );
91     set_capability( "audio filter", 0 );
92     set_callbacks( Open, Close );
93 vlc_module_end();
94
95 /*****************************************************************************
96  * Open: initialize and create stuff
97  *****************************************************************************/
98 static int Open( vlc_object_t *p_this )
99 {
100     aout_filter_t *p_filter = (aout_filter_t*)p_this;
101     int i_channels;
102     aout_filter_sys_t *p_sys = p_filter->p_sys =
103         malloc( sizeof( aout_filter_sys_t ) );
104
105     if( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' ) ||
106         p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
107     {
108             msg_Warn( p_filter, "Bad input or output format" );
109             return VLC_EGENERIC;
110     }
111
112     if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
113     {
114         msg_Warn( p_filter, "input and output formats are not similar" );
115         return VLC_EGENERIC;
116     }
117
118     p_filter->pf_do_work = DoWork;
119     p_filter->b_in_place = VLC_TRUE;
120
121     i_channels = aout_FormatNbChannels( &p_filter->input );
122
123     p_sys->i_nb = var_CreateGetInteger( p_filter->p_parent, "norm-buff-size" );
124     p_sys->f_max = var_CreateGetFloat( p_filter->p_parent, "norm-max-level" );
125
126     if( p_sys->f_max <= 0 ) p_sys->f_max = 0.01;
127
128     /* We need to store (nb_buffers+1)*nb_channels floats */
129     p_sys->p_last = malloc( sizeof( float ) * (i_channels) *
130                             (p_filter->p_sys->i_nb + 2) );
131     memset( p_sys->p_last, 0 ,sizeof( float ) * (i_channels) *
132             (p_filter->p_sys->i_nb + 2) );
133     return VLC_SUCCESS;
134 }
135
136 /*****************************************************************************
137  * DoWork : normalizes and sends a buffer
138  *****************************************************************************/
139  static void DoWork( aout_instance_t *p_aout, aout_filter_t *p_filter,
140                      aout_buffer_t *p_in_buf, aout_buffer_t *p_out_buf )
141 {
142     float *pf_sum;
143     float *pf_gain;
144     float f_average = 0;
145     int i, i_chan;
146
147     int i_samples = p_in_buf->i_nb_samples;
148     int i_channels = aout_FormatNbChannels( &p_filter->input );
149     float *p_out = (float*)p_out_buf->p_buffer;
150     float *p_in =  (float*)p_in_buf->p_buffer;
151
152     struct aout_filter_sys_t *p_sys = p_filter->p_sys;
153
154     pf_sum = (float *)malloc( sizeof(float) * i_channels );
155     memset( pf_sum, 0, sizeof(float) * i_channels );
156
157     pf_gain = (float *)malloc( sizeof(float) * i_channels );
158
159     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
160     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
161
162     /* Calculate the average power level on this buffer */
163     for( i = 0 ; i < i_samples; i++ )
164     {
165         for( i_chan = 0; i_chan < i_channels; i_chan++ )
166         {
167             float f_sample = p_in[i_chan];
168             float f_square = pow( f_sample, 2 );
169             pf_sum[i_chan] += f_square;
170         }
171         p_in += i_channels;
172     }
173
174     /* sum now contains for each channel the sigma(value²) */
175     for( i_chan = 0; i_chan < i_channels; i_chan++ )
176     {
177         /* Shift our lastbuff */
178         memmove( &p_sys->p_last[ i_chan * p_sys->i_nb],
179                         &p_sys->p_last[i_chan * p_sys->i_nb + 1],
180                  (p_sys->i_nb-1) * sizeof( float ) );
181
182         /* Insert the new average : sqrt(sigma(value²)) */
183         p_sys->p_last[ i_chan * p_sys->i_nb + p_sys->i_nb - 1] =
184                 sqrt( pf_sum[i_chan] );
185
186         pf_sum[i_chan] = 0;
187
188         /* Get the average power on the lastbuff */
189         f_average = 0;
190         for( i = 0; i < p_sys->i_nb ; i++)
191         {
192             f_average += p_sys->p_last[ i_chan * p_sys->i_nb + i ];
193         }
194         f_average = f_average / p_sys->i_nb;
195
196         /* Seuil arbitraire */
197         p_sys->f_max = var_GetFloat( p_aout, "norm-max-level" );
198
199         //fprintf(stderr,"Average %f, max %f\n", f_average, p_sys->f_max );
200         if( f_average > p_sys->f_max )
201         {
202              pf_gain[i_chan] = f_average / p_sys->f_max;
203         }
204         else
205         {
206            pf_gain[i_chan] = 1;
207         }
208     }
209
210     /* Apply gain */
211     for( i = 0; i < i_samples; i++)
212     {
213         for( i_chan = 0; i_chan < i_channels; i_chan++ )
214         {
215             p_out[i_chan] /= pf_gain[i_chan];
216         }
217         p_out += i_channels;
218     }
219
220     free( pf_sum );
221     free( pf_gain );
222
223     return;
224 }
225
226 /**********************************************************************
227  * Close
228  **********************************************************************/
229 static void Close( vlc_object_t *p_this )
230 {
231     aout_filter_t *p_filter = (aout_filter_t*)p_this;
232     aout_filter_sys_t *p_sys = p_filter->p_sys;
233
234     if( p_sys )
235     {
236         if( p_sys->p_last) free( p_sys->p_last );
237         free( p_sys );
238     }
239 }