thread.c 17.2 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
 * Creates the main playlist thread.
50
 */
51
void playlist_Activate( playlist_t *p_playlist )
52
{
53
    playlist_private_t *p_sys = pl_priv(p_playlist);
54

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

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

72
    PL_LOCK;
73 74 75 76 77 78 79 80 81 82 83
    /* 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" );
84
    p_sys->killed = true;
85 86 87
    vlc_cond_signal( &p_sys->signal );
    PL_UNLOCK;

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

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

/* 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 &&
101
        newval.i_int != INPUT_EVENT_DEAD )
Laurent Aimar's avatar
Laurent Aimar committed
102 103 104 105
        return VLC_SUCCESS;

    PL_LOCK;

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

    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
 */
121
void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur )
Laurent Aimar's avatar
Laurent Aimar committed
122
{
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
    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
138 139
}

140 141 142 143 144 145 146 147
/**
 * 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
148 149
                                   playlist_item_t *p_cur )
{
150 151
    playlist_private_t *p_sys = pl_priv(p_playlist);

Laurent Aimar's avatar
Laurent Aimar committed
152
    PL_DEBUG( "rebuilding array of current - root %s",
153
              PLI_NAME( p_sys->status.p_node ) );
Laurent Aimar's avatar
Laurent Aimar committed
154 155
    ARRAY_RESET( p_playlist->current );
    p_playlist->i_current_index = -1;
156 157 158
    for( playlist_item_t *p_next = NULL; ; )
    {
        /** FIXME: this is *slow* */
Laurent Aimar's avatar
Laurent Aimar committed
159
        p_next = playlist_GetNextLeaf( p_playlist,
160
                                       p_sys->status.p_node,
Laurent Aimar's avatar
Laurent Aimar committed
161
                                       p_next, true, false );
162 163 164 165 166 167
        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
168 169 170
    }
    PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
                                                  p_playlist->i_current_index);
171

172
    if( var_GetBool( p_playlist, "random" ) && ( p_playlist->current.i_size > 0 ) )
Laurent Aimar's avatar
Laurent Aimar committed
173 174
    {
        /* Shuffle the array */
175
        for( unsigned j = p_playlist->current.i_size - 1; j > 0; j-- )
Laurent Aimar's avatar
Laurent Aimar committed
176
        {
177
            unsigned i = vlc_lrand48() % (j+1); /* between 0 and j */
Laurent Aimar's avatar
Laurent Aimar committed
178 179 180 181 182 183 184
            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;
        }
    }
185
    p_sys->b_reset_currently_playing = false;
Laurent Aimar's avatar
Laurent Aimar committed
186 187 188 189 190 191 192 193 194 195 196 197
}


/**
 * 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 )
{
198
    playlist_private_t *p_sys = pl_priv(p_playlist);
Laurent Aimar's avatar
Laurent Aimar committed
199 200
    input_item_t *p_input = p_item->p_input;

201 202
    PL_ASSERT_LOCKED;

Laurent Aimar's avatar
Laurent Aimar committed
203 204 205 206 207
    msg_Dbg( p_playlist, "creating new input thread" );

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

208
    p_sys->status.i_status = PLAYLIST_RUNNING;
Laurent Aimar's avatar
Laurent Aimar committed
209

210
    assert( p_sys->p_input == NULL );
211

212
    input_thread_t *p_input_thread = input_Create( p_playlist, p_input, NULL, p_sys->p_input_resource );
213 214
    if( p_input_thread )
    {
215
        p_sys->p_input = p_input_thread;
216
        var_AddCallback( p_input_thread, "intf-event", InputEvent, p_playlist );
217

218 219
        var_SetAddress( p_playlist, "input-current", p_input_thread );

220 221 222 223 224
        if( input_Start( p_sys->p_input ) )
        {
            vlc_object_release( p_input_thread );
            p_sys->p_input = p_input_thread = NULL;
        }
225
    }
Laurent Aimar's avatar
Laurent Aimar committed
226

227 228 229
    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
230
    {
231 232 233 234
        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
235 236 237 238
        free( psz_uri );
    }

    /* TODO store art policy in playlist private data */
239
    if( b_find_art )
