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