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$
   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 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <vlc_common.h>
  29 #include "vlc_playlist.h"
  30 #include "playlist_internal.h"
  31 #include <assert.h>
  32
  33 /*****************************************************************************
  34  * Local prototypes
  35  *****************************************************************************/
  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  * Playlist control
  42  *****************************************************************************/
  43
  44 playlist_t *__pl_Yield( vlc_object_t *p_this )
  45 {
  46     playlist_t *pl;
  47
  48     barrier ();
  49     pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
  50     if (pl)
  51         vlc_object_yield (pl);
  52     return pl;
  53 }
  54
  55 void __pl_Release( vlc_object_t *p_this )
  56 {
  57     playlist_t *pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
  58     assert( pl != NULL );
  59     vlc_object_release( pl );
  60 }
  61
  62 int playlist_Control( playlist_t * p_playlist, int i_query,
  63                       bool b_locked, ... )
  64 {
  65     va_list args;
  66     int i_result;
  67     va_start( args, b_locked );
  68     if( !b_locked ) PL_LOCK;
  69     i_result = PlaylistVAControl( p_playlist, i_query, args );
  70     va_end( args );
  71     if( !b_locked ) PL_UNLOCK;
  72
  73     return i_result;
  74 }
  75
  76 static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args )
  77 {
  78     playlist_item_t *p_item, *p_node;
  79     vlc_value_t val;
  80
  81     if( !vlc_object_alive( p_playlist ) )
  82         return VLC_EGENERIC;
  83
  84     if( playlist_IsEmpty( p_playlist ) )
  85         return VLC_EGENERIC;
  86
  87     switch( i_query )
  88     {
  89     case PLAYLIST_STOP:
  90         p_playlist->request.i_status = PLAYLIST_STOPPED;
  91         p_playlist->request.b_request = true;
  92         p_playlist->request.p_item = NULL;
  93         break;
  94
  95     // Node can be null, it will keep the same. Use with care ...
  96     // Item null = take the first child of node
  97     case PLAYLIST_VIEWPLAY:
  98         p_node = (playlist_item_t *)va_arg( args, playlist_item_t * );
  99         p_item = (playlist_item_t *)va_arg( args, playlist_item_t * );
 100         if ( p_node == NULL )
 101         {
 102             p_node = p_playlist->status.p_node;
 103             assert( p_node );
 104         }
 105         p_playlist->request.i_status = PLAYLIST_RUNNING;
 106         p_playlist->request.i_skip = 0;
 107         p_playlist->request.b_request = true;
 108         p_playlist->request.p_node = p_node;
 109         p_playlist->request.p_item = p_item;
 110         if( p_item && var_GetBool( p_playlist, "random" ) )
 111             p_playlist->b_reset_currently_playing = true;
 112         break;
 113
 114     case PLAYLIST_PLAY:
 115         if( p_playlist->p_input )
 116         {
 117             val.i_int = PLAYING_S;
 118             var_Set( p_playlist->p_input, "state", val );
 119             break;
 120         }
 121         else
 122         {
 123             p_playlist->request.i_status = PLAYLIST_RUNNING;
 124             p_playlist->request.b_request = true;
 125             p_playlist->request.p_node = p_playlist->status.p_node;
 126             p_playlist->request.p_item = p_playlist->status.p_item;
 127             p_playlist->request.i_skip = 0;
 128         }
 129         break;
 130
 131     case PLAYLIST_PAUSE:
 132         val.i_int = 0;
 133         if( p_playlist->p_input )
 134             var_Get( p_playlist->p_input, "state", &val );
 135
 136         if( val.i_int == PAUSE_S )
 137         {
 138             p_playlist->status.i_status = PLAYLIST_RUNNING;
 139             if( p_playlist->p_input )
 140             {
 141                 val.i_int = PLAYING_S;
 142                 var_Set( p_playlist->p_input, "state", val );
 143             }
 144         }
 145         else
 146         {
 147             p_playlist->status.i_status = PLAYLIST_PAUSED;
 148             if( p_playlist->p_input )
 149             {
 150                 val.i_int = PAUSE_S;
 151                 var_Set( p_playlist->p_input, "state", val );
 152             }
 153         }
 154         break;
 155
 156     case PLAYLIST_SKIP:
 157         p_playlist->request.p_node = p_playlist->status.p_node;
 158         p_playlist->request.p_item = p_playlist->status.p_item;
 159         p_playlist->request.i_skip = (int) va_arg( args, int );
 160         /* if already running, keep running */
 161         if( p_playlist->status.i_status != PLAYLIST_STOPPED )
 162             p_playlist->request.i_status = p_playlist->status.i_status;
 163         p_playlist->request.b_request = true;
 164         break;
 165
 166     default:
 167         msg_Err( p_playlist, "unknown playlist query" );
 168         return VLC_EBADVAR;
 169         break;
 170     }
 171     vlc_object_signal_maybe( VLC_OBJECT(p_playlist) );
 172
 173     return VLC_SUCCESS;
 174 }
 175
 176 /*****************************************************************************
 177  * Preparse control
 178  *****************************************************************************/
 179 /** Enqueue an item for preparsing */
 180 int playlist_PreparseEnqueue( playlist_t *p_playlist,
 181                               input_item_t *p_item )
 182 {
 183     vlc_object_lock( p_playlist->p_preparse );
 184     vlc_gc_incref( p_item );
 185     INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
 186                  p_playlist->p_preparse->i_waiting,
 187                  p_playlist->p_preparse->i_waiting,
 188                  p_item );
 189     vlc_object_signal_unlocked( p_playlist->p_preparse );
 190     vlc_object_unlock( p_playlist->p_preparse );
 191     return VLC_SUCCESS;
 192 }
 193
 194 /** Enqueue a playlist item or a node for peparsing.
 195  *  This function should be entered without playlist and preparser locks */
 196 int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
 197                                   playlist_item_t *p_item )
 198 {
 199     vlc_object_lock( p_playlist );
 200     vlc_object_lock( p_playlist->p_preparse );
 201     PreparseEnqueueItemSub( p_playlist, p_item );
 202     vlc_object_unlock( p_playlist->p_preparse );
 203     vlc_object_unlock( p_playlist );
 204     return VLC_SUCCESS;
 205 }
 206
 207 int playlist_AskForArtEnqueue( playlist_t *p_playlist,
 208                                input_item_t *p_item )
 209 {
 210     int i;
 211
 212     vlc_object_lock( p_playlist->p_fetcher );
 213     for( i = 0; i < p_playlist->p_fetcher->i_waiting ; i++ );
 214     vlc_gc_incref( p_item );
 215     INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
 216                  p_playlist->p_fetcher->i_waiting,
 217                  i, p_item );
 218     vlc_object_signal_unlocked( p_playlist->p_fetcher );
 219     vlc_object_unlock( p_playlist->p_fetcher );
 220     return VLC_SUCCESS;
 221 }
 222
 223 static void PreparseEnqueueItemSub( playlist_t *p_playlist,
 224                                     playlist_item_t *p_item )
 225 {
 226     int i;
 227     if( p_item->i_children == -1 )
 228     {
 229         vlc_gc_incref( p_item );
 230         INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
 231                      p_playlist->p_preparse->i_waiting,
 232                      p_playlist->p_preparse->i_waiting,
 233                      p_item->p_input );
 234     }
 235     else
 236     {
 237         for( i = 0; i < p_item->i_children; i++)
 238         {
 239             PreparseEnqueueItemSub( p_playlist, p_item->pp_children[i] );
 240         }
 241     }
 242 }
 243
 244 /*****************************************************************************
 245  * Playback logic
 246  *****************************************************************************/
 247
 248 /**
 249  * Synchronise the current index of the playlist
 250  * to match the index of the current item.
 251  *
 252  * \param p_playlist the playlist structure
 253  * \param p_cur the current playlist item
 254  * \return nothing
 255  */
 256 static void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur )
 257 {
 258      PL_DEBUG( "resyncing on %s", PLI_NAME( p_cur ) );
 259      /* Simply resync index */
 260      int i;
 261      p_playlist->i_current_index = -1;
 262      for( i = 0 ; i< p_playlist->current.i_size; i++ )
 263      {
 264           if( ARRAY_VAL( p_playlist->current, i ) == p_cur )
 265           {
 266               p_playlist->i_current_index = i;
 267               break;
 268           }
 269      }
 270      PL_DEBUG( "%s is at %i", PLI_NAME( p_cur ), p_playlist->i_current_index );
 271 }
 272
 273 void ResetCurrentlyPlaying( playlist_t *p_playlist, bool b_random,
 274                             playlist_item_t *p_cur )
 275 {
 276     playlist_item_t *p_next = NULL;
 277     stats_TimerStart( p_playlist, "Items array build",
 278                       STATS_TIMER_PLAYLIST_BUILD );
 279     PL_DEBUG( "rebuilding array of current - root %s",
 280               PLI_NAME( p_playlist->status.p_node ) );
 281     ARRAY_RESET( p_playlist->current );
 282     p_playlist->i_current_index = -1;
 283     while( 1 )
 284     {
 285         /** FIXME: this is *slow* */
 286         p_next = playlist_GetNextLeaf( p_playlist,
 287                                        p_playlist->status.p_node,
 288                                        p_next, true, false );
 289         if( p_next )
 290         {
 291             if( p_next == p_cur )
 292                 p_playlist->i_current_index = p_playlist->current.i_size;
 293             ARRAY_APPEND( p_playlist->current, p_next);
 294         }
 295         else break;
 296     }
 297     PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
 298                                                   p_playlist->i_current_index);
 299     if( b_random )
 300     {
 301         /* Shuffle the array */
 302         srand( (unsigned int)mdate() );
 303         int j;
 304         for( j = p_playlist->current.i_size - 1; j > 0; j-- )
 305         {
 306             int i = rand() % (j+1); /* between 0 and j */
 307             playlist_item_t *p_tmp;
 308             /* swap the two items */
 309             p_tmp = ARRAY_VAL(p_playlist->current, i);
 310             ARRAY_VAL(p_playlist->current,i) = ARRAY_VAL(p_playlist->current,j);
 311             ARRAY_VAL(p_playlist->current,j) = p_tmp;
 312         }
 313     }
 314     p_playlist->b_reset_currently_playing = false;
 315     stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_BUILD );
 316 }
 317
 318 /**
 319  * Compute the next playlist item depending on
 320  * the playlist course mode (forward, backward, random, view,...).
 321  *
 322  * \param p_playlist the playlist object
 323  * \return nothing
 324  */
 325 playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
 326 {
 327     playlist_item_t *p_new = NULL;
 328     int i_skip = 0, i;
 329
 330     bool b_loop = var_GetBool( p_playlist, "loop" );
 331     bool b_random = var_GetBool( p_playlist, "random" );
 332     bool b_repeat = var_GetBool( p_playlist, "repeat" );
 333     bool b_playstop = var_GetBool( p_playlist, "play-and-stop" );
 334
 335     /* Handle quickly a few special cases */
 336     /* No items to play */
 337     if( p_playlist->items.i_size == 0 )
 338     {
 339         msg_Info( p_playlist, "playlist is empty" );
 340         return NULL;
 341     }
 342
 343     /* Repeat and play/stop */
 344     if( !p_playlist->request.b_request && b_repeat == true &&
 345          p_playlist->status.p_item )
 346     {
 347         msg_Dbg( p_playlist,"repeating item" );
 348         return p_playlist->status.p_item;
 349     }
 350     if( !p_playlist->request.b_request && b_playstop == true )
 351     {
 352         msg_Dbg( p_playlist,"stopping (play and stop)" );
 353         return NULL;
 354     }
 355
 356     if( !p_playlist->request.b_request && p_playlist->status.p_item )
 357     {
 358         playlist_item_t *p_parent = p_playlist->status.p_item;
 359         while( p_parent )
 360         {
 361             if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
 362             {
 363                 msg_Dbg( p_playlist, "blocking item, stopping") ;
 364                 return NULL;
 365             }
 366             p_parent = p_parent->p_parent;
 367         }
 368     }
 369
 370     /* Start the real work */
 371     if( p_playlist->request.b_request )
 372     {
 373         p_new = p_playlist->request.p_item;
 374         i_skip = p_playlist->request.i_skip;
 375         PL_DEBUG( "processing request item %s node %s skip %i",
 376                         PLI_NAME( p_playlist->request.p_item ),
 377                         PLI_NAME( p_playlist->request.p_node ), i_skip );
 378
 379         /* Make sure the node wasn't deleted */
 380         if( p_playlist->status.p_node &&
 381             p_playlist->status.p_node->i_flags & PLAYLIST_REMOVE_FLAG )
 382         {
 383              PL_DEBUG( "%s was marked for deletion, deleting",
 384                              PLI_NAME( p_playlist->status.p_node  ) );
 385              playlist_ItemDelete( p_playlist->status.p_node );
 386              /* Don't attempt to reuse that node */
 387              if( p_playlist->status.p_node == p_playlist->request.p_node )
 388                 p_playlist->request.p_node = NULL;
 389              p_playlist->status.p_node = NULL;
 390         }
 391
 392         if( p_playlist->request.p_node &&
 393             p_playlist->request.p_node != p_playlist->status.p_node )
 394         {
 395
 396             p_playlist->status.p_node = p_playlist->request.p_node;
 397             p_playlist->b_reset_currently_playing = true;
 398         }
 399
 400         /* If we are asked for a node, don't take it */
 401         if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
 402             i_skip++;
 403
 404         if( p_playlist->b_reset_currently_playing )
 405             /* A bit too bad to reset twice ... */
 406             ResetCurrentlyPlaying( p_playlist, b_random, p_new );
 407         else if( p_new )
 408             ResyncCurrentIndex( p_playlist, p_new );
 409         else
 410             p_playlist->i_current_index = -1;
 411
 412         if( p_playlist->current.i_size && (i_skip > 0) )
 413         {
 414             if( p_playlist->i_current_index < -1 )
 415                 p_playlist->i_current_index = -1;
 416             for( i = i_skip; i > 0 ; i-- )
 417             {
 418                 p_playlist->i_current_index++;
 419                 if( p_playlist->i_current_index >= p_playlist->current.i_size )
 420                 {
 421                     PL_DEBUG( "looping - restarting at beginning of node" );
 422                     p_playlist->i_current_index = 0;
 423                 }
 424             }
 425             p_new = ARRAY_VAL( p_playlist->current,
 426                                p_playlist->i_current_index );
 427         }
 428         else if( p_playlist->current.i_size && (i_skip < 0) )
 429         {
 430             for( i = i_skip; i < 0 ; i++ )
 431             {
 432                 p_playlist->i_current_index--;
 433                 if( p_playlist->i_current_index <= -1 )
 434                 {
 435                     PL_DEBUG( "looping - restarting at end of node" );
 436                     p_playlist->i_current_index = p_playlist->current.i_size-1;
 437                 }
 438             }
 439             p_new = ARRAY_VAL( p_playlist->current,
 440                                p_playlist->i_current_index );
 441         }
 442         /* Clear the request */
 443         p_playlist->request.b_request = false;
 444     }
 445     /* "Automatic" item change ( next ) */
 446     else
 447     {
 448         PL_DEBUG( "changing item without a request (current %i/%i)",
 449                   p_playlist->i_current_index, p_playlist->current.i_size );
 450         /* Cant go to next from current item */
 451         if( p_playlist->status.p_item &&
 452             p_playlist->status.p_item->i_flags & PLAYLIST_SKIP_FLAG )
 453             return NULL;
 454
 455         if( p_playlist->b_reset_currently_playing )
 456             ResetCurrentlyPlaying( p_playlist, b_random,
 457                                    p_playlist->status.p_item );
 458
 459         p_playlist->i_current_index++;
 460         assert( p_playlist->i_current_index <= p_playlist->current.i_size );
 461         if( p_playlist->i_current_index == p_playlist->current.i_size )
 462         {
 463             if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
 464             p_playlist->i_current_index = 0;
 465         }
 466         PL_DEBUG( "using item %i", p_playlist->i_current_index );
 467         if ( p_playlist->current.i_size == 0 ) return NULL;
 468
 469         p_new = ARRAY_VAL( p_playlist->current, p_playlist->i_current_index );
 470         /* The new item can't be autoselected  */
 471         if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
 472             return NULL;
 473     }
 474     return p_new;
 475 }
 476
 477 /**
 478  * Start the input for an item
 479  *
 480  * \param p_playlist the playlist objetc
 481  * \param p_item the item to play
 482  * \return nothing
 483  */
 484 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
 485 {
 486     input_item_t *p_input = p_item->p_input;
 487     sout_instance_t **pp_sout = &libvlc_priv(p_playlist->p_libvlc)->p_sout;
 488     int i_activity = var_GetInteger( p_playlist, "activity" ) ;
 489
 490     msg_Dbg( p_playlist, "creating new input thread" );
 491
 492     p_input->i_nb_played++;
 493     p_playlist->status.p_item = p_item;
 494
 495     p_playlist->status.i_status = PLAYLIST_RUNNING;
 496
 497     var_SetInteger( p_playlist, "activity", i_activity +
 498                     DEFAULT_INPUT_ACTIVITY );
 499
 500     input_thread_t * p_input_thread =
 501         input_CreateThreadExtended( p_playlist, p_input, NULL, *pp_sout );
 502     playlist_set_current_input( p_playlist, p_input_thread );
 503     vlc_object_release( p_input_thread );
 504
 505     *pp_sout = NULL;
 506
 507     char *psz_uri = input_item_GetURI( p_item->p_input );
 508     if( psz_uri && ( !strncmp( psz_uri, "directory:", 10 ) ||
 509                      !strncmp( psz_uri, "vlc:", 4 ) ) )
 510     {
 511         free( psz_uri );
 512         return VLC_SUCCESS;
 513     }
 514     free( psz_uri );
 515
 516     if( p_playlist->p_fetcher &&
 517             p_playlist->p_fetcher->i_art_policy == ALBUM_ART_WHEN_PLAYED )
 518     {
 519         bool b_has_art;
 520
 521         char *psz_arturl, *psz_name;
 522         psz_arturl = input_item_GetArtURL( p_input );
 523         psz_name = input_item_GetName( p_input );
 524
 525         /* p_input->p_meta should not be null after a successfull CreateThread */
 526         b_has_art = !EMPTY_STR( psz_arturl );
 527
 528         if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
 529         {
 530             PL_DEBUG( "requesting art for %s", psz_name );
 531             playlist_AskForArtEnqueue( p_playlist, p_input );
 532         }
 533         free( psz_arturl );
 534         free( psz_name );
 535     }
 536
 537     PL_UNLOCK;
 538     var_SetInteger( p_playlist, "playlist-current", p_input->i_id );
 539     PL_LOCK;
 540
 541     return VLC_SUCCESS;
 542 }