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