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

   1 /*****************************************************************************
   2  * engine.c : Run the playlist and handle its control
   3  *****************************************************************************
   4  * Copyright (C) 1999-2007 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
  25 #ifdef HAVE_CONFIG_H
  26 # include "config.h"
  27 #endif
  28
  29 #include <assert.h>
  30 #include <vlc_common.h>
  31 #include <vlc_sout.h>
  32 #include <vlc_playlist.h>
  33 #include <vlc_interface.h>
  34 #include "playlist_internal.h"
  35 #include "stream_output/stream_output.h" /* sout_DeleteInstance */
  36
  37 /*****************************************************************************
  38  * Local prototypes
  39  *****************************************************************************/
  40 static void VariablesInit( playlist_t *p_playlist );
  41 static void playlist_Destructor( vlc_object_t * p_this );
  42 static void playlist_Destructor( vlc_object_t * p_this );
  43
  44 static int RandomCallback( vlc_object_t *p_this, char const *psz_cmd,
  45                            vlc_value_t oldval, vlc_value_t newval, void *a )
  46 {
  47     (void)psz_cmd; (void)oldval; (void)newval; (void)a;
  48
  49     ((playlist_t*)p_this)->b_reset_currently_playing = true;
  50     playlist_Signal( ((playlist_t*)p_this) );
  51     return VLC_SUCCESS;
  52 }
  53
  54 /**
  55  * Create playlist
  56  *
  57  * Create a playlist structure.
  58  * \param p_parent the vlc object that is to be the parent of this playlist
  59  * \return a pointer to the created playlist, or NULL on error
  60  */
  61 playlist_t * playlist_Create( vlc_object_t *p_parent )
  62 {
  63     static const char playlist_name[] = "playlist";
  64     playlist_t *p_playlist;
  65     bool b_save;
  66
  67     /* Allocate structure */
  68     p_playlist = vlc_custom_create( p_parent, sizeof( *p_playlist ),
  69                                     VLC_OBJECT_PLAYLIST, playlist_name );
  70     if( !p_playlist )
  71     {
  72         msg_Err( p_parent, "out of memory" );
  73         return NULL;
  74     }
  75
  76     TAB_INIT( p_playlist->i_sds, p_playlist->pp_sds );
  77
  78     libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
  79
  80     VariablesInit( p_playlist );
  81
  82     /* Initialise data structures */
  83     vlc_mutex_init( &p_playlist->gc_lock );
  84     p_playlist->i_last_playlist_id = 0;
  85     p_playlist->p_input = NULL;
  86
  87     p_playlist->gc_date = 0;
  88     p_playlist->b_cant_sleep = false;
  89
  90     ARRAY_INIT( p_playlist->items );
  91     ARRAY_INIT( p_playlist->all_items );
  92     ARRAY_INIT( p_playlist->current );
  93
  94     p_playlist->i_current_index = 0;
  95     p_playlist->b_reset_currently_playing = true;
  96     p_playlist->last_rebuild_date = 0;
  97
  98     p_playlist->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
  99
 100     p_playlist->b_doing_ml = false;
 101
 102     p_playlist->b_auto_preparse =
 103                         var_CreateGetBool( p_playlist, "auto-preparse" ) ;
 104
 105     p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
 106                                     0, NULL );
 107     p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
 108                                     0, p_playlist->p_root_category->p_input );
 109
 110     if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
 111         return NULL;
 112
 113     /* Create playlist and media library */
 114     playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
 115                             &p_playlist->p_local_category,
 116                             &p_playlist->p_local_onelevel, false );
 117
 118     p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
 119     p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
 120
 121     if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
 122         !p_playlist->p_local_category->p_input ||
 123         !p_playlist->p_local_onelevel->p_input )
 124         return NULL;
 125
 126     if( config_GetInt( p_playlist, "media-library") )
 127     {
 128         playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
 129                             &p_playlist->p_ml_category,
 130                             &p_playlist->p_ml_onelevel, false );
 131
 132         if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
 133             return NULL;
 134
 135         p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
 136         p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
 137     }
 138     else
 139     {
 140         p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
 141     }
 142
 143     /* Initial status */
 144     p_playlist->status.p_item = NULL;
 145     p_playlist->status.p_node = p_playlist->p_local_onelevel;
 146     p_playlist->request.b_request = false;
 147     p_playlist->status.i_status = PLAYLIST_STOPPED;
 148
 149     p_playlist->i_sort = SORT_ID;
 150     p_playlist->i_order = ORDER_NORMAL;
 151
 152
 153     b_save = p_playlist->b_auto_preparse;
 154     p_playlist->b_auto_preparse = false;
 155     playlist_MLLoad( p_playlist );
 156     p_playlist->b_auto_preparse = true;
 157
 158     vlc_object_set_destructor( p_playlist, playlist_Destructor );
 159
 160     return p_playlist;
 161 }
 162
 163 /**
 164  * Destroy playlist
 165  *
 166  * Destroy a playlist structure.
 167  * \param p_playlist the playlist object
 168  * \return nothing
 169  */
 170
 171 static void playlist_Destructor( vlc_object_t * p_this )
 172 {
 173     playlist_t * p_playlist = (playlist_t *)p_this;
 174
 175     if( p_playlist->p_preparse )
 176         vlc_object_release( p_playlist->p_preparse );
 177
 178     if( p_playlist->p_fetcher )
 179         vlc_object_release( p_playlist->p_fetcher );
 180 #ifndef NDEBUG
 181     libvlc_priv (p_this->p_libvlc)->p_playlist = NULL; /* pl_Yield() will fail */
 182 #endif
 183 }
 184
 185 /* Destroy remaining objects */
 186 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
 187 {
 188     vlc_object_t *p_obj;
 189
 190     if( !b_force )
 191     {
 192         if( mdate() - p_playlist->gc_date < 1000000 )
 193         {
 194             p_playlist->b_cant_sleep = true;
 195             return;
 196         }
 197         else if( p_playlist->gc_date == 0 )
 198             return;
 199     }
 200
 201     vlc_mutex_lock( &p_playlist->gc_lock );
 202     p_playlist->b_cant_sleep = false;
 203     vlc_mutex_unlock( &p_playlist->gc_lock );
 204 }
 205
 206 /**
 207  * Main loop
 208  *
 209  * Main loop for the playlist
 210  * \param p_playlist the playlist object
 211  * \return nothing
 212  */
 213 void playlist_MainLoop( playlist_t *p_playlist )
 214 {
 215     playlist_item_t *p_item = NULL;
 216     bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
 217     PL_LOCK;
 218
 219     if( p_playlist->b_reset_currently_playing &&
 220         mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
 221     {
 222         ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
 223                              p_playlist->status.p_item );
 224         p_playlist->last_rebuild_date = mdate();
 225     }
 226
 227 check_input:
 228     /* If there is an input, check that it doesn't need to die. */
 229     if( p_playlist->p_input )
 230     {
 231         if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
 232         {
 233             PL_DEBUG( "incoming request - stopping current input" );
 234             input_StopThread( p_playlist->p_input );
 235         }
 236
 237         /* This input is dead. Remove it ! */
 238         if( p_playlist->p_input->b_dead )
 239         {
 240             int i_activity;
 241             input_thread_t *p_input;
 242             sout_instance_t **pp_sout =
 243                 &libvlc_priv(p_playlist->p_libvlc)->p_sout;
 244
 245             PL_DEBUG( "dead input" );
 246
 247             p_input = p_playlist->p_input;
 248
 249             assert( *pp_sout == NULL );
 250             if( var_CreateGetBool( p_input, "sout-keep" ) )
 251                 *pp_sout = input_DetachSout( p_input );
 252
 253             /* Destroy input */
 254             playlist_release_current_input( p_playlist );
 255
 256             p_playlist->gc_date = mdate();
 257             p_playlist->b_cant_sleep = true;
 258
 259             if( p_playlist->status.p_item->i_flags
 260                 & PLAYLIST_REMOVE_FLAG )
 261             {
 262                  PL_DEBUG( "%s was marked for deletion, deleting",
 263                                  PLI_NAME( p_playlist->status.p_item  ) );
 264                  playlist_ItemDelete( p_playlist->status.p_item );
 265                  if( p_playlist->request.p_item == p_playlist->status.p_item )
 266                      p_playlist->request.p_item = NULL;
 267                  p_playlist->status.p_item = NULL;
 268             }
 269
 270             i_activity= var_GetInteger( p_playlist, "activity" );
 271             var_SetInteger( p_playlist, "activity", i_activity -
 272                             DEFAULT_INPUT_ACTIVITY );
 273
 274             goto check_input;
 275         }
 276         /* This input is dying, let it do */
 277         else if( p_playlist->p_input->b_die )
 278         {
 279             PL_DEBUG( "dying input" );
 280             PL_UNLOCK;
 281             msleep( INTF_IDLE_SLEEP );
 282             PL_LOCK;
 283             goto check_input;
 284         }
 285         /* This input has finished, ask it to die ! */
 286         else if( p_playlist->p_input->b_error
 287                   || p_playlist->p_input->b_eof )
 288         {
 289             PL_DEBUG( "finished input" );
 290             input_StopThread( p_playlist->p_input );
 291             /* No need to wait here, we'll wait in the p_input->b_die case */
 292             goto check_input;
 293         }
 294         else if( p_playlist->p_input->i_state != INIT_S )
 295         {
 296             PL_UNLOCK;
 297             ObjectGarbageCollector( p_playlist, false );
 298             PL_LOCK;
 299         }
 300     }
 301     else
 302     {
 303         /* No input. Several cases
 304          *  - No request, running status -> start new item
 305          *  - No request, stopped status -> collect garbage
 306          *  - Request, running requested -> start new item
 307          *  - Request, stopped requested -> collect garbage
 308         */
 309         int i_status = p_playlist->request.b_request ?
 310             p_playlist->request.i_status : p_playlist->status.i_status;
 311         if( i_status != PLAYLIST_STOPPED )
 312         {
 313             msg_Dbg( p_playlist, "starting new item" );
 314             p_item = playlist_NextItem( p_playlist );
 315
 316             if( p_item == NULL )
 317             {
 318                 msg_Dbg( p_playlist, "nothing to play" );
 319                 p_playlist->status.i_status = PLAYLIST_STOPPED;
 320                 PL_UNLOCK;
 321
 322                 if( b_playexit == true )
 323                 {
 324                     msg_Info( p_playlist, "end of playlist, exiting" );
 325                     vlc_object_kill( p_playlist->p_libvlc );
 326                 }
 327                 ObjectGarbageCollector( p_playlist, true );
 328                 return;
 329              }
 330              playlist_PlayItem( p_playlist, p_item );
 331          }
 332          else
 333          {
 334             const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
 335
 336             p_playlist->status.i_status = PLAYLIST_STOPPED;
 337             if( p_playlist->status.p_item &&
 338                 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
 339             {
 340                 PL_DEBUG( "deleting item marked for deletion" );
 341                 playlist_ItemDelete( p_playlist->status.p_item );
 342                 p_playlist->status.p_item = NULL;
 343             }
 344
 345             /* Collect garbage */
 346             PL_UNLOCK;
 347             ObjectGarbageCollector( p_playlist, b_gc_forced );
 348             PL_LOCK;
 349         }
 350     }
 351     PL_UNLOCK;
 352 }
 353
 354 /**
 355  * Last loop
 356  *
 357  * The playlist is dying so do the last loop
 358  * \param p_playlist the playlist object
 359  * \return nothing
 360 */
 361 void playlist_LastLoop( playlist_t *p_playlist )
 362 {
 363     vlc_object_t *p_obj;
 364
 365     /* If there is an input, kill it */
 366     while( 1 )
 367     {
 368         PL_LOCK;
 369         if( p_playlist->p_input == NULL )
 370         {
 371             PL_UNLOCK;
 372             break;
 373         }
 374
 375         if( p_playlist->p_input->b_dead )
 376         {
 377             /* remove input */
 378             playlist_release_current_input( p_playlist );
 379
 380             /* sout-keep: no need to anything here.
 381              * The last input will destroy its sout, if any, by itself */
 382
 383             PL_UNLOCK;
 384             continue;
 385         }
 386         else if( p_playlist->p_input->b_die )
 387         {
 388             /* This input is dying, leave it alone */
 389             ;
 390         }
 391         else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
 392         {
 393             input_StopThread( p_playlist->p_input );
 394             PL_UNLOCK;
 395             continue;
 396         }
 397         else
 398         {
 399             p_playlist->p_input->b_eof = 1;
 400         }
 401         PL_UNLOCK;
 402
 403         msleep( INTF_IDLE_SLEEP );
 404     }
 405
 406 #ifdef ENABLE_SOUT
 407     /* close the remaining sout-keep (if there was no input atm) */
 408     sout_instance_t *p_sout = libvlc_priv (p_playlist->p_libvlc)->p_sout;
 409     if (p_sout)
 410         sout_DeleteInstance( p_sout );
 411 #endif
 412
 413     /* Core should have terminated all SDs before the playlist */
 414     assert( p_playlist->i_sds == 0 );
 415     playlist_MLDump( p_playlist );
 416
 417     PL_LOCK;
 418     FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
 419         free( p_del->pp_children );
 420         vlc_gc_decref( p_del->p_input );
 421         free( p_del );
 422     FOREACH_END();
 423     ARRAY_RESET( p_playlist->all_items );
 424
 425     ARRAY_RESET( p_playlist->items );
 426     ARRAY_RESET( p_playlist->current );
 427
 428     PL_UNLOCK;
 429 }
 430
 431 /**
 432  * Preparse loop
 433  *
 434  * Main loop for preparser queue
 435  * \param p_obj items to preparse
 436  * \return nothing
 437  */
 438 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
 439 {
 440     playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
 441     input_item_t *p_current;
 442     int i_activity;
 443
 444     vlc_object_lock( p_obj );
 445
 446     while( vlc_object_alive( p_obj ) )
 447     {
 448         if( p_obj->i_waiting == 0 )
 449         {
 450             vlc_object_wait( p_obj );
 451             continue;
 452         }
 453
 454         p_current = p_obj->pp_waiting[0];
 455         REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
 456         vlc_object_unlock( p_obj );
 457
 458         PL_LOCK;
 459         if( p_current )
 460         {
 461             if( p_current->i_type == ITEM_TYPE_FILE )
 462             {
 463                 stats_TimerStart( p_playlist, "Preparse run",
 464                                   STATS_TIMER_PREPARSE );
 465                 /* Do not preparse if it is already done (like by playing it) */
 466                 if( !input_item_IsPreparsed( p_current ) )
 467                 {
 468                     PL_UNLOCK;
 469                     input_Preparse( p_playlist, p_current );
 470                     PL_LOCK;
 471                 }
 472                 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
 473                 PL_UNLOCK;
 474                 input_item_SetPreparsed( p_current, true );
 475                 var_SetInteger( p_playlist, "item-change", p_current->i_id );
 476                 PL_LOCK;
 477             }
 478             /* If we haven't retrieved enough meta, add to secondary queue
 479              * which will run the "meta fetchers".
 480              * This only checks for meta, not for art
 481              * \todo don't do this for things we won't get meta for, like vids
 482              */
 483             char *psz_arturl = input_item_GetArtURL( p_current );
 484             char *psz_name = input_item_GetName( p_current );
 485             if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
 486                         ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
 487             {
 488                 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
 489                 vlc_object_lock( p_playlist->p_fetcher );
 490                 INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
 491                              p_playlist->p_fetcher->i_waiting,
 492                              p_playlist->p_fetcher->i_waiting, p_current);
 493                 vlc_object_signal_unlocked( p_playlist->p_fetcher );
 494                 vlc_object_unlock( p_playlist->p_fetcher );
 495             }
 496             else
 497             {
 498                 PL_DEBUG( "no fetch required for %s (art currently %s)",
 499                           psz_name, psz_arturl );
 500                 vlc_gc_decref( p_current );
 501             }
 502             free( psz_name );
 503             free( psz_arturl );
 504             PL_UNLOCK;
 505         }
 506         else
 507             PL_UNLOCK;
 508
 509         vlc_object_lock( p_obj );
 510         i_activity = var_GetInteger( p_playlist, "activity" );
 511         if( i_activity < 0 ) i_activity = 0;
 512         vlc_object_unlock( p_obj );
 513         /* Sleep at least 1ms */
 514         msleep( (i_activity+1) * 1000 );
 515         vlc_object_lock( p_obj );
 516     }
 517     vlc_object_unlock( p_obj );
 518 }
 519
 520 /**
 521  * Fetcher loop
 522  *
 523  * Main loop for secondary preparser queue
 524  * \param p_obj items to preparse
 525  * \return nothing
 526  */
 527 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
 528 {
 529     playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
 530     input_item_t *p_item;
 531     int i_activity;
 532
 533     vlc_mutex_lock( &p_obj->object_lock );
 534
 535     while( vlc_object_alive( p_obj ) )
 536     {
 537         if( p_obj->i_waiting == 0 )
 538         {
 539             vlc_object_wait( p_obj );
 540             continue;
 541         }
 542
 543         p_item = p_obj->pp_waiting[0];
 544         REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
 545         vlc_mutex_unlock( &p_obj->object_lock );
 546         if( p_item )
 547         {
 548             int i_ret;
 549
 550             /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
 551              * (This can happen if we fetch art on play)
 552              * FIXME this doesn't work if we need to fetch meta before art ... */
 553             for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
 554             {
 555                 bool b_break;
 556                 PL_LOCK;
 557                 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item  ||
 558                             p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
 559                 PL_UNLOCK;
 560                 if( b_break )
 561                     break;
 562                 msleep( 50000 );
 563             }
 564
 565             i_ret = input_ArtFind( p_playlist, p_item );
 566             if( i_ret == 1 )
 567             {
 568                 PL_DEBUG( "downloading art for %s", p_item->psz_name );
 569                 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
 570                     input_item_SetArtNotFound( p_item, true );
 571                 else {
 572                     input_item_SetArtFetched( p_item, true );
 573                     var_SetInteger( p_playlist, "item-change",
 574                                     p_item->i_id );
 575                 }
 576             }
 577             else if( i_ret == 0 ) /* Was in cache */
 578             {
 579                 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
 580                 input_item_SetArtFetched( p_item, true );
 581                 var_SetInteger( p_playlist, "item-change", p_item->i_id );
 582             }
 583             else
 584             {
 585                 PL_DEBUG( "art not found for %s", p_item->psz_name );
 586                 input_item_SetArtNotFound( p_item, true );
 587             }
 588             vlc_gc_decref( p_item );
 589         }
 590         vlc_object_lock( p_obj );
 591         i_activity = var_GetInteger( p_playlist, "activity" );
 592         if( i_activity < 0 ) i_activity = 0;
 593         vlc_object_unlock( p_obj );
 594         /* Sleep at least 1ms */
 595         msleep( (i_activity+1) * 1000 );
 596         vlc_mutex_lock( &p_obj->object_lock );
 597     }
 598     vlc_mutex_unlock( &p_obj->object_lock );
 599 }
 600
 601 static void VariablesInit( playlist_t *p_playlist )
 602 {
 603     vlc_value_t val;
 604     /* These variables control updates */
 605     var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
 606     val.b_bool = true;
 607     var_Set( p_playlist, "intf-change", val );
 608
 609     var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
 610     val.i_int = -1;
 611     var_Set( p_playlist, "item-change", val );
 612
 613     var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
 614     val.i_int = -1;
 615     var_Set( p_playlist, "item-deleted", val );
 616
 617     var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
 618
 619     var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
 620     val.i_int = -1;
 621     var_Set( p_playlist, "playlist-current", val );
 622
 623     var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
 624
 625     var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
 626     var_SetInteger( p_playlist, "activity", 0 );
 627
 628     /* Variables to control playback */
 629     var_CreateGetBool( p_playlist, "play-and-stop" );
 630     var_CreateGetBool( p_playlist, "play-and-exit" );
 631     var_CreateGetBool( p_playlist, "random" );
 632     var_CreateGetBool( p_playlist, "repeat" );
 633     var_CreateGetBool( p_playlist, "loop" );
 634
 635     var_AddCallback( p_playlist, "random", RandomCallback, NULL );
 636 }