b4edc12364f0b5cb76c652d4ac51b95cded6ce72
[vlc.git] / modules / audio_filter / spatializer / spatializer.cpp
1 /*****************************************************************************
2  * spatializer.cpp:
3  *****************************************************************************
4  * Copyright (C) 2004, 2006, 2007 the VideoLAN team
5  *
6  * Google Summer of Code 2007
7  *
8  * Authors: Biodun Osunkunle <biodun@videolan.org>
9  *
10  * Mentor : Jean-Baptiste Kempf <jb@videolan.org>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 /*****************************************************************************
28  * Preamble
29  *****************************************************************************/
30 #include <stdlib.h>                                      /* malloc(), free() */
31 #include <math.h>
32
33 #ifdef HAVE_CONFIG_H
34 # include "config.h"
35 #endif
36
37 #include <vlc_common.h>
38 #include <vlc_plugin.h>
39 #include "vlc_aout.h"
40 #include "revmodel.hpp"
41 #define SPAT_AMP 0.3
42 /*****************************************************************************
43  * Module descriptor
44  *****************************************************************************/
45 static int  Open ( vlc_object_t * );
46 static void Close( vlc_object_t * );
47
48 vlc_module_begin();
49     set_description( N_("spatializer") );
50     set_shortname( N_("spatializer" ) );
51     set_capability( "audio filter", 0 );
52     set_category( CAT_AUDIO );
53     set_subcategory( SUBCAT_AUDIO_AFILTER );
54
55     set_callbacks( Open, Close );
56     add_shortcut( "spatializer" );
57     add_float( "Roomsize", 1.05, NULL, NULL,NULL, true);
58     add_float( "Width", 10.0, NULL, NULL,NULL, true);
59     add_float( "Wet", 3.0, NULL, NULL,NULL, true);
60     add_float( "Dry", 2.0, NULL, NULL,NULL, true);
61     add_float( "Damp", 1.0, NULL, NULL,NULL, true);
62 vlc_module_end();
63
64 /*****************************************************************************
65  * Local prototypes
66  *****************************************************************************/
67 typedef struct aout_filter_sys_t
68 {
69     vlc_mutex_t lock;
70     revmodel *p_reverbm;
71
72 } aout_filter_sys_t;
73
74 class CLocker
75 {
76 public:
77     CLocker( vlc_mutex_t *p_lock ) : p_lock(p_lock) {
78         vlc_mutex_lock( p_lock );
79     }
80     virtual ~CLocker() {
81         vlc_mutex_unlock( p_lock );
82     }
83 private:
84     vlc_mutex_t *p_lock;
85 };
86
87 static const char *psz_control_names[] =
88 {
89     "Roomsize", "Width" , "Wet", "Dry", "Damp"
90 };
91 static void DoWork( aout_instance_t *, aout_filter_t *,
92                     aout_buffer_t *, aout_buffer_t * );
93
94 static int  SpatInit( aout_filter_t *);
95 static void SpatFilter( aout_instance_t *,aout_filter_t *, float *, float *,
96                         int, int );
97 static void SpatClean( aout_filter_t * );
98 static int RoomCallback ( vlc_object_t *, char const *,
99                                            vlc_value_t, vlc_value_t, void * );
100 static int WetCallback ( vlc_object_t *, char const *,
101                                            vlc_value_t, vlc_value_t, void * );
102 static int DryCallback ( vlc_object_t *, char const *,
103                                            vlc_value_t, vlc_value_t, void * );
104 static int DampCallback ( vlc_object_t *, char const *,
105                                            vlc_value_t, vlc_value_t, void * );
106 static int WidthCallback ( vlc_object_t *, char const *,
107                                            vlc_value_t, vlc_value_t, void * );
108
109 /*****************************************************************************
110  * Open:
111  *****************************************************************************/
112 static int Open( vlc_object_t *p_this )
113 {
114     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
115     aout_filter_sys_t *p_sys;
116     bool         b_fit = true;
117     msg_Dbg(p_this, "Opening filter spatializer %s %s %d\n", __FILE__,__func__,__LINE__);
118
119     if( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' ) ||
120         p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
121     {
122         b_fit = false;
123         p_filter->input.i_format = VLC_FOURCC('f','l','3','2');
124         p_filter->output.i_format = VLC_FOURCC('f','l','3','2');
125         msg_Warn( p_filter, "bad input or output format" );
126     }
127     if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
128     {
129         b_fit = false;
130         memcpy( &p_filter->output, &p_filter->input,
131                 sizeof(audio_sample_format_t) );
132         msg_Warn( p_filter, "input and output formats are not similar" );
133     }
134
135     if ( ! b_fit )
136     {
137         return VLC_EGENERIC;
138     }
139
140     p_filter->pf_do_work = DoWork;
141     p_filter->b_in_place = true;
142
143      /* Allocate structure */
144     p_sys = p_filter->p_sys = (aout_filter_sys_t*)malloc( sizeof( aout_filter_sys_t ) );
145     if( !p_sys )
146         return VLC_ENOMEM;
147
148     vlc_mutex_init( &p_sys->lock );
149     p_sys->p_reverbm = new revmodel();
150     p_sys->p_reverbm->setroomsize(1.05);
151     p_sys->p_reverbm->setwet(10.0f);
152     p_sys->p_reverbm->setdry(1.0f);
153     p_sys->p_reverbm->setdamp(0.3);
154     p_sys->p_reverbm->setwidth(0.9);
155     SpatInit( p_filter);
156
157     return VLC_SUCCESS;
158 }
159
160 /*****************************************************************************
161  * Close: close the plugin
162  *****************************************************************************/
163 static void Close( vlc_object_t *p_this )
164 {
165     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
166     aout_filter_sys_t *p_sys = p_filter->p_sys;
167     SpatClean( p_filter );
168     delete p_sys->p_reverbm;
169     vlc_mutex_destroy( &p_sys->lock );
170     free( p_sys );
171     msg_Dbg(p_this, "Closing filter spatializer %s %s %d\n", __FILE__,__func__,__LINE__);
172 }
173
174 /*****************************************************************************
175  * DoWork: process samples buffer
176  *****************************************************************************
177  *
178  *****************************************************************************/
179 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
180                     aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
181 {
182     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
183     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
184
185     SpatFilter( p_aout, p_filter, (float*)p_out_buf->p_buffer,
186                (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
187                aout_FormatNbChannels( &p_filter->input ) );
188 }
189
190 static int SpatInit( aout_filter_t *p_filter )
191 {
192     aout_filter_sys_t *p_sys = p_filter->p_sys;
193     int i, ch;
194     vlc_value_t val1, val2, val3, val4, val5;
195     aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
196
197     for( i = 0; i < 5 ; i ++ )
198     {
199         var_CreateGetFloatCommand( p_aout, psz_control_names[i] );
200     }
201
202     /* Get initial values */
203     var_Get( p_aout, psz_control_names[0], &val1 );
204     var_Get( p_aout, psz_control_names[1], &val2 );
205     var_Get( p_aout, psz_control_names[2], &val3 );
206     var_Get( p_aout, psz_control_names[3], &val4 );
207     var_Get( p_aout, psz_control_names[4], &val5);
208
209     RoomCallback( VLC_OBJECT( p_aout ), NULL, val1, val1, p_sys );
210     WidthCallback( VLC_OBJECT( p_aout ), NULL, val2, val2, p_sys );
211     WetCallback( VLC_OBJECT( p_aout ), NULL, val3, val3, p_sys );
212     DryCallback( VLC_OBJECT( p_aout ), NULL, val4, val4, p_sys );
213     DampCallback( VLC_OBJECT( p_aout ), NULL, val5, val5, p_sys );
214
215     msg_Dbg( p_filter, "%f", val1.f_float );
216     /* Add our own callbacks */
217     var_AddCallback( p_aout, psz_control_names[0], RoomCallback, p_sys );
218     var_AddCallback( p_aout, psz_control_names[1], WidthCallback, p_sys );
219     var_AddCallback( p_aout, psz_control_names[2], WetCallback, p_sys );
220     var_AddCallback( p_aout, psz_control_names[3], DryCallback, p_sys );
221     var_AddCallback( p_aout, psz_control_names[4], DampCallback, p_sys );
222
223     return VLC_SUCCESS;
224 }
225
226 static void SpatFilter( aout_instance_t *p_aout,
227                        aout_filter_t *p_filter, float *out, float *in,
228                        int i_samples, int i_channels )
229 {
230     aout_filter_sys_t *p_sys = p_filter->p_sys;
231     CLocker locker( &p_sys->lock );
232
233     int i, ch, j;
234     for( i = 0; i < i_samples; i++ )
235     {
236         for( ch = 0 ; ch < 2; ch++)
237         {
238             in[ch] = in[ch] * SPAT_AMP;
239         }
240         p_sys->p_reverbm->processreplace( in, out , 1, i_channels);
241         in  += i_channels;
242         out += i_channels;
243     }
244 }
245
246 static void SpatClean( aout_filter_t *p_filter )
247 {
248     aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
249     aout_filter_sys_t *p_sys = p_filter->p_sys;
250
251     var_DelCallback( p_aout, psz_control_names[0], RoomCallback, p_sys );
252     var_DelCallback( p_aout, psz_control_names[1], WidthCallback, p_sys );
253     var_DelCallback( p_aout, psz_control_names[2], WetCallback, p_sys );
254     var_DelCallback( p_aout, psz_control_names[3], DryCallback, p_sys );
255     var_DelCallback( p_aout, psz_control_names[4], DampCallback, p_sys );
256 }
257
258 static int RoomCallback( vlc_object_t *p_this, char const *psz_cmd,
259                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
260 {
261     aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
262     CLocker locker( &p_sys->lock );
263
264     p_sys->p_reverbm->setroomsize(newval.f_float);
265     msg_Dbg (p_this,"room callback %3.1f %s %s %d\n", newval.f_float, __FILE__,__func__,__LINE__);
266     return VLC_SUCCESS;
267 }
268
269 static int WidthCallback( vlc_object_t *p_this, char const *psz_cmd,
270                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
271 {
272     aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
273     CLocker locker( &p_sys->lock );
274
275     p_sys->p_reverbm->setwidth(newval.f_float);
276     msg_Dbg (p_this,"width callback %3.1f %s %s %d\n", newval.f_float,  __FILE__,__func__,__LINE__);
277     return VLC_SUCCESS;
278 }
279 static int WetCallback( vlc_object_t *p_this, char const *psz_cmd,
280                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
281 {
282     aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
283     CLocker locker( &p_sys->lock );
284
285     p_sys->p_reverbm->setwet(newval.f_float);
286     msg_Dbg (p_this,"wet callback %3.1f %s %s %d\n", newval.f_float,  __FILE__,__func__,__LINE__);
287     return VLC_SUCCESS;
288 }
289 static int DryCallback( vlc_object_t *p_this, char const *psz_cmd,
290                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
291 {
292     aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
293     CLocker locker( &p_sys->lock );
294
295     p_sys->p_reverbm->setdry(newval.f_float);
296     msg_Dbg (p_this,"dry callback %3.1f %s %s %d\n", newval.f_float, __FILE__,__func__,__LINE__);
297     return VLC_SUCCESS;
298 }
299 static int DampCallback( vlc_object_t *p_this, char const *psz_cmd,
300                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
301 {
302     aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
303     CLocker locker( &p_sys->lock );
304
305     p_sys->p_reverbm->setdamp(newval.f_float);
306     msg_Dbg (p_this, "damp callback %3.1f %s %s %d\n", newval.f_float, __FILE__,__func__,__LINE__);
307     return VLC_SUCCESS;
308 }
309