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;
67 /* Allocate structure */
68 p = vlc_custom_create( p_parent, sizeof( *p ),
69 VLC_OBJECT_GENERIC, playlist_name );
73 assert( offsetof( playlist_private_t, public_data ) == 0 );
74 p_playlist = &p->public_data;
75 TAB_INIT( pl_priv(p_playlist)->i_sds, pl_priv(p_playlist)->pp_sds );
77 libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
79 VariablesInit( p_playlist );
81 /* Initialise data structures */
82 pl_priv(p_playlist)->i_last_playlist_id = 0;
83 pl_priv(p_playlist)->p_input = NULL;
85 pl_priv(p_playlist)->gc_date = 0;
86 pl_priv(p_playlist)->b_cant_sleep = false;
88 ARRAY_INIT( p_playlist->items );
89 ARRAY_INIT( p_playlist->all_items );
90 ARRAY_INIT( pl_priv(p_playlist)->items_to_delete );
91 ARRAY_INIT( p_playlist->current );
93 p_playlist->i_current_index = 0;
94 pl_priv(p_playlist)->b_reset_currently_playing = true;
95 pl_priv(p_playlist)->last_rebuild_date = 0;
97 pl_priv(p_playlist)->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
99 pl_priv(p_playlist)->b_doing_ml = false;
101 pl_priv(p_playlist)->b_auto_preparse =
102 var_CreateGetBool( p_playlist, "auto-preparse" ) ;
104 PL_LOCK; /* playlist_NodeCreate will check for it */
105 p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
107 p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
108 0, p_playlist->p_root_category->p_input );
111 if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
114 /* Create playlist and media library */
115 PL_LOCK; /* playlist_NodesPairCreate will check for it */
116 playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
117 &p_playlist->p_local_category,
118 &p_playlist->p_local_onelevel, false );
121 p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
122 p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
124 if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
125 !p_playlist->p_local_category->p_input ||
126 !p_playlist->p_local_onelevel->p_input )
129 if( config_GetInt( p_playlist, "media-library") )
131 PL_LOCK; /* playlist_NodesPairCreate will check for it */
132 playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
133 &p_playlist->p_ml_category,
134 &p_playlist->p_ml_onelevel, false );
137 if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
140 p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
141 p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
145 p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
149 pl_priv(p_playlist)->status.p_item = NULL;
150 pl_priv(p_playlist)->status.p_node = p_playlist->p_local_onelevel;
151 pl_priv(p_playlist)->request.b_request = false;
152 pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
154 b_save = pl_priv(p_playlist)->b_auto_preparse;
155 pl_priv(p_playlist)->b_auto_preparse = false;
156 playlist_MLLoad( p_playlist );
157 pl_priv(p_playlist)->b_auto_preparse = true;
159 vlc_object_set_destructor( p_playlist, playlist_Destructor );
167 * Destroy a playlist structure.
168 * \param p_playlist the playlist object
172 static void playlist_Destructor( vlc_object_t * p_this )
174 playlist_t * p_playlist = (playlist_t *)p_this;
176 /* Destroy the item preparser */
177 playlist_preparse_t *p_preparse = &pl_priv(p_playlist)->preparse;
180 vlc_cancel (p_preparse->thread);
181 vlc_join (p_preparse->thread, NULL);
183 while (p_preparse->i_waiting > 0)
184 { /* Any left-over unparsed item? */
185 vlc_gc_decref (p_preparse->pp_waiting[0]);
186 REMOVE_ELEM (p_preparse->pp_waiting, p_preparse->i_waiting, 0);
188 vlc_cond_destroy (&p_preparse->wait);
189 vlc_mutex_destroy (&p_preparse->lock);
191 /* Destroy the item meta-infos fetcher */
192 playlist_fetcher_t *p_fetcher = &pl_priv(p_playlist)->fetcher;
195 vlc_cancel (p_fetcher->thread);
196 vlc_join (p_fetcher->thread, NULL);
198 while (p_fetcher->i_waiting > 0)
199 { /* Any left-over unparsed item? */
200 vlc_gc_decref (p_fetcher->pp_waiting[0]);
201 REMOVE_ELEM (p_fetcher->pp_waiting, p_fetcher->i_waiting, 0);
203 vlc_cond_destroy (&p_fetcher->wait);
204 vlc_mutex_destroy (&p_fetcher->lock);
206 msg_Dbg( p_this, "Destroyed" );
209 /* Destroy remaining objects */
210 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
214 if( mdate() - pl_priv(p_playlist)->gc_date < 1000000 )
216 pl_priv(p_playlist)->b_cant_sleep = true;
219 else if( pl_priv(p_playlist)->gc_date == 0 )
223 pl_priv(p_playlist)->b_cant_sleep = false;
227 static void input_state_changed( const vlc_event_t * event, void * data )
230 playlist_t * p_playlist = data;
231 playlist_Signal( p_playlist );
235 static void input_selected_stream_changed( const vlc_event_t * event, void * data )
238 playlist_t * p_playlist = data;
240 pl_priv(p_playlist)->gc_date = mdate();
241 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;
253 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
255 vlc_event_detach( p_em, vlc_InputStateChanged,
256 input_state_changed, p_playlist );
257 vlc_event_detach( p_em, vlc_InputSelectedStreamChanged,
258 input_selected_stream_changed, p_playlist );
259 pl_priv(p_playlist)->p_input = NULL;
261 /* Release the playlist lock, because we may get stuck
262 * in vlc_object_release() for some time. */
264 vlc_thread_join( p_input );
265 vlc_object_release( p_input );
269 void playlist_set_current_input(
270 playlist_t * p_playlist, input_thread_t * p_input )
274 playlist_release_current_input( p_playlist );
278 vlc_object_hold( p_input );
279 pl_priv(p_playlist)->p_input = p_input;
280 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
281 vlc_event_attach( p_em, vlc_InputStateChanged,
282 input_state_changed, p_playlist );
283 vlc_event_attach( p_em, vlc_InputSelectedStreamChanged,
284 input_selected_stream_changed, p_playlist );
288 /** Get current playing input.
290 input_thread_t * playlist_CurrentInput( playlist_t * p_playlist )
292 input_thread_t * p_input;
294 p_input = pl_priv(p_playlist)->p_input;
295 if( p_input ) vlc_object_hold( p_input );
304 /** Accessor for status item and status nodes.
306 playlist_item_t * get_current_status_item( playlist_t * p_playlist )
310 return pl_priv(p_playlist)->status.p_item;
313 playlist_item_t * get_current_status_node( playlist_t * p_playlist )
317 return pl_priv(p_playlist)->status.p_node;
320 void set_current_status_item( playlist_t * p_playlist,
321 playlist_item_t * p_item )
325 if( pl_priv(p_playlist)->status.p_item &&
326 pl_priv(p_playlist)->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG &&
327 pl_priv(p_playlist)->status.p_item != p_item )
329 /* It's unsafe given current design to delete a playlist item :(
330 playlist_ItemDelete( pl_priv(p_playlist)->status.p_item ); */
332 pl_priv(p_playlist)->status.p_item = p_item;
335 void set_current_status_node( playlist_t * p_playlist,
336 playlist_item_t * p_node )
340 if( pl_priv(p_playlist)->status.p_node &&
341 pl_priv(p_playlist)->status.p_node->i_flags & PLAYLIST_REMOVE_FLAG &&
342 pl_priv(p_playlist)->status.p_node != p_node )
344 /* It's unsafe given current design to delete a playlist item :(
345 playlist_ItemDelete( pl_priv(p_playlist)->status.p_node ); */
347 pl_priv(p_playlist)->status.p_node = p_node;
353 * Main loop for the playlist. It should be entered with the
354 * playlist lock (otherwise input event may be lost)
355 * \param p_playlist the playlist object
358 void playlist_MainLoop( playlist_t *p_playlist )
360 playlist_item_t *p_item = NULL;
361 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
365 if( pl_priv(p_playlist)->b_reset_currently_playing &&
366 mdate() - pl_priv(p_playlist)->last_rebuild_date > 30000 ) // 30 ms
368 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
369 get_current_status_item( p_playlist ) );
370 pl_priv(p_playlist)->last_rebuild_date = mdate();
374 /* If there is an input, check that it doesn't need to die. */
375 if( pl_priv(p_playlist)->p_input )
377 if( pl_priv(p_playlist)->request.b_request && !pl_priv(p_playlist)->p_input->b_die )
379 PL_DEBUG( "incoming request - stopping current input" );
380 input_StopThread( pl_priv(p_playlist)->p_input );
383 /* This input is dead. Remove it ! */
384 if( pl_priv(p_playlist)->p_input->b_dead )
387 input_thread_t *p_input;
388 sout_instance_t **pp_sout = &pl_priv(p_playlist)->p_sout;
390 PL_DEBUG( "dead input" );
392 p_input = pl_priv(p_playlist)->p_input;
394 assert( *pp_sout == NULL );
395 if( var_CreateGetBool( p_input, "sout-keep" ) )
396 *pp_sout = input_DetachSout( p_input );
399 playlist_release_current_input( p_playlist );
401 pl_priv(p_playlist)->gc_date = mdate();
402 pl_priv(p_playlist)->b_cant_sleep = true;
404 i_activity= var_GetInteger( p_playlist, "activity" );
405 var_SetInteger( p_playlist, "activity", i_activity -
406 DEFAULT_INPUT_ACTIVITY );
410 /* This input is dying, let it do */
411 else if( pl_priv(p_playlist)->p_input->b_die )
413 PL_DEBUG( "dying input" );
415 msleep( INTF_IDLE_SLEEP );
419 /* This input has finished, ask it to die ! */
420 else if( pl_priv(p_playlist)->p_input->b_error
421 || pl_priv(p_playlist)->p_input->b_eof )
423 PL_DEBUG( "finished input" );
424 input_StopThread( pl_priv(p_playlist)->p_input );
425 /* No need to wait here, we'll wait in the p_input->b_die case */
428 else if( pl_priv(p_playlist)->p_input->i_state != INIT_S )
430 ObjectGarbageCollector( p_playlist, false );
435 /* No input. Several cases
436 * - No request, running status -> start new item
437 * - No request, stopped status -> collect garbage
438 * - Request, running requested -> start new item
439 * - Request, stopped requested -> collect garbage
441 int i_status = pl_priv(p_playlist)->request.b_request ?
442 pl_priv(p_playlist)->request.i_status : pl_priv(p_playlist)->status.i_status;
443 if( i_status != PLAYLIST_STOPPED )
445 msg_Dbg( p_playlist, "starting new item" );
446 p_item = playlist_NextItem( p_playlist );
450 msg_Dbg( p_playlist, "nothing to play" );
451 pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
453 if( b_playexit == true )
455 msg_Info( p_playlist, "end of playlist, exiting" );
456 vlc_object_kill( p_playlist->p_libvlc );
458 ObjectGarbageCollector( p_playlist, true );
461 playlist_PlayItem( p_playlist, p_item );
462 /* playlist_PlayItem loose input event, we need to recheck */
467 const bool b_gc_forced = pl_priv(p_playlist)->status.i_status != PLAYLIST_STOPPED;
469 pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
471 /* Collect garbage */
472 ObjectGarbageCollector( p_playlist, b_gc_forced );
480 * The playlist is dying so do the last loop
481 * \param p_playlist the playlist object
484 void playlist_LastLoop( playlist_t *p_playlist )
486 /* If there is an input, kill it */
490 if( pl_priv(p_playlist)->p_input == NULL )
496 if( pl_priv(p_playlist)->p_input->b_dead )
499 playlist_release_current_input( p_playlist );
501 /* sout-keep: no need to anything here.
502 * The last input will destroy its sout, if any, by itself */
507 else if( pl_priv(p_playlist)->p_input->b_die )
509 /* This input is dying, leave it alone */
512 else if( pl_priv(p_playlist)->p_input->b_error || pl_priv(p_playlist)->p_input->b_eof )
514 input_StopThread( pl_priv(p_playlist)->p_input );
520 pl_priv(p_playlist)->p_input->b_eof = 1;
524 msleep( INTF_IDLE_SLEEP );
528 /* close the remaining sout-keep (if there was no input atm) */
529 sout_instance_t *p_sout = pl_priv(p_playlist)->p_sout;
531 sout_DeleteInstance( p_sout );
534 /* Core should have terminated all SDs before the playlist */
535 /* TODO: It fails to do so when not playing anything -- Courmisch */
536 playlist_ServicesDiscoveryKillAll( p_playlist );
537 playlist_MLDump( p_playlist );
541 /* Release the current node */
542 set_current_status_node( p_playlist, NULL );
544 /* Release the current item */
545 set_current_status_item( p_playlist, NULL );
547 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
548 free( p_del->pp_children );
549 vlc_gc_decref( p_del->p_input );
552 ARRAY_RESET( p_playlist->all_items );
553 FOREACH_ARRAY( playlist_item_t *p_del, pl_priv(p_playlist)->items_to_delete )
554 free( p_del->pp_children );
555 vlc_gc_decref( p_del->p_input );
558 ARRAY_RESET( pl_priv(p_playlist)->items_to_delete );
560 ARRAY_RESET( p_playlist->items );
561 ARRAY_RESET( p_playlist->current );
567 * Preparse queue loop
569 * @param p_obj preparse structure
572 void *playlist_PreparseLoop( void *data )
574 playlist_preparse_t *p_preparse = data;
575 playlist_t *p_playlist = &((playlist_private_t *)(((char *)p_preparse)
576 - offsetof(playlist_private_t, preparse)))->public_data;
580 input_item_t *p_current;
582 vlc_mutex_lock( &p_preparse->lock );
583 mutex_cleanup_push( &p_preparse->lock );
585 while( p_preparse->i_waiting == 0 )
586 vlc_cond_wait( &p_preparse->wait, &p_preparse->lock );
588 p_current = p_preparse->pp_waiting[0];
589 REMOVE_ELEM( p_preparse->pp_waiting, p_preparse->i_waiting, 0 );
594 int canc = vlc_savecancel ();
596 if( p_current->i_type == ITEM_TYPE_FILE )
598 stats_TimerStart( p_playlist, "Preparse run",
599 STATS_TIMER_PREPARSE );
600 /* Do not preparse if it is already done (like by playing it) */
601 if( !input_item_IsPreparsed( p_current ) )
604 input_Preparse( p_playlist, p_current );
607 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
609 input_item_SetPreparsed( p_current, true );
610 var_SetInteger( p_playlist, "item-change", p_current->i_id );
613 /* If we haven't retrieved enough meta, add to secondary queue
614 * which will run the "meta fetchers".
615 * This only checks for meta, not for art
616 * \todo don't do this for things we won't get meta for, like vids
618 char *psz_arturl = input_item_GetArtURL( p_current );
619 char *psz_name = input_item_GetName( p_current );
620 playlist_fetcher_t *p_fetcher = &pl_priv(p_playlist)->fetcher;
621 if( p_fetcher->i_art_policy == ALBUM_ART_ALL &&
622 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
624 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
625 vlc_mutex_lock( &p_fetcher->lock );
626 INSERT_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting,
627 p_fetcher->i_waiting, p_current);
628 vlc_cond_signal( &p_fetcher->wait );
629 vlc_mutex_unlock( &p_fetcher->lock );
633 PL_DEBUG( "no fetch required for %s (art currently %s)",
634 psz_name, psz_arturl );
635 vlc_gc_decref( p_current );
640 vlc_restorecancel( canc );
643 int i_activity = var_GetInteger( p_playlist, "activity" );
644 if( i_activity < 0 ) i_activity = 0;
645 /* Sleep at least 1ms */
646 msleep( (i_activity+1) * 1000 );
658 void *playlist_FetcherLoop( void *data )
660 playlist_fetcher_t *p_fetcher = data;
661 playlist_t *p_playlist = &((playlist_private_t *)(((char *)p_fetcher)
662 - offsetof(playlist_private_t, fetcher)))->public_data;
666 input_item_t *p_item;
668 vlc_mutex_lock( &p_fetcher->lock );
669 mutex_cleanup_push( &p_fetcher->lock );
671 while( p_fetcher->i_waiting == 0 )
672 vlc_cond_wait( &p_fetcher->wait, &p_fetcher->lock );
674 p_item = p_fetcher->pp_waiting[0];
675 REMOVE_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting, 0 );
678 int canc = vlc_savecancel();
683 /* Check if it is not yet preparsed and if so wait for it
685 * (This can happen if we fetch art on play)
686 * FIXME this doesn't work if we need to fetch meta before art...
688 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
692 b_break = ( !pl_priv(p_playlist)->p_input || input_GetItem(pl_priv(p_playlist)->p_input) != p_item ||
693 pl_priv(p_playlist)->p_input->b_die || pl_priv(p_playlist)->p_input->b_eof || pl_priv(p_playlist)->p_input->b_error );
700 i_ret = input_ArtFind( p_playlist, p_item );
703 PL_DEBUG( "downloading art for %s", p_item->psz_name );
704 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
705 input_item_SetArtNotFound( p_item, true );
707 input_item_SetArtFetched( p_item, true );
708 var_SetInteger( p_playlist, "item-change",
712 else if( i_ret == 0 ) /* Was in cache */
714 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
715 input_item_SetArtFetched( p_item, true );
716 var_SetInteger( p_playlist, "item-change", p_item->i_id );
720 PL_DEBUG( "art not found for %s", p_item->psz_name );
721 input_item_SetArtNotFound( p_item, true );
723 vlc_gc_decref( p_item );
725 vlc_restorecancel( canc );
727 int i_activity = var_GetInteger( p_playlist, "activity" );
728 if( i_activity < 0 ) i_activity = 0;
729 /* Sleep at least 1ms */
730 msleep( (i_activity+1) * 1000 );
737 static void VariablesInit( playlist_t *p_playlist )
740 /* These variables control updates */
741 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
743 var_Set( p_playlist, "intf-change", val );
745 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
747 var_Set( p_playlist, "item-change", val );
749 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
751 var_Set( p_playlist, "item-deleted", val );
753 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
755 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
757 var_Set( p_playlist, "playlist-current", val );
759 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
760 var_SetInteger( p_playlist, "activity", 0 );
762 /* Variables to control playback */
763 var_CreateGetBool( p_playlist, "play-and-stop" );
764 var_CreateGetBool( p_playlist, "play-and-exit" );
765 var_CreateGetBool( p_playlist, "random" );
766 var_CreateGetBool( p_playlist, "repeat" );
767 var_CreateGetBool( p_playlist, "loop" );
769 var_AddCallback( p_playlist, "random", RandomCallback, NULL );
772 int playlist_CurrentId( playlist_t * p_playlist )
774 return pl_priv(p_playlist)->status.p_item->i_id;
777 bool playlist_IsPlaying( playlist_t * p_playlist )
779 return ( pl_priv(p_playlist)->status.i_status == PLAYLIST_RUNNING &&
780 !(pl_priv(p_playlist)->request.b_request && pl_priv(p_playlist)->request.i_status == PLAYLIST_STOPPED) );
783 playlist_item_t * playlist_CurrentPlayingItem( playlist_t * p_playlist )
785 return pl_priv(p_playlist)->status.p_item;
788 int playlist_Status( playlist_t * p_playlist )
790 return pl_priv(p_playlist)->status.i_status;