1 /*****************************************************************************
2 * engine.c : Run the playlist and handle its control
3 *****************************************************************************
4 * Copyright (C) 1999-2007 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
8 * Clément Stenac <zorglub@videolan.org>
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.
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.
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 *****************************************************************************/
30 #include <vlc_common.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 */
37 /*****************************************************************************
39 *****************************************************************************/
40 static void VariablesInit( playlist_t *p_playlist );
41 static void playlist_Destructor( vlc_object_t * p_this );
43 static int RandomCallback( vlc_object_t *p_this, char const *psz_cmd,
44 vlc_value_t oldval, vlc_value_t newval, void *a )
46 (void)psz_cmd; (void)oldval; (void)newval; (void)a;
48 ((playlist_t*)p_this)->b_reset_currently_playing = true;
49 playlist_Signal( ((playlist_t*)p_this) );
56 * Create a playlist structure.
57 * \param p_parent the vlc object that is to be the parent of this playlist
58 * \return a pointer to the created playlist, or NULL on error
60 playlist_t * playlist_Create( vlc_object_t *p_parent )
62 static const char playlist_name[] = "playlist";
63 playlist_t *p_playlist;
66 /* Allocate structure */
67 p_playlist = vlc_custom_create( p_parent, sizeof( *p_playlist ),
68 VLC_OBJECT_PLAYLIST, playlist_name );
71 msg_Err( p_parent, "out of memory" );
75 TAB_INIT( p_playlist->i_sds, p_playlist->pp_sds );
77 libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
79 VariablesInit( p_playlist );
81 /* Initialise data structures */
82 vlc_mutex_init( &p_playlist->gc_lock );
83 p_playlist->i_last_playlist_id = 0;
84 p_playlist->p_input = NULL;
86 p_playlist->gc_date = 0;
87 p_playlist->b_cant_sleep = false;
89 ARRAY_INIT( p_playlist->items );
90 ARRAY_INIT( p_playlist->all_items );
91 ARRAY_INIT( p_playlist->current );
93 p_playlist->i_current_index = 0;
94 p_playlist->b_reset_currently_playing = true;
95 p_playlist->last_rebuild_date = 0;
97 p_playlist->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
99 p_playlist->b_doing_ml = false;
101 p_playlist->b_auto_preparse =
102 var_CreateGetBool( p_playlist, "auto-preparse" ) ;
104 p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
106 p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
107 0, p_playlist->p_root_category->p_input );
109 if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
112 /* Create playlist and media library */
113 playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
114 &p_playlist->p_local_category,
115 &p_playlist->p_local_onelevel, false );
117 p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
118 p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
120 if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
121 !p_playlist->p_local_category->p_input ||
122 !p_playlist->p_local_onelevel->p_input )
125 if( config_GetInt( p_playlist, "media-library") )
127 playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
128 &p_playlist->p_ml_category,
129 &p_playlist->p_ml_onelevel, false );
131 if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
134 p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
135 p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
139 p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
143 p_playlist->status.p_item = NULL;
144 p_playlist->status.p_node = p_playlist->p_local_onelevel;
145 p_playlist->request.b_request = false;
146 p_playlist->status.i_status = PLAYLIST_STOPPED;
148 p_playlist->i_sort = SORT_ID;
149 p_playlist->i_order = ORDER_NORMAL;
152 b_save = p_playlist->b_auto_preparse;
153 p_playlist->b_auto_preparse = false;
154 playlist_MLLoad( p_playlist );
155 p_playlist->b_auto_preparse = true;
157 vlc_object_set_destructor( p_playlist, playlist_Destructor );
165 * Destroy a playlist structure.
166 * \param p_playlist the playlist object
170 static void playlist_Destructor( vlc_object_t * p_this )
172 playlist_t * p_playlist = (playlist_t *)p_this;
174 if( p_playlist->p_preparse )
175 vlc_object_release( p_playlist->p_preparse );
177 if( p_playlist->p_fetcher )
178 vlc_object_release( p_playlist->p_fetcher );
181 /* Destroy remaining objects */
182 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
188 if( mdate() - p_playlist->gc_date < 1000000 )
190 p_playlist->b_cant_sleep = true;
193 else if( p_playlist->gc_date == 0 )
197 vlc_mutex_lock( &p_playlist->gc_lock );
198 p_playlist->b_cant_sleep = false;
199 vlc_mutex_unlock( &p_playlist->gc_lock );
205 * Main loop for the playlist
206 * \param p_playlist the playlist object
209 void playlist_MainLoop( playlist_t *p_playlist )
211 playlist_item_t *p_item = NULL;
212 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
215 if( p_playlist->b_reset_currently_playing &&
216 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
218 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
219 p_playlist->status.p_item );
220 p_playlist->last_rebuild_date = mdate();
224 /* If there is an input, check that it doesn't need to die. */
225 if( p_playlist->p_input )
227 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
229 PL_DEBUG( "incoming request - stopping current input" );
230 input_StopThread( p_playlist->p_input );
233 /* This input is dead. Remove it ! */
234 if( p_playlist->p_input->b_dead )
237 input_thread_t *p_input;
238 sout_instance_t **pp_sout =
239 &libvlc_priv(p_playlist->p_libvlc)->p_sout;
241 PL_DEBUG( "dead input" );
243 p_input = p_playlist->p_input;
244 p_playlist->p_input = NULL;
245 assert( *pp_sout == NULL );
246 if( var_CreateGetBool( p_input, "sout-keep" ) )
247 *pp_sout = input_DetachSout( p_input );
249 /* Release the playlist lock, because we may get stuck
250 * in vlc_object_release() for some time. */
254 vlc_object_release( p_input );
258 p_playlist->gc_date = mdate();
259 p_playlist->b_cant_sleep = true;
261 if( p_playlist->status.p_item->i_flags
262 & PLAYLIST_REMOVE_FLAG )
264 PL_DEBUG( "%s was marked for deletion, deleting",
265 PLI_NAME( p_playlist->status.p_item ) );
266 playlist_ItemDelete( p_playlist->status.p_item );
267 if( p_playlist->request.p_item == p_playlist->status.p_item )
268 p_playlist->request.p_item = NULL;
269 p_playlist->status.p_item = NULL;
272 i_activity= var_GetInteger( p_playlist, "activity" );
273 var_SetInteger( p_playlist, "activity", i_activity -
274 DEFAULT_INPUT_ACTIVITY );
277 /* This input is dying, let it do */
278 else if( p_playlist->p_input->b_die )
280 PL_DEBUG( "dying input" );
282 msleep( INTF_IDLE_SLEEP );
286 /* This input has finished, ask it to die ! */
287 else if( p_playlist->p_input->b_error
288 || p_playlist->p_input->b_eof )
290 PL_DEBUG( "finished input" );
291 input_StopThread( p_playlist->p_input );
292 /* No need to wait here, we'll wait in the p_input->b_die case */
295 else if( p_playlist->p_input->i_state != INIT_S )
298 ObjectGarbageCollector( p_playlist, false );
304 /* No input. Several cases
305 * - No request, running status -> start new item
306 * - No request, stopped status -> collect garbage
307 * - Request, running requested -> start new item
308 * - Request, stopped requested -> collect garbage
310 int i_status = p_playlist->request.b_request ?
311 p_playlist->request.i_status : p_playlist->status.i_status;
312 if( i_status != PLAYLIST_STOPPED )
314 msg_Dbg( p_playlist, "starting new item" );
315 p_item = playlist_NextItem( p_playlist );
319 msg_Dbg( p_playlist, "nothing to play" );
320 p_playlist->status.i_status = PLAYLIST_STOPPED;
323 if( b_playexit == true )
325 msg_Info( p_playlist, "end of playlist, exiting" );
326 vlc_object_kill( p_playlist->p_libvlc );
328 ObjectGarbageCollector( p_playlist, true );
331 playlist_PlayItem( p_playlist, p_item );
335 const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
337 p_playlist->status.i_status = PLAYLIST_STOPPED;
338 if( p_playlist->status.p_item &&
339 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
341 PL_DEBUG( "deleting item marked for deletion" );
342 playlist_ItemDelete( p_playlist->status.p_item );
343 p_playlist->status.p_item = NULL;
346 /* Collect garbage */
348 ObjectGarbageCollector( p_playlist, b_gc_forced );
358 * The playlist is dying so do the last loop
359 * \param p_playlist the playlist object
362 void playlist_LastLoop( playlist_t *p_playlist )
366 /* If there is an input, kill it */
370 if( p_playlist->p_input == NULL )
376 if( p_playlist->p_input->b_dead )
378 input_thread_t *p_input;
380 /* Unlink current input */
381 p_input = p_playlist->p_input;
382 p_playlist->p_input = NULL;
385 /* sout-keep: no need to anything here.
386 * The last input will destroy its sout, if any, by itself */
389 vlc_object_release( p_input );
392 else if( p_playlist->p_input->b_die )
394 /* This input is dying, leave it alone */
397 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
399 input_StopThread( p_playlist->p_input );
405 p_playlist->p_input->b_eof = 1;
409 msleep( INTF_IDLE_SLEEP );
413 /* close the remaining sout-keep (if there was no input atm) */
414 sout_instance_t *p_sout = libvlc_priv (p_playlist->p_libvlc)->p_sout;
416 sout_DeleteInstance( p_sout );
419 while( p_playlist->i_sds )
421 playlist_ServicesDiscoveryRemove( p_playlist,
422 p_playlist->pp_sds[0]->p_sd->psz_module );
425 playlist_MLDump( p_playlist );
428 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
429 free( p_del->pp_children );
430 vlc_gc_decref( p_del->p_input );
433 ARRAY_RESET( p_playlist->all_items );
435 ARRAY_RESET( p_playlist->items );
436 ARRAY_RESET( p_playlist->current );
444 * Main loop for preparser queue
445 * \param p_obj items to preparse
448 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
450 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
451 input_item_t *p_current;
454 vlc_object_lock( p_obj );
456 while( vlc_object_alive( p_obj ) )
458 if( p_obj->i_waiting == 0 )
460 vlc_object_wait( p_obj );
464 p_current = p_obj->pp_waiting[0];
465 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
466 vlc_object_unlock( p_obj );
471 if( p_current->i_type == ITEM_TYPE_FILE )
473 stats_TimerStart( p_playlist, "Preparse run",
474 STATS_TIMER_PREPARSE );
475 /* Do not preparse if it is already done (like by playing it) */
476 if( !input_item_IsPreparsed( p_current ) )
479 input_Preparse( p_playlist, p_current );
482 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
484 input_item_SetPreparsed( p_current, true );
485 var_SetInteger( p_playlist, "item-change", p_current->i_id );
488 /* If we haven't retrieved enough meta, add to secondary queue
489 * which will run the "meta fetchers".
490 * This only checks for meta, not for art
491 * \todo don't do this for things we won't get meta for, like vids
493 char *psz_arturl = input_item_GetArtURL( p_current );
494 char *psz_name = input_item_GetName( p_current );
495 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
496 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
498 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
499 vlc_object_lock( p_playlist->p_fetcher );
500 INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
501 p_playlist->p_fetcher->i_waiting,
502 p_playlist->p_fetcher->i_waiting, p_current);
503 vlc_object_signal_unlocked( p_playlist->p_fetcher );
504 vlc_object_unlock( p_playlist->p_fetcher );
508 PL_DEBUG( "no fetch required for %s (art currently %s)",
509 psz_name, psz_arturl );
510 vlc_gc_decref( p_current );
519 vlc_object_lock( p_obj );
520 i_activity = var_GetInteger( p_playlist, "activity" );
521 if( i_activity < 0 ) i_activity = 0;
522 vlc_object_unlock( p_obj );
523 /* Sleep at least 1ms */
524 msleep( (i_activity+1) * 1000 );
525 vlc_object_lock( p_obj );
527 vlc_object_unlock( p_obj );
533 * Main loop for secondary preparser queue
534 * \param p_obj items to preparse
537 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
539 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
540 input_item_t *p_item;
543 vlc_mutex_lock( &p_obj->object_lock );
545 while( vlc_object_alive( p_obj ) )
547 if( p_obj->i_waiting == 0 )
549 vlc_object_wait( p_obj );
553 p_item = p_obj->pp_waiting[0];
554 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
555 vlc_mutex_unlock( &p_obj->object_lock );
560 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
561 * (This can happen if we fetch art on play)
562 * FIXME this doesn't work if we need to fetch meta before art ... */
563 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
567 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
568 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
575 i_ret = input_ArtFind( p_playlist, p_item );
578 PL_DEBUG( "downloading art for %s", p_item->psz_name );
579 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
580 input_item_SetArtNotFound( p_item, true );
582 input_item_SetArtFetched( p_item, true );
583 var_SetInteger( p_playlist, "item-change",
587 else if( i_ret == 0 ) /* Was in cache */
589 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
590 input_item_SetArtFetched( p_item, true );
591 var_SetInteger( p_playlist, "item-change", p_item->i_id );
595 PL_DEBUG( "art not found for %s", p_item->psz_name );
596 input_item_SetArtNotFound( p_item, true );
598 vlc_gc_decref( p_item );
600 vlc_object_lock( p_obj );
601 i_activity = var_GetInteger( p_playlist, "activity" );
602 if( i_activity < 0 ) i_activity = 0;
603 vlc_object_unlock( p_obj );
604 /* Sleep at least 1ms */
605 msleep( (i_activity+1) * 1000 );
606 vlc_mutex_lock( &p_obj->object_lock );
608 vlc_mutex_unlock( &p_obj->object_lock );
611 static void VariablesInit( playlist_t *p_playlist )
614 /* These variables control updates */
615 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
617 var_Set( p_playlist, "intf-change", val );
619 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
621 var_Set( p_playlist, "item-change", val );
623 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
625 var_Set( p_playlist, "item-deleted", val );
627 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
629 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
631 var_Set( p_playlist, "playlist-current", val );
633 var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
635 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
636 var_SetInteger( p_playlist, "activity", 0 );
638 /* Variables to control playback */
639 var_CreateGetBool( p_playlist, "play-and-stop" );
640 var_CreateGetBool( p_playlist, "play-and-exit" );
641 var_CreateGetBool( p_playlist, "random" );
642 var_CreateGetBool( p_playlist, "repeat" );
643 var_CreateGetBool( p_playlist, "loop" );
645 var_AddCallback( p_playlist, "random", RandomCallback, NULL );