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

/*****************************************************************************
 * Preamble
 *****************************************************************************/
28 29 30 31
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

32
#include <vlc_common.h>
33
#include <vlc_plugin.h>
Clément Stenac's avatar
Clément Stenac committed
34 35 36 37
#include <vlc_aout.h>
#include <vlc_vout.h>
#include <vlc_block.h>
#include <vlc_input.h>
Rémi Duraffort's avatar
Rémi Duraffort committed
38
#include <vlc_filter.h>
Pierre Ynard's avatar
Pierre Ynard committed
39
#include <vlc_playlist.h>
40

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

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

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

#define SPEED_TEXT N_("Goom animation speed")
67 68
#define SPEED_LONGTEXT N_("This allows you to set the animation speed " \
  "(between 1 and 10, defaults to 6).")
69 70

#define MAX_SPEED 10
71

72 73 74 75 76
vlc_module_begin ()
    set_shortname( N_("Goom"))
    set_description( N_("Goom effect") )
    set_category( CAT_AUDIO )
    set_subcategory( SUBCAT_AUDIO_VISUAL )
Rémi Duraffort's avatar
Rémi Duraffort committed
77
    set_capability( "visualization2", 0 )
78
    add_integer( "goom-width", 800, NULL,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
79
                 WIDTH_TEXT, RES_LONGTEXT, false )
80
    add_integer( "goom-height", 640, NULL,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
81
                 HEIGHT_TEXT, RES_LONGTEXT, false )
82
    add_integer( "goom-speed", 6, NULL,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
83
                 SPEED_TEXT, SPEED_LONGTEXT, false )
84 85 86
    set_callbacks( Open, Close )
    add_shortcut( "goom" )
vlc_module_end ()
87 88 89 90

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
91
#define MAX_BLOCKS 100
92
#define GOOM_DELAY 400000
93 94 95 96 97 98 99 100 101 102 103

typedef struct
{
    VLC_COMMON_MEMBERS
    vout_thread_t *p_vout;

    char          *psz_title;

    vlc_mutex_t   lock;
    vlc_cond_t    wait;

104
    /* Audio properties */
105
    unsigned i_channels;
106 107 108 109 110

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

111
    date_t        date;
112

113 114
} goom_thread_t;

Rémi Duraffort's avatar
Rémi Duraffort committed
115
struct filter_sys_t
116 117 118
{
    goom_thread_t *p_thread;

Laurent Aimar's avatar
Laurent Aimar committed
119
};
120

Rémi Duraffort's avatar
Rémi Duraffort committed
121
static block_t *DoWork ( filter_t *, block_t * );
122

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

static char *TitleGet( vlc_object_t * );

/*****************************************************************************
 * Open: open a scope effect plugin
 *****************************************************************************/
static int Open( vlc_object_t *p_this )
{
Rémi Duraffort's avatar
Rémi Duraffort committed
132 133 134 135 136
    filter_t       *p_filter = (filter_t *)p_this;
    filter_sys_t   *p_sys;
    goom_thread_t  *p_thread;
    int             width, height;
    video_format_t fmt;
137

138

139 140
    if( p_filter->fmt_in.audio.i_format != VLC_CODEC_FL32 ||
         p_filter->fmt_out.audio.i_format != VLC_CODEC_FL32 )
141
    {
142
        msg_Warn( p_filter, "bad input or output format" );
143
        return VLC_EGENERIC;
144
    }
145
    if( !AOUT_FMTS_SIMILAR( &p_filter->fmt_in.audio, &p_filter->fmt_out.audio ) )
146 147
    {
        msg_Warn( p_filter, "input and output formats are not similar" );
148
        return VLC_EGENERIC;
149 150
    }

Rémi Duraffort's avatar
Rémi Duraffort committed
151
    p_filter->pf_audio_filter = DoWork;
152 153

    /* Allocate structure */
Rémi Duraffort's avatar
Rémi Duraffort committed
154
    p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
155 156

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

Rémi Duraffort's avatar
Rémi Duraffort committed
161 162
    width = var_CreateGetInteger( p_thread, "goom-width" );
    height = var_CreateGetInteger( p_thread, "goom-height" );
163

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

Rémi Duraffort's avatar
Rémi Duraffort committed
166 167
    fmt.i_width = fmt.i_visible_width = width;
    fmt.i_height = fmt.i_visible_height = height;
168
    fmt.i_chroma = VLC_CODEC_RGB32;
169 170
    fmt.i_sar_num = fmt.i_sar_den = 1;

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

182
    p_thread->i_blocks = 0;
183
    date_Init( &p_thread->date, p_filter->fmt_out.audio.i_rate, 1 );
184
    date_Set( &p_thread->date, 0 );
185
    p_thread->i_channels = aout_FormatNbChannels( &p_filter->fmt_in.audio );
186

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

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

202
    return VLC_SUCCESS;
203 204 205
}

/*****************************************************************************
206
 * DoWork: process samples buffer
207
 *****************************************************************************
208 209
 * This function queues the audio buffer to be processed by the goom thread
 *****************************************************************************/
