control.c 18.5 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 50 51
    barrier ();
    pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
    if (pl)
        vlc_object_yield (pl);
52 53 54 55 56
    return pl;
}

void __pl_Release( vlc_object_t *p_this )
{
57
    playlist_t *pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
58 59 60 61 62
    assert( pl != NULL );
    vlc_object_release( pl );
}

int playlist_Control( playlist_t * p_playlist, int i_query,
63
                      bool b_locked, ... )
64 65 66
{
    va_list args;
    int i_result;
67 68
    va_start( args, b_locked );
    if( !b_locked ) PL_LOCK;
69 70
    i_result = PlaylistVAControl( p_playlist, i_query, args );
    va_end( args );
71
    if( !b_locked ) PL_UNLOCK;
72 73 74 75

    return i_result;
}

76
static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args )
77 78 79 80
{
    playlist_item_t *p_item, *p_node;
    vlc_value_t val;

81 82 83
    if( !vlc_object_alive( p_playlist ) )
        return VLC_EGENERIC;

84
    if( playlist_IsEmpty( p_playlist ) )
85 86 87 88 89 90
        return VLC_EGENERIC;

    switch( i_query )
    {
    case PLAYLIST_STOP:
        p_playlist->request.i_status = PLAYLIST_STOPPED;
91
        p_playlist->request.b_request = true;
92 93 94
        p_playlist->request.p_item = NULL;
        break;

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

    case PLAYLIST_PLAY:
        if( p_playlist->p_input )
        {
            val.i_int = PLAYING_S;
            var_Set( p_playlist->p_input, "state", val );
            break;
        }
121 122 123
        else
        {
            p_playlist->request.i_status = PLAYLIST_RUNNING;
124
            p_playlist->request.b_request = true;
125 126 127 128
            p_playlist->request.p_node = p_playlist->status.p_node;
            p_playlist->request.p_item = p_playlist->status.p_item;
            p_playlist->request.i_skip = 0;
        }
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
        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:
        p_playlist->request.p_node = p_playlist->status.p_node;
        p_playlist->request.p_item = p_playlist->status.p_item;
        p_playlist->request.i_skip = (int) va_arg( args, int );
160 161 162
        /* if already running, keep running */
        if( p_playlist->status.i_status != PLAYLIST_STOPPED )
            p_playlist->request.i_status = p_playlist->status.i_status;
163
        p_playlist->request.b_request = true;
164 165 166 167 168 169 170
        break;

    default:
        msg_Err( p_playlist, "unknown playlist query" );
        return VLC_EBADVAR;
        break;
    }
171
    vlc_object_signal_maybe( VLC_OBJECT(p_playlist) );
172 173 174 175 176 177 178 179 180 181 182

    return VLC_SUCCESS;
}

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

218
int playlist_AskForArtEnqueue( playlist_t *p_playlist,
219
                               input_item_t *p_item )
220 221 222
{
    int i;

223
    vlc_object_lock( p_playlist->p_fetcher );
224 225 226 227 228 229
    if( !vlc_object_alive( p_playlist->p_fetcher ) )
    {
        vlc_object_unlock( p_playlist->p_fetcher );
        return VLC_EGENERIC;
    }

Rafaël Carré's avatar
Rafaël Carré committed
230
    for( i = 0; i < p_playlist->p_fetcher->i_waiting ; i++ );
231
    vlc_gc_incref( p_item );
Rafaël Carré's avatar
Rafaël Carré committed
232
    INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
233
                 p_playlist->p_fetcher->i_waiting,
Rafaël Carré's avatar
Rafaël Carré committed
234
                 i, p_item );
235
    vlc_object_signal_unlocked( p_playlist->p_fetcher );
Rafaël Carré's avatar
typo  
Rafaël Carré committed
236
    vlc_object_unlock( p_playlist->p_fetcher );
237 238 239
    return VLC_SUCCESS;
}

240 241
static void PreparseEnqueueItemSub( playlist_t *p_playlist,
                                    playlist_item_t *p_item )
242 243 244 245 246 247 248 249 250 251 252 253 254 255
{
    int i;
    if( p_item->i_children == -1 )
    {
        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->p_input );
    }
    else
    {
        for( i = 0; i < p_item->i_children; i++)
        {
256
            PreparseEnqueueItemSub( p_playlist, p_item->pp_children[i] );
257 258 259 260 261 262 263 264
        }
    }
}

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

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

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

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

347 348 349 350
    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" );
351 352 353

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

    /* Repeat and play/stop */
