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-2011 VLC authors and VideoLAN
   5  *
   6  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   7  *          Gildas Bazin <gbazin@videolan.org>
   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 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  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 */
  36 #include <vlc_filter.h>
  37
  38 #include <goom/goom.h>
  39
  40 /*****************************************************************************
  41  * Module descriptor
  42  *****************************************************************************/
  43 static int  Open         ( vlc_object_t * );
  44 static void Close        ( vlc_object_t * );
  45
  46 #define WIDTH_TEXT N_("Goom display width")
  47 #define HEIGHT_TEXT N_("Goom display height")
  48 #define RES_LONGTEXT N_("This allows you to set the resolution of the " \
  49   "Goom display (bigger resolution will be prettier but more CPU intensive).")
  50
  51 #define SPEED_TEXT N_("Goom animation speed")
  52 #define SPEED_LONGTEXT N_("This allows you to set the animation speed " \
  53   "(between 1 and 10, defaults to 6).")
  54
  55 #define MAX_SPEED 10
  56
  57 vlc_module_begin ()
  58     set_shortname( N_("Goom"))
  59     set_description( N_("Goom effect") )
  60     set_category( CAT_AUDIO )
  61     set_subcategory( SUBCAT_AUDIO_VISUAL )
  62     set_capability( "visualization", 0 )
  63     add_integer( "goom-width", 800,
  64                  WIDTH_TEXT, RES_LONGTEXT, false )
  65     add_integer( "goom-height", 500,
  66                  HEIGHT_TEXT, RES_LONGTEXT, false )
  67     add_integer_with_range( "goom-speed", 6, 1, 10,
  68                  SPEED_TEXT, SPEED_LONGTEXT, false )
  69     set_callbacks( Open, Close )
  70     add_shortcut( "goom" )
  71 vlc_module_end ()
  72
  73 /*****************************************************************************
  74  * Local prototypes
  75  *****************************************************************************/
  76 #define MAX_BLOCKS 100
  77 #define GOOM_DELAY 400000
  78
  79 typedef struct
  80 {
  81     vlc_thread_t  thread;
  82
  83     int           i_width;
  84     int           i_height;
  85     vout_thread_t *p_vout;
  86     int           i_speed;
  87
  88     vlc_mutex_t   lock;
  89     vlc_cond_t    wait;
  90     bool          b_exit;
  91
  92     /* Audio properties */
  93     unsigned i_channels;
  94
  95     /* Audio samples queue */
  96     block_t       *pp_blocks[MAX_BLOCKS];
  97     int           i_blocks;
  98
  99     date_t        date;
 100
 101 } goom_thread_t;
 102
 103 typedef struct
 104 {
 105     goom_thread_t *p_thread;
 106
 107 } filter_sys_t;
 108
 109 static block_t *DoWork ( filter_t *, block_t * );
 110
 111 static void *Thread( void * );
 112
 113 /*****************************************************************************
 114  * Open: open a scope effect plugin
 115  *****************************************************************************/
 116 static int Open( vlc_object_t *p_this )
 117 {
 118     filter_t       *p_filter = (filter_t *)p_this;
 119     filter_sys_t   *p_sys;
 120     goom_thread_t  *p_thread;
 121     video_format_t fmt;
 122
 123     /* Allocate structure */
 124     p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
 125
 126     /* Create goom thread */
 127     p_sys->p_thread = p_thread = calloc( 1, sizeof(*p_thread) );
 128
 129     const int width  = p_thread->i_width  = var_InheritInteger( p_filter, "goom-width" );
 130     const int height = p_thread->i_height = var_InheritInteger( p_filter, "goom-height" );
 131
 132     memset( &fmt, 0, sizeof(video_format_t) );
 133
 134     fmt.i_width = fmt.i_visible_width = width;
 135     fmt.i_height = fmt.i_visible_height = height;
 136     fmt.i_chroma = VLC_CODEC_RGB32;
 137     fmt.i_sar_num = fmt.i_sar_den = 1;
 138
 139     p_thread->p_vout = aout_filter_RequestVout( p_filter, NULL, &fmt );
 140     if( p_thread->p_vout == NULL )
 141     {
 142         msg_Err( p_filter, "no suitable vout module" );
 143         free( p_thread );
 144         free( p_sys );
 145         return VLC_EGENERIC;
 146     }
 147
 148     p_thread->i_speed = MAX_SPEED - var_InheritInteger( p_filter, "goom-speed" );
 149     if( p_thread->i_speed < 0 )
 150         p_thread->i_speed = 0;
 151
 152     vlc_mutex_init( &p_thread->lock );
 153     vlc_cond_init( &p_thread->wait );
 154
 155     p_thread->i_blocks = 0;
 156     date_Init( &p_thread->date, p_filter->fmt_in.audio.i_rate, 1 );
 157     date_Set( &p_thread->date, VLC_TICK_0 );
 158     p_thread->i_channels = aout_FormatNbChannels( &p_filter->fmt_in.audio );
 159
 160     if( vlc_clone( &p_thread->thread,
 161                    Thread, p_thread, VLC_THREAD_PRIORITY_LOW ) )
 162     {
 163         msg_Err( p_filter, "cannot launch goom thread" );
 164         vlc_mutex_destroy( &p_thread->lock );
 165         vlc_cond_destroy( &p_thread->wait );
 166         aout_filter_RequestVout( p_filter, p_thread->p_vout, NULL );
 167         free( p_thread );
 168         free( p_sys );
 169         return VLC_EGENERIC;
 170     }
 171
 172     p_filter->fmt_in.audio.i_format = VLC_CODEC_FL32;
 173     p_filter->fmt_out.audio = p_filter->fmt_in.audio;
 174     p_filter->pf_audio_filter = DoWork;
 175     return VLC_SUCCESS;
 176 }
 177
 178 /*****************************************************************************
 179  * DoWork: process samples buffer
 180  *****************************************************************************
 181  * This function queues the audio buffer to be processed by the goom thread
 182  *****************************************************************************/
 183 static block_t *DoWork( filter_t *p_filter, block_t *p_in_buf )
 184 {
 185     filter_sys_t *p_sys = p_filter->p_sys;
 186     block_t *p_block;
 187
 188     /* Queue sample */
 189     vlc_mutex_lock( &p_sys->p_thread->lock );
 190     if( p_sys->p_thread->i_blocks == MAX_BLOCKS )
 191     {
 192         vlc_mutex_unlock( &p_sys->p_thread->lock );
 193         return p_in_buf;
 194     }
 195
 196     p_block = block_Alloc( p_in_buf->i_buffer );
 197     if( !p_block )
 198     {
 199         vlc_mutex_unlock( &p_sys->p_thread->lock );
 200         return p_in_buf;
 201     }
 202     memcpy( p_block->p_buffer, p_in_buf->p_buffer, p_in_buf->i_buffer );
 203     p_block->i_pts = p_in_buf->i_pts;
 204
 205     p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks++] = p_block;
 206
 207     vlc_cond_signal( &p_sys->p_thread->wait );
 208     vlc_mutex_unlock( &p_sys->p_thread->lock );
 209
 210     return p_in_buf;
 211 }
 212
 213 /*****************************************************************************
 214  * float to s16 conversion
 215  *****************************************************************************/
 216 static inline int16_t FloatToInt16( float f )
 217 {
 218     if( f >= 1.0 )
 219         return 32767;
 220     else if( f < -1.0 )
 221         return -32768;
 222     else
 223         return (int16_t)( f * 32768.0 );
 224 }
 225
 226 /*****************************************************************************
 227  * Fill buffer
 228  *****************************************************************************/
 229 static int FillBuffer( int16_t *p_data, int *pi_data,
 230                        date_t *pi_date, date_t *pi_date_end,
 231                        goom_thread_t *p_this )
 232 {
 233     int i_samples = 0;
 234     block_t *p_block;
 235
 236     while( *pi_data < 512 )
 237     {
 238         if( !p_this->i_blocks ) return VLC_EGENERIC;
 239
 240         p_block = p_this->pp_blocks[0];
 241         i_samples = __MIN( (unsigned)(512 - *pi_data),
 242                 p_block->i_buffer / sizeof(float) / p_this->i_channels );
 243
 244         /* Date management */
 245         if( p_block->i_pts != VLC_TICK_INVALID &&
 246             p_block->i_pts != date_Get( pi_date_end ) )
 247         {
 248            date_Set( pi_date_end, p_block->i_pts );
 249         }
 250         p_block->i_pts = VLC_TICK_INVALID;
 251
 252         date_Increment( pi_date_end, i_samples );
 253
 254         while( i_samples > 0 )
 255         {
 256             float *p_float = (float *)p_block->p_buffer;
 257
 258             p_data[*pi_data] = FloatToInt16( p_float[0] );
 259             if( p_this->i_channels > 1 )
 260                 p_data[512 + *pi_data] = FloatToInt16( p_float[1] );
 261
 262             (*pi_data)++;
 263             p_block->p_buffer += (sizeof(float) * p_this->i_channels);
 264             p_block->i_buffer -= (sizeof(float) * p_this->i_channels);
 265             i_samples--;
 266         }
 267
 268         if( !p_block->i_buffer )
 269         {
 270             block_Release( p_block );
 271             p_this->i_blocks--;
 272             if( p_this->i_blocks )
 273                 memmove( p_this->pp_blocks, p_this->pp_blocks + 1,
 274                          p_this->i_blocks * sizeof(block_t *) );
 275         }
 276     }
 277
 278     *pi_date = *pi_date_end;
 279     *pi_data = 0;
 280     return VLC_SUCCESS;
 281 }
 282
 283 /*****************************************************************************
 284  * Thread:
 285  *****************************************************************************/
 286 static void *Thread( void *p_thread_data )
 287 {
 288     goom_thread_t *p_thread = (goom_thread_t*)p_thread_data;
 289     date_t i_pts;
 290     int16_t p_data[2][512];
 291     int i_data = 0, i_count = 0;
 292     PluginInfo *p_plugin_info;
 293     int canc = vlc_savecancel ();
 294
 295     p_plugin_info = goom_init( p_thread->i_width, p_thread->i_height );
 296
 297     for( ;; )
 298     {
 299         uint32_t  *plane;
 300         picture_t *p_pic;
 301
 302         /* FIXME the way the update is done is not really good.
 303          *  Supurious wake up from p_thread->wait will make it generates a frame
 304          * without using new samples (probably rare as we should not be waiting
 305          * samples).
 306          *  The frame rate at which the video is generated is not well controlled
 307          * nor the time at which each frame is displayed (not smooth)
 308          */
 309         /* goom_update is damn slow, so just copy data and release the lock */
 310         vlc_mutex_lock( &p_thread->lock );
 311         if( !p_thread->b_exit &&
 312             FillBuffer( (int16_t *)p_data, &i_data,
 313                         &i_pts, &p_thread->date, p_thread ) != VLC_SUCCESS )
 314             vlc_cond_wait( &p_thread->wait, &p_thread->lock );
 315         bool b_exit = p_thread->b_exit;
 316         vlc_mutex_unlock( &p_thread->lock );
 317
 318         if( b_exit )
 319             break;
 320
 321         /* Speed selection */
 322         if( p_thread->i_speed && (++i_count % (p_thread->i_speed+1)) ) continue;
 323
 324         /* Frame dropping if necessary */
 325         if( date_Get( &i_pts ) + GOOM_DELAY <= vlc_tick_now() ) continue;
 326
 327         plane = goom_update( p_plugin_info, p_data, 0, 0.0,
 328                              NULL, NULL );
 329
 330         p_pic = vout_GetPicture( p_thread->p_vout );
 331         if( unlikely(p_pic == NULL) )
 332             continue;
 333
 334         memcpy( p_pic->p[0].p_pixels, plane, p_thread->i_width * p_thread->i_height * 4 );
 335
 336         p_pic->date = date_Get( &i_pts ) + GOOM_DELAY;
 337         vout_PutPicture( p_thread->p_vout, p_pic );
 338     }
 339
 340     goom_close( p_plugin_info );
 341     vlc_restorecancel (canc);
 342     return NULL;
 343 }
 344
 345 /*****************************************************************************
 346  * Close: close the plugin
 347  *****************************************************************************/
 348 static void Close( vlc_object_t *p_this )
 349 {
 350     filter_t     *p_filter = (filter_t *)p_this;
 351     filter_sys_t *p_sys = p_filter->p_sys;
 352
 353     /* Stop Goom Thread */
 354     vlc_mutex_lock( &p_sys->p_thread->lock );
 355     p_sys->p_thread->b_exit = true;
 356     vlc_cond_signal( &p_sys->p_thread->wait );
 357     vlc_mutex_unlock( &p_sys->p_thread->lock );
 358
 359     vlc_join( p_sys->p_thread->thread, NULL );
 360
 361     /* Free data */
 362     aout_filter_RequestVout( p_filter, p_sys->p_thread->p_vout, NULL );
 363     vlc_mutex_destroy( &p_sys->p_thread->lock );
 364     vlc_cond_destroy( &p_sys->p_thread->wait );
 365
 366     while( p_sys->p_thread->i_blocks-- )
 367     {
 368         block_Release( p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks] );
 369     }
 370
 371     free( p_sys->p_thread );
 372
 373     free( p_sys );
 374 }
 375