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

   1 /*****************************************************************************
   2  * thread.c : Playlist management functions
   3  *****************************************************************************
   4  * Copyright © 1999-2008 VLC authors and VideoLAN
   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 it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * 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 <assert.h>
  29
  30 #include <vlc_common.h>
  31 #include <vlc_es.h>
  32 #include <vlc_input.h>
  33 #include <vlc_interface.h>
  34 #include <vlc_playlist.h>
  35 #include <vlc_rand.h>
  36 #include "playlist_internal.h"
  37
  38 /*****************************************************************************
  39  * Local prototypes
  40  *****************************************************************************/
  41 static void *Thread   ( void * );
  42
  43 /*****************************************************************************
  44  * Main functions for the global thread
  45  *****************************************************************************/
  46
  47 /**
  48  * Creates the main playlist thread.
  49  */
  50 void playlist_Activate( playlist_t *p_playlist )
  51 {
  52     playlist_private_t *p_sys = pl_priv(p_playlist);
  53
  54     if( vlc_clone( &p_sys->thread, Thread, p_playlist,
  55                    VLC_THREAD_PRIORITY_LOW ) )
  56     {
  57         msg_Err( p_playlist, "cannot spawn playlist thread" );
  58         abort();
  59     }
  60 }
  61
  62 /**
  63  * Stops the playlist forever (but do not destroy it yet).
  64  * Any input is stopped.
  65  * \return Nothing but waits for the playlist to be deactivated.
  66  */
  67 void playlist_Deactivate( playlist_t *p_playlist )
  68 {
  69     playlist_private_t *p_sys = pl_priv(p_playlist);
  70
  71     PL_LOCK;
  72     /* WARNING: There is a latent bug. It is assumed that only one thread will
  73      * be waiting for playlist deactivation at a time. So far, that works
  74      * as playlist_Deactivate() is only ever called while closing an
  75      * interface and interfaces are shut down serially by intf_DestroyAll(). */
  76     if( p_sys->killed )
  77     {
  78         PL_UNLOCK;
  79         return;
  80     }
  81
  82     msg_Dbg( p_playlist, "deactivating the playlist" );
  83     p_sys->killed = true;
  84     vlc_cond_signal( &p_sys->signal );
  85     PL_UNLOCK;
  86
  87     vlc_join( p_sys->thread, NULL );
  88 }
  89
  90 /* */
  91
  92 /* Input Callback */
  93 static int InputEvent( vlc_object_t *p_this, char const *psz_cmd,
  94                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
  95 {
  96     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
  97     playlist_t *p_playlist = p_data;
  98
  99     if( newval.i_int != INPUT_EVENT_STATE &&
 100         newval.i_int != INPUT_EVENT_DEAD )
 101         return VLC_SUCCESS;
 102
 103     PL_LOCK;
 104
 105     /* XXX: signaling while not changing any parameter... suspicious... */
 106     vlc_cond_signal( &pl_priv(p_playlist)->signal );
 107
 108     PL_UNLOCK;
 109     return VLC_SUCCESS;
 110 }
 111
 112 /**
 113  * Synchronise the current index of the playlist
 114  * to match the index of the current item.
 115  *
 116  * \param p_playlist the playlist structure
 117  * \param p_cur the current playlist item
 118  * \return nothing
 119  */
 120 void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur )
 121 {
 122     PL_ASSERT_LOCKED;
 123
 124     PL_DEBUG( "resyncing on %s", PLI_NAME( p_cur ) );
 125     /* Simply resync index */
 126     int i;
 127     p_playlist->i_current_index = -1;
 128     for( i = 0 ; i< p_playlist->current.i_size; i++ )
 129     {
 130         if( ARRAY_VAL( p_playlist->current, i ) == p_cur )
 131         {
 132             p_playlist->i_current_index = i;
 133             break;
 134         }
 135     }
 136     PL_DEBUG( "%s is at %i", PLI_NAME( p_cur ), p_playlist->i_current_index );
 137 }
 138
 139 /**
 140  * Reset the currently playing playlist.
 141  *
 142  * \param p_playlist the playlist structure
 143  * \param p_cur the current playlist item
 144  * \return nothing
 145  */
 146 void ResetCurrentlyPlaying( playlist_t *p_playlist,
 147                                    playlist_item_t *p_cur )
 148 {
 149     playlist_private_t *p_sys = pl_priv(p_playlist);
 150
 151     PL_DEBUG( "rebuilding array of current - root %s",
 152               PLI_NAME( p_sys->status.p_node ) );
 153     ARRAY_RESET( p_playlist->current );
 154     p_playlist->i_current_index = -1;
 155     for( playlist_item_t *p_next = NULL; ; )
 156     {
 157         /** FIXME: this is *slow* */
 158         p_next = playlist_GetNextLeaf( p_playlist,
 159                                        p_sys->status.p_node,
 160                                        p_next, true, false );
 161         if( !p_next )
 162             break;
 163
 164         if( p_next == p_cur )
 165             p_playlist->i_current_index = p_playlist->current.i_size;
 166         ARRAY_APPEND( p_playlist->current, p_next);
 167     }
 168     PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
 169                                                   p_playlist->i_current_index);
 170
 171     if( var_GetBool( p_playlist, "random" ) && ( p_playlist->current.i_size > 0 ) )
 172     {
 173         /* Shuffle the array */
 174         for( unsigned j = p_playlist->current.i_size - 1; j > 0; j-- )
 175         {
 176             unsigned i = vlc_lrand48() % (j+1); /* between 0 and j */
 177             playlist_item_t *p_tmp;
 178             /* swap the two items */
 179             p_tmp = ARRAY_VAL(p_playlist->current, i);
 180             ARRAY_VAL(p_playlist->current,i) = ARRAY_VAL(p_playlist->current,j);
 181             ARRAY_VAL(p_playlist->current,j) = p_tmp;
 182         }
 183     }
 184     p_sys->b_reset_currently_playing = false;
 185 }
 186
 187
 188 /**
 189  * Start the input for an item
 190  *
 191  * \param p_playlist the playlist object
 192  * \param p_item the item to play
 193  */
 194 static bool PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
 195 {
 196     playlist_private_t *p_sys = pl_priv(p_playlist);
 197     input_item_t *p_input = p_item->p_input;
 198
 199     PL_ASSERT_LOCKED;
 200
 201     msg_Dbg( p_playlist, "creating new input thread" );
 202
 203     p_item->i_nb_played++;
 204     set_current_status_item( p_playlist, p_item );
 205     assert( p_sys->p_input == NULL );
 206     PL_UNLOCK;
 207
 208     input_thread_t *p_input_thread = input_Create( p_playlist, p_input, NULL,
 209                                                    p_sys->p_input_resource );
 210     if( likely(p_input_thread != NULL) )
 211     {
 212         var_AddCallback( p_input_thread, "intf-event",
 213                          InputEvent, p_playlist );
 214
 215         if( input_Start( p_input_thread ) )
 216         {
 217             var_DelCallback( p_input_thread, "intf-event",
 218                              InputEvent, p_playlist );
 219             vlc_object_release( p_input_thread );
 220             p_input_thread = NULL;
 221         }
 222     }
 223
 224     /* TODO store art policy in playlist private data */
 225     char *psz_arturl = input_item_GetArtURL( p_input );
 226     /* p_input->p_meta should not be null after a successful CreateThread */
 227     bool b_has_art = !EMPTY_STR( psz_arturl );
 228
 229     if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
 230     {
 231         PL_DEBUG( "requesting art for new input thread" );
 232         libvlc_ArtRequest( p_playlist->p_libvlc, p_input, META_REQUEST_OPTION_NONE );
 233     }
 234     free( psz_arturl );
 235
 236     PL_LOCK;
 237     p_sys->p_input = p_input_thread;
 238     PL_UNLOCK;
 239
 240     var_SetAddress( p_playlist, "input-current", p_input_thread );
 241
 242     PL_LOCK;
 243     return p_input_thread != NULL;
 244 }
 245
 246 /**
 247  * Compute the next playlist item depending on
 248  * the playlist course mode (forward, backward, random, view,...).
 249  *
 250  * \param p_playlist the playlist object
 251  * \return nothing
 252  */
 253 static playlist_item_t *NextItem( playlist_t *p_playlist )
 254 {
 255     playlist_private_t *p_sys = pl_priv(p_playlist);
 256     playlist_item_t *p_new = NULL;
 257     bool requested = p_sys->request.b_request;
 258
 259     /* Clear the request */
 260     p_sys->request.b_request = false;
 261
 262     /* Handle quickly a few special cases */
 263     /* No items to play */
 264     if( p_playlist->items.i_size == 0 )
 265     {
 266         msg_Info( p_playlist, "playlist is empty" );
 267         return NULL;
 268     }
 269
 270     /* Start the real work */
 271     if( requested )
 272     {
 273         p_new = p_sys->request.p_item;
 274
 275         if( p_new == NULL && p_sys->request.p_node == NULL )
 276             return NULL; /* Stop request! */
 277
 278         int i_skip = p_sys->request.i_skip;
 279         PL_DEBUG( "processing request item: %s, node: %s, skip: %i",
 280                         PLI_NAME( p_sys->request.p_item ),
 281                         PLI_NAME( p_sys->request.p_node ), i_skip );
 282
 283         if( p_sys->request.p_node &&
 284             p_sys->request.p_node != get_current_status_node( p_playlist ) )
 285         {
 286
 287             set_current_status_node( p_playlist, p_sys->request.p_node );
 288             p_sys->request.p_node = NULL;
 289             p_sys->b_reset_currently_playing = true;
 290         }
 291
 292         /* If we are asked for a node, go to it's first child */
 293         if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
 294         {
 295             i_skip++;
 296             if( p_new != NULL )
 297             {
 298                 p_new = playlist_GetNextLeaf( p_playlist, p_new, NULL, true, false );
 299                 for( int i = 0; i < p_playlist->current.i_size; i++ )
 300                 {
 301                     if( p_new == ARRAY_VAL( p_playlist->current, i ) )
 302                     {
 303                         p_playlist->i_current_index = i;
 304                         i_skip = 0;
 305                     }
 306                 }
 307             }
 308         }
 309
 310         if( p_sys->b_reset_currently_playing )
 311             /* A bit too bad to reset twice ... */
 312             ResetCurrentlyPlaying( p_playlist, p_new );
 313         else if( p_new )
 314             ResyncCurrentIndex( p_playlist, p_new );
 315         else
 316             p_playlist->i_current_index = -1;
 317
 318         if( p_playlist->current.i_size && (i_skip > 0) )
 319         {
 320             if( p_playlist->i_current_index < -1 )
 321                 p_playlist->i_current_index = -1;
 322             for( int i = i_skip; i > 0 ; i-- )
 323             {
 324                 p_playlist->i_current_index++;
 325                 if( p_playlist->i_current_index >= p_playlist->current.i_size )
 326                 {
 327                     PL_DEBUG( "looping - restarting at beginning of node" );
 328                     /* reshuffle playlist when end is reached */
 329                     if( var_GetBool( p_playlist, "random" ) ) {
 330                         PL_DEBUG( "reshuffle playlist" );
 331                         ResetCurrentlyPlaying( p_playlist,
 332                                 get_current_status_item( p_playlist ) );
 333                     }
 334                     p_playlist->i_current_index = 0;
 335                 }
 336             }
 337             p_new = ARRAY_VAL( p_playlist->current,
 338                                p_playlist->i_current_index );
 339         }
 340         else if( p_playlist->current.i_size && (i_skip < 0) )
 341         {
 342             for( int i = i_skip; i < 0 ; i++ )
 343             {
 344                 p_playlist->i_current_index--;
 345                 if( p_playlist->i_current_index <= -1 )
 346                 {
 347                     PL_DEBUG( "looping - restarting at end of node" );
 348                     /* reshuffle playlist when beginning is reached */
 349                     if( var_GetBool( p_playlist, "random" ) ) {
 350                         PL_DEBUG( "reshuffle playlist" );
 351                         ResetCurrentlyPlaying( p_playlist,
 352                                 get_current_status_item( p_playlist ) );
 353                     }
 354                     p_playlist->i_current_index = p_playlist->current.i_size-1;
 355                 }
 356             }
 357             p_new = ARRAY_VAL( p_playlist->current,
 358                                p_playlist->i_current_index );
 359         }
 360     }
 361     /* "Automatic" item change ( next ) */
 362     else
 363     {
 364         bool b_loop = var_GetBool( p_playlist, "loop" );
 365         bool b_repeat = var_GetBool( p_playlist, "repeat" );
 366         bool b_playstop = var_InheritBool( p_playlist, "play-and-stop" );
 367
 368         /* Repeat and play/stop */
 369         if( b_repeat && get_current_status_item( p_playlist ) )
 370         {
 371             msg_Dbg( p_playlist,"repeating item" );
 372             return get_current_status_item( p_playlist );
 373         }
 374         if( b_playstop )
 375         {
 376             msg_Dbg( p_playlist,"stopping (play and stop)" );
 377             return NULL;
 378         }
 379
 380         /* */
 381         if( get_current_status_item( p_playlist ) )
 382         {
 383             playlist_item_t *p_parent = get_current_status_item( p_playlist );
 384             while( p_parent )
 385             {
 386                 if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
 387                 {
 388                     msg_Dbg( p_playlist, "blocking item, stopping") ;
 389                     return NULL;
 390                 }
 391                 p_parent = p_parent->p_parent;
 392             }
 393         }
 394
 395         PL_DEBUG( "changing item without a request (current %i/%i)",
 396                   p_playlist->i_current_index, p_playlist->current.i_size );
 397         /* Cant go to next from current item */
 398         if( get_current_status_item( p_playlist ) &&
 399             get_current_status_item( p_playlist )->i_flags & PLAYLIST_SKIP_FLAG )
 400             return NULL;
 401
 402         if( p_sys->b_reset_currently_playing )
 403             ResetCurrentlyPlaying( p_playlist,
 404                                    get_current_status_item( p_playlist ) );
 405
 406         p_playlist->i_current_index++;
 407         assert( p_playlist->i_current_index <= p_playlist->current.i_size );
 408         if( p_playlist->i_current_index == p_playlist->current.i_size )
 409         {
 410             if( !b_loop || p_playlist->current.i_size == 0 )
 411                 return NULL;
 412             /* reshuffle after last item has been played */
 413             if( var_GetBool( p_playlist, "random" ) ) {
 414                 PL_DEBUG( "reshuffle playlist" );
 415                 ResetCurrentlyPlaying( p_playlist,
 416                                        get_current_status_item( p_playlist ) );
 417             }
 418             p_playlist->i_current_index = 0;
 419         }
 420         PL_DEBUG( "using item %i", p_playlist->i_current_index );
 421         if ( p_playlist->current.i_size == 0 )
 422             return NULL;
 423
 424         p_new = ARRAY_VAL( p_playlist->current, p_playlist->i_current_index );
 425         /* The new item can't be autoselected  */
 426         if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
 427             return NULL;
 428     }
 429     return p_new;
 430 }
 431
 432 static void LoopInput( playlist_t *p_playlist )
 433 {
 434     playlist_private_t *p_sys = pl_priv(p_playlist);
 435     input_thread_t *p_input = p_sys->p_input;
 436
 437     assert( p_input != NULL );
 438
 439     if( p_sys->request.b_request || p_sys->killed )
 440     {
 441         PL_DEBUG( "incoming request - stopping current input" );
 442         input_Stop( p_input );
 443     }
 444
 445 #warning Unsynchronized access to *p_input flags...
 446     /* This input is dead. Remove it ! */
 447     if( p_input->b_dead )
 448     {
 449         p_sys->p_input = NULL;
 450         PL_DEBUG( "dead input" );
 451         PL_UNLOCK;
 452
 453         var_SetAddress( p_playlist, "input-current", NULL );
 454
 455         /* WARNING: Input resource manipulation and callback deletion are
 456          * incompatible with the playlist lock. */
 457         if( !var_InheritBool( p_input, "sout-keep" ) )
 458             input_resource_TerminateSout( p_sys->p_input_resource );
 459         var_DelCallback( p_input, "intf-event", InputEvent, p_playlist );
 460
 461         input_Close( p_input );
 462         PL_LOCK;
 463         return;
 464     }
 465     /* This input has finished, ask it to die ! */
 466     else if( p_input->b_error || p_input->b_eof )
 467     {
 468         PL_DEBUG( "finished input" );
 469         input_Stop( p_input );
 470     }
 471
 472     vlc_cond_wait( &p_sys->signal, &p_sys->lock );
 473 }
 474
 475 static bool Next( playlist_t *p_playlist )
 476 {
 477     playlist_item_t *p_item = NextItem( p_playlist );
 478     if( p_item == NULL )
 479         return false;
 480
 481     msg_Dbg( p_playlist, "starting playback of new item" );
 482     ResyncCurrentIndex( p_playlist, p_item );
 483     return PlayItem( p_playlist, p_item );
 484 }
 485
 486 /**
 487  * Run the main control thread itself
 488  */
 489 static void *Thread ( void *data )
 490 {
 491     playlist_t *p_playlist = data;
 492     playlist_private_t *p_sys = pl_priv(p_playlist);
 493
 494     PL_LOCK;
 495     while( !p_sys->killed )
 496     {
 497         /* Playlist in stopped state */
 498         assert(p_sys->p_input == NULL);
 499
 500         if( !p_sys->request.b_request )
 501         {
 502             vlc_cond_wait( &p_sys->signal, &p_sys->lock );
 503             continue;
 504         }
 505
 506         while( !p_sys->killed && Next( p_playlist ) )
 507         {   /* Playlist in running state */
 508             assert(p_sys->p_input != NULL);
 509
 510             do
 511                 LoopInput( p_playlist );
 512             while( p_sys->p_input != NULL );
 513         }
 514
 515         msg_Dbg( p_playlist, "nothing to play" );
 516         if( var_InheritBool( p_playlist, "play-and-exit" ) )
 517         {
 518             msg_Info( p_playlist, "end of playlist, exiting" );
 519             libvlc_Quit( p_playlist->p_libvlc );
 520         }
 521
 522         /* Destroy any video display now (XXX: ugly hack) */
 523         if( input_resource_HasVout( p_sys->p_input_resource ) )
 524         {
 525             PL_UNLOCK; /* Mind: NO LOCKS while manipulating input resources! */
 526             input_resource_TerminateVout( p_sys->p_input_resource );
 527             PL_LOCK;
 528         }
 529     }
 530     PL_UNLOCK;
 531
 532     input_resource_Terminate( p_sys->p_input_resource );
 533     return NULL;
 534 }