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

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

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

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

110
    date_t        date;
Gildas Bazin's avatar
Gildas Bazin committed
111

112 113
} goom_thread_t;

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

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

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

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

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
131 132 133 134 135
    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;
136

137

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

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

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

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

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

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

170
    p_thread->p_vout = aout_filter_RequestVout( p_filter, NULL, &fmt );
171
    if( p_thread->p_vout == NULL )
172 173
    {
        msg_Err( p_filter, "no suitable vout module" );
174
        vlc_object_detach( p_thread );
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

Gildas Bazin's avatar
Gildas Bazin committed
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 );
Gildas Bazin's avatar
Gildas Bazin committed
186

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

189
    if( vlc_thread_create( p_thread, "Goom Update Thread", Thread,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
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_detach( p_thread );
198
        vlc_object_release( p_thread );
199
        free( p_sys );
200 201 202
        return VLC_EGENERIC;
    }

203
    return VLC_SUCCESS;
204 205 206
}

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

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

    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
237 238

    return p_in_buf;
Gildas Bazin's avatar
Gildas Bazin committed
239 240 241 242
}

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

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

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

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

280
        date_Increment( pi_date_end, i_samples );
281

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

Gildas Bazin's avatar
Gildas Bazin committed
306 307 308
    *pi_date = *pi_date_end;
    *pi_data = 0;
    return VLC_SUCCESS;
309
}
Gildas Bazin's avatar
Gildas Bazin committed
310

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

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

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

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

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

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

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

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

354 355
        free( p_thread->psz_title );
        p_thread->psz_title = NULL;
Gildas Bazin's avatar
Gildas Bazin committed
356

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

Gildas Bazin's avatar
Gildas Bazin committed
363
        if( p_pic == NULL ) break;
364

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

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

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

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

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

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

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

404
    vlc_object_release( p_sys->p_thread );
405 406 407 408 409 410

    free( p_sys );
}

static char *TitleGet( vlc_object_t *p_this )
{
411 412 413
    char *psz_title = NULL;
    input_thread_t *p_input =
        vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
414 415 416

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

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

    return psz_title;
}