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 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33 #include <vlc_plugin.h>
  34 #include <vlc_aout.h>
  35 #include <vlc_vout.h>
  36 #include <vlc_block.h>
  37 #include <vlc_input.h>
  38 #include <vlc_filter.h>
  39
  40 #ifdef USE_GOOM_TREE
  41 #   ifdef OLD_GOOM
  42 #       include "goom_core.h"
  43 #       define PluginInfo void
  44 #       define goom_update(a,b,c,d,e,f) goom_update(b,c,d,e,f)
  45 #       define goom_close(a) goom_close()
  46 #       define goom_init(a,b) NULL; goom_init(a,b,0); goom_set_font(0,0,0)
  47 #   else
  48 #       include "goom.h"
  49 #   endif
  50 #else
  51 #   include <goom/goom.h>
  52 #endif
  53
  54 /*****************************************************************************
  55  * Module descriptor
  56  *****************************************************************************/
  57 static int  Open         ( vlc_object_t * );
  58 static void Close        ( vlc_object_t * );
  59
  60 #define WIDTH_TEXT N_("Goom display width")
  61 #define HEIGHT_TEXT N_("Goom display height")
  62 #define RES_LONGTEXT N_("This allows you to set the resolution of the " \
  63   "Goom display (bigger resolution will be prettier but more CPU intensive).")
  64
  65 #define SPEED_TEXT N_("Goom animation speed")
  66 #define SPEED_LONGTEXT N_("This allows you to set the animation speed " \
  67   "(between 1 and 10, defaults to 6).")
  68
  69 #define MAX_SPEED 10
  70
  71 vlc_module_begin ()
  72     set_shortname( N_("Goom"))
  73     set_description( N_("Goom effect") )
  74     set_category( CAT_AUDIO )
  75     set_subcategory( SUBCAT_AUDIO_VISUAL )
  76     set_capability( "visualization2", 0 )
  77     add_integer( "goom-width", 800, NULL,
  78                  WIDTH_TEXT, RES_LONGTEXT, false )
  79     add_integer( "goom-height", 640, NULL,
  80                  HEIGHT_TEXT, RES_LONGTEXT, false )
  81     add_integer( "goom-speed", 6, NULL,
  82                  SPEED_TEXT, SPEED_LONGTEXT, false )
  83     set_callbacks( Open, Close )
  84     add_shortcut( "goom" )
  85 vlc_module_end ()
  86
  87 /*****************************************************************************
  88  * Local prototypes
  89  *****************************************************************************/
  90 #define MAX_BLOCKS 100
  91 #define GOOM_DELAY 400000
  92
  93 typedef struct
  94 {
  95     VLC_COMMON_MEMBERS
  96     vout_thread_t *p_vout;
  97
  98     char          *psz_title;
  99
 100     vlc_mutex_t   lock;
 101     vlc_cond_t    wait;
 102
 103     /* Audio properties */
 104     unsigned i_channels;
 105
 106     /* Audio samples queue */
 107     block_t       *pp_blocks[MAX_BLOCKS];
 108     int           i_blocks;
 109
 110     date_t        date;
 111
 112 } goom_thread_t;
 113
 114 struct filter_sys_t
 115 {
 116     goom_thread_t *p_thread;
 117
 118 };
 119
 120 static block_t *DoWork ( filter_t *, block_t * );
 121
 122 static void* Thread   ( vlc_object_t * );
 123
 124 static char *TitleGet( vlc_object_t * );
 125
 126 /*****************************************************************************
 127  * Open: open a scope effect plugin
 128  *****************************************************************************/
 129 static int Open( vlc_object_t *p_this )
 130 {
 131     filter_t       *p_filter = (filter_t *)p_this;
 132     filter_sys_t   *p_sys;
 133     goom_thread_t  *p_thread;
 134     int             width, height;
 135     video_format_t fmt;
 136
 137
 138     if( p_filter->fmt_in.audio.i_format != VLC_CODEC_FL32 ||
 139          p_filter->fmt_out.audio.i_format != VLC_CODEC_FL32 )
 140     {
 141         msg_Warn( p_filter, "bad input or output format" );
 142         return VLC_EGENERIC;
 143     }
 144     if( !AOUT_FMTS_SIMILAR( &p_filter->fmt_in.audio, &p_filter->fmt_out.audio ) )
 145     {
 146         msg_Warn( p_filter, "input and output formats are not similar" );
 147         return VLC_EGENERIC;
 148     }
 149
 150     p_filter->pf_audio_filter = DoWork;
 151
 152     /* Allocate structure */
 153     p_sys = p_filter->p_sys = malloc( sizeof( 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     width = var_CreateGetInteger( p_thread, "goom-width" );
 161     height = var_CreateGetInteger( p_thread, "goom-height" );
 162
 163     memset( &fmt, 0, sizeof(video_format_t) );
 164
 165     fmt.i_width = fmt.i_visible_width = width;
 166     fmt.i_height = fmt.i_visible_height = height;
 167     fmt.i_chroma = VLC_CODEC_RGB32;
 168     fmt.i_sar_num = fmt.i_sar_den = 1;
 169
 170     p_thread->p_vout = aout_filter_RequestVout( p_filter, NULL, &fmt );
 171     if( p_thread->p_vout == NULL )
 172     {
 173         msg_Err( p_filter, "no suitable vout module" );
 174         vlc_object_detach( p_thread );
 175         vlc_object_release( p_thread );
 176         free( p_sys );
 177         return VLC_EGENERIC;
 178     }
 179     vlc_mutex_init( &p_thread->lock );
 180     vlc_cond_init( &p_thread->wait );
 181
 182     p_thread->i_blocks = 0;
 183     date_Init( &p_thread->date, p_filter->fmt_out.audio.i_rate, 1 );
 184     date_Set( &p_thread->date, 0 );
 185     p_thread->i_channels = aout_FormatNbChannels( &p_filter->fmt_in.audio );
 186
 187     p_thread->psz_title = TitleGet( VLC_OBJECT( p_filter ) );
 188
 189     if( vlc_thread_create( p_thread, "Goom Update Thread", Thread,
 190                            VLC_THREAD_PRIORITY_LOW ) )
 191     {
 192         msg_Err( p_filter, "cannot lauch goom thread" );
 193         vlc_object_release( p_thread->p_vout );
 194         vlc_mutex_destroy( &p_thread->lock );
 195         vlc_cond_destroy( &p_thread->wait );
 196         free( p_thread->psz_title );
 197         vlc_object_detach( p_thread );
 198         vlc_object_release( p_thread );
 199         free( p_sys );
 200         return VLC_EGENERIC;
 201     }
 202
 203     return VLC_SUCCESS;
 204 }
 205
 206 /*****************************************************************************
 207  * DoWork: process samples buffer
 208  *****************************************************************************
 209  * This function queues the audio buffer to be processed by the goom thread
 210  *****************************************************************************/
 211 static block_t *DoWork( filter_t *p_filter, block_t *p_in_buf )
 212 {
 213     filter_sys_t *p_sys = p_filter->p_sys;
 214     block_t *p_block;
 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 p_in_buf;
 222     }
 223
 224     p_block = block_New( p_sys->p_thread, p_in_buf->i_buffer );
 225     if( !p_block )
 226     {
 227         vlc_mutex_unlock( &p_sys->p_thread->lock );
 228         return p_in_buf;
 229     }
 230     memcpy( p_block->p_buffer, p_in_buf->p_buffer, p_in_buf->i_buffer );
 231     p_block->i_pts = p_in_buf->i_pts;
 232
 233     p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks++] = p_block;
 234
 235     vlc_cond_signal( &p_sys->p_thread->wait );
 236     vlc_mutex_unlock( &p_sys->p_thread->lock );
 237
 238     return p_in_buf;
 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                        date_t *pi_date, 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( (unsigned)(512 - *pi_data),
 270                 p_block->i_buffer / sizeof(float) / p_this->i_channels );
 271
 272         /* Date management */
 273         if( p_block->i_pts > VLC_TS_INVALID &&
 274             p_block->i_pts != date_Get( pi_date_end ) )
 275         {
 276            date_Set( pi_date_end, p_block->i_pts );
 277         }
 278         p_block->i_pts = VLC_TS_INVALID;
 279
 280         date_Increment( 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     int width, height, speed;
 318     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     int canc = vlc_savecancel ();
 323
 324     width = var_GetInteger( p_this, "goom-width" );
 325     height = var_GetInteger( p_this, "goom-height" );
 326
 327     speed = var_CreateGetInteger( p_thread, "goom-speed" );
 328     speed = MAX_SPEED - speed;
 329     if( speed < 0 ) speed = 0;
 330
 331     p_plugin_info = goom_init( width, height );
 332
 333     while( vlc_object_alive (p_thread) )
 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_count % (speed+1)) ) continue;
 347
 348         /* Frame dropping if necessary */
 349         if( date_Get( &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         free( p_thread->psz_title );
 355         p_thread->psz_title = NULL;
 356
 357         while( !( p_pic = vout_CreatePicture( p_thread->p_vout, 0, 0, 0 ) ) &&
 358                vlc_object_alive (p_thread) )
 359         {
 360             msleep( VOUT_OUTMEM_SLEEP );
 361         }
 362
 363         if( p_pic == NULL ) break;
 364
 365         memcpy( p_pic->p[0].p_pixels, plane, width * height * 4 );
 366
 367         p_pic->date = date_Get( &i_pts ) + GOOM_DELAY;
 368         vout_DisplayPicture( p_thread->p_vout, p_pic );
 369     }
 370
 371     goom_close( p_plugin_info );
 372     vlc_restorecancel (canc);
 373     return NULL;
 374 }
 375
 376 /*****************************************************************************
 377  * Close: close the plugin
 378  *****************************************************************************/
 379 static void Close( vlc_object_t *p_this )
 380 {
 381     filter_t     *p_filter = (filter_t *)p_this;
 382     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     aout_filter_RequestVout( 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_release( p_sys->p_thread );
 405
 406     free( p_sys );
 407 }
 408
 409 static char *TitleGet( vlc_object_t *p_this )
 410 {
 411     playlist_t *pl = pl_Hold( p_this );
 412     if( !pl )
 413         return NULL;
 414
 415     input_thread_t *p_input = playlist_CurrentInput( pl );
 416     pl_Release( p_this );
 417     if( !p_input )
 418         return NULL;
 419
 420     char *psz_title = input_item_GetTitle( input_GetItem( p_input ) );
 421     if( EMPTY_STR( psz_title ) )
 422     {
 423         free( psz_title );
 424
 425         char *psz_uri = input_item_GetURI( input_GetItem( p_input ) );
 426         const char *psz = strrchr( psz_orig, '/' );
 427         if( psz )
 428         {
 429             psz_title = strdup( psz + 1 );
 430             free( psz_uri );
 431         }
 432         else
 433             psz_title = psz_uri;
 434     }
 435     vlc_object_release( p_input );
 436     return psz_title;
 437 }