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

   1 /*****************************************************************************
   2  * projectm: visualization module based on libprojectM
   3  *****************************************************************************
   4  * Copyright (C) 2009 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Rémi Duraffort <ivoire@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License as published by the Free
  11  * Software Foundation; either version 2 of the License, or (at your option)
  12  * any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  16  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  17  * more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along with
  20  * this program; if not, write to the Free Software Foundation, Inc., 51
  21  * Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <vlc_common.h>
  29 #include <vlc_plugin.h>
  30 #include <vlc_aout.h>
  31 #include <vlc_vout.h>
  32 #include <vlc_vout_wrapper.h>
  33 #include <vlc_filter.h>
  34
  35 #include <libprojectM/projectM.hpp>
  36
  37
  38 /*****************************************************************************
  39  * Module descriptor
  40  *****************************************************************************/
  41 static int  Open         ( vlc_object_t * );
  42 static void Close        ( vlc_object_t * );
  43
  44 #define CONFIG_TEXT N_("projectM configuration file")
  45 #define CONFIG_LONGTEXT N_("File that will be used to configure the projectM " \
  46                            "module.")
  47
  48 #define WIDTH_TEXT N_("Video width")
  49 #define WIDTH_LONGTEXT N_("The width of the video window, in pixels.")
  50
  51 #define HEIGHT_TEXT N_("Video height")
  52 #define HEIGHT_LONGTEXT N_("The height of the video window, in pixels.")
  53
  54 vlc_module_begin ()
  55     set_shortname( N_("projectM"))
  56     set_description( N_("libprojectM effect") )
  57     set_capability( "visualization2", 0 )
  58     set_category( CAT_AUDIO )
  59     set_subcategory( SUBCAT_AUDIO_VISUAL )
  60     add_file( "projectm-config", "/usr/share/projectM/config.inp", NULL,
  61                 CONFIG_TEXT, CONFIG_LONGTEXT, true )
  62     add_integer( "projectm-width", 800, NULL, WIDTH_TEXT, WIDTH_LONGTEXT,
  63                  false )
  64     add_integer( "projectm-height", 640, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT,
  65                  false )
  66     add_shortcut( "projectm" )
  67     set_callbacks( Open, Close )
  68 vlc_module_end ()
  69
  70
  71 /*****************************************************************************
  72  * Local prototypes
  73  *****************************************************************************/
  74 struct filter_sys_t
  75 {
  76     /* */
  77     vlc_thread_t thread;
  78     vlc_sem_t    ready;
  79     bool         b_error;
  80
  81     /* Opengl */
  82     vout_thread_t  *p_vout;
  83     vout_display_t *p_vd;
  84
  85     /* libprojectM objects */
  86     projectM      *p_projectm;
  87     char          *psz_config;
  88
  89     /* Window size */
  90     int i_width;
  91     int i_height;
  92
  93     /* audio info */
  94     int i_channels;
  95
  96     vlc_mutex_t lock;
  97     float *p_buffer;
  98     int   i_buffer_size;
  99     int   i_nb_samples;
 100 };
 101
 102
 103 static block_t *DoWork( filter_t *, block_t * );
 104 static void *Thread( void * );
 105
 106 /**
 107  * Open the module
 108  * @param p_this: the filter object
 109  * @return VLC_SUCCESS or vlc error codes
 110  */
 111 static int Open( vlc_object_t * p_this )
 112 {
 113     filter_t     *p_filter = (filter_t *)p_this;
 114     filter_sys_t *p_sys;
 115
 116     /* Test the audio format */
 117     if( p_filter->fmt_in.audio.i_format != VLC_CODEC_FL32 ||
 118         p_filter->fmt_out.audio.i_format != VLC_CODEC_FL32 )
 119     {
 120         msg_Warn( p_filter, "bad input or output format" );
 121         return VLC_EGENERIC;
 122     }
 123     if( !AOUT_FMTS_SIMILAR( &p_filter->fmt_in.audio, &p_filter->fmt_out.audio ) )
 124     {
 125         msg_Warn( p_filter, "input and outut are not similar" );
 126         return VLC_EGENERIC;
 127     }
 128
 129     p_filter->pf_audio_filter = DoWork;
 130
 131     p_sys = p_filter->p_sys = (filter_sys_t*)malloc( sizeof( *p_sys ) );
 132     if( !p_sys )
 133         return VLC_ENOMEM;
 134
 135     /* Create the object for the thread */
 136     vlc_sem_init( &p_sys->ready, 0 );
 137     p_sys->b_error  = false;
 138     p_sys->i_width  = var_CreateGetInteger( p_filter, "projectm-width" );
 139     p_sys->i_height = var_CreateGetInteger( p_filter, "projectm-height" );
 140     p_sys->i_channels = aout_FormatNbChannels( &p_filter->fmt_in.audio );
 141     p_sys->psz_config = var_CreateGetString( p_filter, "projectm-config" );
 142     vlc_mutex_init( &p_sys->lock );
 143     p_sys->p_buffer = NULL;
 144     p_sys->i_buffer_size = 0;
 145     p_sys->i_nb_samples = 0;
 146
 147     /* Create the thread */
 148     if( vlc_clone( &p_sys->thread, Thread, p_filter, VLC_THREAD_PRIORITY_LOW ) )
 149         goto error;
 150
 151     vlc_sem_wait( &p_sys->ready );
 152     if( p_sys->b_error )
 153     {
 154         vlc_join( p_sys->thread, NULL );
 155         goto error;
 156     }
 157
 158     return VLC_SUCCESS;
 159
 160 error:
 161     vlc_sem_destroy( &p_sys->ready );
 162     free (p_sys );
 163     return VLC_EGENERIC;
 164 }
 165
 166
 167 /**
 168  * Close the module
 169  * @param p_this: the filter object
 170  */
 171 static void Close( vlc_object_t *p_this )
 172 {
 173     filter_t     *p_filter = (filter_t *)p_this;
 174     filter_sys_t *p_sys = p_filter->p_sys;
 175
 176     /* Stop the thread */
 177     vlc_cancel( p_sys->thread );
 178     vlc_join( p_sys->thread, NULL );
 179
 180     /* Free the ressources */
 181     vlc_sem_destroy( &p_sys->ready );
 182     vlc_mutex_destroy( &p_sys->lock );
 183     free( p_sys->p_buffer );
 184     free( p_sys->psz_config );
 185     free( p_sys );
 186 }
 187
 188
 189 /**
 190  * Do the actual work with the new sample
 191  * @param p_aout: audio output object
 192  * @param p_filter: filter object
 193  * @param p_in_buf: input buffer
 194  * @param p_out_buf: output buffer
 195  */
 196 static block_t *DoWork( filter_t *p_filter, block_t *p_in_buf )
 197 {
 198     filter_sys_t *p_sys = p_filter->p_sys;
 199
 200     vlc_mutex_lock( &p_sys->lock );
 201     if( p_sys->i_buffer_size > 0 )
 202     {
 203         p_sys->i_nb_samples = __MIN( p_sys->i_buffer_size,
 204                                      p_in_buf->i_nb_samples );
 205
 206         const float *p_src = (float*)p_in_buf->p_buffer;
 207         for( int i = 0; i < p_sys->i_nb_samples; i++ )
 208         {
 209             float v = 0;
 210             for( int j = 0; j < p_sys->i_channels; j++ )
 211                 v += p_src[p_sys->i_channels * i + j];
 212             p_sys->p_buffer[i] = v / p_sys->i_channels;
 213         }
 214     }
 215     vlc_mutex_unlock( &p_sys->lock );
 216
 217     return p_in_buf;
 218 }
 219
 220 /**
 221  * Variable callback for the dummy vout
 222  */
 223 static int VoutCallback( vlc_object_t *p_vout, char const *psz_name,
 224                          vlc_value_t oldv, vlc_value_t newv, void *p_data )
 225 {
 226     vout_display_t *p_vd = (vout_display_t*)p_data;
 227
 228     if( !strcmp(psz_name, "fullscreen") )
 229     {
 230         vout_SetDisplayFullscreen( p_vd, newv.b_bool );
 231     }
 232 }
 233
 234 /**
 235  * Clean up function when Thread() is cancelled.
 236  */
 237 static void ThreadCleanup( void *p_data )
 238 {
 239     filter_t     *p_filter = (filter_t*)p_data;
 240     filter_sys_t *p_sys = p_filter->p_sys;
 241
 242     /* Cleanup */
 243     delete p_sys->p_projectm;
 244
 245     /* Free the openGL provider */
 246     vout_DeleteDisplay( p_sys->p_vd, NULL );
 247     vlc_object_release( p_sys->p_vout );
 248 }
 249
 250
 251 /**
 252  * ProjectM update thread which do the rendering
 253  * @param p_this: the p_thread object
 254  */
 255 static void *Thread( void *p_data )
 256 {
 257     filter_t     *p_filter = (filter_t*)p_data;
 258     filter_sys_t *p_sys = p_filter->p_sys;
 259     int cancel = vlc_savecancel();
 260     video_format_t fmt;
 261     vout_opengl_t *gl;
 262
 263     /* Create the openGL provider */
 264     p_sys->p_vout =
 265         (vout_thread_t *)vlc_object_create( p_filter, sizeof(vout_thread_t) );
 266     if( !p_sys->p_vout )
 267         goto error;
 268
 269     /* */
 270     video_format_Init( &fmt, 0 );
 271     video_format_Setup( &fmt, VLC_CODEC_RGB32,
 272                         p_sys->i_width, p_sys->i_height, 0 );
 273     fmt.i_sar_num = 1;
 274     fmt.i_sar_den = 1;
 275
 276     vout_display_state_t state;
 277     memset( &state, 0, sizeof(state) );
 278     state.cfg.display.sar.num = 1;
 279     state.cfg.display.sar.den = 1;
 280     state.cfg.is_display_filled = true;
 281     state.cfg.zoom.num = 1;
 282     state.cfg.zoom.den = 1;
 283     state.sar.num = 1;
 284     state.sar.den = 1;
 285
 286     p_sys->p_vd = vout_NewDisplay( p_sys->p_vout, &fmt, &state, "opengl",
 287                                    300000, 1000000 );
 288     if( !p_sys->p_vd )
 289     {
 290         vlc_object_release( p_sys->p_vout );
 291         goto error;
 292     }
 293     var_Create( p_sys->p_vout, "fullscreen", VLC_VAR_BOOL );
 294     var_AddCallback( p_sys->p_vout, "fullscreen", VoutCallback, p_sys->p_vd );
 295
 296     gl = vout_GetDisplayOpengl( p_sys->p_vd );
 297     if( !gl )
 298     {
 299         vout_DeleteDisplay( p_sys->p_vd, NULL );
 300         vlc_object_release( p_sys->p_vout );
 301         goto error;
 302     }
 303     vlc_cleanup_push( ThreadCleanup, p_filter );
 304
 305     /* Create the projectM object */
 306     p_sys->p_projectm = new projectM( p_sys->psz_config );
 307     p_sys->i_buffer_size = p_sys->p_projectm->pcm()->maxsamples;
 308     p_sys->p_buffer = (float*)calloc( p_sys->i_buffer_size,
 309                                       sizeof( float ) );
 310
 311     vlc_sem_post( &p_sys->ready );
 312
 313     /* TODO: Give to projectm the name of the input
 314     p_sys->p_projectm->projectM_setTitle( "" ); */
 315
 316     /* */
 317     int i_last_width  = 0;
 318     int i_last_height = 0;
 319     for( ;; )
 320     {
 321         /* Manage the events */
 322         vout_ManageDisplay( p_sys->p_vd, true );
 323         if( p_sys->p_vd->cfg->display.width  != i_last_width ||
 324             p_sys->p_vd->cfg->display.height != i_last_height )
 325         {
 326             /* FIXME it is not perfect as we will have black bands */
 327             vout_display_place_t place;
 328             vout_display_PlacePicture( &place, &p_sys->p_vd->source, p_sys->p_vd->cfg, false );
 329             p_sys->p_projectm->projectM_resetGL( place.width, place.height );
 330
 331             i_last_width  = p_sys->p_vd->cfg->display.width;
 332             i_last_height = p_sys->p_vd->cfg->display.height;
 333         }
 334
 335         /* Render the image and swap the buffers */
 336         vlc_mutex_lock( &p_sys->lock );
 337         if( p_sys->i_nb_samples > 0 )
 338             p_sys->p_projectm->pcm()->addPCMfloat( p_sys->p_buffer,
 339                                                    p_sys->i_nb_samples );
 340
 341         p_sys->p_projectm->renderFrame();
 342         vlc_mutex_unlock( &p_sys->lock );
 343
 344         if( !vout_opengl_Lock(gl) )
 345         {
 346             vout_opengl_Swap( gl );
 347             vout_opengl_Unlock( gl );
 348         }
 349
 350         /* TODO: use a fps limiter */
 351         vlc_restorecancel( cancel );
 352         msleep( 10000 );
 353         cancel = vlc_savecancel();
 354     }
 355     vlc_cleanup_pop();
 356     abort();
 357
 358 error:
 359     p_sys->b_error = true;
 360     vlc_sem_post( &p_sys->ready );
 361     return NULL;
 362
 363 }
 364