4522f7d33e02ebe50906e06dcc95ab5251146860
[vlc.git] / modules / visualization / goom.c
1 /*****************************************************************************
2  * goom.c: based on libgoom (see http://ios.free.fr/?page=projet&quoi=1)
3  *****************************************************************************
4  * Copyright (C) 2003 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *          Gildas Bazin <gbazin@videolan.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 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 General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28 #include <errno.h>
29
30 #ifdef HAVE_CONFIG_H
31 # include "config.h"
32 #endif
33
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #include <vlc_aout.h>
37 #include <vlc_vout.h>
38 #include <vlc_block.h>
39 #include <vlc_input.h>
40
41 #ifdef USE_GOOM_TREE
42 #   ifdef OLD_GOOM
43 #       include "goom_core.h"
44 #       define PluginInfo void
45 #       define goom_update(a,b,c,d,e,f) goom_update(b,c,d,e,f)
46 #       define goom_close(a) goom_close()
47 #       define goom_init(a,b) NULL; goom_init(a,b,0); goom_set_font(0,0,0)
48 #   else
49 #       include "goom.h"
50 #   endif
51 #else
52 #   include <goom/goom.h>
53 #endif
54
55 /*****************************************************************************
56  * Module descriptor
57  *****************************************************************************/
58 static int  Open         ( vlc_object_t * );
59 static void Close        ( vlc_object_t * );
60
61 #define WIDTH_TEXT N_("Goom display width")
62 #define HEIGHT_TEXT N_("Goom display height")
63 #define RES_LONGTEXT N_("This allows you to set the resolution of the " \
64   "Goom display (bigger resolution will be prettier but more CPU intensive).")
65
66 #define SPEED_TEXT N_("Goom animation speed")
67 #define SPEED_LONGTEXT N_("This allows you to set the animation speed " \
68   "(between 1 and 10, defaults to 6).")
69
70 #define MAX_SPEED 10
71
72 vlc_module_begin ()
73     set_shortname( N_("Goom"))
74     set_description( N_("Goom effect") )
75     set_category( CAT_AUDIO )
76     set_subcategory( SUBCAT_AUDIO_VISUAL )
77     set_capability( "visualization", 0 )
78     add_integer( "goom-width", 800, NULL,
79                  WIDTH_TEXT, RES_LONGTEXT, false )
80     add_integer( "goom-height", 640, NULL,
81                  HEIGHT_TEXT, RES_LONGTEXT, false )
82     add_integer( "goom-speed", 6, NULL,
83                  SPEED_TEXT, SPEED_LONGTEXT, false )
84     set_callbacks( Open, Close )
85     add_shortcut( "goom" )
86 vlc_module_end ()
87
88 /*****************************************************************************
89  * Local prototypes
90  *****************************************************************************/
91 #define MAX_BLOCKS 100
92 #define GOOM_DELAY 400000
93
94 typedef struct
95 {
96     VLC_COMMON_MEMBERS
97     vout_thread_t *p_vout;
98
99     char          *psz_title;
100
101     vlc_mutex_t   lock;
102     vlc_cond_t    wait;
103
104     /* Audio properties */
105     int i_channels;
106
107     /* Audio samples queue */
108     block_t       *pp_blocks[MAX_BLOCKS];
109     int           i_blocks;
110
111     date_t        date;
112
113 } goom_thread_t;
114
115 struct aout_filter_sys_t
116 {
117     goom_thread_t *p_thread;
118
119 };
120
121 static void DoWork   ( aout_instance_t *, aout_filter_t *, aout_buffer_t *,
122                        aout_buffer_t * );
123
124 static void* Thread   ( vlc_object_t * );
125
126 static char *TitleGet( vlc_object_t * );
127
128 /*****************************************************************************
129  * Open: open a scope effect plugin
130  *****************************************************************************/
131 static int Open( vlc_object_t *p_this )
132 {
133     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
134     aout_filter_sys_t *p_sys;
135     goom_thread_t     *p_thread;
136     int                width, height;
137     video_format_t     fmt;
138
139
140     if( p_filter->input.i_format != VLC_CODEC_FL32 ||
141          p_filter->output.i_format != VLC_CODEC_FL32 )
142     {
143         msg_Warn( p_filter, "bad input or output format" );
144         return VLC_EGENERIC;
145     }
146     if( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
147     {
148         msg_Warn( p_filter, "input and output formats are not similar" );
149         return VLC_EGENERIC;
150     }
151
152     p_filter->pf_do_work = DoWork;
153     p_filter->b_in_place = 1;
154
155     /* Allocate structure */
156     p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
157
158     /* Create goom thread */
159     p_sys->p_thread = p_thread =
160         vlc_object_create( p_filter, sizeof( goom_thread_t ) );
161     vlc_object_attach( p_thread, p_this );
162
163     width = var_CreateGetInteger( p_thread, "goom-width" );
164     height = var_CreateGetInteger( p_thread, "goom-height" );
165
166     memset( &fmt, 0, sizeof(video_format_t) );
167
168     fmt.i_width = fmt.i_visible_width = width;
169     fmt.i_height = fmt.i_visible_height = height;
170     fmt.i_chroma = VLC_CODEC_RGB32;
171     fmt.i_aspect = VOUT_ASPECT_FACTOR * width/height;
172     fmt.i_sar_num = fmt.i_sar_den = 1;
173
174     p_thread->p_vout = aout_filter_RequestVout( p_filter, NULL, &fmt );
175     if( p_thread->p_vout == NULL )
176     {
177         msg_Err( p_filter, "no suitable vout module" );
178         vlc_object_detach( p_thread );
179         vlc_object_release( p_thread );
180         free( p_sys );
181         return VLC_EGENERIC;
182     }
183     vlc_mutex_init( &p_thread->lock );
184     vlc_cond_init( &p_thread->wait );
185
186     p_thread->i_blocks = 0;
187     date_Init( &p_thread->date, p_filter->output.i_rate, 1 );
188     date_Set( &p_thread->date, 0 );
189     p_thread->i_channels = aout_FormatNbChannels( &p_filter->input );
190
191     p_thread->psz_title = TitleGet( VLC_OBJECT( p_filter ) );
192
193     if( vlc_thread_create( p_thread, "Goom Update Thread", Thread,
194                            VLC_THREAD_PRIORITY_LOW ) )
195     {
196         msg_Err( p_filter, "cannot lauch goom thread" );
197         vlc_object_release( p_thread->p_vout );
198         vlc_mutex_destroy( &p_thread->lock );
199         vlc_cond_destroy( &p_thread->wait );
200         free( p_thread->psz_title );
201         vlc_object_detach( p_thread );
202         vlc_object_release( p_thread );
203         free( p_sys );
204         return VLC_EGENERIC;
205     }
206
207     return VLC_SUCCESS;
208 }
209
210 /*****************************************************************************
211  * DoWork: process samples buffer
212  *****************************************************************************
213  * This function queues the audio buffer to be processed by the goom thread
214  *****************************************************************************/
215 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
216                     aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
217 {
218     VLC_UNUSED( p_aout );
219
220     aout_filter_sys_t *p_sys = p_filter->p_sys;
221     block_t *p_block;
222
223     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
224     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
225
226     /* Queue sample */
227     vlc_mutex_lock( &p_sys->p_thread->lock );
228     if( p_sys->p_thread->i_blocks == MAX_BLOCKS )
229     {
230         vlc_mutex_unlock( &p_sys->p_thread->lock );
231         return;
232     }
233
234     p_block = block_New( p_sys->p_thread, p_in_buf->i_nb_bytes );
235     if( !p_block )
236     {
237         vlc_mutex_unlock( &p_sys->p_thread->lock );
238         return;
239     }
240     memcpy( p_block->p_buffer, p_in_buf->p_buffer, p_in_buf->i_nb_bytes );
241     p_block->i_pts = p_in_buf->start_date;
242
243     p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks++] = p_block;
244
245     vlc_cond_signal( &p_sys->p_thread->wait );
246     vlc_mutex_unlock( &p_sys->p_thread->lock );
247 }
248
249 /*****************************************************************************
250  * float to s16 conversion
251  *****************************************************************************/
252 static inline int16_t FloatToInt16( float f )
253 {
254     if( f >= 1.0 )
255         return 32767;
256     else if( f < -1.0 )
257         return -32768;
258     else
259         return (int16_t)( f * 32768.0 );
260 }
261
262 /*****************************************************************************
263  * Fill buffer
264  *****************************************************************************/
265 static int FillBuffer( int16_t *p_data, int *pi_data,
266                        date_t *pi_date, date_t *pi_date_end,
267                        goom_thread_t *p_this )
268 {
269     int i_samples = 0;
270     block_t *p_block;
271
272     while( *pi_data < 512 )
273     {
274         if( !p_this->i_blocks ) return VLC_EGENERIC;
275
276         p_block = p_this->pp_blocks[0];
277         i_samples = __MIN( 512 - *pi_data, p_block->i_buffer /
278                            sizeof(float) / p_this->i_channels );
279
280         /* Date management */
281         if( p_block->i_pts > 0 &&
282             p_block->i_pts != date_Get( pi_date_end ) )
283         {
284            date_Set( pi_date_end, p_block->i_pts );
285         }
286         p_block->i_pts = 0;
287
288         date_Increment( pi_date_end, i_samples );
289
290         while( i_samples > 0 )
291         {
292             float *p_float = (float *)p_block->p_buffer;
293
294             p_data[*pi_data] = FloatToInt16( p_float[0] );
295             if( p_this->i_channels > 1 )
296                 p_data[512 + *pi_data] = FloatToInt16( p_float[1] );
297
298             (*pi_data)++;
299             p_block->p_buffer += (sizeof(float) * p_this->i_channels);
300             p_block->i_buffer -= (sizeof(float) * p_this->i_channels);
301             i_samples--;
302         }
303
304         if( !p_block->i_buffer )
305         {
306             block_Release( p_block );
307             p_this->i_blocks--;
308             if( p_this->i_blocks )
309                 memmove( p_this->pp_blocks, p_this->pp_blocks + 1,
310                          p_this->i_blocks * sizeof(block_t *) );
311         }
312     }
313
314     *pi_date = *pi_date_end;
315     *pi_data = 0;
316     return VLC_SUCCESS;
317 }
318
319 /*****************************************************************************
320  * Thread:
321  *****************************************************************************/
322 static void* Thread( vlc_object_t *p_this )
323 {
324     goom_thread_t *p_thread = (goom_thread_t*)p_this;
325     int width, height, speed;
326     date_t i_pts;
327     int16_t p_data[2][512];
328     int i_data = 0, i_count = 0;
329     PluginInfo *p_plugin_info;
330     int canc = vlc_savecancel ();
331
332     width = var_GetInteger( p_this, "goom-width" );
333     height = var_GetInteger( p_this, "goom-height" );
334
335     speed = var_CreateGetInteger( p_thread, "goom-speed" );
336     speed = MAX_SPEED - speed;
337     if( speed < 0 ) speed = 0;
338
339     p_plugin_info = goom_init( width, height );
340
341     while( vlc_object_alive (p_thread) )
342     {
343         uint32_t  *plane;
344         picture_t *p_pic;
345
346         /* goom_update is damn slow, so just copy data and release the lock */
347         vlc_mutex_lock( &p_thread->lock );
348         if( FillBuffer( (int16_t *)p_data, &i_data, &i_pts,
349                         &p_thread->date, p_thread ) != VLC_SUCCESS )
350             vlc_cond_wait( &p_thread->wait, &p_thread->lock );
351         vlc_mutex_unlock( &p_thread->lock );
352
353         /* Speed selection */
354         if( speed && (++i_count % (speed+1)) ) continue;
355
356         /* Frame dropping if necessary */
357         if( date_Get( &i_pts ) + GOOM_DELAY <= mdate() ) continue;
358
359         plane = goom_update( p_plugin_info, p_data, 0, 0.0,
360                              p_thread->psz_title, NULL );
361
362         free( p_thread->psz_title );
363         p_thread->psz_title = NULL;
364
365         while( !( p_pic = vout_CreatePicture( p_thread->p_vout, 0, 0, 0 ) ) &&
366                vlc_object_alive (p_thread) )
367         {
368             msleep( VOUT_OUTMEM_SLEEP );
369         }
370
371         if( p_pic == NULL ) break;
372
373         memcpy( p_pic->p[0].p_pixels, plane, width * height * 4 );
374
375         p_pic->date = date_Get( &i_pts ) + GOOM_DELAY;
376         vout_DisplayPicture( p_thread->p_vout, p_pic );
377     }
378
379     goom_close( p_plugin_info );
380     vlc_restorecancel (canc);
381     return NULL;
382 }
383
384 /*****************************************************************************
385  * Close: close the plugin
386  *****************************************************************************/
387 static void Close( vlc_object_t *p_this )
388 {
389     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
390     aout_filter_sys_t *p_sys = p_filter->p_sys;
391
392     /* Stop Goom Thread */
393     vlc_object_kill( p_sys->p_thread );
394
395     vlc_mutex_lock( &p_sys->p_thread->lock );
396     vlc_cond_signal( &p_sys->p_thread->wait );
397     vlc_mutex_unlock( &p_sys->p_thread->lock );
398
399     vlc_thread_join( p_sys->p_thread );
400
401     /* Free data */
402     aout_filter_RequestVout( p_filter, p_sys->p_thread->p_vout, 0 );
403     vlc_mutex_destroy( &p_sys->p_thread->lock );
404     vlc_cond_destroy( &p_sys->p_thread->wait );
405     vlc_object_detach( p_sys->p_thread );
406
407     while( p_sys->p_thread->i_blocks-- )
408     {
409         block_Release( p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks] );
410     }
411
412     vlc_object_release( p_sys->p_thread );
413
414     free( p_sys );
415 }
416
417 static char *TitleGet( vlc_object_t *p_this )
418 {
419     char *psz_title = NULL;
420     input_thread_t *p_input =
421         vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
422
423     if( p_input )
424     {
425         psz_title = input_item_GetTitle( input_GetItem( p_input ) );
426         if( EMPTY_STR( psz_title ) )
427         {
428             free( psz_title );
429             char *psz_orig = input_item_GetURI( input_GetItem( p_input ) );
430             char *psz = strrchr( psz_orig, '/' );
431
432             if( psz )
433             {
434                 psz++;
435             }
436             else
437             {
438                 psz = psz_orig;
439             }
440             if( psz && *psz )
441             {
442                 psz_title = strdup( psz );
443             }
444             free( psz_orig );
445         }
446         vlc_object_release( p_input );
447     }
448
449     return psz_title;
450 }