control.c 16.1 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 26
 *****************************************************************************
 * 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/input.h>
#include "vlc_playlist.h"
27
#include "playlist_internal.h"
28
#include <assert.h>
29 30 31 32

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

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

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

41
int playlist_Control( playlist_t * p_playlist, int i_query, vlc_bool_t b_locked, ... )
42 43 44
{
    va_list args;
    int i_result;
45 46
    va_start( args, b_locked );
    if( !b_locked ) PL_LOCK;
47 48
    i_result = PlaylistVAControl( p_playlist, i_query, args );
    va_end( args );
49
    if( !b_locked ) PL_UNLOCK;
50 51 52 53

    return i_result;
}

54
static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args )
55 56 57 58
{
    playlist_item_t *p_item, *p_node;
    vlc_value_t val;

59
    if( playlist_IsEmpty( p_playlist ) )
60 61 62 63 64 65 66 67 68 69
        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;

70 71
    // Node can be null, it will keep the same. Use with care ...
    // Item null = take the first child of node
72 73 74 75 76
    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 )
        {
77
            p_node = p_playlist->status.p_node;
78
            assert( p_node );
79 80 81 82 83 84
        }
        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
85 86
        if( p_item && var_GetBool( p_playlist, "random" ) )
            p_playlist->b_reset_currently_playing = VLC_TRUE;
87 88 89 90 91 92 93 94 95
        break;

    case PLAYLIST_PLAY:
        if( p_playlist->p_input )
        {
            val.i_int = PLAYING_S;
            var_Set( p_playlist->p_input, "state", val );
            break;
        }
96 97 98 99 100 101 102 103
        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;
        }
104 105 106
        break;

    case PLAYLIST_AUTOPLAY:
107 108
        // AUTOPLAY is an ugly hack for initial status.
        // Hopefully it will disappear
109
        p_playlist->status.i_status = PLAYLIST_RUNNING;
110
        p_playlist->request.p_node = p_playlist->status.p_node;
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
        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 );
143 144 145
        /* if already running, keep running */
        if( p_playlist->status.i_status != PLAYLIST_STOPPED )
            p_playlist->request.i_status = p_playlist->status.i_status;
146 147 148 149 150 151 152 153
        p_playlist->request.b_request = VLC_TRUE;
        break;

    default:
        msg_Err( p_playlist, "unknown playlist query" );
        return VLC_EBADVAR;
        break;
    }
154
    vlc_cond_signal( &p_playlist->object_wait );
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172

    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 );
    vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
173
    vlc_cond_signal( &p_playlist->p_preparse->object_wait );
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
    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;
}

190 191 192 193 194 195 196 197
int playlist_AskForArtEnqueue( playlist_t *p_playlist,
                              input_item_t *p_item )
{
    int i;
    preparse_item_t p;
    p.p_item = p_item;
    p.b_fetch_art = VLC_TRUE;

198 199 200
    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;
201 202
         i++ );
    vlc_gc_incref( p_item );
203 204
    INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
                 p_playlist->p_fetcher->i_waiting,
205
                 i, p );
206 207
    vlc_mutex_unlock( &p_playlist->p_fetcher->object_lock );
    vlc_cond_signal( &p_playlist->p_fetcher->object_wait );
208 209 210
    return VLC_SUCCESS;
}

211 212
static void PreparseEnqueueItemSub( playlist_t *p_playlist,
                                    playlist_item_t *p_item )
213 214 215 216 217 218 219 220 221 222 223 224 225 226
{
    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++)
        {
227
            PreparseEnqueueItemSub( p_playlist, p_item->pp_children[i] );
228 229 230 231 232 233 234 235
        }
    }
}

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

Clément Stenac's avatar
Clément Stenac committed
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
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 );
}

253 254
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
255 256
{
    playlist_item_t *p_next = NULL;
257 258
    stats_TimerStart( p_playlist, "Items array build",
                      STATS_TIMER_PLAYLIST_BUILD );
Clément Stenac's avatar
Clément Stenac committed
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
    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;
296
    stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_BUILD );
Clément Stenac's avatar
Clément Stenac committed
297 298
}

