thread.c 17.5 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 "stream_output/stream_output.h"
37
#include "playlist_internal.h"
38 39 40 41

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

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

/**
49
 * Create the main playlist threads.
50 51 52 53 54 55
 * Additionally to the playlist, this thread controls :
 *    - Statistics
 *    - VLM
 * \param p_parent
 * \return an object with a started thread
 */
56
void playlist_Activate( playlist_t *p_playlist )
57
{
58 59
    /* */
    playlist_private_t *p_sys = pl_priv(p_playlist);
60

61 62 63 64
    p_sys->p_input_resource = input_resource_New( VLC_OBJECT( p_playlist ) );
    if( unlikely(p_sys->p_input_resource == NULL) )
        abort();

65
    /* Start the playlist thread */
66 67
    if( vlc_clone( &p_sys->thread, Thread, p_playlist,
                   VLC_THREAD_PRIORITY_LOW ) )
68 69 70
    {
        msg_Err( p_playlist, "cannot spawn playlist thread" );
    }
71
    msg_Dbg( p_playlist, "playlist threads correctly activated" );
72 73 74 75 76 77 78
}

void playlist_Deactivate( playlist_t *p_playlist )
{
    /* */
    playlist_private_t *p_sys = pl_priv(p_playlist);

79
    msg_Dbg( p_playlist, "deactivating the playlist" );
80

81
    PL_LOCK;
82
    p_sys->killed = true;
83 84 85
    vlc_cond_signal( &p_sys->signal );
    PL_UNLOCK;

86
    vlc_join( p_sys->thread, NULL );
87
    assert( !p_sys->p_input );
88

89
    /* release input resources */
90
    input_resource_Release( p_sys->p_input_resource );
91

92 93
    if( var_InheritBool( p_playlist, "media-library" ) )
        playlist_MLDump( p_playlist );
94 95 96 97 98 99 100 101 102 103 104

    PL_LOCK;

    /* Release the current node */
    set_current_status_node( p_playlist, NULL );

    /* Release the current item */
    set_current_status_item( p_playlist, NULL );

    PL_UNLOCK;

105
    msg_Dbg( p_playlist, "playlist correctly deactivated" );
106 107
}

Laurent Aimar's avatar
Laurent Aimar committed
108 109 110 111 112 113 114 115 116 117
/* */

/* 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 &&
118
        newval.i_int != INPUT_EVENT_DEAD )
Laurent Aimar's avatar
Laurent Aimar committed
119 120 121 122
        return VLC_SUCCESS;

    PL_LOCK;

123 124
    /* XXX: signaling while not changing any parameter... suspicious... */
    vlc_cond_signal( &pl_priv(p_playlist)->signal );
Laurent Aimar's avatar
Laurent Aimar committed
125 126 127 128 129 130 131 132 133 134 135 136 137

    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
 */
138
void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur )
Laurent Aimar's avatar
Laurent Aimar committed
139
{
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
    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
155 156
}

157 158 159 160 161 162 163 164
/**
 * 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
165 166
                                   playlist_item_t *p_cur )
{
167 168
    playlist_private_t *p_sys = pl_priv(p_playlist);

Laurent Aimar's avatar
Laurent Aimar committed
169
    PL_DEBUG( "rebuilding array of current - root %s",
170
              PLI_NAME( p_sys->status.p_node ) );
Laurent Aimar's avatar
Laurent Aimar committed
171 172
    ARRAY_RESET( p_playlist->current );
    p_playlist->i_current_index = -1;
173 174 175
    for( playlist_item_t *p_next = NULL; ; )
    {
        /** FIXME: this is *slow* */
Laurent Aimar's avatar
Laurent Aimar committed
176
        p_next = playlist_GetNextLeaf( p_playlist,
177
                                       p_sys->status.p_node,
Laurent Aimar's avatar
Laurent Aimar committed
178
                                       p_next, true, false );
179 180 181 182 183 184
        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
185 186 187
    }
    PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
                                                  p_playlist->i_current_index);
188

189
    if( var_GetBool( p_playlist, "random" ) && ( p_playlist->current.i_size > 0 ) )
Laurent Aimar's avatar
Laurent Aimar committed
190 191
    {
        /* Shuffle the array */
192
        for( unsigned j = p_playlist->current.i_size - 1; j > 0; j-- )
Laurent Aimar's avatar
Laurent Aimar committed
193
        {
194
            unsigned i = vlc_lrand48() % (j+1); /* between 0 and j */
Laurent Aimar's avatar
Laurent Aimar committed
195 196 197 198 199 200 201
            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;
        }
    }
