thread.c 17 KB
Newer Older
1
/*****************************************************************************
2
 * thread.c : Playlist management functions
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright © 1999-2008 VLC authors and VideoLAN
5 6 7 8 9
 * $Id$
 *
 * Authors: Samuel Hocevar <sam@zoy.org>
 *          Clément Stenac <zorglub@videolan.org>
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
10 11 12
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
13 14 15 16
 * (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
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
17 18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
19
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
20 21 22
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23
 *****************************************************************************/
24 25 26 27
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

28 29
#include <assert.h>

30
#include <vlc_common.h>
Jean-Paul Saman's avatar
Jean-Paul Saman committed
31
#include <vlc_es.h>
32
#include <vlc_input.h>
Clément Stenac's avatar
Clément Stenac committed
33 34
#include <vlc_interface.h>
#include <vlc_playlist.h>
35
#include <vlc_rand.h>
36
#include "playlist_internal.h"
37 38 39 40

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
41
static void *Thread   ( void * );
42 43 44 45 46 47

/*****************************************************************************
 * Main functions for the global thread
 *****************************************************************************/

/**
48
 * Creates the main playlist thread.
49
 */
50
void playlist_Activate( playlist_t *p_playlist )
51
{
52
    playlist_private_t *p_sys = pl_priv(p_playlist);
53

54 55
    if( vlc_clone( &p_sys->thread, Thread, p_playlist,
                   VLC_THREAD_PRIORITY_LOW ) )
56 57
    {
        msg_Err( p_playlist, "cannot spawn playlist thread" );
58
        abort();
59
    }
60 61
}

62 63 64 65 66
/**
 * Stops the playlist forever (but do not destroy it yet).
 * Any input is stopped.
 * \return Nothing but waits for the playlist to be deactivated.
 */
67 68 69 70
void playlist_Deactivate( playlist_t *p_playlist )
{
    playlist_private_t *p_sys = pl_priv(p_playlist);

71
    PL_LOCK;
72 73 74 75 76 77 78 79 80 81 82
    /* WARNING: There is a latent bug. It is assumed that only one thread will
     * be waiting for playlist deactivation at a time. So far, that works
     * as playlist_Deactivate() is only ever called while closing an
     * interface and interfaces are shut down serially by intf_DestroyAll(). */
    if( p_sys->killed )
    {
        PL_UNLOCK;
        return;
    }

    msg_Dbg( p_playlist, "deactivating the playlist" );
83
    p_sys->killed = true;
84 85 86
    vlc_cond_signal( &p_sys->signal );
    PL_UNLOCK;

87
    vlc_join( p_sys->thread, NULL );
88 89
}

Laurent Aimar's avatar
Laurent Aimar committed
90 91 92 93 94 95 96 97 98 99
/* */

/* Input Callback */
static int InputEvent( vlc_object_t *p_this, char const *psz_cmd,
                       vlc_value_t oldval, vlc_value_t newval, void *p_data )
{
    VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
    playlist_t *p_playlist = p_data;

    if( newval.i_int != INPUT_EVENT_STATE &&
100
        newval.i_int != INPUT_EVENT_DEAD )
Laurent Aimar's avatar
Laurent Aimar committed
101 102 103 104
        return VLC_SUCCESS;

    PL_LOCK;

105 106
    /* XXX: signaling while not changing any parameter... suspicious... */
    vlc_cond_signal( &pl_priv(p_playlist)->signal );
Laurent Aimar's avatar
Laurent Aimar committed
107 108 109 110 111 112 113 114 115 116 117 118 119

    PL_UNLOCK;
    return VLC_SUCCESS;
}

/**
 * Synchronise the current index of the playlist
 * to match the index of the current item.
 *
 * \param p_playlist the playlist structure
 * \param p_cur the current playlist item
 * \return nothing
 */
120
void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur )
Laurent Aimar's avatar
Laurent Aimar committed
121
{
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
    PL_ASSERT_LOCKED;

    PL_DEBUG( "resyncing on %s", PLI_NAME( p_cur ) );
    /* Simply resync index */
    int i;
    p_playlist->i_current_index = -1;
    for( i = 0 ; i< p_playlist->current.i_size; i++ )
    {
        if( ARRAY_VAL( p_playlist->current, i ) == p_cur )
        {
            p_playlist->i_current_index = i;
            break;
        }
    }
    PL_DEBUG( "%s is at %i", PLI_NAME( p_cur ), p_playlist->i_current_index );
Laurent Aimar's avatar
Laurent Aimar committed
137 138
}

