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, false );
  79     add_integer( "goom-height", 240, NULL,
  80                  HEIGHT_TEXT, RES_LONGTEXT, false );
  81     add_integer( "goom-speed", 6, NULL,
  82                  SPEED_TEXT, SPEED_LONGTEXT, 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_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, 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     VLC_UNUSED( p_aout );
 220
 221     aout_filter_sys_t *p_sys = p_filter->p_sys;
 222     block_t *p_block;
 223
 224     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
 225     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
 226
 227     /* Queue sample */
 228     vlc_mutex_lock( &p_sys->p_thread->lock );
 229     if( p_sys->p_thread->i_blocks == MAX_BLOCKS )
 230     {
 231         vlc_mutex_unlock( &p_sys->p_thread->lock );
 232         return;
 233     }
 234
 235     p_block = block_New( p_sys->p_thread, p_in_buf->i_nb_bytes );
 236     if( !p_block ) return;
 237     memcpy( p_block->p_buffer, p_in_buf->p_buffer, p_in_buf->i_nb_bytes );
 238     p_block->i_pts = p_in_buf->start_date;
 239
 240     p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks++] = p_block;
 241
 242     vlc_cond_signal( &p_sys->p_thread->wait );
 243     vlc_mutex_unlock( &p_sys->p_thread->lock );
 244 }
 245
 246 /*****************************************************************************
 247  * float to s16 conversion
 248  *****************************************************************************/
 249 static inline int16_t FloatToInt16( float f )
 250 {
 251     if( f >= 1.0 )
 252         return 32767;
 253     else if( f < -1.0 )
 254         return -32768;
 255     else
 256         return (int16_t)( f * 32768.0 );
 257 }
 258
 259 /*****************************************************************************
 260  * Fill buffer
 261  *****************************************************************************/
 262 static int FillBuffer( int16_t *p_data, int *pi_data,
 263                        audio_date_t *pi_date, audio_date_t *pi_date_end,
 264                        goom_thread_t *p_this )
 265 {
 266     int i_samples = 0;
 267     block_t *p_block;
 268
 269     while( *pi_data < 512 )
 270     {
 271         if( !p_this->i_blocks ) return VLC_EGENERIC;
 272
 273         p_block = p_this->pp_blocks[0];
 274         i_samples = __MIN( 512 - *pi_data, p_block->i_buffer /
 275                            sizeof(float) / p_this->i_channels );
 276
 277         /* Date management */
 278         if( p_block->i_pts > 0 &&
 279             p_block->i_pts != aout_DateGet( pi_date_end ) )
 280         {
 281            aout_DateSet( pi_date_end, p_block->i_pts );
 282         }
 283         p_block->i_pts = 0;
 284
 285         aout_DateIncrement( pi_date_end, i_samples );
 286
 287         while( i_samples > 0 )
 288         {
 289             float *p_float = (float *)p_block->p_buffer;
 290
 291             p_data[*pi_data] = FloatToInt16( p_float[0] );
 292             if( p_this->i_channels > 1 )
 293                 p_data[512 + *pi_data] = FloatToInt16( p_float[1] );
 294
 295             (*pi_data)++;
 296             p_block->p_buffer += (sizeof(float) * p_this->i_channels);
 297             p_block->i_buffer -= (sizeof(float) * p_this->i_channels);
 298             i_samples--;
 299         }
 300
 301         if( !p_block->i_buffer )
 302         {
 303             block_Release( p_block );
 304             p_this->i_blocks--;
 305             if( p_this->i_blocks )
 306                 memmove( p_this->pp_blocks, p_this->pp_blocks + 1,
 307                          p_this->i_blocks * sizeof(block_t *) );
 308         }
 309     }
 310
 311     *pi_date = *pi_date_end;
 312     *pi_data = 0;
 313     return VLC_SUCCESS;
 314 }
 315
 316 /*****************************************************************************
 317  * Thread:
 318  *****************************************************************************/
 319 static void Thread( vlc_object_t *p_this )
 320 {
 321     goom_thread_t *p_thread = (goom_thread_t*)p_this;
 322     vlc_value_t width, height, speed;
 323     audio_date_t i_pts;
 324     int16_t p_data[2][512];
 325     int i_data = 0, i_count = 0;
 326     PluginInfo *p_plugin_info;
 327
 328     var_Get( p_this, "goom-width", &width );
 329     var_Get( p_this, "goom-height", &height );
 330
 331     var_Create( p_thread, "goom-speed", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 332     var_Get( p_thread, "goom-speed", &speed );
 333     speed.i_int = MAX_SPEED - speed.i_int;
 334     if( speed.i_int < 0 ) speed.i_int = 0;
 335
 336     p_plugin_info = goom_init( width.i_int, height.i_int );
 337
 338     while( !p_thread->b_die )
 339     {
 340         uint32_t  *plane;
 341         picture_t *p_pic;
 342
 343         /* goom_update is damn slow, so just copy data and release the lock */
 344         vlc_mutex_lock( &p_thread->lock );
 345         if( FillBuffer( (int16_t *)p_data, &i_data, &i_pts,
 346                         &p_thread->date, p_thread ) != VLC_SUCCESS )
 347             vlc_cond_wait( &p_thread->wait, &p_thread->lock );
 348         vlc_mutex_unlock( &p_thread->lock );
 349
 350         /* Speed selection */
 351         if( speed.i_int && (++i_count % (speed.i_int+1)) ) continue;
 352
 353         /* Frame dropping if necessary */
 354         if( aout_DateGet( &i_pts ) + GOOM_DELAY <= mdate() ) continue;
 355
 356         plane = goom_update( p_plugin_info, p_data, 0, 0.0,
 357                              p_thread->psz_title, NULL );
 358
 359         free( p_thread->psz_title );
 360         p_thread->psz_title = NULL;
 361
 362         while( !( p_pic = vout_CreatePicture( p_thread->p_vout, 0, 0, 0 ) ) &&
 363                !p_thread->b_die )
 364         {
 365             msleep( VOUT_OUTMEM_SLEEP );
 366         }
 367
 368         if( p_pic == NULL ) break;
 369
 370         memcpy( p_pic->p[0].p_pixels, plane, width.i_int * height.i_int * 4 );
 371         vout_DatePicture( p_thread->p_vout, p_pic,
 372                           aout_DateGet( &i_pts ) + GOOM_DELAY );
 373         vout_DisplayPicture( p_thread->p_vout, p_pic );
 374     }
 375
 376     goom_close( p_plugin_info );
 377 }
 378
 379 /*****************************************************************************
 380  * Close: close the plugin
 381  *****************************************************************************/
 382 static void Close( vlc_object_t *p_this )
 383 {
 384     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
 385     aout_filter_sys_t *p_sys = p_filter->p_sys;
 386
 387     /* Stop Goom Thread */
 388     vlc_object_kill( p_sys->p_thread );
 389
 390     vlc_mutex_lock( &p_sys->p_thread->lock );
 391     vlc_cond_signal( &p_sys->p_thread->wait );
 392     vlc_mutex_unlock( &p_sys->p_thread->lock );
 393
 394     vlc_thread_join( p_sys->p_thread );
 395
 396     /* Free data */
 397     vout_Request( p_filter, p_sys->p_thread->p_vout, 0 );
 398     vlc_mutex_destroy( &p_sys->p_thread->lock );
 399     vlc_cond_destroy( &p_sys->p_thread->wait );
 400     vlc_object_detach( p_sys->p_thread );
 401
 402     while( p_sys->p_thread->i_blocks-- )
 403     {
 404         block_Release( p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks] );
 405     }
 406
 407     vlc_object_release( p_sys->p_thread );
 408
 409     free( p_sys );
 410 }
 411
 412 static char *TitleGet( vlc_object_t *p_this )
 413 {
 414     char *psz_title = NULL;
 415     input_thread_t *p_input =
 416         vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
 417
 418     if( p_input )
 419     {
 420         psz_title = input_item_GetTitle( input_GetItem( p_input ) );
 421         if( EMPTY_STR( psz_title ) )
 422         {
 423             free( psz_title );
 424             char *psz_orig = input_item_GetURI( input_GetItem( p_input ) );
 425             char *psz = strrchr( psz_orig, '/' );
 426
 427             if( psz )
 428             {
 429                 psz++;
 430             }
 431             else
 432             {
 433                 psz = psz_orig;
 434             }
 435             if( psz && *psz )
 436             {
 437                 psz_title = strdup( psz );
 438             }
 439             free( psz_orig );
 440         }
 441         vlc_object_release( p_input );
 442     }
 443
 444     return psz_title;
 445 }