control.c 18.3 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 52 53

    assert( pl != p_this /* This does not make sense to yield the playlist
    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 65 66
    
    assert( pl != p_this /* The rule is that pl_Release() should act on
    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 91
    if( !vlc_object_alive( p_playlist ) )
        return VLC_EGENERIC;

92
    if( playlist_IsEmpty( p_playlist ) )
93 94 95 96 97 98
        return VLC_EGENERIC;

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

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

    case PLAYLIST_PLAY:
        if( p_playlist->p_input )
        {
            val.i_int = PLAYING_S;
            var_Set( p_playlist->p_input, "state", val );
            break;
        }
129 130 131
        else
        {
            p_playlist->request.i_status = PLAYLIST_RUNNING;
132
            p_playlist->request.b_request = true;
133 134
            p_playlist->request.p_node = get_current_status_node( p_playlist );
            p_playlist->request.p_item = get_current_status_item( p_playlist );
135 136
            p_playlist->request.i_skip = 0;
        }
137 138 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
        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:
165 166
        p_playlist->request.p_node = get_current_status_node( p_playlist );
        p_playlist->request.p_item = get_current_status_item( p_playlist );
167
        p_playlist->request.i_skip = (int) va_arg( args, int );
168 169 170
        /* if already running, keep running */
        if( p_playlist->status.i_status != PLAYLIST_STOPPED )
            p_playlist->request.i_status = p_playlist->status.i_status;
171
        p_playlist->request.b_request = true;
172 173 174 175 176 177 178
        break;

    default:
        msg_Err( p_playlist, "unknown playlist query" );
        return VLC_EBADVAR;
        break;
    }
179
    vlc_object_signal_maybe( VLC_OBJECT(p_playlist) );
180 181 182 183 184 185 186 187 188 189 190

    return VLC_SUCCESS;
}

/*****************************************************************************
 * Preparse control
 *****************************************************************************/
/** Enqueue an item for preparsing */
int playlist_PreparseEnqueue( playlist_t *p_playlist,
                              input_item_t *p_item )
{
191
    vlc_object_lock( p_playlist->p_preparse );
192 193 194 195 196
    if( !vlc_object_alive( p_playlist->p_preparse ) )
    {
        vlc_object_unlock( p_playlist->p_preparse );
        return VLC_EGENERIC;
    }
197 198 199 200 201
    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
202
    vlc_object_signal_unlocked( p_playlist->p_preparse );
203
    vlc_object_unlock( p_playlist->p_preparse );
204 205 206 207 208 209 210 211
    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 )
{
212 213
    vlc_object_lock( p_playlist );
    vlc_object_lock( p_playlist->p_preparse );
214 215 216 217 218 219
    if( !vlc_object_alive( p_playlist->p_preparse ) )
    {
        vlc_object_unlock( p_playlist->p_preparse );
        vlc_object_unlock( p_playlist );
        return VLC_EGENERIC;
    }
220
    PreparseEnqueueItemSub( p_playlist, p_item );
221 222
    vlc_object_unlock( p_playlist->p_preparse );
    vlc_object_unlock( p_playlist );
223 224 225
    return VLC_SUCCESS;
}

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

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

245 246
static void PreparseEnqueueItemSub( playlist_t *p_playlist,
                                    playlist_item_t *p_item )
247 248 249 250
{
    int i;
    if( p_item->i_children == -1 )
    {
251
        vlc_gc_incref( p_item->p_input );
252 253 254 255 256 257 258 259 260
        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++)
        {
261
            PreparseEnqueueItemSub( p_playlist, p_item->pp_children[i] );
262 263 264 265 266 267 268 269
        }
    }
}

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

Rémi Duraffort's avatar
Rémi Duraffort committed
270 271 272 273 274 275 276 277 278
/**
 * 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
279
{
Rémi Duraffort's avatar
Rémi Duraffort committed
280
     PL_DEBUG( "resyncing on %s", PLI_NAME( p_cur ) );
Clément Stenac's avatar
Clément Stenac committed
281 282 283 284 285
     /* 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
286
          if( ARRAY_VAL( p_playlist->current, i ) == p_cur )
Clément Stenac's avatar
Clément Stenac committed
287 288 289 290 291
          {
              p_playlist->i_current_index = i;
              break;
          }
     }
Rémi Duraffort's avatar
Rémi Duraffort committed
292
     PL_DEBUG( "%s is at %i", PLI_NAME( p_cur ), p_playlist->i_current_index );
Clément Stenac's avatar
Clément Stenac committed
293 294
}

295
void ResetCurrentlyPlaying( playlist_t *p_playlist, bool b_random,
296
                            playlist_item_t *p_cur )
Clément Stenac's avatar
Clément Stenac committed
297 298
{
    playlist_item_t *p_next = NULL;
299 300
    stats_TimerStart( p_playlist, "Items array build",
                      STATS_TIMER_PLAYLIST_BUILD );
Rémi Duraffort's avatar
Rémi Duraffort committed
301 302 303
    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
304 305 306 307 308 309
    p_playlist->i_current_index = -1;
    while( 1 )
    {
        /** FIXME: this is *slow* */
        p_next = playlist_GetNextLeaf( p_playlist,
                                       p_playlist->status.p_node,
310
                                       p_next, true, false );
Clément Stenac's avatar
Clément Stenac committed
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
        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
330
            /* swap the two items */
Clément Stenac's avatar
Clément Stenac committed
331 332 333 334 335
            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;
        }
    }
336
    p_playlist->b_reset_currently_playing = false;
337
    stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_BUILD );
Clément Stenac's avatar
Clément Stenac committed
338 339
}

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

352 353 354 355
    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" );
356 357 358

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

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

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

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

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

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

