goom.c 14 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
 *****************************************************************************/

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

30 31 32 33
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

34
#include <vlc/vlc.h>
Clément Stenac's avatar
Clément Stenac committed
35 36 37 38
#include <vlc_aout.h>
#include <vlc_vout.h>
#include <vlc_block.h>
#include <vlc_input.h>
39

40
#ifdef USE_GOOM_TREE
41 42 43 44 45 46 47 48 49
#   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
50 51
#else
#   include <goom/goom.h>
52
#endif
53 54 55 56 57 58 59

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

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

#define SPEED_TEXT N_("Goom animation speed")
66 67
#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
68 69

#define MAX_SPEED 10
70

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

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
90
#define MAX_BLOCKS 100
Gildas Bazin's avatar
Gildas Bazin committed
91
#define GOOM_DELAY 400000
92 93 94 95 96 97 98 99 100 101 102

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
103 104 105 106 107 108 109 110 111
    /* Audio properties */
    int i_channels;

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

    audio_date_t  date;

112 113 114 115 116 117 118 119
} goom_thread_t;

typedef struct aout_filter_sys_t
{
    goom_thread_t *p_thread;

} aout_filter_sys_t;

120 121
static void DoWork   ( aout_instance_t *, aout_filter_t *, aout_buffer_t *,
                       aout_buffer_t * );
122

123
static void Thread   ( vlc_object_t * );
124 125 126 127 128 129 130 131 132 133

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;
134 135
    goom_thread_t     *p_thread;
    vlc_value_t       width, height;
136 137
    video_format_t    fmt;

138 139 140 141

    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
142
        msg_Warn( p_filter, "bad input or output format" );
143
        return VLC_EGENERIC;
144 145 146 147
    }
    if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
    {
        msg_Warn( p_filter, "input and output formats are not similar" );
148
        return VLC_EGENERIC;
149 150 151 152 153 154 155 156 157
    }

    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 */
158 159 160 161 162 163 164 165 166
    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 );

167 168
    memset( &fmt, 0, sizeof(video_format_t) );

169 170 171 172 173 174 175
    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 );
176
    if( p_thread->p_vout == NULL )
177 178
    {
        msg_Err( p_filter, "no suitable vout module" );
179
        vlc_object_detach( p_thread );
180
        vlc_object_release( p_thread );
181
        free( p_sys );
182 183
        return VLC_EGENERIC;
    }
184 185
    vlc_mutex_init( p_filter, &p_thread->lock );
    vlc_cond_init( p_filter, &p_thread->wait );
186

Gildas Bazin's avatar
Gildas Bazin committed
187 188 189 190 191
    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 );

192
    p_thread->psz_title = TitleGet( VLC_OBJECT( p_filter ) );
193

194
    if( vlc_thread_create( p_thread, "Goom Update Thread", Thread,
195
                           VLC_THREAD_PRIORITY_LOW, false ) )
196 197
    {
        msg_Err( p_filter, "cannot lauch goom thread" );
198 199 200
        vout_Destroy( p_thread->p_vout );
        vlc_mutex_destroy( &p_thread->lock );
        vlc_cond_destroy( &p_thread->wait );
201
        free( p_thread->psz_title );
202
        vlc_object_detach( p_thread );
203
        vlc_object_release( p_thread );
204
        free( p_sys );
205 206 207
        return VLC_EGENERIC;
    }

208
    return VLC_SUCCESS;
209 210 211
}

