control.c 18.9 KB
Newer Older
1
/*****************************************************************************
Clément Stenac's avatar
Clément Stenac committed
2
 * control.c : Handle control of the playlist & running through it
3 4
 *****************************************************************************
 * Copyright (C) 1999-2004 the VideoLAN team
Jean-Paul Saman's avatar
Jean-Paul Saman committed
5
 * $Id$
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 *
 * Authors: Samuel Hocevar <sam@zoy.org>
 *          Clément Stenac <zorglub@videolan.org>
 *
 * 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
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/
24 25 26 27
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

28
#include <vlc_common.h>
29
#include "vlc_playlist.h"
30
#include "playlist_internal.h"
31
#include <assert.h>
32 33 34 35

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
36
static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args );
37

38
static void PreparseEnqueueItemSub( playlist_t *, playlist_item_t * );
39 40 41 42 43

/*****************************************************************************
 * Playlist control
 *****************************************************************************/

44 45
playlist_t *__pl_Yield( vlc_object_t *p_this )
{
46
    playlist_t *pl;
47

48 49
    barrier ();
    pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
50

51
    assert( VLC_OBJECT(pl) != p_this /* This does not make sense to yield the playlist
52 53
    using pl_Yield. use vlc_object_yield in this case */ );

54 55
    if (pl)
        vlc_object_yield (pl);
56 57 58 59 60
    return pl;
}

void __pl_Release( vlc_object_t *p_this )
{
61
    playlist_t *pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
62
    assert( pl != NULL );
63

64
    assert( VLC_OBJECT(pl) != p_this /* The rule is that pl_Release() should act on
65 66
    the same object than pl_Yield() */ );

67 68 69 70
    vlc_object_release( pl );
}

int playlist_Control( playlist_t * p_playlist, int i_query,
71
                      bool b_locked, ... )
72 73 74
{
    va_list args;
    int i_result;
75
    va_start( args, b_locked );
76
    PL_LOCK_IF( !b_locked );
77 78
    i_result = PlaylistVAControl( p_playlist, i_query, args );
    va_end( args );
79
    PL_UNLOCK_IF( !b_locked );
80 81 82 83

    return i_result;
}

84
static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args )
85 86 87 88
{
    playlist_item_t *p_item, *p_node;
    vlc_value_t val;

89 90
    PL_ASSERT_LOCKED;

91 92 93
    if( !vlc_object_alive( p_playlist ) )
        return VLC_EGENERIC;

94
    if( playlist_IsEmpty( p_playlist ) )
95 96 97 98 99 100
        return VLC_EGENERIC;

    switch( i_query )
    {
    case PLAYLIST_STOP:
        p_playlist->request.i_status = PLAYLIST_STOPPED;
101
        p_playlist->request.b_request = true;
102 103 104
        p_playlist->request.p_item = NULL;
        break;

105 106
    // Node can be null, it will keep the same. Use with care ...
    // Item null = take the first child of node
107 108 109 110 111
    case PLAYLIST_VIEWPLAY:
        p_node = (playlist_item_t *)va_arg( args, playlist_item_t * );
        p_item = (playlist_item_t *)va_arg( args, playlist_item_t * );
        if ( p_node == NULL )
        {
112
            p_node = p_playlist->status.p_node;
113
            assert( p_node );
114 115 116
        }
        p_playlist->request.i_status = PLAYLIST_RUNNING;
        p_playlist->request.i_skip = 0;
117
        p_playlist->request.b_request = true;
118 119
        p_playlist->request.p_node = p_node;
        p_playlist->request.p_item = p_item;
Clément Stenac's avatar
Clément Stenac committed
120
        if( p_item && var_GetBool( p_playlist, "random" ) )
121
            p_playlist->b_reset_currently_playing = true;
122 123 124 125 126 127 128 129 130
        break;

    case PLAYLIST_PLAY:
        if( p_playlist->p_input )
        {
            val.i_int = PLAYING_S;
            var_Set( p_playlist->p_input, "state", val );
            break;
        }
131 132 133
        else
        {
            p_playlist->request.i_status = PLAYLIST_RUNNING;
134
            p_playlist->request.b_request = true;
135 136
            p_playlist->request.p_node = get_current_status_node( p_playlist );
            p_playlist->request.p_item = get_current_status_item( p_playlist );
137 138
            p_playlist->request.i_skip = 0;
        }
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
        break;

    case PLAYLIST_PAUSE:
        val.i_int = 0;
        if( p_playlist->p_input )
            var_Get( p_playlist->p_input, "state", &val );

        if( val.i_int == PAUSE_S )
        {
            p_playlist->status.i_status = PLAYLIST_RUNNING;
            if( p_playlist->p_input )
            {
                val.i_int = PLAYING_S;
                var_Set( p_playlist->p_input, "state", val );
            }
        }
        else
        {
            p_playlist->status.i_status = PLAYLIST_PAUSED;
            if( p_playlist->p_input )
            {
                val.i_int = PAUSE_S;
                var_Set( p_playlist->p_input, "state", val );
            }
        }
        break;

    case PLAYLIST_SKIP:
167 168
        p_playlist->request.p_node = get_current_status_node( p_playlist );
        p_playlist->request.p_item = get_current_status_item( p_playlist );
169
        p_playlist->request.i_skip = (int) va_arg( args, int );
170 171 172
        /* if already running, keep running */
        if( p_playlist->status.i_status != PLAYLIST_STOPPED )
            p_playlist->request.i_status = p_playlist->status.i_status;
173
        p_playlist->request.b_request = true;
174 175 176 177 178 179 180
        break;

    default:
        msg_Err( p_playlist, "unknown playlist query" );
        return VLC_EBADVAR;
        break;
    }
181
    vlc_object_signal_unlocked( p_playlist );
182 183 184 185 186 187 188 189 190 191 192

    return VLC_SUCCESS;
}