Rémi Duraffort's avatar
Rémi Duraffort committed
411
        /* If we are asked for a node, don't take it */
412
        if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
413 414
            i_skip++;

Clément Stenac's avatar
Clément Stenac committed
415
        if( p_playlist->b_reset_currently_playing )
416
            /* A bit too bad to reset twice ... */
Clément Stenac's avatar
Clément Stenac committed
417 418 419 420 421 422
            ResetCurrentlyPlaying( p_playlist, b_random, p_new );
        else if( p_new )
            ResyncCurrentIndex( p_playlist, p_new );
        else
            p_playlist->i_current_index = -1;

423
        if( p_playlist->current.i_size && (i_skip > 0) )
424
        {
425 426
            if( p_playlist->i_current_index < -1 )
                p_playlist->i_current_index = -1;
427 428
            for( i = i_skip; i > 0 ; i-- )
            {
Clément Stenac's avatar
Clément Stenac committed
429
                p_playlist->i_current_index++;
430
                if( p_playlist->i_current_index >= p_playlist->current.i_size )
431
                {
432
                    PL_DEBUG( "looping - restarting at beginning of node" );
Clément Stenac's avatar
Clément Stenac committed
433
                    p_playlist->i_current_index = 0;
434 435
                }
            }
Clément Stenac's avatar
Clément Stenac committed
436 437
            p_new = ARRAY_VAL( p_playlist->current,
                               p_playlist->i_current_index );
438
        }
439
        else if( p_playlist->current.i_size && (i_skip < 0) )
440 441 442
        {
            for( i = i_skip; i < 0 ; i++ )
            {
Clément Stenac's avatar
Clément Stenac committed
443
                p_playlist->i_current_index--;
444
                if( p_playlist->i_current_index <= -1 )
445
                {
446
                    PL_DEBUG( "looping - restarting at end of node" );
Clément Stenac's avatar
Clément Stenac committed
447
                    p_playlist->i_current_index = p_playlist->current.i_size-1;
448 449
                }
            }
Clément Stenac's avatar
Clément Stenac committed
450 451
            p_new = ARRAY_VAL( p_playlist->current,
                               p_playlist->i_current_index );
452 453
        }
        /* Clear the request */
454
        p_playlist->request.b_request = false;
455 456 457 458
    }
    /* "Automatic" item change ( next ) */
    else
    {
Clément Stenac's avatar
Clément Stenac committed
459 460
        PL_DEBUG( "changing item without a request (current %i/%i)",
                  p_playlist->i_current_index, p_playlist->current.i_size );
461
        /* Cant go to next from current item */
462 463
        if( get_current_status_item( p_playlist ) &&
            get_current_status_item( p_playlist )->i_flags & PLAYLIST_SKIP_FLAG )
464 465
            return NULL;

Clément Stenac's avatar
Clément Stenac committed
466 467
        if( p_playlist->b_reset_currently_playing )
            ResetCurrentlyPlaying( p_playlist, b_random,
468
                                   get_current_status_item( p_playlist ) );
Clément Stenac's avatar
Clément Stenac committed
469 470

        p_playlist->i_current_index++;
Rafaël Carré's avatar
Rafaël Carré committed
471
        assert( p_playlist->i_current_index <= p_playlist->current.i_size );
Clément Stenac's avatar
Clément Stenac committed
472
        if( p_playlist->i_current_index == p_playlist->current.i_size )
473
        {
Clément Stenac's avatar
Clément Stenac committed
474 475
            if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
            p_playlist->i_current_index = 0;
476
        }
Clément Stenac's avatar
Clément Stenac committed
477 478 479 480
        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 );
481 482 483 484 485 486 487
        /* 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
488 489 490 491 492 493 494
/**
 * Start the input for an item
 *
 * \param p_playlist the playlist objetc
 * \param p_item the item to play
 * \return nothing
 */
495 496
int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
{
497
    input_item_t *p_input = p_item->p_input;
498
    sout_instance_t **pp_sout = &libvlc_priv(p_playlist->p_libvlc)->p_sout;
Rémi Duraffort's avatar
Rémi Duraffort committed
499
    int i_activity = var_GetInteger( p_playlist, "activity" ) ;
500 501 502

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

503
    p_input->i_nb_played++;
504
    set_current_status_item( p_playlist, p_item );
505 506 507 508 509

    p_playlist->status.i_status = PLAYLIST_RUNNING;

    var_SetInteger( p_playlist, "activity", i_activity +
                    DEFAULT_INPUT_ACTIVITY );
510 511

    input_thread_t * p_input_thread =
512
        input_CreateThreadExtended( p_playlist, p_input, NULL, *pp_sout );
513 514 515
    playlist_set_current_input( p_playlist, p_input_thread );
    vlc_object_release( p_input_thread );

516
    *pp_sout = NULL;
517

518 519 520 521 522 523 524 525 526
    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 );

527 528
    if( p_playlist->p_fetcher &&
            p_playlist->p_fetcher->i_art_policy == ALBUM_ART_WHEN_PLAYED )
529
    {
530
        bool b_has_art;
531

532 533 534 535
        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
536
        /* p_input->p_meta should not be null after a successfull CreateThread */
537
        b_has_art = !EMPTY_STR( psz_arturl );
538

539
        if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
540
        {
541
            PL_DEBUG( "requesting art for %s", psz_name );
542 543
            playlist_AskForArtEnqueue( p_playlist, p_input );
        }
544 545
        free( psz_arturl );
        free( psz_name );
546
    }
547

548
    PL_UNLOCK;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
549
    var_SetInteger( p_playlist, "playlist-current", p_input->i_id );
550
    PL_LOCK;
551 552 553

    return VLC_SUCCESS;
}