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 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *          Gildas Bazin <gbazin@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #include <errno.h>
  29
  30 #ifdef HAVE_CONFIG_H
  31 # include "config.h"
  32 #endif
  33
  34 #include <vlc/vlc.h>
  35 #include <vlc_aout.h>
  36 #include <vlc_vout.h>
  37 #include <vlc_block.h>
  38 #include <vlc_input.h>
  39
  40 #ifdef USE_GOOM_TREE
  41 #   ifdef OLD_GOOM
  42 #       include "goom_core.h"
  43 #       define PluginInfo void
  44 #       define goom_update(a,b,c,d,e,f) goom_update(b,c,d,e,f)
  45 #       define goom_close(a) goom_close()
  46 #       define goom_init(a,b) NULL; goom_init(a,b,0); goom_set_font(0,0,0)
  47 #   else
  48 #       include "goom.h"
  49 #   endif
  50 #else
  51 #   include <goom/goom.h>
  52 #endif
  53
  54 /*****************************************************************************
  55  * Module descriptor
  56  *****************************************************************************/
  57 static int  Open         ( vlc_object_t * );
  58 static void Close        ( vlc_object_t * );
  59
  60 #define WIDTH_TEXT N_("Goom display width")
  61 #define HEIGHT_TEXT N_("Goom display height")
  62 #define RES_LONGTEXT N_("This allows you to set the resolution of the " \
  63   "Goom display (bigger resolution will be prettier but more CPU intensive).")
  64
  65 #define SPEED_TEXT N_("Goom animation speed")
  66 #define SPEED_LONGTEXT N_("This allows you to set the animation speed " \
  67   "(between 1 and 10, defaults to 6).")
  68
  69 #define MAX_SPEED 10
  70
  71 vlc_module_begin();
  72     set_shortname( _("Goom"));
  73     set_description( _("Goom effect") );
  74     set_category( CAT_AUDIO );
  75     set_subcategory( SUBCAT_AUDIO_VISUAL );
  76     set_capability( "visualization", 0 );
  77     add_integer( "goom-width", 320, NULL,
  78                  WIDTH_TEXT, RES_LONGTEXT, VLC_FALSE );
  79     add_integer( "goom-height", 240, NULL,
  80                  HEIGHT_TEXT, RES_LONGTEXT, VLC_FALSE );
  81     add_integer( "goom-speed", 6, NULL,
  82                  SPEED_TEXT, SPEED_LONGTEXT, VLC_FALSE );
  83     set_callbacks( Open, Close );
  84     add_shortcut( "goom" );
  85 vlc_module_end();
  86
  87 /*****************************************************************************
  88  * Local prototypes
  89  *****************************************************************************/
  90 #define MAX_BLOCKS 100
  91 #define GOOM_DELAY 400000
  92
  93 typedef struct
  94 {
  95     VLC_COMMON_MEMBERS
  96     vout_thread_t *p_vout;
  97
  98     char          *psz_title;
  99
 100     vlc_mutex_t   lock;
 101     vlc_cond_t    wait;
 102
 103     /* Audio properties */
 104     int i_channels;
 105
 106     /* Audio samples queue */
 107     block_t       *pp_blocks[MAX_BLOCKS];
 108     int           i_blocks;
 109
 110     audio_date_t  date;
 111
 112 } goom_thread_t;
 113
 114 typedef struct aout_filter_sys_t
 115 {
 116     goom_thread_t *p_thread;
 117
 118 } aout_filter_sys_t;
 119
 120 static void DoWork   ( aout_instance_t *, aout_filter_t *, aout_buffer_t *,
 121                        aout_buffer_t * );
 122
 123 static void Thread   ( vlc_object_t * );
 124
 125 static char *TitleGet( vlc_object_t * );
 126
 127 /*****************************************************************************
 128  * Open: open a scope effect plugin
 129  *****************************************************************************/
 130 static int Open( vlc_object_t *p_this )
 131 {
 132     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
 133     aout_filter_sys_t *p_sys;
 134     goom_thread_t     *p_thread;
 135     vlc_value_t       width, height;
 136     video_format_t    fmt;
 137
 138
 139     if ( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' )
 140          || p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
 141     {
 142         msg_Warn( p_filter, "bad input or output format" );
 143         return VLC_EGENERIC;
 144     }
 145     if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
 146     {
 147         msg_Warn( p_filter, "input and output formats are not similar" );
 148         return VLC_EGENERIC;
 149     }
 150
 151     p_filter->pf_do_work = DoWork;
 152     p_filter->b_in_place = 1;
 153
 154     /* Allocate structure */
 155     p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
 156
 157     /* Create goom thread */
 158     p_sys->p_thread = p_thread =
 159         vlc_object_create( p_filter, sizeof( goom_thread_t ) );
 160     vlc_object_attach( p_thread, p_this );
 161
 162     var_Create( p_thread, "goom-width", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 163     var_Get( p_thread, "goom-width", &width );
 164     var_Create( p_thread, "goom-height", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 165     var_Get( p_thread, "goom-height", &height );
 166
 167     memset( &fmt, 0, sizeof(video_format_t) );
 168
 169     fmt.i_width = fmt.i_visible_width = width.i_int;
 170     fmt.i_height = fmt.i_visible_height = height.i_int;
 171     fmt.i_chroma = VLC_FOURCC('R','V','3','2');
 172     fmt.i_aspect = VOUT_ASPECT_FACTOR * width.i_int/height.i_int;
 173     fmt.i_sar_num = fmt.i_sar_den = 1;
 174
 175     p_thread->p_vout = vout_Request( p_filter, NULL, &fmt );
 176     if( p_thread->p_vout == NULL )
 177     {
 178         msg_Err( p_filter, "no suitable vout module" );
 179         vlc_object_detach( p_thread );
 180         vlc_object_release( p_thread );
 181         free( p_sys );
 182         return VLC_EGENERIC;
 183     }
 184     vlc_mutex_init( p_filter, &p_thread->lock );
 185     vlc_cond_init( p_filter, &p_thread->wait );
 186
 187     p_thread->i_blocks = 0;
 188     aout_DateInit( &p_thread->date, p_filter->output.i_rate );
 189     aout_DateSet( &p_thread->date, 0 );
 190     p_thread->i_channels = aout_FormatNbChannels( &p_filter->input );
 191
 192     p_thread->psz_title = TitleGet( VLC_OBJECT( p_filter ) );
 193
 194     if( vlc_thread_create( p_thread, "Goom Update Thread", Thread,
 195                            VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
 196     {
 197         msg_Err( p_filter, "cannot lauch goom thread" );
 198         vout_Destroy( p_thread->p_vout );
 199         vlc_mutex_destroy( &p_thread->lock );
 200         vlc_cond_destroy( &p_thread->wait );
 201         free( p_thread->psz_title );
 202         vlc_object_detach( p_thread );
 203         vlc_object_release( p_thread );
 204         free( p_sys );
 205         return VLC_EGENERIC;
 206     }
 207
 208     return VLC_SUCCESS;
 209 }
 210
 211 /*****************************************************************************
 212  * DoWork: process samples buffer
 213  *****************************************************************************
 214  * This function queues the audio buffer to be processed by the goom thread
 215  *****************************************************************************/
 216 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
 217                     aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
 218 {
 219     aout_filter_sys_t *p_sys = p_filter->p_sys;
 220     block_t *p_block;
 221
 222     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
 223     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
 224
 225     /* Queue sample */
 226     vlc_mutex_lock( &p_sys->p_thread->lock );
 227     if( p_sys->p_thread->i_blocks == MAX_BLOCKS )
 228     {
 229         vlc_mutex_unlock( &p_sys->p_thread->lock );
 230         return;
 231     }
 232
 233     p_block = block_New( p_sys->p_thread, p_in_buf->i_nb_bytes );
 234     if( !p_block ) return;
 235     memcpy( p_block->p_buffer, p_in_buf->p_buffer, p_in_buf->i_nb_bytes );
 236     p_block->i_pts = p_in_buf->start_date;
 237
 238     p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks++] = p_block;
 239
 240     vlc_cond_signal( &p_sys->p_thread->wait );
 241     vlc_mutex_unlock( &p_sys->p_thread->lock );
 242 }
 243
 244 /*****************************************************************************
 245  * float to s16 conversion
 246  *****************************************************************************/
 247 static inline int16_t FloatToInt16( float f )
 248 {
 249     if( f >= 1.0 )
 250         return 32767;
 251     else if( f < -1.0 )
 252         return -32768;
 253     else
 254         return (int16_t)( f * 32768.0 );
 255 }
 256
 257 /*****************************************************************************
 258  * Fill buffer
 259  *****************************************************************************/
 260 static int FillBuffer( int16_t *p_data, int *pi_data,
 261                        audio_date_t *pi_date, audio_date_t *pi_date_end,
 262                        goom_thread_t *p_this )
 263 {
 264     int i_samples = 0;
 265     block_t *p_block;
 266
 267     while( *pi_data < 512 )
 268     {
 269         if( !p_this->i_blocks ) return VLC_EGENERIC;
 270
 271         p_block = p_this->pp_blocks[0];
 272         i_samples = __MIN( 512 - *pi_data, p_block->i_buffer /
 273                            sizeof(float) / p_this->i_channels );
 274
 275         /* Date management */
 276         if( p_block->i_pts > 0 &&
 277             p_block->i_pts != aout_DateGet( pi_date_end ) )
 278         {
 279            aout_DateSet( pi_date_end, p_block->i_pts );
 280         }
 281         p_block->i_pts = 0;
 282
 283         aout_DateIncrement( pi_date_end, i_samples );
 284
 285         while( i_samples > 0 )
 286         {
 287             float *p_float = (float *)p_block->p_buffer;
 288
 289             p_data[*pi_data] = FloatToInt16( p_float[0] );
 290             if( p_this->i_channels > 1 )
 291                 p_data[512 + *pi_data] = FloatToInt16( p_float[1] );
 292
 293             (*pi_data)++;
 294             p_block->p_buffer += (sizeof(float) * p_this->i_channels);
 295             p_block->i_buffer -= (sizeof(float) * p_this->i_channels);
 296             i_samples--;
 297         }
 298
 299         if( !p_block->i_buffer )
 300         {
 301             block_Release( p_block );
 302             p_this->i_blocks--;
 303             if( p_this->i_blocks )
 304                 memmove( p_this->pp_blocks, p_this->pp_blocks + 1,
 305                          p_this->i_blocks * sizeof(block_t *) );
 306         }
 307     }
 308
 309     *pi_date = *pi_date_end;
 310     *pi_data = 0;
 311     return VLC_SUCCESS;
 312 }
 313
 314 /*****************************************************************************
 315  * Thread:
 316  *****************************************************************************/
 317 static void Thread( vlc_object_t *p_this )
 318 {
 319     goom_thread_t *p_thread = (goom_thread_t*)p_this;
 320     vlc_value_t width, height, speed;
 321     audio_date_t i_pts;
 322     int16_t p_data[2][512];
 323     int i_data = 0, i_count = 0;
 324     PluginInfo *p_plugin_info;
 325
 326     var_Get( p_this, "goom-width", &width );
 327     var_Get( p_this, "goom-height", &height );
 328
 329     var_Create( p_thread, "goom-speed", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 330     var_Get( p_thread, "goom-speed", &speed );
 331     speed.i_int = MAX_SPEED - speed.i_int;
 332     if( speed.i_int < 0 ) speed.i_int = 0;
 333
 334     p_plugin_info = goom_init( width.i_int, height.i_int );
 335
 336     while( !p_thread->b_die )
 337     {
 338         uint32_t  *plane;
 339         picture_t *p_pic;
 340
 341         /* goom_update is damn slow, so just copy data and release the lock */
 342         vlc_mutex_lock( &p_thread->lock );
 343         if( FillBuffer( (int16_t *)p_data, &i_data, &i_pts,
 344                         &p_thread->date, p_thread ) != VLC_SUCCESS )
 345             vlc_cond_wait( &p_thread->wait, &p_thread->lock );
 346         vlc_mutex_unlock( &p_thread->lock );
 347
 348         /* Speed selection */
 349         if( speed.i_int && (++i_count % (speed.i_int+1)) ) continue;
 350
 351         /* Frame dropping if necessary */
 352         if( aout_DateGet( &i_pts ) + GOOM_DELAY <= mdate() ) continue;
 353
 354         plane = goom_update( p_plugin_info, p_data, 0, 0.0,
 355                              p_thread->psz_title, NULL );
 356
 357         free( p_thread->psz_title );
 358         p_thread->psz_title = NULL;
 359
 360         while( !( p_pic = vout_CreatePicture( p_thread->p_vout, 0, 0, 0 ) ) &&
 361                !p_thread->b_die )
 362         {
 363             msleep( VOUT_OUTMEM_SLEEP );
 364         }
 365
 366         if( p_pic == NULL ) break;
 367
 368         memcpy( p_pic->p[0].p_pixels, plane, width.i_int * height.i_int * 4 );
 369         vout_DatePicture( p_thread->p_vout, p_pic,
 370                           aout_DateGet( &i_pts ) + GOOM_DELAY );
 371         vout_DisplayPicture( p_thread->p_vout, p_pic );
 372     }
 373
 374     goom_close( p_plugin_info );
 375 }
 376
 377 /*****************************************************************************
 378  * Close: close the plugin
 379  *****************************************************************************/
 380 static void Close( vlc_object_t *p_this )
 381 {
 382     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
 383     aout_filter_sys_t *p_sys = p_filter->p_sys;
 384
 385     /* Stop Goom Thread */
 386     vlc_object_kill( p_sys->p_thread );
 387
 388     vlc_mutex_lock( &p_sys->p_thread->lock );
 389     vlc_cond_signal( &p_sys->p_thread->wait );
 390     vlc_mutex_unlock( &p_sys->p_thread->lock );
 391
 392     vlc_thread_join( p_sys->p_thread );
 393
 394     /* Free data */
 395     vout_Request( p_filter, p_sys->p_thread->p_vout, 0 );
 396     vlc_mutex_destroy( &p_sys->p_thread->lock );
 397     vlc_cond_destroy( &p_sys->p_thread->wait );
 398     vlc_object_detach( p_sys->p_thread );
 399
 400     while( p_sys->p_thread->i_blocks-- )
 401     {
 402         block_Release( p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks] );
 403     }
 404
 405     vlc_object_release( p_sys->p_thread );
 406
 407     free( p_sys );
 408 }
 409
 410 static char *TitleGet( vlc_object_t *p_this )
 411 {
 412     char *psz_title = NULL;
 413     input_thread_t *p_input =
 414         vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
 415
 416     if( p_input )
 417     {
 418         psz_title = input_item_GetTitle( input_GetItem( p_input ) );
 419         if( EMPTY_STR( psz_title ) )
 420         {
 421             free( psz_title );
 422             char *psz_orig = input_item_GetURI( input_GetItem( p_input ) );
 423             char *psz = strrchr( psz_orig, '/' );
 424
 425             if( psz )
 426             {
 427                 psz++;
 428             }
 429             else
 430             {
 431                 psz = psz_orig;
 432             }
 433             if( psz && *psz )
 434             {
 435                 psz_title = strdup( psz );
 436             }
 437             free( psz_orig );
 438         }
 439         vlc_object_release( p_input );
 440     }
 441
 442     return psz_title;
 443 }