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