goom.c 14.1 KB
Newer Older
1 2 3
/*****************************************************************************
 * goom.c: based on libgoom (see http://ios.free.fr/?page=projet&quoi=1)
 *****************************************************************************
4
 * Copyright (C) 2003 the VideoLAN team
5
 * $Id$
6
 *
Gildas Bazin's avatar
Gildas Bazin committed
7 8
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 *          Gildas Bazin <gbazin@videolan.org>
9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 24 25 26 27 28 29 30
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <errno.h>

#include <vlc/vlc.h>
Clément Stenac's avatar
Clément Stenac committed
31 32 33 34
#include <vlc_aout.h>
#include <vlc_vout.h>
#include <vlc_block.h>
#include <vlc_input.h>
35

36
#ifdef USE_GOOM_TREE
37 38 39 40 41 42 43 44 45
#   ifdef OLD_GOOM
#       include "goom_core.h"
#       define PluginInfo void
#       define goom_update(a,b,c,d,e,f) goom_update(b,c,d,e,f)
#       define goom_close(a) goom_close()
#       define goom_init(a,b) NULL; goom_init(a,b,0); goom_set_font(0,0,0)
#   else
#       include "goom.h"
#   endif
46 47
#else
#   include <goom/goom.h>
48
#endif
49 50 51 52 53 54 55

/*****************************************************************************
 * Module descriptor
 *****************************************************************************/
static int  Open         ( vlc_object_t * );
static void Close        ( vlc_object_t * );

56 57
#define WIDTH_TEXT N_("Goom display width")
#define HEIGHT_TEXT N_("Goom display height")
58
#define RES_LONGTEXT N_("This allows you to set the resolution of the " \
59
  "Goom display (bigger resolution will be prettier but more CPU intensive).")
Gildas Bazin's avatar
Gildas Bazin committed
60 61

#define SPEED_TEXT N_("Goom animation speed")
62 63
#define SPEED_LONGTEXT N_("This allows you to set the animation speed " \
  "(between 1 and 10, defaults to 6).")
Gildas Bazin's avatar
Gildas Bazin committed
64 65

#define MAX_SPEED 10
66

67
vlc_module_begin();
68
    set_shortname( _("Goom"));
Gildas Bazin's avatar
Gildas Bazin committed
69
    set_description( _("Goom effect") );
Clément Stenac's avatar
Clément Stenac committed
70 71 72
    set_category( CAT_AUDIO );
    set_subcategory( SUBCAT_AUDIO_VISUAL );
    set_capability( "visualization", 0 );
73 74 75 76
    add_integer( "goom-width", 320, NULL,
                 WIDTH_TEXT, RES_LONGTEXT, VLC_FALSE );
    add_integer( "goom-height", 240, NULL,
                 HEIGHT_TEXT, RES_LONGTEXT, VLC_FALSE );
77
    add_integer( "goom-speed", 6, NULL,
Gildas Bazin's avatar
Gildas Bazin committed
78
                 SPEED_TEXT, SPEED_LONGTEXT, VLC_FALSE );
79 80 81 82 83 84 85
    set_callbacks( Open, Close );
    add_shortcut( "goom" );
vlc_module_end();

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
86
#define MAX_BLOCKS 100
Gildas Bazin's avatar
Gildas Bazin committed
87
#define GOOM_DELAY 400000
88 89 90 91 92 93 94 95 96 97 98

typedef struct
{
    VLC_COMMON_MEMBERS
    vout_thread_t *p_vout;

    char          *psz_title;

    vlc_mutex_t   lock;
    vlc_cond_t    wait;

Gildas Bazin's avatar
Gildas Bazin committed
99 100 101 102 103 104 105 106 107
    /* Audio properties */
    int i_channels;

    /* Audio samples queue */
    block_t       *pp_blocks[MAX_BLOCKS];
    int           i_blocks;

    audio_date_t  date;

108 109 110 111 112 113 114 115
} goom_thread_t;

typedef struct aout_filter_sys_t
{
    goom_thread_t *p_thread;

} aout_filter_sys_t;

116 117
static void DoWork   ( aout_instance_t *, aout_filter_t *, aout_buffer_t *,
                       aout_buffer_t * );
118

119
static void Thread   ( vlc_object_t * );
120 121 122 123 124 125 126 127 128 129

static char *TitleGet( vlc_object_t * );

/*****************************************************************************
 * Open: open a scope effect plugin
 *****************************************************************************/