/*****************************************************************************
 * Preparse control
 *****************************************************************************/
/** Enqueue an item for preparsing */
int playlist_PreparseEnqueue( playlist_t *p_playlist,
                              input_item_t *p_item )
{
193
    vlc_object_lock( p_playlist->p_preparse );
194 195 196 197 198
    if( !vlc_object_alive( p_playlist->p_preparse ) )
    {
        vlc_object_unlock( p_playlist->p_preparse );
        return VLC_EGENERIC;
    }
199 200 201 202 203
    vlc_gc_incref( p_item );
    INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
                 p_playlist->p_preparse->i_waiting,
                 p_playlist->p_preparse->i_waiting,
                 p_item );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
204
    vlc_object_signal_unlocked( p_playlist->p_preparse );
205
    vlc_object_unlock( p_playlist->p_preparse );
206 207 208 209 210 211 212 213
    return VLC_SUCCESS;
}

/** Enqueue a playlist item or a node for peparsing.
 *  This function should be entered without playlist and preparser locks */
int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
                                  playlist_item_t *p_item )
{
214 215
    vlc_object_lock( p_playlist );
    vlc_object_lock( p_playlist->p_preparse );
216 217 218 219 220 221
    if( !vlc_object_alive( p_playlist->p_preparse ) )
    {
        vlc_object_unlock( p_playlist->p_preparse );
        vlc_object_unlock( p_playlist );
        return VLC_EGENERIC;
    }
222
    PreparseEnqueueItemSub( p_playlist, p_item );
223 224
    vlc_object_unlock( p_playlist->p_preparse );
    vlc_object_unlock( p_playlist );
225 226 227
    return VLC_SUCCESS;
}

228
int playlist_AskForArtEnqueue( playlist_t *p_playlist,
229
                               input_item_t *p_item )
230
{
231
    vlc_object_lock( p_playlist->p_fetcher );
232 233 234 235 236 237
    if( !vlc_object_alive( p_playlist->p_fetcher ) )
    {
        vlc_object_unlock( p_playlist->p_fetcher );
        return VLC_EGENERIC;
    }

238
    vlc_gc_incref( p_item );
Rafaël Carré's avatar
Rafaël Carré committed
239
    INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
240
                 p_playlist->p_fetcher->i_waiting,
241
                 p_playlist->p_fetcher->i_waiting, p_item );
242
    vlc_object_signal_unlocked( p_playlist->p_fetcher );
Rafaël Carré's avatar
typo  
Rafaël Carré committed
243
    vlc_object_unlock( p_playlist->p_fetcher );
244 245 246
    return VLC_SUCCESS;
}

247 248
static void PreparseEnqueueItemSub( playlist_t *p_playlist,
                                    playlist_item_t *p_item )
