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