control.c 17.6 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 = libvlc_priv (p_this->p_libvlc)->p_playlist;
47 48 49 50 51
    /* Objects that are destroyed _after_ the playlist cannot use pl_Yield() */
    assert (p_this->i_object_type != VLC_OBJECT_VOUT);
    assert (p_this->i_object_type != VLC_OBJECT_ANNOUNCE);
    assert ((void *)p_this != libvlc_priv (p_this->p_libvlc)->p_interaction);

52 53 54 55 56 57 58
    assert( pl != NULL );
    vlc_object_yield( pl );
    return pl;
}

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

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

    return i_result;
}

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

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

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

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

    case PLAYLIST_PLAY:
        if( p_playlist->p_input )
        {
            val.i_int = PLAYING_S;
            var_Set( p_playlist->p_input, "state", val );
            break;
        }
120 121 122
        else
        {
            p_playlist->request.i_status = PLAYLIST_RUNNING;
123
            p_playlist->request.b_request = true;
124 125 126 127
            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;
        }
128 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
        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 );
159 160 161
        /* if already running, keep running */
        if( p_playlist->status.i_status != PLAYLIST_STOPPED )
            p_playlist->request.i_status = p_playlist->status.i_status;
162
        p_playlist->request.b_request = true;
163 164 165 166 167 168 169
        break;

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

    return VLC_SUCCESS;
}

/*****************************************************************************
 * Preparse control
 *****************************************************************************/
/** Enqueue an item for preparsing */
int playlist_PreparseEnqueue( playlist_t *p_playlist,
                              input_item_t *p_item )
{
182
    vlc_object_lock( p_playlist->p_preparse );
183 184 185 186 187
    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
188
    vlc_object_signal_unlocked( p_playlist->p_preparse );
189
    vlc_object_unlock( p_playlist->p_preparse );
190 191 192 193 194 195 196 197
    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 )
{
198 199
    vlc_object_lock( p_playlist );
    vlc_object_lock( p_playlist->p_preparse );
200
    PreparseEnqueueItemSub( p_playlist, p_item );
201 202
    vlc_object_unlock( p_playlist->p_preparse );
    vlc_object_unlock( p_playlist );
203 204 205
    return VLC_SUCCESS;
}

206
int playlist_AskForArtEnqueue( playlist_t *p_playlist,
207
                               input_item_t *p_item )
208 209 210
{
    int i;

211
    vlc_object_lock( p_playlist->p_fetcher );
Rafaël Carré's avatar
Rafaël Carré committed
212
    for( i = 0; i < p_playlist->p_fetcher->i_waiting ; i++ );
213
    vlc_gc_incref( p_item );
Rafaël Carré's avatar
Rafaël Carré committed
214
    INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
215
                 p_playlist->p_fetcher->i_waiting,
Rafaël Carré's avatar
Rafaël Carré committed
216
                 i, p_item );
217
    vlc_object_signal_unlocked( p_playlist->p_fetcher );
Rafaël Carré's avatar
typo  
Rafaël Carré committed
218
    vlc_object_unlock( p_playlist->p_fetcher );
219 220 221
    return VLC_SUCCESS;
}

222 223
static void PreparseEnqueueItemSub( playlist_t *p_playlist,
                                    playlist_item_t *p_item )
224 225 226 227 228 229 230 231 232 233 234 235 236 237
{
    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++)
        {
238
            PreparseEnqueueItemSub( p_playlist, p_item->pp_children[i] );
239 240 241 242 243 244 245 246
        }
    }
}

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