Laurent Aimar's avatar
Laurent Aimar committed
240
    {
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
241 242
        char *psz_arturl = input_item_GetArtURL( p_input );
        char *psz_name = input_item_GetName( p_input );
Konstantin Pavlov's avatar
Konstantin Pavlov committed
243
        /* p_input->p_meta should not be null after a successful CreateThread */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
244
        bool b_has_art = !EMPTY_STR( psz_arturl );
Laurent Aimar's avatar
Laurent Aimar committed
245 246 247 248

        if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
        {
            PL_DEBUG( "requesting art for %s", psz_name );
249
            playlist_AskForArtEnqueue( p_playlist, p_input );
Laurent Aimar's avatar
Laurent Aimar committed
250 251 252 253 254
        }
        free( psz_arturl );
        free( psz_name );
    }
    PL_UNLOCK;
255
    var_TriggerCallback( p_playlist, "activity" );
Laurent Aimar's avatar
Laurent Aimar committed
256 257 258 259 260 261 262 263 264 265 266 267
    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
 */
268
static playlist_item_t *NextItem( playlist_t *p_playlist )
Laurent Aimar's avatar
Laurent Aimar committed
269
{
270
    playlist_private_t *p_sys = pl_priv(p_playlist);
Laurent Aimar's avatar
Laurent Aimar committed
271 272 273 274 275 276 277 278 279 280 281
    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 */
282
    if( p_sys->request.b_request )
Laurent Aimar's avatar
Laurent Aimar committed
283
    {
284 285
        p_new = p_sys->request.p_item;
        int i_skip = p_sys->request.i_skip;
286
        PL_DEBUG( "processing request item: %s, node: %s, skip: %i",
287 288
                        PLI_NAME( p_sys->request.p_item ),
                        PLI_NAME( p_sys->request.p_node ), i_skip );
Laurent Aimar's avatar
Laurent Aimar committed
289

290 291
        if( p_sys->request.p_node &&
            p_sys->request.p_node != get_current_status_node( p_playlist ) )
Laurent Aimar's avatar
Laurent Aimar committed
292 293
        {

294 295 296
            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
297 298 299 300 301 302 303 304 305
        }

        /* 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 );
306
                for( int i = 0; i < p_playlist->current.i_size; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
307 308 309 310 311 312 313 314 315 316
                {
                    if( p_new == ARRAY_VAL( p_playlist->current, i ) )
                    {
                        p_playlist->i_current_index = i;
                        i_skip = 0;
                    }
                }
            }
        }

317
        if( p_sys->b_reset_currently_playing )
Laurent Aimar's avatar
Laurent Aimar committed
318
            /* A bit too bad to reset twice ... */
319
            ResetCurrentlyPlaying( p_playlist, p_new );
Laurent Aimar's avatar
Laurent Aimar committed
320 321 322 323 324 325 326 327 328
        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;
329
            for( int i = i_skip; i > 0 ; i-- )
Laurent Aimar's avatar
Laurent Aimar committed
330 331 332 333 334 335 336 337 338 339 340 341 342
            {
                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) )
        {
343
            for( int i = i_skip; i < 0 ; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
344 345 346 347 348 349 350 351 352 353 354 355
            {
                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 */
356
        p_sys->request.b_request = false;
Laurent Aimar's avatar
Laurent Aimar committed
357 358 359 360
    }
    /* "Automatic" item change ( next ) */
    else
    {
361 362 363 364 365 366 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
        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
392 393 394 395 396 397 398
        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;

399 400
        if( p_sys->b_reset_currently_playing )
            ResetCurrentlyPlaying( p_playlist,
Laurent Aimar's avatar
Laurent Aimar committed
401 402 403 404 405 406
                                   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 )
        {
407 408
            if( !b_loop || p_playlist->current.i_size == 0 )
                return NULL;
Laurent Aimar's avatar
Laurent Aimar committed
409 410 411
            p_playlist->i_current_index = 0;
        }
        PL_DEBUG( "using item %i", p_playlist->i_current_index );
412 413
        if ( p_playlist->current.i_size == 0 )
            return NULL;
Laurent Aimar's avatar
Laurent Aimar committed
414 415 416 417 418 419 420 421 422

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

423
static void LoopInput( playlist_t *p_playlist )
Laurent Aimar's avatar
Laurent Aimar committed
424
{
425 426
    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
427

428
    assert( p_input != NULL );
Laurent Aimar's avatar
Laurent Aimar committed
429

430
    if( p_sys->request.b_request || p_sys->killed )
Laurent Aimar's avatar
Laurent Aimar committed
431
    {
432
        PL_DEBUG( "incoming request - stopping current input" );
433
        input_Stop( p_input, true );
Laurent Aimar's avatar
Laurent Aimar committed
434 435
    }

436
#warning Unsynchronized access to *p_input flags...
437 438
    /* This input is dead. Remove it ! */
    if( p_input->b_dead )
Laurent Aimar's avatar
Laurent Aimar committed
439
    {
440
        p_sys->p_input = NULL;
441
        PL_DEBUG( "dead input" );
442 443
        PL_UNLOCK;

444 445
        /* WARNING: Input resource manipulation and callback deletion are
         * incompatible with the playlist lock. */
446
        if( !var_InheritBool( p_input, "sout-keep" ) )
447
            input_resource_TerminateSout( p_sys->p_input_resource );
448
        var_DelCallback( p_input, "intf-event", InputEvent, p_playlist );
449

450
        input_Close( p_input );
451
        var_TriggerCallback( p_playlist, "activity" );
452
        PL_LOCK;
453
        return;
454 455 456 457 458
    }
    /* This input has finished, ask it to die ! */
    else if( p_input->b_error || p_input->b_eof )
    {
        PL_DEBUG( "finished input" );
459
        input_Stop( p_input, false );
460
    }
461 462

    vlc_cond_wait( &p_sys->signal, &p_sys->lock );
463
}
464

465
static void LoopRequest( playlist_t *p_playlist, int i_status )
466 467 468
{
    playlist_private_t *p_sys = pl_priv(p_playlist);
    assert( !p_sys->p_input );
Laurent Aimar's avatar
Laurent Aimar committed
469

470 471 472 473 474 475
    /* 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
    */
476
    if( i_status == PLAYLIST_STOPPED )
477 478
    {
        p_sys->status.i_status = PLAYLIST_STOPPED;
479
        vlc_cond_wait( &p_sys->signal, &p_sys->lock );
480
        return;
Laurent Aimar's avatar
Laurent Aimar committed
481
    }
482 483 484

    playlist_item_t *p_item = NextItem( p_playlist );
    if( p_item )
Laurent Aimar's avatar
Laurent Aimar committed
485
    {
486
        msg_Dbg( p_playlist, "starting playback of the new playlist item" );
487
        ResyncCurrentIndex( p_playlist, p_item );
488 489 490
        PlayItem( p_playlist, p_item );
        return;
    }
Laurent Aimar's avatar
Laurent Aimar committed
491

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

495 496 497
    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
498
        libvlc_Quit( p_playlist->p_libvlc );
Laurent Aimar's avatar
Laurent Aimar committed
499 500 501
    }
}

502 503 504
/**
 * Run the main control thread itself
 */
505
static void *Thread ( void *data )
506
{
507
    playlist_t *p_playlist = data;
508
    playlist_private_t *p_sys = pl_priv(p_playlist);
509

510
    playlist_Lock( p_playlist );
511
    for( ;; )
512
    {
513 514
        while( p_sys->p_input != NULL )
            LoopInput( p_playlist );
515

516 517 518
        if( p_sys->killed )
            break; /* THE END */

519 520 521 522 523
        const int status = p_sys->request.b_request ?
                           p_sys->request.i_status : p_sys->status.i_status;

        /* Destroy any video display if the playlist is supposed to stop */
        if( status == PLAYLIST_STOPPED
524 525 526 527 528 529 530
         && 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 */
        }
531

532
        LoopRequest( p_playlist, status );
533
    }
534
    p_sys->status.i_status = PLAYLIST_STOPPED;
535
    playlist_Unlock( p_playlist );
536

537
    input_resource_Terminate( p_sys->p_input_resource );
538
    return NULL;
539
}