Rémi Duraffort's avatar
Rémi Duraffort committed
210
static block_t *DoWork( filter_t *p_filter, block_t *p_in_buf )
211
{
Rémi Duraffort's avatar
Rémi Duraffort committed
212
    filter_sys_t *p_sys = p_filter->p_sys;
213 214 215 216 217 218 219
    block_t *p_block;

    /* 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 );
Rémi Duraffort's avatar
Rémi Duraffort committed
220
        return p_in_buf;
221 222
    }

223
    p_block = block_New( p_sys->p_thread, p_in_buf->i_buffer );
224 225 226
    if( !p_block )
    {
        vlc_mutex_unlock( &p_sys->p_thread->lock );
Rémi Duraffort's avatar
Rémi Duraffort committed
227
        return p_in_buf;
228
    }
229
    memcpy( p_block->p_buffer, p_in_buf->p_buffer, p_in_buf->i_buffer );
230
    p_block->i_pts = p_in_buf->i_pts;
231 232 233 234 235

    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 );
Rémi Duraffort's avatar
Rémi Duraffort committed
236 237

    return p_in_buf;
238 239 240 241
}

/*****************************************************************************
 * 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 );
}

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

263
    while( *pi_data < 512 )
264
    {
265
        if( !p_this->i_blocks ) return VLC_EGENERIC;
266

267
        p_block = p_this->pp_blocks[0];
268 269
        i_samples = __MIN( (unsigned)(512 - *pi_data),
                p_block->i_buffer / sizeof(float) / p_this->i_channels );
270

271
        /* Date management */
272
        if( p_block->i_pts > VLC_TS_INVALID &&
273
            p_block->i_pts != date_Get( pi_date_end ) )
274
        {
275
           date_Set( pi_date_end, p_block->i_pts );
276
        }
277
        p_block->i_pts = VLC_TS_INVALID;
278

279
        date_Increment( pi_date_end, i_samples );
280

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
    }

305 306 307
    *pi_date = *pi_date_end;
    *pi_data = 0;
    return VLC_SUCCESS;
308
}
309

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

Rémi Duraffort's avatar
Rémi Duraffort committed
323 324
    width = var_GetInteger( p_this, "goom-width" );
    height = var_GetInteger( p_this, "goom-height" );
325

Rémi Duraffort's avatar
Rémi Duraffort committed
326 327 328
    speed = var_CreateGetInteger( p_thread, "goom-speed" );
    speed = MAX_SPEED - speed;
    if( speed < 0 ) speed = 0;
329

Rémi Duraffort's avatar
Rémi Duraffort committed
330
    p_plugin_info = goom_init( width, height );
331

332
    while( vlc_object_alive (p_thread) )
333 334 335 336 337 338
    {
        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 );
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 );

344
        /* Speed selection */
Rémi Duraffort's avatar
Rémi Duraffort committed
345
        if( speed && (++i_count % (speed+1)) ) continue;
346 347

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

350 351
        plane = goom_update( p_plugin_info, p_data, 0, 0.0,
                             p_thread->psz_title, NULL );
352

353 354
        free( p_thread->psz_title );
        p_thread->psz_title = NULL;
355

356
        while( !( p_pic = vout_CreatePicture( p_thread->p_vout, 0, 0, 0 ) ) &&
357
               vlc_object_alive (p_thread) )
358 359 360 361
        {
            msleep( VOUT_OUTMEM_SLEEP );
        }

362
        if( p_pic == NULL ) break;
363

Rémi Duraffort's avatar
Rémi Duraffort committed
364
        memcpy( p_pic->p[0].p_pixels, plane, width * height * 4 );
365

366
        p_pic->date = date_Get( &i_pts ) + GOOM_DELAY;
367 368 369
        vout_DisplayPicture( p_thread->p_vout, p_pic );
    }

370
    goom_close( p_plugin_info );
371
    vlc_restorecancel (canc);
372
    return NULL;
373 374 375 376 377 378 379
}

/*****************************************************************************
 * Close: close the plugin
 *****************************************************************************/
static void Close( vlc_object_t *p_this )
{
Rémi Duraffort's avatar
Rémi Duraffort committed
380 381
    filter_t     *p_filter = (filter_t *)p_this;
    filter_sys_t *p_sys = p_filter->p_sys;
382 383

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

    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 */
393
    aout_filter_RequestVout( p_filter, p_sys->p_thread->p_vout, 0 );
394 395
    vlc_mutex_destroy( &p_sys->p_thread->lock );
    vlc_cond_destroy( &p_sys->p_thread->wait );
396 397 398 399 400 401

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

402
    vlc_object_release( p_sys->p_thread );
403 404 405 406 407 408

    free( p_sys );
}

static char *TitleGet( vlc_object_t *p_this )
{
409 410 411
    playlist_t *pl = pl_Hold( p_this );
    if( !pl )
        return NULL;
412

413 414 415 416 417 418 419
    input_thread_t *p_input = playlist_CurrentInput( pl );
    pl_Release( p_this );
    if( !p_input )
        return NULL;

    char *psz_title = input_item_GetTitle( input_GetItem( p_input ) );
    if( EMPTY_STR( psz_title ) )
420
    {
421 422 423
        free( psz_title );

        char *psz_uri = input_item_GetURI( input_GetItem( p_input ) );
Pierre Ynard's avatar
Pierre Ynard committed
424
        const char *psz = strrchr( psz_uri, '/' );
425
        if( psz )
426
        {
427 428
            psz_title = strdup( psz + 1 );
            free( psz_uri );
429
        }
430 431
        else
            psz_title = psz_uri;
432
    }
433
    vlc_object_release( p_input );
434 435
    return psz_title;
}