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