139 140 141 142 143 144 145 146
/**
 * Reset the currently playing playlist.
 *
 * \param p_playlist the playlist structure
 * \param p_cur the current playlist item
 * \return nothing
 */
void ResetCurrentlyPlaying( playlist_t *p_playlist,
Laurent Aimar's avatar
Laurent Aimar committed
147 148
                                   playlist_item_t *p_cur )
{
149 150
    playlist_private_t *p_sys = pl_priv(p_playlist);

Laurent Aimar's avatar
Laurent Aimar committed
151
    PL_DEBUG( "rebuilding array of current - root %s",
152
              PLI_NAME( p_sys->status.p_node ) );
Laurent Aimar's avatar
Laurent Aimar committed
153 154
    ARRAY_RESET( p_playlist->current );
    p_playlist->i_current_index = -1;
155 156 157
    for( playlist_item_t *p_next = NULL; ; )
    {
        /** FIXME: this is *slow* */
Laurent Aimar's avatar
Laurent Aimar committed
158
        p_next = playlist_GetNextLeaf( p_playlist,
159
                                       p_sys->status.p_node,
Laurent Aimar's avatar
Laurent Aimar committed
160
                                       p_next, true, false );
161 162 163 164 165 166
        if( !p_next )
            break;

        if( p_next == p_cur )
            p_playlist->i_current_index = p_playlist->current.i_size;
        ARRAY_APPEND( p_playlist->current, p_next);
Laurent Aimar's avatar
Laurent Aimar committed
167 168 169
    }
    PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
                                                  p_playlist->i_current_index);
170

171
    if( var_GetBool( p_playlist, "random" ) && ( p_playlist->current.i_size > 0 ) )
Laurent Aimar's avatar
Laurent Aimar committed
172 173
    {
        /* Shuffle the array */
174
        for( unsigned j = p_playlist->current.i_size - 1; j > 0; j-- )
Laurent Aimar's avatar
Laurent Aimar committed
175
        {
176
            unsigned i = vlc_lrand48() % (j+1); /* between 0 and j */
Laurent Aimar's avatar
Laurent Aimar committed
177 178 179 180 181 182 183
            playlist_item_t *p_tmp;
            /* swap the two items */
            p_tmp = ARRAY_VAL(p_playlist->current, i);
            ARRAY_VAL(p_playlist->current,i) = ARRAY_VAL(p_playlist->current,j);
            ARRAY_VAL(p_playlist->current,j) = p_tmp;
        }
    }
184
    p_sys->b_reset_currently_playing = false;
Laurent Aimar's avatar
Laurent Aimar committed
185 186 187 188 189 190 191 192 193
}


/**
 * Start the input for an item
 *
 * \param p_playlist the playlist object
 * \param p_item the item to play
 */
194
static bool PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
Laurent Aimar's avatar
Laurent Aimar committed
195
{
196
    playlist_private_t *p_sys = pl_priv(p_playlist);
Laurent Aimar's avatar
Laurent Aimar committed
197 198
    input_item_t *p_input = p_item->p_input;

199 200
    PL_ASSERT_LOCKED;

Laurent Aimar's avatar
Laurent Aimar committed
201 202
    msg_Dbg( p_playlist, "creating new input thread" );

203
    p_item->i_nb_played++;
Laurent Aimar's avatar
Laurent Aimar committed
204
    set_current_status_item( p_playlist, p_item );
205
    assert( p_sys->p_input == NULL );
206
    PL_UNLOCK;
207

208 209 210
    input_thread_t *p_input_thread = input_Create( p_playlist, p_input, NULL,
                                                   p_sys->p_input_resource );
    if( likely(p_input_thread != NULL) )
211
    {
212 213
        var_AddCallback( p_input_thread, "intf-event",
                         InputEvent, p_playlist );
214

215
        if( input_Start( p_input_thread ) )
216
        {
217 218
            var_DelCallback( p_input_thread, "intf-event",
                             InputEvent, p_playlist );
219
            vlc_object_release( p_input_thread );
220
            p_input_thread = NULL;
221
        }
222
    }
Laurent Aimar's avatar
Laurent Aimar committed
223 224

    /* TODO store art policy in playlist private data */
225 226 227
    char *psz_arturl = input_item_GetArtURL( p_input );
    /* p_input->p_meta should not be null after a successful CreateThread */
    bool b_has_art = !EMPTY_STR( psz_arturl );
Laurent Aimar's avatar
Laurent Aimar committed
228

229 230
    if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
    {
231
        PL_DEBUG( "requesting art for new input thread" );
232
        libvlc_ArtRequest( p_playlist->p_libvlc, p_input, META_REQUEST_OPTION_NONE );
Laurent Aimar's avatar
Laurent Aimar committed
233
    }
234 235
    free( psz_arturl );

236 237 238 239
    PL_LOCK;
    p_sys->p_input = p_input_thread;
    PL_UNLOCK;

240
    var_SetAddress( p_playlist, "input-current", p_input_thread );
241

Laurent Aimar's avatar
Laurent Aimar committed
242
    PL_LOCK;
243
    return p_input_thread != NULL;
Laurent Aimar's avatar
Laurent Aimar committed
244 245 246 247 248 249 250 251 252
}

