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_aspect = VOUT_ASPECT_FACTOR * width/height;
 171     fmt.i_sar_num = fmt.i_sar_den = 1;
 172
 173     p_thread->p_vout = aout_filter_RequestVout( 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_release( p_thread );
 179         free( p_sys );
 180         return VLC_EGENERIC;
 181     }
 182     vlc_mutex_init( &p_thread->lock );
 183     vlc_cond_init( &p_thread->wait );
 184
 185     p_thread->i_blocks = 0;
 186     date_Init( &p_thread->date, p_filter->fmt_out.audio.i_rate, 1 );
 187     date_Set( &p_thread->date, 0 );
 188     p_thread->i_channels = aout_FormatNbChannels( &p_filter->fmt_in.audio );
 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 ) )
 194     {
 195         msg_Err( p_filter, "cannot lauch goom thread" );
 196         vlc_object_release( p_thread->p_vout );
 197         vlc_mutex_destroy( &p_thread->lock );
 198         vlc_cond_destroy( &p_thread->wait );
 199         free( p_thread->psz_title );
 200         vlc_object_detach( p_thread );
 201         vlc_object_release( 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 block_t *DoWork( filter_t *p_filter, block_t *p_in_buf )
 215 {
 216     filter_sys_t *p_sys = p_filter->p_sys;
 217     block_t *p_block;
 218
 219     /* Queue sample */
 220     vlc_mutex_lock( &p_sys->p_thread->lock );
 221     if( p_sys->p_thread->i_blocks == MAX_BLOCKS )
 222     {
 223         vlc_mutex_unlock( &p_sys->p_thread->lock );
 224         return p_in_buf;
 225     }
 226
 227     p_block = block_New( p_sys->p_thread, p_in_buf->i_buffer );
 228     if( !p_block )
 229     {
 230         vlc_mutex_unlock( &p_sys->p_thread->lock );
 231         return p_in_buf;
 232     }
 233     memcpy( p_block->p_buffer, p_in_buf->p_buffer, p_in_buf->i_buffer );
 234     p_block->i_pts = p_in_buf->i_pts;
 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     return p_in_buf;
 242 }
 243
 244 /*****************************************************************************
 245  * float to s16 conversion
 246  *****************************************************************************/
 247 static inline int16_t FloatToInt16( float f )
 248 {
 249     if( f >= 1.0 )
 250         return 32767;
 251     else if( f < -1.0 )
 252         return -32768;
 253     else
 254         return (int16_t)( f * 32768.0 );
 255 }
 256
 257 /*****************************************************************************
 258  * Fill buffer
 259  *****************************************************************************/
 260 static int FillBuffer( int16_t *p_data, int *pi_data,
 261                        date_t *pi_date, date_t *pi_date_end,
 262                        goom_thread_t *p_this )
 263 {
 264     int i_samples = 0;
 265     block_t *p_block;
 266
 267     while( *pi_data < 512 )
 268     {
 269         if( !p_this->i_blocks ) return VLC_EGENERIC;
 270
 271         p_block = p_this->pp_blocks[0];
 272         i_samples = __MIN( (unsigned)(512 - *pi_data),
 273                 p_block->i_buffer / sizeof(float) / p_this->i_channels );
 274
 275         /* Date management */
 276         if( p_block->i_pts > 0 &&
 277             p_block->i_pts != date_Get( pi_date_end ) )
 278         {
 279            date_Set( pi_date_end, p_block->i_pts );
 280         }
 281         p_block->i_pts = 0;
 282
 283         date_Increment( pi_date_end, i_samples );
 284
 285         while( i_samples > 0 )
 286         {
 287             float *p_float = (float *)p_block->p_buffer;
 288
 289             p_data[*pi_data] = FloatToInt16( p_float[0] );
 290             if( p_this->i_channels > 1 )
 291                 p_data[512 + *pi_data] = FloatToInt16( p_float[1] );
 292
 293             (*pi_data)++;
 294             p_block->p_buffer += (sizeof(float) * p_this->i_channels);
 295             p_block->i_buffer -= (sizeof(float) * p_this->i_channels);
 296             i_samples--;
 297         }
 298
 299         if( !p_block->i_buffer )
 300         {
 301             block_Release( p_block );
 302             p_this->i_blocks--;
 303             if( p_this->i_blocks )
 304                 memmove( p_this->pp_blocks, p_this->pp_blocks + 1,
 305                          p_this->i_blocks * sizeof(block_t *) );
 306         }
 307     }
 308
 309     *pi_date = *pi_date_end;
 310     *pi_data = 0;
 311     return VLC_SUCCESS;
 312 }
 313
 314 /*****************************************************************************
 315  * Thread:
 316  *****************************************************************************/
 317 static void* Thread( vlc_object_t *p_this )
 318 {
 319     goom_thread_t *p_thread = (goom_thread_t*)p_this;
 320     int width, height, speed;
 321     date_t i_pts;
 322     int16_t p_data[2][512];
 323     int i_data = 0, i_count = 0;
 324     PluginInfo *p_plugin_info;
 325     int canc = vlc_savecancel ();
 326
 327     width = var_GetInteger( p_this, "goom-width" );
 328     height = var_GetInteger( p_this, "goom-height" );
 329
 330     speed = var_CreateGetInteger( p_thread, "goom-speed" );
 331     speed = MAX_SPEED - speed;
 332     if( speed < 0 ) speed = 0;
 333
 334     p_plugin_info = goom_init( width, height );
 335
 336     while( vlc_object_alive (p_thread) )
 337     {
 338         uint32_t  *plane;
 339         picture_t *p_pic;
 340
 341         /* goom_update is damn slow, so just copy data and release the lock */
 342         vlc_mutex_lock( &p_thread->lock );
 343         if( FillBuffer( (int16_t *)p_data, &i_data, &i_pts,
 344                         &p_thread->date, p_thread ) != VLC_SUCCESS )
 345             vlc_cond_wait( &p_thread->wait, &p_thread->lock );
 346         vlc_mutex_unlock( &p_thread->lock );
 347
 348         /* Speed selection */
 349         if( speed && (++i_count % (speed+1)) ) continue;
 350
 351         /* Frame dropping if necessary */
 352         if( date_Get( &i_pts ) + GOOM_DELAY <= mdate() ) continue;
 353
 354         plane = goom_update( p_plugin_info, p_data, 0, 0.0,
 355                              p_thread->psz_title, NULL );
 356
 357         free( p_thread->psz_title );
 358         p_thread->psz_title = NULL;
 359
 360         while( !( p_pic = vout_CreatePicture( p_thread->p_vout, 0, 0, 0 ) ) &&
 361                vlc_object_alive (p_thread) )
 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 * height * 4 );
 369
 370         p_pic->date = date_Get( &i_pts ) + GOOM_DELAY;
 371         vout_DisplayPicture( p_thread->p_vout, p_pic );
 372     }
 373
 374     goom_close( p_plugin_info );
 375     vlc_restorecancel (canc);
 376     return NULL;
 377 }
 378
 379 /*****************************************************************************
 380  * Close: close the plugin
 381  *****************************************************************************/
 382 static void Close( vlc_object_t *p_this )
 383 {
 384     filter_t     *p_filter = (filter_t *)p_this;
 385     filter_sys_t *p_sys = p_filter->p_sys;
 386
 387     /* Stop Goom Thread */
 388     vlc_object_kill( p_sys->p_thread );
 389
 390     vlc_mutex_lock( &p_sys->p_thread->lock );
 391     vlc_cond_signal( &p_sys->p_thread->wait );
 392     vlc_mutex_unlock( &p_sys->p_thread->lock );
 393
 394     vlc_thread_join( p_sys->p_thread );
 395
 396     /* Free data */
 397     aout_filter_RequestVout( p_filter, p_sys->p_thread->p_vout, 0 );
 398     vlc_mutex_destroy( &p_sys->p_thread->lock );
 399     vlc_cond_destroy( &p_sys->p_thread->wait );
 400     vlc_object_detach( p_sys->p_thread );
 401
 402     while( p_sys->p_thread->i_blocks-- )
 403     {
 404         block_Release( p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks] );
 405     }
 406
 407     vlc_object_release( p_sys->p_thread );
 408
 409     free( p_sys );
 410 }
 411
 412 static char *TitleGet( vlc_object_t *p_this )
 413 {
 414     char *psz_title = NULL;
 415     input_thread_t *p_input =
 416         vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
 417
 418     if( p_input )
 419     {
 420         psz_title = input_item_GetTitle( input_GetItem( p_input ) );
 421         if( EMPTY_STR( psz_title ) )
 422         {
 423             free( psz_title );
 424             char *psz_orig = input_item_GetURI( input_GetItem( p_input ) );
 425             char *psz = strrchr( psz_orig, '/' );
 426
 427             if( psz )
 428             {
 429                 psz++;
 430             }
 431             else
 432             {
 433                 psz = psz_orig;
 434             }
 435             if( psz && *psz )
 436             {
 437                 psz_title = strdup( psz );
 438             }
 439             free( psz_orig );
 440         }
 441         vlc_object_release( p_input );
 442     }
 443
 444     return psz_title;
 445 }