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