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 );
73 MALLOC_NULL( p_playlist->p, playlist_private_t );
74 memset( p_playlist->p, 0, sizeof( playlist_private_t ) );
76 libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
78 VariablesInit( p_playlist );
80 /* Initialise data structures */
81 p_playlist->i_last_playlist_id = 0;
82 p_playlist->p_input = NULL;
84 p_playlist->gc_date = 0;
85 p_playlist->b_cant_sleep = false;
87 ARRAY_INIT( p_playlist->items );
88 ARRAY_INIT( p_playlist->all_items );
89 ARRAY_INIT( p_playlist->items_to_delete );
90 ARRAY_INIT( p_playlist->current );
92 p_playlist->i_current_index = 0;
93 p_playlist->b_reset_currently_playing = true;
94 p_playlist->last_rebuild_date = 0;
96 p_playlist->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
98 p_playlist->b_doing_ml = false;
100 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 p_playlist->status.p_item = NULL;
149 p_playlist->status.p_node = p_playlist->p_local_onelevel;
150 p_playlist->request.b_request = false;
151 p_playlist->status.i_status = PLAYLIST_STOPPED;
153 p_playlist->i_sort = SORT_ID;
154 p_playlist->i_order = ORDER_NORMAL;
157 b_save = p_playlist->b_auto_preparse;
158 p_playlist->b_auto_preparse = false;
159 playlist_MLLoad( p_playlist );
160 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 if( p_playlist->p->p_preparse )
181 vlc_object_release( p_playlist->p->p_preparse );
184 if( p_playlist->p->p_fetcher )
186 vlc_object_release( p_playlist->p->p_fetcher );
188 msg_Dbg( p_this, "Destroyed" );
191 /* Destroy remaining objects */
192 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
196 if( mdate() - p_playlist->gc_date < 1000000 )
198 p_playlist->b_cant_sleep = true;
201 else if( p_playlist->gc_date == 0 )
205 p_playlist->b_cant_sleep = false;
209 static void input_state_changed( const vlc_event_t * event, void * data )
212 playlist_t * p_playlist = data;
213 playlist_Signal( p_playlist );
217 static void input_selected_stream_changed( const vlc_event_t * event, void * data )
220 playlist_t * p_playlist = data;
222 p_playlist->gc_date = mdate();
223 vlc_object_signal_unlocked( p_playlist );
228 void playlist_release_current_input( playlist_t * p_playlist )
232 if( !p_playlist->p_input ) return;
234 input_thread_t * p_input = p_playlist->p_input;
235 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
237 vlc_event_detach( p_em, vlc_InputStateChanged,
238 input_state_changed, p_playlist );
239 vlc_event_detach( p_em, vlc_InputSelectedStreamChanged,
240 input_selected_stream_changed, p_playlist );
241 p_playlist->p_input = NULL;
243 /* Release the playlist lock, because we may get stuck
244 * in vlc_object_release() for some time. */
246 vlc_thread_join( p_input );
247 vlc_object_release( p_input );
251 void playlist_set_current_input(
252 playlist_t * p_playlist, input_thread_t * p_input )
256 playlist_release_current_input( p_playlist );
260 vlc_object_yield( p_input );
261 p_playlist->p_input = p_input;
262 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
263 vlc_event_attach( p_em, vlc_InputStateChanged,
264 input_state_changed, p_playlist );
265 vlc_event_attach( p_em, vlc_InputSelectedStreamChanged,
266 input_selected_stream_changed, p_playlist );
270 /** Get current playing input.
272 input_thread_t * playlist_CurrentInput( playlist_t * p_playlist )
274 input_thread_t * p_input;
276 p_input = p_playlist->p_input;
277 if( p_input ) vlc_object_yield( p_input );
286 /** Accessor for status item and status nodes.
288 playlist_item_t * get_current_status_item( playlist_t * p_playlist )
292 return p_playlist->status.p_item;
295 playlist_item_t * get_current_status_node( playlist_t * p_playlist )
299 return p_playlist->status.p_node;
302 void set_current_status_item( playlist_t * p_playlist,
303 playlist_item_t * p_item )
307 if( p_playlist->status.p_item &&
308 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG &&
309 p_playlist->status.p_item != p_item )
311 /* It's unsafe given current design to delete a playlist item :(
312 playlist_ItemDelete( p_playlist->status.p_item ); */
314 p_playlist->status.p_item = p_item;
317 void set_current_status_node( playlist_t * p_playlist,
318 playlist_item_t * p_node )
322 if( p_playlist->status.p_node &&
323 p_playlist->status.p_node->i_flags & PLAYLIST_REMOVE_FLAG &&
324 p_playlist->status.p_node != p_node )
326 /* It's unsafe given current design to delete a playlist item :(
327 playlist_ItemDelete( p_playlist->status.p_node ); */
329 p_playlist->status.p_node = p_node;
335 * Main loop for the playlist. It should be entered with the
336 * playlist lock (otherwise input event may be lost)
337 * \param p_playlist the playlist object
340 void playlist_MainLoop( playlist_t *p_playlist )
342 playlist_item_t *p_item = NULL;
343 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
347 if( p_playlist->b_reset_currently_playing &&
348 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
350 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
351 get_current_status_item( p_playlist ) );
352 p_playlist->last_rebuild_date = mdate();
356 /* If there is an input, check that it doesn't need to die. */
357 if( p_playlist->p_input )
359 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
361 PL_DEBUG( "incoming request - stopping current input" );
362 input_StopThread( p_playlist->p_input );
365 /* This input is dead. Remove it ! */
366 if( p_playlist->p_input->b_dead )
369 input_thread_t *p_input;
370 sout_instance_t **pp_sout = &p_playlist->p->p_sout;
372 PL_DEBUG( "dead input" );
374 p_input = p_playlist->p_input;
376 assert( *pp_sout == NULL );
377 if( var_CreateGetBool( p_input, "sout-keep" ) )
378 *pp_sout = input_DetachSout( p_input );
381 playlist_release_current_input( p_playlist );
383 p_playlist->gc_date = mdate();
384 p_playlist->b_cant_sleep = true;
386 i_activity= var_GetInteger( p_playlist, "activity" );
387 var_SetInteger( p_playlist, "activity", i_activity -
388 DEFAULT_INPUT_ACTIVITY );
392 /* This input is dying, let it do */
393 else if( p_playlist->p_input->b_die )
395 PL_DEBUG( "dying input" );
397 msleep( INTF_IDLE_SLEEP );
401 /* This input has finished, ask it to die ! */
402 else if( p_playlist->p_input->b_error
403 || p_playlist->p_input->b_eof )
405 PL_DEBUG( "finished input" );
406 input_StopThread( p_playlist->p_input );
407 /* No need to wait here, we'll wait in the p_input->b_die case */
410 else if( p_playlist->p_input->i_state != INIT_S )
412 ObjectGarbageCollector( p_playlist, false );
417 /* No input. Several cases
418 * - No request, running status -> start new item
419 * - No request, stopped status -> collect garbage
420 * - Request, running requested -> start new item
421 * - Request, stopped requested -> collect garbage
423 int i_status = p_playlist->request.b_request ?
424 p_playlist->request.i_status : p_playlist->status.i_status;
425 if( i_status != PLAYLIST_STOPPED )
427 msg_Dbg( p_playlist, "starting new item" );
428 p_item = playlist_NextItem( p_playlist );
432 msg_Dbg( p_playlist, "nothing to play" );
433 p_playlist->status.i_status = PLAYLIST_STOPPED;
435 if( b_playexit == true )
437 msg_Info( p_playlist, "end of playlist, exiting" );
438 vlc_object_kill( p_playlist->p_libvlc );
440 ObjectGarbageCollector( p_playlist, true );
443 playlist_PlayItem( p_playlist, p_item );
444 /* playlist_PlayItem loose input event, we need to recheck */
449 const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
451 p_playlist->status.i_status = PLAYLIST_STOPPED;
453 /* Collect garbage */
454 ObjectGarbageCollector( p_playlist, b_gc_forced );
462 * The playlist is dying so do the last loop
463 * \param p_playlist the playlist object
466 void playlist_LastLoop( playlist_t *p_playlist )
468 /* If there is an input, kill it */
472 if( p_playlist->p_input == NULL )
478 if( p_playlist->p_input->b_dead )
481 playlist_release_current_input( p_playlist );
483 /* sout-keep: no need to anything here.
484 * The last input will destroy its sout, if any, by itself */
489 else if( p_playlist->p_input->b_die )
491 /* This input is dying, leave it alone */
494 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
496 input_StopThread( p_playlist->p_input );
502 p_playlist->p_input->b_eof = 1;
506 msleep( INTF_IDLE_SLEEP );
510 /* close the remaining sout-keep (if there was no input atm) */
511 sout_instance_t *p_sout = p_playlist->p->p_sout;
513 sout_DeleteInstance( p_sout );
516 /* Core should have terminated all SDs before the playlist */
517 /* TODO: It fails to do so when not playing anything -- Courmisch */
518 playlist_ServicesDiscoveryKillAll( p_playlist );
519 playlist_MLDump( p_playlist );
521 vlc_object_kill( p_playlist->p->p_preparse );
522 vlc_thread_join( p_playlist->p->p_preparse );
523 vlc_object_kill( p_playlist->p->p_fetcher );
524 vlc_thread_join( p_playlist->p->p_fetcher );
528 /* Release the current node */
529 set_current_status_node( p_playlist, NULL );
531 /* Release the current item */
532 set_current_status_item( p_playlist, NULL );
534 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
535 free( p_del->pp_children );
536 vlc_gc_decref( p_del->p_input );
539 ARRAY_RESET( p_playlist->all_items );
540 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->items_to_delete )
541 free( p_del->pp_children );
542 vlc_gc_decref( p_del->p_input );
545 ARRAY_RESET( p_playlist->items_to_delete );
547 ARRAY_RESET( p_playlist->items );
548 ARRAY_RESET( p_playlist->current );
556 * Main loop for preparser queue
557 * \param p_obj items to preparse
560 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
562 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
563 input_item_t *p_current;
566 vlc_object_lock( p_obj );
568 while( vlc_object_alive( p_obj ) )
570 if( p_obj->i_waiting == 0 )
572 vlc_object_wait( p_obj );
576 p_current = p_obj->pp_waiting[0];
577 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
578 vlc_object_unlock( p_obj );
583 if( p_current->i_type == ITEM_TYPE_FILE )
585 stats_TimerStart( p_playlist, "Preparse run",
586 STATS_TIMER_PREPARSE );
587 /* Do not preparse if it is already done (like by playing it) */
588 if( !input_item_IsPreparsed( p_current ) )
591 input_Preparse( p_playlist, p_current );
594 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
596 input_item_SetPreparsed( p_current, true );
597 var_SetInteger( p_playlist, "item-change", p_current->i_id );
600 /* If we haven't retrieved enough meta, add to secondary queue
601 * which will run the "meta fetchers".
602 * This only checks for meta, not for art
603 * \todo don't do this for things we won't get meta for, like vids
605 char *psz_arturl = input_item_GetArtURL( p_current );
606 char *psz_name = input_item_GetName( p_current );
607 if( p_playlist->p->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
608 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
610 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
611 vlc_object_lock( p_playlist->p->p_fetcher );
612 if( vlc_object_alive( p_playlist->p->p_fetcher ) )
614 INSERT_ELEM( p_playlist->p->p_fetcher->pp_waiting,
615 p_playlist->p->p_fetcher->i_waiting,
616 p_playlist->p->p_fetcher->i_waiting, p_current);
617 vlc_object_signal_unlocked( p_playlist->p->p_fetcher );
620 vlc_gc_decref( p_current );
621 vlc_object_unlock( p_playlist->p->p_fetcher );
625 PL_DEBUG( "no fetch required for %s (art currently %s)",
626 psz_name, psz_arturl );
627 vlc_gc_decref( p_current );
636 vlc_object_lock( p_obj );
637 i_activity = var_GetInteger( p_playlist, "activity" );
638 if( i_activity < 0 ) i_activity = 0;
639 vlc_object_unlock( p_obj );
640 /* Sleep at least 1ms */
641 msleep( (i_activity+1) * 1000 );
642 vlc_object_lock( p_obj );
645 while( p_obj->i_waiting > 0 )
647 vlc_gc_decref( p_obj->pp_waiting[0] );
648 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
651 vlc_object_unlock( p_obj );
657 * Main loop for secondary preparser queue
658 * \param p_obj items to preparse
661 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
663 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
664 input_item_t *p_item;
667 vlc_object_lock( p_obj );
669 while( vlc_object_alive( p_obj ) )
671 if( p_obj->i_waiting == 0 )
673 vlc_object_wait( p_obj );
677 p_item = p_obj->pp_waiting[0];
678 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
679 vlc_object_unlock( p_obj );
684 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
685 * (This can happen if we fetch art on play)
686 * 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 = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
692 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || 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_object_lock( p_obj );
725 i_activity = var_GetInteger( p_playlist, "activity" );
726 if( i_activity < 0 ) i_activity = 0;
727 vlc_object_unlock( p_obj );
728 /* Sleep at least 1ms */
729 msleep( (i_activity+1) * 1000 );
730 vlc_object_lock( p_obj );
733 while( p_obj->i_waiting > 0 )
735 vlc_gc_decref( p_obj->pp_waiting[0] );
736 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
739 vlc_object_unlock( p_obj );
742 static void VariablesInit( playlist_t *p_playlist )
745 /* These variables control updates */
746 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
748 var_Set( p_playlist, "intf-change", val );
750 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
752 var_Set( p_playlist, "item-change", val );
754 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
756 var_Set( p_playlist, "item-deleted", val );
758 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
760 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
762 var_Set( p_playlist, "playlist-current", val );
764 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
765 var_SetInteger( p_playlist, "activity", 0 );
767 /* Variables to control playback */
768 var_CreateGetBool( p_playlist, "play-and-stop" );
769 var_CreateGetBool( p_playlist, "play-and-exit" );
770 var_CreateGetBool( p_playlist, "random" );
771 var_CreateGetBool( p_playlist, "repeat" );
772 var_CreateGetBool( p_playlist, "loop" );
774 var_AddCallback( p_playlist, "random", RandomCallback, NULL );