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 vlc_mutex_init( &p_playlist->gc_lock );
80 p_playlist->i_last_playlist_id = 0;
81 p_playlist->p_input = NULL;
83 p_playlist->gc_date = 0;
84 p_playlist->b_cant_sleep = false;
86 ARRAY_INIT( p_playlist->items );
87 ARRAY_INIT( p_playlist->all_items );
88 ARRAY_INIT( p_playlist->items_to_delete );
89 ARRAY_INIT( p_playlist->current );
91 p_playlist->i_current_index = 0;
92 p_playlist->b_reset_currently_playing = true;
93 p_playlist->last_rebuild_date = 0;
95 p_playlist->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
97 p_playlist->b_doing_ml = false;
99 p_playlist->b_auto_preparse =
100 var_CreateGetBool( p_playlist, "auto-preparse" ) ;
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 );
107 if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
110 /* Create playlist and media library */
111 PL_LOCK; /* playlist_NodesPairCreate will check for it */
112 playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
113 &p_playlist->p_local_category,
114 &p_playlist->p_local_onelevel, false );
117 p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
118 p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
120 if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
121 !p_playlist->p_local_category->p_input ||
122 !p_playlist->p_local_onelevel->p_input )
125 if( config_GetInt( p_playlist, "media-library") )
127 PL_LOCK; /* playlist_NodesPairCreate will check for it */
128 playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
129 &p_playlist->p_ml_category,
130 &p_playlist->p_ml_onelevel, false );
133 if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
136 p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
137 p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
141 p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
145 p_playlist->status.p_item = NULL;
146 p_playlist->status.p_node = p_playlist->p_local_onelevel;
147 p_playlist->request.b_request = false;
148 p_playlist->status.i_status = PLAYLIST_STOPPED;
150 p_playlist->i_sort = SORT_ID;
151 p_playlist->i_order = ORDER_NORMAL;
154 b_save = p_playlist->b_auto_preparse;
155 p_playlist->b_auto_preparse = false;
156 playlist_MLLoad( p_playlist );
157 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 if( p_playlist->p_preparse )
178 vlc_object_release( p_playlist->p_preparse );
181 if( p_playlist->p_fetcher )
183 vlc_object_release( p_playlist->p_fetcher );
185 msg_Dbg( p_this, "Destroyed" );
188 /* Destroy remaining objects */
189 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
193 if( mdate() - p_playlist->gc_date < 1000000 )
195 p_playlist->b_cant_sleep = true;
198 else if( p_playlist->gc_date == 0 )
202 vlc_mutex_lock( &p_playlist->gc_lock );
203 p_playlist->b_cant_sleep = false;
204 vlc_mutex_unlock( &p_playlist->gc_lock );
208 static void input_state_changed( const vlc_event_t * event, void * data )
211 playlist_t * p_playlist = data;
212 playlist_Signal( p_playlist );
216 static void input_selected_stream_changed( const vlc_event_t * event, void * data )
219 playlist_t * p_playlist = data;
221 p_playlist->gc_date = mdate();
222 vlc_object_signal_unlocked( p_playlist );
227 void playlist_release_current_input( playlist_t * p_playlist )
231 if( !p_playlist->p_input ) return;
233 input_thread_t * p_input = p_playlist->p_input;
234 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
236 vlc_event_detach( p_em, vlc_InputStateChanged,
237 input_state_changed, p_playlist );
238 vlc_event_detach( p_em, vlc_InputSelectedStreamChanged,
239 input_selected_stream_changed, p_playlist );
240 p_playlist->p_input = NULL;
242 /* Release the playlist lock, because we may get stuck
243 * in vlc_object_release() for some time. */
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
334 * \param p_playlist the playlist object
337 void playlist_MainLoop( playlist_t *p_playlist )
339 playlist_item_t *p_item = NULL;
340 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
343 if( p_playlist->b_reset_currently_playing &&
344 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
346 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
347 get_current_status_item( p_playlist ) );
348 p_playlist->last_rebuild_date = mdate();
352 /* If there is an input, check that it doesn't need to die. */
353 if( p_playlist->p_input )
355 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
357 PL_DEBUG( "incoming request - stopping current input" );
358 input_StopThread( p_playlist->p_input );
361 /* This input is dead. Remove it ! */
362 if( p_playlist->p_input->b_dead )
365 input_thread_t *p_input;
366 sout_instance_t **pp_sout =
367 &libvlc_priv(p_playlist->p_libvlc)->p_sout;
369 PL_DEBUG( "dead input" );
371 p_input = p_playlist->p_input;
373 assert( *pp_sout == NULL );
374 if( var_CreateGetBool( p_input, "sout-keep" ) )
375 *pp_sout = input_DetachSout( p_input );
378 playlist_release_current_input( p_playlist );
380 p_playlist->gc_date = mdate();
381 p_playlist->b_cant_sleep = true;
383 set_current_status_item( p_playlist, NULL );
385 i_activity= var_GetInteger( p_playlist, "activity" );
386 var_SetInteger( p_playlist, "activity", i_activity -
387 DEFAULT_INPUT_ACTIVITY );
391 /* This input is dying, let it do */
392 else if( p_playlist->p_input->b_die )
394 PL_DEBUG( "dying input" );
396 msleep( INTF_IDLE_SLEEP );
400 /* This input has finished, ask it to die ! */
401 else if( p_playlist->p_input->b_error
402 || p_playlist->p_input->b_eof )
404 PL_DEBUG( "finished input" );
405 input_StopThread( p_playlist->p_input );
406 /* No need to wait here, we'll wait in the p_input->b_die case */
409 else if( p_playlist->p_input->i_state != INIT_S )
412 ObjectGarbageCollector( p_playlist, false );
418 /* No input. Several cases
419 * - No request, running status -> start new item
420 * - No request, stopped status -> collect garbage
421 * - Request, running requested -> start new item
422 * - Request, stopped requested -> collect garbage
424 int i_status = p_playlist->request.b_request ?
425 p_playlist->request.i_status : p_playlist->status.i_status;
426 if( i_status != PLAYLIST_STOPPED )
428 msg_Dbg( p_playlist, "starting new item" );
429 p_item = playlist_NextItem( p_playlist );
433 msg_Dbg( p_playlist, "nothing to play" );
434 p_playlist->status.i_status = PLAYLIST_STOPPED;
437 if( b_playexit == true )
439 msg_Info( p_playlist, "end of playlist, exiting" );
440 vlc_object_kill( p_playlist->p_libvlc );
442 ObjectGarbageCollector( p_playlist, true );
445 playlist_PlayItem( p_playlist, p_item );
449 const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
451 p_playlist->status.i_status = PLAYLIST_STOPPED;
452 set_current_status_item( p_playlist, NULL );
454 /* Collect garbage */
456 ObjectGarbageCollector( p_playlist, b_gc_forced );
466 * The playlist is dying so do the last loop
467 * \param p_playlist the playlist object
470 void playlist_LastLoop( playlist_t *p_playlist )
472 /* If there is an input, kill it */
476 if( p_playlist->p_input == NULL )
482 if( p_playlist->p_input->b_dead )
485 playlist_release_current_input( p_playlist );
487 /* sout-keep: no need to anything here.
488 * The last input will destroy its sout, if any, by itself */
493 else if( p_playlist->p_input->b_die )
495 /* This input is dying, leave it alone */
498 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
500 input_StopThread( p_playlist->p_input );
506 p_playlist->p_input->b_eof = 1;
510 msleep( INTF_IDLE_SLEEP );
514 /* close the remaining sout-keep (if there was no input atm) */
515 sout_instance_t *p_sout = libvlc_priv (p_playlist->p_libvlc)->p_sout;
517 sout_DeleteInstance( p_sout );
520 /* Core should have terminated all SDs before the playlist */
521 /* TODO: It fails to do so when not playing anything -- Courmisch */
522 playlist_ServicesDiscoveryKillAll( p_playlist );
523 playlist_MLDump( p_playlist );
525 vlc_object_kill( p_playlist->p_preparse );
526 vlc_thread_join( p_playlist->p_preparse );
527 vlc_object_kill( p_playlist->p_fetcher );
528 vlc_thread_join( p_playlist->p_fetcher );
532 /* Release the current node */
533 set_current_status_node( p_playlist, NULL );
535 /* Release the current item */
536 set_current_status_item( p_playlist, NULL );
538 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
539 free( p_del->pp_children );
540 vlc_gc_decref( p_del->p_input );
543 ARRAY_RESET( p_playlist->all_items );
544 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->items_to_delete )
545 free( p_del->pp_children );
546 vlc_gc_decref( p_del->p_input );
549 ARRAY_RESET( p_playlist->items_to_delete );
551 ARRAY_RESET( p_playlist->items );
552 ARRAY_RESET( p_playlist->current );
560 * Main loop for preparser queue
561 * \param p_obj items to preparse
564 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
566 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
567 input_item_t *p_current;
570 vlc_object_lock( p_obj );
572 while( vlc_object_alive( p_obj ) )
574 if( p_obj->i_waiting == 0 )
576 vlc_object_wait( p_obj );
580 p_current = p_obj->pp_waiting[0];
581 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
582 vlc_object_unlock( p_obj );
587 if( p_current->i_type == ITEM_TYPE_FILE )
589 stats_TimerStart( p_playlist, "Preparse run",
590 STATS_TIMER_PREPARSE );
591 /* Do not preparse if it is already done (like by playing it) */
592 if( !input_item_IsPreparsed( p_current ) )
595 input_Preparse( p_playlist, p_current );
598 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
600 input_item_SetPreparsed( p_current, true );
601 var_SetInteger( p_playlist, "item-change", p_current->i_id );
604 /* If we haven't retrieved enough meta, add to secondary queue
605 * which will run the "meta fetchers".
606 * This only checks for meta, not for art
607 * \todo don't do this for things we won't get meta for, like vids
609 char *psz_arturl = input_item_GetArtURL( p_current );
610 char *psz_name = input_item_GetName( p_current );
611 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
612 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
614 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
615 vlc_object_lock( p_playlist->p_fetcher );
616 if( vlc_object_alive( p_playlist->p_fetcher ) )
618 INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
619 p_playlist->p_fetcher->i_waiting,
620 p_playlist->p_fetcher->i_waiting, p_current);
621 vlc_object_signal_unlocked( p_playlist->p_fetcher );
624 vlc_gc_decref( p_current );
625 vlc_object_unlock( p_playlist->p_fetcher );
629 PL_DEBUG( "no fetch required for %s (art currently %s)",
630 psz_name, psz_arturl );
631 vlc_gc_decref( p_current );
640 vlc_object_lock( p_obj );
641 i_activity = var_GetInteger( p_playlist, "activity" );
642 if( i_activity < 0 ) i_activity = 0;
643 vlc_object_unlock( p_obj );
644 /* Sleep at least 1ms */
645 msleep( (i_activity+1) * 1000 );
646 vlc_object_lock( p_obj );
649 while( p_obj->i_waiting > 0 )
651 vlc_gc_decref( p_obj->pp_waiting[0] );
652 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
655 vlc_object_unlock( p_obj );
661 * Main loop for secondary preparser queue
662 * \param p_obj items to preparse
665 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
667 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
668 input_item_t *p_item;
671 vlc_object_lock( p_obj );
673 while( vlc_object_alive( p_obj ) )
675 if( p_obj->i_waiting == 0 )
677 vlc_object_wait( p_obj );
681 p_item = p_obj->pp_waiting[0];
682 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
683 vlc_object_unlock( p_obj );
688 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
689 * (This can happen if we fetch art on play)
690 * FIXME this doesn't work if we need to fetch meta before art ... */
691 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
695 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
696 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
703 i_ret = input_ArtFind( p_playlist, p_item );
706 PL_DEBUG( "downloading art for %s", p_item->psz_name );
707 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
708 input_item_SetArtNotFound( p_item, true );
710 input_item_SetArtFetched( p_item, true );
711 var_SetInteger( p_playlist, "item-change",
715 else if( i_ret == 0 ) /* Was in cache */
717 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
718 input_item_SetArtFetched( p_item, true );
719 var_SetInteger( p_playlist, "item-change", p_item->i_id );
723 PL_DEBUG( "art not found for %s", p_item->psz_name );
724 input_item_SetArtNotFound( p_item, true );
726 vlc_gc_decref( p_item );
728 vlc_object_lock( p_obj );
729 i_activity = var_GetInteger( p_playlist, "activity" );
730 if( i_activity < 0 ) i_activity = 0;
731 vlc_object_unlock( p_obj );
732 /* Sleep at least 1ms */
733 msleep( (i_activity+1) * 1000 );
734 vlc_object_lock( p_obj );
737 while( p_obj->i_waiting > 0 )
739 vlc_gc_decref( p_obj->pp_waiting[0] );
740 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
743 vlc_object_unlock( p_obj );
746 static void VariablesInit( playlist_t *p_playlist )
749 /* These variables control updates */
750 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
752 var_Set( p_playlist, "intf-change", val );
754 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
756 var_Set( p_playlist, "item-change", val );
758 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
760 var_Set( p_playlist, "item-deleted", val );
762 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
764 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
766 var_Set( p_playlist, "playlist-current", val );
768 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
769 var_SetInteger( p_playlist, "activity", 0 );
771 /* Variables to control playback */
772 var_CreateGetBool( p_playlist, "play-and-stop" );
773 var_CreateGetBool( p_playlist, "play-and-exit" );
774 var_CreateGetBool( p_playlist, "random" );
775 var_CreateGetBool( p_playlist, "repeat" );
776 var_CreateGetBool( p_playlist, "loop" );
778 var_AddCallback( p_playlist, "random", RandomCallback, NULL );