202
    p_sys->b_reset_currently_playing = false;
Laurent Aimar's avatar
Laurent Aimar committed
203 204 205 206 207 208 209 210 211 212 213 214
}


/**
 * Start the input for an item
 *
 * \param p_playlist the playlist object
 * \param p_item the item to play
 * \return nothing
 */
static int PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
{
215
    playlist_private_t *p_sys = pl_priv(p_playlist);
Laurent Aimar's avatar
Laurent Aimar committed
216 217
    input_item_t *p_input = p_item->p_input;

218 219
    PL_ASSERT_LOCKED;

Laurent Aimar's avatar
Laurent Aimar committed
220 221 222 223 224
    msg_Dbg( p_playlist, "creating new input thread" );

    p_input->i_nb_played++;
    set_current_status_item( p_playlist, p_item );

225
    p_sys->status.i_status = PLAYLIST_RUNNING;
Laurent Aimar's avatar
Laurent Aimar committed
226

227
    assert( p_sys->p_input == NULL );
228

229
    input_thread_t *p_input_thread = input_Create( p_playlist, p_input, NULL, p_sys->p_input_resource );
230 231
    if( p_input_thread )
    {
232
        p_sys->p_input = p_input_thread;
233
        var_AddCallback( p_input_thread, "intf-event", InputEvent, p_playlist );
234

235 236
        var_SetAddress( p_playlist, "input-current", p_input_thread );

237 238 239 240 241
        if( input_Start( p_sys->p_input ) )
        {
            vlc_object_release( p_input_thread );
            p_sys->p_input = p_input_thread = NULL;
        }
242
    }
Laurent Aimar's avatar
Laurent Aimar committed
243

244 245 246
    bool b_find_art = var_GetInteger( p_playlist, "album-art" )
                                                      == ALBUM_ART_WHEN_PLAYED;
    if( b_find_art )
Laurent Aimar's avatar
Laurent Aimar committed
247
    {
248 249 250 251
        char *psz_uri = input_item_GetURI( p_item->p_input );
        if( psz_uri != NULL && (!strncmp( psz_uri, "directory:", 10 ) ||
                                !strncmp( psz_uri, "vlc:", 4 )) )
            b_find_art = false;
Laurent Aimar's avatar
Laurent Aimar committed
252 253 254 255
        free( psz_uri );
    }

    /* TODO store art policy in playlist private data */
256
    if( b_find_art )
Laurent Aimar's avatar
Laurent Aimar committed
257
    {
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
258 259
        char *psz_arturl = input_item_GetArtURL( p_input );
        char *psz_name = input_item_GetName( p_input );
Konstantin Pavlov's avatar
Konstantin Pavlov committed
260
        /* p_input->p_meta should not be null after a successful CreateThread */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
261
        bool b_has_art = !EMPTY_STR( psz_arturl );
Laurent Aimar's avatar
Laurent Aimar committed
262 263 264 265

        if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
        {
            PL_DEBUG( "requesting art for %s", psz_name );
266
            playlist_AskForArtEnqueue( p_playlist, p_input );
Laurent Aimar's avatar
Laurent Aimar committed
267 268 269 270 271
        }
        free( psz_arturl );
        free( psz_name );
    }
    PL_UNLOCK;
272
    var_TriggerCallback( p_playlist, "activity" );
Laurent Aimar's avatar
Laurent Aimar committed
273 274 275 276 277 278 279 280 281 282 283 284
    PL_LOCK;

    return VLC_SUCCESS;
}

/**
 * Compute the next playlist item depending on
 * the playlist course mode (forward, backward, random, view,...).
 *
 * \param p_playlist the playlist object
 * \return nothing
 */
