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 <stdlib.h>                                      /* malloc(), free() */
  29 #include <string.h>                                              /* strdup() */
  30 #include <errno.h>
  31
  32 #include <vlc/vlc.h>
  33 #include <vlc_aout.h>
  34 #include <vlc_vout.h>
  35 #include <vlc_block.h>
  36 #include <vlc_input.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_("This allows you to set 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_("This allows you to set the animation speed " \
  65   "(between 1 and 10, defaults to 6).")
  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     video_format_t    fmt;
 135
 136
 137     if ( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' )
 138          || p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
 139     {
 140         msg_Warn( p_filter, "bad input or output format" );
 141         return VLC_EGENERIC;
 142     }
 143     if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
 144     {
 145         msg_Warn( p_filter, "input and output formats are not similar" );
 146         return VLC_EGENERIC;
 147     }
 148
 149     p_filter->pf_do_work = DoWork;
 150     p_filter->b_in_place = 1;
 151
 152     /* Allocate structure */
 153     p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
 154
 155     /* Create goom thread */
 156     p_sys->p_thread = p_thread =
 157         vlc_object_create( p_filter, sizeof( goom_thread_t ) );
 158     vlc_object_attach( p_thread, p_this );
 159
 160     var_Create( p_thread, "goom-width", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 161     var_Get( p_thread, "goom-width", &width );
 162     var_Create( p_thread, "goom-height", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 163     var_Get( p_thread, "goom-height", &height );
 164
 165     memset( &fmt, 0, sizeof(video_format_t) );
 166
 167     fmt.i_width = fmt.i_visible_width = width.i_int;
 168     fmt.i_height = fmt.i_visible_height = height.i_int;
 169     fmt.i_chroma = VLC_FOURCC('R','V','3','2');
 170     fmt.i_aspect = VOUT_ASPECT_FACTOR * width.i_int/height.i_int;
 171     fmt.i_sar_num = fmt.i_sar_den = 1;
 172
 173     p_thread->p_vout = vout_Request( p_filter, NULL, &fmt );
 174     if( p_thread->p_vout == NULL )
 175     {
 176         msg_Err( p_filter, "no suitable vout module" );
 177         vlc_object_detach( p_thread );
 178         vlc_object_destroy( p_thread );
 179         free( p_sys );
 180         return VLC_EGENERIC;
 181     }
 182     vlc_mutex_init( p_filter, &p_thread->lock );
 183     vlc_cond_init( p_filter, &p_thread->wait );
 184
 185     p_thread->i_blocks = 0;
 186     aout_DateInit( &p_thread->date, p_filter->output.i_rate );
 187     aout_DateSet( &p_thread->date, 0 );
 188     p_thread->i_channels = aout_FormatNbChannels( &p_filter->input );
 189
 190     p_thread->psz_title = TitleGet( VLC_OBJECT( p_filter ) );
 191
 192     if( vlc_thread_create( p_thread, "Goom Update Thread", Thread,
 193                            VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
 194     {
 195         msg_Err( p_filter, "cannot lauch goom thread" );
 196         vout_Destroy( p_thread->p_vout );
 197         vlc_mutex_destroy( &p_thread->lock );
 198         vlc_cond_destroy( &p_thread->wait );
 199         if( p_thread->psz_title ) free( p_thread->psz_title );
 200         vlc_object_detach( p_thread );
 201         vlc_object_destroy( p_thread );
 202         free( p_sys );
 203         return VLC_EGENERIC;
 204     }
 205
 206     return VLC_SUCCESS;
 207 }
 208
 209 /*****************************************************************************
 210  * DoWork: process samples buffer
 211  *****************************************************************************
 212  * This function queues the audio buffer to be processed by the goom thread
 213  *****************************************************************************/
 214 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
 215                     aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
 216 {
 217     aout_filter_sys_t *p_sys = p_filter->p_sys;
 218     block_t *p_block;
 219
 220     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
 221     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
 222
 223     /* Queue sample */
 224     vlc_mutex_lock( &p_sys->p_thread->lock );
 225     if( p_sys->p_thread->i_blocks == MAX_BLOCKS )
 226     {
 227         vlc_mutex_unlock( &p_sys->p_thread->lock );
 228         return;
 229     }
 230
 231     p_block = block_New( p_sys->p_thread, p_in_buf->i_nb_bytes );
 232     if( !p_block ) return;
 233     memcpy( p_block->p_buffer, p_in_buf->p_buffer, p_in_buf->i_nb_bytes );
 234     p_block->i_pts = p_in_buf->start_date;
 235
 236     p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks++] = p_block;
 237
 238     vlc_cond_signal( &p_sys->p_thread->wait );
 239     vlc_mutex_unlock( &p_sys->p_thread->lock );
 240 }
 241
 242 /*****************************************************************************
 243  * float to s16 conversion
 244  *****************************************************************************/
 245 static inline int16_t FloatToInt16( float f )
 246 {
 247     if( f >= 1.0 )
 248         return 32767;
 249     else if( f < -1.0 )
 250         return -32768;
 251     else
 252         return (int16_t)( f * 32768.0 );
 253 }
 254
 255 /*****************************************************************************
 256  * Fill buffer
 257  *****************************************************************************/
 258 static int FillBuffer( int16_t *p_data, int *pi_data,
 259                        audio_date_t *pi_date, audio_date_t *pi_date_end,
 260                        goom_thread_t *p_this )
 261 {
 262     int i_samples = 0;
 263     block_t *p_block;
 264
 265     while( *pi_data < 512 )
 266     {
 267         if( !p_this->i_blocks ) return VLC_EGENERIC;
 268
 269         p_block = p_this->pp_blocks[0];
 270         i_samples = __MIN( 512 - *pi_data, p_block->i_buffer /
 271                            sizeof(float) / p_this->i_channels );
 272
 273         /* Date management */
 274         if( p_block->i_pts > 0 &&
 275             p_block->i_pts != aout_DateGet( pi_date_end ) )
 276         {
 277            aout_DateSet( pi_date_end, p_block->i_pts );
 278         }
 279         p_block->i_pts = 0;
 280
 281         aout_DateIncrement( pi_date_end, i_samples );
 282
 283         while( i_samples > 0 )
 284         {
 285             float *p_float = (float *)p_block->p_buffer;
 286
 287             p_data[*pi_data] = FloatToInt16( p_float[0] );
 288             if( p_this->i_channels > 1 )
 289                 p_data[512 + *pi_data] = FloatToInt16( p_float[1] );
 290
 291             (*pi_data)++;
 292             p_block->p_buffer += (sizeof(float) * p_this->i_channels);
 293             p_block->i_buffer -= (sizeof(float) * p_this->i_channels);
 294             i_samples--;
 295         }
 296
 297         if( !p_block->i_buffer )
 298         {
 299             block_Release( p_block );
 300             p_this->i_blocks--;
 301             if( p_this->i_blocks )
 302                 memmove( p_this->pp_blocks, p_this->pp_blocks + 1,
 303                          p_this->i_blocks * sizeof(block_t *) );
 304         }
 305     }
 306
 307     *pi_date = *pi_date_end;
 308     *pi_data = 0;
 309     return VLC_SUCCESS;
 310 }
 311
 312 /*****************************************************************************
 313  * Thread:
 314  *****************************************************************************/
 315 static void Thread( vlc_object_t *p_this )
 316 {
 317     goom_thread_t *p_thread = (goom_thread_t*)p_this;
 318     vlc_value_t width, height, speed;
 319     audio_date_t i_pts;
 320     int16_t p_data[2][512];
 321     int i_data = 0, i_count = 0;
 322     PluginInfo *p_plugin_info;
 323
 324     var_Get( p_this, "goom-width", &width );
 325     var_Get( p_this, "goom-height", &height );
 326
 327     var_Create( p_thread, "goom-speed", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 328     var_Get( p_thread, "goom-speed", &speed );
 329     speed.i_int = MAX_SPEED - speed.i_int;
 330     if( speed.i_int < 0 ) speed.i_int = 0;
 331
 332     p_plugin_info = goom_init( width.i_int, height.i_int );
 333
 334     while( !p_thread->b_die )
 335     {
 336         uint32_t  *plane;
 337         picture_t *p_pic;
 338
 339         /* goom_update is damn slow, so just copy data and release the lock */
 340         vlc_mutex_lock( &p_thread->lock );
 341         if( FillBuffer( (int16_t *)p_data, &i_data, &i_pts,
 342                         &p_thread->date, p_thread ) != VLC_SUCCESS )
 343             vlc_cond_wait( &p_thread->wait, &p_thread->lock );
 344         vlc_mutex_unlock( &p_thread->lock );
 345
 346         /* Speed selection */
 347         if( speed.i_int && (++i_count % (speed.i_int+1)) ) continue;
 348
 349         /* Frame dropping if necessary */
 350         if( aout_DateGet( &i_pts ) + GOOM_DELAY <= mdate() ) continue;
 351
 352         plane = goom_update( p_plugin_info, p_data, 0, 0.0,
 353                              p_thread->psz_title, NULL );
 354
 355         if( p_thread->psz_title )
 356         {
 357             free( p_thread->psz_title );
 358             p_thread->psz_title = NULL;
 359         }
 360
 361         while( !( p_pic = vout_CreatePicture( p_thread->p_vout, 0, 0, 0 ) ) &&
 362                !p_thread->b_die )
 363         {
 364             msleep( VOUT_OUTMEM_SLEEP );
 365         }
 366
 367         if( p_pic == NULL ) break;
 368
 369         memcpy( p_pic->p[0].p_pixels, plane, width.i_int * height.i_int * 4 );
 370         vout_DatePicture( p_thread->p_vout, p_pic,
 371                           aout_DateGet( &i_pts ) + GOOM_DELAY );
 372         vout_DisplayPicture( p_thread->p_vout, p_pic );
 373     }
 374
 375     goom_close( p_plugin_info );
 376 }
 377
 378 /*****************************************************************************
 379  * Close: close the plugin
 380  *****************************************************************************/
 381 static void Close( vlc_object_t *p_this )
 382 {
 383     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
 384     aout_filter_sys_t *p_sys = p_filter->p_sys;
 385
 386     /* Stop Goom Thread */
 387     vlc_object_kill( p_sys->p_thread );
 388
 389     vlc_mutex_lock( &p_sys->p_thread->lock );
 390     vlc_cond_signal( &p_sys->p_thread->wait );
 391     vlc_mutex_unlock( &p_sys->p_thread->lock );
 392
 393     vlc_thread_join( p_sys->p_thread );
 394
 395     /* Free data */
 396     vout_Request( p_filter, p_sys->p_thread->p_vout, 0 );
 397     vlc_mutex_destroy( &p_sys->p_thread->lock );
 398     vlc_cond_destroy( &p_sys->p_thread->wait );
 399     vlc_object_detach( p_sys->p_thread );
 400
 401     while( p_sys->p_thread->i_blocks-- )
 402     {
 403         block_Release( p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks] );
 404     }
 405
 406     vlc_object_destroy( p_sys->p_thread );
 407
 408     free( p_sys );
 409 }
 410
 411 static char *TitleGet( vlc_object_t *p_this )
 412 {
 413     char *psz_title = NULL;
 414     input_thread_t *p_input =
 415         vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
 416
 417     if( p_input )
 418     {
 419         if( !EMPTY_STR( input_item_GetTitle( input_GetItem(p_input) ) ) )
 420         {
 421             psz_title = strdup( input_item_GetTitle( input_GetItem(p_input) ) );
 422         }
 423         else
 424         {
 425             char *psz = strrchr( input_GetItem(p_input)->psz_uri, '/' );
 426
 427             if( psz )
 428             {
 429                 psz++;
 430             }
 431             else
 432             {
 433                 psz = input_GetItem(p_input)->psz_uri;
 434             }
 435             if( psz && *psz )
 436             {
 437                 psz_title = strdup( psz );
 438             }
 439         }
 440         vlc_object_release( p_input );
 441     }
 442
 443     return psz_title;
 444 }