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;
47 playlist_t *p_playlist = (playlist_t*)p_this;
51 pl_priv(p_playlist)->b_reset_currently_playing = true;
52 vlc_object_signal_unlocked( p_playlist );
61 * Create a playlist structure.
62 * \param p_parent the vlc object that is to be the parent of this playlist
63 * \return a pointer to the created playlist, or NULL on error
65 playlist_t * playlist_Create( vlc_object_t *p_parent )
67 static const char playlist_name[] = "playlist";
68 playlist_t *p_playlist;
69 playlist_private_t *p;
71 /* Allocate structure */
72 p = vlc_custom_create( p_parent, sizeof( *p ),
73 VLC_OBJECT_GENERIC, playlist_name );
77 assert( offsetof( playlist_private_t, public_data ) == 0 );
78 p_playlist = &p->public_data;
79 TAB_INIT( pl_priv(p_playlist)->i_sds, pl_priv(p_playlist)->pp_sds );
81 libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
83 VariablesInit( p_playlist );
85 /* Initialise data structures */
86 pl_priv(p_playlist)->i_last_playlist_id = 0;
87 pl_priv(p_playlist)->p_input = NULL;
89 pl_priv(p_playlist)->gc_date = 0;
90 pl_priv(p_playlist)->b_cant_sleep = false;
92 ARRAY_INIT( p_playlist->items );
93 ARRAY_INIT( p_playlist->all_items );
94 ARRAY_INIT( pl_priv(p_playlist)->items_to_delete );
95 ARRAY_INIT( p_playlist->current );
97 p_playlist->i_current_index = 0;
98 pl_priv(p_playlist)->b_reset_currently_playing = true;
99 pl_priv(p_playlist)->last_rebuild_date = 0;
101 pl_priv(p_playlist)->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
103 pl_priv(p_playlist)->b_doing_ml = false;
105 pl_priv(p_playlist)->b_auto_preparse =
106 var_CreateGetBool( p_playlist, "auto-preparse" ) ;
108 PL_LOCK; /* playlist_NodeCreate will check for it */
109 p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
111 p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
112 0, p_playlist->p_root_category->p_input );
115 if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
118 /* Create playlist and media library */
119 PL_LOCK; /* playlist_NodesPairCreate will check for it */
120 playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
121 &p_playlist->p_local_category,
122 &p_playlist->p_local_onelevel, false );
125 p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
126 p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
128 if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
129 !p_playlist->p_local_category->p_input ||
130 !p_playlist->p_local_onelevel->p_input )
133 if( config_GetInt( p_playlist, "media-library") )
135 PL_LOCK; /* playlist_NodesPairCreate will check for it */
136 playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
137 &p_playlist->p_ml_category,
138 &p_playlist->p_ml_onelevel, false );
141 if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
144 p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
145 p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
149 p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
153 pl_priv(p_playlist)->status.p_item = NULL;
154 pl_priv(p_playlist)->status.p_node = p_playlist->p_local_onelevel;
155 pl_priv(p_playlist)->request.b_request = false;
156 pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
158 pl_priv(p_playlist)->b_auto_preparse = false;
159 playlist_MLLoad( p_playlist );
160 pl_priv(p_playlist)->b_auto_preparse = true;
162 vlc_object_set_destructor( p_playlist, playlist_Destructor );
170 * Destroy a playlist structure.
171 * \param p_playlist the playlist object
175 static void playlist_Destructor( vlc_object_t * p_this )
177 playlist_t * p_playlist = (playlist_t *)p_this;
179 /* Destroy the item preparser */
180 playlist_preparse_t *p_preparse = &pl_priv(p_playlist)->preparse;
183 vlc_cancel (p_preparse->thread);
184 vlc_join (p_preparse->thread, NULL);
186 while (p_preparse->i_waiting > 0)
187 { /* Any left-over unparsed item? */
188 vlc_gc_decref (p_preparse->pp_waiting[0]);
189 REMOVE_ELEM (p_preparse->pp_waiting, p_preparse->i_waiting, 0);
191 vlc_cond_destroy (&p_preparse->wait);
192 vlc_mutex_destroy (&p_preparse->lock);
194 /* Destroy the item meta-infos fetcher */
195 playlist_fetcher_t *p_fetcher = &pl_priv(p_playlist)->fetcher;
198 vlc_cancel (p_fetcher->thread);
199 vlc_join (p_fetcher->thread, NULL);
201 while (p_fetcher->i_waiting > 0)
202 { /* Any left-over unparsed item? */
203 vlc_gc_decref (p_fetcher->pp_waiting[0]);
204 REMOVE_ELEM (p_fetcher->pp_waiting, p_fetcher->i_waiting, 0);
206 vlc_cond_destroy (&p_fetcher->wait);
207 vlc_mutex_destroy (&p_fetcher->lock);
209 msg_Dbg( p_this, "Destroyed" );
212 /* Destroy remaining objects */
213 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
217 if( mdate() - pl_priv(p_playlist)->gc_date < 1000000 )
219 pl_priv(p_playlist)->b_cant_sleep = true;
222 else if( pl_priv(p_playlist)->gc_date == 0 )
226 pl_priv(p_playlist)->b_cant_sleep = false;
230 static int InputEvent( vlc_object_t *p_this, char const *psz_cmd,
231 vlc_value_t oldval, vlc_value_t newval, void *p_data )
233 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
234 playlist_t *p_playlist = p_data;
236 if( newval.i_int != INPUT_EVENT_STATE &&
237 newval.i_int != INPUT_EVENT_ES )
242 if( newval.i_int == INPUT_EVENT_ES )
243 pl_priv(p_playlist)->gc_date = mdate();
245 vlc_object_signal_unlocked( p_playlist );
252 void playlist_release_current_input( playlist_t * p_playlist )
256 if( !pl_priv(p_playlist)->p_input ) return;
258 input_thread_t * p_input = pl_priv(p_playlist)->p_input;
260 var_DelCallback( p_input, "intf-event", InputEvent, p_playlist );
261 pl_priv(p_playlist)->p_input = NULL;
263 /* Release the playlist lock, because we may get stuck
264 * in vlc_object_release() for some time. */
266 vlc_thread_join( p_input );
267 vlc_object_release( p_input );
271 void playlist_set_current_input(
272 playlist_t * p_playlist, input_thread_t * p_input )
276 playlist_release_current_input( p_playlist );
280 vlc_object_hold( p_input );
281 pl_priv(p_playlist)->p_input = p_input;
283 var_AddCallback( p_input, "intf-event", InputEvent, p_playlist );
287 /** Get current playing input.
289 input_thread_t * playlist_CurrentInput( playlist_t * p_playlist )
291 input_thread_t * p_input;
293 p_input = pl_priv(p_playlist)->p_input;
294 if( p_input ) vlc_object_hold( p_input );
303 /** Accessor for status item and status nodes.
305 playlist_item_t * get_current_status_item( playlist_t * p_playlist )
309 return pl_priv(p_playlist)->status.p_item;
312 playlist_item_t * get_current_status_node( playlist_t * p_playlist )
316 return pl_priv(p_playlist)->status.p_node;
319 void set_current_status_item( playlist_t * p_playlist,
320 playlist_item_t * p_item )
324 if( pl_priv(p_playlist)->status.p_item &&
325 pl_priv(p_playlist)->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG &&
326 pl_priv(p_playlist)->status.p_item != p_item )
328 /* It's unsafe given current design to delete a playlist item :(
329 playlist_ItemDelete( pl_priv(p_playlist)->status.p_item ); */
331 pl_priv(p_playlist)->status.p_item = p_item;
334 void set_current_status_node( playlist_t * p_playlist,
335 playlist_item_t * p_node )
339 if( pl_priv(p_playlist)->status.p_node &&
340 pl_priv(p_playlist)->status.p_node->i_flags & PLAYLIST_REMOVE_FLAG &&
341 pl_priv(p_playlist)->status.p_node != p_node )
343 /* It's unsafe given current design to delete a playlist item :(
344 playlist_ItemDelete( pl_priv(p_playlist)->status.p_node ); */
346 pl_priv(p_playlist)->status.p_node = p_node;
352 * Main loop for the playlist. It should be entered with the
353 * playlist lock (otherwise input event may be lost)
354 * \param p_playlist the playlist object
357 void playlist_MainLoop( playlist_t *p_playlist )
359 playlist_item_t *p_item = NULL;
360 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
364 if( pl_priv(p_playlist)->b_reset_currently_playing &&
365 mdate() - pl_priv(p_playlist)->last_rebuild_date > 30000 ) // 30 ms
367 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
368 get_current_status_item( p_playlist ) );
369 pl_priv(p_playlist)->last_rebuild_date = mdate();
373 /* If there is an input, check that it doesn't need to die. */
374 if( pl_priv(p_playlist)->p_input )
376 if( pl_priv(p_playlist)->request.b_request && !pl_priv(p_playlist)->p_input->b_die )
378 PL_DEBUG( "incoming request - stopping current input" );
379 input_StopThread( pl_priv(p_playlist)->p_input );
382 /* This input is dead. Remove it ! */
383 if( pl_priv(p_playlist)->p_input->b_dead )
386 input_thread_t *p_input;
387 sout_instance_t **pp_sout = &pl_priv(p_playlist)->p_sout;
389 PL_DEBUG( "dead input" );
391 p_input = pl_priv(p_playlist)->p_input;
393 assert( *pp_sout == NULL );
394 if( var_CreateGetBool( p_input, "sout-keep" ) )
395 *pp_sout = input_DetachSout( p_input );
398 playlist_release_current_input( p_playlist );
400 pl_priv(p_playlist)->gc_date = mdate();
401 pl_priv(p_playlist)->b_cant_sleep = true;
403 i_activity= var_GetInteger( p_playlist, "activity" );
404 var_SetInteger( p_playlist, "activity", i_activity -
405 DEFAULT_INPUT_ACTIVITY );
409 /* This input is dying, let it do */
410 else if( pl_priv(p_playlist)->p_input->b_die )
412 PL_DEBUG( "dying input" );
414 msleep( INTF_IDLE_SLEEP );
418 /* This input has finished, ask it to die ! */
419 else if( pl_priv(p_playlist)->p_input->b_error
420 || pl_priv(p_playlist)->p_input->b_eof )
422 PL_DEBUG( "finished input" );
423 input_StopThread( pl_priv(p_playlist)->p_input );
424 /* No need to wait here, we'll wait in the p_input->b_die case */
427 else if( pl_priv(p_playlist)->p_input->i_state != INIT_S )
429 ObjectGarbageCollector( p_playlist, false );
434 /* No input. Several cases
435 * - No request, running status -> start new item
436 * - No request, stopped status -> collect garbage
437 * - Request, running requested -> start new item
438 * - Request, stopped requested -> collect garbage
440 int i_status = pl_priv(p_playlist)->request.b_request ?
441 pl_priv(p_playlist)->request.i_status : pl_priv(p_playlist)->status.i_status;
442 if( i_status != PLAYLIST_STOPPED )
444 msg_Dbg( p_playlist, "starting new item" );
445 p_item = playlist_NextItem( p_playlist );
449 msg_Dbg( p_playlist, "nothing to play" );
450 pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
452 if( b_playexit == true )
454 msg_Info( p_playlist, "end of playlist, exiting" );
455 vlc_object_kill( p_playlist->p_libvlc );
457 ObjectGarbageCollector( p_playlist, true );
460 playlist_PlayItem( p_playlist, p_item );
461 /* playlist_PlayItem loose input event, we need to recheck */
466 const bool b_gc_forced = pl_priv(p_playlist)->status.i_status != PLAYLIST_STOPPED;
468 pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
470 /* Collect garbage */
471 ObjectGarbageCollector( p_playlist, b_gc_forced );
479 * The playlist is dying so do the last loop
480 * \param p_playlist the playlist object
483 void playlist_LastLoop( playlist_t *p_playlist )
485 /* If there is an input, kill it */
489 if( pl_priv(p_playlist)->p_input == NULL )
495 if( pl_priv(p_playlist)->p_input->b_dead )
498 playlist_release_current_input( p_playlist );
500 /* sout-keep: no need to anything here.
501 * The last input will destroy its sout, if any, by itself */
506 else if( pl_priv(p_playlist)->p_input->b_die )
508 /* This input is dying, leave it alone */
511 else if( pl_priv(p_playlist)->p_input->b_error || pl_priv(p_playlist)->p_input->b_eof )
513 input_StopThread( pl_priv(p_playlist)->p_input );
519 pl_priv(p_playlist)->p_input->b_eof = 1;
523 msleep( INTF_IDLE_SLEEP );
527 /* close the remaining sout-keep (if there was no input atm) */
528 sout_instance_t *p_sout = pl_priv(p_playlist)->p_sout;
530 sout_DeleteInstance( p_sout );
533 /* Core should have terminated all SDs before the playlist */
534 /* TODO: It fails to do so when not playing anything -- Courmisch */
535 playlist_ServicesDiscoveryKillAll( p_playlist );
536 playlist_MLDump( p_playlist );
540 /* Release the current node */
541 set_current_status_node( p_playlist, NULL );
543 /* Release the current item */
544 set_current_status_item( p_playlist, NULL );
546 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
547 free( p_del->pp_children );
548 vlc_gc_decref( p_del->p_input );
551 ARRAY_RESET( p_playlist->all_items );
552 FOREACH_ARRAY( playlist_item_t *p_del, pl_priv(p_playlist)->items_to_delete )
553 free( p_del->pp_children );
554 vlc_gc_decref( p_del->p_input );
557 ARRAY_RESET( pl_priv(p_playlist)->items_to_delete );
559 ARRAY_RESET( p_playlist->items );
560 ARRAY_RESET( p_playlist->current );
566 * Preparse queue loop
568 * @param p_obj preparse structure
571 void *playlist_PreparseLoop( void *data )
573 playlist_preparse_t *p_preparse = data;
574 playlist_t *p_playlist = &((playlist_private_t *)(((char *)p_preparse)
575 - offsetof(playlist_private_t, preparse)))->public_data;
579 input_item_t *p_current;
581 vlc_mutex_lock( &p_preparse->lock );
582 mutex_cleanup_push( &p_preparse->lock );
584 while( p_preparse->i_waiting == 0 )
585 vlc_cond_wait( &p_preparse->wait, &p_preparse->lock );
587 p_current = p_preparse->pp_waiting[0];
588 REMOVE_ELEM( p_preparse->pp_waiting, p_preparse->i_waiting, 0 );
593 int canc = vlc_savecancel ();
595 if( p_current->i_type == ITEM_TYPE_FILE )
597 stats_TimerStart( p_playlist, "Preparse run",
598 STATS_TIMER_PREPARSE );
599 /* Do not preparse if it is already done (like by playing it) */
600 if( !input_item_IsPreparsed( p_current ) )
603 input_Preparse( p_playlist, p_current );
606 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
608 input_item_SetPreparsed( p_current, true );
609 var_SetInteger( p_playlist, "item-change", p_current->i_id );
612 /* If we haven't retrieved enough meta, add to secondary queue
613 * which will run the "meta fetchers".
614 * This only checks for meta, not for art
615 * \todo don't do this for things we won't get meta for, like vids
617 char *psz_arturl = input_item_GetArtURL( p_current );
618 char *psz_name = input_item_GetName( p_current );
619 playlist_fetcher_t *p_fetcher = &pl_priv(p_playlist)->fetcher;
620 if( p_fetcher->i_art_policy == ALBUM_ART_ALL &&
621 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
623 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
624 vlc_mutex_lock( &p_fetcher->lock );
625 INSERT_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting,
626 p_fetcher->i_waiting, p_current);
627 vlc_cond_signal( &p_fetcher->wait );
628 vlc_mutex_unlock( &p_fetcher->lock );
632 PL_DEBUG( "no fetch required for %s (art currently %s)",
633 psz_name, psz_arturl );
634 vlc_gc_decref( p_current );
639 vlc_restorecancel( canc );
642 int i_activity = var_GetInteger( p_playlist, "activity" );
643 if( i_activity < 0 ) i_activity = 0;
644 /* Sleep at least 1ms */
645 msleep( (i_activity+1) * 1000 );
657 void *playlist_FetcherLoop( void *data )
659 playlist_fetcher_t *p_fetcher = data;
660 playlist_t *p_playlist = &((playlist_private_t *)(((char *)p_fetcher)
661 - offsetof(playlist_private_t, fetcher)))->public_data;
665 input_item_t *p_item;
667 vlc_mutex_lock( &p_fetcher->lock );
668 mutex_cleanup_push( &p_fetcher->lock );
670 while( p_fetcher->i_waiting == 0 )
671 vlc_cond_wait( &p_fetcher->wait, &p_fetcher->lock );
673 p_item = p_fetcher->pp_waiting[0];
674 REMOVE_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting, 0 );
677 int canc = vlc_savecancel();
682 /* Check if it is not yet preparsed and if so wait for it
684 * (This can happen if we fetch art on play)
685 * FIXME this doesn't work if we need to fetch meta before art...
687 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
691 b_break = ( !pl_priv(p_playlist)->p_input || input_GetItem(pl_priv(p_playlist)->p_input) != p_item ||
692 pl_priv(p_playlist)->p_input->b_die || pl_priv(p_playlist)->p_input->b_eof || pl_priv(p_playlist)->p_input->b_error );
699 i_ret = input_ArtFind( p_playlist, p_item );
702 PL_DEBUG( "downloading art for %s", p_item->psz_name );
703 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
704 input_item_SetArtNotFound( p_item, true );
706 input_item_SetArtFetched( p_item, true );
707 var_SetInteger( p_playlist, "item-change",
711 else if( i_ret == 0 ) /* Was in cache */
713 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
714 input_item_SetArtFetched( p_item, true );
715 var_SetInteger( p_playlist, "item-change", p_item->i_id );
719 PL_DEBUG( "art not found for %s", p_item->psz_name );
720 input_item_SetArtNotFound( p_item, true );
722 vlc_gc_decref( p_item );
724 vlc_restorecancel( canc );
726 int i_activity = var_GetInteger( p_playlist, "activity" );
727 if( i_activity < 0 ) i_activity = 0;
728 /* Sleep at least 1ms */
729 msleep( (i_activity+1) * 1000 );
736 static void VariablesInit( playlist_t *p_playlist )
739 /* These variables control updates */
740 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
742 var_Set( p_playlist, "intf-change", val );
744 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
746 var_Set( p_playlist, "item-change", val );
748 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
750 var_Set( p_playlist, "item-deleted", val );
752 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
754 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
756 var_Set( p_playlist, "playlist-current", val );
758 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
759 var_SetInteger( p_playlist, "activity", 0 );
761 /* Variables to control playback */
762 var_Create( p_playlist, "play-and-stop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
763 var_Create( p_playlist, "play-and-exit", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
764 var_Create( p_playlist, "random", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
765 var_Create( p_playlist, "repeat", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
766 var_Create( p_playlist, "loop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
768 var_AddCallback( p_playlist, "random", RandomCallback, NULL );
771 int playlist_CurrentId( playlist_t * p_playlist )
773 return pl_priv(p_playlist)->status.p_item->i_id;
776 bool playlist_IsPlaying( playlist_t * p_playlist )
778 return ( pl_priv(p_playlist)->status.i_status == PLAYLIST_RUNNING &&
779 !(pl_priv(p_playlist)->request.b_request && pl_priv(p_playlist)->request.i_status == PLAYLIST_STOPPED) );
782 playlist_item_t * playlist_CurrentPlayingItem( playlist_t * p_playlist )
784 return pl_priv(p_playlist)->status.p_item;
787 int playlist_Status( playlist_t * p_playlist )
789 return pl_priv(p_playlist)->status.i_status;