Rémi Duraffort's avatar
Rémi Duraffort committed
247 248 249 250 251 252 253 254 255
/**
 * 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
256
{
Rémi Duraffort's avatar
Rémi Duraffort committed
257
     PL_DEBUG( "resyncing on %s", PLI_NAME( p_cur ) );
Clément Stenac's avatar
Clément Stenac committed
258 259 260 261 262
     /* 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
263
          if( ARRAY_VAL( p_playlist->current, i ) == p_cur )
Clément Stenac's avatar
Clément Stenac committed
264 265 266 267 268
          {
              p_playlist->i_current_index = i;
              break;
          }
     }
Rémi Duraffort's avatar
Rémi Duraffort committed
269
     PL_DEBUG( "%s is at %i", PLI_NAME( p_cur ), p_playlist->i_current_index );
Clément Stenac's avatar
Clément Stenac committed
270 271
}

272
void ResetCurrentlyPlaying( playlist_t *p_playlist, bool b_random,
273
                            playlist_item_t *p_cur )
Clément Stenac's avatar
Clément Stenac committed
274 275
{
    playlist_item_t *p_next = NULL;
276 277
    stats_TimerStart( p_playlist, "Items array build",
                      STATS_TIMER_PLAYLIST_BUILD );
Rémi Duraffort's avatar
Rémi Duraffort committed
278 279 280
    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
281 282 283 284 285 286
    p_playlist->i_current_index = -1;
    while( 1 )
    {
        /** FIXME: this is *slow* */
        p_next = playlist_GetNextLeaf( p_playlist,
                                       p_playlist->status.p_node,
287
                                       p_next, true, false );
Clément Stenac's avatar
Clément Stenac committed
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
        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
307
            /* swap the two items */
Clément Stenac's avatar
Clément Stenac committed
308 309 310 311 312
            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;
        }
    }
313
    p_playlist->b_reset_currently_playing = false;
314
    stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_BUILD );
Clément Stenac's avatar
Clément Stenac committed
315 316
}

Rémi Duraffort's avatar
Rémi Duraffort committed
317 318 319 320 321 322 323
/**
 * Compute the next playlist item depending on
 * the playlist course mode (forward, backward, random, view,...).
 *
 * \param p_playlist the playlist object
 * \return nothing
 */
