1 /*****************************************************************************
2 * engine.c : Run the playlist and handle its control
3 *****************************************************************************
4 * Copyright (C) 1999-2008 the VideoLAN team
6 * Authors: Samuel Hocevar <sam@zoy.org>
7 * Clément Stenac <zorglub@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
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 pl_priv((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;
64 playlist_private_t *p;
66 /* Allocate structure */
67 p = vlc_custom_create( p_parent, sizeof( *p ),
68 VLC_OBJECT_GENERIC, playlist_name );
72 assert( offsetof( playlist_private_t, public_data ) == 0 );
73 p_playlist = &p->public_data;
74 TAB_INIT( pl_priv(p_playlist)->i_sds, pl_priv(p_playlist)->pp_sds );
76 libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
78 VariablesInit( p_playlist );
80 /* Initialise data structures */
81 pl_priv(p_playlist)->i_last_playlist_id = 0;
82 pl_priv(p_playlist)->p_input = NULL;
84 pl_priv(p_playlist)->gc_date = 0;
85 pl_priv(p_playlist)->b_cant_sleep = false;
87 ARRAY_INIT( p_playlist->items );
88 ARRAY_INIT( p_playlist->all_items );
89 ARRAY_INIT( pl_priv(p_playlist)->items_to_delete );
90 ARRAY_INIT( p_playlist->current );
92 p_playlist->i_current_index = 0;
93 pl_priv(p_playlist)->b_reset_currently_playing = true;
94 pl_priv(p_playlist)->last_rebuild_date = 0;
96 pl_priv(p_playlist)->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
98 pl_priv(p_playlist)->b_doing_ml = false;
100 pl_priv(p_playlist)->b_auto_preparse =
101 var_CreateGetBool( p_playlist, "auto-preparse" ) ;
103 PL_LOCK; /* playlist_NodeCreate will check for it */
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 );
110 if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
113 /* Create playlist and media library */
114 PL_LOCK; /* playlist_NodesPairCreate will check for it */
115 playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
116 &p_playlist->p_local_category,
117 &p_playlist->p_local_onelevel, false );
120 p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
121 p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
123 if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
124 !p_playlist->p_local_category->p_input ||
125 !p_playlist->p_local_onelevel->p_input )
128 if( config_GetInt( p_playlist, "media-library") )
130 PL_LOCK; /* playlist_NodesPairCreate will check for it */
131 playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
132 &p_playlist->p_ml_category,
133 &p_playlist->p_ml_onelevel, false );
136 if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
139 p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
140 p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
144 p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
148 pl_priv(p_playlist)->status.p_item = NULL;
149 pl_priv(p_playlist)->status.p_node = p_playlist->p_local_onelevel;
150 pl_priv(p_playlist)->request.b_request = false;
151 pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
153 pl_priv(p_playlist)->b_auto_preparse = false;
154 playlist_MLLoad( p_playlist );
155 pl_priv(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 /* Destroy the item preparser */
175 playlist_preparse_t *p_preparse = &pl_priv(p_playlist)->preparse;
178 vlc_cancel (p_preparse->thread);
179 vlc_join (p_preparse->thread, NULL);
181 while (p_preparse->i_waiting > 0)
182 { /* Any left-over unparsed item? */
183 vlc_gc_decref (p_preparse->pp_waiting[0]);
184 REMOVE_ELEM (p_preparse->pp_waiting, p_preparse->i_waiting, 0);
186 vlc_cond_destroy (&p_preparse->wait);
187 vlc_mutex_destroy (&p_preparse->lock);
189 /* Destroy the item meta-infos fetcher */
190 playlist_fetcher_t *p_fetcher = &pl_priv(p_playlist)->fetcher;
193 vlc_cancel (p_fetcher->thread);
194 vlc_join (p_fetcher->thread, NULL);
196 while (p_fetcher->i_waiting > 0)
197 { /* Any left-over unparsed item? */
198 vlc_gc_decref (p_fetcher->pp_waiting[0]);
199 REMOVE_ELEM (p_fetcher->pp_waiting, p_fetcher->i_waiting, 0);
201 vlc_cond_destroy (&p_fetcher->wait);
202 vlc_mutex_destroy (&p_fetcher->lock);
204 msg_Dbg( p_this, "Destroyed" );
207 /* Destroy remaining objects */
208 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
212 if( mdate() - pl_priv(p_playlist)->gc_date < 1000000 )
214 pl_priv(p_playlist)->b_cant_sleep = true;
217 else if( pl_priv(p_playlist)->gc_date == 0 )
221 pl_priv(p_playlist)->b_cant_sleep = false;
225 static int InputEvent( vlc_object_t *p_this, char const *psz_cmd,
226 vlc_value_t oldval, vlc_value_t newval, void *p_data )
228 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
229 playlist_t *p_playlist = p_data;
231 if( newval.i_int == INPUT_EVENT_STATE )
233 playlist_Signal( p_playlist );
235 else if( newval.i_int == INPUT_EVENT_ES )
238 pl_priv(p_playlist)->gc_date = mdate();
239 vlc_object_signal_unlocked( p_playlist );
246 void playlist_release_current_input( playlist_t * p_playlist )
250 if( !pl_priv(p_playlist)->p_input ) return;
252 input_thread_t * p_input = pl_priv(p_playlist)->p_input;
254 var_DelCallback( p_input, "intf-event", InputEvent, p_playlist );
255 pl_priv(p_playlist)->p_input = NULL;
257 /* Release the playlist lock, because we may get stuck
258 * in vlc_object_release() for some time. */
260 vlc_thread_join( p_input );
261 vlc_object_release( p_input );
265 void playlist_set_current_input(
266 playlist_t * p_playlist, input_thread_t * p_input )
270 playlist_release_current_input( p_playlist );
274 vlc_object_hold( p_input );
275 pl_priv(p_playlist)->p_input = p_input;
277 var_AddCallback( p_input, "intf-event", InputEvent, p_playlist );
281 /** Get current playing input.
283 input_thread_t * playlist_CurrentInput( playlist_t * p_playlist )
285 input_thread_t * p_input;
287 p_input = pl_priv(p_playlist)->p_input;
288 if( p_input ) vlc_object_hold( p_input );
297 /** Accessor for status item and status nodes.
299 playlist_item_t * get_current_status_item( playlist_t * p_playlist )
303 return pl_priv(p_playlist)->status.p_item;
306 playlist_item_t * get_current_status_node( playlist_t * p_playlist )
310 return pl_priv(p_playlist)->status.p_node;
313 void set_current_status_item( playlist_t * p_playlist,
314 playlist_item_t * p_item )
318 if( pl_priv(p_playlist)->status.p_item &&
319 pl_priv(p_playlist)->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG &&
320 pl_priv(p_playlist)->status.p_item != p_item )
322 /* It's unsafe given current design to delete a playlist item :(
323 playlist_ItemDelete( pl_priv(p_playlist)->status.p_item ); */
325 pl_priv(p_playlist)->status.p_item = p_item;
328 void set_current_status_node( playlist_t * p_playlist,
329 playlist_item_t * p_node )
333 if( pl_priv(p_playlist)->status.p_node &&
334 pl_priv(p_playlist)->status.p_node->i_flags & PLAYLIST_REMOVE_FLAG &&
335 pl_priv(p_playlist)->status.p_node != p_node )
337 /* It's unsafe given current design to delete a playlist item :(
338 playlist_ItemDelete( pl_priv(p_playlist)->status.p_node ); */
340 pl_priv(p_playlist)->status.p_node = p_node;
346 * Main loop for the playlist. It should be entered with the
347 * playlist lock (otherwise input event may be lost)
348 * \param p_playlist the playlist object
351 void playlist_MainLoop( playlist_t *p_playlist )
353 playlist_item_t *p_item = NULL;
354 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
358 if( pl_priv(p_playlist)->b_reset_currently_playing &&
359 mdate() - pl_priv(p_playlist)->last_rebuild_date > 30000 ) // 30 ms
361 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
362 get_current_status_item( p_playlist ) );
363 pl_priv(p_playlist)->last_rebuild_date = mdate();
367 /* If there is an input, check that it doesn't need to die. */
368 if( pl_priv(p_playlist)->p_input )
370 if( pl_priv(p_playlist)->request.b_request && !pl_priv(p_playlist)->p_input->b_die )
372 PL_DEBUG( "incoming request - stopping current input" );
373 input_StopThread( pl_priv(p_playlist)->p_input );
376 /* This input is dead. Remove it ! */
377 if( pl_priv(p_playlist)->p_input->b_dead )
380 input_thread_t *p_input;
381 sout_instance_t **pp_sout = &pl_priv(p_playlist)->p_sout;
383 PL_DEBUG( "dead input" );
385 p_input = pl_priv(p_playlist)->p_input;
387 assert( *pp_sout == NULL );
388 if( var_CreateGetBool( p_input, "sout-keep" ) )
389 *pp_sout = input_DetachSout( p_input );
392 playlist_release_current_input( p_playlist );
394 pl_priv(p_playlist)->gc_date = mdate();
395 pl_priv(p_playlist)->b_cant_sleep = true;
397 i_activity= var_GetInteger( p_playlist, "activity" );
398 var_SetInteger( p_playlist, "activity", i_activity -
399 DEFAULT_INPUT_ACTIVITY );
403 /* This input is dying, let it do */
404 else if( pl_priv(p_playlist)->p_input->b_die )
406 PL_DEBUG( "dying input" );
408 msleep( INTF_IDLE_SLEEP );
412 /* This input has finished, ask it to die ! */
413 else if( pl_priv(p_playlist)->p_input->b_error
414 || pl_priv(p_playlist)->p_input->b_eof )
416 PL_DEBUG( "finished input" );
417 input_StopThread( pl_priv(p_playlist)->p_input );
418 /* No need to wait here, we'll wait in the p_input->b_die case */
421 else if( pl_priv(p_playlist)->p_input->i_state != INIT_S )
423 ObjectGarbageCollector( p_playlist, false );
428 /* No input. Several cases
429 * - No request, running status -> start new item
430 * - No request, stopped status -> collect garbage
431 * - Request, running requested -> start new item
432 * - Request, stopped requested -> collect garbage
434 int i_status = pl_priv(p_playlist)->request.b_request ?
435 pl_priv(p_playlist)->request.i_status : pl_priv(p_playlist)->status.i_status;
436 if( i_status != PLAYLIST_STOPPED )
438 msg_Dbg( p_playlist, "starting new item" );
439 p_item = playlist_NextItem( p_playlist );
443 msg_Dbg( p_playlist, "nothing to play" );
444 pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
446 if( b_playexit == true )
448 msg_Info( p_playlist, "end of playlist, exiting" );
449 vlc_object_kill( p_playlist->p_libvlc );
451 ObjectGarbageCollector( p_playlist, true );
454 playlist_PlayItem( p_playlist, p_item );
455 /* playlist_PlayItem loose input event, we need to recheck */
460 const bool b_gc_forced = pl_priv(p_playlist)->status.i_status != PLAYLIST_STOPPED;
462 pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
464 /* Collect garbage */
465 ObjectGarbageCollector( p_playlist, b_gc_forced );
473 * The playlist is dying so do the last loop
474 * \param p_playlist the playlist object
477 void playlist_LastLoop( playlist_t *p_playlist )
479 /* If there is an input, kill it */
483 if( pl_priv(p_playlist)->p_input == NULL )
489 if( pl_priv(p_playlist)->p_input->b_dead )
492 playlist_release_current_input( p_playlist );
494 /* sout-keep: no need to anything here.
495 * The last input will destroy its sout, if any, by itself */
500 else if( pl_priv(p_playlist)->p_input->b_die )
502 /* This input is dying, leave it alone */
505 else if( pl_priv(p_playlist)->p_input->b_error || pl_priv(p_playlist)->p_input->b_eof )
507 input_StopThread( pl_priv(p_playlist)->p_input );
513 pl_priv(p_playlist)->p_input->b_eof = 1;
517 msleep( INTF_IDLE_SLEEP );
521 /* close the remaining sout-keep (if there was no input atm) */
522 sout_instance_t *p_sout = pl_priv(p_playlist)->p_sout;
524 sout_DeleteInstance( p_sout );
527 /* Core should have terminated all SDs before the playlist */
528 /* TODO: It fails to do so when not playing anything -- Courmisch */
529 playlist_ServicesDiscoveryKillAll( p_playlist );
530 playlist_MLDump( p_playlist );
534 /* Release the current node */
535 set_current_status_node( p_playlist, NULL );
537 /* Release the current item */
538 set_current_status_item( p_playlist, NULL );
540 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
541 free( p_del->pp_children );
542 vlc_gc_decref( p_del->p_input );
545 ARRAY_RESET( p_playlist->all_items );
546 FOREACH_ARRAY( playlist_item_t *p_del, pl_priv(p_playlist)->items_to_delete )
547 free( p_del->pp_children );
548 vlc_gc_decref( p_del->p_input );
551 ARRAY_RESET( pl_priv(p_playlist)->items_to_delete );
553 ARRAY_RESET( p_playlist->items );
554 ARRAY_RESET( p_playlist->current );
560 * Preparse queue loop
562 * @param p_obj preparse structure
565 void *playlist_PreparseLoop( void *data )
567 playlist_preparse_t *p_preparse = data;
568 playlist_t *p_playlist = &((playlist_private_t *)(((char *)p_preparse)
569 - offsetof(playlist_private_t, preparse)))->public_data;
573 input_item_t *p_current;
575 vlc_mutex_lock( &p_preparse->lock );
576 mutex_cleanup_push( &p_preparse->lock );
578 while( p_preparse->i_waiting == 0 )
579 vlc_cond_wait( &p_preparse->wait, &p_preparse->lock );
581 p_current = p_preparse->pp_waiting[0];
582 REMOVE_ELEM( p_preparse->pp_waiting, p_preparse->i_waiting, 0 );
587 int canc = vlc_savecancel ();
589 if( p_current->i_type == ITEM_TYPE_FILE )
591 stats_TimerStart( p_playlist, "Preparse run",
592 STATS_TIMER_PREPARSE );
593 /* Do not preparse if it is already done (like by playing it) */
594 if( !input_item_IsPreparsed( p_current ) )
597 input_Preparse( p_playlist, p_current );
600 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
602 input_item_SetPreparsed( p_current, true );
603 var_SetInteger( p_playlist, "item-change", p_current->i_id );
606 /* If we haven't retrieved enough meta, add to secondary queue
607 * which will run the "meta fetchers".
608 * This only checks for meta, not for art
609 * \todo don't do this for things we won't get meta for, like vids
611 char *psz_arturl = input_item_GetArtURL( p_current );
612 char *psz_name = input_item_GetName( p_current );
613 playlist_fetcher_t *p_fetcher = &pl_priv(p_playlist)->fetcher;
614 if( p_fetcher->i_art_policy == ALBUM_ART_ALL &&
615 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
617 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
618 vlc_mutex_lock( &p_fetcher->lock );
619 INSERT_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting,
620 p_fetcher->i_waiting, p_current);
621 vlc_cond_signal( &p_fetcher->wait );
622 vlc_mutex_unlock( &p_fetcher->lock );
626 PL_DEBUG( "no fetch required for %s (art currently %s)",
627 psz_name, psz_arturl );
628 vlc_gc_decref( p_current );
633 vlc_restorecancel( canc );
636 int i_activity = var_GetInteger( p_playlist, "activity" );
637 if( i_activity < 0 ) i_activity = 0;
638 /* Sleep at least 1ms */
639 msleep( (i_activity+1) * 1000 );
651 void *playlist_FetcherLoop( void *data )
653 playlist_fetcher_t *p_fetcher = data;
654 playlist_t *p_playlist = &((playlist_private_t *)(((char *)p_fetcher)
655 - offsetof(playlist_private_t, fetcher)))->public_data;
659 input_item_t *p_item;
661 vlc_mutex_lock( &p_fetcher->lock );
662 mutex_cleanup_push( &p_fetcher->lock );
664 while( p_fetcher->i_waiting == 0 )
665 vlc_cond_wait( &p_fetcher->wait, &p_fetcher->lock );
667 p_item = p_fetcher->pp_waiting[0];
668 REMOVE_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting, 0 );
671 int canc = vlc_savecancel();
676 /* Check if it is not yet preparsed and if so wait for it
678 * (This can happen if we fetch art on play)
679 * FIXME this doesn't work if we need to fetch meta before art...
681 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
685 b_break = ( !pl_priv(p_playlist)->p_input || input_GetItem(pl_priv(p_playlist)->p_input) != p_item ||
686 pl_priv(p_playlist)->p_input->b_die || pl_priv(p_playlist)->p_input->b_eof || pl_priv(p_playlist)->p_input->b_error );
693 i_ret = input_ArtFind( p_playlist, p_item );
696 PL_DEBUG( "downloading art for %s", p_item->psz_name );
697 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
698 input_item_SetArtNotFound( p_item, true );
700 input_item_SetArtFetched( p_item, true );
701 var_SetInteger( p_playlist, "item-change",
705 else if( i_ret == 0 ) /* Was in cache */
707 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
708 input_item_SetArtFetched( p_item, true );
709 var_SetInteger( p_playlist, "item-change", p_item->i_id );
713 PL_DEBUG( "art not found for %s", p_item->psz_name );
714 input_item_SetArtNotFound( p_item, true );
716 vlc_gc_decref( p_item );
718 vlc_restorecancel( canc );
720 int i_activity = var_GetInteger( p_playlist, "activity" );
721 if( i_activity < 0 ) i_activity = 0;
722 /* Sleep at least 1ms */
723 msleep( (i_activity+1) * 1000 );
730 static void VariablesInit( playlist_t *p_playlist )
733 /* These variables control updates */
734 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
736 var_Set( p_playlist, "intf-change", val );
738 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
740 var_Set( p_playlist, "item-change", val );
742 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
744 var_Set( p_playlist, "item-deleted", val );
746 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
748 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
750 var_Set( p_playlist, "playlist-current", val );
752 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
753 var_SetInteger( p_playlist, "activity", 0 );
755 /* Variables to control playback */
756 var_Create( p_playlist, "play-and-stop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
757 var_Create( p_playlist, "play-and-exit", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
758 var_Create( p_playlist, "random", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
759 var_Create( p_playlist, "repeat", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
760 var_Create( p_playlist, "loop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
762 var_AddCallback( p_playlist, "random", RandomCallback, NULL );
765 int playlist_CurrentId( playlist_t * p_playlist )
767 return pl_priv(p_playlist)->status.p_item->i_id;
770 bool playlist_IsPlaying( playlist_t * p_playlist )
772 return ( pl_priv(p_playlist)->status.i_status == PLAYLIST_RUNNING &&
773 !(pl_priv(p_playlist)->request.b_request && pl_priv(p_playlist)->request.i_status == PLAYLIST_STOPPED) );
776 playlist_item_t * playlist_CurrentPlayingItem( playlist_t * p_playlist )
778 return pl_priv(p_playlist)->status.p_item;
781 int playlist_Status( playlist_t * p_playlist )
783 return pl_priv(p_playlist)->status.i_status;