299 300 301 302 303
/** 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;
304
    int i_skip = 0, i;
305 306 307 308 309 310 311 312

    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
313
    if( p_playlist->items.i_size == 0 )
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
    {
        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;
    }

332
    if( !p_playlist->request.b_request && p_playlist->status.p_item )
333
    {
334 335 336 337 338 339 340 341 342 343
        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;
        }
344 345 346 347 348
    }

    /* Start the real work */
    if( p_playlist->request.b_request )
    {
349 350
        p_new = p_playlist->request.p_item;
        i_skip = p_playlist->request.i_skip;
Clément Stenac's avatar
Clément Stenac committed
351
        PL_DEBUG( "processing request item %s node %s skip %i",
352 353
                        PLI_NAME( p_playlist->request.p_item ),
                        PLI_NAME( p_playlist->request.p_node ), i_skip );
354

Clément Stenac's avatar
Clément Stenac committed
355 356 357
        if( p_playlist->request.p_node &&
            p_playlist->request.p_node != p_playlist->status.p_node )
        {
358
            p_playlist->status.p_node = p_playlist->request.p_node;
Clément Stenac's avatar
Clément Stenac committed
359 360
            p_playlist->b_reset_currently_playing = VLC_TRUE;
        }
361

362 363
        /* If we are asked for a node, dont take it */
        if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
364 365
            i_skip++;

Clément Stenac's avatar
Clément Stenac committed
366
        if( p_playlist->b_reset_currently_playing )
367
            /* A bit too bad to reset twice ... */
Clément Stenac's avatar
Clément Stenac committed
368 369 370 371 372 373 374
            ResetCurrentlyPlaying( p_playlist, b_random, p_new );
        else if( p_new )
            ResyncCurrentIndex( p_playlist, p_new );
        else
            p_playlist->i_current_index = -1;

        if( p_playlist->current.i_size && i_skip > 0 )
375 376 377
        {
            for( i = i_skip; i > 0 ; i-- )
            {
Clément Stenac's avatar
Clément Stenac committed
378 379
                p_playlist->i_current_index++;
                if( p_playlist->i_current_index == p_playlist->current.i_size )
380
                {
381
                    PL_DEBUG( "looping - restarting at beginning of node" );
Clément Stenac's avatar
Clément Stenac committed
382
                    p_playlist->i_current_index = 0;
383 384
                }
            }
Clément Stenac's avatar
Clément Stenac committed
385 386
            p_new = ARRAY_VAL( p_playlist->current,
                               p_playlist->i_current_index );
387
        }
Clément Stenac's avatar
Clément Stenac committed
388
        else if( p_playlist->current.i_size && i_skip < 0 )
389 390 391
        {
            for( i = i_skip; i < 0 ; i++ )
            {
Clément Stenac's avatar
Clément Stenac committed
392 393
                p_playlist->i_current_index--;
                if( p_playlist->i_current_index == -1 )
394
                {
395
                    PL_DEBUG( "looping - restarting at end of node" );
Clément Stenac's avatar
Clément Stenac committed
396
                    p_playlist->i_current_index = p_playlist->current.i_size-1;
397 398
                }
            }
Clément Stenac's avatar
Clément Stenac committed
399 400
            p_new = ARRAY_VAL( p_playlist->current,
                               p_playlist->i_current_index );
401 402 403 404 405 406 407
        }
        /* Clear the request */
        p_playlist->request.b_request = VLC_FALSE;
    }
    /* "Automatic" item change ( next ) */
    else
    {
Clément Stenac's avatar
Clément Stenac committed
408 409
        PL_DEBUG( "changing item without a request (current %i/%i)",
                  p_playlist->i_current_index, p_playlist->current.i_size );
410 411 412 413 414
        /* 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
415 416 417 418 419 420
        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 )
421
        {
Clément Stenac's avatar
Clément Stenac committed
422 423
            if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
            p_playlist->i_current_index = 0;
424
        }
Clément Stenac's avatar
Clément Stenac committed
425 426 427 428
        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 );
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
        /* 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;
    int i_activity = var_GetInteger( p_playlist, "activity") ;

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

    p_item->p_input->i_nb_played++;
    p_playlist->status.p_item = p_item;

    p_playlist->status.i_status = PLAYLIST_RUNNING;

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

    val.i_int = p_item->p_input->i_id;
    /* unlock the playlist to set the var...mmm */
    vlc_mutex_unlock( &p_playlist->object_lock);
    var_Set( p_playlist, "playlist-current", val);
    vlc_mutex_lock( &p_playlist->object_lock);

    return VLC_SUCCESS;
}