1 /*****************************************************************************
2 * spatializer.cpp: sound reverberation
3 *****************************************************************************
4 * Copyright (C) 2004, 2006, 2007 the VideoLAN team
6 * Google Summer of Code 2007
8 * Authors: Biodun Osunkunle <biodun@videolan.org>
10 * Mentor : Jean-Baptiste Kempf <jb@videolan.org>
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.
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.
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 *****************************************************************************/
27 /*****************************************************************************
29 *****************************************************************************/
30 #include <stdlib.h> /* malloc(), free() */
37 #include <vlc_common.h>
38 #include <vlc_plugin.h>
40 #include "revmodel.hpp"
42 /*****************************************************************************
44 *****************************************************************************/
45 static int Open ( vlc_object_t * );
46 static void Close( vlc_object_t * );
48 #define ROOMSIZE_TEXT N_("Room size")
49 #define ROOMSIZE_LONGTEXT N_("Defines the virtual surface of the room" \
50 "emulated by the filter." )
52 #define WIDTH_TEXT N_("Room width")
53 #define WIDTH_LONGTEXT N_("Width of the virtual room")
56 #define WET_LONGTEXT ""
59 #define DRY_LONGTEXT ""
62 #define DAMP_LONGTEXT ""
65 set_description( N_("spatializer") )
66 set_shortname( N_("spatializer" ) )
67 set_capability( "audio filter", 0 )
68 set_category( CAT_AUDIO )
69 set_subcategory( SUBCAT_AUDIO_AFILTER )
71 set_callbacks( Open, Close )
72 add_shortcut( "spatializer" )
73 add_float( "Roomsize", 1.05, NULL, ROOMSIZE_TEXT,ROOMSIZE_LONGTEXT, true)
74 add_float( "Width", 10.0, NULL, WIDTH_TEXT,WIDTH_LONGTEXT, true)
75 add_float( "Wet", 3.0, NULL, WET_TEXT,WET_LONGTEXT, true)
76 add_float( "Dry", 2.0, NULL, DRY_TEXT,DRY_LONGTEXT, true)
77 add_float( "Damp", 1.0, NULL, DAMP_TEXT,DAMP_LONGTEXT, true)
80 /*****************************************************************************
82 *****************************************************************************/
83 typedef struct aout_filter_sys_t
93 CLocker( vlc_mutex_t *p_lock ) : p_lock(p_lock) {
94 vlc_mutex_lock( p_lock );
97 vlc_mutex_unlock( p_lock );
103 static const char *psz_control_names[] =
105 "Roomsize", "Width" , "Wet", "Dry", "Damp"
107 static void DoWork( aout_instance_t *, aout_filter_t *,
108 aout_buffer_t *, aout_buffer_t * );
110 static int SpatInit( aout_filter_t *);
111 static void SpatFilter( aout_instance_t *,aout_filter_t *, float *, float *,
113 static void SpatClean( aout_filter_t * );
114 static int RoomCallback ( vlc_object_t *, char const *,
115 vlc_value_t, vlc_value_t, void * );
116 static int WetCallback ( vlc_object_t *, char const *,
117 vlc_value_t, vlc_value_t, void * );
118 static int DryCallback ( vlc_object_t *, char const *,
119 vlc_value_t, vlc_value_t, void * );
120 static int DampCallback ( vlc_object_t *, char const *,
121 vlc_value_t, vlc_value_t, void * );
122 static int WidthCallback ( vlc_object_t *, char const *,
123 vlc_value_t, vlc_value_t, void * );
125 /*****************************************************************************
127 *****************************************************************************/
128 static int Open( vlc_object_t *p_this )
130 aout_filter_t *p_filter = (aout_filter_t *)p_this;
131 aout_filter_sys_t *p_sys;
133 msg_Dbg(p_this, "Opening filter spatializer %s %s %d\n", __FILE__,__func__,__LINE__);
135 if( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' ) ||
136 p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
139 p_filter->input.i_format = VLC_FOURCC('f','l','3','2');
140 p_filter->output.i_format = VLC_FOURCC('f','l','3','2');
141 msg_Warn( p_filter, "bad input or output format" );
143 if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
146 memcpy( &p_filter->output, &p_filter->input,
147 sizeof(audio_sample_format_t) );
148 msg_Warn( p_filter, "input and output formats are not similar" );
156 p_filter->pf_do_work = DoWork;
157 p_filter->b_in_place = true;
159 /* Allocate structure */
160 p_sys = p_filter->p_sys = (aout_filter_sys_t*)malloc( sizeof( aout_filter_sys_t ) );
164 vlc_mutex_init( &p_sys->lock );
165 p_sys->p_reverbm = new revmodel();
166 p_sys->p_reverbm->setroomsize(1.05);
167 p_sys->p_reverbm->setwet(10.0f);
168 p_sys->p_reverbm->setdry(1.0f);
169 p_sys->p_reverbm->setdamp(0.3);
170 p_sys->p_reverbm->setwidth(0.9);
176 /*****************************************************************************
177 * Close: close the plugin
178 *****************************************************************************/
179 static void Close( vlc_object_t *p_this )
181 aout_filter_t *p_filter = (aout_filter_t *)p_this;
182 aout_filter_sys_t *p_sys = p_filter->p_sys;
183 SpatClean( p_filter );
184 delete p_sys->p_reverbm;
185 vlc_mutex_destroy( &p_sys->lock );
187 msg_Dbg(p_this, "Closing filter spatializer %s %s %d\n", __FILE__,__func__,__LINE__);
190 /*****************************************************************************
191 * DoWork: process samples buffer
192 *****************************************************************************/
193 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
194 aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
196 p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
197 p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
199 SpatFilter( p_aout, p_filter, (float*)p_out_buf->p_buffer,
200 (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
201 aout_FormatNbChannels( &p_filter->input ) );
204 static int SpatInit( aout_filter_t *p_filter )
206 aout_filter_sys_t *p_sys = p_filter->p_sys;
208 vlc_value_t val1, val2, val3, val4, val5;
209 aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
211 for( i = 0; i < 5 ; i ++ )
213 var_CreateGetFloatCommand( p_aout, psz_control_names[i] );
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);
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 );
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 );
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 )
244 aout_filter_sys_t *p_sys = p_filter->p_sys;
245 CLocker locker( &p_sys->lock );
248 for( i = 0; i < i_samples; i++ )
250 for( ch = 0 ; ch < 2; ch++)
252 in[ch] = in[ch] * SPAT_AMP;
254 p_sys->p_reverbm->processreplace( in, out , 1, i_channels);
260 static void SpatClean( aout_filter_t *p_filter )
262 aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
263 aout_filter_sys_t *p_sys = p_filter->p_sys;
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 );
272 /*****************************************************************************
273 * Variables callbacks
274 *****************************************************************************/
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 )
279 aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
280 CLocker locker( &p_sys->lock );
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__);
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 )
290 aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
291 CLocker locker( &p_sys->lock );
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__);
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 )
300 aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
301 CLocker locker( &p_sys->lock );
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__);
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 )
310 aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
311 CLocker locker( &p_sys->lock );
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__);
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 )
320 aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
321 CLocker locker( &p_sys->lock );
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__);