control.c 17.4 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 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
 *****************************************************************************
 * Copyright (C) 1999-2004 the VideoLAN team
 * $Id: /local/vlc/0.8.6-playlist-vlm/src/playlist/playlist.c 13741 2006-03-21T19:29:39.792444Z zorglub  $
 *
 * 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.
 *****************************************************************************/
#include <vlc/vlc.h>
#include "vlc_playlist.h"
26
#include "playlist_internal.h"
27
#include <assert.h>
28 29 30 31

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

34
static void PreparseEnqueueItemSub( playlist_t *, playlist_item_t * );
35 36 37 38 39

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

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
playlist_t *__pl_Yield( vlc_object_t *p_this )
{
    playlist_t *pl = p_this->p_libvlc->p_playlist;
    assert( pl != NULL );
    vlc_object_yield( pl );
    return pl;
}

void __pl_Release( vlc_object_t *p_this )
{
    playlist_t *pl = p_this->p_libvlc->p_playlist;
    assert( pl != NULL );
    vlc_object_release( pl );
}

int playlist_Control( playlist_t * p_playlist, int i_query,
                      vlc_bool_t b_locked, ... )
57 58 59
{
    va_list args;
    int i_result;
60 61
    va_start( args, b_locked );
    if( !b_locked ) PL_LOCK;
62 63
    i_result = PlaylistVAControl( p_playlist, i_query, args );
    va_end( args );
64
    if( !b_locked ) PL_UNLOCK;
65 66 67 68

    return i_result;
}

69
static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args )
70 71 72 73
{
    playlist_item_t *p_item, *p_node;
    vlc_value_t val;

74
    if( playlist_IsEmpty( p_playlist ) )
75 76 77 78 79 80 81 82 83 84
        return VLC_EGENERIC;

    switch( i_query )
    {
    case PLAYLIST_STOP:
        p_playlist->request.i_status = PLAYLIST_STOPPED;
        p_playlist->request.b_request = VLC_TRUE;
        p_playlist->request.p_item = NULL;
        break;

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

    case PLAYLIST_PLAY:
        if( p_playlist->p_input )
        {
            val.i_int = PLAYING_S;
            var_Set( p_playlist->p_input, "state", val );
            break;
        }
111 112 113 114 115 116 117 118
        else
        {
            p_playlist->request.i_status = PLAYLIST_RUNNING;
            p_playlist->request.b_request = VLC_TRUE;
            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;
        }
119 120 121
        break;

    case PLAYLIST_AUTOPLAY:
122 123
        // AUTOPLAY is an ugly hack for initial status.
        // Hopefully it will disappear
124
        p_playlist->status.i_status = PLAYLIST_RUNNING;
125
        p_playlist->request.p_node = p_playlist->status.p_node;
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 154 155 156 157
        p_playlist->request.b_request = VLC_FALSE;
        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 );
158 159 160
        /* if already running, keep running */
        if( p_playlist->status.i_status != PLAYLIST_STOPPED )
            p_playlist->request.i_status = p_playlist->status.i_status;
161 162 163 164 165 166 167 168
        p_playlist->request.b_request = VLC_TRUE;
        break;

    default:
        msg_Err( p_playlist, "unknown playlist query" );
        return VLC_EBADVAR;
        break;
    }
169
    vlc_cond_signal( &p_playlist->object_wait );
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186

    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 );
187
    vlc_cond_signal( &p_playlist->p_preparse->object_wait );
188
    vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
    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;
}

205
int playlist_AskForArtEnqueue( playlist_t *p_playlist,
206
                               input_item_t *p_item )
207 208 209 210 211 212
{
    int i;
    preparse_item_t p;
    p.p_item = p_item;
    p.b_fetch_art = VLC_TRUE;

213 214 215
    vlc_mutex_lock( &p_playlist->p_fetcher->object_lock );
    for( i = 0; i < p_playlist->p_fetcher->i_waiting &&
         p_playlist->p_fetcher->p_waiting->b_fetch_art == VLC_TRUE;
216 217
         i++ );
    vlc_gc_incref( p_item );
218 219
    INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
                 p_playlist->p_fetcher->i_waiting,
220
                 i, p );