static int Open( vlc_object_t *p_this )
{
    aout_filter_t     *p_filter = (aout_filter_t *)p_this;
    aout_filter_sys_t *p_sys;
130 131
    goom_thread_t     *p_thread;
    vlc_value_t       width, height;
132 133
    video_format_t    fmt;

134 135 136 137

    if ( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' )
         || p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
    {
Christophe Mutricy's avatar
Christophe Mutricy committed
138
        msg_Warn( p_filter, "bad input or output format" );
139
        return VLC_EGENERIC;
140 141 142 143
    }
    if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
    {
        msg_Warn( p_filter, "input and output formats are not similar" );
144
        return VLC_EGENERIC;
145 146 147 148 149 150 151 152 153
    }

    p_filter->pf_do_work = DoWork;
    p_filter->b_in_place = 1;

    /* Allocate structure */
    p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );

    /* Create goom thread */
154 155 156 157 158 159 160 161 162
    p_sys->p_thread = p_thread =
        vlc_object_create( p_filter, sizeof( goom_thread_t ) );
    vlc_object_attach( p_thread, p_this );

    var_Create( p_thread, "goom-width", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
    var_Get( p_thread, "goom-width", &width );
    var_Create( p_thread, "goom-height", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
    var_Get( p_thread, "goom-height", &height );

163 164
    memset( &fmt, 0, sizeof(video_format_t) );

165 166 167 168 169 170 171
    fmt.i_width = fmt.i_visible_width = width.i_int;
    fmt.i_height = fmt.i_visible_height = height.i_int;
    fmt.i_chroma = VLC_FOURCC('R','V','3','2');
    fmt.i_aspect = VOUT_ASPECT_FACTOR * width.i_int/height.i_int;
    fmt.i_sar_num = fmt.i_sar_den = 1;

    p_thread->p_vout = vout_Request( p_filter, NULL, &fmt );
172
    if( p_thread->p_vout == NULL )
173 174
    {
        msg_Err( p_filter, "no suitable vout module" );
175 176 177
        vlc_object_detach( p_thread );
        vlc_object_destroy( p_thread );
        free( p_sys );
178 179
        return VLC_EGENERIC;
    }
180 181
    vlc_mutex_init( p_filter, &p_thread->lock );
    vlc_cond_init( p_filter, &p_thread->wait );
182

Gildas Bazin's avatar
Gildas Bazin committed
183 184 185 186 187
    p_thread->i_blocks = 0;
    aout_DateInit( &p_thread->date, p_filter->output.i_rate );
    aout_DateSet( &p_thread->date, 0 );
    p_thread->i_channels = aout_FormatNbChannels( &p_filter->input );

188
    p_thread->psz_title = TitleGet( VLC_OBJECT( p_filter ) );
189

190
    if( vlc_thread_create( p_thread, "Goom Update Thread", Thread,
191 192 193
                           VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
    {
        msg_Err( p_filter, "cannot lauch goom thread" );
194 195 196 197 198 199 200
        vout_Destroy( p_thread->p_vout );
        vlc_mutex_destroy( &p_thread->lock );
        vlc_cond_destroy( &p_thread->wait );
        if( p_thread->psz_title ) free( p_thread->psz_title );
        vlc_object_detach( p_thread );
        vlc_object_destroy( p_thread );
        free( p_sys );
201 202 203
        return VLC_EGENERIC;
    }

204
    return VLC_SUCCESS;
205 206 207
}

/*****************************************************************************
Gildas Bazin's avatar
Gildas Bazin committed
208
 * DoWork: process samples buffer
209
 *****************************************************************************
Gildas Bazin's avatar
Gildas Bazin committed
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
 * This function queues the audio buffer to be processed by the goom thread
 *****************************************************************************/
static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
                    aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
{
    aout_filter_sys_t *p_sys = p_filter->p_sys;
    block_t *p_block;

    p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
    p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;

    /* Queue sample */
    vlc_mutex_lock( &p_sys->p_thread->lock );
    if( p_sys->p_thread->i_blocks == MAX_BLOCKS )
    {
        vlc_mutex_unlock( &p_sys->p_thread->lock );
        return;
    }

    p_block = block_New( p_sys->p_thread, p_in_buf->i_nb_bytes );
    if( !p_block ) return;
    memcpy( p_block->p_buffer, p_in_buf->p_buffer, p_in_buf->i_nb_bytes );
    p_block->i_pts = p_in_buf->start_date;

    p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks++] = p_block;

    vlc_cond_signal( &p_sys->p_thread->wait );
    vlc_mutex_unlock( &p_sys->p_thread->lock );
}

/*****************************************************************************
 * float to s16 conversion
242 243 244 245 246 247 248 249 250 251 252
 *****************************************************************************/
static inline int16_t FloatToInt16( float f )
{
    if( f >= 1.0 )
        return 32767;
    else if( f < -1.0 )
        return -32768;
    else
        return (int16_t)( f * 32768.0 );
}

Gildas Bazin's avatar
Gildas Bazin committed
253 254 255 256 257 258
/*****************************************************************************
 * Fill buffer
 *****************************************************************************/
static int FillBuffer( int16_t *p_data, int *pi_data,
                       audio_date_t *pi_date, audio_date_t *pi_date_end,
                       goom_thread_t *p_this )
259
{
Gildas Bazin's avatar
Gildas Bazin committed
260 261
    int i_samples = 0;
    block_t *p_block;
262

Gildas Bazin's avatar
Gildas Bazin committed
263
    while( *pi_data < 512 )
264
    {
Gildas Bazin's avatar
Gildas Bazin committed
265
        if( !p_this->i_blocks ) return VLC_EGENERIC;
266

Gildas Bazin's avatar
Gildas Bazin committed
267 268 269
        p_block = p_this->pp_blocks[0];
        i_samples = __MIN( 512 - *pi_data, p_block->i_buffer /
                           sizeof(float) / p_this->i_channels );
270

Gildas Bazin's avatar
Gildas Bazin committed
271 272 273
        /* Date management */
        if( p_block->i_pts > 0 &&
            p_block->i_pts != aout_DateGet( pi_date_end ) )
274
        {
Gildas Bazin's avatar
Gildas Bazin committed
275
           aout_DateSet( pi_date_end, p_block->i_pts );
276
        }
Gildas Bazin's avatar
Gildas Bazin committed
277
        p_block->i_pts = 0;
278

Gildas Bazin's avatar
Gildas Bazin committed
279
        aout_DateIncrement( pi_date_end, i_samples );
280

Gildas Bazin's avatar
Gildas Bazin committed
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
        while( i_samples > 0 )
        {
            float *p_float = (float *)p_block->p_buffer;

            p_data[*pi_data] = FloatToInt16( p_float[0] );
            if( p_this->i_channels > 1 )
                p_data[512 + *pi_data] = FloatToInt16( p_float[1] );

            (*pi_data)++;
            p_block->p_buffer += (sizeof(float) * p_this->i_channels);
            p_block->i_buffer -= (sizeof(float) * p_this->i_channels);
            i_samples--;
        }

        if( !p_block->i_buffer )
        {
            block_Release( p_block );
            p_this->i_blocks--;
            if( p_this->i_blocks )
                memmove( p_this->pp_blocks, p_this->pp_blocks + 1,
                         p_this->i_blocks * sizeof(block_t *) );
        }
303 304
    }

Gildas Bazin's avatar
Gildas Bazin committed
305 306 307
    *pi_date = *pi_date_end;
    *pi_data = 0;
    return VLC_SUCCESS;
308
}
Gildas Bazin's avatar
Gildas Bazin committed
309

310 311 312 313 314 315
/*****************************************************************************
 * Thread:
 *****************************************************************************/
static void Thread( vlc_object_t *p_this )
{
    goom_thread_t *p_thread = (goom_thread_t*)p_this;
Gildas Bazin's avatar
Gildas Bazin committed
316 317 318 319
    vlc_value_t width, height, speed;
    audio_date_t i_pts;
    int16_t p_data[2][512];
    int i_data = 0, i_count = 0;
320
    PluginInfo *p_plugin_info;
321

322 323 324
    var_Get( p_this, "goom-width", &width );
    var_Get( p_this, "goom-height", &height );

Gildas Bazin's avatar
Gildas Bazin committed
325 326 327 328 329
    var_Create( p_thread, "goom-speed", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
    var_Get( p_thread, "goom-speed", &speed );
    speed.i_int = MAX_SPEED - speed.i_int;
    if( speed.i_int < 0 ) speed.i_int = 0;

330
    p_plugin_info = goom_init( width.i_int, height.i_int );
331 332 333 334 335 336 337 338

    while( !p_thread->b_die )
    {
        uint32_t  *plane;
        picture_t *p_pic;

        /* goom_update is damn slow, so just copy data and release the lock */
        vlc_mutex_lock( &p_thread->lock );
Gildas Bazin's avatar
Gildas Bazin committed
339 340 341
        if( FillBuffer( (int16_t *)p_data, &i_data, &i_pts,
                        &p_thread->date, p_thread ) != VLC_SUCCESS )
            vlc_cond_wait( &p_thread->wait, &p_thread->lock );
342 343
        vlc_mutex_unlock( &p_thread->lock );

Gildas Bazin's avatar
Gildas Bazin committed
344 345 346 347 348 349
        /* Speed selection */
        if( speed.i_int && (++i_count % (speed.i_int+1)) ) continue;

        /* Frame dropping if necessary */
        if( aout_DateGet( &i_pts ) + GOOM_DELAY <= mdate() ) continue;

350 351
        plane = goom_update( p_plugin_info, p_data, 0, 0.0,
                             p_thread->psz_title, NULL );
352 353 354 355 356 357

        if( p_thread->psz_title )
        {
            free( p_thread->psz_title );
            p_thread->psz_title = NULL;
        }
Gildas Bazin's avatar
Gildas Bazin committed
358

359
        while( !( p_pic = vout_CreatePicture( p_thread->p_vout, 0, 0, 0 ) ) &&
360 361 362 363 364
               !p_thread->b_die )
        {
            msleep( VOUT_OUTMEM_SLEEP );
        }

Gildas Bazin's avatar
Gildas Bazin committed
365
        if( p_pic == NULL ) break;
366

367
        memcpy( p_pic->p[0].p_pixels, plane, width.i_int * height.i_int * 4 );
Gildas Bazin's avatar
Gildas Bazin committed
368 369
        vout_DatePicture( p_thread->p_vout, p_pic,
                          aout_DateGet( &i_pts ) + GOOM_DELAY );
370 371 372
        vout_DisplayPicture( p_thread->p_vout, p_pic );
    }

373
    goom_close( p_plugin_info );
374 375 376 377 378 379 380 381 382 383 384
}

/*****************************************************************************
 * Close: close the plugin
 *****************************************************************************/
static void Close( vlc_object_t *p_this )
{
    aout_filter_t     *p_filter = (aout_filter_t *)p_this;
    aout_filter_sys_t *p_sys = p_filter->p_sys;

    /* Stop Goom Thread */
385
    vlc_object_kill( p_sys->p_thread );
386 387 388 389 390 391 392 393

    vlc_mutex_lock( &p_sys->p_thread->lock );
    vlc_cond_signal( &p_sys->p_thread->wait );
    vlc_mutex_unlock( &p_sys->p_thread->lock );

    vlc_thread_join( p_sys->p_thread );

    /* Free data */
394
    vout_Request( p_filter, p_sys->p_thread->p_vout, 0 );
395 396
    vlc_mutex_destroy( &p_sys->p_thread->lock );
    vlc_cond_destroy( &p_sys->p_thread->wait );
397
    vlc_object_detach( p_sys->p_thread );
Gildas Bazin's avatar
Gildas Bazin committed
398 399 400 401 402 403

    while( p_sys->p_thread->i_blocks-- )
    {
        block_Release( p_sys->p_thread->pp_blocks[p_sys->p_thread->i_blocks] );
    }

404 405 406 407 408 409 410
    vlc_object_destroy( p_sys->p_thread );

    free( p_sys );
}

static char *TitleGet( vlc_object_t *p_this )
{
411 412 413
    char *psz_title = NULL;
    input_thread_t *p_input =
        vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
414 415 416

    if( p_input )
    {
417
        psz_title = input_item_GetTitle( input_GetItem( p_input ) );
Rafaël Carré's avatar
Rafaël Carré committed
418
        if( EMPTY_STR( psz_title ) )
419
        {
Rafaël Carré's avatar
Rafaël Carré committed
420
            free( psz_title );
421 422
            char *psz_orig = input_item_GetURI( input_GetItem( p_input ) );
            char *psz = strrchr( psz_orig, '/' );
423 424 425 426 427 428 429

            if( psz )
            {
                psz++;
            }
            else
            {
430
                psz = psz_orig;
431 432 433 434 435
            }
            if( psz && *psz )
            {
                psz_title = strdup( psz );
            }
436
            free( psz_orig );
437 438 439 440 441 442
        }
        vlc_object_release( p_input );
    }

    return psz_title;
}