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 *****************************************************************************/
29 #include <vlc_common.h>
31 #include <vlc_playlist.h>
32 #include <vlc_interface.h>
33 #include "playlist_internal.h"
34 #include "stream_output/stream_output.h" /* sout_DeleteInstance */
36 /*****************************************************************************
38 *****************************************************************************/
39 static void VariablesInit( playlist_t *p_playlist );
40 static void playlist_Destructor( vlc_object_t * p_this );
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_GENERIC, playlist_name );
72 TAB_INIT( p_playlist->i_sds, p_playlist->pp_sds );
74 libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
76 VariablesInit( p_playlist );
78 /* Initialise data structures */
79 p_playlist->i_last_playlist_id = 0;
80 p_playlist->p_input = NULL;
82 p_playlist->gc_date = 0;
83 p_playlist->b_cant_sleep = false;
85 ARRAY_INIT( p_playlist->items );
86 ARRAY_INIT( p_playlist->all_items );
87 ARRAY_INIT( p_playlist->items_to_delete );
88 ARRAY_INIT( p_playlist->current );
90 p_playlist->i_current_index = 0;
91 p_playlist->b_reset_currently_playing = true;
92 p_playlist->last_rebuild_date = 0;
94 p_playlist->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
96 p_playlist->b_doing_ml = false;
98 p_playlist->b_auto_preparse =
99 var_CreateGetBool( p_playlist, "auto-preparse" ) ;
101 PL_LOCK; /* playlist_NodeCreate will check for it */
102 p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
104 p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
105 0, p_playlist->p_root_category->p_input );
108 if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
111 /* Create playlist and media library */
112 PL_LOCK; /* playlist_NodesPairCreate will check for it */
113 playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
114 &p_playlist->p_local_category,
115 &p_playlist->p_local_onelevel, false );
118 p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
119 p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
121 if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
122 !p_playlist->p_local_category->p_input ||
123 !p_playlist->p_local_onelevel->p_input )
126 if( config_GetInt( p_playlist, "media-library") )
128 PL_LOCK; /* playlist_NodesPairCreate will check for it */
129 playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
130 &p_playlist->p_ml_category,
131 &p_playlist->p_ml_onelevel, false );
134 if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
137 p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
138 p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
142 p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
146 p_playlist->status.p_item = NULL;
147 p_playlist->status.p_node = p_playlist->p_local_onelevel;
148 p_playlist->request.b_request = false;
149 p_playlist->status.i_status = PLAYLIST_STOPPED;
151 p_playlist->i_sort = SORT_ID;
152 p_playlist->i_order = ORDER_NORMAL;
155 b_save = p_playlist->b_auto_preparse;
156 p_playlist->b_auto_preparse = false;
157 playlist_MLLoad( p_playlist );
158 p_playlist->b_auto_preparse = true;
160 vlc_object_set_destructor( p_playlist, playlist_Destructor );
168 * Destroy a playlist structure.
169 * \param p_playlist the playlist object
173 static void playlist_Destructor( vlc_object_t * p_this )
175 playlist_t * p_playlist = (playlist_t *)p_this;
177 if( p_playlist->p->p_preparse )
179 vlc_object_release( p_playlist->p->p_preparse );
182 if( p_playlist->p->p_fetcher )
184 vlc_object_release( p_playlist->p->p_fetcher );
186 msg_Dbg( p_this, "Destroyed" );
189 /* Destroy remaining objects */
190 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
194 if( mdate() - p_playlist->gc_date < 1000000 )
196 p_playlist->b_cant_sleep = true;
199 else if( p_playlist->gc_date == 0 )
203 p_playlist->b_cant_sleep = false;
207 static void input_state_changed( const vlc_event_t * event, void * data )
210 playlist_t * p_playlist = data;
211 playlist_Signal( p_playlist );
215 static void input_selected_stream_changed( const vlc_event_t * event, void * data )
218 playlist_t * p_playlist = data;
220 p_playlist->gc_date = mdate();
221 vlc_object_signal_unlocked( p_playlist );
226 void playlist_release_current_input( playlist_t * p_playlist )
230 if( !p_playlist->p_input ) return;
232 input_thread_t * p_input = p_playlist->p_input;
233 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
235 vlc_event_detach( p_em, vlc_InputStateChanged,
236 input_state_changed, p_playlist );
237 vlc_event_detach( p_em, vlc_InputSelectedStreamChanged,
238 input_selected_stream_changed, p_playlist );
239 p_playlist->p_input = NULL;
241 /* Release the playlist lock, because we may get stuck
242 * in vlc_object_release() for some time. */
244 vlc_thread_join( p_input );
245 vlc_object_release( p_input );
249 void playlist_set_current_input(
250 playlist_t * p_playlist, input_thread_t * p_input )
254 playlist_release_current_input( p_playlist );
258 vlc_object_yield( p_input );
259 p_playlist->p_input = p_input;
260 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
261 vlc_event_attach( p_em, vlc_InputStateChanged,
262 input_state_changed, p_playlist );
263 vlc_event_attach( p_em, vlc_InputSelectedStreamChanged,
264 input_selected_stream_changed, p_playlist );
268 /** Get current playing input.
270 input_thread_t * playlist_CurrentInput( playlist_t * p_playlist )
272 input_thread_t * p_input;
274 p_input = p_playlist->p_input;
275 if( p_input ) vlc_object_yield( p_input );
284 /** Accessor for status item and status nodes.
286 playlist_item_t * get_current_status_item( playlist_t * p_playlist )
290 return p_playlist->status.p_item;
293 playlist_item_t * get_current_status_node( playlist_t * p_playlist )
297 return p_playlist->status.p_node;
300 void set_current_status_item( playlist_t * p_playlist,
301 playlist_item_t * p_item )
305 if( p_playlist->status.p_item &&
306 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG &&
307 p_playlist->status.p_item != p_item )
309 /* It's unsafe given current design to delete a playlist item :(
310 playlist_ItemDelete( p_playlist->status.p_item ); */
312 p_playlist->status.p_item = p_item;
315 void set_current_status_node( playlist_t * p_playlist,
316 playlist_item_t * p_node )
320 if( p_playlist->status.p_node &&
321 p_playlist->status.p_node->i_flags & PLAYLIST_REMOVE_FLAG &&
322 p_playlist->status.p_node != p_node )
324 /* It's unsafe given current design to delete a playlist item :(
325 playlist_ItemDelete( p_playlist->status.p_node ); */
327 p_playlist->status.p_node = p_node;
333 * Main loop for the playlist. It should be entered with the
334 * playlist lock (otherwise input event may be lost)
335 * \param p_playlist the playlist object
338 void playlist_MainLoop( playlist_t *p_playlist )
340 playlist_item_t *p_item = NULL;
341 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
345 if( p_playlist->b_reset_currently_playing &&
346 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
348 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
349 get_current_status_item( p_playlist ) );
350 p_playlist->last_rebuild_date = mdate();
354 /* If there is an input, check that it doesn't need to die. */
355 if( p_playlist->p_input )
357 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
359 PL_DEBUG( "incoming request - stopping current input" );
360 input_StopThread( p_playlist->p_input );
363 /* This input is dead. Remove it ! */
364 if( p_playlist->p_input->b_dead )
367 input_thread_t *p_input;
368 sout_instance_t **pp_sout = &p_playlist->p->p_sout;
370 PL_DEBUG( "dead input" );
372 p_input = p_playlist->p_input;
374 assert( *pp_sout == NULL );
375 if( var_CreateGetBool( p_input, "sout-keep" ) )
376 *pp_sout = input_DetachSout( p_input );
379 playlist_release_current_input( p_playlist );
381 p_playlist->gc_date = mdate();
382 p_playlist->b_cant_sleep = true;
384 i_activity= var_GetInteger( p_playlist, "activity" );
385 var_SetInteger( p_playlist, "activity", i_activity -
386 DEFAULT_INPUT_ACTIVITY );
390 /* This input is dying, let it do */
391 else if( p_playlist->p_input->b_die )
393 PL_DEBUG( "dying input" );
395 msleep( INTF_IDLE_SLEEP );
399 /* This input has finished, ask it to die ! */
400 else if( p_playlist->p_input->b_error
401 || p_playlist->p_input->b_eof )
403 PL_DEBUG( "finished input" );
404 input_StopThread( p_playlist->p_input );
405 /* No need to wait here, we'll wait in the p_input->b_die case */
408 else if( p_playlist->p_input->i_state != INIT_S )
410 ObjectGarbageCollector( p_playlist, false );
415 /* No input. Several cases
416 * - No request, running status -> start new item
417 * - No request, stopped status -> collect garbage
418 * - Request, running requested -> start new item
419 * - Request, stopped requested -> collect garbage
421 int i_status = p_playlist->request.b_request ?
422 p_playlist->request.i_status : p_playlist->status.i_status;
423 if( i_status != PLAYLIST_STOPPED )
425 msg_Dbg( p_playlist, "starting new item" );
426 p_item = playlist_NextItem( p_playlist );
430 msg_Dbg( p_playlist, "nothing to play" );
431 p_playlist->status.i_status = PLAYLIST_STOPPED;
433 if( b_playexit == true )
435 msg_Info( p_playlist, "end of playlist, exiting" );
436 vlc_object_kill( p_playlist->p_libvlc );
438 ObjectGarbageCollector( p_playlist, true );
441 playlist_PlayItem( p_playlist, p_item );
442 /* playlist_PlayItem loose input event, we need to recheck */
447 const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
449 p_playlist->status.i_status = PLAYLIST_STOPPED;
451 /* Collect garbage */
452 ObjectGarbageCollector( p_playlist, b_gc_forced );
460 * The playlist is dying so do the last loop
461 * \param p_playlist the playlist object
464 void playlist_LastLoop( playlist_t *p_playlist )
466 /* If there is an input, kill it */
470 if( p_playlist->p_input == NULL )
476 if( p_playlist->p_input->b_dead )
479 playlist_release_current_input( p_playlist );
481 /* sout-keep: no need to anything here.
482 * The last input will destroy its sout, if any, by itself */
487 else if( p_playlist->p_input->b_die )
489 /* This input is dying, leave it alone */
492 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
494 input_StopThread( p_playlist->p_input );
500 p_playlist->p_input->b_eof = 1;
504 msleep( INTF_IDLE_SLEEP );
508 /* close the remaining sout-keep (if there was no input atm) */
509 sout_instance_t *p_sout = p_playlist->p->p_sout;
511 sout_DeleteInstance( p_sout );
514 /* Core should have terminated all SDs before the playlist */
515 /* TODO: It fails to do so when not playing anything -- Courmisch */
516 playlist_ServicesDiscoveryKillAll( p_playlist );
517 playlist_MLDump( p_playlist );
519 vlc_object_kill( p_playlist->p->p_preparse );
520 vlc_thread_join( p_playlist->p->p_preparse );
521 vlc_object_kill( p_playlist->p->p_fetcher );
522 vlc_thread_join( p_playlist->p->p_fetcher );
526 /* Release the current node */
527 set_current_status_node( p_playlist, NULL );
529 /* Release the current item */
530 set_current_status_item( p_playlist, NULL );
532 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
533 free( p_del->pp_children );
534 vlc_gc_decref( p_del->p_input );
537 ARRAY_RESET( p_playlist->all_items );
538 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->items_to_delete )
539 free( p_del->pp_children );
540 vlc_gc_decref( p_del->p_input );
543 ARRAY_RESET( p_playlist->items_to_delete );
545 ARRAY_RESET( p_playlist->items );
546 ARRAY_RESET( p_playlist->current );
554 * Main loop for preparser queue
555 * \param p_obj items to preparse
558 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
560 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
561 input_item_t *p_current;
564 vlc_object_lock( p_obj );
566 while( vlc_object_alive( p_obj ) )
568 if( p_obj->i_waiting == 0 )
570 vlc_object_wait( p_obj );
574 p_current = p_obj->pp_waiting[0];
575 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
576 vlc_object_unlock( p_obj );
581 if( p_current->i_type == ITEM_TYPE_FILE )
583 stats_TimerStart( p_playlist, "Preparse run",
584 STATS_TIMER_PREPARSE );
585 /* Do not preparse if it is already done (like by playing it) */
586 if( !input_item_IsPreparsed( p_current ) )
589 input_Preparse( p_playlist, p_current );
592 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
594 input_item_SetPreparsed( p_current, true );
595 var_SetInteger( p_playlist, "item-change", p_current->i_id );
598 /* If we haven't retrieved enough meta, add to secondary queue
599 * which will run the "meta fetchers".
600 * This only checks for meta, not for art
601 * \todo don't do this for things we won't get meta for, like vids
603 char *psz_arturl = input_item_GetArtURL( p_current );
604 char *psz_name = input_item_GetName( p_current );
605 if( p_playlist->p->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
606 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
608 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
609 vlc_object_lock( p_playlist->p->p_fetcher );
610 if( vlc_object_alive( p_playlist->p->p_fetcher ) )
612 INSERT_ELEM( p_playlist->p->p_fetcher->pp_waiting,
613 p_playlist->p->p_fetcher->i_waiting,
614 p_playlist->p->p_fetcher->i_waiting, p_current);
615 vlc_object_signal_unlocked( p_playlist->p->p_fetcher );
618 vlc_gc_decref( p_current );
619 vlc_object_unlock( p_playlist->p->p_fetcher );
623 PL_DEBUG( "no fetch required for %s (art currently %s)",
624 psz_name, psz_arturl );
625 vlc_gc_decref( p_current );
634 vlc_object_lock( p_obj );
635 i_activity = var_GetInteger( p_playlist, "activity" );
636 if( i_activity < 0 ) i_activity = 0;
637 vlc_object_unlock( p_obj );
638 /* Sleep at least 1ms */
639 msleep( (i_activity+1) * 1000 );
640 vlc_object_lock( p_obj );
643 while( p_obj->i_waiting > 0 )
645 vlc_gc_decref( p_obj->pp_waiting[0] );
646 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
649 vlc_object_unlock( p_obj );
655 * Main loop for secondary preparser queue
656 * \param p_obj items to preparse
659 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
661 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
662 input_item_t *p_item;
665 vlc_object_lock( p_obj );
667 while( vlc_object_alive( p_obj ) )
669 if( p_obj->i_waiting == 0 )
671 vlc_object_wait( p_obj );
675 p_item = p_obj->pp_waiting[0];
676 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
677 vlc_object_unlock( p_obj );
682 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
683 * (This can happen if we fetch art on play)
684 * FIXME this doesn't work if we need to fetch meta before art ... */
685 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
689 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
690 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
697 i_ret = input_ArtFind( p_playlist, p_item );
700 PL_DEBUG( "downloading art for %s", p_item->psz_name );
701 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
702 input_item_SetArtNotFound( p_item, true );
704 input_item_SetArtFetched( p_item, true );
705 var_SetInteger( p_playlist, "item-change",
709 else if( i_ret == 0 ) /* Was in cache */
711 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
712 input_item_SetArtFetched( p_item, true );
713 var_SetInteger( p_playlist, "item-change", p_item->i_id );
717 PL_DEBUG( "art not found for %s", p_item->psz_name );
718 input_item_SetArtNotFound( p_item, true );
720 vlc_gc_decref( p_item );
722 vlc_object_lock( p_obj );
723 i_activity = var_GetInteger( p_playlist, "activity" );
724 if( i_activity < 0 ) i_activity = 0;
725 vlc_object_unlock( p_obj );
726 /* Sleep at least 1ms */
727 msleep( (i_activity+1) * 1000 );
728 vlc_object_lock( p_obj );
731 while( p_obj->i_waiting > 0 )
733 vlc_gc_decref( p_obj->pp_waiting[0] );
734 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
737 vlc_object_unlock( p_obj );
740 static void VariablesInit( playlist_t *p_playlist )
743 /* These variables control updates */
744 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
746 var_Set( p_playlist, "intf-change", val );
748 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
750 var_Set( p_playlist, "item-change", val );
752 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
754 var_Set( p_playlist, "item-deleted", val );
756 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
758 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
760 var_Set( p_playlist, "playlist-current", val );
762 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
763 var_SetInteger( p_playlist, "activity", 0 );
765 /* Variables to control playback */
766 var_CreateGetBool( p_playlist, "play-and-stop" );
767 var_CreateGetBool( p_playlist, "play-and-exit" );
768 var_CreateGetBool( p_playlist, "random" );
769 var_CreateGetBool( p_playlist, "repeat" );
770 var_CreateGetBool( p_playlist, "loop" );
772 var_AddCallback( p_playlist, "random", RandomCallback, NULL );