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