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 int InputEvent( vlc_object_t *p_this, char const *psz_cmd,
228 vlc_value_t oldval, vlc_value_t newval, void *p_data )
230 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
231 playlist_t *p_playlist = p_data;
233 if( newval.i_int == INPUT_EVENT_STATE )
235 playlist_Signal( p_playlist );
237 else if( newval.i_int == INPUT_EVENT_ES )
240 pl_priv(p_playlist)->gc_date = mdate();
241 vlc_object_signal_unlocked( p_playlist );
248 void playlist_release_current_input( playlist_t * p_playlist )
252 if( !pl_priv(p_playlist)->p_input ) return;
254 input_thread_t * p_input = pl_priv(p_playlist)->p_input;
256 var_DelCallback( p_input, "intf-event", InputEvent, p_playlist );
257 pl_priv(p_playlist)->p_input = NULL;
259 /* Release the playlist lock, because we may get stuck
260 * in vlc_object_release() for some time. */
262 vlc_thread_join( p_input );
263 vlc_object_release( p_input );
267 void playlist_set_current_input(
268 playlist_t * p_playlist, input_thread_t * p_input )
272 playlist_release_current_input( p_playlist );
276 vlc_object_hold( p_input );
277 pl_priv(p_playlist)->p_input = p_input;
279 var_AddCallback( p_input, "intf-event", InputEvent, p_playlist );
283 /** Get current playing input.
285 input_thread_t * playlist_CurrentInput( playlist_t * p_playlist )
287 input_thread_t * p_input;
289 p_input = pl_priv(p_playlist)->p_input;
290 if( p_input ) vlc_object_hold( p_input );
299 /** Accessor for status item and status nodes.
301 playlist_item_t * get_current_status_item( playlist_t * p_playlist )
305 return pl_priv(p_playlist)->status.p_item;
308 playlist_item_t * get_current_status_node( playlist_t * p_playlist )
312 return pl_priv(p_playlist)->status.p_node;
315 void set_current_status_item( playlist_t * p_playlist,
316 playlist_item_t * p_item )
320 if( pl_priv(p_playlist)->status.p_item &&
321 pl_priv(p_playlist)->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG &&
322 pl_priv(p_playlist)->status.p_item != p_item )
324 /* It's unsafe given current design to delete a playlist item :(
325 playlist_ItemDelete( pl_priv(p_playlist)->status.p_item ); */
327 pl_priv(p_playlist)->status.p_item = p_item;
330 void set_current_status_node( playlist_t * p_playlist,
331 playlist_item_t * p_node )
335 if( pl_priv(p_playlist)->status.p_node &&
336 pl_priv(p_playlist)->status.p_node->i_flags & PLAYLIST_REMOVE_FLAG &&
337 pl_priv(p_playlist)->status.p_node != p_node )
339 /* It's unsafe given current design to delete a playlist item :(
340 playlist_ItemDelete( pl_priv(p_playlist)->status.p_node ); */
342 pl_priv(p_playlist)->status.p_node = p_node;
348 * Main loop for the playlist. It should be entered with the
349 * playlist lock (otherwise input event may be lost)
350 * \param p_playlist the playlist object
353 void playlist_MainLoop( playlist_t *p_playlist )
355 playlist_item_t *p_item = NULL;
356 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
360 if( pl_priv(p_playlist)->b_reset_currently_playing &&
361 mdate() - pl_priv(p_playlist)->last_rebuild_date > 30000 ) // 30 ms
363 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
364 get_current_status_item( p_playlist ) );
365 pl_priv(p_playlist)->last_rebuild_date = mdate();
369 /* If there is an input, check that it doesn't need to die. */
370 if( pl_priv(p_playlist)->p_input )
372 if( pl_priv(p_playlist)->request.b_request && !pl_priv(p_playlist)->p_input->b_die )
374 PL_DEBUG( "incoming request - stopping current input" );
375 input_StopThread( pl_priv(p_playlist)->p_input );
378 /* This input is dead. Remove it ! */
379 if( pl_priv(p_playlist)->p_input->b_dead )
382 input_thread_t *p_input;
383 sout_instance_t **pp_sout = &pl_priv(p_playlist)->p_sout;
385 PL_DEBUG( "dead input" );
387 p_input = pl_priv(p_playlist)->p_input;
389 assert( *pp_sout == NULL );
390 if( var_CreateGetBool( p_input, "sout-keep" ) )
391 *pp_sout = input_DetachSout( p_input );
394 playlist_release_current_input( p_playlist );
396 pl_priv(p_playlist)->gc_date = mdate();
397 pl_priv(p_playlist)->b_cant_sleep = true;
399 i_activity= var_GetInteger( p_playlist, "activity" );
400 var_SetInteger( p_playlist, "activity", i_activity -
401 DEFAULT_INPUT_ACTIVITY );
405 /* This input is dying, let it do */
406 else if( pl_priv(p_playlist)->p_input->b_die )
408 PL_DEBUG( "dying input" );
410 msleep( INTF_IDLE_SLEEP );
414 /* This input has finished, ask it to die ! */
415 else if( pl_priv(p_playlist)->p_input->b_error
416 || pl_priv(p_playlist)->p_input->b_eof )
418 PL_DEBUG( "finished input" );
419 input_StopThread( pl_priv(p_playlist)->p_input );
420 /* No need to wait here, we'll wait in the p_input->b_die case */
423 else if( pl_priv(p_playlist)->p_input->i_state != INIT_S )
425 ObjectGarbageCollector( p_playlist, false );
430 /* No input. Several cases
431 * - No request, running status -> start new item
432 * - No request, stopped status -> collect garbage
433 * - Request, running requested -> start new item
434 * - Request, stopped requested -> collect garbage
436 int i_status = pl_priv(p_playlist)->request.b_request ?
437 pl_priv(p_playlist)->request.i_status : pl_priv(p_playlist)->status.i_status;
438 if( i_status != PLAYLIST_STOPPED )
440 msg_Dbg( p_playlist, "starting new item" );
441 p_item = playlist_NextItem( p_playlist );
445 msg_Dbg( p_playlist, "nothing to play" );
446 pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
448 if( b_playexit == true )
450 msg_Info( p_playlist, "end of playlist, exiting" );
451 vlc_object_kill( p_playlist->p_libvlc );
453 ObjectGarbageCollector( p_playlist, true );
456 playlist_PlayItem( p_playlist, p_item );
457 /* playlist_PlayItem loose input event, we need to recheck */
462 const bool b_gc_forced = pl_priv(p_playlist)->status.i_status != PLAYLIST_STOPPED;
464 pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
466 /* Collect garbage */
467 ObjectGarbageCollector( p_playlist, b_gc_forced );
475 * The playlist is dying so do the last loop
476 * \param p_playlist the playlist object
479 void playlist_LastLoop( playlist_t *p_playlist )
481 /* If there is an input, kill it */
485 if( pl_priv(p_playlist)->p_input == NULL )
491 if( pl_priv(p_playlist)->p_input->b_dead )
494 playlist_release_current_input( p_playlist );
496 /* sout-keep: no need to anything here.
497 * The last input will destroy its sout, if any, by itself */
502 else if( pl_priv(p_playlist)->p_input->b_die )
504 /* This input is dying, leave it alone */
507 else if( pl_priv(p_playlist)->p_input->b_error || pl_priv(p_playlist)->p_input->b_eof )
509 input_StopThread( pl_priv(p_playlist)->p_input );
515 pl_priv(p_playlist)->p_input->b_eof = 1;
519 msleep( INTF_IDLE_SLEEP );
523 /* close the remaining sout-keep (if there was no input atm) */
524 sout_instance_t *p_sout = pl_priv(p_playlist)->p_sout;
526 sout_DeleteInstance( p_sout );
529 /* Core should have terminated all SDs before the playlist */
530 /* TODO: It fails to do so when not playing anything -- Courmisch */
531 playlist_ServicesDiscoveryKillAll( p_playlist );
532 playlist_MLDump( p_playlist );
536 /* Release the current node */
537 set_current_status_node( p_playlist, NULL );
539 /* Release the current item */
540 set_current_status_item( p_playlist, NULL );
542 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
543 free( p_del->pp_children );
544 vlc_gc_decref( p_del->p_input );
547 ARRAY_RESET( p_playlist->all_items );
548 FOREACH_ARRAY( playlist_item_t *p_del, pl_priv(p_playlist)->items_to_delete )
549 free( p_del->pp_children );
550 vlc_gc_decref( p_del->p_input );
553 ARRAY_RESET( pl_priv(p_playlist)->items_to_delete );
555 ARRAY_RESET( p_playlist->items );
556 ARRAY_RESET( p_playlist->current );
562 * Preparse queue loop
564 * @param p_obj preparse structure
567 void *playlist_PreparseLoop( void *data )
569 playlist_preparse_t *p_preparse = data;
570 playlist_t *p_playlist = &((playlist_private_t *)(((char *)p_preparse)
571 - offsetof(playlist_private_t, preparse)))->public_data;
575 input_item_t *p_current;
577 vlc_mutex_lock( &p_preparse->lock );
578 mutex_cleanup_push( &p_preparse->lock );
580 while( p_preparse->i_waiting == 0 )
581 vlc_cond_wait( &p_preparse->wait, &p_preparse->lock );
583 p_current = p_preparse->pp_waiting[0];
584 REMOVE_ELEM( p_preparse->pp_waiting, p_preparse->i_waiting, 0 );
589 int canc = vlc_savecancel ();
591 if( p_current->i_type == ITEM_TYPE_FILE )
593 stats_TimerStart( p_playlist, "Preparse run",
594 STATS_TIMER_PREPARSE );
595 /* Do not preparse if it is already done (like by playing it) */
596 if( !input_item_IsPreparsed( p_current ) )
599 input_Preparse( p_playlist, p_current );
602 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
604 input_item_SetPreparsed( p_current, true );
605 var_SetInteger( p_playlist, "item-change", p_current->i_id );
608 /* If we haven't retrieved enough meta, add to secondary queue
609 * which will run the "meta fetchers".
610 * This only checks for meta, not for art
611 * \todo don't do this for things we won't get meta for, like vids
613 char *psz_arturl = input_item_GetArtURL( p_current );
614 char *psz_name = input_item_GetName( p_current );
615 playlist_fetcher_t *p_fetcher = &pl_priv(p_playlist)->fetcher;
616 if( p_fetcher->i_art_policy == ALBUM_ART_ALL &&
617 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
619 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
620 vlc_mutex_lock( &p_fetcher->lock );
621 INSERT_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting,
622 p_fetcher->i_waiting, p_current);
623 vlc_cond_signal( &p_fetcher->wait );
624 vlc_mutex_unlock( &p_fetcher->lock );
628 PL_DEBUG( "no fetch required for %s (art currently %s)",
629 psz_name, psz_arturl );
630 vlc_gc_decref( p_current );
635 vlc_restorecancel( canc );
638 int i_activity = var_GetInteger( p_playlist, "activity" );
639 if( i_activity < 0 ) i_activity = 0;
640 /* Sleep at least 1ms */
641 msleep( (i_activity+1) * 1000 );
653 void *playlist_FetcherLoop( void *data )
655 playlist_fetcher_t *p_fetcher = data;
656 playlist_t *p_playlist = &((playlist_private_t *)(((char *)p_fetcher)
657 - offsetof(playlist_private_t, fetcher)))->public_data;
661 input_item_t *p_item;
663 vlc_mutex_lock( &p_fetcher->lock );
664 mutex_cleanup_push( &p_fetcher->lock );
666 while( p_fetcher->i_waiting == 0 )
667 vlc_cond_wait( &p_fetcher->wait, &p_fetcher->lock );
669 p_item = p_fetcher->pp_waiting[0];
670 REMOVE_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting, 0 );
673 int canc = vlc_savecancel();
678 /* Check if it is not yet preparsed and if so wait for it
680 * (This can happen if we fetch art on play)
681 * FIXME this doesn't work if we need to fetch meta before art...
683 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
687 b_break = ( !pl_priv(p_playlist)->p_input || input_GetItem(pl_priv(p_playlist)->p_input) != p_item ||
688 pl_priv(p_playlist)->p_input->b_die || pl_priv(p_playlist)->p_input->b_eof || pl_priv(p_playlist)->p_input->b_error );
695 i_ret = input_ArtFind( p_playlist, p_item );
698 PL_DEBUG( "downloading art for %s", p_item->psz_name );
699 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
700 input_item_SetArtNotFound( p_item, true );
702 input_item_SetArtFetched( p_item, true );
703 var_SetInteger( p_playlist, "item-change",
707 else if( i_ret == 0 ) /* Was in cache */
709 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
710 input_item_SetArtFetched( p_item, true );
711 var_SetInteger( p_playlist, "item-change", p_item->i_id );
715 PL_DEBUG( "art not found for %s", p_item->psz_name );
716 input_item_SetArtNotFound( p_item, true );
718 vlc_gc_decref( p_item );
720 vlc_restorecancel( canc );
722 int i_activity = var_GetInteger( p_playlist, "activity" );
723 if( i_activity < 0 ) i_activity = 0;
724 /* Sleep at least 1ms */
725 msleep( (i_activity+1) * 1000 );
732 static void VariablesInit( playlist_t *p_playlist )
735 /* These variables control updates */
736 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
738 var_Set( p_playlist, "intf-change", val );
740 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
742 var_Set( p_playlist, "item-change", val );
744 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
746 var_Set( p_playlist, "item-deleted", val );
748 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
750 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
752 var_Set( p_playlist, "playlist-current", val );
754 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
755 var_SetInteger( p_playlist, "activity", 0 );
757 /* Variables to control playback */
758 var_Create( p_playlist, "play-and-stop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
759 var_Create( p_playlist, "play-and-exit", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
760 var_Create( p_playlist, "random", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
761 var_Create( p_playlist, "repeat", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
762 var_Create( p_playlist, "loop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
764 var_AddCallback( p_playlist, "random", RandomCallback, NULL );
767 int playlist_CurrentId( playlist_t * p_playlist )
769 return pl_priv(p_playlist)->status.p_item->i_id;
772 bool playlist_IsPlaying( playlist_t * p_playlist )
774 return ( pl_priv(p_playlist)->status.i_status == PLAYLIST_RUNNING &&
775 !(pl_priv(p_playlist)->request.b_request && pl_priv(p_playlist)->request.i_status == PLAYLIST_STOPPED) );
778 playlist_item_t * playlist_CurrentPlayingItem( playlist_t * p_playlist )
780 return pl_priv(p_playlist)->status.p_item;
783 int playlist_Status( playlist_t * p_playlist )
785 return pl_priv(p_playlist)->status.i_status;