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