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     if( !vlc_object_alive( p_playlist->p_preparse ) )
 185     {
 186         vlc_object_unlock( p_playlist->p_preparse );
 187         return VLC_EGENERIC;
 188     }
 189     vlc_gc_incref( p_item );
 190     INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
 191                  p_playlist->p_preparse->i_waiting,
 192                  p_playlist->p_preparse->i_waiting,
 193                  p_item );
 194     vlc_object_signal_unlocked( p_playlist->p_preparse );
 195     vlc_object_unlock( p_playlist->p_preparse );
 196     return VLC_SUCCESS;
 197 }
 198
 199 /** Enqueue a playlist item or a node for peparsing.
 200  *  This function should be entered without playlist and preparser locks */
 201 int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
 202                                   playlist_item_t *p_item )
 203 {
 204     vlc_object_lock( p_playlist );
 205     vlc_object_lock( p_playlist->p_preparse );
 206     if( !vlc_object_alive( p_playlist->p_preparse ) )
 207     {
 208         vlc_object_unlock( p_playlist->p_preparse );
 209         vlc_object_unlock( p_playlist );
 210         return VLC_EGENERIC;
 211     }
 212     PreparseEnqueueItemSub( p_playlist, p_item );
 213     vlc_object_unlock( p_playlist->p_preparse );
 214     vlc_object_unlock( p_playlist );
 215     return VLC_SUCCESS;
 216 }
 217
 218 int playlist_AskForArtEnqueue( playlist_t *p_playlist,
 219                                input_item_t *p_item )
 220 {
 221     int i;
 222
 223     vlc_object_lock( p_playlist->p_fetcher );
 224     if( !vlc_object_alive( p_playlist->p_fetcher ) )
 225     {
 226         vlc_object_unlock( p_playlist->p_fetcher );
 227         return VLC_EGENERIC;
 228     }
 229
 230     for( i = 0; i < p_playlist->p_fetcher->i_waiting ; i++ );
 231     vlc_gc_incref( p_item );
 232     INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
 233                  p_playlist->p_fetcher->i_waiting,
 234                  i, p_item );
 235     vlc_object_signal_unlocked( p_playlist->p_fetcher );
 236     vlc_object_unlock( p_playlist->p_fetcher );
 237     return VLC_SUCCESS;
 238 }
 239
 240 static void PreparseEnqueueItemSub( playlist_t *p_playlist,
 241                                     playlist_item_t *p_item )
 242 {
 243     int i;
 244     if( p_item->i_children == -1 )
 245     {
 246         vlc_gc_incref( p_item );
 247         INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
 248                      p_playlist->p_preparse->i_waiting,
 249                      p_playlist->p_preparse->i_waiting,
 250                      p_item->p_input );
 251     }
 252     else
 253     {
 254         for( i = 0; i < p_item->i_children; i++)
 255         {
 256             PreparseEnqueueItemSub( p_playlist, p_item->pp_children[i] );
 257         }
 258     }
 259 }
 260
 261 /*****************************************************************************
 262  * Playback logic
 263  *****************************************************************************/
 264
 265 /**
 266  * Synchronise the current index of the playlist
 267  * to match the index of the current item.
 268  *
 269  * \param p_playlist the playlist structure
 270  * \param p_cur the current playlist item
 271  * \return nothing
 272  */
 273 static void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur )
 274 {
 275      PL_DEBUG( "resyncing on %s", PLI_NAME( p_cur ) );
 276      /* Simply resync index */
 277      int i;
 278      p_playlist->i_current_index = -1;
 279      for( i = 0 ; i< p_playlist->current.i_size; i++ )
 280      {
 281           if( ARRAY_VAL( p_playlist->current, i ) == p_cur )
 282           {
 283               p_playlist->i_current_index = i;
 284               break;
 285           }
 286      }
 287      PL_DEBUG( "%s is at %i", PLI_NAME( p_cur ), p_playlist->i_current_index );
 288 }
 289
 290 void ResetCurrentlyPlaying( playlist_t *p_playlist, bool b_random,
 291                             playlist_item_t *p_cur )
 292 {
 293     playlist_item_t *p_next = NULL;
 294     stats_TimerStart( p_playlist, "Items array build",
 295                       STATS_TIMER_PLAYLIST_BUILD );
 296     PL_DEBUG( "rebuilding array of current - root %s",
 297               PLI_NAME( p_playlist->status.p_node ) );
 298     ARRAY_RESET( p_playlist->current );
 299     p_playlist->i_current_index = -1;
 300     while( 1 )
 301     {
 302         /** FIXME: this is *slow* */
 303         p_next = playlist_GetNextLeaf( p_playlist,
 304                                        p_playlist->status.p_node,
 305                                        p_next, true, false );
 306         if( p_next )
 307         {
 308             if( p_next == p_cur )
 309                 p_playlist->i_current_index = p_playlist->current.i_size;
 310             ARRAY_APPEND( p_playlist->current, p_next);
 311         }
 312         else break;
 313     }
 314     PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
 315                                                   p_playlist->i_current_index);
 316     if( b_random )
 317     {
 318         /* Shuffle the array */
 319         srand( (unsigned int)mdate() );
 320         int j;
 321         for( j = p_playlist->current.i_size - 1; j > 0; j-- )
 322         {
 323             int i = rand() % (j+1); /* between 0 and j */
 324             playlist_item_t *p_tmp;
 325             /* swap the two items */
 326             p_tmp = ARRAY_VAL(p_playlist->current, i);
 327             ARRAY_VAL(p_playlist->current,i) = ARRAY_VAL(p_playlist->current,j);
 328             ARRAY_VAL(p_playlist->current,j) = p_tmp;
 329         }
 330     }
 331     p_playlist->b_reset_currently_playing = false;
 332     stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_BUILD );
 333 }
 334
 335 /**
 336  * Compute the next playlist item depending on
 337  * the playlist course mode (forward, backward, random, view,...).
 338  *
 339  * \param p_playlist the playlist object
 340  * \return nothing
 341  */
 342 playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
 343 {
 344     playlist_item_t *p_new = NULL;
 345     int i_skip = 0, i;
 346
 347     bool b_loop = var_GetBool( p_playlist, "loop" );
 348     bool b_random = var_GetBool( p_playlist, "random" );
 349     bool b_repeat = var_GetBool( p_playlist, "repeat" );
 350     bool b_playstop = var_GetBool( p_playlist, "play-and-stop" );
 351
 352     /* Handle quickly a few special cases */
 353     /* No items to play */
 354     if( p_playlist->items.i_size == 0 )
 355     {
 356         msg_Info( p_playlist, "playlist is empty" );
 357         return NULL;
 358     }
 359
 360     /* Repeat and play/stop */
 361     if( !p_playlist->request.b_request && b_repeat == true &&
 362          p_playlist->status.p_item )
 363     {
 364         msg_Dbg( p_playlist,"repeating item" );
 365         return p_playlist->status.p_item;
 366     }
 367     if( !p_playlist->request.b_request && b_playstop == true )
 368     {
 369         msg_Dbg( p_playlist,"stopping (play and stop)" );
 370         return NULL;
 371     }
 372
 373     if( !p_playlist->request.b_request && p_playlist->status.p_item )
 374     {
 375         playlist_item_t *p_parent = p_playlist->status.p_item;
 376         while( p_parent )
 377         {
 378             if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
 379             {
 380                 msg_Dbg( p_playlist, "blocking item, stopping") ;
 381                 return NULL;
 382             }
 383             p_parent = p_parent->p_parent;
 384         }
 385     }
 386
 387     /* Start the real work */
 388     if( p_playlist->request.b_request )
 389     {
 390         p_new = p_playlist->request.p_item;
 391         i_skip = p_playlist->request.i_skip;
 392         PL_DEBUG( "processing request item %s node %s skip %i",
 393                         PLI_NAME( p_playlist->request.p_item ),
 394                         PLI_NAME( p_playlist->request.p_node ), i_skip );
 395
 396         /* Make sure the node wasn't deleted */
 397         if( p_playlist->status.p_node &&
 398             p_playlist->status.p_node->i_flags & PLAYLIST_REMOVE_FLAG )
 399         {
 400              PL_DEBUG( "%s was marked for deletion, deleting",
 401                              PLI_NAME( p_playlist->status.p_node  ) );
 402              playlist_ItemDelete( p_playlist->status.p_node );
 403              /* Don't attempt to reuse that node */
 404              if( p_playlist->status.p_node == p_playlist->request.p_node )
 405                 p_playlist->request.p_node = NULL;
 406              p_playlist->status.p_node = NULL;
 407         }
 408
 409         if( p_playlist->request.p_node &&
 410             p_playlist->request.p_node != p_playlist->status.p_node )
 411         {
 412
 413             p_playlist->status.p_node = p_playlist->request.p_node;
 414             p_playlist->b_reset_currently_playing = true;
 415         }
 416
 417         /* If we are asked for a node, don't take it */
 418         if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
 419             i_skip++;
 420
 421         if( p_playlist->b_reset_currently_playing )
 422             /* A bit too bad to reset twice ... */
 423             ResetCurrentlyPlaying( p_playlist, b_random, p_new );
 424         else if( p_new )
 425             ResyncCurrentIndex( p_playlist, p_new );
 426         else
 427             p_playlist->i_current_index = -1;
 428
 429         if( p_playlist->current.i_size && (i_skip > 0) )
 430         {
 431             if( p_playlist->i_current_index < -1 )
 432                 p_playlist->i_current_index = -1;
 433             for( i = i_skip; i > 0 ; i-- )
 434             {
 435                 p_playlist->i_current_index++;
 436                 if( p_playlist->i_current_index >= p_playlist->current.i_size )
 437                 {
 438                     PL_DEBUG( "looping - restarting at beginning of node" );
 439                     p_playlist->i_current_index = 0;
 440                 }
 441             }
 442             p_new = ARRAY_VAL( p_playlist->current,
 443                                p_playlist->i_current_index );
 444         }
 445         else if( p_playlist->current.i_size && (i_skip < 0) )
 446         {
 447             for( i = i_skip; i < 0 ; i++ )
 448             {
 449                 p_playlist->i_current_index--;
 450                 if( p_playlist->i_current_index <= -1 )
 451                 {
 452                     PL_DEBUG( "looping - restarting at end of node" );
 453                     p_playlist->i_current_index = p_playlist->current.i_size-1;
 454                 }
 455             }
 456             p_new = ARRAY_VAL( p_playlist->current,
 457                                p_playlist->i_current_index );
 458         }
 459         /* Clear the request */
 460         p_playlist->request.b_request = false;
 461     }
 462     /* "Automatic" item change ( next ) */
 463     else
 464     {
 465         PL_DEBUG( "changing item without a request (current %i/%i)",
 466                   p_playlist->i_current_index, p_playlist->current.i_size );
 467         /* Cant go to next from current item */
 468         if( p_playlist->status.p_item &&
 469             p_playlist->status.p_item->i_flags & PLAYLIST_SKIP_FLAG )
 470             return NULL;
 471
 472         if( p_playlist->b_reset_currently_playing )
 473             ResetCurrentlyPlaying( p_playlist, b_random,
 474                                    p_playlist->status.p_item );
 475
 476         p_playlist->i_current_index++;
 477         assert( p_playlist->i_current_index <= p_playlist->current.i_size );
 478         if( p_playlist->i_current_index == p_playlist->current.i_size )
 479         {
 480             if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
 481             p_playlist->i_current_index = 0;
 482         }
 483         PL_DEBUG( "using item %i", p_playlist->i_current_index );
 484         if ( p_playlist->current.i_size == 0 ) return NULL;
 485
 486         p_new = ARRAY_VAL( p_playlist->current, p_playlist->i_current_index );
 487         /* The new item can't be autoselected  */
 488         if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
 489             return NULL;
 490     }
 491     return p_new;
 492 }
 493
 494 /**
 495  * Start the input for an item
 496  *
 497  * \param p_playlist the playlist objetc
 498  * \param p_item the item to play
 499  * \return nothing
 500  */
 501 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
 502 {
 503     input_item_t *p_input = p_item->p_input;
 504     sout_instance_t **pp_sout = &libvlc_priv(p_playlist->p_libvlc)->p_sout;
 505     int i_activity = var_GetInteger( p_playlist, "activity" ) ;
 506
 507     msg_Dbg( p_playlist, "creating new input thread" );
 508
 509     p_input->i_nb_played++;
 510     p_playlist->status.p_item = p_item;
 511
 512     p_playlist->status.i_status = PLAYLIST_RUNNING;
 513
 514     var_SetInteger( p_playlist, "activity", i_activity +
 515                     DEFAULT_INPUT_ACTIVITY );
 516
 517     input_thread_t * p_input_thread =
 518         input_CreateThreadExtended( p_playlist, p_input, NULL, *pp_sout );
 519     playlist_set_current_input( p_playlist, p_input_thread );
 520     vlc_object_release( p_input_thread );
 521
 522     *pp_sout = NULL;
 523
 524     char *psz_uri = input_item_GetURI( p_item->p_input );
 525     if( psz_uri && ( !strncmp( psz_uri, "directory:", 10 ) ||
 526                      !strncmp( psz_uri, "vlc:", 4 ) ) )
 527     {
 528         free( psz_uri );
 529         return VLC_SUCCESS;
 530     }
 531     free( psz_uri );
 532
 533     if( p_playlist->p_fetcher &&
 534             p_playlist->p_fetcher->i_art_policy == ALBUM_ART_WHEN_PLAYED )
 535     {
 536         bool b_has_art;
 537
 538         char *psz_arturl, *psz_name;
 539         psz_arturl = input_item_GetArtURL( p_input );
 540         psz_name = input_item_GetName( p_input );
 541
 542         /* p_input->p_meta should not be null after a successfull CreateThread */
 543         b_has_art = !EMPTY_STR( psz_arturl );
 544
 545         if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
 546         {
 547             PL_DEBUG( "requesting art for %s", psz_name );
 548             playlist_AskForArtEnqueue( p_playlist, p_input );
 549         }
 550         free( psz_arturl );
 551         free( psz_name );
 552     }
 553
 554     PL_UNLOCK;
 555     var_SetInteger( p_playlist, "playlist-current", p_input->i_id );
 556     PL_LOCK;
 557
 558     return VLC_SUCCESS;
 559 }