324 325 326
playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
{
    playlist_item_t *p_new = NULL;
327
    int i_skip = 0, i;
328

329 330 331 332
    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" );
333 334 335

    /* Handle quickly a few special cases */
    /* No items to play */
Clément Stenac's avatar
Clément Stenac committed
336
    if( p_playlist->items.i_size == 0 )
337 338 339 340 341 342
    {
        msg_Info( p_playlist, "playlist is empty" );
        return NULL;
    }

    /* Repeat and play/stop */
343
    if( !p_playlist->request.b_request && b_repeat == true &&
344 345 346 347 348
         p_playlist->status.p_item )
    {
        msg_Dbg( p_playlist,"repeating item" );
        return p_playlist->status.p_item;
    }
349
    if( !p_playlist->request.b_request && b_playstop == true )
350
    {
Rémi Duraffort's avatar
Rémi Duraffort committed
351
        msg_Dbg( p_playlist,"stopping (play and stop)" );
352 353 354
        return NULL;
    }

355
    if( !p_playlist->request.b_request && p_playlist->status.p_item )
356
    {
357 358 359 360 361 362 363 364 365 366
        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;
        }
367 368 369 370 371
    }

    /* Start the real work */
    if( p_playlist->request.b_request )
    {
372 373
        p_new = p_playlist->request.p_item;
        i_skip = p_playlist->request.i_skip;
Clément Stenac's avatar
Clément Stenac committed
374
        PL_DEBUG( "processing request item %s node %s skip %i",
375 376
                        PLI_NAME( p_playlist->request.p_item ),
                        PLI_NAME( p_playlist->request.p_node ), i_skip );
377

Clément Stenac's avatar
Clément Stenac committed
378 379 380
        if( p_playlist->request.p_node &&
            p_playlist->request.p_node != p_playlist->status.p_node )
        {
381
            p_playlist->status.p_node = p_playlist->request.p_node;
382
            p_playlist->b_reset_currently_playing = true;
Clément Stenac's avatar
Clément Stenac committed
383
        }
384

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

Clément Stenac's avatar
Clément Stenac committed
389
        if( p_playlist->b_reset_currently_playing )
390
            /* A bit too bad to reset twice ... */
Clément Stenac's avatar
Clément Stenac committed
391 392 393 394 395 396
            ResetCurrentlyPlaying( p_playlist, b_random, p_new );
        else if( p_new )
            ResyncCurrentIndex( p_playlist, p_new );
        else
            p_playlist->i_current_index = -1;

397
        if( p_playlist->current.i_size && (i_skip > 0) )
398
        {
399 400
            if( p_playlist->i_current_index < -1 )
                p_playlist->i_current_index = -1;
401 402
            for( i = i_skip; i > 0 ; i-- )
            {
Clément Stenac's avatar
Clément Stenac committed
403
                p_playlist->i_current_index++;
404
                if( p_playlist->i_current_index >= p_playlist->current.i_size )
405
                {
406
                    PL_DEBUG( "looping - restarting at beginning of node" );
Clément Stenac's avatar
Clément Stenac committed
407
                    p_playlist->i_current_index = 0;
408 409
                }
            }
Clément Stenac's avatar
Clément Stenac committed
410 411
            p_new = ARRAY_VAL( p_playlist->current,
                               p_playlist->i_current_index );
412
        }
413
        else if( p_playlist->current.i_size && (i_skip < 0) )
414 415 416
        {
            for( i = i_skip; i < 0 ; i++ )
            {
Clément Stenac's avatar
Clément Stenac committed
417
                p_playlist->i_current_index--;
418
                if( p_playlist->i_current_index <= -1 )
419
                {
420
                    PL_DEBUG( "looping - restarting at end of node" );
Clément Stenac's avatar
Clément Stenac committed
421
                    p_playlist->i_current_index = p_playlist->current.i_size-1;
422 423
                }
            }
Clément Stenac's avatar
Clément Stenac committed
424 425
            p_new = ARRAY_VAL( p_playlist->current,
                               p_playlist->i_current_index );
426 427
        }
        /* Clear the request */
428
        p_playlist->request.b_request = false;
429 430 431 432
    }
    /* "Automatic" item change ( next ) */
    else
    {
Clément Stenac's avatar
Clément Stenac committed
433 434
        PL_DEBUG( "changing item without a request (current %i/%i)",
                  p_playlist->i_current_index, p_playlist->current.i_size );
435 436 437 438 439
        /* 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
440 441 442 443 444
        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
445
        assert( p_playlist->i_current_index <= p_playlist->current.i_size );
Clément Stenac's avatar
Clément Stenac committed
446
        if( p_playlist->i_current_index == p_playlist->current.i_size )
447
        {
Clément Stenac's avatar
Clément Stenac committed
448 449
            if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
            p_playlist->i_current_index = 0;
450
        }
Clément Stenac's avatar
Clément Stenac committed
451 452 453 454
        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 );
455 456 457 458 459 460 461
        /* 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
462 463 464 465 466 467 468
/**
 * Start the input for an item
 *
 * \param p_playlist the playlist objetc
 * \param p_item the item to play
 * \return nothing
 */
469 470
int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
{
471
    input_item_t *p_input = p_item->p_input;
472
    sout_instance_t **pp_sout = &libvlc_priv(p_playlist->p_libvlc)->p_sout;
Rémi Duraffort's avatar
Rémi Duraffort committed
473
    int i_activity = var_GetInteger( p_playlist, "activity" ) ;
474 475 476

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

477
    p_input->i_nb_played++;
478 479 480 481 482 483
    p_playlist->status.p_item = p_item;

    p_playlist->status.i_status = PLAYLIST_RUNNING;

    var_SetInteger( p_playlist, "activity", i_activity +
                    DEFAULT_INPUT_ACTIVITY );
484 485

    input_thread_t * p_input_thread =
486
        input_CreateThreadExtended( p_playlist, p_input, NULL, *pp_sout );
487 488 489
    playlist_set_current_input( p_playlist, p_input_thread );
    vlc_object_release( p_input_thread );

490
    *pp_sout = NULL;
491

492 493 494 495 496 497 498 499 500
    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 );

501 502
    if( p_playlist->p_fetcher &&
            p_playlist->p_fetcher->i_art_policy == ALBUM_ART_WHEN_PLAYED )
503
    {
504
        bool b_has_art;
505

506 507 508 509
        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
510
        /* p_input->p_meta should not be null after a successfull CreateThread */
511
        b_has_art = !EMPTY_STR( psz_arturl );
512

513
        if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
514
        {
515
            PL_DEBUG( "requesting art for %s", psz_name );
516 517
            playlist_AskForArtEnqueue( p_playlist, p_input );
        }
518 519
        free( psz_arturl );
        free( psz_name );
520
    }
521

522
    PL_UNLOCK;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
523
    var_SetInteger( p_playlist, "playlist-current", p_input->i_id );
524
    PL_LOCK;
525 526 527

    return VLC_SUCCESS;
}