1 /*****************************************************************************
2 * projectm: visualization module based on libprojectM
3 *****************************************************************************
4 * Copyright (C) 2009 the VideoLAN team
7 * Authors: RĂ©mi Duraffort <ivoire@videolan.org>
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)
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
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 *****************************************************************************/
28 #include <vlc_common.h>
29 #include <vlc_plugin.h>
32 #include <vlc_vout_wrapper.h>
33 #include <vlc_filter.h>
35 #include <libprojectM/projectM.hpp>
38 /*****************************************************************************
40 *****************************************************************************/
41 static int Open ( vlc_object_t * );
42 static void Close ( vlc_object_t * );
44 #define CONFIG_TEXT N_("projectM configuration file")
45 #define CONFIG_LONGTEXT N_("File that will be used to configure the projectM " \
48 #define WIDTH_TEXT N_("Video width")
49 #define WIDTH_LONGTEXT N_("The width of the video window, in pixels.")
51 #define HEIGHT_TEXT N_("Video height")
52 #define HEIGHT_LONGTEXT N_("The height of the video window, in pixels.")
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,
64 add_integer( "projectm-height", 640, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT,
66 add_shortcut( "projectm" )
67 set_callbacks( Open, Close )
71 /*****************************************************************************
73 *****************************************************************************/
82 vout_thread_t *p_vout;
85 /* libprojectM objects */
103 static block_t *DoWork( filter_t *, block_t * );
104 static void *Thread( void * );
108 * @param p_this: the filter object
109 * @return VLC_SUCCESS or vlc error codes
111 static int Open( vlc_object_t * p_this )
113 filter_t *p_filter = (filter_t *)p_this;
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 )
120 msg_Warn( p_filter, "bad input or output format" );
123 if( !AOUT_FMTS_SIMILAR( &p_filter->fmt_in.audio, &p_filter->fmt_out.audio ) )
125 msg_Warn( p_filter, "input and outut are not similar" );
129 p_filter->pf_audio_filter = DoWork;
131 p_sys = p_filter->p_sys = (filter_sys_t*)malloc( sizeof( *p_sys ) );
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;
147 /* Create the thread */
148 if( vlc_clone( &p_sys->thread, Thread, p_filter, VLC_THREAD_PRIORITY_LOW ) )
151 vlc_sem_wait( &p_sys->ready );
154 vlc_join( p_sys->thread, NULL );
161 vlc_sem_destroy( &p_sys->ready );
169 * @param p_this: the filter object
171 static void Close( vlc_object_t *p_this )
173 filter_t *p_filter = (filter_t *)p_this;
174 filter_sys_t *p_sys = p_filter->p_sys;
176 /* Stop the thread */
177 vlc_cancel( p_sys->thread );
178 vlc_join( p_sys->thread, NULL );
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 );
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
196 static block_t *DoWork( filter_t *p_filter, block_t *p_in_buf )
198 filter_sys_t *p_sys = p_filter->p_sys;
200 vlc_mutex_lock( &p_sys->lock );
201 if( p_sys->i_buffer_size > 0 )
203 p_sys->i_nb_samples = __MIN( p_sys->i_buffer_size,
204 p_in_buf->i_nb_samples );
206 const float *p_src = (float*)p_in_buf->p_buffer;
207 for( int i = 0; i < p_sys->i_nb_samples; i++ )
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;
215 vlc_mutex_unlock( &p_sys->lock );
221 * Variable callback for the dummy vout
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 )
226 vout_display_t *p_vd = (vout_display_t*)p_data;
228 if( !strcmp(psz_name, "fullscreen") )
230 vout_SetDisplayFullscreen( p_vd, newv.b_bool );
235 * Clean up function when Thread() is cancelled.
237 static void ThreadCleanup( void *p_data )
239 filter_t *p_filter = (filter_t*)p_data;
240 filter_sys_t *p_sys = p_filter->p_sys;
243 delete p_sys->p_projectm;
245 /* Free the openGL provider */
246 vout_DeleteDisplay( p_sys->p_vd, NULL );
247 vlc_object_release( p_sys->p_vout );
252 * ProjectM update thread which do the rendering
253 * @param p_this: the p_thread object
255 static void *Thread( void *p_data )
257 filter_t *p_filter = (filter_t*)p_data;
258 filter_sys_t *p_sys = p_filter->p_sys;
259 int cancel = vlc_savecancel();
263 /* Create the openGL provider */
265 (vout_thread_t *)vlc_object_create( p_filter, sizeof(vout_thread_t) );
270 video_format_Init( &fmt, 0 );
271 video_format_Setup( &fmt, VLC_CODEC_RGB32,
272 p_sys->i_width, p_sys->i_height, 0 );
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;
286 p_sys->p_vd = vout_NewDisplay( p_sys->p_vout, &fmt, &state, "opengl",
290 vlc_object_release( p_sys->p_vout );
293 var_Create( p_sys->p_vout, "fullscreen", VLC_VAR_BOOL );
294 var_AddCallback( p_sys->p_vout, "fullscreen", VoutCallback, p_sys->p_vd );
296 gl = vout_GetDisplayOpengl( p_sys->p_vd );
299 vout_DeleteDisplay( p_sys->p_vd, NULL );
300 vlc_object_release( p_sys->p_vout );
303 vlc_cleanup_push( ThreadCleanup, p_filter );
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,
311 vlc_sem_post( &p_sys->ready );
313 /* TODO: Give to projectm the name of the input
314 p_sys->p_projectm->projectM_setTitle( "" ); */
317 int i_last_width = 0;
318 int i_last_height = 0;
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 )
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 );
331 i_last_width = p_sys->p_vd->cfg->display.width;
332 i_last_height = p_sys->p_vd->cfg->display.height;
335 /* Render the image and swap the buffers */
336 vlc_mutex_lock( &p_sys->lock );
337 if( p_sys->i_nb_samples > 0 )
339 p_sys->p_projectm->pcm()->addPCMfloat( p_sys->p_buffer,
340 p_sys->i_nb_samples );
341 p_sys->i_nb_samples = 0;
343 vlc_mutex_unlock( &p_sys->lock );
345 p_sys->p_projectm->renderFrame();
347 if( !vout_opengl_Lock(gl) )
349 vout_opengl_Swap( gl );
350 vout_opengl_Unlock( gl );
353 /* TODO: use a fps limiter */
354 vlc_restorecancel( cancel );
356 cancel = vlc_savecancel();
362 p_sys->b_error = true;
363 vlc_sem_post( &p_sys->ready );