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 #ifdef HAVE_CONFIG_H
  31 # include "config.h"
  32 #endif
  33
  34 #include <vlc_common.h>
  35 #include <vlc_plugin.h>
  36 #include <vlc_aout.h>
  37 #include <vlc_vout.h>
  38 #include <vlc_block.h>
  39 #include <vlc_input.h>
  40 #include <vlc_filter.h>
  41
  42 #ifdef USE_GOOM_TREE
  43 #   ifdef OLD_GOOM
  44 #       include "goom_core.h"
  45 #       define PluginInfo void
  46 #       define goom_update(a,b,c,d,e,f) goom_update(b,c,d,e,f)
  47 #       define goom_close(a) goom_close()
  48 #       define goom_init(a,b) NULL; goom_init(a,b,0); goom_set_font(0,0,0)
  49 #   else
  50 #       include "goom.h"
  51 #   endif
  52 #else
  53 #   include <goom/goom.h>
  54 #endif
  55
  56 /*****************************************************************************
  57  * Module descriptor
  58  *****************************************************************************/
  59 static int  Open         ( vlc_object_t * );
  60 static void Close        ( vlc_object_t * );
  61
  62 #define WIDTH_TEXT N_("Goom display width")
  63 #define HEIGHT_TEXT N_("Goom display height")
  64 #define RES_LONGTEXT N_("This allows you to set the resolution of the " \
  65   "Goom display (bigger resolution will be prettier but more CPU intensive).")
  66
  67 #define SPEED_TEXT N_("Goom animation speed")
  68 #define SPEED_LONGTEXT N_("This allows you to set the animation speed " \
  69   "(between 1 and 10, defaults to 6).")
  70
  71 #define MAX_SPEED 10
  72
  73 vlc_module_begin ()
  74     set_shortname( N_("Goom"))
  75     set_description( N_("Goom effect") )
  76     set_category( CAT_AUDIO )
  77     set_subcategory( SUBCAT_AUDIO_VISUAL )
  78     set_capability( "visualization2", 0 )
  79     add_integer( "goom-width", 800, NULL,
  80                  WIDTH_TEXT, RES_LONGTEXT, false )
  81     add_integer( "goom-height", 640, NULL,
  82                  HEIGHT_TEXT, RES_LONGTEXT, false )
  83     add_integer( "goom-speed", 6, NULL,
  84                  SPEED_TEXT, SPEED_LONGTEXT, false )
  85     set_callbacks( Open, Close )
  86     add_shortcut( "goom" )
  87 vlc_module_end ()
  88
  89 /*****************************************************************************
  90  * Local prototypes
  91  *****************************************************************************/
  92 #define MAX_BLOCKS 100
  93 #define GOOM_DELAY 400000
  94
  95 typedef struct
  96 {
  97     VLC_COMMON_MEMBERS
  98     vout_thread_t *p_vout;
  99
 100     char          *psz_title;
 101
 102     vlc_mutex_t   lock;
 103     vlc_cond_t    wait;
 104
 105     /* Audio properties */
 106     unsigned i_channels;
 107
 108     /* Audio samples queue */
 109     block_t       *pp_blocks[MAX_BLOCKS];
 110     int           i_blocks;
 111
 112     date_t        date;
 113
 114 } goom_thread_t;
 115
 116 struct filter_sys_t
 117 {
 118     goom_thread_t *p_thread;
 119
 120 };
 121
 122 static block_t *DoWork ( filter_t *, block_t * );
 123
 124 static void* Thread   ( vlc_object_t * );
 125
 126 static char *TitleGet( vlc_object_t * );
 127
 128 /*****************************************************************************
 129  * Open: open a scope effect plugin
 130  *****************************************************************************/
 131 static int Open( vlc_object_t *p_this )
 132 {
 133     filter_t       *p_filter = (filter_t *)p_this;
 134     filter_sys_t   *p_sys;
 135     goom_thread_t  *p_thread;
 136     int             width, height;
 137     video_format_t fmt;
 138
 139
 140     if( p_filter->fmt_in.audio.i_format != VLC_CODEC_FL32 ||
 141          p_filter->fmt_out.audio.i_format != VLC_CODEC_FL32 )
 142     {
 143         msg_Warn( p_filter, "bad input or output format" );
 144         return VLC_EGENERIC;
 145     }
 146     if( !AOUT_FMTS_SIMILAR( &p_filter->fmt_in.audio, &p_filter->fmt_out.audio ) )
 147     {
 148         msg_Warn( p_filter, "input and output formats are not similar" );
 149         return VLC_EGENERIC;
 150     }
 151
 152     p_filter->pf_audio_filter = DoWork;
 153
 154     /* Allocate structure */
 155     p_sys = p_filter->p_sys = malloc( sizeof( 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     width = var_CreateGetInteger( p_thread, "goom-width" );
 163     height = var_CreateGetInteger( p_thread, "goom-height" );
 164
 165     memset( &fmt, 0, sizeof(video_format_t) );
 166
 167     fmt.i_width = fmt.i_visible_width = width;
 168     fmt.i_height = fmt.i_visible_height = height;
 169     fmt.i_chroma = VLC_CODEC_RGB32;
 170     fmt.i_sar_num = fmt.i_sar_den = 1;
 171
 172     p_thread->p_vout = aout_filter_RequestVout( 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_release( p_thread );
 178         free( p_sys );
 179         return VLC_EGENERIC;
 180     }
 181     vlc_mutex_init( &p_thread->lock );
 182     vlc_cond_init( &p_thread->wait );
 183
 184     p_thread->i_blocks = 0;
 185     date_Init( &p_thread->date, p_filter->fmt_out.audio.i_rate, 1 );
 186     date_Set( &p_thread->date, 0 );
 187     p_thread->i_channels = aout_FormatNbChannels( &p_filter->fmt_in.audio );
 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 ) )
 193     {
 194         msg_Err( p_filter, "cannot lauch goom thread" );
 195         vlc_object_release( p_thread->p_vout );
 196         vlc_mutex_destroy( &p_thread->lock );
 197         vlc_cond_destroy( &p_thread->wait );
 198         free( p_thread->psz_title );
 199         vlc_object_detach( p_thread );
 200         vlc_object_release( 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 block_t *DoWork( filter_t *p_filter, block_t *p_in_buf )
 214 {
 215     filter_sys_t *p_sys = p_filter->p_sys;
 216     block_t *p_block;
 217
 218     /* Queue sample */
 219     vlc_mutex_lock( &p_sys->p_thread->lock );
 220     if( p_sys->p_thread->i_blocks == MAX_BLOCKS )
 221     {
 222         vlc_mutex_unlock( &p_sys->p_thread->lock );
 223         return p_in_buf;
 224     }
 225
 226     p_block = block_New( p_sys->p_thread, p_in_buf->i_buffer );
 227     if( !p_block )
 228     {
 229         vlc_mutex_unlock( &p_sys->p_thread->lock );
 230         return p_in_buf;
 231     }
 232     memcpy( p_block->p_buffer, p_in_buf->p_buffer, p_in_buf->i_buffer );
 233     p_block->i_pts = p_in_buf->i_pts;
 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     return p_in_buf;
 241 }
 242
 243 /*****************************************************************************
 244  * float to s16 conversion
 245  *****************************************************************************/
 246 static inline int16_t FloatToInt16( float f )
 247 {
 248     if( f >= 1.0 )
 249         return 32767;
 250     else if( f < -1.0 )
 251         return -32768;
 252     else
 253         return (int16_t)( f * 32768.0 );
 254 }
 255
 256 /*****************************************************************************
 257  * Fill buffer
 258  *****************************************************************************/
 259 static int FillBuffer( int16_t *p_data, int *pi_data,
 260                        date_t *pi_date, date_t *pi_date_end,
 261                        goom_thread_t *p_this )
 262 {
 263     int i_samples = 0;
 264     block_t *p_block;
 265
 266     while( *pi_data < 512 )
 267     {
 268         if( !p_this->i_blocks ) return VLC_EGENERIC;
 269
 270         p_block = p_this->pp_blocks[0];
 271         i_samples = __MIN( (unsigned)(512 - *pi_data),
 272                 p_block->i_buffer / sizeof(float) / p_this->i_channels );
 273
 274         /* Date management */
 275         if( p_block->i_pts > VLC_TS_INVALID &&
 276             p_block->i_pts != date_Get( pi_date_end ) )
 277         {
 278            date_Set( pi_date_end, p_block->i_pts );
 279         }
 280         p_block->i_pts = VLC_TS_INVALID;
 281
 282         date_Increment( pi_date_end, i_samples );
 283
 284         while( i_samples > 0 )
 285         {
 286             float *p_float = (float *)p_block->p_buffer;
 287
 288             p_data[*pi_data] = FloatToInt16( p_float[0] );
 289             if( p_this->i_channels > 1 )
 290                 p_data[512 + *pi_data] = FloatToInt16( p_float[1] );
 291
 292             (*pi_data)++;
 293             p_block->p_buffer += (sizeof(float) * p_this->i_channels);
 294             p_block->i_buffer -= (sizeof(float) * p_this->i_channels);
 295             i_samples--;
 296         }
 297
 298         if( !p_block->i_buffer )
 299         {
 300             block_Release( p_block );
 301             p_this->i_blocks--;
 302             if( p_this->i_blocks )
 303                 memmove( p_this->pp_blocks, p_this->pp_blocks + 1,
 304                          p_this->i_blocks * sizeof(block_t *) );
 305         }
 306     }
 307
 308     *pi_date = *pi_date_end;
 309     *pi_data = 0;
 310     return VLC_SUCCESS;
 311 }
 312
 313 /*****************************************************************************
 314  * Thread:
 315  *****************************************************************************/
 316 static void* Thread( vlc_object_t *p_this )
 317 {
 318     goom_thread_t *p_thread = (goom_thread_t*)p_this;
 319     int width, height, speed;
 320     date_t i_pts;
 321     int16_t p_data[2][512];
 322     int i_data = 0, i_count = 0;
 323     PluginInfo *p_plugin_info;
 324     int canc = vlc_savecancel ();
 325
 326     width = var_GetInteger( p_this, "goom-width" );
 327     height = var_GetInteger( p_this, "goom-height" );
 328
 329     speed = var_CreateGetInteger( p_thread, "goom-speed" );
 330     speed = MAX_SPEED - speed;
 331     if( speed < 0 ) speed = 0;
 332
 333     p_plugin_info = goom_init( width, height );
 334
 335     while( vlc_object_alive (p_thread) )
 336     {
 337         uint32_t  *plane;
 338         picture_t *p_pic;
 339
 340         /* goom_update is damn slow, so just copy data and release the lock */
 341         vlc_mutex_lock( &p_thread->lock );
 342         if( FillBuffer( (int16_t *)p_data, &i_data, &i_pts,
 343                         &p_thread->date, p_thread ) != VLC_SUCCESS )
 344             vlc_cond_wait( &p_thread->wait, &p_thread->lock );
 345         vlc_mutex_unlock( &p_thread->lock );
 346
 347         /* Speed selection */
 348         if( speed && (++i_count % (speed+1)) ) continue;
 349
 350         /* Frame dropping if necessary */
 351         if( date_Get( &i_pts ) + GOOM_DELAY <= mdate() ) continue;
 352
 353         plane = goom_update( p_plugin_info, p_data, 0, 0.0,
 354                              p_thread->psz_title, NULL );
 355
 356         free( p_thread->psz_title );
 357         p_thread->psz_title = NULL;
 358
 359         while( !( p_pic = vout_CreatePicture( p_thread->p_vout, 0, 0, 0 ) ) &&
 360                vlc_object_alive (p_thread) )
 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 * height * 4 );
 368
 369         p_pic->date = date_Get( &i_pts ) + GOOM_DELAY;
 370         vout_DisplayPicture( p_thread->p_vout, p_pic );
 371     }
 372
 373     goom_close( p_plugin_info );
 374     vlc_restorecancel (canc);
 375     return NULL;
 376 }
 377
 378 /*****************************************************************************
 379  * Close: close the plugin
 380  *****************************************************************************/
 381 static void Close( vlc_object_t *p_this )
 382 {
 383     filter_t     *p_filter = (filter_t *)p_this;
 384     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     aout_filter_RequestVout( 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_release( 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         psz_title = input_item_GetTitle( input_GetItem( p_input ) );
 420         if( EMPTY_STR( psz_title ) )
 421         {
 422             free( psz_title );
 423             char *psz_orig = input_item_GetURI( input_GetItem( p_input ) );
 424             char *psz = strrchr( psz_orig, '/' );
 425
 426             if( psz )
 427             {
 428                 psz++;
 429             }
 430             else
 431             {
 432                 psz = psz_orig;
 433             }
 434             if( psz && *psz )
 435             {
 436                 psz_title = strdup( psz );
 437             }
 438             free( psz_orig );
 439         }
 440         vlc_object_release( p_input );
 441     }
 442
 443     return psz_title;
 444 }