git.sesse.net Git - vlc/blob - src/playlist/control.c

   1 /*****************************************************************************
   2  * control.c : Handle control of the playlist & running through it
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 the VideoLAN team
   5  * $Id: /local/vlc/0.8.6-playlist-vlm/src/playlist/playlist.c 13741 2006-03-21T19:29:39.792444Z zorglub  $
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *          Clément Stenac <zorglub@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24 #include <vlc/vlc.h>
  25 #include <vlc/input.h>
  26 #include "vlc_playlist.h"
  27 #include "playlist_internal.h"
  28 #include <assert.h>
  29
  30 /*****************************************************************************
  31  * Local prototypes
  32  *****************************************************************************/
  33 int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args );
  34
  35 void PreparseEnqueueItemSub( playlist_t *, playlist_item_t * );
  36
  37 playlist_item_t *playlist_RecursiveFindLast(playlist_t *p_playlist,
  38                                             playlist_item_t *p_node );
  39
  40 /*****************************************************************************
  41  * Playlist control
  42  *****************************************************************************/
  43
  44 /**
  45  * Do a playlist action. Should be entered without playlist lock
  46  * \see playlist_Control
  47  */
  48 int playlist_LockControl( playlist_t * p_playlist, int i_query, ... )
  49 {
  50     va_list args;
  51     int i_result;
  52     va_start( args, i_query );
  53     vlc_mutex_lock( &p_playlist->object_lock );
  54     i_result = PlaylistVAControl( p_playlist, i_query, args );
  55     va_end( args );
  56     vlc_mutex_unlock( &p_playlist->object_lock );
  57     return i_result;
  58 }
  59
  60 /**
  61  * Do a playlist action.
  62  * If there is something in the playlist then you can do playlist actions.
  63  * Should be entered with playlist lock. See include/vlc_playlist.h for
  64  * possible queries
  65  *
  66  * \param p_playlist the playlist to do the command on
  67  * \param i_query the command to do
  68  * \param variable number of arguments
  69  * \return VLC_SUCCESS or an error
  70  */
  71 int playlist_Control( playlist_t * p_playlist, int i_query, ... )
  72 {
  73     va_list args;
  74     int i_result;
  75     va_start( args, i_query );
  76     i_result = PlaylistVAControl( p_playlist, i_query, args );
  77     va_end( args );
  78
  79     return i_result;
  80 }
  81
  82 int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args )
  83 {
  84     playlist_item_t *p_item, *p_node;
  85     vlc_value_t val;
  86
  87     if( p_playlist->i_size <= 0 )
  88     {
  89         return VLC_EGENERIC;
  90     }
  91
  92     switch( i_query )
  93     {
  94     case PLAYLIST_STOP:
  95         p_playlist->request.i_status = PLAYLIST_STOPPED;
  96         p_playlist->request.b_request = VLC_TRUE;
  97         p_playlist->request.p_item = NULL;
  98         break;
  99
 100     // Node can be null, it will keep the same. Use with care ...
 101     // Item null = take the first child of node
 102     case PLAYLIST_VIEWPLAY:
 103         p_playlist->b_reset_random = VLC_TRUE;
 104         p_node = (playlist_item_t *)va_arg( args, playlist_item_t * );
 105         p_item = (playlist_item_t *)va_arg( args, playlist_item_t * );
 106         if ( p_node == NULL )
 107         {
 108             p_node = p_playlist->status.p_node;
 109             assert( p_node );
 110         }
 111         p_playlist->request.i_status = PLAYLIST_RUNNING;
 112         p_playlist->request.i_skip = 0;
 113         p_playlist->request.b_request = VLC_TRUE;
 114         p_playlist->request.p_node = p_node;
 115         p_playlist->request.p_item = p_item;
 116         break;
 117
 118     case PLAYLIST_PLAY:
 119         if( p_playlist->p_input )
 120         {
 121             val.i_int = PLAYING_S;
 122             var_Set( p_playlist->p_input, "state", val );
 123             break;
 124         }
 125         else
 126         {
 127             p_playlist->request.i_status = PLAYLIST_RUNNING;
 128             p_playlist->request.b_request = VLC_TRUE;
 129             p_playlist->request.p_node = p_playlist->status.p_node;
 130             p_playlist->request.p_item = p_playlist->status.p_item;
 131             p_playlist->request.i_skip = 0;
 132         }
 133         break;
 134
 135     case PLAYLIST_AUTOPLAY:
 136         // AUTOPLAY is an ugly hack for initial status.
 137         // Hopefully it will disappear
 138         p_playlist->status.i_status = PLAYLIST_RUNNING;
 139         p_playlist->request.p_node = p_playlist->status.p_node;
 140         p_playlist->request.b_request = VLC_FALSE;
 141         break;
 142
 143     case PLAYLIST_PAUSE:
 144         val.i_int = 0;
 145         if( p_playlist->p_input )
 146             var_Get( p_playlist->p_input, "state", &val );
 147
 148         if( val.i_int == PAUSE_S )
 149         {
 150             p_playlist->status.i_status = PLAYLIST_RUNNING;
 151             if( p_playlist->p_input )
 152             {
 153                 val.i_int = PLAYING_S;
 154                 var_Set( p_playlist->p_input, "state", val );
 155             }
 156         }
 157         else
 158         {
 159             p_playlist->status.i_status = PLAYLIST_PAUSED;
 160             if( p_playlist->p_input )
 161             {
 162                 val.i_int = PAUSE_S;
 163                 var_Set( p_playlist->p_input, "state", val );
 164             }
 165         }
 166         break;
 167
 168     case PLAYLIST_SKIP:
 169         p_playlist->request.p_node = p_playlist->status.p_node;
 170         p_playlist->request.p_item = p_playlist->status.p_item;
 171         p_playlist->request.i_skip = (int) va_arg( args, int );
 172         /* if already running, keep running */
 173         if( p_playlist->status.i_status != PLAYLIST_STOPPED )
 174             p_playlist->request.i_status = p_playlist->status.i_status;
 175         p_playlist->request.b_request = VLC_TRUE;
 176         break;
 177
 178     default:
 179         msg_Err( p_playlist, "unknown playlist query" );
 180         return VLC_EBADVAR;
 181         break;
 182     }
 183
 184     return VLC_SUCCESS;
 185 }
 186
 187 /*****************************************************************************
 188  * Preparse control
 189  *****************************************************************************/
 190 /** Enqueue an item for preparsing */
 191 int playlist_PreparseEnqueue( playlist_t *p_playlist,
 192                               input_item_t *p_item )
 193 {
 194     vlc_mutex_lock( &p_playlist->p_preparse->object_lock );
 195     vlc_gc_incref( p_item );
 196     INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
 197                  p_playlist->p_preparse->i_waiting,
 198                  p_playlist->p_preparse->i_waiting,
 199                  p_item );
 200     vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
 201     return VLC_SUCCESS;
 202 }
 203
 204 /** Enqueue a playlist item or a node for peparsing.
 205  *  This function should be entered without playlist and preparser locks */
 206 int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
 207                                   playlist_item_t *p_item )
 208 {
 209     vlc_mutex_lock( &p_playlist->object_lock );
 210     vlc_mutex_lock( &p_playlist->p_preparse->object_lock );
 211     PreparseEnqueueItemSub( p_playlist, p_item );
 212     vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
 213     vlc_mutex_unlock( &p_playlist->object_lock );
 214     return VLC_SUCCESS;
 215 }
 216
 217 void PreparseEnqueueItemSub( playlist_t *p_playlist,
 218                              playlist_item_t *p_item )
 219 {
 220     int i;
 221     if( p_item->i_children == -1 )
 222     {
 223         vlc_gc_incref( p_item );
 224         INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
 225                      p_playlist->p_preparse->i_waiting,
 226                      p_playlist->p_preparse->i_waiting,
 227                      p_item->p_input );
 228     }
 229     else
 230     {
 231         for( i = 0; i < p_item->i_children; i++)
 232         {
 233             PreparseEnqueueItemSub( p_playlist,
 234                                              p_item->pp_children[i] );
 235         }
 236     }
 237 }
 238
 239 /*****************************************************************************
 240  * Playback logic
 241  *****************************************************************************/
 242
 243 /** This function calculates the next playlist item, depending
 244  *  on the playlist course mode (forward, backward, random, view,...). */
 245 playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
 246 {
 247     playlist_item_t *p_new = NULL;
 248     int i_skip = 0, i;
 249
 250     vlc_bool_t b_loop = var_GetBool( p_playlist, "loop" );
 251     vlc_bool_t b_random = var_GetBool( p_playlist, "random" );
 252     vlc_bool_t b_repeat = var_GetBool( p_playlist, "repeat" );
 253     vlc_bool_t b_playstop = var_GetBool( p_playlist, "play-and-stop" );
 254
 255     /* Handle quickly a few special cases */
 256     /* No items to play */
 257     if( p_playlist->i_size == 0 )
 258     {
 259         msg_Info( p_playlist, "playlist is empty" );
 260         return NULL;
 261     }
 262
 263     /* Repeat and play/stop */
 264     if( !p_playlist->request.b_request && b_repeat == VLC_TRUE &&
 265          p_playlist->status.p_item )
 266     {
 267         msg_Dbg( p_playlist,"repeating item" );
 268         return p_playlist->status.p_item;
 269     }
 270     if( !p_playlist->request.b_request && b_playstop == VLC_TRUE )
 271     {
 272         msg_Dbg( p_playlist,"stopping (play and stop)");
 273         return NULL;
 274     }
 275
 276     if( !p_playlist->request.b_request && p_playlist->status.p_item )
 277     {
 278         playlist_item_t *p_parent = p_playlist->status.p_item;
 279         while( p_parent )
 280         {
 281             if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
 282             {
 283                 msg_Dbg( p_playlist, "blocking item, stopping") ;
 284                 return NULL;
 285             }
 286             p_parent = p_parent->p_parent;
 287         }
 288     }
 289
 290     /* Random case. This is an exception: if request, but request is skip +- 1
 291      * we don't go to next item but select a new random one. */
 292     if( b_random &&
 293         ( !p_playlist->request.b_request ||
 294         ( p_playlist->request.b_request &&
 295             ( p_playlist->request.p_item == NULL ||
 296               p_playlist->request.i_skip == 1    ||
 297               p_playlist->request.i_skip == -1 ) ) ) )
 298     {
 299        PL_DEBUG( "doing random, have %i items, currently at %i, reset %i\n",
 300                         p_playlist->i_random, p_playlist->i_random_index,
 301                         p_playlist->b_reset_random );
 302        if( p_playlist->b_reset_random )
 303         {
 304             int j;
 305             FREE( p_playlist->pp_random );
 306             if( !p_playlist->b_reset_random &&  !b_loop ) goto end;
 307             p_playlist->i_random = 0;
 308             p_playlist->i_random_index = 0;
 309             p_playlist->i_random = playlist_GetAllEnabledChildren(
 310                                                 p_playlist,
 311                                                 p_playlist->status.p_node,
 312                                                 &p_playlist->pp_random );
 313             /* Shuffle the array */
 314             srand( (unsigned int)mdate() );
 315             int swap = 0;
 316             for( j = p_playlist->i_random -1; j > 0; j-- )
 317             {
 318                 swap++;
 319                 int i = rand() % (j+1); /* between 0 and j */
 320                 playlist_item_t *p_tmp;
 321                 p_tmp = p_playlist->pp_random[i];
 322                 p_playlist->pp_random[i] = p_playlist->pp_random[j];
 323                 p_playlist->pp_random[j] = p_tmp;
 324             }
 325             p_playlist->b_reset_random = VLC_FALSE;
 326             PL_DEBUG( "random rebuilt, have %i items", p_playlist->i_random );
 327         }
 328         else
 329         {
 330             /* Go backward or forward */
 331             if( !p_playlist->request.b_request || !p_playlist->request.p_item ||
 332                                                p_playlist->request.i_skip == 1 )
 333                 p_playlist->i_random_index++;
 334             else
 335                 p_playlist->i_random_index--;
 336             /* Handle bounds situations */
 337             if( p_playlist->i_random_index == -1 )
 338             {
 339                 if( !b_loop || p_playlist->i_random == 0 ) goto end;
 340                 p_playlist->i_random_index = p_playlist->i_random - 1;
 341             }
 342             else if( p_playlist->i_random_index == p_playlist->i_random )
 343             {
 344                 if( !b_loop || p_playlist->i_random == 0 ) goto end;
 345                 p_playlist->i_random_index = 0;
 346             }
 347         }
 348         PL_DEBUG( "using random item %i", p_playlist->i_random_index );
 349         if ( p_playlist->i_random == 0 ) goto end; /* Can this happen ?? */
 350         p_new = p_playlist->pp_random[p_playlist->i_random_index];
 351 end:
 352         if( !p_new ) p_playlist->b_reset_random = VLC_TRUE;
 353         p_playlist->request.i_skip = 0;
 354         p_playlist->request.b_request = VLC_FALSE;
 355         return p_new;
 356     }
 357
 358     /* Start the real work */
 359     if( p_playlist->request.b_request )
 360     {
 361         p_new = p_playlist->request.p_item;
 362         i_skip = p_playlist->request.i_skip;
 363         PL_DEBUG( "processing request item %s node %s skip %i",
 364                         PLI_NAME( p_playlist->request.p_item ),
 365                         PLI_NAME( p_playlist->request.p_node ), i_skip );
 366
 367         if( p_playlist->request.p_node )
 368             p_playlist->status.p_node = p_playlist->request.p_node;
 369
 370         /* If we are asked for a node, dont take it */
 371         if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
 372             i_skip++;
 373
 374         if( i_skip > 0 )
 375         {
 376             for( i = i_skip; i > 0 ; i-- )
 377             {
 378                 p_new = playlist_GetNextLeaf( p_playlist,
 379                                               p_playlist->request.p_node,
 380                                               p_new, VLC_TRUE, VLC_FALSE );
 381                 if( p_new == NULL )
 382                 {
 383                     PL_DEBUG( "looping - restarting at beginning of node" );
 384                     p_new = playlist_GetNextLeaf( p_playlist,
 385                                                   p_playlist->request.p_node,
 386                                                   NULL, VLC_TRUE, VLC_FALSE);
 387                     if( p_new == NULL ) break;
 388                 }
 389             }
 390         }
 391         else if( i_skip < 0 )
 392         {
 393             for( i = i_skip; i < 0 ; i++ )
 394             {
 395                 p_new = playlist_GetPrevLeaf( p_playlist,
 396                                               p_playlist->request.p_node,
 397                                               p_new, VLC_FALSE, VLC_FALSE );
 398                 if( p_new == NULL )
 399                 {
 400                     PL_DEBUG( "looping - restarting at end of node" );
 401                     /** \bug This is needed because GetPrevLeaf does not loop
 402                       * by itself */
 403                     p_new = playlist_GetLastLeaf( p_playlist,
 404                                                  p_playlist->request.p_node );
 405                 }
 406                 if( p_new == NULL ) break;
 407             }
 408         }
 409         /* Clear the request */
 410         p_playlist->request.b_request = VLC_FALSE;
 411     }
 412     /* "Automatic" item change ( next ) */
 413     else
 414     {
 415         PL_DEBUG( "changing item without a request" );
 416         /* Cant go to next from current item */
 417         if( p_playlist->status.p_item &&
 418             p_playlist->status.p_item->i_flags & PLAYLIST_SKIP_FLAG )
 419             return NULL;
 420
 421         p_new = playlist_GetNextLeaf( p_playlist,
 422                                       p_playlist->status.p_node,
 423                                       p_playlist->status.p_item,
 424                                       VLC_TRUE, VLC_FALSE );
 425         if( p_new == NULL && b_loop )
 426         {
 427             PL_DEBUG( "looping" );
 428             p_new = playlist_GetNextLeaf( p_playlist,
 429                                           p_playlist->status.p_node,
 430                                           NULL, VLC_TRUE, VLC_FALSE );
 431         }
 432         /* The new item can't be autoselected  */
 433         if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
 434             return NULL;
 435     }
 436     if( p_new == NULL )
 437     {
 438         msg_Dbg( p_playlist, "did not find something to play" );
 439     }
 440     return p_new;
 441 }
 442
 443 /** Start the input for an item */
 444 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
 445 {
 446     vlc_value_t val;
 447     int i_activity = var_GetInteger( p_playlist, "activity") ;
 448
 449     msg_Dbg( p_playlist, "creating new input thread" );
 450
 451     p_item->p_input->i_nb_played++;
 452     p_playlist->status.p_item = p_item;
 453
 454     p_playlist->status.i_status = PLAYLIST_RUNNING;
 455
 456     var_SetInteger( p_playlist, "activity", i_activity +
 457                     DEFAULT_INPUT_ACTIVITY );
 458     p_playlist->p_input = input_CreateThread( p_playlist, p_item->p_input );
 459
 460     val.i_int = p_item->p_input->i_id;
 461     /* unlock the playlist to set the var...mmm */
 462     vlc_mutex_unlock( &p_playlist->object_lock);
 463     var_Set( p_playlist, "playlist-current", val);
 464     vlc_mutex_lock( &p_playlist->object_lock);
 465
 466     return VLC_SUCCESS;
 467 }