spatializer: do not conflict with libvlccore options
[vlc.git] / modules / audio_filter / spatializer / spatializer.cpp
1 /*****************************************************************************
2  * spatializer.cpp: sound reverberation
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 #define ROOMSIZE_TEXT N_("Room size")
49 #define ROOMSIZE_LONGTEXT N_("Defines the virtual surface of the room" \
50                                 "emulated by the filter." )
51
52 #define WIDTH_TEXT N_("Room width")
53 #define WIDTH_LONGTEXT N_("Width of the virtual room")
54
55 #define WET_TEXT ""
56 #define WET_LONGTEXT ""
57
58 #define DRY_TEXT ""
59 #define DRY_LONGTEXT ""
60
61 #define DAMP_TEXT ""
62 #define DAMP_LONGTEXT ""
63
64 vlc_module_begin ()
65     set_description( N_("Audio Spatializer") )
66     set_shortname( N_("Spatializer" ) )
67     set_capability( "audio filter", 0 )
68     set_category( CAT_AUDIO )
69     set_subcategory( SUBCAT_AUDIO_AFILTER )
70
71     set_callbacks( Open, Close )
72     add_shortcut( "spatializer" )
73     add_float( "spatializer-roomsize", 1.05, NULL, ROOMSIZE_TEXT,
74                ROOMSIZE_LONGTEXT, true )
75     add_float( "spatializer-width", 10., NULL, WIDTH_TEXT,WIDTH_LONGTEXT, true )
76     add_float( "spatializer-wet", 3., NULL, WET_TEXT,WET_LONGTEXT, true )
77     add_float( "spatializer-dry", 2., NULL, DRY_TEXT,DRY_LONGTEXT, true )
78     add_float( "spatializer-damp", 1., NULL, DAMP_TEXT,DAMP_LONGTEXT, true )
79 vlc_module_end ()
80
81 /*****************************************************************************
82  * Local prototypes
83  *****************************************************************************/
84 struct aout_filter_sys_t
85 {
86     vlc_mutex_t lock;
87     revmodel *p_reverbm;
88
89 };
90
91 class CLocker
92 {
93 public:
94     CLocker( vlc_mutex_t *p_lock ) : p_lock(p_lock) {
95         vlc_mutex_lock( p_lock );
96     }
97     virtual ~CLocker() {
98         vlc_mutex_unlock( p_lock );
99     }
100 private:
101     vlc_mutex_t *p_lock;
102 };
103
104 static const char *psz_control_names[] =
105 {
106     "Roomsize", "Width" , "Wet", "Dry", "Damp"
107 };
108 static void DoWork( aout_instance_t *, aout_filter_t *,
109                     aout_buffer_t *, aout_buffer_t * );
110
111 static int  SpatInit( aout_filter_t *);
112 static void SpatFilter( aout_instance_t *,aout_filter_t *, float *, float *,
113                         int, int );
114 static void SpatClean( aout_filter_t * );
115 static int RoomCallback ( vlc_object_t *, char const *,
116                                            vlc_value_t, vlc_value_t, void * );
117 static int WetCallback ( vlc_object_t *, char const *,
118                                            vlc_value_t, vlc_value_t, void * );
119 static int DryCallback ( vlc_object_t *, char const *,
120                                            vlc_value_t, vlc_value_t, void * );
121 static int DampCallback ( vlc_object_t *, char const *,
122                                            vlc_value_t, vlc_value_t, void * );
123 static int WidthCallback ( vlc_object_t *, char const *,
124                                            vlc_value_t, vlc_value_t, void * );
125
126 /*****************************************************************************
127  * Open:
128  *****************************************************************************/
129 static int Open( vlc_object_t *p_this )
130 {
131     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
132     aout_filter_sys_t *p_sys;
133     bool         b_fit = true;
134     msg_Dbg(p_this, "Opening filter spatializer %s %s %d\n", __FILE__,__func__,__LINE__);
135
136     if( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' ) ||
137         p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
138     {
139         b_fit = false;
140         p_filter->input.i_format = VLC_FOURCC('f','l','3','2');
141         p_filter->output.i_format = VLC_FOURCC('f','l','3','2');
142         msg_Warn( p_filter, "bad input or output format" );
143     }
144     if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
145     {
146         b_fit = false;
147         memcpy( &p_filter->output, &p_filter->input,
148                 sizeof(audio_sample_format_t) );
149         msg_Warn( p_filter, "input and output formats are not similar" );
150     }
151
152     if ( ! b_fit )
153     {
154         return VLC_EGENERIC;
155     }
156
157     p_filter->pf_do_work = DoWork;
158     p_filter->b_in_place = true;
159
160      /* Allocate structure */
161     p_sys = p_filter->p_sys = (aout_filter_sys_t*)malloc( sizeof( aout_filter_sys_t ) );
162     if( !p_sys )
163         return VLC_ENOMEM;
164
165     vlc_mutex_init( &p_sys->lock );
166     p_sys->p_reverbm = new revmodel();
167     p_sys->p_reverbm->setroomsize(1.05);
168     p_sys->p_reverbm->setwet(10.0f);
169     p_sys->p_reverbm->setdry(1.0f);
170     p_sys->p_reverbm->setdamp(0.3);
171     p_sys->p_reverbm->setwidth(0.9);
172     SpatInit( p_filter);
173
174     return VLC_SUCCESS;
175 }
176
177 /*****************************************************************************
178  * Close: close the plugin
179  *****************************************************************************/
180 static void Close( vlc_object_t *p_this )
181 {
182     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
183     aout_filter_sys_t *p_sys = p_filter->p_sys;
184     SpatClean( p_filter );
185     delete p_sys->p_reverbm;
186     vlc_mutex_destroy( &p_sys->lock );
187     free( p_sys );
188     msg_Dbg(p_this, "Closing filter spatializer %s %s %d\n", __FILE__,__func__,__LINE__);
189 }
190
191 /*****************************************************************************
192  * DoWork: process samples buffer
193  *****************************************************************************/
194 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
195                     aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
196 {
197     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
198     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
199
200     SpatFilter( p_aout, p_filter, (float*)p_out_buf->p_buffer,
201                (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
202                aout_FormatNbChannels( &p_filter->input ) );
203 }
204
205 static int SpatInit( aout_filter_t *p_filter )
206 {
207     aout_filter_sys_t *p_sys = p_filter->p_sys;
208     int i, ch;
209     vlc_value_t val1, val2, val3, val4, val5;
210     aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
211
212     for( i = 0; i < 5 ; i ++ )
213         var_Create( p_aout, psz_control_names[i], VLC_VAR_FLOAT
214                             | VLC_VAR_DOINHERIT | VLC_VAR_ISCOMMAND );
215
216     /* Get initial values */
217     var_Get( p_aout, psz_control_names[0], &val1 );
218     var_Get( p_aout, psz_control_names[1], &val2 );
219     var_Get( p_aout, psz_control_names[2], &val3 );
220     var_Get( p_aout, psz_control_names[3], &val4 );
221     var_Get( p_aout, psz_control_names[4], &val5);
222
223     RoomCallback( VLC_OBJECT( p_aout ), NULL, val1, val1, p_sys );
224     WidthCallback( VLC_OBJECT( p_aout ), NULL, val2, val2, p_sys );
225     WetCallback( VLC_OBJECT( p_aout ), NULL, val3, val3, p_sys );
226     DryCallback( VLC_OBJECT( p_aout ), NULL, val4, val4, p_sys );
227     DampCallback( VLC_OBJECT( p_aout ), NULL, val5, val5, p_sys );
228
229     msg_Dbg( p_filter, "%f", val1.f_float );
230     /* Add our own callbacks */
231     var_AddCallback( p_aout, psz_control_names[0], RoomCallback, p_sys );
232     var_AddCallback( p_aout, psz_control_names[1], WidthCallback, p_sys );
233     var_AddCallback( p_aout, psz_control_names[2], WetCallback, p_sys );
234     var_AddCallback( p_aout, psz_control_names[3], DryCallback, p_sys );
235     var_AddCallback( p_aout, psz_control_names[4], DampCallback, p_sys );
236
237     return VLC_SUCCESS;
238 }
239
240 static void SpatFilter( aout_instance_t *p_aout,
241                        aout_filter_t *p_filter, float *out, float *in,
242                        int i_samples, int i_channels )
243 {
244     aout_filter_sys_t *p_sys = p_filter->p_sys;
245     CLocker locker( &p_sys->lock );
246
247     int i, ch, j;
248     for( i = 0; i < i_samples; i++ )
249     {
250         for( ch = 0 ; ch < 2; ch++)
251         {
252             in[ch] = in[ch] * SPAT_AMP;
253         }
254         p_sys->p_reverbm->processreplace( in, out , 1, i_channels);
255         in  += i_channels;
256         out += i_channels;
257     }
258 }
259
260 static void SpatClean( aout_filter_t *p_filter )
261 {
262     aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
263     aout_filter_sys_t *p_sys = p_filter->p_sys;
264
265     var_DelCallback( p_aout, psz_control_names[0], RoomCallback, p_sys );
266     var_DelCallback( p_aout, psz_control_names[1], WidthCallback, p_sys );
267     var_DelCallback( p_aout, psz_control_names[2], WetCallback, p_sys );
268     var_DelCallback( p_aout, psz_control_names[3], DryCallback, p_sys );
269     var_DelCallback( p_aout, psz_control_names[4], DampCallback, p_sys );
270 }
271
272 /*****************************************************************************
273  * Variables callbacks
274  *****************************************************************************/
275
276 static int RoomCallback( vlc_object_t *p_this, char const *psz_cmd,
277                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
278 {
279     aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
280     CLocker locker( &p_sys->lock );
281
282     p_sys->p_reverbm->setroomsize(newval.f_float);
283     msg_Dbg (p_this,"room callback %3.1f %s %s %d\n", newval.f_float, __FILE__,__func__,__LINE__);
284     return VLC_SUCCESS;
285 }
286
287 static int WidthCallback( vlc_object_t *p_this, char const *psz_cmd,
288                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
289 {
290     aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
291     CLocker locker( &p_sys->lock );
292
293     p_sys->p_reverbm->setwidth(newval.f_float);
294     msg_Dbg (p_this,"width callback %3.1f %s %s %d\n", newval.f_float,  __FILE__,__func__,__LINE__);
295     return VLC_SUCCESS;
296 }
297 static int WetCallback( vlc_object_t *p_this, char const *psz_cmd,
298                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
299 {
300     aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
301     CLocker locker( &p_sys->lock );
302
303     p_sys->p_reverbm->setwet(newval.f_float);
304     msg_Dbg (p_this,"wet callback %3.1f %s %s %d\n", newval.f_float,  __FILE__,__func__,__LINE__);
305     return VLC_SUCCESS;
306 }
307 static int DryCallback( vlc_object_t *p_this, char const *psz_cmd,
308                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
309 {
310     aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
311     CLocker locker( &p_sys->lock );
312
313     p_sys->p_reverbm->setdry(newval.f_float);
314     msg_Dbg (p_this,"dry callback %3.1f %s %s %d\n", newval.f_float, __FILE__,__func__,__LINE__);
315     return VLC_SUCCESS;
316 }
317 static int DampCallback( vlc_object_t *p_this, char const *psz_cmd,
318                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
319 {
320     aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
321     CLocker locker( &p_sys->lock );
322
323     p_sys->p_reverbm->setdamp(newval.f_float);
324     msg_Dbg (p_this, "damp callback %3.1f %s %s %d\n", newval.f_float, __FILE__,__func__,__LINE__);
325     return VLC_SUCCESS;
326 }
327