goom.c 13.4 KB
Newer Older
1 2 3 4
/*****************************************************************************
 * goom.c: based on libgoom (see http://ios.free.fr/?page=projet&quoi=1)
 *****************************************************************************
 * Copyright (C) 2003 VideoLAN
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 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
 *
 * 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
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <stdlib.h>                                      /* malloc(), free() */
#include <string.h>                                              /* strdup() */
#include <errno.h>

#include <vlc/vlc.h>
#include <vlc/input.h>
#include <vlc/aout.h>
#include <vlc/vout.h>
#include "aout_internal.h"

38 39 40 41
#ifdef USE_GOOM_TREE
#   include "goom.h"
#else
#   include <goom/goom.h>
42
#endif
43 44 45 46 47 48 49

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

50 51 52
#define WIDTH_TEXT N_("Goom display width")
#define HEIGHT_TEXT N_("Goom display height")
#define RES_LONGTEXT N_("Allows you to change the resolution of the " \
53
  "Goom display (bigger resolution will be prettier but more CPU intensive).")
Gildas Bazin's avatar
Gildas Bazin committed
54 55 56

#define SPEED_TEXT N_("Goom animation speed")
#define SPEED_LONGTEXT N_("Allows you to reduce the speed of the animation " \
57
  "(default 6, max 10).")
Gildas Bazin's avatar
Gildas Bazin committed
58 59

#define MAX_SPEED 10
60

61
vlc_module_begin();
Gildas Bazin's avatar
Gildas Bazin committed
62
    set_description( _("Goom effect") );
63
    set_capability( "audio filter", 0 );
64 65 66 67
    add_integer( "goom-width", 320, NULL,
                 WIDTH_TEXT, RES_LONGTEXT, VLC_FALSE );
    add_integer( "goom-height", 240, NULL,
                 HEIGHT_TEXT, RES_LONGTEXT, VLC_FALSE );
68
    add_integer( "goom-speed", 6, NULL,
Gildas Bazin's avatar
Gildas Bazin committed
69
                 SPEED_TEXT, SPEED_LONGTEXT, VLC_FALSE );
70 71 72 73 74 75 76
    set_callbacks( Open, Close );
    add_shortcut( "goom" );
vlc_module_end();

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
Gildas Bazin's avatar
Gildas Bazin committed
77 78
#define MAX_BLOCKS 10
#define GOOM_DELAY 400000
79 80 81 82 83 84 85 86 87 88 89

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
90 91 92 93 94 95 96 97 98
    /* Audio properties */
    int i_channels;

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

    audio_date_t  date;

99 100 101 102 103 104 105 106
} goom_thread_t;

typedef struct aout_filter_sys_t
{
    goom_thread_t *p_thread;

} aout_filter_sys_t;

107 108
static void DoWork   ( aout_instance_t *, aout_filter_t *, aout_buffer_t *,
                       aout_buffer_t * );
109

110
static void Thread   ( vlc_object_t * );
111 112 113 114 115 116 117 118 119 120

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;
121 122
    goom_thread_t     *p_thread;
    vlc_value_t       width, height;
123 124 125 126 127

    if ( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' )
         || p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
    {
        msg_Warn( p_filter, "Bad input or output format" );
128
        return VLC_EGENERIC;
129 130 131 132
    }
    if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
    {
        msg_Warn( p_filter, "input and output formats are not similar" );
133
        return VLC_EGENERIC;
134 135 136 137 138 139 140 141 142
    }

    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 */
143 144 145 146 147 148 149 150 151 152 153 154 155 156
    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 );

    p_thread->p_vout =
        vout_Request( p_filter, NULL, width.i_int, height.i_int,
                      VLC_FOURCC('R','V','3','2'),
                      VOUT_ASPECT_FACTOR * width.i_int/height.i_int );
    if( p_thread->p_vout == NULL )
157 158
    {
        msg_Err( p_filter, "no suitable vout module" );
159 160 161
        vlc_object_detach( p_thread );
        vlc_object_destroy( p_thread );
        free( p_sys );
162 163
        return VLC_EGENERIC;
    }
164 165
    vlc_mutex_init( p_filter, &p_thread->lock );
    vlc_cond_init( p_filter, &p_thread->wait );
166

Gildas Bazin's avatar
Gildas Bazin committed
167 168 169 170 171
    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 );

172
    p_thread->psz_title = TitleGet( VLC_OBJECT( p_filter ) );
173

174
    if( vlc_thread_create( p_thread, "Goom Update Thread", Thread,
175 176 177
                           VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
    {
        msg_Err( p_filter, "cannot lauch goom thread" );
178 179 180 181 182 183 184
        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 );
185 186 187
        return VLC_EGENERIC;
    }

188
    return VLC_SUCCESS;
189 190 191
}

