control.c 17.2 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 52 53
    assert( pl != NULL );
    vlc_object_yield( pl );
    return pl;
}

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

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

    return i_result;
}

73
static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args )
74 75 76 77
{
    playlist_item_t *p_item, *p_node;
    vlc_value_t val;

78
    if( playlist_IsEmpty( p_playlist ) )
79 80 81 82 83 84
        return VLC_EGENERIC;

    switch( i_query )
    {
    case PLAYLIST_STOP:
        p_playlist->request.i_status = PLAYLIST_STOPPED;
85
        p_playlist->request.b_request = true;
86 87 88
        p_playlist->request.p_item = NULL;
        break;

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

    case PLAYLIST_PLAY:
        if( p_playlist->p_input )
        {
            val.i_int = PLAYING_S;
            var_Set( p_playlist->p_input, "state", val );
            break;
        }
115 116 117
        else
        {
            p_playlist->request.i_status = PLAYLIST_RUNNING;
118
            p_playlist->request.b_request = true;
119 120 121 122
            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;
        }
123 124 125 126 127 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
        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 );
154 155 156
        /* if already running, keep running */
        if( p_playlist->status.i_status != PLAYLIST_STOPPED )
            p_playlist->request.i_status = p_playlist->status.i_status;
157
        p_playlist->request.b_request = true;
158 159 160 161 162 163 164
        break;

    default:
        msg_Err( p_playlist, "unknown playlist query" );
        return VLC_EBADVAR;
        break;
    }
165
    vlc_cond_signal( &p_playlist->object_wait );
166 167 168 169 170 171 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 )
{
    vlc_mutex_lock( &p_playlist->p_preparse->object_lock );
    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 );
183
    vlc_cond_signal( &p_playlist->p_preparse->object_wait );
184
    vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
    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 )
{
    vlc_mutex_lock( &p_playlist->object_lock );
    vlc_mutex_lock( &p_playlist->p_preparse->object_lock );
    PreparseEnqueueItemSub( p_playlist, p_item );
    vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
    vlc_mutex_unlock( &p_playlist->object_lock );
    return VLC_SUCCESS;
}

201
int playlist_AskForArtEnqueue( playlist_t *p_playlist,
202
                               input_item_t *p_item )
203 204 205
{
    int i;

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

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

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

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

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

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

324 325 326 327
    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" );
328 329 330

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

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

350
    if( !p_playlist->request.b_request && p_playlist->status.p_item )
351
    {
352 353 354 355 356 357 358 359 360 361
        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;
        }
362 363 364 365 366
    }

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

Clément Stenac's avatar
Clément Stenac committed
373 374 375
        if( p_playlist->request.p_node &&
            p_playlist->request.p_node != p_playlist->status.p_node )
        {
376
            p_playlist->status.p_node = p_playlist->request.p_node;
377
            p_playlist->b_reset_currently_playing = true;
Clément Stenac's avatar
Clément Stenac committed
378
        }
379

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

Clément Stenac's avatar
Clément Stenac committed
384
        if( p_playlist->b_reset_currently_playing )
385
            /* A bit too bad to reset twice ... */
Clément Stenac's avatar
Clément Stenac committed
386 387 388 389 390 391
            ResetCurrentlyPlaying( p_playlist, b_random, p_new );
        else if( p_new )
            ResyncCurrentIndex( p_playlist, p_new );
        else
            p_playlist->i_current_index = -1;

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

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

472
    p_input->i_nb_played++;
473 474 475 476 477 478
    p_playlist->status.p_item = p_item;

    p_playlist->status.i_status = PLAYLIST_RUNNING;

    var_SetInteger( p_playlist, "activity", i_activity +
                    DEFAULT_INPUT_ACTIVITY );
479 480
    p_playlist->p_input = input_CreateThread( p_playlist, p_input );

481 482 483 484 485 486 487 488 489
    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 );

490 491
    if( p_playlist->p_fetcher &&
            p_playlist->p_fetcher->i_art_policy == ALBUM_ART_WHEN_PLAYED )
492
    {
493
        bool b_has_art;
494

495 496 497 498
        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
499
        /* p_input->p_meta should not be null after a successfull CreateThread */
500
        b_has_art = !EMPTY_STR( psz_arturl );
501

502
        if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
503
        {
504
            PL_DEBUG( "requesting art for %s", psz_name );
505 506
            playlist_AskForArtEnqueue( p_playlist, p_input );
        }
507 508
        free( psz_arturl );
        free( psz_name );
509
    }
510

511
    val.i_int = p_input->i_id;
512
    PL_UNLOCK;
Rémi Duraffort's avatar
Rémi Duraffort committed
513
    var_Set( p_playlist, "playlist-current", val );
514
    PL_LOCK;
515 516 517

    return VLC_SUCCESS;
}