snap: Added avahi-control to the available plugs
[vlc.git] / modules / visualization / vsxu.cpp
1 /*****************************************************************************
2  * vsxu.cpp: visualization module wrapper for Vovoid VSXu
3  *****************************************************************************
4  * Copyright © 2009-2012 the VideoLAN team, Vovoid Media Technologies
5  *
6  * Authors: Rémi Duraffort <ivoire@videolan.org>
7  *          Laurent Aimar
8  *          Jonatan "jaw" Wallmander
9  *
10  * Used the projectM implementation as reference for this file.
11  *
12  * This program is free software; you can redistribute it and/or modify it
13  * under the terms of the GNU Lesser General Public License as published by
14  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public License
23  * along with this program; if not, write to the Free Software Foundation,
24  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
33 #include <vlc_aout.h>
34 #include <vlc_vout_window.h>
35 #include <vlc_opengl.h>
36 #include <vlc_filter.h>
37
38 // vsxu manager include
39 #include <vsx_manager.h>
40 #include <logo_intro.h>
41
42 // class to handle cyclic buffer
43 #include "cyclic_buffer.h"
44
45 /*****************************************************************************
46  * Module descriptor
47  *****************************************************************************/
48 static int  Open         ( vlc_object_t * );
49 static void Close        ( vlc_object_t * );
50
51 #define WIDTH_TEXT N_("Video width")
52 #define WIDTH_LONGTEXT N_("The width of the video window, in pixels.")
53
54 #define HEIGHT_TEXT N_("Video height")
55 #define HEIGHT_LONGTEXT N_("The height of the video window, in pixels.")
56
57 vlc_module_begin ()
58     set_shortname( N_("vsxu"))
59     set_description( N_("vsxu") )
60     set_capability( "visualization", 0 )
61     set_category( CAT_AUDIO )
62     set_subcategory( SUBCAT_AUDIO_VISUAL )
63     add_integer( "vsxu-width", 1280, WIDTH_TEXT, WIDTH_LONGTEXT,
64                  false )
65     add_integer( "vsxu-height", 800, HEIGHT_TEXT, HEIGHT_LONGTEXT,
66                  false )
67     add_shortcut( "vsxu" )
68     set_callbacks( Open, Close )
69 vlc_module_end ()
70
71
72 /*****************************************************************************
73  * Local prototypes
74  *****************************************************************************/
75 namespace {
76
77 struct filter_sys_t
78 {
79     vlc_thread_t thread;
80     vlc_gl_t *gl;
81
82     vlc_mutex_t lock;
83
84     // mutex around the cyclic block
85     vlc_mutex_t cyclic_block_mutex;
86
87     // cyclic buffer to cache sound frames in
88     cyclic_block_queue* vsxu_cyclic_buffer;
89
90     int i_channels;
91
92     bool b_quit;
93 };
94
95 } // namespace
96
97 static block_t *DoWork( filter_t *, block_t * );
98 static void *Thread( void * );
99
100 /**
101  * Open the module
102  * @param p_this: the filter object
103  * @return VLC_SUCCESS or vlc error codes
104  */
105 static int Open( vlc_object_t * p_this )
106 {
107     filter_t     *p_filter = (filter_t *)p_this;
108     filter_sys_t *p_sys;
109
110     p_sys = p_filter->p_sys = (filter_sys_t*)malloc( sizeof( *p_sys ) );
111     if( unlikely( !p_sys ) )
112     {
113         return VLC_ENOMEM;
114     }
115
116     /* Create the object for the thread */
117     p_sys->b_quit        = false;
118     p_sys->i_channels    = aout_FormatNbChannels( &p_filter->fmt_in.audio );
119     vlc_mutex_init( &p_sys->lock );
120     vlc_mutex_init( &p_sys->cyclic_block_mutex );
121     p_sys->vsxu_cyclic_buffer = new cyclic_block_queue();
122
123     /* Create the openGL provider */
124     vout_window_cfg_t cfg;
125
126     memset( &cfg, 0, sizeof(cfg) );
127     cfg.width = var_InheritInteger( p_filter, "vsxu-width" );
128     cfg.height = var_InheritInteger( p_filter, "vsxu-height" );
129
130     p_sys->gl = vlc_gl_surface_Create( VLC_OBJECT(p_filter), &cfg, NULL );
131     if( p_sys->gl == NULL )
132         goto error;
133
134     /* Create the thread */
135     if( vlc_clone( &p_sys->thread, Thread, p_filter,
136                    VLC_THREAD_PRIORITY_LOW ) )
137     {
138         vlc_gl_surface_Destroy( p_sys->gl );
139         goto error;
140     }
141
142     p_filter->fmt_in.audio.i_format = VLC_CODEC_FL32;
143     p_filter->fmt_out.audio = p_filter->fmt_in.audio;
144     p_filter->pf_audio_filter = DoWork;
145
146     return VLC_SUCCESS;
147
148 error:
149     free( p_sys );
150     return VLC_EGENERIC;
151 }
152
153 /**
154  * Close the module
155  * @param p_this: the filter object
156  */
157 static void Close( vlc_object_t *p_this )
158 {
159     filter_t  *p_filter = (filter_t *)p_this;
160     filter_sys_t *p_sys = p_filter->p_sys;
161
162     vlc_mutex_lock( &p_sys->lock );
163     p_sys->b_quit = true;
164     vlc_mutex_unlock( &p_sys->lock );
165
166     vlc_join( p_sys->thread, NULL );
167
168     /* Free the ressources */
169     vlc_gl_surface_Destroy( p_sys->gl );
170     delete p_sys->vsxu_cyclic_buffer;
171     free( p_sys );
172 }
173
174 /**
175  * Do the actual work with the new sample
176  * @param p_filter: filter object
177  * @param p_in_buf: input buffer
178  */
179 static block_t *DoWork( filter_t *p_filter, block_t *p_in_buf )
180 {
181     filter_sys_t *p_sys = p_filter->p_sys;
182
183     vlc_mutex_lock( &p_sys->lock );
184     vlc_mutex_lock( &p_sys->cyclic_block_mutex );
185
186     unsigned i_nb_samples = __MIN( 1024,
187                                  p_in_buf->i_nb_samples );
188
189     const float *p_src = (float*)p_in_buf->p_buffer;
190     // iterate block holder
191     size_t i_bh_data_iter = 0;
192
193     // calc 512-byte-aligned sample count to grab, we don't need more
194     unsigned i_num_samples = i_nb_samples - i_nb_samples % 512;
195
196     // muls are cheaper than divs
197     float f_onedivchannels = 1.0f / (float)p_sys->i_channels;
198
199     block_holder* p_block_holder = p_sys->vsxu_cyclic_buffer->get_insertion_object();
200     p_block_holder->pts = p_in_buf->i_pts;
201     for( unsigned i = 0; i < i_num_samples; i++ )
202     {
203         float f_v = 0;
204         for( int j = 0; j < p_sys->i_channels; j++ )
205         {
206             f_v += p_src[p_sys->i_channels * i + j];
207         }
208
209         // insert into our little cyclic buffer
210         p_block_holder->data[i_bh_data_iter] = f_v * f_onedivchannels;
211         i_bh_data_iter++;
212         if (i_bh_data_iter == 512 && i < i_num_samples-256)
213         {
214             p_block_holder = p_sys->vsxu_cyclic_buffer->get_insertion_object();
215             p_block_holder->pts = p_in_buf->i_pts + 11609;
216
217             i_bh_data_iter = 0;
218         }
219     }
220
221     vlc_mutex_unlock( &p_sys->cyclic_block_mutex );
222     vlc_mutex_unlock( &p_sys->lock );
223     return p_in_buf;
224 }
225
226 /**
227  * VSXu update thread which do the rendering
228  * @param p_this: the p_thread object
229  */
230 static void *Thread( void *p_data )
231 {
232     filter_t  *p_filter = (filter_t*)p_data;
233     filter_sys_t *p_sys = p_filter->p_sys;
234     vlc_gl_t *gl = p_sys->gl;
235
236     // our abstract manager holder
237     vsx_manager_abs* manager = 0;
238
239     // temp audio buffer for sending to vsxu through manager
240     float f_sample_buf[512];
241
242     // vsxu logo intro
243     vsx_logo_intro* intro = 0;
244
245     bool first = true;
246     bool run = true;
247
248     // tell main thread we are ready
249     if( vlc_gl_MakeCurrent( gl ) != VLC_SUCCESS )
250     {
251         msg_Err( p_filter, "Can't attach gl context" );
252         return NULL;
253     }
254
255     while ( run )
256     {
257         /* Manage the events */
258         unsigned width, height;
259
260         if( vlc_gl_surface_CheckSize( p_sys->gl, &width, &height ) )
261         {
262             /* ??? */
263         }
264
265         // look for control commands from outside the thread
266         vlc_mutex_lock( &p_sys->lock );
267             if( p_sys->b_quit )
268             {
269                 run = false;
270             }
271         vlc_mutex_unlock( &p_sys->lock );
272
273         if (first)
274         {
275             // only run this once
276             first = false;
277
278             // create a new manager
279             manager = manager_factory();
280
281             // init manager with the shared path and sound input type.
282             manager->init( 0, "media_player" );
283
284             // only show logo once
285             // keep track of iterations
286             static int i_iterations = 0;
287             if ( i_iterations++ < 1 )
288             {
289                 intro = new vsx_logo_intro();
290                 intro->set_destroy_textures( false );
291             }
292         }
293
294         // lock cyclic buffer mutex and copy floats
295         vlc_mutex_lock( &p_sys->cyclic_block_mutex );
296             block_holder* bh = p_sys->vsxu_cyclic_buffer->consume();
297             memcpy( &f_sample_buf[0], (void*)(&bh->data[0]), sizeof(float) * 512 );
298         vlc_mutex_unlock( &p_sys->cyclic_block_mutex );
299
300         // send sound pointer to vsxu
301         manager->set_sound_wave( &f_sample_buf[0] );
302
303         // render vsxu engine
304         if (manager) manager->render();
305
306         // render intro
307         if (intro) intro->draw();
308
309         // swap buffers etc.
310         vlc_gl_Swap( gl );
311     }
312
313     // stop vsxu nicely (unloads textures and frees memory)
314     if (manager) manager->stop();
315
316     // call manager factory to destruct our manager object
317     if (manager) manager_destroy( manager );
318
319     // delete the intro (if ever allocated)
320     if (intro) delete intro;
321
322     vlc_gl_ReleaseCurrent( gl );
323
324     // clean up the cyclic buffer
325     vlc_mutex_lock( &p_sys->cyclic_block_mutex );
326         p_sys->vsxu_cyclic_buffer->reset();
327     vlc_mutex_unlock( &p_sys->cyclic_block_mutex );
328
329     // die
330     return NULL;
331 }
332