git.sesse.net Git - vlc/blob - 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 N_("Wet")
  56 #define WET_LONGTEXT NULL
  57
  58 #define DRY_TEXT N_("Dry")
  59 #define DRY_LONGTEXT NULL
  60
  61 #define DAMP_TEXT N_("Damp")
  62 #define DAMP_LONGTEXT NULL
  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     "spatializer-roomsize", "spatializer-width" ,
 107     "spatializer-wet", "spatializer-dry", "spatializer-damp"
 108 };
 109 static void DoWork( aout_instance_t *, aout_filter_t *,
 110                     aout_buffer_t *, aout_buffer_t * );
 111
 112 static int  SpatInit( aout_filter_t *);
 113 static void SpatFilter( aout_instance_t *,aout_filter_t *, float *, float *,
 114                         int, int );
 115 static void SpatClean( aout_filter_t * );
 116 static int RoomCallback ( vlc_object_t *, char const *,
 117                                            vlc_value_t, vlc_value_t, void * );
 118 static int WetCallback ( vlc_object_t *, char const *,
 119                                            vlc_value_t, vlc_value_t, void * );
 120 static int DryCallback ( vlc_object_t *, char const *,
 121                                            vlc_value_t, vlc_value_t, void * );
 122 static int DampCallback ( vlc_object_t *, char const *,
 123                                            vlc_value_t, vlc_value_t, void * );
 124 static int WidthCallback ( vlc_object_t *, char const *,
 125                                            vlc_value_t, vlc_value_t, void * );
 126
 127 /*****************************************************************************
 128  * Open:
 129  *****************************************************************************/
 130 static int Open( vlc_object_t *p_this )
 131 {
 132     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
 133     aout_filter_sys_t *p_sys;
 134     bool         b_fit = true;
 135     msg_Dbg(p_this, "Opening filter spatializer %s %s %d", __FILE__,__func__,__LINE__);
 136
 137     if( p_filter->input.i_format != VLC_CODEC_FL32 ||
 138         p_filter->output.i_format != VLC_CODEC_FL32 )
 139     {
 140         b_fit = false;
 141         p_filter->input.i_format = VLC_CODEC_FL32;
 142         p_filter->output.i_format = VLC_CODEC_FL32;
 143         msg_Warn( p_filter, "bad input or output format" );
 144     }
 145     if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
 146     {
 147         b_fit = false;
 148         memcpy( &p_filter->output, &p_filter->input,
 149                 sizeof(audio_sample_format_t) );
 150         msg_Warn( p_filter, "input and output formats are not similar" );
 151     }
 152
 153     if ( ! b_fit )
 154     {
 155         return VLC_EGENERIC;
 156     }
 157
 158     p_filter->pf_do_work = DoWork;
 159     p_filter->b_in_place = true;
 160
 161      /* Allocate structure */
 162     p_sys = p_filter->p_sys = (aout_filter_sys_t*)malloc( sizeof( aout_filter_sys_t ) );
 163     if( !p_sys )
 164         return VLC_ENOMEM;
 165
 166     vlc_mutex_init( &p_sys->lock );
 167     p_sys->p_reverbm = new revmodel();
 168     p_sys->p_reverbm->setroomsize(1.05);
 169     p_sys->p_reverbm->setwet(10.0f);
 170     p_sys->p_reverbm->setdry(1.0f);
 171     p_sys->p_reverbm->setdamp(0.3);
 172     p_sys->p_reverbm->setwidth(0.9);
 173     SpatInit( p_filter);
 174
 175     return VLC_SUCCESS;
 176 }
 177
 178 /*****************************************************************************
 179  * Close: close the plugin
 180  *****************************************************************************/
 181 static void Close( vlc_object_t *p_this )
 182 {
 183     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
 184     aout_filter_sys_t *p_sys = p_filter->p_sys;
 185     SpatClean( p_filter );
 186     delete p_sys->p_reverbm;
 187     vlc_mutex_destroy( &p_sys->lock );
 188     free( p_sys );
 189     msg_Dbg(p_this, "Closing filter spatializer %s %s %d", __FILE__,__func__,__LINE__);
 190 }
 191
 192 /*****************************************************************************
 193  * DoWork: process samples buffer
 194  *****************************************************************************/
 195 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
 196                     aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
 197 {
 198     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
 199     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
 200
 201     SpatFilter( p_aout, p_filter, (float*)p_out_buf->p_buffer,
 202                (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
 203                aout_FormatNbChannels( &p_filter->input ) );
 204 }
 205
 206 static int SpatInit( aout_filter_t *p_filter )
 207 {
 208     aout_filter_sys_t *p_sys = p_filter->p_sys;
 209     int i, ch;
 210     vlc_value_t val1, val2, val3, val4, val5;
 211     aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
 212
 213     for( i = 0; i < 5 ; i ++ )
 214         var_Create( p_aout, psz_control_names[i], VLC_VAR_FLOAT
 215                             | VLC_VAR_DOINHERIT | VLC_VAR_ISCOMMAND );
 216
 217     /* Get initial values */
 218     var_Get( p_aout, psz_control_names[0], &val1 );
 219     var_Get( p_aout, psz_control_names[1], &val2 );
 220     var_Get( p_aout, psz_control_names[2], &val3 );
 221     var_Get( p_aout, psz_control_names[3], &val4 );
 222     var_Get( p_aout, psz_control_names[4], &val5);
 223
 224     RoomCallback( VLC_OBJECT( p_aout ), NULL, val1, val1, p_sys );
 225     WidthCallback( VLC_OBJECT( p_aout ), NULL, val2, val2, p_sys );
 226     WetCallback( VLC_OBJECT( p_aout ), NULL, val3, val3, p_sys );
 227     DryCallback( VLC_OBJECT( p_aout ), NULL, val4, val4, p_sys );
 228     DampCallback( VLC_OBJECT( p_aout ), NULL, val5, val5, p_sys );
 229
 230     msg_Dbg( p_filter, "%f", val1.f_float );
 231     /* Add our own callbacks */
 232     var_AddCallback( p_aout, psz_control_names[0], RoomCallback, p_sys );
 233     var_AddCallback( p_aout, psz_control_names[1], WidthCallback, p_sys );
 234     var_AddCallback( p_aout, psz_control_names[2], WetCallback, p_sys );
 235     var_AddCallback( p_aout, psz_control_names[3], DryCallback, p_sys );
 236     var_AddCallback( p_aout, psz_control_names[4], DampCallback, p_sys );
 237
 238     return VLC_SUCCESS;
 239 }
 240
 241 static void SpatFilter( aout_instance_t *p_aout,
 242                        aout_filter_t *p_filter, float *out, float *in,
 243                        int i_samples, int i_channels )
 244 {
 245     aout_filter_sys_t *p_sys = p_filter->p_sys;
 246     CLocker locker( &p_sys->lock );
 247
 248     int i, ch, j;
 249     for( i = 0; i < i_samples; i++ )
 250     {
 251         for( ch = 0 ; ch < 2; ch++)
 252         {
 253             in[ch] = in[ch] * SPAT_AMP;
 254         }
 255         p_sys->p_reverbm->processreplace( in, out , 1, i_channels);
 256         in  += i_channels;
 257         out += i_channels;
 258     }
 259 }
 260
 261 static void SpatClean( aout_filter_t *p_filter )
 262 {
 263     aout_instance_t *p_aout = (aout_instance_t *)p_filter->p_parent;
 264     aout_filter_sys_t *p_sys = p_filter->p_sys;
 265
 266     var_DelCallback( p_aout, psz_control_names[0], RoomCallback, p_sys );
 267     var_DelCallback( p_aout, psz_control_names[1], WidthCallback, p_sys );
 268     var_DelCallback( p_aout, psz_control_names[2], WetCallback, p_sys );
 269     var_DelCallback( p_aout, psz_control_names[3], DryCallback, p_sys );
 270     var_DelCallback( p_aout, psz_control_names[4], DampCallback, p_sys );
 271 }
 272
 273 /*****************************************************************************
 274  * Variables callbacks
 275  *****************************************************************************/
 276
 277 static int RoomCallback( vlc_object_t *p_this, char const *psz_cmd,
 278                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 279 {
 280     aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
 281     CLocker locker( &p_sys->lock );
 282
 283     p_sys->p_reverbm->setroomsize(newval.f_float);
 284     msg_Dbg (p_this,"room callback %3.1f %s %s %d", newval.f_float, __FILE__,__func__,__LINE__);
 285     return VLC_SUCCESS;
 286 }
 287
 288 static int WidthCallback( vlc_object_t *p_this, char const *psz_cmd,
 289                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 290 {
 291     aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
 292     CLocker locker( &p_sys->lock );
 293
 294     p_sys->p_reverbm->setwidth(newval.f_float);
 295     msg_Dbg (p_this,"width callback %3.1f %s %s %d", newval.f_float,  __FILE__,__func__,__LINE__);
 296     return VLC_SUCCESS;
 297 }
 298 static int WetCallback( vlc_object_t *p_this, char const *psz_cmd,
 299                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 300 {
 301     aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
 302     CLocker locker( &p_sys->lock );
 303
 304     p_sys->p_reverbm->setwet(newval.f_float);
 305     msg_Dbg (p_this,"wet callback %3.1f %s %s %d", newval.f_float,  __FILE__,__func__,__LINE__);
 306     return VLC_SUCCESS;
 307 }
 308 static int DryCallback( vlc_object_t *p_this, char const *psz_cmd,
 309                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 310 {
 311     aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
 312     CLocker locker( &p_sys->lock );
 313
 314     p_sys->p_reverbm->setdry(newval.f_float);
 315     msg_Dbg (p_this,"dry callback %3.1f %s %s %d", newval.f_float, __FILE__,__func__,__LINE__);
 316     return VLC_SUCCESS;
 317 }
 318 static int DampCallback( vlc_object_t *p_this, char const *psz_cmd,
 319                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 320 {
 321     aout_filter_sys_t *p_sys = (aout_filter_sys_t*)p_data;
 322     CLocker locker( &p_sys->lock );
 323
 324     p_sys->p_reverbm->setdamp(newval.f_float);
 325     msg_Dbg (p_this, "damp callback %3.1f %s %s %d", newval.f_float, __FILE__,__func__,__LINE__);
 326     return VLC_SUCCESS;
 327 }
 328