goom.c 12.9 KB
Newer Older
1 2 3
/*****************************************************************************
 * goom.c: based on libgoom (see http://ios.free.fr/?page=projet&quoi=1)
 *****************************************************************************
4
 * Copyright (C) 2003-2011 the VideoLAN team
5
 *
gbazin's avatar
gbazin committed
6 7
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 *          Gildas Bazin <gbazin@videolan.org>
8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * 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
dionoea's avatar
dionoea committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23 24 25 26
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
27

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

32
#include <vlc_common.h>
33
#include <vlc_plugin.h>
34 35 36
#include <vlc_aout.h>            /* aout_FormatNbChannels, AOUT_FMTS_SIMILAR */
#include <vlc_vout.h>              /* vout_*Picture, aout_filter_RequestVout */
#include <vlc_playlist.h>              /* playlist_CurrentInput, input*Title */
37

38
#include <goom/goom.h>
39 40 41 42 43 44 45

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

46 47
#define WIDTH_TEXT N_("Goom display width")
#define HEIGHT_TEXT N_("Goom display height")
48
#define RES_LONGTEXT N_("This allows you to set the resolution of the " \
49
  "Goom display (bigger resolution will be prettier but more CPU intensive).")
gbazin's avatar
gbazin committed
50 51

#define SPEED_TEXT N_("Goom animation speed")
52 53
#define SPEED_LONGTEXT N_("This allows you to set the animation speed " \
  "(between 1 and 10, defaults to 6).")
gbazin's avatar
gbazin committed
54 55

#define MAX_SPEED 10
56

57 58 59 60 61
vlc_module_begin ()
    set_shortname( N_("Goom"))
    set_description( N_("Goom effect") )
    set_category( CAT_AUDIO )
    set_subcategory( SUBCAT_AUDIO_VISUAL )
ivoire's avatar
ivoire committed
62
    set_capability( "visualization2", 0 )
63
    add_integer( "goom-width", 800,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
64
                 WIDTH_TEXT, RES_LONGTEXT, false )
65
    add_integer( "goom-height", 640,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
66
                 HEIGHT_TEXT, RES_LONGTEXT, false )
67
    add_integer( "goom-speed", 6,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
68
                 SPEED_TEXT, SPEED_LONGTEXT, false )
69 70 71
    set_callbacks( Open, Close )
    add_shortcut( "goom" )
vlc_module_end ()
72 73 74 75

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
76
#define MAX_BLOCKS 100
gbazin's avatar
gbazin committed
77
#define GOOM_DELAY 400000
78 79 80 81 82 83 84 85 86 87 88

typedef struct
{
    VLC_COMMON_MEMBERS
    vout_thread_t *p_vout;

    char          *psz_title;

    vlc_mutex_t   lock;
    vlc_cond_t    wait;

gbazin's avatar
gbazin committed
89
    /* Audio properties */
90
    unsigned i_channels;
gbazin's avatar
gbazin committed
91 92 93 94 95

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

96
    date_t        date;
gbazin's avatar
gbazin committed
97

98 99
} goom_thread_t;

ivoire's avatar
ivoire committed
100
struct filter_sys_t
101 102 103
{
    goom_thread_t *p_thread;

Laurent Aimar's avatar
Laurent Aimar committed
104
};
105

ivoire's avatar
ivoire committed
106
static block_t *DoWork ( filter_t *, block_t * );
107

ivoire's avatar
ivoire committed
108
static void* Thread   ( vlc_object_t * );
109 110 111 112 113 114 115 116

static char *TitleGet( vlc_object_t * );

/*****************************************************************************
 * Open: open a scope effect plugin
 *****************************************************************************/