/*****************************************************************************
Gildas Bazin's avatar
Gildas Bazin committed
192
 * DoWork: process samples buffer
193
 *****************************************************************************
Gildas Bazin's avatar
Gildas Bazin committed
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
 * 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
226 227 228 229 230 231 232 233 234 235 236
 *****************************************************************************/
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
237 238 239 240 241 242
/*****************************************************************************
 * 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 )
243
{
Gildas Bazin's avatar
Gildas Bazin committed
244 245
    int i_samples = 0;
    block_t *p_block;
246

Gildas Bazin's avatar
Gildas Bazin committed
247
    while( *pi_data < 512 )
248
    {
Gildas Bazin's avatar
Gildas Bazin committed
249
        if( !p_this->i_blocks ) return VLC_EGENERIC;
250

Gildas Bazin's avatar
Gildas Bazin committed
251 252 253
        p_block = p_this->pp_blocks[0];
        i_samples = __MIN( 512 - *pi_data, p_block->i_buffer /
                           sizeof(float) / p_this->i_channels );
254

Gildas Bazin's avatar
Gildas Bazin committed
255 256 257
        /* Date management */
        if( p_block->i_pts > 0 &&
            p_block->i_pts != aout_DateGet( pi_date_end ) )
258
        {
Gildas Bazin's avatar
Gildas Bazin committed
259
           aout_DateSet( pi_date_end, p_block->i_pts );
260
        }
Gildas Bazin's avatar
Gildas Bazin committed
261
        p_block->i_pts = 0;
262

Gildas Bazin's avatar
Gildas Bazin committed
263
        aout_DateIncrement( pi_date_end, i_samples );
264

Gildas Bazin's avatar
Gildas Bazin committed
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
        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 *) );
        }
287 288
    }

Gildas Bazin's avatar
Gildas Bazin committed
289 290 291
    *pi_date = *pi_date_end;
    *pi_data = 0;
    return VLC_SUCCESS;
292
}
Gildas Bazin's avatar
Gildas Bazin committed
293

294 295 296 297 298 299
/*****************************************************************************
 * 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
300 301 302 303
    vlc_value_t width, height, speed;
    audio_date_t i_pts;
    int16_t p_data[2][512];
    int i_data = 0, i_count = 0;
304
    PluginInfo *p_plugin_info;
305

306 307 308
    var_Get( p_this, "goom-width", &width );
    var_Get( p_this, "goom-height", &height );

Gildas Bazin's avatar
Gildas Bazin committed
309 310 311 312 313
    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;

314
    p_plugin_info = goom_init( width.i_int, height.i_int );
315 316 317 318 319 320 321 322

    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
323 324 325
        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 );
326 327
        vlc_mutex_unlock( &p_thread->lock );

Gildas Bazin's avatar
Gildas Bazin committed
328 329 330 331 332 333
        /* 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;

334 335
        plane = goom_update( p_plugin_info, p_data, 0, 0.0,
                             p_thread->psz_title, NULL );
336 337 338 339 340 341

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

343
        while( !( p_pic = vout_CreatePicture( p_thread->p_vout, 0, 0, 0 ) ) &&
344 345 346 347 348
               !p_thread->b_die )
        {
            msleep( VOUT_OUTMEM_SLEEP );
        }

Gildas Bazin's avatar
Gildas Bazin committed
349
        if( p_pic == NULL ) break;
350

351
        memcpy( p_pic->p[0].p_pixels, plane, width.i_int * height.i_int * 4 );
Gildas Bazin's avatar
Gildas Bazin committed
352 353
        vout_DatePicture( p_thread->p_vout, p_pic,
                          aout_DateGet( &i_pts ) + GOOM_DELAY );
354 355 356
        vout_DisplayPicture( p_thread->p_vout, p_pic );
    }

357
    goom_close( p_plugin_info );
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
}

/*****************************************************************************
 * 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 */
    p_sys->p_thread->b_die = VLC_TRUE;

    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 */
    vout_Request( p_filter, p_sys->p_thread->p_vout, 0, 0, 0, 0 );
    vlc_mutex_destroy( &p_sys->p_thread->lock );
    vlc_cond_destroy( &p_sys->p_thread->wait );
381
    vlc_object_detach( p_sys->p_thread );
Gildas Bazin's avatar
Gildas Bazin committed
382 383 384 385 386 387

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

388 389 390 391 392 393 394
    vlc_object_destroy( p_sys->p_thread );

    free( p_sys );
}

static char *TitleGet( vlc_object_t *p_this )
{
395 396 397
    char *psz_title = NULL;
    input_thread_t *p_input =
        vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419

    if( p_input )
    {
        char *psz = strrchr( p_input->psz_source, '/' );

        if( psz )
        {
            psz++;
        }
        else
        {
            psz = p_input->psz_source;
        }
        if( psz && *psz )
        {
            psz_title = strdup( psz );
        }
        vlc_object_release( p_input );
    }

    return psz_title;
}