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 #include <vlc_playlist.h>
  40
  41 #ifdef USE_GOOM_TREE
  42 #   ifdef OLD_GOOM
  43 #       include "goom_core.h"
  44 #       define PluginInfo void
  45 #       define goom_update(a,b,c,d,e,f) goom_update(b,c,d,e,f)
  46 #       define goom_close(a) goom_close()
  47 #       define goom_init(a,b) NULL; goom_init(a,b,0); goom_set_font(0,0,0)
  48 #   else
  49 #       include "goom.h"
  50 #   endif
  51 #else
  52 #   include <goom/goom.h>
  53 #endif
  54
  55 /*****************************************************************************
  56  * Module descriptor
  57  *****************************************************************************/
  58 static int  Open         ( vlc_object_t * );
  59 static void Close        ( vlc_object_t * );
  60
  61 #define WIDTH_TEXT N_("Goom display width")
  62 #define HEIGHT_TEXT N_("Goom display height")
  63 #define RES_LONGTEXT N_("This allows you to set the resolution of the " \
  64   "Goom display (bigger resolution will be prettier but more CPU intensive).")
  65
  66 #define SPEED_TEXT N_("Goom animation speed")
  67 #define SPEED_LONGTEXT N_("This allows you to set the animation speed " \
  68   "(between 1 and 10, defaults to 6).")
  69
  70 #define MAX_SPEED 10
  71
  72 vlc_module_begin ()
  73     set_shortname( N_("Goom"))
  74     set_description( N_("Goom effect") )
  75     set_category( CAT_AUDIO )
  76     set_subcategory( SUBCAT_AUDIO_VISUAL )
  77     set_capability( "visualization2", 0 )
  78     add_integer( "goom-width", 800, NULL,
  79                  WIDTH_TEXT, RES_LONGTEXT, false )
  80     add_integer( "goom-height", 640, NULL,
  81                  HEIGHT_TEXT, RES_LONGTEXT, false )
  82     add_integer( "goom-speed", 6, NULL,
  83                  SPEED_TEXT, SPEED_LONGTEXT, false )
  84     set_callbacks( Open, Close )
  85     add_shortcut( "goom" )
  86 vlc_module_end ()
  87
  88 /*****************************************************************************
  89  * Local prototypes
  90  *****************************************************************************/
  91 #define MAX_BLOCKS 100
  92 #define GOOM_DELAY 400000
  93
  94 typedef struct
  95 {
  96     VLC_COMMON_MEMBERS
  97     vout_thread_t *p_vout;
  98
  99     char          *psz_title;
 100
 101     vlc_mutex_t   lock;
 102     vlc_cond_t    wait;
 103
 104     /* Audio properties */
 105     unsigned i_channels;
 106
 107     /* Audio samples queue */
 108     block_t       *pp_blocks[MAX_BLOCKS];
 109     int           i_blocks;
 110
 111     date_t        date;
 112
 113 } goom_thread_t;
 114
 115 struct filter_sys_t
 116 {
 117     goom_thread_t *p_thread;
 118
 119 };
 120
 121 static block_t *DoWork ( filter_t *, block_t * );
 122
 123 static void* Thread   ( vlc_object_t * );
 124
 125 static char *TitleGet( vlc_object_t * );
 126
 127 /*****************************************************************************
 128  * Open: open a scope effect plugin
 129  *****************************************************************************/
 130 static int Open( vlc_object_t *p_this )
 131 {
 132     filter_t       *p_filter = (filter_t *)p_this;
 133     filter_sys_t   *p_sys;
 134     goom_thread_t  *p_thread;
 135     int             width, height;
 136     video_format_t fmt;
 137
 138
 139     if( p_filter->fmt_in.audio.i_format != VLC_CODEC_FL32 ||
 140          p_filter->fmt_out.audio.i_format != VLC_CODEC_FL32 )
 141     {
 142         msg_Warn( p_filter, "bad input or output format" );
 143         return VLC_EGENERIC;
 144     }
 145     if( !AOUT_FMTS_SIMILAR( &p_filter->fmt_in.audio, &p_filter->fmt_out.audio ) )
 146     {
 147         msg_Warn( p_filter, "input and output formats are not similar" );
 148         return VLC_EGENERIC;
 149     }
 150
 151     p_filter->pf_audio_filter = DoWork;
 152
 153     /* Allocate structure */
 154     p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
 155
 156     /* Create goom thread */
 157     p_sys->p_thread = p_thread =
 158         vlc_object_create( p_filter, sizeof( goom_thread_t ) );
 159     vlc_object_attach( p_thread, p_this );
 160
 161     width = var_CreateGetInteger( p_thread, "goom-width" );
 162     height = var_CreateGetInteger( p_thread, "goom-height" );
 163
 164     memset( &fmt, 0, sizeof(video_format_t) );
 165
 166     fmt.i_width = fmt.i_visible_width = width;
 167     fmt.i_height = fmt.i_visible_height = height;
 168     fmt.i_chroma = VLC_CODEC_RGB32;
 169     fmt.i_sar_num = fmt.i_sar_den = 1;
 170
 171     p_thread->p_vout = aout_filter_RequestVout( p_filter, NULL, &fmt );
 172     if( p_thread->p_vout == NULL )
 173     {
 174         msg_Err( p_filter, "no suitable vout module" );
 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_release( p_thread );
 198         free( p_sys );
 199         return VLC_EGENERIC;
 200     }
 201
 202     return VLC_SUCCESS;
 203 }
 204
 205 /*****************************************************************************
 206  * DoWork: process samples buffer
 207  *****************************************************************************
 208  * This function queues the audio buffer to be processed by the goom thread
 209  *****************************************************************************/
 210 static block_t *DoWork( filter_t *p_filter, block_t *p_in_buf )
 211 {
 212     filter_sys_t *p_sys = p_filter->p_sys;
 213     block_t *p_block;
 214
 215     /* Queue sample */
 216     vlc_mutex_lock( &p_sys->p_thread->lock );
 217     if( p_sys->p_thread->i_blocks == MAX_BLOCKS )
 218     {
 219         vlc_mutex_unlock( &p_sys->p_thread->lock );
 220         return p_in_buf;
 221     }
 222
 223     p_block = block_New( p_sys->p_thread, p_in_buf->i_buffer );
 224     if( !p_block )
 225     {
 226         vlc_mutex_unlock( &p_sys->p_thread->lock );
 227         return p_in_buf;
 228     }
 229     memcpy( p_block->p_buffer, p_in_buf->p_buffer, p_in_buf->i_buffer );
 230     p_block->i_pts = p_in_buf->i_pts;
 231
 232     p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks++] = p_block;
 233
 234     vlc_cond_signal( &p_sys->p_thread->wait );
 235     vlc_mutex_unlock( &p_sys->p_thread->lock );
 236
 237     return p_in_buf;
 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                        date_t *pi_date, 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( (unsigned)(512 - *pi_data),
 269                 p_block->i_buffer / sizeof(float) / p_this->i_channels );
 270
 271         /* Date management */
 272         if( p_block->i_pts > VLC_TS_INVALID &&
 273             p_block->i_pts != date_Get( pi_date_end ) )
 274         {
 275            date_Set( pi_date_end, p_block->i_pts );
 276         }
 277         p_block->i_pts = VLC_TS_INVALID;
 278
 279         date_Increment( 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     int width, height, speed;
 317     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     int canc = vlc_savecancel ();
 322
 323     width = var_GetInteger( p_this, "goom-width" );
 324     height = var_GetInteger( p_this, "goom-height" );
 325
 326     speed = var_CreateGetInteger( p_thread, "goom-speed" );
 327     speed = MAX_SPEED - speed;
 328     if( speed < 0 ) speed = 0;
 329
 330     p_plugin_info = goom_init( width, height );
 331
 332     while( vlc_object_alive (p_thread) )
 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_count % (speed+1)) ) continue;
 346
 347         /* Frame dropping if necessary */
 348         if( date_Get( &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         free( p_thread->psz_title );
 354         p_thread->psz_title = NULL;
 355
 356         while( !( p_pic = vout_GetPicture( p_thread->p_vout ) ) &&
 357                vlc_object_alive (p_thread) )
 358         {
 359             msleep( VOUT_OUTMEM_SLEEP );
 360         }
 361
 362         if( p_pic == NULL ) break;
 363
 364         memcpy( p_pic->p[0].p_pixels, plane, width * height * 4 );
 365
 366         p_pic->date = date_Get( &i_pts ) + GOOM_DELAY;
 367         vout_PutPicture( p_thread->p_vout, p_pic );
 368     }
 369
 370     goom_close( p_plugin_info );
 371     vlc_restorecancel (canc);
 372     return NULL;
 373 }
 374
 375 /*****************************************************************************
 376  * Close: close the plugin
 377  *****************************************************************************/
 378 static void Close( vlc_object_t *p_this )
 379 {
 380     filter_t     *p_filter = (filter_t *)p_this;
 381     filter_sys_t *p_sys = p_filter->p_sys;
 382
 383     /* Stop Goom Thread */
 384     vlc_object_kill( p_sys->p_thread );
 385
 386     vlc_mutex_lock( &p_sys->p_thread->lock );
 387     vlc_cond_signal( &p_sys->p_thread->wait );
 388     vlc_mutex_unlock( &p_sys->p_thread->lock );
 389
 390     vlc_thread_join( p_sys->p_thread );
 391
 392     /* Free data */
 393     aout_filter_RequestVout( p_filter, p_sys->p_thread->p_vout, 0 );
 394     vlc_mutex_destroy( &p_sys->p_thread->lock );
 395     vlc_cond_destroy( &p_sys->p_thread->wait );
 396
 397     while( p_sys->p_thread->i_blocks-- )
 398     {
 399         block_Release( p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks] );
 400     }
 401
 402     vlc_object_release( p_sys->p_thread );
 403
 404     free( p_sys );
 405 }
 406
 407 static char *TitleGet( vlc_object_t *p_this )
 408 {
 409     input_thread_t *p_input = playlist_CurrentInput( pl_Get( p_this ) );
 410     if( !p_input )
 411         return NULL;
 412
 413     char *psz_title = input_item_GetTitle( input_GetItem( p_input ) );
 414     if( EMPTY_STR( psz_title ) )
 415     {
 416         free( psz_title );
 417
 418         char *psz_uri = input_item_GetURI( input_GetItem( p_input ) );
 419         const char *psz = strrchr( psz_uri, '/' );
 420         if( psz )
 421         {
 422             psz_title = strdup( psz + 1 );
 423             free( psz_uri );
 424         }
 425         else
 426             psz_title = psz_uri;
 427     }
 428     vlc_object_release( p_input );
 429     return psz_title;
 430 }