git.sesse.net Git - vlc/blob - modules/visualization/projectm.cpp

   1 /*****************************************************************************
   2  * projectm.cpp: visualization module based on libprojectM
   3  *****************************************************************************
   4  * Copyright © 2009-2011 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Rémi Duraffort <ivoire@videolan.org>
   8  *          Laurent Aimar
   9  *
  10   * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifdef HAVE_CONFIG_H
  26 # include "config.h"
  27 #endif
  28 #ifndef __STDC_CONSTANT_MACROS
  29 # define __STDC_CONSTANT_MACROS
  30 #endif
  31
  32 #include <assert.h>
  33
  34 #include <vlc_common.h>
  35 #include <vlc_plugin.h>
  36 #include <vlc_aout.h>
  37 #include <vlc_vout.h>
  38 #include <vlc_vout_wrapper.h>
  39 #include <vlc_opengl.h>
  40 #include <vlc_filter.h>
  41 #include <vlc_rand.h>
  42
  43 #include <libprojectM/projectM.hpp>
  44
  45 /*****************************************************************************
  46  * Module descriptor
  47  *****************************************************************************/
  48 static int  Open         ( vlc_object_t * );
  49 static void Close        ( vlc_object_t * );
  50
  51 #define CONFIG_TEXT N_("projectM configuration file")
  52 #define CONFIG_LONGTEXT N_("File that will be used to configure the projectM " \
  53                            "module.")
  54
  55 #define PRESET_PATH_TXT N_("projectM preset path")
  56 #define PRESET_PATH_LONGTXT N_("Path to the projectM preset directory")
  57
  58 #define TITLE_FONT_TXT N_("Title font")
  59 #define TITLE_FONT_LONGTXT N_("Font used for the titles")
  60
  61 #define MENU_FONT_TXT N_("Font menu")
  62 #define MENU_FONT_LONGTXT N_("Font used for the menus")
  63
  64 #define WIDTH_TEXT N_("Video width")
  65 #define WIDTH_LONGTEXT N_("The width of the video window, in pixels.")
  66
  67 #define HEIGHT_TEXT N_("Video height")
  68 #define HEIGHT_LONGTEXT N_("The height of the video window, in pixels.")
  69
  70 #define MESHX_TEXT N_("Mesh width")
  71 #define MESHX_LONGTEXT N_("The width of the mesh, in pixels.")
  72
  73 #define MESHY_TEXT N_("Mesh height")
  74 #define MESHY_LONGTEXT N_("The height of the mesh, in pixels.")
  75
  76 #define TEXTURE_TEXT N_("Texture size")
  77 #define TEXTURE_LONGTEXT N_("The size of the texture, in pixels.")
  78
  79 #ifdef _WIN32
  80 # define FONT_PATH      "C:\\WINDOWS\\Fonts\\arial.ttf"
  81 # define FONT_PATH_MENU "C:\\WINDOWS\\Fonts\\arial.ttf"
  82 # define PRESET_PATH    NULL
  83 #else
  84 # define FONT_PATH      "/usr/share/fonts/truetype/ttf-dejavu/DejaVuSans.ttf"
  85 # define FONT_PATH_MENU "/usr/share/fonts/truetype/ttf-dejavu/DejaVuSansMono.ttf"
  86 # define PRESET_PATH    "/usr/share/projectM/presets"
  87 #endif
  88
  89 #ifdef DEFAULT_FONT_FILE
  90 #undef FONT_PATH
  91 #define FONT_PATH DEFAULT_FONT_FILE
  92 #endif
  93
  94 #ifdef DEFAULT_MONOSPACE_FONT_FILE
  95 #undef FONT_PATH_MENU
  96 #define FONT_PATH_MENU DEFAULT_MONOSPACE_FONT_FILE
  97 #endif
  98
  99 vlc_module_begin ()
 100     set_shortname( N_("projectM"))
 101     set_description( N_("libprojectM effect") )
 102     set_capability( "visualization", 0 )
 103     set_category( CAT_AUDIO )
 104     set_subcategory( SUBCAT_AUDIO_VISUAL )
 105 #ifndef HAVE_PROJECTM2
 106     add_loadfile( "projectm-config", "/usr/share/projectM/config.inp",
 107                   CONFIG_TEXT, CONFIG_LONGTEXT, true )
 108 #else
 109     add_directory( "projectm-preset-path", PRESET_PATH,
 110                   PRESET_PATH_TXT, PRESET_PATH_LONGTXT, true )
 111     add_loadfile( "projectm-title-font", FONT_PATH,
 112                   TITLE_FONT_TXT, TITLE_FONT_LONGTXT, true )
 113     add_loadfile( "projectm-menu-font", FONT_PATH_MENU,
 114                   MENU_FONT_TXT, MENU_FONT_LONGTXT, true )
 115 #endif
 116     add_integer( "projectm-width", 800, WIDTH_TEXT, WIDTH_LONGTEXT,
 117                  false )
 118     add_integer( "projectm-height", 500, HEIGHT_TEXT, HEIGHT_LONGTEXT,
 119                  false )
 120     add_integer( "projectm-meshx", 32, MESHX_TEXT, MESHX_LONGTEXT,
 121                  false )
 122     add_integer( "projectm-meshy", 24, MESHY_TEXT, MESHY_LONGTEXT,
 123                  false )
 124     add_integer( "projectm-texture-size", 1024, TEXTURE_TEXT, TEXTURE_LONGTEXT,
 125                  false )
 126     add_shortcut( "projectm" )
 127     set_callbacks( Open, Close )
 128 vlc_module_end ()
 129
 130
 131 /*****************************************************************************
 132  * Local prototypes
 133  *****************************************************************************/
 134 struct filter_sys_t
 135 {
 136     /* */
 137     vlc_thread_t thread;
 138     vlc_sem_t    ready;
 139     bool         b_error;
 140
 141     /* Opengl */
 142     vout_thread_t  *p_vout;
 143     vout_display_t *p_vd;
 144
 145     /* Window size */
 146     int i_width;
 147     int i_height;
 148
 149     /* audio info */
 150     int i_channels;
 151
 152     /* */
 153     vlc_mutex_t lock;
 154     bool  b_quit;
 155     float *p_buffer;
 156     unsigned i_buffer_size;
 157     unsigned i_nb_samples;
 158 };
 159
 160
 161 static block_t *DoWork( filter_t *, block_t * );
 162 static void *Thread( void * );
 163
 164 /**
 165  * Open the module
 166  * @param p_this: the filter object
 167  * @return VLC_SUCCESS or vlc error codes
 168  */
 169 static int Open( vlc_object_t * p_this )
 170 {
 171     filter_t     *p_filter = (filter_t *)p_this;
 172     filter_sys_t *p_sys;
 173
 174     p_sys = p_filter->p_sys = (filter_sys_t*)malloc( sizeof( *p_sys ) );
 175     if( !p_sys )
 176         return VLC_ENOMEM;
 177
 178     /* Create the object for the thread */
 179     vlc_sem_init( &p_sys->ready, 0 );
 180     p_sys->b_error       = false;
 181     p_sys->b_quit        = false;
 182     p_sys->i_width       = var_InheritInteger( p_filter, "projectm-width" );
 183     p_sys->i_height      = var_InheritInteger( p_filter, "projectm-height" );
 184     p_sys->i_channels    = aout_FormatNbChannels( &p_filter->fmt_in.audio );
 185     vlc_mutex_init( &p_sys->lock );
 186     p_sys->p_buffer      = NULL;
 187     p_sys->i_buffer_size = 0;
 188     p_sys->i_nb_samples  = 0;
 189
 190     /* Create the thread */
 191     if( vlc_clone( &p_sys->thread, Thread, p_filter, VLC_THREAD_PRIORITY_LOW ) )
 192         goto error;
 193
 194     vlc_sem_wait( &p_sys->ready );
 195     if( p_sys->b_error )
 196     {
 197         vlc_join( p_sys->thread, NULL );
 198         goto error;
 199     }
 200
 201     p_filter->fmt_in.audio.i_format = VLC_CODEC_FL32;
 202     p_filter->fmt_out.audio = p_filter->fmt_in.audio;
 203     p_filter->pf_audio_filter = DoWork;
 204     return VLC_SUCCESS;
 205
 206 error:
 207     vlc_sem_destroy( &p_sys->ready );
 208     free (p_sys );
 209     return VLC_EGENERIC;
 210 }
 211
 212
 213 /**
 214  * Close the module
 215  * @param p_this: the filter object
 216  */
 217 static void Close( vlc_object_t *p_this )
 218 {
 219     filter_t  *p_filter = (filter_t *)p_this;
 220     filter_sys_t *p_sys = p_filter->p_sys;
 221
 222     /* Stop the thread
 223      * XXX vlc_cleanup_push does not seems to work with C++ so no
 224      * vlc_cancel()... */
 225     vlc_mutex_lock( &p_sys->lock );
 226     p_sys->b_quit = true;
 227     vlc_mutex_unlock( &p_sys->lock );
 228
 229     vlc_join( p_sys->thread, NULL );
 230
 231     /* Free the ressources */
 232     vlc_sem_destroy( &p_sys->ready );
 233     vlc_mutex_destroy( &p_sys->lock );
 234     free( p_sys->p_buffer );
 235     free( p_sys );
 236 }
 237
 238
 239 /**
 240  * Do the actual work with the new sample
 241  * @param p_aout: audio output object
 242  * @param p_filter: filter object
 243  * @param p_in_buf: input buffer
 244  * @param p_out_buf: output buffer
 245  */
 246 static block_t *DoWork( filter_t *p_filter, block_t *p_in_buf )
 247 {
 248     filter_sys_t *p_sys = p_filter->p_sys;
 249
 250     vlc_mutex_lock( &p_sys->lock );
 251     if( p_sys->i_buffer_size > 0 )
 252     {
 253         p_sys->i_nb_samples = __MIN( p_sys->i_buffer_size,
 254                                      p_in_buf->i_nb_samples );
 255
 256         const float *p_src = (float*)p_in_buf->p_buffer;
 257         for( unsigned i = 0; i < p_sys->i_nb_samples; i++ )
 258         {
 259             float v = 0;
 260             for( int j = 0; j < p_sys->i_channels; j++ )
 261                 v += p_src[p_sys->i_channels * i + j];
 262             p_sys->p_buffer[i] = v / p_sys->i_channels;
 263         }
 264     }
 265     vlc_mutex_unlock( &p_sys->lock );
 266
 267     return p_in_buf;
 268 }
 269
 270 /**
 271  * Variable callback for the dummy vout
 272  */
 273 static int VoutCallback( vlc_object_t *p_vout, char const *psz_name,
 274                          vlc_value_t oldv, vlc_value_t newv, void *p_data )
 275 {
 276     VLC_UNUSED( p_vout ); VLC_UNUSED( oldv );
 277     vout_display_t *p_vd = (vout_display_t*)p_data;
 278
 279     if( !strcmp(psz_name, "fullscreen") )
 280     {
 281         vout_SetDisplayFullscreen( p_vd, newv.b_bool );
 282     }
 283     return VLC_SUCCESS;
 284 }
 285
 286 /**
 287  * ProjectM update thread which do the rendering
 288  * @param p_this: the p_thread object
 289  */
 290 static void *Thread( void *p_data )
 291 {
 292     filter_t  *p_filter = (filter_t*)p_data;
 293     filter_sys_t *p_sys = p_filter->p_sys;
 294
 295     video_format_t fmt;
 296     vlc_gl_t *gl;
 297     unsigned int i_last_width  = 0;
 298     unsigned int i_last_height = 0;
 299     locale_t loc;
 300     locale_t oldloc;
 301
 302     projectM *p_projectm;
 303 #ifndef HAVE_PROJECTM2
 304     char *psz_config;
 305 #else
 306     char *psz_preset_path;
 307     char *psz_title_font;
 308     char *psz_menu_font;
 309     projectM::Settings settings;
 310 #endif
 311
 312     vlc_savecancel();
 313
 314     /* Create the openGL provider */
 315     p_sys->p_vout =
 316         (vout_thread_t *)vlc_object_create( p_filter, sizeof(vout_thread_t) );
 317     if( !p_sys->p_vout )
 318         goto error;
 319
 320     /* */
 321     video_format_Init( &fmt, 0 );
 322     video_format_Setup( &fmt, VLC_CODEC_RGB32, p_sys->i_width, p_sys->i_height,
 323                         p_sys->i_width, p_sys->i_height, 1, 1 );
 324
 325     vout_display_state_t state;
 326     memset( &state, 0, sizeof(state) );
 327     state.cfg.display.sar.num = 1;
 328     state.cfg.display.sar.den = 1;
 329     state.cfg.is_display_filled = true;
 330     state.cfg.zoom.num = 1;
 331     state.cfg.zoom.den = 1;
 332     state.sar.num = 1;
 333     state.sar.den = 1;
 334
 335     p_sys->p_vd = vout_NewDisplay( p_sys->p_vout, &fmt, &state, "opengl",
 336                                    300000, 1000000 );
 337     if( !p_sys->p_vd )
 338     {
 339         vlc_object_release( p_sys->p_vout );
 340         goto error;
 341     }
 342     var_Create( p_sys->p_vout, "fullscreen", VLC_VAR_BOOL );
 343     var_AddCallback( p_sys->p_vout, "fullscreen", VoutCallback, p_sys->p_vd );
 344
 345     gl = vout_GetDisplayOpengl( p_sys->p_vd );
 346     if( !gl )
 347     {
 348         var_DelCallback( p_sys->p_vout, "fullscreen", VoutCallback, p_sys->p_vd );
 349         vout_DeleteDisplay( p_sys->p_vd, NULL );
 350         vlc_object_release( p_sys->p_vout );
 351         goto error;
 352     }
 353
 354     /* Work-around the projectM locale bug */
 355     loc = newlocale (LC_NUMERIC_MASK, "C", NULL);
 356     oldloc = uselocale (loc);
 357
 358     /* Create the projectM object */
 359 #ifndef HAVE_PROJECTM2
 360     psz_config = var_InheritString( p_filter, "projectm-config" );
 361     p_projectm = new projectM( psz_config );
 362     free( psz_config );
 363 #else
 364     psz_preset_path = var_InheritString( p_filter, "projectm-preset-path" );
 365 #ifdef _WIN32
 366     if ( psz_preset_path == NULL )
 367     {
 368         char *psz_data_path = config_GetDataDir();
 369         asprintf( &psz_preset_path, "%s" DIR_SEP "visualization", psz_data_path );
 370         free( psz_data_path );
 371     }
 372 #endif
 373
 374     psz_title_font                = var_InheritString( p_filter, "projectm-title-font" );
 375     psz_menu_font                 = var_InheritString( p_filter, "projectm-menu-font" );
 376
 377     settings.meshX                = var_InheritInteger( p_filter, "projectm-meshx" );
 378     settings.meshY                = var_InheritInteger( p_filter, "projectm-meshy" );
 379     settings.fps                  = 35;
 380     settings.textureSize          = var_InheritInteger( p_filter, "projectm-texture-size" );
 381     settings.windowWidth          = p_sys->i_width;
 382     settings.windowHeight         = p_sys->i_height;
 383     settings.presetURL            = psz_preset_path;
 384     settings.titleFontURL         = psz_title_font;
 385     settings.menuFontURL          = psz_menu_font;
 386     settings.smoothPresetDuration = 5;
 387     settings.presetDuration       = 30;
 388     settings.beatSensitivity      = 10;
 389     settings.aspectCorrection     = 1;
 390     settings.easterEgg            = 1;
 391     settings.shuffleEnabled       = 1;
 392
 393     p_projectm = new projectM( settings );
 394
 395     free( psz_menu_font );
 396     free( psz_title_font );
 397     free( psz_preset_path );
 398 #endif /* HAVE_PROJECTM2 */
 399
 400     p_sys->i_buffer_size = p_projectm->pcm()->maxsamples;
 401     p_sys->p_buffer = (float*)calloc( p_sys->i_buffer_size,
 402                                       sizeof( float ) );
 403
 404     vlc_sem_post( &p_sys->ready );
 405
 406     /* Choose a preset randomly or projectM will always show the first one */
 407     if ( p_projectm->getPlaylistSize() > 0 )
 408         p_projectm->selectPreset( (unsigned)vlc_mrand48() % p_projectm->getPlaylistSize() );
 409
 410     /* */
 411     for( ;; )
 412     {
 413         const mtime_t i_deadline = mdate() + CLOCK_FREQ / 50; /* 50 fps max */
 414         /* Manage the events */
 415         vout_ManageDisplay( p_sys->p_vd, true );
 416         if( p_sys->p_vd->cfg->display.width  != i_last_width ||
 417             p_sys->p_vd->cfg->display.height != i_last_height )
 418         {
 419             /* FIXME it is not perfect as we will have black bands */
 420             vout_display_place_t place;
 421             vout_display_PlacePicture( &place, &p_sys->p_vd->source, p_sys->p_vd->cfg, false );
 422             p_projectm->projectM_resetGL( place.width, place.height );
 423
 424             i_last_width  = p_sys->p_vd->cfg->display.width;
 425             i_last_height = p_sys->p_vd->cfg->display.height;
 426         }
 427
 428         /* Render the image and swap the buffers */
 429         vlc_mutex_lock( &p_sys->lock );
 430         if( p_sys->i_nb_samples > 0 )
 431         {
 432             p_projectm->pcm()->addPCMfloat( p_sys->p_buffer,
 433                                             p_sys->i_nb_samples );
 434             p_sys->i_nb_samples = 0;
 435         }
 436         if( p_sys->b_quit )
 437         {
 438             vlc_mutex_unlock( &p_sys->lock );
 439
 440             delete p_projectm;
 441             var_DelCallback( p_sys->p_vout, "fullscreen", VoutCallback, p_sys->p_vd );
 442             vout_DeleteDisplay( p_sys->p_vd, NULL );
 443             vlc_object_release( p_sys->p_vout );
 444             if (loc != (locale_t)0)
 445             {
 446                 uselocale (oldloc);
 447                 freelocale (loc);
 448             }
 449             return NULL;
 450         }
 451         vlc_mutex_unlock( &p_sys->lock );
 452
 453         p_projectm->renderFrame();
 454
 455         /* */
 456         mwait( i_deadline );
 457
 458         if( !vlc_gl_Lock(gl) )
 459         {
 460             vlc_gl_Swap( gl );
 461             vlc_gl_Unlock( gl );
 462         }
 463     }
 464     assert(0);
 465
 466 error:
 467     p_sys->b_error = true;
 468     vlc_sem_post( &p_sys->ready );
 469     return NULL;
 470 }
 471