/*****************************************************************************
Gildas Bazin's avatar
Gildas Bazin committed
212
 * DoWork: process samples buffer
213
 *****************************************************************************
Gildas Bazin's avatar
Gildas Bazin committed
214 215 216 217 218
 * 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 )
{
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
219 220
    VLC_UNUSED( p_aout );

Gildas Bazin's avatar
Gildas Bazin committed
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
    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
248 249 250 251 252 253 254 255 256 257 258
 *****************************************************************************/
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
259 260 261 262 263 264
/*****************************************************************************
 * 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 )
265
{
Gildas Bazin's avatar
Gildas Bazin committed
266 267
    int i_samples = 0;
    block_t *p_block;
268

Gildas Bazin's avatar
Gildas Bazin committed
269
    while( *pi_data < 512 )
270
    {
Gildas Bazin's avatar
Gildas Bazin committed
271
        if( !p_this->i_blocks ) return VLC_EGENERIC;
272

Gildas Bazin's avatar
Gildas Bazin committed
273 274 275
        p_block = p_this->pp_blocks[0];
        i_samples = __MIN( 512 - *pi_data, p_block->i_buffer /
                           sizeof(float) / p_this->i_channels );
276

Gildas Bazin's avatar
Gildas Bazin committed
277 278 279
        /* Date management */
        if( p_block->i_pts > 0 &&
            p_block->i_pts != aout_DateGet( pi_date_end ) )
280
        {
Gildas Bazin's avatar
Gildas Bazin committed
281
           aout_DateSet( pi_date_end, p_block->i_pts );
282
        }
Gildas Bazin's avatar
Gildas Bazin committed
283
        p_block->i_pts = 0;
284

Gildas Bazin's avatar
Gildas Bazin committed
285
        aout_DateIncrement( pi_date_end, i_samples );
286

Gildas Bazin's avatar
Gildas Bazin committed
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
        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 *) );
        }
309 310
    }

Gildas Bazin's avatar
Gildas Bazin committed
311 312 313
    *pi_date = *pi_date_end;
    *pi_data = 0;
    return VLC_SUCCESS;
314
}
Gildas Bazin's avatar
Gildas Bazin committed
315

316 317 318 319 320 321
/*****************************************************************************
 * 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
322 323 324 325
    vlc_value_t width, height, speed;
    audio_date_t i_pts;
    int16_t p_data[2][512];
    int i_data = 0, i_count = 0;
326
    PluginInfo *p_plugin_info;
327

328 329 330
    var_Get( p_this, "goom-width", &width );
    var_Get( p_this, "goom-height", &height );

Gildas Bazin's avatar
Gildas Bazin committed
331 332 333 334 335
    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;

336
    p_plugin_info = goom_init( width.i_int, height.i_int );
337 338 339 340 341 342 343 344

    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
345 346 347
        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 );
348 349
        vlc_mutex_unlock( &p_thread->lock );

Gildas Bazin's avatar
Gildas Bazin committed
350 351 352 353 354 355
        /* 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;

356 357
        plane = goom_update( p_plugin_info, p_data, 0, 0.0,
                             p_thread->psz_title, NULL );
358

359 360
        free( p_thread->psz_title );
        p_thread->psz_title = NULL;
Gildas Bazin's avatar
Gildas Bazin committed
361

362
        while( !( p_pic = vout_CreatePicture( p_thread->p_vout, 0, 0, 0 ) ) &&
363 364 365 366 367
               !p_thread->b_die )
        {
            msleep( VOUT_OUTMEM_SLEEP );
        }

Gildas Bazin's avatar
Gildas Bazin committed
368
        if( p_pic == NULL ) break;
369

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

376
    goom_close( p_plugin_info );
377 378 379 380 381 382 383 384 385 386 387
}

/*****************************************************************************
 * 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 */
388
    vlc_object_kill( p_sys->p_thread );
389 390 391 392 393 394 395 396

    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 */
397
    vout_Request( p_filter, p_sys->p_thread->p_vout, 0 );
398 399
    vlc_mutex_destroy( &p_sys->p_thread->lock );
    vlc_cond_destroy( &p_sys->p_thread->wait );
400
    vlc_object_detach( p_sys->p_thread );
Gildas Bazin's avatar
Gildas Bazin committed
401 402 403 404 405 406

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

407
    vlc_object_release( p_sys->p_thread );
408 409 410 411 412 413

    free( p_sys );
}

static char *TitleGet( vlc_object_t *p_this )
{
414 415 416
    char *psz_title = NULL;
    input_thread_t *p_input =
        vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
417 418 419

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

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

    return psz_title;
}