1 /*****************************************************************************
2 * goom.c: based on libgoom (see http://ios.free.fr/?page=projet&quoi=1)
3 *****************************************************************************
4 * Copyright (C) 2003-2011 the VideoLAN team
6 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
7 * Gildas Bazin <gbazin@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
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 General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_aout.h> /* aout_FormatNbChannels, AOUT_FMTS_SIMILAR */
35 #include <vlc_vout.h> /* vout_*Picture, aout_filter_RequestVout */
37 #include <goom/goom.h>
39 /*****************************************************************************
41 *****************************************************************************/
42 static int Open ( vlc_object_t * );
43 static void Close ( vlc_object_t * );
45 #define WIDTH_TEXT N_("Goom display width")
46 #define HEIGHT_TEXT N_("Goom display height")
47 #define RES_LONGTEXT N_("This allows you to set the resolution of the " \
48 "Goom display (bigger resolution will be prettier but more CPU intensive).")
50 #define SPEED_TEXT N_("Goom animation speed")
51 #define SPEED_LONGTEXT N_("This allows you to set the animation speed " \
52 "(between 1 and 10, defaults to 6).")
57 set_shortname( N_("Goom"))
58 set_description( N_("Goom effect") )
59 set_category( CAT_AUDIO )
60 set_subcategory( SUBCAT_AUDIO_VISUAL )
61 set_capability( "visualization", 0 )
62 add_integer( "goom-width", 800,
63 WIDTH_TEXT, RES_LONGTEXT, false )
64 add_integer( "goom-height", 500,
65 HEIGHT_TEXT, RES_LONGTEXT, false )
66 add_integer_with_range( "goom-speed", 6, 1, 10,
67 SPEED_TEXT, SPEED_LONGTEXT, false )
68 set_callbacks( Open, Close )
69 add_shortcut( "goom" )
72 /*****************************************************************************
74 *****************************************************************************/
75 #define MAX_BLOCKS 100
76 #define GOOM_DELAY 400000
84 vout_thread_t *p_vout;
91 /* Audio properties */
94 /* Audio samples queue */
95 block_t *pp_blocks[MAX_BLOCKS];
104 goom_thread_t *p_thread;
108 static block_t *DoWork ( filter_t *, block_t * );
110 static void *Thread( void * );
112 /*****************************************************************************
113 * Open: open a scope effect plugin
114 *****************************************************************************/
115 static int Open( vlc_object_t *p_this )
117 filter_t *p_filter = (filter_t *)p_this;
119 goom_thread_t *p_thread;
122 /* Allocate structure */
123 p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
125 /* Create goom thread */
126 p_sys->p_thread = p_thread = calloc( 1, sizeof(*p_thread) );
128 const int width = p_thread->i_width = var_InheritInteger( p_filter, "goom-width" );
129 const int height = p_thread->i_height = var_InheritInteger( p_filter, "goom-height" );
131 memset( &fmt, 0, sizeof(video_format_t) );
133 fmt.i_width = fmt.i_visible_width = width;
134 fmt.i_height = fmt.i_visible_height = height;
135 fmt.i_chroma = VLC_CODEC_RGB32;
136 fmt.i_sar_num = fmt.i_sar_den = 1;
138 p_thread->p_vout = aout_filter_RequestVout( p_filter, NULL, &fmt );
139 if( p_thread->p_vout == NULL )
141 msg_Err( p_filter, "no suitable vout module" );
147 p_thread->i_speed = MAX_SPEED - var_InheritInteger( p_filter, "goom-speed" );
148 if( p_thread->i_speed < 0 )
149 p_thread->i_speed = 0;
151 vlc_mutex_init( &p_thread->lock );
152 vlc_cond_init( &p_thread->wait );
154 p_thread->i_blocks = 0;
155 date_Init( &p_thread->date, p_filter->fmt_in.audio.i_rate, 1 );
156 date_Set( &p_thread->date, 0 );
157 p_thread->i_channels = aout_FormatNbChannels( &p_filter->fmt_in.audio );
159 if( vlc_clone( &p_thread->thread,
160 Thread, p_thread, VLC_THREAD_PRIORITY_LOW ) )
162 msg_Err( p_filter, "cannot lauch goom thread" );
163 vlc_mutex_destroy( &p_thread->lock );
164 vlc_cond_destroy( &p_thread->wait );
165 aout_filter_RequestVout( p_filter, p_thread->p_vout, NULL );
171 p_filter->fmt_in.audio.i_format = VLC_CODEC_FL32;
172 p_filter->fmt_out.audio = p_filter->fmt_in.audio;
173 p_filter->pf_audio_filter = DoWork;
177 /*****************************************************************************
178 * DoWork: process samples buffer
179 *****************************************************************************
180 * This function queues the audio buffer to be processed by the goom thread
181 *****************************************************************************/
182 static block_t *DoWork( filter_t *p_filter, block_t *p_in_buf )
184 filter_sys_t *p_sys = p_filter->p_sys;
188 vlc_mutex_lock( &p_sys->p_thread->lock );
189 if( p_sys->p_thread->i_blocks == MAX_BLOCKS )
191 vlc_mutex_unlock( &p_sys->p_thread->lock );
195 p_block = block_Alloc( p_in_buf->i_buffer );
198 vlc_mutex_unlock( &p_sys->p_thread->lock );
201 memcpy( p_block->p_buffer, p_in_buf->p_buffer, p_in_buf->i_buffer );
202 p_block->i_pts = p_in_buf->i_pts;
204 p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks++] = p_block;
206 vlc_cond_signal( &p_sys->p_thread->wait );
207 vlc_mutex_unlock( &p_sys->p_thread->lock );
212 /*****************************************************************************
213 * float to s16 conversion
214 *****************************************************************************/
215 static inline int16_t FloatToInt16( float f )
222 return (int16_t)( f * 32768.0 );
225 /*****************************************************************************
227 *****************************************************************************/
228 static int FillBuffer( int16_t *p_data, int *pi_data,
229 date_t *pi_date, date_t *pi_date_end,
230 goom_thread_t *p_this )
235 while( *pi_data < 512 )
237 if( !p_this->i_blocks ) return VLC_EGENERIC;
239 p_block = p_this->pp_blocks[0];
240 i_samples = __MIN( (unsigned)(512 - *pi_data),
241 p_block->i_buffer / sizeof(float) / p_this->i_channels );
243 /* Date management */
244 if( p_block->i_pts > VLC_TS_INVALID &&
245 p_block->i_pts != date_Get( pi_date_end ) )
247 date_Set( pi_date_end, p_block->i_pts );
249 p_block->i_pts = VLC_TS_INVALID;
251 date_Increment( pi_date_end, i_samples );
253 while( i_samples > 0 )
255 float *p_float = (float *)p_block->p_buffer;
257 p_data[*pi_data] = FloatToInt16( p_float[0] );
258 if( p_this->i_channels > 1 )
259 p_data[512 + *pi_data] = FloatToInt16( p_float[1] );
262 p_block->p_buffer += (sizeof(float) * p_this->i_channels);
263 p_block->i_buffer -= (sizeof(float) * p_this->i_channels);
267 if( !p_block->i_buffer )
269 block_Release( p_block );
271 if( p_this->i_blocks )
272 memmove( p_this->pp_blocks, p_this->pp_blocks + 1,
273 p_this->i_blocks * sizeof(block_t *) );
277 *pi_date = *pi_date_end;
282 /*****************************************************************************
284 *****************************************************************************/
285 static void *Thread( void *p_thread_data )
287 goom_thread_t *p_thread = (goom_thread_t*)p_thread_data;
289 int16_t p_data[2][512];
290 int i_data = 0, i_count = 0;
291 PluginInfo *p_plugin_info;
292 int canc = vlc_savecancel ();
294 p_plugin_info = goom_init( p_thread->i_width, p_thread->i_height );
301 /* FIXME the way the update is done is not really good.
302 * Supurious wake up from p_thread->wait will make it generates a frame
303 * without using new samples (probably rare as we should not be waiting
305 * The frame rate at which the video is generated is not well controlled
306 * nor the time at which each frame is displayed (not smooth)
308 /* goom_update is damn slow, so just copy data and release the lock */
309 vlc_mutex_lock( &p_thread->lock );
310 if( !p_thread->b_exit &&
311 FillBuffer( (int16_t *)p_data, &i_data,
312 &i_pts, &p_thread->date, p_thread ) != VLC_SUCCESS )
313 vlc_cond_wait( &p_thread->wait, &p_thread->lock );
314 bool b_exit = p_thread->b_exit;
315 vlc_mutex_unlock( &p_thread->lock );
320 /* Speed selection */
321 if( p_thread->i_speed && (++i_count % (p_thread->i_speed+1)) ) continue;
323 /* Frame dropping if necessary */
324 if( date_Get( &i_pts ) + GOOM_DELAY <= mdate() ) continue;
326 plane = goom_update( p_plugin_info, p_data, 0, 0.0,
329 while( !( p_pic = vout_GetPicture( p_thread->p_vout ) ) )
331 vlc_mutex_lock( &p_thread->lock );
332 bool b_exit = p_thread->b_exit;
333 vlc_mutex_unlock( &p_thread->lock );
336 msleep( VOUT_OUTMEM_SLEEP );
339 if( p_pic == NULL ) break;
341 memcpy( p_pic->p[0].p_pixels, plane, p_thread->i_width * p_thread->i_height * 4 );
343 p_pic->date = date_Get( &i_pts ) + GOOM_DELAY;
344 vout_PutPicture( p_thread->p_vout, p_pic );
347 goom_close( p_plugin_info );
348 vlc_restorecancel (canc);
352 /*****************************************************************************
353 * Close: close the plugin
354 *****************************************************************************/
355 static void Close( vlc_object_t *p_this )
357 filter_t *p_filter = (filter_t *)p_this;
358 filter_sys_t *p_sys = p_filter->p_sys;
360 /* Stop Goom Thread */
361 vlc_mutex_lock( &p_sys->p_thread->lock );
362 p_sys->p_thread->b_exit = true;
363 vlc_cond_signal( &p_sys->p_thread->wait );
364 vlc_mutex_unlock( &p_sys->p_thread->lock );
366 vlc_join( p_sys->p_thread->thread, NULL );
369 aout_filter_RequestVout( p_filter, p_sys->p_thread->p_vout, NULL );
370 vlc_mutex_destroy( &p_sys->p_thread->lock );
371 vlc_cond_destroy( &p_sys->p_thread->wait );
373 while( p_sys->p_thread->i_blocks-- )
375 block_Release( p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks] );
378 free( p_sys->p_thread );