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