static int Open( vlc_object_t *p_this )
{
ivoire's avatar
ivoire committed
117 118 119 120 121
    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;
122

123

124 125
    if( p_filter->fmt_in.audio.i_format != VLC_CODEC_FL32 ||
         p_filter->fmt_out.audio.i_format != VLC_CODEC_FL32 )
126
    {
Christophe Mutricy's avatar
Christophe Mutricy committed
127
        msg_Warn( p_filter, "bad input or output format" );
128
        return VLC_EGENERIC;
129
    }
130
    if( !AOUT_FMTS_SIMILAR( &p_filter->fmt_in.audio, &p_filter->fmt_out.audio ) )
131 132
    {
        msg_Warn( p_filter, "input and output formats are not similar" );
133
        return VLC_EGENERIC;
134 135
    }

ivoire's avatar
ivoire committed
136
    p_filter->pf_audio_filter = DoWork;
137 138

    /* Allocate structure */
ivoire's avatar
ivoire committed
139
    p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
140 141

    /* Create goom thread */
142 143 144 145
    p_sys->p_thread = p_thread =
        vlc_object_create( p_filter, sizeof( goom_thread_t ) );
    vlc_object_attach( p_thread, p_this );

ivoire's avatar
ivoire committed
146 147
    width = var_CreateGetInteger( p_thread, "goom-width" );
    height = var_CreateGetInteger( p_thread, "goom-height" );
148

149 150
    memset( &fmt, 0, sizeof(video_format_t) );

ivoire's avatar
ivoire committed
151 152
    fmt.i_width = fmt.i_visible_width = width;
    fmt.i_height = fmt.i_visible_height = height;
153
    fmt.i_chroma = VLC_CODEC_RGB32;
154 155
    fmt.i_sar_num = fmt.i_sar_den = 1;

156
    p_thread->p_vout = aout_filter_RequestVout( p_filter, NULL, &fmt );
157
    if( p_thread->p_vout == NULL )
158 159
    {
        msg_Err( p_filter, "no suitable vout module" );
160
        vlc_object_release( p_thread );
161
        free( p_sys );
162 163
        return VLC_EGENERIC;
    }
164
    vlc_mutex_init( &p_thread->lock );
165
    vlc_cond_init( &p_thread->wait );
166

gbazin's avatar
gbazin committed
167
    p_thread->i_blocks = 0;
168
    date_Init( &p_thread->date, p_filter->fmt_out.audio.i_rate, 1 );
169
    date_Set( &p_thread->date, 0 );
170
    p_thread->i_channels = aout_FormatNbChannels( &p_filter->fmt_in.audio );
gbazin's avatar
gbazin committed
171

172
    p_thread->psz_title = TitleGet( VLC_OBJECT( p_filter ) );
173

174
    if( vlc_thread_create( p_thread, Thread,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
175
                           VLC_THREAD_PRIORITY_LOW ) )
176 177
    {
        msg_Err( p_filter, "cannot lauch goom thread" );
178
        vlc_object_release( p_thread->p_vout );
179 180
        vlc_mutex_destroy( &p_thread->lock );
        vlc_cond_destroy( &p_thread->wait );
ivoire's avatar
ivoire committed
181
        free( p_thread->psz_title );
182
        vlc_object_release( p_thread );
183
        free( p_sys );
184 185 186
        return VLC_EGENERIC;
    }

187
    return VLC_SUCCESS;
188 189 190
}

/*****************************************************************************
gbazin's avatar
gbazin committed
191
 * DoWork: process samples buffer
192
 *****************************************************************************
gbazin's avatar
gbazin committed
193 194
 * This function queues the audio buffer to be processed by the goom thread
 *****************************************************************************/
ivoire's avatar
ivoire committed
195
static block_t *DoWork( filter_t *p_filter, block_t *p_in_buf )
gbazin's avatar
gbazin committed
196
{
ivoire's avatar
ivoire committed
197
    filter_sys_t *p_sys = p_filter->p_sys;
gbazin's avatar
gbazin committed
198 199 200 201 202 203 204
    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 );
ivoire's avatar
ivoire committed
205
        return p_in_buf;
gbazin's avatar
gbazin committed
206 207
    }

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
208
    p_block = block_New( p_sys->p_thread, p_in_buf->i_buffer );
ivoire's avatar
ivoire committed
209 210 211
    if( !p_block )
    {
        vlc_mutex_unlock( &p_sys->p_thread->lock );
ivoire's avatar
ivoire committed
212
        return p_in_buf;
ivoire's avatar
ivoire committed
213
    }
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
214
    memcpy( p_block->p_buffer, p_in_buf->p_buffer, p_in_buf->i_buffer );
215
    p_block->i_pts = p_in_buf->i_pts;
gbazin's avatar
gbazin committed
216 217 218 219 220

    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 );
ivoire's avatar
ivoire committed
221 222

    return p_in_buf;
gbazin's avatar
gbazin committed
223 224 225 226
}

/*****************************************************************************
 * float to s16 conversion
227 228 229 230 231 232 233 234 235 236 237
 *****************************************************************************/
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 );
}

gbazin's avatar
gbazin committed
238 239 240 241
/*****************************************************************************
 * Fill buffer
 *****************************************************************************/
static int FillBuffer( int16_t *p_data, int *pi_data,
242
                       date_t *pi_date, date_t *pi_date_end,
gbazin's avatar
gbazin committed
243
                       goom_thread_t *p_this )
