lua: Add basic support for renderer discovery
[vlc.git] / modules / visualization / projectm.cpp
1 /*****************************************************************************
2  * projectm.cpp: visualization module based on libprojectM
3  *****************************************************************************
4  * Copyright © 2009-2011 VLC authors and VideoLAN
5  *
6  * Authors: Rémi Duraffort <ivoire@videolan.org>
7  *          Laurent Aimar
8  *
9   * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 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_window.h>
32 #include <vlc_opengl.h>
33 #include <vlc_filter.h>
34 #include <vlc_rand.h>
35
36 #include <libprojectM/projectM.hpp>
37
38 #ifndef _WIN32
39 # include <locale.h>
40 #endif
41 #ifdef HAVE_XLOCALE_H
42 # include <xlocale.h>
43 #endif
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)
108 #else
109     add_directory("projectm-preset-path", PRESET_PATH,
110                   PRESET_PATH_TXT, PRESET_PATH_LONGTXT)
111     add_loadfile("projectm-title-font", FONT_PATH,
112                  TITLE_FONT_TXT, TITLE_FONT_LONGTXT)
113     add_loadfile("projectm-menu-font", FONT_PATH_MENU,
114                  MENU_FONT_TXT, MENU_FONT_LONGTXT)
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 namespace {
135
136 struct filter_sys_t
137 {
138     /* */
139     vlc_thread_t thread;
140
141     /* Opengl */
142     vlc_gl_t  *gl;
143
144     /* audio info */
145     int i_channels;
146
147     /* */
148     vlc_mutex_t lock;
149     bool  b_quit;
150     float *p_buffer;
151     unsigned i_buffer_size;
152     unsigned i_nb_samples;
153 };
154
155 } // namespace
156
157 static block_t *DoWork( filter_t *, block_t * );
158 static void *Thread( void * );
159
160 /**
161  * Open the module
162  * @param p_this: the filter object
163  * @return VLC_SUCCESS or vlc error codes
164  */
165 static int Open( vlc_object_t * p_this )
166 {
167     filter_t     *p_filter = (filter_t *)p_this;
168     filter_sys_t *p_sys;
169
170     p_filter->p_sys = p_sys = (filter_sys_t*)malloc( sizeof( *p_sys ) );
171     if( !p_sys )
172         return VLC_ENOMEM;
173
174     /* Create the object for the thread */
175     p_sys->b_quit        = false;
176     p_sys->i_channels    = aout_FormatNbChannels( &p_filter->fmt_in.audio );
177     vlc_mutex_init( &p_sys->lock );
178     p_sys->p_buffer      = NULL;
179     p_sys->i_buffer_size = 0;
180     p_sys->i_nb_samples  = 0;
181
182     /* Create the OpenGL context */
183     vout_window_cfg_t cfg;
184
185     memset(&cfg, 0, sizeof (cfg));
186     cfg.width = var_CreateGetInteger( p_filter, "projectm-width" );
187     cfg.height = var_CreateGetInteger( p_filter, "projectm-height" );
188
189     p_sys->gl = vlc_gl_surface_Create( VLC_OBJECT(p_filter), &cfg, NULL );
190     if( p_sys->gl == NULL )
191         goto error;
192
193     /* Create the thread */
194     if( vlc_clone( &p_sys->thread, Thread, p_filter,
195                    VLC_THREAD_PRIORITY_LOW ) )
196     {
197         vlc_gl_surface_Destroy( p_sys->gl );
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     free (p_sys );
208     return VLC_EGENERIC;
209 }
210
211
212 /**
213  * Close the module
214  * @param p_this: the filter object
215  */
216 static void Close( vlc_object_t *p_this )
217 {
218     filter_t  *p_filter = (filter_t *)p_this;
219     filter_sys_t *p_sys = reinterpret_cast<filter_sys_t *>( p_filter->p_sys );
220
221     /* Stop the thread
222      * XXX vlc_cleanup_push does not seems to work with C++ so no
223      * vlc_cancel()... */
224     vlc_mutex_lock( &p_sys->lock );
225     p_sys->b_quit = true;
226     vlc_mutex_unlock( &p_sys->lock );
227
228     vlc_join( p_sys->thread, NULL );
229
230     /* Free the ressources */
231     vlc_gl_surface_Destroy( p_sys->gl );
232     free( p_sys->p_buffer );
233     free( p_sys );
234 }
235
236
237 /**
238  * Do the actual work with the new sample
239  * @param p_aout: audio output object
240  * @param p_filter: filter object
241  * @param p_in_buf: input buffer
242  * @param p_out_buf: output buffer
243  */
244 static block_t *DoWork( filter_t *p_filter, block_t *p_in_buf )
245 {
246     filter_sys_t *p_sys = reinterpret_cast<filter_sys_t *>( p_filter->p_sys );
247
248     vlc_mutex_lock( &p_sys->lock );
249     if( p_sys->i_buffer_size > 0 )
250     {
251         p_sys->i_nb_samples = __MIN( p_sys->i_buffer_size,
252                                      p_in_buf->i_nb_samples );
253
254         const float *p_src = (float*)p_in_buf->p_buffer;
255         for( unsigned i = 0; i < p_sys->i_nb_samples; i++ )
256         {
257             float v = 0;
258             for( int j = 0; j < p_sys->i_channels; j++ )
259                 v += p_src[p_sys->i_channels * i + j];
260             p_sys->p_buffer[i] = v / p_sys->i_channels;
261         }
262     }
263     vlc_mutex_unlock( &p_sys->lock );
264
265     return p_in_buf;
266 }
267
268 /**
269  * ProjectM update thread which do the rendering
270  * @param p_this: the p_thread object
271  */
272 static void *Thread( void *p_data )
273 {
274     filter_t  *p_filter = (filter_t*)p_data;
275     filter_sys_t *p_sys = reinterpret_cast<filter_sys_t *>( p_filter->p_sys );
276     vlc_gl_t *gl = p_sys->gl;
277     locale_t loc;
278     locale_t oldloc;
279
280     projectM *p_projectm;
281 #ifndef HAVE_PROJECTM2
282     char *psz_config;
283 #else
284     char *psz_preset_path;
285     char *psz_title_font;
286     char *psz_menu_font;
287     projectM::Settings settings;
288 #endif
289
290     if( vlc_gl_MakeCurrent( gl ) != VLC_SUCCESS )
291     {
292         msg_Err( p_filter, "Can't attach gl context" );
293         return NULL;
294     }
295
296     /* Work-around the projectM locale bug */
297     loc = newlocale (LC_NUMERIC_MASK, "C", NULL);
298     oldloc = uselocale (loc);
299
300     /* Create the projectM object */
301 #ifndef HAVE_PROJECTM2
302     psz_config = var_InheritString( p_filter, "projectm-config" );
303     p_projectm = new projectM( psz_config );
304     free( psz_config );
305 #else
306     psz_preset_path = var_InheritString( p_filter, "projectm-preset-path" );
307 #ifdef _WIN32
308     if ( psz_preset_path == NULL )
309         psz_preset_path = config_GetSysPath(VLC_PKG_DATA_DIR, "visualization");
310 #endif
311
312     psz_title_font                = var_InheritString( p_filter, "projectm-title-font" );
313     psz_menu_font                 = var_InheritString( p_filter, "projectm-menu-font" );
314
315     settings.meshX                = var_InheritInteger( p_filter, "projectm-meshx" );
316     settings.meshY                = var_InheritInteger( p_filter, "projectm-meshy" );
317     settings.fps                  = 35;
318     settings.textureSize          = var_InheritInteger( p_filter, "projectm-texture-size" );
319     settings.windowWidth          = var_InheritInteger( p_filter, "projectm-width" );
320     settings.windowHeight         = var_CreateGetInteger( p_filter, "projectm-height" );
321     settings.presetURL            = psz_preset_path;
322     settings.titleFontURL         = psz_title_font;
323     settings.menuFontURL          = psz_menu_font;
324     settings.smoothPresetDuration = 5;
325     settings.presetDuration       = 30;
326     settings.beatSensitivity      = 10;
327     settings.aspectCorrection     = 1;
328     settings.easterEgg            = 1;
329     settings.shuffleEnabled       = 1;
330     settings.softCutRatingsEnabled= false;
331
332     p_projectm = new projectM( settings );
333
334     free( psz_menu_font );
335     free( psz_title_font );
336     free( psz_preset_path );
337 #endif /* HAVE_PROJECTM2 */
338
339     p_sys->i_buffer_size = p_projectm->pcm()->maxsamples;
340     p_sys->p_buffer = (float*)calloc( p_sys->i_buffer_size,
341                                       sizeof( float ) );
342
343     /* Choose a preset randomly or projectM will always show the first one */
344     if ( p_projectm->getPlaylistSize() > 0 )
345         p_projectm->selectPreset( (unsigned)vlc_mrand48() % p_projectm->getPlaylistSize() );
346
347     /* */
348     for( ;; )
349     {
350         const vlc_tick_t i_deadline = vlc_tick_now() + VLC_TICK_FROM_MS(20); /* 50 fps max */
351
352         /* Manage the events */
353         unsigned width, height;
354         bool quit;
355
356         if( vlc_gl_surface_CheckSize( gl, &width, &height ) )
357             p_projectm->projectM_resetGL( width, height );
358
359         /* Render the image and swap the buffers */
360         vlc_mutex_lock( &p_sys->lock );
361         if( p_sys->i_nb_samples > 0 )
362         {
363             p_projectm->pcm()->addPCMfloat( p_sys->p_buffer,
364                                             p_sys->i_nb_samples );
365             p_sys->i_nb_samples = 0;
366         }
367         quit = p_sys->b_quit;
368         vlc_mutex_unlock( &p_sys->lock );
369
370         if( quit )
371             break;
372
373         p_projectm->renderFrame();
374
375         /* */
376         vlc_tick_wait( i_deadline );
377
378         vlc_gl_Swap( gl );
379     }
380
381     delete p_projectm;
382
383     if (loc != (locale_t)0)
384     {
385         uselocale (oldloc);
386         freelocale (loc);
387     }
388
389     vlc_gl_ReleaseCurrent( gl );
390     return NULL;
391 }