goom.c 13.6 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_common.h>
35
#include <vlc_plugin.h>
Clément Stenac's avatar
Clément Stenac committed
36 37 38 39
#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
40
#include <vlc_filter.h>
41

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

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

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

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

#define MAX_SPEED 10
72

73 74 75 76 77
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
78
    set_capability( "visualization2", 0 )
79
    add_integer( "goom-width", 800, NULL,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
80
                 WIDTH_TEXT, RES_LONGTEXT, false )
81
    add_integer( "goom-height", 640, NULL,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
82
                 HEIGHT_TEXT, RES_LONGTEXT, false )
83
    add_integer( "goom-speed", 6, NULL,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
84
                 SPEED_TEXT, SPEED_LONGTEXT, false )
85 86 87
    set_callbacks( Open, Close )
    add_shortcut( "goom" )
vlc_module_end ()
88 89 90 91

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

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
105
    /* Audio properties */
106
    unsigned i_channels;
Gildas Bazin's avatar
Gildas Bazin committed
107 108 109 110 111

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

112
    date_t        date;
Gildas Bazin's avatar
Gildas Bazin committed
113

114 115
} goom_thread_t;

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

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

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

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

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
133 134 135 136 137
    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;
138

139

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

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

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

    /* Create goom thread */
158 159 160 161
    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
162 163
    width = var_CreateGetInteger( p_thread, "goom-width" );
    height = var_CreateGetInteger( p_thread, "goom-height" );
164

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

Rémi Duraffort's avatar
Rémi Duraffort committed
167 168
    fmt.i_width = fmt.i_visible_width = width;
    fmt.i_height = fmt.i_visible_height = height;
169
    fmt.i_chroma = VLC_CODEC_RGB32;
Rémi Duraffort's avatar
Rémi Duraffort committed
170
    fmt.i_aspect = VOUT_ASPECT_FACTOR * width/height;
171 172
    fmt.i_sar_num = fmt.i_sar_den = 1;

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

Gildas Bazin's avatar
Gildas Bazin committed
185
    p_thread->i_blocks = 0;
186
    date_Init( &p_thread->date, p_filter->fmt_out.audio.i_rate, 1 );
187
    date_Set( &p_thread->date, 0 );
188
    p_thread->i_channels = aout_FormatNbChannels( &p_filter->fmt_in.audio );
Gildas Bazin's avatar
Gildas Bazin committed
189

190
    p_thread->psz_title = TitleGet( VLC_OBJECT( p_filter ) );
191

192
    if( vlc_thread_create( p_thread, "Goom Update Thread", Thread,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
193
                           VLC_THREAD_PRIORITY_LOW ) )
194 195
    {
        msg_Err( p_filter, "cannot lauch goom thread" );
196
        vlc_object_release( p_thread->p_vout );
197 198
        vlc_mutex_destroy( &p_thread->lock );
        vlc_cond_destroy( &p_thread->wait );
199
        free( p_thread->psz_title );
200
        vlc_object_detach( p_thread );
201
        vlc_object_release( p_thread );
202
        free( p_sys );
203 204 205
        return VLC_EGENERIC;
    }

206
    return VLC_SUCCESS;
207 208 209
}

/*****************************************************************************
Gildas Bazin's avatar
Gildas Bazin committed
210
 * DoWork: process samples buffer
211
 *****************************************************************************
Gildas Bazin's avatar
Gildas Bazin committed
212 213
 * This function queues the audio buffer to be processed by the goom thread
 *****************************************************************************/
Rémi Duraffort's avatar
Rémi Duraffort committed
214
static block_t *DoWork( filter_t *p_filter, block_t *p_in_buf )
Gildas Bazin's avatar
Gildas Bazin committed
215
{
Rémi Duraffort's avatar
Rémi Duraffort committed
216
    filter_sys_t *p_sys = p_filter->p_sys;
Gildas Bazin's avatar
Gildas Bazin committed
217 218 219 220 221 222 223
    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
224
        return p_in_buf;
Gildas Bazin's avatar
Gildas Bazin committed
225 226
    }

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
227
    p_block = block_New( p_sys->p_thread, p_in_buf->i_buffer );
228 229 230
    if( !p_block )
    {
        vlc_mutex_unlock( &p_sys->p_thread->lock );
Rémi Duraffort's avatar
Rémi Duraffort committed
231
        return p_in_buf;
232
    }
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
233
    memcpy( p_block->p_buffer, p_in_buf->p_buffer, p_in_buf->i_buffer );
234
    p_block->i_pts = p_in_buf->i_pts;
Gildas Bazin's avatar
Gildas Bazin committed
235 236 237 238 239

    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
240 241

    return p_in_buf;
Gildas Bazin's avatar
Gildas Bazin committed
242 243 244 245
}

/*****************************************************************************
 * float to s16 conversion
246 247 248 249 250 251 252 253 254 255 256
 *****************************************************************************/
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
257 258 259 260
/*****************************************************************************
 * Fill buffer
 *****************************************************************************/
static int FillBuffer( int16_t *p_data, int *pi_data,
261
                       date_t *pi_date, date_t *pi_date_end,
Gildas Bazin's avatar
Gildas Bazin committed
262
                       goom_thread_t *p_this )
263
{
Gildas Bazin's avatar
Gildas Bazin committed
264 265
    int i_samples = 0;
    block_t *p_block;
266

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

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

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

283
        date_Increment( pi_date_end, i_samples );
284

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

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

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

Rémi Duraffort's avatar
Rémi Duraffort committed
327 328
    width = var_GetInteger( p_this, "goom-width" );
    height = var_GetInteger( p_this, "goom-height" );
329

Rémi Duraffort's avatar
Rémi Duraffort committed
330 331 332
    speed = var_CreateGetInteger( p_thread, "goom-speed" );
    speed = MAX_SPEED - speed;
    if( speed < 0 ) speed = 0;
Gildas Bazin's avatar
Gildas Bazin committed
333

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

336
    while( vlc_object_alive (p_thread) )
337 338 339 340 341 342
    {
        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
343 344 345
        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 );
346 347
        vlc_mutex_unlock( &p_thread->lock );

Gildas Bazin's avatar
Gildas Bazin committed
348
        /* Speed selection */
Rémi Duraffort's avatar
Rémi Duraffort committed
349
        if( speed && (++i_count % (speed+1)) ) continue;
Gildas Bazin's avatar
Gildas Bazin committed
350 351

        /* Frame dropping if necessary */
352
        if( date_Get( &i_pts ) + GOOM_DELAY <= mdate() ) continue;
Gildas Bazin's avatar
Gildas Bazin committed
353

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

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

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

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

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

370
        p_pic->date = date_Get( &i_pts ) + GOOM_DELAY;
371 372 373
        vout_DisplayPicture( p_thread->p_vout, p_pic );
    }

374
    goom_close( p_plugin_info );
375
    vlc_restorecancel (canc);
376
    return NULL;
377 378 379 380 381 382 383
}

/*****************************************************************************
 * Close: close the plugin
 *****************************************************************************/
static void Close( vlc_object_t *p_this )
{
Rémi Duraffort's avatar
Rémi Duraffort committed
384 385
    filter_t     *p_filter = (filter_t *)p_this;
    filter_sys_t *p_sys = p_filter->p_sys;
386 387

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