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->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 p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
103 p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
104 0, p_playlist->p_root_category->p_input );
106 if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
109 /* Create playlist and media library */
110 playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
111 &p_playlist->p_local_category,
112 &p_playlist->p_local_onelevel, false );
114 p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
115 p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
117 if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
118 !p_playlist->p_local_category->p_input ||
119 !p_playlist->p_local_onelevel->p_input )
122 if( config_GetInt( p_playlist, "media-library") )
124 playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
125 &p_playlist->p_ml_category,
126 &p_playlist->p_ml_onelevel, false );
128 if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
131 p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
132 p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
136 p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
140 p_playlist->status.p_item = NULL;
141 p_playlist->status.p_node = p_playlist->p_local_onelevel;
142 p_playlist->request.b_request = false;
143 p_playlist->status.i_status = PLAYLIST_STOPPED;
145 p_playlist->i_sort = SORT_ID;
146 p_playlist->i_order = ORDER_NORMAL;
149 b_save = p_playlist->b_auto_preparse;
150 p_playlist->b_auto_preparse = false;
151 playlist_MLLoad( p_playlist );
152 p_playlist->b_auto_preparse = true;
154 vlc_object_set_destructor( p_playlist, playlist_Destructor );
162 * Destroy a playlist structure.
163 * \param p_playlist the playlist object
167 static void playlist_Destructor( vlc_object_t * p_this )
169 playlist_t * p_playlist = (playlist_t *)p_this;
171 if( p_playlist->p_preparse )
173 vlc_object_release( p_playlist->p_preparse );
176 if( p_playlist->p_fetcher )
178 vlc_object_release( p_playlist->p_fetcher );
180 msg_Dbg( p_this, "Destroyed" );
183 /* Destroy remaining objects */
184 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
188 if( mdate() - p_playlist->gc_date < 1000000 )
190 p_playlist->b_cant_sleep = true;
193 else if( p_playlist->gc_date == 0 )
197 vlc_mutex_lock( &p_playlist->gc_lock );
198 p_playlist->b_cant_sleep = false;
199 vlc_mutex_unlock( &p_playlist->gc_lock );
203 static void input_state_changed( const vlc_event_t * event, void * data )
206 playlist_t * p_playlist = data;
207 playlist_Signal( p_playlist );
211 static void input_selected_stream_changed( const vlc_event_t * event, void * data )
214 playlist_t * p_playlist = data;
216 p_playlist->gc_date = mdate();
217 vlc_object_signal_unlocked( p_playlist );
222 void playlist_release_current_input( playlist_t * p_playlist )
224 vlc_assert_locked( &(vlc_internals(p_playlist)->lock) );
226 if( !p_playlist->p_input ) return;
228 input_thread_t * p_input = p_playlist->p_input;
229 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
231 vlc_event_detach( p_em, vlc_InputStateChanged,
232 input_state_changed, p_playlist );
233 vlc_event_detach( p_em, vlc_InputSelectedStreamChanged,
234 input_selected_stream_changed, p_playlist );
235 p_playlist->p_input = NULL;
237 /* Release the playlist lock, because we may get stuck
238 * in vlc_object_release() for some time. */
240 vlc_object_release( p_input );
244 void playlist_set_current_input(
245 playlist_t * p_playlist, input_thread_t * p_input )
247 vlc_assert_locked( &(vlc_internals(p_playlist)->lock) );
249 playlist_release_current_input( p_playlist );
253 vlc_object_yield( p_input );
254 p_playlist->p_input = p_input;
255 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
256 vlc_event_attach( p_em, vlc_InputStateChanged,
257 input_state_changed, p_playlist );
258 vlc_event_attach( p_em, vlc_InputSelectedStreamChanged,
259 input_selected_stream_changed, p_playlist );
263 /** Get current playing input.
265 input_thread_t * playlist_CurrentInput( playlist_t * p_playlist )
267 input_thread_t * p_input;
269 p_input = p_playlist->p_input;
270 if( p_input ) vlc_object_yield( p_input );
280 /** Accessor for status item and status nodes.
282 playlist_item_t * get_current_status_item( playlist_t * p_playlist )
286 return p_playlist->status.p_item;
289 playlist_item_t * get_current_status_node( playlist_t * p_playlist )
293 return p_playlist->status.p_node;
296 void set_current_status_item( playlist_t * p_playlist,
297 playlist_item_t * p_item )
301 if( p_playlist->status.p_item &&
302 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG &&
303 p_playlist->status.p_item != p_item )
305 PL_DEBUG( "%s was marked for deletion, deleting",
306 PLI_NAME( p_playlist->status.p_item ) );
307 playlist_ItemDelete( p_playlist->status.p_item );
309 p_playlist->status.p_item = p_item;
312 void set_current_status_node( playlist_t * p_playlist,
313 playlist_item_t * p_node )
317 if( p_playlist->status.p_node &&
318 p_playlist->status.p_node->i_flags & PLAYLIST_REMOVE_FLAG &&
319 p_playlist->status.p_node != p_node )
321 PL_DEBUG( "%s was marked for deletion, deleting",
322 PLI_NAME( p_playlist->status.p_node ) );
323 playlist_ItemDelete( p_playlist->status.p_node );
325 p_playlist->status.p_node = p_node;
331 * Main loop for the playlist
332 * \param p_playlist the playlist object
335 void playlist_MainLoop( playlist_t *p_playlist )
337 playlist_item_t *p_item = NULL;
338 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
341 if( p_playlist->b_reset_currently_playing &&
342 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
344 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
345 get_current_status_item( p_playlist ) );
346 p_playlist->last_rebuild_date = mdate();
350 /* If there is an input, check that it doesn't need to die. */
351 if( p_playlist->p_input )
353 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
355 PL_DEBUG( "incoming request - stopping current input" );
356 input_StopThread( p_playlist->p_input );
359 /* This input is dead. Remove it ! */
360 if( p_playlist->p_input->b_dead )
363 input_thread_t *p_input;
364 sout_instance_t **pp_sout =
365 &libvlc_priv(p_playlist->p_libvlc)->p_sout;
367 PL_DEBUG( "dead input" );
369 p_input = p_playlist->p_input;
371 assert( *pp_sout == NULL );
372 if( var_CreateGetBool( p_input, "sout-keep" ) )
373 *pp_sout = input_DetachSout( p_input );
376 playlist_release_current_input( p_playlist );
378 p_playlist->gc_date = mdate();
379 p_playlist->b_cant_sleep = true;
381 set_current_status_item( p_playlist, NULL );
383 i_activity= var_GetInteger( p_playlist, "activity" );
384 var_SetInteger( p_playlist, "activity", i_activity -
385 DEFAULT_INPUT_ACTIVITY );
389 /* This input is dying, let it do */
390 else if( p_playlist->p_input->b_die )
392 PL_DEBUG( "dying input" );
394 msleep( INTF_IDLE_SLEEP );
398 /* This input has finished, ask it to die ! */
399 else if( p_playlist->p_input->b_error
400 || p_playlist->p_input->b_eof )
402 PL_DEBUG( "finished input" );
403 input_StopThread( p_playlist->p_input );
404 /* No need to wait here, we'll wait in the p_input->b_die case */
407 else if( p_playlist->p_input->i_state != INIT_S )
410 ObjectGarbageCollector( p_playlist, false );
416 /* No input. Several cases
417 * - No request, running status -> start new item
418 * - No request, stopped status -> collect garbage
419 * - Request, running requested -> start new item
420 * - Request, stopped requested -> collect garbage
422 int i_status = p_playlist->request.b_request ?
423 p_playlist->request.i_status : p_playlist->status.i_status;
424 if( i_status != PLAYLIST_STOPPED )
426 msg_Dbg( p_playlist, "starting new item" );
427 p_item = playlist_NextItem( p_playlist );
431 msg_Dbg( p_playlist, "nothing to play" );
432 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 );
447 const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
449 p_playlist->status.i_status = PLAYLIST_STOPPED;
450 set_current_status_item( p_playlist, NULL );
452 /* Collect garbage */
454 ObjectGarbageCollector( p_playlist, b_gc_forced );
464 * The playlist is dying so do the last loop
465 * \param p_playlist the playlist object
468 void playlist_LastLoop( playlist_t *p_playlist )
470 /* If there is an input, kill it */
474 if( p_playlist->p_input == NULL )
480 if( p_playlist->p_input->b_dead )
483 playlist_release_current_input( p_playlist );
485 /* sout-keep: no need to anything here.
486 * The last input will destroy its sout, if any, by itself */
491 else if( p_playlist->p_input->b_die )
493 /* This input is dying, leave it alone */
496 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
498 input_StopThread( p_playlist->p_input );
504 p_playlist->p_input->b_eof = 1;
508 msleep( INTF_IDLE_SLEEP );
512 /* close the remaining sout-keep (if there was no input atm) */
513 sout_instance_t *p_sout = libvlc_priv (p_playlist->p_libvlc)->p_sout;
515 sout_DeleteInstance( p_sout );
518 /* Core should have terminated all SDs before the playlist */
519 /* TODO: It fails to do so when not playing anything -- Courmisch */
520 playlist_ServicesDiscoveryKillAll( p_playlist );
521 playlist_MLDump( p_playlist );
523 vlc_object_kill( p_playlist->p_preparse );
524 vlc_thread_join( p_playlist->p_preparse );
525 vlc_object_kill( p_playlist->p_fetcher );
526 vlc_thread_join( p_playlist->p_fetcher );
530 /* Release the current node */
531 set_current_status_node( p_playlist, NULL );
533 /* Release the current item */
534 set_current_status_item( p_playlist, NULL );
536 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
537 free( p_del->pp_children );
538 vlc_gc_decref( p_del->p_input );
541 ARRAY_RESET( p_playlist->all_items );
543 ARRAY_RESET( p_playlist->items );
544 ARRAY_RESET( p_playlist->current );
552 * Main loop for preparser queue
553 * \param p_obj items to preparse
556 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
558 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
559 input_item_t *p_current;
562 vlc_object_lock( p_obj );
564 while( vlc_object_alive( p_obj ) )
566 if( p_obj->i_waiting == 0 )
568 vlc_object_wait( p_obj );
572 p_current = p_obj->pp_waiting[0];
573 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
574 vlc_object_unlock( p_obj );
579 if( p_current->i_type == ITEM_TYPE_FILE )
581 stats_TimerStart( p_playlist, "Preparse run",
582 STATS_TIMER_PREPARSE );
583 /* Do not preparse if it is already done (like by playing it) */
584 if( !input_item_IsPreparsed( p_current ) )
587 input_Preparse( p_playlist, p_current );
590 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
592 input_item_SetPreparsed( p_current, true );
593 var_SetInteger( p_playlist, "item-change", p_current->i_id );
596 /* If we haven't retrieved enough meta, add to secondary queue
597 * which will run the "meta fetchers".
598 * This only checks for meta, not for art
599 * \todo don't do this for things we won't get meta for, like vids
601 char *psz_arturl = input_item_GetArtURL( p_current );
602 char *psz_name = input_item_GetName( p_current );
603 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
604 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
606 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
607 vlc_object_lock( p_playlist->p_fetcher );
608 if( vlc_object_alive( p_playlist->p_fetcher ) )
610 INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
611 p_playlist->p_fetcher->i_waiting,
612 p_playlist->p_fetcher->i_waiting, p_current);
613 vlc_object_signal_unlocked( p_playlist->p_fetcher );
616 vlc_gc_decref( p_current );
617 vlc_object_unlock( p_playlist->p_fetcher );
621 PL_DEBUG( "no fetch required for %s (art currently %s)",
622 psz_name, psz_arturl );
623 vlc_gc_decref( p_current );
632 vlc_object_lock( p_obj );
633 i_activity = var_GetInteger( p_playlist, "activity" );
634 if( i_activity < 0 ) i_activity = 0;
635 vlc_object_unlock( p_obj );
636 /* Sleep at least 1ms */
637 msleep( (i_activity+1) * 1000 );
638 vlc_object_lock( p_obj );
641 while( p_obj->i_waiting > 0 )
643 vlc_gc_decref( p_obj->pp_waiting[0] );
644 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
647 vlc_object_unlock( p_obj );
653 * Main loop for secondary preparser queue
654 * \param p_obj items to preparse
657 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
659 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
660 input_item_t *p_item;
663 vlc_object_lock( p_obj );
665 while( vlc_object_alive( p_obj ) )
667 if( p_obj->i_waiting == 0 )
669 vlc_object_wait( p_obj );
673 p_item = p_obj->pp_waiting[0];
674 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
675 vlc_object_unlock( p_obj );
680 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
681 * (This can happen if we fetch art on play)
682 * 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 = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
688 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || 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_object_lock( p_obj );
721 i_activity = var_GetInteger( p_playlist, "activity" );
722 if( i_activity < 0 ) i_activity = 0;
723 vlc_object_unlock( p_obj );
724 /* Sleep at least 1ms */
725 msleep( (i_activity+1) * 1000 );
726 vlc_object_lock( p_obj );
729 while( p_obj->i_waiting > 0 )
731 vlc_gc_decref( p_obj->pp_waiting[0] );
732 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
735 vlc_object_unlock( p_obj );
738 static void VariablesInit( playlist_t *p_playlist )
741 /* These variables control updates */
742 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
744 var_Set( p_playlist, "intf-change", val );
746 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
748 var_Set( p_playlist, "item-change", val );
750 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
752 var_Set( p_playlist, "item-deleted", val );
754 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
756 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
758 var_Set( p_playlist, "playlist-current", val );
760 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
761 var_SetInteger( p_playlist, "activity", 0 );
763 /* Variables to control playback */
764 var_CreateGetBool( p_playlist, "play-and-stop" );
765 var_CreateGetBool( p_playlist, "play-and-exit" );
766 var_CreateGetBool( p_playlist, "random" );
767 var_CreateGetBool( p_playlist, "repeat" );
768 var_CreateGetBool( p_playlist, "loop" );
770 var_AddCallback( p_playlist, "random", RandomCallback, NULL );