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 VideoLAN
   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., 59 Temple Place - Suite 330, Boston, MA  02111, 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/input.h>
  34 #include <vlc/aout.h>
  35 #include <vlc/vout.h>
  36 #include "aout_internal.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_("Allows you to change 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_("Allows you to reduce the speed of the animation " \
  65   "(default 6, max 10).")
  66
  67 #define MAX_SPEED 10
  68
  69 vlc_module_begin();
  70     set_description( _("Goom effect") );
  71     set_category( CAT_AUDIO );
  72     set_subcategory( SUBCAT_AUDIO_VISUAL );
  73     set_capability( "visualization", 0 );
  74     add_integer( "goom-width", 320, NULL,
  75                  WIDTH_TEXT, RES_LONGTEXT, VLC_FALSE );
  76     add_integer( "goom-height", 240, NULL,
  77                  HEIGHT_TEXT, RES_LONGTEXT, VLC_FALSE );
  78     add_integer( "goom-speed", 6, NULL,
  79                  SPEED_TEXT, SPEED_LONGTEXT, VLC_FALSE );
  80     set_callbacks( Open, Close );
  81     add_shortcut( "goom" );
  82 vlc_module_end();
  83
  84 /*****************************************************************************
  85  * Local prototypes
  86  *****************************************************************************/
  87 #define MAX_BLOCKS 100
  88 #define GOOM_DELAY 400000
  89
  90 typedef struct
  91 {
  92     VLC_COMMON_MEMBERS
  93     vout_thread_t *p_vout;
  94
  95     char          *psz_title;
  96
  97     vlc_mutex_t   lock;
  98     vlc_cond_t    wait;
  99
 100     /* Audio properties */
 101     int i_channels;
 102
 103     /* Audio samples queue */
 104     block_t       *pp_blocks[MAX_BLOCKS];
 105     int           i_blocks;
 106
 107     audio_date_t  date;
 108
 109 } goom_thread_t;
 110
 111 typedef struct aout_filter_sys_t
 112 {
 113     goom_thread_t *p_thread;
 114
 115 } aout_filter_sys_t;
 116
 117 static void DoWork   ( aout_instance_t *, aout_filter_t *, aout_buffer_t *,
 118                        aout_buffer_t * );
 119
 120 static void Thread   ( vlc_object_t * );
 121
 122 static char *TitleGet( vlc_object_t * );
 123
 124 /*****************************************************************************
 125  * Open: open a scope effect plugin
 126  *****************************************************************************/
 127 static int Open( vlc_object_t *p_this )
 128 {
 129     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
 130     aout_filter_sys_t *p_sys;
 131     goom_thread_t     *p_thread;
 132     vlc_value_t       width, height;
 133
 134     if ( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' )
 135          || p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
 136     {
 137         msg_Warn( p_filter, "Bad input or output format" );
 138         return VLC_EGENERIC;
 139     }
 140     if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
 141     {
 142         msg_Warn( p_filter, "input and output formats are not similar" );
 143         return VLC_EGENERIC;
 144     }
 145
 146     p_filter->pf_do_work = DoWork;
 147     p_filter->b_in_place = 1;
 148
 149     /* Allocate structure */
 150     p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
 151
 152     /* Create goom thread */
 153     p_sys->p_thread = p_thread =
 154         vlc_object_create( p_filter, sizeof( goom_thread_t ) );
 155     vlc_object_attach( p_thread, p_this );
 156
 157     var_Create( p_thread, "goom-width", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 158     var_Get( p_thread, "goom-width", &width );
 159     var_Create( p_thread, "goom-height", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 160     var_Get( p_thread, "goom-height", &height );
 161
 162     p_thread->p_vout =
 163         vout_Request( p_filter, NULL, width.i_int, height.i_int,
 164                       VLC_FOURCC('R','V','3','2'),
 165                       VOUT_ASPECT_FACTOR * width.i_int/height.i_int );
 166     if( p_thread->p_vout == NULL )
 167     {
 168         msg_Err( p_filter, "no suitable vout module" );
 169         vlc_object_detach( p_thread );
 170         vlc_object_destroy( p_thread );
 171         free( p_sys );
 172         return VLC_EGENERIC;
 173     }
 174     vlc_mutex_init( p_filter, &p_thread->lock );
 175     vlc_cond_init( p_filter, &p_thread->wait );
 176
 177     p_thread->i_blocks = 0;
 178     aout_DateInit( &p_thread->date, p_filter->output.i_rate );
 179     aout_DateSet( &p_thread->date, 0 );
 180     p_thread->i_channels = aout_FormatNbChannels( &p_filter->input );
 181
 182     p_thread->psz_title = TitleGet( VLC_OBJECT( p_filter ) );
 183
 184     if( vlc_thread_create( p_thread, "Goom Update Thread", Thread,
 185                            VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
 186     {
 187         msg_Err( p_filter, "cannot lauch goom thread" );
 188         vout_Destroy( p_thread->p_vout );
 189         vlc_mutex_destroy( &p_thread->lock );
 190         vlc_cond_destroy( &p_thread->wait );
 191         if( p_thread->psz_title ) free( p_thread->psz_title );
 192         vlc_object_detach( p_thread );
 193         vlc_object_destroy( p_thread );
 194         free( p_sys );
 195         return VLC_EGENERIC;
 196     }
 197
 198     return VLC_SUCCESS;
 199 }
 200
 201 /*****************************************************************************
 202  * DoWork: process samples buffer
 203  *****************************************************************************
 204  * This function queues the audio buffer to be processed by the goom thread
 205  *****************************************************************************/
 206 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
 207                     aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
 208 {
 209     aout_filter_sys_t *p_sys = p_filter->p_sys;
 210     block_t *p_block;
 211
 212     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
 213     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
 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;
 221     }
 222
 223     p_block = block_New( p_sys->p_thread, p_in_buf->i_nb_bytes );
 224     if( !p_block ) return;
 225     memcpy( p_block->p_buffer, p_in_buf->p_buffer, p_in_buf->i_nb_bytes );
 226     p_block->i_pts = p_in_buf->start_date;
 227
 228     p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks++] = p_block;
 229
 230     vlc_cond_signal( &p_sys->p_thread->wait );
 231     vlc_mutex_unlock( &p_sys->p_thread->lock );
 232 }
 233
 234 /*****************************************************************************
 235  * float to s16 conversion
 236  *****************************************************************************/
 237 static inline int16_t FloatToInt16( float f )
 238 {
 239     if( f >= 1.0 )
 240         return 32767;
 241     else if( f < -1.0 )
 242         return -32768;
 243     else
 244         return (int16_t)( f * 32768.0 );
 245 }
 246
 247 /*****************************************************************************
 248  * Fill buffer
 249  *****************************************************************************/
 250 static int FillBuffer( int16_t *p_data, int *pi_data,
 251                        audio_date_t *pi_date, audio_date_t *pi_date_end,
 252                        goom_thread_t *p_this )
 253 {
 254     int i_samples = 0;
 255     block_t *p_block;
 256
 257     while( *pi_data < 512 )
 258     {
 259         if( !p_this->i_blocks ) return VLC_EGENERIC;
 260
 261         p_block = p_this->pp_blocks[0];
 262         i_samples = __MIN( 512 - *pi_data, p_block->i_buffer /
 263                            sizeof(float) / p_this->i_channels );
 264
 265         /* Date management */
 266         if( p_block->i_pts > 0 &&
 267             p_block->i_pts != aout_DateGet( pi_date_end ) )
 268         {
 269            aout_DateSet( pi_date_end, p_block->i_pts );
 270         }
 271         p_block->i_pts = 0;
 272
 273         aout_DateIncrement( pi_date_end, i_samples );
 274
 275         while( i_samples > 0 )
 276         {
 277             float *p_float = (float *)p_block->p_buffer;
 278
 279             p_data[*pi_data] = FloatToInt16( p_float[0] );
 280             if( p_this->i_channels > 1 )
 281                 p_data[512 + *pi_data] = FloatToInt16( p_float[1] );
 282
 283             (*pi_data)++;
 284             p_block->p_buffer += (sizeof(float) * p_this->i_channels);
 285             p_block->i_buffer -= (sizeof(float) * p_this->i_channels);
 286             i_samples--;
 287         }
 288
 289         if( !p_block->i_buffer )
 290         {
 291             block_Release( p_block );
 292             p_this->i_blocks--;
 293             if( p_this->i_blocks )
 294                 memmove( p_this->pp_blocks, p_this->pp_blocks + 1,
 295                          p_this->i_blocks * sizeof(block_t *) );
 296         }
 297     }
 298
 299     *pi_date = *pi_date_end;
 300     *pi_data = 0;
 301     return VLC_SUCCESS;
 302 }
 303
 304 /*****************************************************************************
 305  * Thread:
 306  *****************************************************************************/
 307 static void Thread( vlc_object_t *p_this )
 308 {
 309     goom_thread_t *p_thread = (goom_thread_t*)p_this;
 310     vlc_value_t width, height, speed;
 311     audio_date_t i_pts;
 312     int16_t p_data[2][512];
 313     int i_data = 0, i_count = 0;
 314     PluginInfo *p_plugin_info;
 315
 316     var_Get( p_this, "goom-width", &width );
 317     var_Get( p_this, "goom-height", &height );
 318
 319     var_Create( p_thread, "goom-speed", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 320     var_Get( p_thread, "goom-speed", &speed );
 321     speed.i_int = MAX_SPEED - speed.i_int;
 322     if( speed.i_int < 0 ) speed.i_int = 0;
 323
 324     p_plugin_info = goom_init( width.i_int, height.i_int );
 325
 326     while( !p_thread->b_die )
 327     {
 328         uint32_t  *plane;
 329         picture_t *p_pic;
 330
 331         /* goom_update is damn slow, so just copy data and release the lock */
 332         vlc_mutex_lock( &p_thread->lock );
 333         if( FillBuffer( (int16_t *)p_data, &i_data, &i_pts,
 334                         &p_thread->date, p_thread ) != VLC_SUCCESS )
 335             vlc_cond_wait( &p_thread->wait, &p_thread->lock );
 336         vlc_mutex_unlock( &p_thread->lock );
 337
 338         /* Speed selection */
 339         if( speed.i_int && (++i_count % (speed.i_int+1)) ) continue;
 340
 341         /* Frame dropping if necessary */
 342         if( aout_DateGet( &i_pts ) + GOOM_DELAY <= mdate() ) continue;
 343
 344         plane = goom_update( p_plugin_info, p_data, 0, 0.0,
 345                              p_thread->psz_title, NULL );
 346
 347         if( p_thread->psz_title )
 348         {
 349             free( p_thread->psz_title );
 350             p_thread->psz_title = NULL;
 351         }
 352
 353         while( !( p_pic = vout_CreatePicture( p_thread->p_vout, 0, 0, 0 ) ) &&
 354                !p_thread->b_die )
 355         {
 356             msleep( VOUT_OUTMEM_SLEEP );
 357         }
 358
 359         if( p_pic == NULL ) break;
 360
 361         memcpy( p_pic->p[0].p_pixels, plane, width.i_int * height.i_int * 4 );
 362         vout_DatePicture( p_thread->p_vout, p_pic,
 363                           aout_DateGet( &i_pts ) + GOOM_DELAY );
 364         vout_DisplayPicture( p_thread->p_vout, p_pic );
 365     }
 366
 367     goom_close( p_plugin_info );
 368 }
 369
 370 /*****************************************************************************
 371  * Close: close the plugin
 372  *****************************************************************************/
 373 static void Close( vlc_object_t *p_this )
 374 {
 375     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
 376     aout_filter_sys_t *p_sys = p_filter->p_sys;
 377
 378     /* Stop Goom Thread */
 379     p_sys->p_thread->b_die = VLC_TRUE;
 380
 381     vlc_mutex_lock( &p_sys->p_thread->lock );
 382     vlc_cond_signal( &p_sys->p_thread->wait );
 383     vlc_mutex_unlock( &p_sys->p_thread->lock );
 384
 385     vlc_thread_join( p_sys->p_thread );
 386
 387     /* Free data */
 388     vout_Request( p_filter, p_sys->p_thread->p_vout, 0, 0, 0, 0 );
 389     vlc_mutex_destroy( &p_sys->p_thread->lock );
 390     vlc_cond_destroy( &p_sys->p_thread->wait );
 391     vlc_object_detach( p_sys->p_thread );
 392
 393     while( p_sys->p_thread->i_blocks-- )
 394     {
 395         block_Release( p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks] );
 396     }
 397
 398     vlc_object_destroy( p_sys->p_thread );
 399
 400     free( p_sys );
 401 }
 402
 403 static char *TitleGet( vlc_object_t *p_this )
 404 {
 405     char *psz_title = NULL;
 406     input_thread_t *p_input =
 407         vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
 408
 409     if( p_input )
 410     {
 411         char *psz = strrchr( p_input->input.p_item->psz_uri, '/' );
 412
 413         if( psz )
 414         {
 415             psz++;
 416         }
 417         else
 418         {
 419             psz = p_input->input.p_item->psz_uri;
 420         }
 421         if( psz && *psz )
 422         {
 423             psz_title = strdup( psz );
 424         }
 425         vlc_object_release( p_input );
 426     }
 427
 428     return psz_title;
 429 }