249 250 251 252
{
    int i;
    if( p_item->i_children == -1 )
    {
253
        vlc_gc_incref( p_item->p_input );
254 255 256 257 258 259 260 261 262
        INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
                     p_playlist->p_preparse->i_waiting,
                     p_playlist->p_preparse->i_waiting,
                     p_item->p_input );
    }
    else
    {
        for( i = 0; i < p_item->i_children; i++)
        {
263
            PreparseEnqueueItemSub( p_playlist, p_item->pp_children[i] );
264 265 266 267 268 269 270 271
        }
    }
}

/*****************************************************************************
 * Playback logic
 *****************************************************************************/

Rémi Duraffort's avatar
Rémi Duraffort committed
272 273 274 275 276 277 278 279 280
/**
 * 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
 */
static void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur )
Clément Stenac's avatar
Clément Stenac committed
281
{
Rémi Duraffort's avatar
Rémi Duraffort committed
282
     PL_DEBUG( "resyncing on %s", PLI_NAME( p_cur ) );
Clément Stenac's avatar
Clément Stenac committed
283 284 285 286 287
     /* Simply resync index */
     int i;
     p_playlist->i_current_index = -1;
     for( i = 0 ; i< p_playlist->current.i_size; i++ )
     {
Rémi Duraffort's avatar
Rémi Duraffort committed
288
          if( ARRAY_VAL( p_playlist->current, i ) == p_cur )
Clément Stenac's avatar
Clément Stenac committed
289 290 291 292 293
          {
              p_playlist->i_current_index = i;
              break;
          }
     }
Rémi Duraffort's avatar
Rémi Duraffort committed
294
     PL_DEBUG( "%s is at %i", PLI_NAME( p_cur ), p_playlist->i_current_index );
Clément Stenac's avatar
Clément Stenac committed
295 296
}

297
void ResetCurrentlyPlaying( playlist_t *p_playlist, bool b_random,
298
                            playlist_item_t *p_cur )
Clément Stenac's avatar
Clément Stenac committed
299 300
{
    playlist_item_t *p_next = NULL;
301 302
    stats_TimerStart( p_playlist, "Items array build",
                      STATS_TIMER_PLAYLIST_BUILD );
Rémi Duraffort's avatar
Rémi Duraffort committed
303 304 305
    PL_DEBUG( "rebuilding array of current - root %s",
              PLI_NAME( p_playlist->status.p_node ) );
    ARRAY_RESET( p_playlist->current );
Clément Stenac's avatar
Clément Stenac committed
306 307 308 309 310 311
    p_playlist->i_current_index = -1;
    while( 1 )
    {
        /** FIXME: this is *slow* */
        p_next = playlist_GetNextLeaf( p_playlist,
                                       p_playlist->status.p_node,
312
                                       p_next, true, false );
Clément Stenac's avatar
Clément Stenac committed
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
        if( p_next )
        {
            if( p_next == p_cur )
                p_playlist->i_current_index = p_playlist->current.i_size;
            ARRAY_APPEND( p_playlist->current, p_next);
        }
        else break;
    }
    PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
                                                  p_playlist->i_current_index);
    if( b_random )
    {
        /* Shuffle the array */
        srand( (unsigned int)mdate() );
        int j;
        for( j = p_playlist->current.i_size - 1; j > 0; j-- )
        {
            int i = rand() % (j+1); /* between 0 and j */
            playlist_item_t *p_tmp;
Rémi Duraffort's avatar
Rémi Duraffort committed
332
            /* swap the two items */
Clément Stenac's avatar
Clément Stenac committed
333 334 335 336 337
            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;
        }
    }
338
    p_playlist->b_reset_currently_playing = false;
339
    stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_BUILD );
Clément Stenac's avatar
Clément Stenac committed
340 341
}

Rémi Duraffort's avatar
Rémi Duraffort committed
342 343 344 345 346 347 348
/**
 * Compute the next playlist item depending on
 * the playlist course mode (forward, backward, random, view,...).
 *
 * \param p_playlist the playlist object
 * \return nothing
 */