/**
 * Compute the next playlist item depending on
 * the playlist course mode (forward, backward, random, view,...).
 *
 * \param p_playlist the playlist object
 * \return nothing
 */
253
static playlist_item_t *NextItem( playlist_t *p_playlist )
Laurent Aimar's avatar
Laurent Aimar committed
254
{
255
    playlist_private_t *p_sys = pl_priv(p_playlist);
Laurent Aimar's avatar
Laurent Aimar committed
256
    playlist_item_t *p_new = NULL;
257 258 259 260
    bool requested = p_sys->request.b_request;

    /* Clear the request */
    p_sys->request.b_request = false;
Laurent Aimar's avatar
Laurent Aimar committed
261 262 263 264 265 266 267 268 269 270

    /* Handle quickly a few special cases */
    /* No items to play */
    if( p_playlist->items.i_size == 0 )
    {
        msg_Info( p_playlist, "playlist is empty" );
        return NULL;
    }

    /* Start the real work */
271
    if( requested )
Laurent Aimar's avatar
Laurent Aimar committed
272
    {
273
        p_new = p_sys->request.p_item;
274 275 276 277

        if( p_new == NULL && p_sys->request.p_node == NULL )
            return NULL; /* Stop request! */

278
        int i_skip = p_sys->request.i_skip;
279
        PL_DEBUG( "processing request item: %s, node: %s, skip: %i",
280 281
                        PLI_NAME( p_sys->request.p_item ),
                        PLI_NAME( p_sys->request.p_node ), i_skip );
Laurent Aimar's avatar
Laurent Aimar committed
282

283 284
        if( p_sys->request.p_node &&
            p_sys->request.p_node != get_current_status_node( p_playlist ) )
Laurent Aimar's avatar
Laurent Aimar committed
285 286
        {

287 288 289
            set_current_status_node( p_playlist, p_sys->request.p_node );
            p_sys->request.p_node = NULL;
            p_sys->b_reset_currently_playing = true;
Laurent Aimar's avatar
Laurent Aimar committed
290 291 292 293 294 295 296 297 298
        }

        /* If we are asked for a node, go to it's first child */
        if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
        {
            i_skip++;
            if( p_new != NULL )
            {
                p_new = playlist_GetNextLeaf( p_playlist, p_new, NULL, true, false );
299
                for( int i = 0; i < p_playlist->current.i_size; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
300 301 302 303 304 305 306 307 308 309
                {
                    if( p_new == ARRAY_VAL( p_playlist->current, i ) )
                    {
                        p_playlist->i_current_index = i;
                        i_skip = 0;
                    }
                }
            }
        }

310
        if( p_sys->b_reset_currently_playing )
Laurent Aimar's avatar
Laurent Aimar committed
311
            /* A bit too bad to reset twice ... */
312
            ResetCurrentlyPlaying( p_playlist, p_new );
Laurent Aimar's avatar
Laurent Aimar committed
313 314 315 316 317 318 319 320 321
        else if( p_new )
            ResyncCurrentIndex( p_playlist, p_new );
        else
            p_playlist->i_current_index = -1;

        if( p_playlist->current.i_size && (i_skip > 0) )
        {
            if( p_playlist->i_current_index < -1 )
                p_playlist->i_current_index = -1;
322
            for( int i = i_skip; i > 0 ; i-- )
Laurent Aimar's avatar
Laurent Aimar committed
323 324 325 326 327
            {
                p_playlist->i_current_index++;
                if( p_playlist->i_current_index >= p_playlist->current.i_size )
                {
                    PL_DEBUG( "looping - restarting at beginning of node" );
Alex Warhawk's avatar
Alex Warhawk committed
328 329 330 331 332 333
                    /* reshuffle playlist when end is reached */
                    if( var_GetBool( p_playlist, "random" ) ) {
                        PL_DEBUG( "reshuffle playlist" );
                        ResetCurrentlyPlaying( p_playlist,
                                get_current_status_item( p_playlist ) );
                    }
Laurent Aimar's avatar
Laurent Aimar committed
334 335 336 337 338 339 340 341
                    p_playlist->i_current_index = 0;
                }
            }
            p_new = ARRAY_VAL( p_playlist->current,
                               p_playlist->i_current_index );
        }
        else if( p_playlist->current.i_size && (i_skip < 0) )
        {
342
            for( int i = i_skip; i < 0 ; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
343 344 345 346 347
            {
                p_playlist->i_current_index--;
                if( p_playlist->i_current_index <= -1 )
                {
                    PL_DEBUG( "looping - restarting at end of node" );
Alex Warhawk's avatar
Alex Warhawk committed
348 349 350 351 352 353
                    /* reshuffle playlist when beginning is reached */
                    if( var_GetBool( p_playlist, "random" ) ) {
                        PL_DEBUG( "reshuffle playlist" );
                        ResetCurrentlyPlaying( p_playlist,
                                get_current_status_item( p_playlist ) );
                    }
Laurent Aimar's avatar
Laurent Aimar committed
354 355 356 357 358 359 360 361 362 363
                    p_playlist->i_current_index = p_playlist->current.i_size-1;
                }
            }
            p_new = ARRAY_VAL( p_playlist->current,
                               p_playlist->i_current_index );
        }
    }
    /* "Automatic" item change ( next ) */
    else
    {
364 365
        bool b_loop = var_GetBool( p_playlist, "loop" );
        bool b_repeat = var_GetBool( p_playlist, "repeat" );
366
        bool b_playstop = var_InheritBool( p_playlist, "play-and-stop" );
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394

        /* Repeat and play/stop */
        if( b_repeat && get_current_status_item( p_playlist ) )
        {
            msg_Dbg( p_playlist,"repeating item" );
            return get_current_status_item( p_playlist );
        }
        if( b_playstop )
        {
            msg_Dbg( p_playlist,"stopping (play and stop)" );
            return NULL;
        }

        /* */
        if( get_current_status_item( p_playlist ) )
        {
            playlist_item_t *p_parent = get_current_status_item( p_playlist );
            while( p_parent )
            {
                if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
                {
                    msg_Dbg( p_playlist, "blocking item, stopping") ;
                    return NULL;
                }
                p_parent = p_parent->p_parent;
            }
        }

Laurent Aimar's avatar
Laurent Aimar committed
395 396
        PL_DEBUG( "changing item without a request (current %i/%i)",
                  p_playlist->i_current_index, p_playlist->current.i_size );
397
        /* Can't go to next from current item */
Laurent Aimar's avatar
Laurent Aimar committed
398 399 400 401
        if( get_current_status_item( p_playlist ) &&
            get_current_status_item( p_playlist )->i_flags & PLAYLIST_SKIP_FLAG )
            return NULL;

402 403
        if( p_sys->b_reset_currently_playing )
            ResetCurrentlyPlaying( p_playlist,
Laurent Aimar's avatar
Laurent Aimar committed
404 405 406 407 408 409
                                   get_current_status_item( p_playlist ) );

        p_playlist->i_current_index++;
        assert( p_playlist->i_current_index <= p_playlist->current.i_size );
        if( p_playlist->i_current_index == p_playlist->current.i_size )
        {
410 411
            if( !b_loop || p_playlist->current.i_size == 0 )
                return NULL;
Alex Warhawk's avatar
Alex Warhawk committed
412 413 414 415 416 417
            /* reshuffle after last item has been played */
            if( var_GetBool( p_playlist, "random" ) ) {
                PL_DEBUG( "reshuffle playlist" );
                ResetCurrentlyPlaying( p_playlist,
                                       get_current_status_item( p_playlist ) );
            }
Laurent Aimar's avatar
Laurent Aimar committed
418 419 420
            p_playlist->i_current_index = 0;
        }
        PL_DEBUG( "using item %i", p_playlist->i_current_index );
421 422
        if ( p_playlist->current.i_size == 0 )
            return NULL;
Laurent Aimar's avatar
Laurent Aimar committed
423 424 425 426 427 428 429 430 431

        p_new = ARRAY_VAL( p_playlist->current, p_playlist->i_current_index );
        /* The new item can't be autoselected  */
        if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
            return NULL;
    }
    return p_new;
}

432
static void LoopInput( playlist_t *p_playlist )
Laurent Aimar's avatar
Laurent Aimar committed
433
{
434 435
    playlist_private_t *p_sys = pl_priv(p_playlist);
    input_thread_t *p_input = p_sys->p_input;
Laurent Aimar's avatar
Laurent Aimar committed
436

437
    assert( p_input != NULL );
Laurent Aimar's avatar
Laurent Aimar committed
438

439
    if( p_sys->request.b_request || p_sys->killed )
Laurent Aimar's avatar
Laurent Aimar committed
440
    {
441
        PL_DEBUG( "incoming request - stopping current input" );
442
        input_Stop( p_input );
Laurent Aimar's avatar
Laurent Aimar committed
443 444
    }

445
    switch( var_GetInteger( p_input, "state" ) )
Laurent Aimar's avatar
Laurent Aimar committed
446
    {
447 448 449
    case END_S:
    case ERROR_S:
    /* This input is dead. Remove it ! */
450
        p_sys->p_input = NULL;
451
        PL_DEBUG( "dead input" );
452 453
        PL_UNLOCK;

454 455
        var_SetAddress( p_playlist, "input-current", NULL );

456 457
        /* WARNING: Input resource manipulation and callback deletion are
         * incompatible with the playlist lock. */
458
        if( !var_InheritBool( p_input, "sout-keep" ) )
459
            input_resource_TerminateSout( p_sys->p_input_resource );
460
        var_DelCallback( p_input, "intf-event", InputEvent, p_playlist );
461

462
        input_Close( p_input );
463
        PL_LOCK;
464 465 466
        break;
    default:
        vlc_cond_wait( &p_sys->signal, &p_sys->lock );
467 468
    }
}
469

470
static bool Next( playlist_t *p_playlist )
471 472
{
    playlist_item_t *p_item = NextItem( p_playlist );
473 474
    if( p_item == NULL )
        return false;
Laurent Aimar's avatar
Laurent Aimar committed
475

476 477 478
    msg_Dbg( p_playlist, "starting playback of new item" );
    ResyncCurrentIndex( p_playlist, p_item );
    return PlayItem( p_playlist, p_item );
Laurent Aimar's avatar
Laurent Aimar committed
479 480
}

481 482 483
/**
 * Run the main control thread itself
 */
484
static void *Thread ( void *data )
485
{
486
    playlist_t *p_playlist = data;
487
    playlist_private_t *p_sys = pl_priv(p_playlist);
488

489
    PL_LOCK;
490
    while( !p_sys->killed )
491
    {
492 493 494 495 496 497 498 499
        /* Playlist in stopped state */
        assert(p_sys->p_input == NULL);

        if( !p_sys->request.b_request )
        {
            vlc_cond_wait( &p_sys->signal, &p_sys->lock );
            continue;
        }
500

501 502 503
        while( !p_sys->killed && Next( p_playlist ) )
        {   /* Playlist in running state */
            assert(p_sys->p_input != NULL);
504

505 506 507 508
            do
                LoopInput( p_playlist );
            while( p_sys->p_input != NULL );
        }
509

510 511 512 513 514 515 516 517 518
        msg_Dbg( p_playlist, "nothing to play" );
        if( var_InheritBool( p_playlist, "play-and-exit" ) )
        {
            msg_Info( p_playlist, "end of playlist, exiting" );
            libvlc_Quit( p_playlist->p_libvlc );
        }

        /* Destroy any video display now (XXX: ugly hack) */
        if( input_resource_HasVout( p_sys->p_input_resource ) )
519 520 521 522 523
        {
            PL_UNLOCK; /* Mind: NO LOCKS while manipulating input resources! */
            input_resource_TerminateVout( p_sys->p_input_resource );
            PL_LOCK;
        }
524
    }
525
    PL_UNLOCK;
526

527
    input_resource_Terminate( p_sys->p_input_resource );
528
    return NULL;
529
}