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 ((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( p_playlist->i_sds, p_playlist->pp_sds );
77 libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
79 VariablesInit( p_playlist );
81 /* Initialise data structures */
82 p_playlist->i_last_playlist_id = 0;
83 p_playlist->p_input = NULL;
85 p_playlist->gc_date = 0;
86 p_playlist->b_cant_sleep = false;
88 ARRAY_INIT( p_playlist->items );
89 ARRAY_INIT( p_playlist->all_items );
90 ARRAY_INIT( p_playlist->items_to_delete );
91 ARRAY_INIT( p_playlist->current );
93 p_playlist->i_current_index = 0;
94 p_playlist->b_reset_currently_playing = true;
95 p_playlist->last_rebuild_date = 0;
97 p_playlist->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
99 p_playlist->b_doing_ml = false;
101 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 p_playlist->status.p_item = NULL;
150 p_playlist->status.p_node = p_playlist->p_local_onelevel;
151 p_playlist->request.b_request = false;
152 p_playlist->status.i_status = PLAYLIST_STOPPED;
154 p_playlist->i_sort = SORT_ID;
155 p_playlist->i_order = ORDER_NORMAL;
158 b_save = p_playlist->b_auto_preparse;
159 p_playlist->b_auto_preparse = false;
160 playlist_MLLoad( p_playlist );
161 p_playlist->b_auto_preparse = true;
163 vlc_object_set_destructor( p_playlist, playlist_Destructor );
171 * Destroy a playlist structure.
172 * \param p_playlist the playlist object
176 static void playlist_Destructor( vlc_object_t * p_this )
178 playlist_t * p_playlist = (playlist_t *)p_this;
179 playlist_preparse_t *p_preparse = &pl_priv(p_playlist)->preparse;
181 /* Destroy the item preparser */
184 vlc_cancel (p_preparse->thread);
185 vlc_join (p_preparse->thread, NULL);
187 while (p_preparse->i_waiting > 0)
188 { /* Any left-over unparsed item? */
189 vlc_gc_decref (p_preparse->pp_waiting[0]);
190 REMOVE_ELEM (p_preparse->pp_waiting, p_preparse->i_waiting, 0);
192 vlc_cond_destroy (&p_preparse->wait);
193 vlc_mutex_destroy (&p_preparse->lock);
195 /* Destroy the item meta-infos fetcher */
196 if( pl_priv(p_playlist)->p_fetcher )
198 vlc_object_release( pl_priv(p_playlist)->p_fetcher );
200 msg_Dbg( p_this, "Destroyed" );
203 /* Destroy remaining objects */
204 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
208 if( mdate() - p_playlist->gc_date < 1000000 )
210 p_playlist->b_cant_sleep = true;
213 else if( p_playlist->gc_date == 0 )
217 p_playlist->b_cant_sleep = false;
221 static void input_state_changed( const vlc_event_t * event, void * data )
224 playlist_t * p_playlist = data;
225 playlist_Signal( p_playlist );
229 static void input_selected_stream_changed( const vlc_event_t * event, void * data )
232 playlist_t * p_playlist = data;
234 p_playlist->gc_date = mdate();
235 vlc_object_signal_unlocked( p_playlist );
240 void playlist_release_current_input( playlist_t * p_playlist )
244 if( !p_playlist->p_input ) return;
246 input_thread_t * p_input = p_playlist->p_input;
247 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
249 vlc_event_detach( p_em, vlc_InputStateChanged,
250 input_state_changed, p_playlist );
251 vlc_event_detach( p_em, vlc_InputSelectedStreamChanged,
252 input_selected_stream_changed, p_playlist );
253 p_playlist->p_input = NULL;
255 /* Release the playlist lock, because we may get stuck
256 * in vlc_object_release() for some time. */
258 vlc_thread_join( p_input );
259 vlc_object_release( p_input );
263 void playlist_set_current_input(
264 playlist_t * p_playlist, input_thread_t * p_input )
268 playlist_release_current_input( p_playlist );
272 vlc_object_yield( p_input );
273 p_playlist->p_input = p_input;
274 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
275 vlc_event_attach( p_em, vlc_InputStateChanged,
276 input_state_changed, p_playlist );
277 vlc_event_attach( p_em, vlc_InputSelectedStreamChanged,
278 input_selected_stream_changed, p_playlist );
282 /** Get current playing input.
284 input_thread_t * playlist_CurrentInput( playlist_t * p_playlist )
286 input_thread_t * p_input;
288 p_input = p_playlist->p_input;
289 if( p_input ) vlc_object_yield( p_input );
298 /** Accessor for status item and status nodes.
300 playlist_item_t * get_current_status_item( playlist_t * p_playlist )
304 return p_playlist->status.p_item;
307 playlist_item_t * get_current_status_node( playlist_t * p_playlist )
311 return p_playlist->status.p_node;
314 void set_current_status_item( playlist_t * p_playlist,
315 playlist_item_t * p_item )
319 if( p_playlist->status.p_item &&
320 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG &&
321 p_playlist->status.p_item != p_item )
323 /* It's unsafe given current design to delete a playlist item :(
324 playlist_ItemDelete( p_playlist->status.p_item ); */
326 p_playlist->status.p_item = p_item;
329 void set_current_status_node( playlist_t * p_playlist,
330 playlist_item_t * p_node )
334 if( p_playlist->status.p_node &&
335 p_playlist->status.p_node->i_flags & PLAYLIST_REMOVE_FLAG &&
336 p_playlist->status.p_node != p_node )
338 /* It's unsafe given current design to delete a playlist item :(
339 playlist_ItemDelete( p_playlist->status.p_node ); */
341 p_playlist->status.p_node = p_node;
347 * Main loop for the playlist. It should be entered with the
348 * playlist lock (otherwise input event may be lost)
349 * \param p_playlist the playlist object
352 void playlist_MainLoop( playlist_t *p_playlist )
354 playlist_item_t *p_item = NULL;
355 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
359 if( p_playlist->b_reset_currently_playing &&
360 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
362 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
363 get_current_status_item( p_playlist ) );
364 p_playlist->last_rebuild_date = mdate();
368 /* If there is an input, check that it doesn't need to die. */
369 if( p_playlist->p_input )
371 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
373 PL_DEBUG( "incoming request - stopping current input" );
374 input_StopThread( p_playlist->p_input );
377 /* This input is dead. Remove it ! */
378 if( p_playlist->p_input->b_dead )
381 input_thread_t *p_input;
382 sout_instance_t **pp_sout = &pl_priv(p_playlist)->p_sout;
384 PL_DEBUG( "dead input" );
386 p_input = p_playlist->p_input;
388 assert( *pp_sout == NULL );
389 if( var_CreateGetBool( p_input, "sout-keep" ) )
390 *pp_sout = input_DetachSout( p_input );
393 playlist_release_current_input( p_playlist );
395 p_playlist->gc_date = mdate();
396 p_playlist->b_cant_sleep = true;
398 i_activity= var_GetInteger( p_playlist, "activity" );
399 var_SetInteger( p_playlist, "activity", i_activity -
400 DEFAULT_INPUT_ACTIVITY );
404 /* This input is dying, let it do */
405 else if( p_playlist->p_input->b_die )
407 PL_DEBUG( "dying input" );
409 msleep( INTF_IDLE_SLEEP );
413 /* This input has finished, ask it to die ! */
414 else if( p_playlist->p_input->b_error
415 || p_playlist->p_input->b_eof )
417 PL_DEBUG( "finished input" );
418 input_StopThread( p_playlist->p_input );
419 /* No need to wait here, we'll wait in the p_input->b_die case */
422 else if( p_playlist->p_input->i_state != INIT_S )
424 ObjectGarbageCollector( p_playlist, false );
429 /* No input. Several cases
430 * - No request, running status -> start new item
431 * - No request, stopped status -> collect garbage
432 * - Request, running requested -> start new item
433 * - Request, stopped requested -> collect garbage
435 int i_status = p_playlist->request.b_request ?
436 p_playlist->request.i_status : p_playlist->status.i_status;
437 if( i_status != PLAYLIST_STOPPED )
439 msg_Dbg( p_playlist, "starting new item" );
440 p_item = playlist_NextItem( p_playlist );
444 msg_Dbg( p_playlist, "nothing to play" );
445 p_playlist->status.i_status = PLAYLIST_STOPPED;
447 if( b_playexit == true )
449 msg_Info( p_playlist, "end of playlist, exiting" );
450 vlc_object_kill( p_playlist->p_libvlc );
452 ObjectGarbageCollector( p_playlist, true );
455 playlist_PlayItem( p_playlist, p_item );
456 /* playlist_PlayItem loose input event, we need to recheck */
461 const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
463 p_playlist->status.i_status = PLAYLIST_STOPPED;
465 /* Collect garbage */
466 ObjectGarbageCollector( p_playlist, b_gc_forced );
474 * The playlist is dying so do the last loop
475 * \param p_playlist the playlist object
478 void playlist_LastLoop( playlist_t *p_playlist )
480 /* If there is an input, kill it */
484 if( p_playlist->p_input == NULL )
490 if( p_playlist->p_input->b_dead )
493 playlist_release_current_input( p_playlist );
495 /* sout-keep: no need to anything here.
496 * The last input will destroy its sout, if any, by itself */
501 else if( p_playlist->p_input->b_die )
503 /* This input is dying, leave it alone */
506 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
508 input_StopThread( p_playlist->p_input );
514 p_playlist->p_input->b_eof = 1;
518 msleep( INTF_IDLE_SLEEP );
522 /* close the remaining sout-keep (if there was no input atm) */
523 sout_instance_t *p_sout = pl_priv(p_playlist)->p_sout;
525 sout_DeleteInstance( p_sout );
528 /* Core should have terminated all SDs before the playlist */
529 /* TODO: It fails to do so when not playing anything -- Courmisch */
530 playlist_ServicesDiscoveryKillAll( p_playlist );
531 playlist_MLDump( p_playlist );
533 vlc_object_kill( pl_priv(p_playlist)->p_fetcher );
534 vlc_thread_join( pl_priv(p_playlist)->p_fetcher );
538 /* Release the current node */
539 set_current_status_node( p_playlist, NULL );
541 /* Release the current item */
542 set_current_status_item( p_playlist, NULL );
544 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
545 free( p_del->pp_children );
546 vlc_gc_decref( p_del->p_input );
549 ARRAY_RESET( p_playlist->all_items );
550 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->items_to_delete )
551 free( p_del->pp_children );
552 vlc_gc_decref( p_del->p_input );
555 ARRAY_RESET( p_playlist->items_to_delete );
557 ARRAY_RESET( p_playlist->items );
558 ARRAY_RESET( p_playlist->current );
564 * Preparse queue loop
566 * @param p_obj preparse structure
569 void *playlist_PreparseLoop( void *data )
571 playlist_preparse_t *p_preparse = data;
572 playlist_t *p_playlist = &((playlist_private_t *)(((char *)p_preparse)
573 - offsetof(playlist_private_t, preparse)))->public_data;
578 input_item_t *p_current;
580 vlc_mutex_lock( &p_preparse->lock );
581 mutex_cleanup_push( &p_preparse->lock );
583 while( p_preparse->i_waiting == 0 )
584 vlc_cond_wait( &p_preparse->wait, &p_preparse->lock );
586 p_current = p_preparse->pp_waiting[0];
587 REMOVE_ELEM( p_preparse->pp_waiting, p_preparse->i_waiting, 0 );
592 int canc = vlc_savecancel ();
594 if( p_current->i_type == ITEM_TYPE_FILE )
596 stats_TimerStart( p_playlist, "Preparse run",
597 STATS_TIMER_PREPARSE );
598 /* Do not preparse if it is already done (like by playing it) */
599 if( !input_item_IsPreparsed( p_current ) )
602 input_Preparse( p_playlist, p_current );
605 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
607 input_item_SetPreparsed( p_current, true );
608 var_SetInteger( p_playlist, "item-change", p_current->i_id );
611 /* If we haven't retrieved enough meta, add to secondary queue
612 * which will run the "meta fetchers".
613 * This only checks for meta, not for art
614 * \todo don't do this for things we won't get meta for, like vids
616 char *psz_arturl = input_item_GetArtURL( p_current );
617 char *psz_name = input_item_GetName( p_current );
618 playlist_fetcher_t *p_fetcher = pl_priv(p_playlist)->p_fetcher;
619 if( p_fetcher->i_art_policy == ALBUM_ART_ALL &&
620 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
622 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
623 vlc_object_lock( p_fetcher );
624 if( vlc_object_alive( p_fetcher ) )
626 INSERT_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting,
627 p_fetcher->i_waiting, p_current);
628 vlc_object_signal_unlocked( p_fetcher );
631 vlc_gc_decref( p_current );
632 vlc_object_unlock( p_fetcher );
636 PL_DEBUG( "no fetch required for %s (art currently %s)",
637 psz_name, psz_arturl );
638 vlc_gc_decref( p_current );
643 vlc_restorecancel( canc );
646 i_activity = var_GetInteger( p_playlist, "activity" );
647 if( i_activity < 0 ) i_activity = 0;
648 /* Sleep at least 1ms */
649 msleep( (i_activity+1) * 1000 );
659 * Main loop for secondary preparser queue
660 * \param p_obj items to preparse
663 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
665 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
666 input_item_t *p_item;
669 vlc_object_lock( p_obj );
671 while( vlc_object_alive( p_obj ) )
673 if( p_obj->i_waiting == 0 )
675 vlc_object_wait( p_obj );
679 p_item = p_obj->pp_waiting[0];
680 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
681 vlc_object_unlock( p_obj );
686 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
687 * (This can happen if we fetch art on play)
688 * FIXME this doesn't work if we need to fetch meta before art ... */
689 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
693 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
694 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
701 i_ret = input_ArtFind( p_playlist, p_item );
704 PL_DEBUG( "downloading art for %s", p_item->psz_name );
705 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
706 input_item_SetArtNotFound( p_item, true );
708 input_item_SetArtFetched( p_item, true );
709 var_SetInteger( p_playlist, "item-change",
713 else if( i_ret == 0 ) /* Was in cache */
715 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
716 input_item_SetArtFetched( p_item, true );
717 var_SetInteger( p_playlist, "item-change", p_item->i_id );
721 PL_DEBUG( "art not found for %s", p_item->psz_name );
722 input_item_SetArtNotFound( p_item, true );
724 vlc_gc_decref( p_item );
726 vlc_object_lock( p_obj );
727 i_activity = var_GetInteger( p_playlist, "activity" );
728 if( i_activity < 0 ) i_activity = 0;
729 vlc_object_unlock( p_obj );
730 /* Sleep at least 1ms */
731 msleep( (i_activity+1) * 1000 );
732 vlc_object_lock( p_obj );
735 while( p_obj->i_waiting > 0 )
737 vlc_gc_decref( p_obj->pp_waiting[0] );
738 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
741 vlc_object_unlock( p_obj );
744 static void VariablesInit( playlist_t *p_playlist )
747 /* These variables control updates */
748 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
750 var_Set( p_playlist, "intf-change", val );
752 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
754 var_Set( p_playlist, "item-change", val );
756 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
758 var_Set( p_playlist, "item-deleted", val );
760 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
762 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
764 var_Set( p_playlist, "playlist-current", val );
766 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
767 var_SetInteger( p_playlist, "activity", 0 );
769 /* Variables to control playback */
770 var_CreateGetBool( p_playlist, "play-and-stop" );
771 var_CreateGetBool( p_playlist, "play-and-exit" );
772 var_CreateGetBool( p_playlist, "random" );
773 var_CreateGetBool( p_playlist, "repeat" );
774 var_CreateGetBool( p_playlist, "loop" );
776 var_AddCallback( p_playlist, "random", RandomCallback, NULL );