361
    if( !p_playlist->request.b_request && b_repeat == true &&
362 363 364 365 366
         p_playlist->status.p_item )
    {
        msg_Dbg( p_playlist,"repeating item" );
        return p_playlist->status.p_item;
    }
367
    if( !p_playlist->request.b_request && b_playstop == true )
368
    {
Rémi Duraffort's avatar
Rémi Duraffort committed
369
        msg_Dbg( p_playlist,"stopping (play and stop)" );
370 371 372
        return NULL;
    }

373
    if( !p_playlist->request.b_request && p_playlist->status.p_item )
374
    {
375 376 377 378 379 380 381 382 383 384
        playlist_item_t *p_parent = p_playlist->status.p_item;
        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;
        }
385 386 387 388 389
    }

    /* Start the real work */
    if( p_playlist->request.b_request )
    {
390 391
        p_new = p_playlist->request.p_item;
        i_skip = p_playlist->request.i_skip;
Clément Stenac's avatar
Clément Stenac committed
392
        PL_DEBUG( "processing request item %s node %s skip %i",
393 394
                        PLI_NAME( p_playlist->request.p_item ),
                        PLI_NAME( p_playlist->request.p_node ), i_skip );
395

396 397 398 399 400 401 402 403 404 405 406 407 408
        /* Make sure the node wasn't deleted */
        if( p_playlist->status.p_node &&
            p_playlist->status.p_node->i_flags & PLAYLIST_REMOVE_FLAG )
        {
             PL_DEBUG( "%s was marked for deletion, deleting",
                             PLI_NAME( p_playlist->status.p_node  ) );
             playlist_ItemDelete( p_playlist->status.p_node );
             /* Don't attempt to reuse that node */
             if( p_playlist->status.p_node == p_playlist->request.p_node )
                p_playlist->request.p_node = NULL;
             p_playlist->status.p_node = NULL;
        }

Clément Stenac's avatar
Clément Stenac committed
409 410 411
        if( p_playlist->request.p_node &&
            p_playlist->request.p_node != p_playlist->status.p_node )
        {
412

413
            p_playlist->status.p_node = p_playlist->request.p_node;
414
            p_playlist->b_reset_currently_playing = true;
Clément Stenac's avatar
Clément Stenac committed
415
        }
416

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

Clément Stenac's avatar
Clément Stenac committed
421
        if( p_playlist->b_reset_currently_playing )
422
            /* A bit too bad to reset twice ... */
Clément Stenac's avatar
Clément Stenac committed
423 424 425 426 427 428
            ResetCurrentlyPlaying( p_playlist, b_random, p_new );
        else if( p_new )
            ResyncCurrentIndex( p_playlist, p_new );
        else
            p_playlist->i_current_index = -1;

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

Clément Stenac's avatar
Clément Stenac committed
472 473 474 475 476
        if( p_playlist->b_reset_currently_playing )
            ResetCurrentlyPlaying( p_playlist, b_random,
                                   p_playlist->status.p_item );

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

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

509
    p_input->i_nb_played++;
510 511 512 513 514 515
    p_playlist->status.p_item = p_item;

    p_playlist->status.i_status = PLAYLIST_RUNNING;

    var_SetInteger( p_playlist, "activity", i_activity +
                    DEFAULT_INPUT_ACTIVITY );
516 517

    input_thread_t * p_input_thread =
518
        input_CreateThreadExtended( p_playlist, p_input, NULL, *pp_sout );
519 520 521
    playlist_set_current_input( p_playlist, p_input_thread );
    vlc_object_release( p_input_thread );

522
    *pp_sout = NULL;
523

524 525 526 527 528 529 530 531 532
    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 );

533 534
    if( p_playlist->p_fetcher &&
            p_playlist->p_fetcher->i_art_policy == ALBUM_ART_WHEN_PLAYED )
535
    {
536
        bool b_has_art;
537

538 539 540 541
        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
542
        /* p_input->p_meta should not be null after a successfull CreateThread */
543
        b_has_art = !EMPTY_STR( psz_arturl );
544

545
        if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
546
        {
547
            PL_DEBUG( "requesting art for %s", psz_name );
548 549
            playlist_AskForArtEnqueue( p_playlist, p_input );
        }
550 551
        free( psz_arturl );
        free( psz_name );
552
    }
553

554
    PL_UNLOCK;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
555
    var_SetInteger( p_playlist, "playlist-current", p_input->i_id );
556
    PL_LOCK;
557 558 559

    return VLC_SUCCESS;
}