244
{
gbazin's avatar
gbazin committed
245 246
    int i_samples = 0;
    block_t *p_block;
247

gbazin's avatar
gbazin committed
248
    while( *pi_data < 512 )
249
    {
gbazin's avatar
gbazin committed
250
        if( !p_this->i_blocks ) return VLC_EGENERIC;
251

gbazin's avatar
gbazin committed
252
        p_block = p_this->pp_blocks[0];
253 254
        i_samples = __MIN( (unsigned)(512 - *pi_data),
                p_block->i_buffer / sizeof(float) / p_this->i_channels );
255

gbazin's avatar
gbazin committed
256
        /* Date management */
257
        if( p_block->i_pts > VLC_TS_INVALID &&
258
            p_block->i_pts != date_Get( pi_date_end ) )
259
        {
260
           date_Set( pi_date_end, p_block->i_pts );
261
        }
262
        p_block->i_pts = VLC_TS_INVALID;
263

264
        date_Increment( pi_date_end, i_samples );
265

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

gbazin's avatar
gbazin committed
290 291 292
    *pi_date = *pi_date_end;
    *pi_data = 0;
    return VLC_SUCCESS;
293
}
gbazin's avatar
gbazin committed
294

295 296 297
/*****************************************************************************
 * Thread:
 *****************************************************************************/
ivoire's avatar
ivoire committed
298
static void* Thread( vlc_object_t *p_this )
299 300
{
    goom_thread_t *p_thread = (goom_thread_t*)p_this;
ivoire's avatar
ivoire committed
301
    int width, height, speed;
302
    date_t i_pts;
gbazin's avatar
gbazin committed
303 304
    int16_t p_data[2][512];
    int i_data = 0, i_count = 0;
305
    PluginInfo *p_plugin_info;
306
    int canc = vlc_savecancel ();
307

ivoire's avatar
ivoire committed
308 309
    width = var_GetInteger( p_this, "goom-width" );
    height = var_GetInteger( p_this, "goom-height" );
310

ivoire's avatar
ivoire committed
311 312 313
    speed = var_CreateGetInteger( p_thread, "goom-speed" );
    speed = MAX_SPEED - speed;
    if( speed < 0 ) speed = 0;
gbazin's avatar
gbazin committed
314

ivoire's avatar
ivoire committed
315
    p_plugin_info = goom_init( width, height );
316

317
    while( vlc_object_alive (p_thread) )
318 319 320 321 322 323
    {
        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 );
gbazin's avatar
gbazin committed
324 325 326
        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 );
327 328
        vlc_mutex_unlock( &p_thread->lock );

gbazin's avatar
gbazin committed
329
        /* Speed selection */
ivoire's avatar
ivoire committed
330
        if( speed && (++i_count % (speed+1)) ) continue;
gbazin's avatar
gbazin committed
331 332

        /* Frame dropping if necessary */
333
        if( date_Get( &i_pts ) + GOOM_DELAY <= mdate() ) continue;
gbazin's avatar
gbazin committed
334

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

ivoire's avatar
ivoire committed
338 339
        free( p_thread->psz_title );
        p_thread->psz_title = NULL;
gbazin's avatar
gbazin committed
340

Laurent Aimar's avatar
Laurent Aimar committed
341
        while( !( p_pic = vout_GetPicture( p_thread->p_vout ) ) &&
342
               vlc_object_alive (p_thread) )
343 344 345 346
        {
            msleep( VOUT_OUTMEM_SLEEP );
        }

gbazin's avatar
gbazin committed
347
        if( p_pic == NULL ) break;
348

ivoire's avatar
ivoire committed
349
        memcpy( p_pic->p[0].p_pixels, plane, width * height * 4 );
350

351
        p_pic->date = date_Get( &i_pts ) + GOOM_DELAY;
Laurent Aimar's avatar
Laurent Aimar committed
352
        vout_PutPicture( p_thread->p_vout, p_pic );
353 354
    }

355
    goom_close( p_plugin_info );
356
    vlc_restorecancel (canc);
ivoire's avatar
ivoire committed
357
    return NULL;
358 359 360 361 362 363 364
}

/*****************************************************************************
 * Close: close the plugin
 *****************************************************************************/
static void Close( vlc_object_t *p_this )
{
ivoire's avatar
ivoire committed
365 366
    filter_t     *p_filter = (filter_t *)p_this;
    filter_sys_t *p_sys = p_filter->p_sys;
367 368

    /* Stop Goom Thread */
369
    vlc_object_kill( p_sys->p_thread );
370 371 372 373 374 375 376 377

    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 */
378
    aout_filter_RequestVout( p_filter, p_sys->p_thread->p_vout, 0 );
379 380
    vlc_mutex_destroy( &p_sys->p_thread->lock );
    vlc_cond_destroy( &p_sys->p_thread->wait );
gbazin's avatar
gbazin committed
381 382 383 384 385 386

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

387
    vlc_object_release( p_sys->p_thread );
388 389 390 391 392 393

    free( p_sys );
}

static char *TitleGet( vlc_object_t *p_this )
{
394
    input_thread_t *p_input = playlist_CurrentInput( pl_Get( p_this ) );
395 396 397 398 399
    if( !p_input )
        return NULL;

    char *psz_title = input_item_GetTitle( input_GetItem( p_input ) );
    if( EMPTY_STR( psz_title ) )
400
    {
401 402 403
        free( psz_title );

        char *psz_uri = input_item_GetURI( input_GetItem( p_input ) );
Pierre Ynard's avatar
Pierre Ynard committed
404
        const char *psz = strrchr( psz_uri, '/' );
405
        if( psz )
406
        {
407 408
            psz_title = strdup( psz + 1 );
            free( psz_uri );
409
        }
410 411
        else
            psz_title = psz_uri;
412
    }
413
    vlc_object_release( p_input );
414 415
    return psz_title;
}