349 350 351
playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
{
    playlist_item_t *p_new = NULL;
352
    int i_skip = 0, i;
353

354 355 356 357
    bool b_loop = var_GetBool( p_playlist, "loop" );
    bool b_random = var_GetBool( p_playlist, "random" );
    bool b_repeat = var_GetBool( p_playlist, "repeat" );
    bool b_playstop = var_GetBool( p_playlist, "play-and-stop" );
358 359 360

    /* Handle quickly a few special cases */
    /* No items to play */
Clément Stenac's avatar
Clément Stenac committed
361
    if( p_playlist->items.i_size == 0 )
362 363 364 365 366 367
    {
        msg_Info( p_playlist, "playlist is empty" );
        return NULL;
    }

    /* Repeat and play/stop */
368
    if( !p_playlist->request.b_request && b_repeat == true &&
369
         get_current_status_item( p_playlist ) )
370 371
    {
        msg_Dbg( p_playlist,"repeating item" );
372
        return get_current_status_item( p_playlist );
373
    }
374
    if( !p_playlist->request.b_request && b_playstop == true )
375
    {
Rémi Duraffort's avatar
Rémi Duraffort committed
376
        msg_Dbg( p_playlist,"stopping (play and stop)" );
377 378 379
        return NULL;
    }

380 381
    if( !p_playlist->request.b_request &&
        get_current_status_item( p_playlist ) )
382
    {
383
        playlist_item_t *p_parent = get_current_status_item( p_playlist );
384 385 386 387 388 389 390 391 392
        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;
        }
393 394 395 396 397
    }

    /* Start the real work */
    if( p_playlist->request.b_request )
    {
398 399
        p_new = p_playlist->request.p_item;
        i_skip = p_playlist->request.i_skip;
Clément Stenac's avatar
Clément Stenac committed
400
        PL_DEBUG( "processing request item %s node %s skip %i",
401 402
                        PLI_NAME( p_playlist->request.p_item ),
                        PLI_NAME( p_playlist->request.p_node ), i_skip );
403

Clément Stenac's avatar
Clément Stenac committed
404
        if( p_playlist->request.p_node &&
405
            p_playlist->request.p_node != get_current_status_node( p_playlist ) )
Clément Stenac's avatar
Clément Stenac committed
406
        {
407

408 409
            set_current_status_node( p_playlist, p_playlist->request.p_node );
            p_playlist->request.p_node = NULL;
410
            p_playlist->b_reset_currently_playing = true;
Clément Stenac's avatar
Clément Stenac committed
411
        }
412

413
        /* If we are asked for a node, go to it's first child */
414
        if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
415
        {
416
            i_skip++;
417 418 419 420 421 422 423 424 425 426 427 428 429
            if( p_new != NULL )
            {
                p_new = playlist_GetNextLeaf( p_playlist, p_new, NULL, true, false );
                for( i = 0; i < p_playlist->current.i_size; i++ )
                {
                    if( p_new == ARRAY_VAL( p_playlist->current, i ) )
                    {
                        p_playlist->i_current_index = i;
                        i_skip = 0;
                    }
                }
            }
        }
430

Clément Stenac's avatar
Clément Stenac committed
431
        if( p_playlist->b_reset_currently_playing )
432
            /* A bit too bad to reset twice ... */
Clément Stenac's avatar
Clément Stenac committed
433 434 435 436 437 438
            ResetCurrentlyPlaying( p_playlist, b_random, p_new );
        else if( p_new )
            ResyncCurrentIndex( p_playlist, p_new );
        else
            p_playlist->i_current_index = -1;

439
        if( p_playlist->current.i_size && (i_skip > 0) )
440
        {
441 442
            if( p_playlist->i_current_index < -1 )
                p_playlist->i_current_index = -1;
443 444
            for( i = i_skip; i > 0 ; i-- )
            {
Clément Stenac's avatar
Clément Stenac committed
445
                p_playlist->i_current_index++;
446
                if( p_playlist->i_current_index >= p_playlist->current.i_size )
447
                {
448
                    PL_DEBUG( "looping - restarting at beginning of node" );
Clément Stenac's avatar
Clément Stenac committed
449
                    p_playlist->i_current_index = 0;
450 451
                }
            }
Clément Stenac's avatar
Clément Stenac committed
452 453
            p_new = ARRAY_VAL( p_playlist->current,
                               p_playlist->i_current_index );
454
        }
455
        else if( p_playlist->current.i_size && (i_skip < 0) )
456 457 458
        {
            for( i = i_skip; i < 0 ; i++ )
            {
Clément Stenac's avatar
Clément Stenac committed
459
                p_playlist->i_current_index--;
460
                if( p_playlist->i_current_index <= -1 )
461
                {
462
                    PL_DEBUG( "looping - restarting at end of node" );
Clément Stenac's avatar
Clément Stenac committed
463
                    p_playlist->i_current_index = p_playlist->current.i_size-1;
464 465
                }
            }
Clément Stenac's avatar
Clément Stenac committed
466 467
            p_new = ARRAY_VAL( p_playlist->current,
                               p_playlist->i_current_index );
468 469
        }
        /* Clear the request */
470
        p_playlist->request.b_request = false;
471 472 473 474
    }
    /* "Automatic" item change ( next ) */
    else
    {
Clément Stenac's avatar
Clément Stenac committed
475 476
        PL_DEBUG( "changing item without a request (current %i/%i)",
                  p_playlist->i_current_index, p_playlist->current.i_size );
477
        /* Cant go to next from current item */
478 479
        if( get_current_status_item( p_playlist ) &&
            get_current_status_item( p_playlist )->i_flags & PLAYLIST_SKIP_FLAG )
480 481
            return NULL;

Clément Stenac's avatar
Clément Stenac committed
482 483
        if( p_playlist->b_reset_currently_playing )
            ResetCurrentlyPlaying( p_playlist, b_random,
484
                                   get_current_status_item( p_playlist ) );
Clément Stenac's avatar
Clément Stenac committed
485 486

        p_playlist->i_current_index++;
Rafaël Carré's avatar
Rafaël Carré committed
487
        assert( p_playlist->i_current_index <= p_playlist->current.i_size );
Clément Stenac's avatar
Clément Stenac committed
488
        if( p_playlist->i_current_index == p_playlist->current.i_size )
489
        {
Clément Stenac's avatar
Clément Stenac committed
490 491
            if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
            p_playlist->i_current_index = 0;
492
        }
Clément Stenac's avatar
Clément Stenac committed
493 494 495 496
        PL_DEBUG( "using item %i", p_playlist->i_current_index );
        if ( p_playlist->current.i_size == 0 ) return NULL;

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

Rémi Duraffort's avatar
Rémi Duraffort committed
504 505 506 507 508 509 510
/**
 * Start the input for an item
 *
 * \param p_playlist the playlist objetc
 * \param p_item the item to play
 * \return nothing
 */
511 512
int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
{
513
    input_item_t *p_input = p_item->p_input;
514
    sout_instance_t **pp_sout = &libvlc_priv(p_playlist->p_libvlc)->p_sout;
Rémi Duraffort's avatar
Rémi Duraffort committed
515
    int i_activity = var_GetInteger( p_playlist, "activity" ) ;
516 517 518

    msg_Dbg( p_playlist, "creating new input thread" );

519
    p_input->i_nb_played++;
520
    set_current_status_item( p_playlist, p_item );
521 522 523 524 525

    p_playlist->status.i_status = PLAYLIST_RUNNING;

    var_SetInteger( p_playlist, "activity", i_activity +
                    DEFAULT_INPUT_ACTIVITY );
526 527

    input_thread_t * p_input_thread =
528
        input_CreateThreadExtended( p_playlist, p_input, NULL, *pp_sout );
529 530 531
    playlist_set_current_input( p_playlist, p_input_thread );
    vlc_object_release( p_input_thread );

532
    *pp_sout = NULL;
533

534 535 536 537 538 539 540 541 542
    char *psz_uri = input_item_GetURI( p_item->p_input );
    if( psz_uri && ( !strncmp( psz_uri, "directory:", 10 ) ||
                     !strncmp( psz_uri, "vlc:", 4 ) ) )
    {
        free( psz_uri );
        return VLC_SUCCESS;
    }
    free( psz_uri );

543 544
    if( p_playlist->p_fetcher &&
            p_playlist->p_fetcher->i_art_policy == ALBUM_ART_WHEN_PLAYED )
545
    {
546
        bool b_has_art;
547

548 549 550 551
        char *psz_arturl, *psz_name;
        psz_arturl = input_item_GetArtURL( p_input );
        psz_name = input_item_GetName( p_input );

Rémi Duraffort's avatar
Rémi Duraffort committed
552
        /* p_input->p_meta should not be null after a successfull CreateThread */
553
        b_has_art = !EMPTY_STR( psz_arturl );
554

555
        if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
556
        {
557
            PL_DEBUG( "requesting art for %s", psz_name );
558 559
            playlist_AskForArtEnqueue( p_playlist, p_input );
        }
560 561
        free( psz_arturl );
        free( psz_name );
562
    }
563

564
    PL_UNLOCK;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
565
    var_SetInteger( p_playlist, "playlist-current", p_input->i_id );
566
    PL_LOCK;
567 568 569

    return VLC_SUCCESS;
}