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