goom.c 13.3 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
#ifndef WIN32
39
#include "goom_core.h"
40
#endif
41 42 43 44 45 46 47

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

48 49 50
#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 " \
Gildas Bazin's avatar
Gildas Bazin committed
51 52 53 54 55 56 57
  "goom display (bigger resolution will be prettier but more CPU intensive).")

#define SPEED_TEXT N_("Goom animation speed")
#define SPEED_LONGTEXT N_("Allows you to reduce the speed of the animation " \
  "(default 7, max 10).")

#define MAX_SPEED 10
58

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

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

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

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

    audio_date_t  date;

97 98 99 100 101 102 103 104
} goom_thread_t;

typedef struct aout_filter_sys_t
{
    goom_thread_t *p_thread;

} aout_filter_sys_t;

105 106
static void DoWork   ( aout_instance_t *, aout_filter_t *, aout_buffer_t *,
                       aout_buffer_t * );
107

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

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

    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" );
126
        return VLC_EGENERIC;
127 128 129 130
    }
    if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
    {
        msg_Warn( p_filter, "input and output formats are not similar" );
131
        return VLC_EGENERIC;
132 133 134 135 136 137 138 139 140
    }

    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 */
141 142 143 144 145 146 147 148 149 150 151 152 153 154
    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 )
155 156
    {
        msg_Err( p_filter, "no suitable vout module" );
157 158 159
        vlc_object_detach( p_thread );
        vlc_object_destroy( p_thread );
        free( p_sys );
160 161
        return VLC_EGENERIC;
    }
162 163
    vlc_mutex_init( p_filter, &p_thread->lock );
    vlc_cond_init( p_filter, &p_thread->wait );
164

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

170
    p_thread->psz_title = TitleGet( VLC_OBJECT( p_filter ) );
171

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

186
    return VLC_SUCCESS;
187 188 189
}

/*****************************************************************************
Gildas Bazin's avatar
Gildas Bazin committed
190
 * DoWork: process samples buffer
191
 *****************************************************************************
Gildas Bazin's avatar
Gildas Bazin committed
192 193 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
 * 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
224 225 226 227 228 229 230 231 232 233 234
 *****************************************************************************/
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
235 236 237 238 239 240
/*****************************************************************************
 * 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 )
241
{
Gildas Bazin's avatar
Gildas Bazin committed
242 243
    int i_samples = 0;
    block_t *p_block;
244

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

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

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

Gildas Bazin's avatar
Gildas Bazin committed
261
        aout_DateIncrement( pi_date_end, i_samples );
262

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

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

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

303 304 305
    var_Get( p_this, "goom-width", &width );
    var_Get( p_this, "goom-height", &height );

Gildas Bazin's avatar
Gildas Bazin committed
306 307 308 309 310
    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;

311
    goom_init( width.i_int, height.i_int, 0 );
312 313 314 315 316 317 318 319 320
    goom_set_font( NULL, NULL, NULL );

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

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

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

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

340
        while( !( p_pic = vout_CreatePicture( p_thread->p_vout, 0, 0, 0 ) ) &&
341 342 343 344 345
               !p_thread->b_die )
        {
            msleep( VOUT_OUTMEM_SLEEP );
        }

Gildas Bazin's avatar
Gildas Bazin committed
346
        if( p_pic == NULL ) break;
347

348
        memcpy( p_pic->p[0].p_pixels, plane, width.i_int * height.i_int * 4 );
Gildas Bazin's avatar
Gildas Bazin committed
349 350
        vout_DatePicture( p_thread->p_vout, p_pic,
                          aout_DateGet( &i_pts ) + GOOM_DELAY );
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
        vout_DisplayPicture( p_thread->p_vout, p_pic );
    }

    goom_close();
}

/*****************************************************************************
 * 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 );
378
    vlc_object_detach( p_sys->p_thread );
Gildas Bazin's avatar
Gildas Bazin committed
379 380 381 382 383 384

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

385 386 387 388 389 390 391
    vlc_object_destroy( p_sys->p_thread );

    free( p_sys );
}

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

    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;
}