221
    vlc_cond_signal( &p_playlist->p_fetcher->object_wait );
222
    vlc_mutex_unlock( &p_playlist->p_fetcher->object_lock );
223 224 225
    return VLC_SUCCESS;
}

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

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

Clément Stenac's avatar
Clément Stenac committed
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
static void ResyncCurrentIndex(playlist_t *p_playlist, playlist_item_t *p_cur )
{
     PL_DEBUG("resyncing on %s", PLI_NAME(p_cur) );
     /* Simply resync index */
     int i;
     p_playlist->i_current_index = -1;
     for( i = 0 ; i< p_playlist->current.i_size; i++ )
     {
          if( ARRAY_VAL(p_playlist->current, i) == p_cur )
          {
              p_playlist->i_current_index = i;
              break;
          }
     }
     PL_DEBUG("%s is at %i", PLI_NAME(p_cur), p_playlist->i_current_index );
}

268 269
void ResetCurrentlyPlaying( playlist_t *p_playlist, vlc_bool_t b_random,
                            playlist_item_t *p_cur )
Clément Stenac's avatar
Clément Stenac committed
270 271
{
    playlist_item_t *p_next = NULL;
272 273
    stats_TimerStart( p_playlist, "Items array build",
                      STATS_TIMER_PLAYLIST_BUILD );
Clément Stenac's avatar
Clément Stenac committed
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
    PL_DEBUG("rebuilding array of current - root %s",
              PLI_NAME(p_playlist->status.p_node) );
    ARRAY_RESET(p_playlist->current);
    p_playlist->i_current_index = -1;
    while( 1 )
    {
        /** FIXME: this is *slow* */
        p_next = playlist_GetNextLeaf( p_playlist,
                                       p_playlist->status.p_node,
                                       p_next, VLC_TRUE, VLC_FALSE );
        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 swap = 0;
        int j;
        for( j = p_playlist->current.i_size - 1; j > 0; j-- )
        {
            swap++;
            int i = rand() % (j+1); /* between 0 and j */
            playlist_item_t *p_tmp;
            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;
        }
    }
    p_playlist->b_reset_currently_playing = VLC_FALSE;
311
    stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_BUILD );
Clément Stenac's avatar
Clément Stenac committed
312 313
}

314 315 316 317 318
/** This function calculates the next playlist item, depending
 *  on the playlist course mode (forward, backward, random, view,...). */
playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
{
    playlist_item_t *p_new = NULL;
319
    int i_skip = 0, i;
320 321 322 323 324 325 326 327

    vlc_bool_t b_loop = var_GetBool( p_playlist, "loop" );
    vlc_bool_t b_random = var_GetBool( p_playlist, "random" );
    vlc_bool_t b_repeat = var_GetBool( p_playlist, "repeat" );
    vlc_bool_t b_playstop = var_GetBool( p_playlist, "play-and-stop" );

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

    /* Repeat and play/stop */
    if( !p_playlist->request.b_request && b_repeat == VLC_TRUE &&
         p_playlist->status.p_item )
    {
        msg_Dbg( p_playlist,"repeating item" );
        return p_playlist->status.p_item;
    }
    if( !p_playlist->request.b_request && b_playstop == VLC_TRUE )
    {
        msg_Dbg( p_playlist,"stopping (play and stop)");
        return NULL;
    }

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

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

Clément Stenac's avatar
Clément Stenac committed
370 371 372
        if( p_playlist->request.p_node &&
            p_playlist->request.p_node != p_playlist->status.p_node )
        {
373
            p_playlist->status.p_node = p_playlist->request.p_node;
Clément Stenac's avatar
Clément Stenac committed
374 375
            p_playlist->b_reset_currently_playing = VLC_TRUE;
        }
376

377 378
        /* If we are asked for a node, dont take it */
        if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
379 380
            i_skip++;

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

389
        if( p_playlist->current.i_size && (i_skip > 0) )
390
        {
391 392
            if( p_playlist->i_current_index < -1 )
                p_playlist->i_current_index = -1;
393 394
            for( i = i_skip; i > 0 ; i-- )
            {
Clément Stenac's avatar
Clément Stenac committed
395
                p_playlist->i_current_index++;
396
                if( p_playlist->i_current_index >= p_playlist->current.i_size )
397
                {
398
                    PL_DEBUG( "looping - restarting at beginning of node" );
Clément Stenac's avatar
Clément Stenac committed
399
                    p_playlist->i_current_index = 0;
400 401
                }
            }
Clément Stenac's avatar
Clément Stenac committed
402 403
            p_new = ARRAY_VAL( p_playlist->current,
                               p_playlist->i_current_index );
404
        }
405
        else if( p_playlist->current.i_size && (i_skip < 0) )
406 407 408
        {
            for( i = i_skip; i < 0 ; i++ )
            {
Clément Stenac's avatar
Clément Stenac committed
409
                p_playlist->i_current_index--;
410
                if( p_playlist->i_current_index <= -1 )
411
                {
412
                    PL_DEBUG( "looping - restarting at end of node" );
Clément Stenac's avatar
Clément Stenac committed
413
                    p_playlist->i_current_index = p_playlist->current.i_size-1;
414 415
                }
            }
Clément Stenac's avatar
Clément Stenac committed
416 417
            p_new = ARRAY_VAL( p_playlist->current,
                               p_playlist->i_current_index );
418 419 420 421 422 423 424
        }
        /* Clear the request */
        p_playlist->request.b_request = VLC_FALSE;
    }
    /* "Automatic" item change ( next ) */
    else
    {
Clément Stenac's avatar
Clément Stenac committed
425 426
        PL_DEBUG( "changing item without a request (current %i/%i)",
                  p_playlist->i_current_index, p_playlist->current.i_size );
427 428 429 430 431
        /* 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
432 433 434 435 436 437
        if( p_playlist->b_reset_currently_playing )
            ResetCurrentlyPlaying( p_playlist, b_random,
                                   p_playlist->status.p_item );

        p_playlist->i_current_index++;
        if( p_playlist->i_current_index == p_playlist->current.i_size )
438
        {
Clément Stenac's avatar
Clément Stenac committed
439 440
            if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
            p_playlist->i_current_index = 0;
441
        }
Clément Stenac's avatar
Clément Stenac committed
442 443 444 445
        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 );
446 447 448 449 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;
}

/** Start the input for an item */
int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
{
    vlc_value_t val;
457
    input_item_t *p_input = p_item->p_input;
458 459 460 461
    int i_activity = var_GetInteger( p_playlist, "activity") ;

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

462
    p_input->i_nb_played++;
463 464 465 466 467 468
    p_playlist->status.p_item = p_item;

    p_playlist->status.i_status = PLAYLIST_RUNNING;

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

471 472 473 474 475 476 477 478 479
    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 );

480 481
    if( p_playlist->p_fetcher &&
            p_playlist->p_fetcher->i_art_policy == ALBUM_ART_WHEN_PLAYED )
482
    {
483 484
        vlc_bool_t b_has_art;

485 486 487 488 489 490
        char *psz_arturl, *psz_name;
        psz_arturl = input_item_GetArtURL( p_input );
        psz_name = input_item_GetName( p_input );

        /* p_input->p_meta should not be null after a successfull CreateThread*/
        b_has_art = !EMPTY_STR( psz_arturl );
491 492

        if( !b_has_art )
493
        {
494
            PL_DEBUG( "requesting art for %s", psz_name );
495 496
            playlist_AskForArtEnqueue( p_playlist, p_input );
        }
497 498
        free( psz_arturl );
        free( psz_name );
499
    }
500

501
    val.i_int = p_input->i_id;
502 503 504 505 506 507
    vlc_mutex_unlock( &p_playlist->object_lock);
    var_Set( p_playlist, "playlist-current", val);
    vlc_mutex_lock( &p_playlist->object_lock);

    return VLC_SUCCESS;
}