285
static playlist_item_t *NextItem( playlist_t *p_playlist )
Laurent Aimar's avatar
Laurent Aimar committed
286
{
287
    playlist_private_t *p_sys = pl_priv(p_playlist);
Laurent Aimar's avatar
Laurent Aimar committed
288 289 290 291 292 293 294 295 296 297 298
    playlist_item_t *p_new = NULL;

    /* 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 */
299
    if( p_sys->request.b_request )
Laurent Aimar's avatar
Laurent Aimar committed
300
    {
301 302
        p_new = p_sys->request.p_item;
        int i_skip = p_sys->request.i_skip;
303
        PL_DEBUG( "processing request item: %s, node: %s, skip: %i",
304 305
                        PLI_NAME( p_sys->request.p_item ),
                        PLI_NAME( p_sys->request.p_node ), i_skip );
Laurent Aimar's avatar
Laurent Aimar committed
306

307 308
        if( p_sys->request.p_node &&
            p_sys->request.p_node != get_current_status_node( p_playlist ) )
Laurent Aimar's avatar
Laurent Aimar committed
309 310
        {

311 312 313
            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
314 315 316 317 318 319 320 321 322
        }

        /* 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 );
323
                for( int i = 0; i < p_playlist->current.i_size; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
324 325 326 327 328 329 330 331 332 333
                {
                    if( p_new == ARRAY_VAL( p_playlist->current, i ) )
                    {
                        p_playlist->i_current_index = i;
                        i_skip = 0;
                    }
                }
            }
        }

334
        if( p_sys->b_reset_currently_playing )
Laurent Aimar's avatar
Laurent Aimar committed
335
            /* A bit too bad to reset twice ... */
336
            ResetCurrentlyPlaying( p_playlist, p_new );
Laurent Aimar's avatar
Laurent Aimar committed
337 338 339 340 341 342 343 344 345
        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;
346
            for( int i = i_skip; i > 0 ; i-- )
Laurent Aimar's avatar
Laurent Aimar committed
347 348 349 350 351 352 353 354 355 356 357 358 359
            {
                p_playlist->i_current_index++;
                if( p_playlist->i_current_index >= p_playlist->current.i_size )
                {
                    PL_DEBUG( "looping - restarting at beginning of node" );
                    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) )
        {
360
            for( int i = i_skip; i < 0 ; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
361 362 363 364 365 366 367 368 369 370 371 372
            {
                p_playlist->i_current_index--;
                if( p_playlist->i_current_index <= -1 )
                {
                    PL_DEBUG( "looping - restarting at end of node" );
                    p_playlist->i_current_index = p_playlist->current.i_size-1;
                }
            }
            p_new = ARRAY_VAL( p_playlist->current,
                               p_playlist->i_current_index );
        }
        /* Clear the request */
373
        p_sys->request.b_request = false;
Laurent Aimar's avatar
Laurent Aimar committed
374 375 376 377
    }
    /* "Automatic" item change ( next ) */
    else
    {
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
        bool b_loop = var_GetBool( p_playlist, "loop" );
        bool b_repeat = var_GetBool( p_playlist, "repeat" );
        bool b_playstop = var_GetBool( p_playlist, "play-and-stop" );

        /* 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
409 410 411 412 413 414 415
        PL_DEBUG( "changing item without a request (current %i/%i)",
                  p_playlist->i_current_index, p_playlist->current.i_size );
        /* Cant go to next from current item */
        if( get_current_status_item( p_playlist ) &&
            get_current_status_item( p_playlist )->i_flags & PLAYLIST_SKIP_FLAG )
            return NULL;

416 417
        if( p_sys->b_reset_currently_playing )
            ResetCurrentlyPlaying( p_playlist,
Laurent Aimar's avatar
Laurent Aimar committed
418 419 420 421 422 423
                                   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 )
        {
424 425
            if( !b_loop || p_playlist->current.i_size == 0 )
                return NULL;
Laurent Aimar's avatar
Laurent Aimar committed
426 427 428
            p_playlist->i_current_index = 0;
        }
        PL_DEBUG( "using item %i", p_playlist->i_current_index );
429 430
        if ( p_playlist->current.i_size == 0 )
            return NULL;
Laurent Aimar's avatar
Laurent Aimar committed
431 432 433 434 435 436 437 438 439

        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;
}

440
static void LoopInput( playlist_t *p_playlist )
Laurent Aimar's avatar
Laurent Aimar committed
441
{
442 443
    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
444

445
    assert( p_input != NULL );
Laurent Aimar's avatar
Laurent Aimar committed
446

447
    if( p_sys->request.b_request || p_sys->killed )
Laurent Aimar's avatar
Laurent Aimar committed
448
    {
449
        PL_DEBUG( "incoming request - stopping current input" );
450
        input_Stop( p_input, true );
Laurent Aimar's avatar
Laurent Aimar committed
451 452
    }

453
#warning Unsynchronized access to *p_input flags...
454 455
    /* This input is dead. Remove it ! */
    if( p_input->b_dead )
Laurent Aimar's avatar
Laurent Aimar committed
456
    {
457
        p_sys->p_input = NULL;
458
        PL_DEBUG( "dead input" );
459 460
        PL_UNLOCK;

461 462
        /* WARNING: Input resource manipulation and callback deletion are
         * incompatible with the playlist lock. */
463
        if( !var_InheritBool( p_input, "sout-keep" ) )
464
            input_resource_TerminateSout( p_sys->p_input_resource );
465
        var_DelCallback( p_input, "intf-event", InputEvent, p_playlist );
466

467
        input_Close( p_input );
468
        var_TriggerCallback( p_playlist, "activity" );
469
        PL_LOCK;
470
        return;
471 472 473 474 475
    }
    /* This input has finished, ask it to die ! */
    else if( p_input->b_error || p_input->b_eof )
    {
        PL_DEBUG( "finished input" );
476
        input_Stop( p_input, false );
477
    }
478 479

    vlc_cond_wait( &p_sys->signal, &p_sys->lock );
480
}
481

482 483 484 485
static void LoopRequest( playlist_t *p_playlist )
{
    playlist_private_t *p_sys = pl_priv(p_playlist);
    assert( !p_sys->p_input );
Laurent Aimar's avatar
Laurent Aimar committed
486

487 488 489 490 491 492 493 494 495
    /* No input. Several cases
     *  - No request, running status -> start new item
     *  - No request, stopped status -> collect garbage
     *  - Request, running requested -> start new item
     *  - Request, stopped requested -> collect garbage
    */
    const int i_status = p_sys->request.b_request ?
                         p_sys->request.i_status : p_sys->status.i_status;

496
    if( i_status == PLAYLIST_STOPPED )
497 498
    {
        p_sys->status.i_status = PLAYLIST_STOPPED;
499
        vlc_cond_wait( &p_sys->signal, &p_sys->lock );
500
        return;
Laurent Aimar's avatar
Laurent Aimar committed
501
    }
502 503 504

    playlist_item_t *p_item = NextItem( p_playlist );
    if( p_item )
Laurent Aimar's avatar
Laurent Aimar committed
505
    {
506
        msg_Dbg( p_playlist, "starting playback of the new playlist item" );
507
        ResyncCurrentIndex( p_playlist, p_item );
508 509 510
        PlayItem( p_playlist, p_item );
        return;
    }
Laurent Aimar's avatar
Laurent Aimar committed
511

512 513
    msg_Dbg( p_playlist, "nothing to play" );
    p_sys->status.i_status = PLAYLIST_STOPPED;
Laurent Aimar's avatar
Laurent Aimar committed
514

515 516 517
    if( var_GetBool( p_playlist, "play-and-exit" ) )
    {
        msg_Info( p_playlist, "end of playlist, exiting" );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
518
        libvlc_Quit( p_playlist->p_libvlc );
Laurent Aimar's avatar
Laurent Aimar committed
519 520 521
    }
}

522 523 524
/**
 * Run the main control thread itself
 */
525
static void *Thread ( void *data )
526
{
527
    playlist_t *p_playlist = data;
528
    playlist_private_t *p_sys = pl_priv(p_playlist);
529

530
    playlist_Lock( p_playlist );
531
    for( ;; )
532
    {
533 534
        while( p_sys->p_input != NULL )
            LoopInput( p_playlist );
535

536 537 538 539 540 541 542 543 544 545 546 547
        if( p_sys->killed )
            break; /* THE END */

        /* Destroy any video display if the playlist is stopped */
        if( p_sys->status.i_status == PLAYLIST_STOPPED
         && input_resource_HasVout( p_sys->p_input_resource ) )
        {
            PL_UNLOCK; /* Mind: NO LOCKS while manipulating input resources! */
            input_resource_TerminateVout( p_sys->p_input_resource );
            PL_LOCK;
            continue; /* lost lock = lost state */
        }
548 549

        LoopRequest( p_playlist );
550
    }
551
    p_sys->status.i_status = PLAYLIST_STOPPED;
552
    playlist_Unlock( p_playlist );
553

554
    input_resource_Terminate( p_sys->p_input_resource );
555
    return NULL;
556
}