20f04734f78c3cfb0a3ccc3c6981e8729d11e64c
[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 #include <vlc/vlc.h>
34 #include "vlc_aout.h"
35 #include "revmodel.hpp"
36 #define SPAT_AMP 0.3
37 /*****************************************************************************
38  * Module descriptor
39  *****************************************************************************/
40 static int  Open ( vlc_object_t * );
41 static void Close( vlc_object_t * );
42
43 vlc_module_begin();
44     set_description( _("spatializer") );
45     set_shortname( _("spatializer" ) );
46     set_capability( "audio filter", 0 );
47     set_category( CAT_AUDIO );
48     set_subcategory( SUBCAT_AUDIO_AFILTER );
49
50     set_callbacks( Open, Close );
51     add_shortcut( "spatializer" );
52     add_float( "Roomsize", 1.05, NULL, NULL,NULL, VLC_TRUE);
53     add_float( "Width", 10.0, NULL, NULL,NULL, VLC_TRUE);
54     add_float( "Wet", 3.0, NULL, NULL,NULL, VLC_TRUE);
55     add_float( "Dry", 2.0, NULL, NULL,NULL, VLC_TRUE);
56     add_float( "Damp", 1.0, NULL, NULL,NULL, VLC_TRUE);
57 vlc_module_end();
58
59 /*****************************************************************************
60  * Local prototypes
61  *****************************************************************************/
62 typedef struct aout_filter_sys_t
63 {
64     /* reverb static config */
65     vlc_bool_t b_first;
66     
67 } aout_filter_sys_t;
68
69 static revmodel reverbm;
70     
71 static const char *psz_control_names[] =
72 {
73     "Roomsize", "Width" , "Wet", "Dry", "Damp"
74 };
75 static void DoWork( aout_instance_t *, aout_filter_t *,
76                     aout_buffer_t *, aout_buffer_t * );
77
78 static int  SpatInit( aout_filter_t *);
79 static void SpatFilter( aout_instance_t *,aout_filter_t *, float *, float *,
80                         int, int );
81 static void SpatClean( aout_filter_t * );
82 static int RoomCallback ( vlc_object_t *, char const *,
83                                            vlc_value_t, vlc_value_t, void * );
84 static int WetCallback ( vlc_object_t *, char const *,
85                                            vlc_value_t, vlc_value_t, void * );
86 static int DryCallback ( vlc_object_t *, char const *,
87                                            vlc_value_t, vlc_value_t, void * );
88 static int DampCallback ( vlc_object_t *, char const *,
89                                            vlc_value_t, vlc_value_t, void * );
90 static int WidthCallback ( vlc_object_t *, char const *,
91                                            vlc_value_t, vlc_value_t, void * );                                                                                                                                 
92 /*****************************************************************************
93  * Open:
94  *****************************************************************************/
95 static int Open( vlc_object_t *p_this )
96 {
97     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
98     aout_filter_sys_t *p_sys;
99     vlc_bool_t         b_fit = VLC_TRUE;
100     msg_Dbg(p_this, "Opening filter spatializer %s %s %d\n", __FILE__,__func__,__LINE__);
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         b_fit = VLC_FALSE;
106         p_filter->input.i_format = VLC_FOURCC('f','l','3','2');
107         p_filter->output.i_format = VLC_FOURCC('f','l','3','2');
108         msg_Warn( p_filter, "bad input or output format" );
109     }
110     if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
111     {
112         b_fit = VLC_FALSE;
113         memcpy( &p_filter->output, &p_filter->input,
114                 sizeof(audio_sample_format_t) );
115         msg_Warn( p_filter, "input and output formats are not similar" );
116     }
117
118     if ( ! b_fit )
119     {
120         return VLC_EGENERIC;
121     }
122
123     p_filter->pf_do_work = DoWork;
124     p_filter->b_in_place = VLC_TRUE;
125     
126      /* Allocate structure */    
127     p_sys = p_filter->p_sys = (aout_filter_sys_t*)malloc( sizeof( aout_filter_sys_t ) );
128     reverbm.setroomsize(1.05);
129     reverbm.setwet(10.0f);
130     reverbm.setdry(1.0f);
131     reverbm.setdamp(0.3);
132     reverbm.setwidth(0.9);
133     SpatInit( p_filter);
134     
135     return VLC_SUCCESS;
136 }
137
138 /*****************************************************************************
139  * Close: close the plugin
140  *****************************************************************************/
141 static void Close( vlc_object_t *p_this ) 
142 {
143     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
144     aout_filter_sys_t *p_sys = p_filter->p_sys;
145     SpatClean( p_filter );
146     free( p_sys );
147     msg_Dbg(p_this, "Closing filter spatializer %s %s %d\n", __FILE__,__func__,__LINE__);
148 }
149
150 /*****************************************************************************
151  * DoWork: process samples buffer
152  *****************************************************************************
153  *
154  *****************************************************************************/
155 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
156                     aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
157 {
158     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
159     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
160
161     SpatFilter( p_aout, p_filter, (float*)p_out_buf->p_buffer,
162                (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
163                aout_FormatNbChannels( &p_filter->input ) );
164 }
165
166 static int SpatInit( aout_filter_t *p_filter )
167 {
168     aout_filter_sys_t *p_sys = p_filter->p_sys;
169     int i, ch;
170     vlc_value_t val1, val2, val3, val4, val5;
171     aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
172     
173     for( int i = 0; i < 5 ; i ++ )
174     {
175      var_CreateGetFloatCommand( p_aout, psz_control_names[i] );
176     }
177
178     /* Get initial values */
179     var_Get( p_aout, psz_control_names[0], &val1 );
180     var_Get( p_aout, psz_control_names[1], &val2 );
181     var_Get( p_aout, psz_control_names[2], &val3 );
182     var_Get( p_aout, psz_control_names[3], &val4 );
183     var_Get( p_aout, psz_control_names[4], &val5);
184
185     RoomCallback( VLC_OBJECT( p_aout ), NULL, val1, val1, p_sys );
186     WidthCallback( VLC_OBJECT( p_aout ), NULL, val2, val2, p_sys );
187     WetCallback( VLC_OBJECT( p_aout ), NULL, val3, val3, p_sys );
188     DryCallback( VLC_OBJECT( p_aout ), NULL, val4, val4, p_sys );
189     DampCallback( VLC_OBJECT( p_aout ), NULL, val5, val5, p_sys );
190
191     msg_Dbg( p_filter, "%f", val1.f_float );
192     /* Add our own callbacks */
193     var_AddCallback( p_aout, psz_control_names[0], RoomCallback, p_sys );
194     var_AddCallback( p_aout, psz_control_names[1], WidthCallback, p_sys );
195     var_AddCallback( p_aout, psz_control_names[2], WetCallback, p_sys );
196     var_AddCallback( p_aout, psz_control_names[3], DryCallback, p_sys );
197     var_AddCallback( p_aout, psz_control_names[4], DampCallback, p_sys );
198     
199     return VLC_SUCCESS;
200 }
201
202 static void SpatFilter( aout_instance_t *p_aout,
203                        aout_filter_t *p_filter, float *out, float *in,
204                        int i_samples, int i_channels )
205 {
206     int i, ch, j;
207     for( i = 0; i < i_samples; i++ )
208     {
209         for( ch = 0 ; ch < 2; ch++)
210         {
211             in[ch] = in[ch] * SPAT_AMP;
212         }
213            reverbm.processreplace( in, out , 1, i_channels);
214          in  += i_channels;
215          out += i_channels;
216     }
217 }
218
219 static void SpatClean( aout_filter_t *p_filter )
220 {
221     aout_filter_sys_t *p_sys = p_filter->p_sys;
222
223     var_DelCallback( (aout_instance_t *)p_filter->p_parent,
224                         "Roomsize", RoomCallback, p_sys );
225     var_DelCallback( (aout_instance_t *)p_filter->p_parent,
226                         "Width", WidthCallback, p_sys );
227     var_DelCallback( (aout_instance_t *)p_filter->p_parent,
228                         "Wet", WetCallback, p_sys );
229     var_DelCallback( (aout_instance_t *)p_filter->p_parent,
230                         "Dry", DryCallback, p_sys );
231     var_DelCallback( (aout_instance_t *)p_filter->p_parent,
232                         "Damp", DampCallback, p_sys );
233
234 }
235
236 static int RoomCallback( vlc_object_t *p_this, char const *psz_cmd,
237                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
238 {
239     msg_Dbg (p_this,"room callback %3.1f %s %s %d\n", newval.f_float, __FILE__,__func__,__LINE__);    
240     reverbm.setroomsize(newval.f_float);
241     return VLC_SUCCESS;
242 }
243
244 static int WidthCallback( vlc_object_t *p_this, char const *psz_cmd,
245                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
246 {
247     reverbm.setwidth(newval.f_float);
248     msg_Dbg (p_this,"width callback %3.1f %s %s %d\n", newval.f_float,  __FILE__,__func__,__LINE__);
249     return VLC_SUCCESS;
250 }
251 static int WetCallback( vlc_object_t *p_this, char const *psz_cmd,
252                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
253 {
254     reverbm.setwet(newval.f_float);
255     msg_Dbg (p_this,"wet callback %3.1f %s %s %d\n", newval.f_float,  __FILE__,__func__,__LINE__);
256     return VLC_SUCCESS;
257 }
258 static int DryCallback( vlc_object_t *p_this, char const *psz_cmd,
259                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
260 {
261     reverbm.setdry(newval.f_float);
262     msg_Dbg (p_this,"dry callback %3.1f %s %s %d\n", newval.f_float, __FILE__,__func__,__LINE__);
263     return VLC_SUCCESS;
264 }
265 static int DampCallback( vlc_object_t *p_this, char const *psz_cmd,
266                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
267 {
268     reverbm.setdamp(newval.f_float);
269     msg_Dbg (p_this, "damp callback %3.1f %s %s %d\n", newval.f_float, __FILE__,__func__,__LINE__);
270     return VLC_SUCCESS;
271 }
272