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 )
172 vlc_object_release( p_playlist->p_preparse );
174 if( p_playlist->p_fetcher )
175 vlc_object_release( p_playlist->p_fetcher );
177 libvlc_priv (p_this->p_libvlc)->p_playlist = NULL; /* pl_Yield() will fail */
181 /* Destroy remaining objects */
182 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
186 if( mdate() - p_playlist->gc_date < 1000000 )
188 p_playlist->b_cant_sleep = true;
191 else if( p_playlist->gc_date == 0 )
195 vlc_mutex_lock( &p_playlist->gc_lock );
196 /* Remove video outputs when user presses stop: */
197 vlc_list_t *list = vlc_list_find( p_playlist->p_libvlc, VLC_OBJECT_VOUT,
201 msg_Dbg( p_playlist, "removing %u vout(s)", list->i_count );
202 for( int i = 0; i < list->i_count; i++)
203 vlc_object_release( list->p_values[i].p_object );
204 vlc_list_release( list );
206 p_playlist->b_cant_sleep = false;
207 vlc_mutex_unlock( &p_playlist->gc_lock );
211 static void input_state_changed( const vlc_event_t * event, void * data )
214 playlist_t * p_playlist = data;
215 playlist_Signal( p_playlist );
219 static void input_selected_stream_changed( const vlc_event_t * event, void * data )
222 playlist_t * p_playlist = data;
224 p_playlist->gc_date = mdate();
225 vlc_object_signal_unlocked( p_playlist );
230 void playlist_release_current_input( playlist_t * p_playlist )
232 vlc_assert_locked( &(vlc_internals(p_playlist)->lock) );
234 if( !p_playlist->p_input ) return;
236 input_thread_t * p_input = p_playlist->p_input;
237 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
239 vlc_event_detach( p_em, vlc_InputStateChanged,
240 input_state_changed, p_playlist );
241 vlc_event_detach( p_em, vlc_InputSelectedStreamChanged,
242 input_selected_stream_changed, p_playlist );
243 p_playlist->p_input = NULL;
245 /* Release the playlist lock, because we may get stuck
246 * in vlc_object_release() for some time. */
248 vlc_object_release( p_input );
252 void playlist_set_current_input(
253 playlist_t * p_playlist, input_thread_t * p_input )
255 vlc_assert_locked( &(vlc_internals(p_playlist)->lock) );
257 playlist_release_current_input( p_playlist );
261 vlc_object_yield( p_input );
262 p_playlist->p_input = p_input;
263 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
264 vlc_event_attach( p_em, vlc_InputStateChanged,
265 input_state_changed, p_playlist );
266 vlc_event_attach( p_em, vlc_InputSelectedStreamChanged,
267 input_selected_stream_changed, p_playlist );
279 * Main loop for the playlist
280 * \param p_playlist the playlist object
283 void playlist_MainLoop( playlist_t *p_playlist )
285 playlist_item_t *p_item = NULL;
286 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
289 if( p_playlist->b_reset_currently_playing &&
290 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
292 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
293 p_playlist->status.p_item );
294 p_playlist->last_rebuild_date = mdate();
298 /* If there is an input, check that it doesn't need to die. */
299 if( p_playlist->p_input )
301 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
303 PL_DEBUG( "incoming request - stopping current input" );
304 input_StopThread( p_playlist->p_input );
307 /* This input is dead. Remove it ! */
308 if( p_playlist->p_input->b_dead )
311 input_thread_t *p_input;
312 sout_instance_t **pp_sout =
313 &libvlc_priv(p_playlist->p_libvlc)->p_sout;
315 PL_DEBUG( "dead input" );
317 p_input = p_playlist->p_input;
319 assert( *pp_sout == NULL );
320 if( var_CreateGetBool( p_input, "sout-keep" ) )
321 *pp_sout = input_DetachSout( p_input );
324 playlist_release_current_input( p_playlist );
326 p_playlist->gc_date = mdate();
327 p_playlist->b_cant_sleep = true;
329 if( p_playlist->status.p_item->i_flags
330 & PLAYLIST_REMOVE_FLAG )
332 PL_DEBUG( "%s was marked for deletion, deleting",
333 PLI_NAME( p_playlist->status.p_item ) );
334 playlist_ItemDelete( p_playlist->status.p_item );
335 if( p_playlist->request.p_item == p_playlist->status.p_item )
336 p_playlist->request.p_item = NULL;
337 p_playlist->status.p_item = NULL;
340 i_activity= var_GetInteger( p_playlist, "activity" );
341 var_SetInteger( p_playlist, "activity", i_activity -
342 DEFAULT_INPUT_ACTIVITY );
346 /* This input is dying, let it do */
347 else if( p_playlist->p_input->b_die )
349 PL_DEBUG( "dying input" );
351 msleep( INTF_IDLE_SLEEP );
355 /* This input has finished, ask it to die ! */
356 else if( p_playlist->p_input->b_error
357 || p_playlist->p_input->b_eof )
359 PL_DEBUG( "finished input" );
360 input_StopThread( p_playlist->p_input );
361 /* No need to wait here, we'll wait in the p_input->b_die case */
364 else if( p_playlist->p_input->i_state != INIT_S )
367 ObjectGarbageCollector( p_playlist, false );
373 /* No input. Several cases
374 * - No request, running status -> start new item
375 * - No request, stopped status -> collect garbage
376 * - Request, running requested -> start new item
377 * - Request, stopped requested -> collect garbage
379 int i_status = p_playlist->request.b_request ?
380 p_playlist->request.i_status : p_playlist->status.i_status;
381 if( i_status != PLAYLIST_STOPPED )
383 msg_Dbg( p_playlist, "starting new item" );
384 p_item = playlist_NextItem( p_playlist );
388 msg_Dbg( p_playlist, "nothing to play" );
389 p_playlist->status.i_status = PLAYLIST_STOPPED;
392 if( b_playexit == true )
394 msg_Info( p_playlist, "end of playlist, exiting" );
395 vlc_object_kill( p_playlist->p_libvlc );
397 ObjectGarbageCollector( p_playlist, true );
400 playlist_PlayItem( p_playlist, p_item );
404 const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
406 p_playlist->status.i_status = PLAYLIST_STOPPED;
407 if( p_playlist->status.p_item &&
408 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
410 PL_DEBUG( "deleting item marked for deletion" );
411 playlist_ItemDelete( p_playlist->status.p_item );
412 p_playlist->status.p_item = NULL;
415 /* Collect garbage */
417 ObjectGarbageCollector( p_playlist, b_gc_forced );
427 * The playlist is dying so do the last loop
428 * \param p_playlist the playlist object
431 void playlist_LastLoop( playlist_t *p_playlist )
433 /* If there is an input, kill it */
437 if( p_playlist->p_input == NULL )
443 if( p_playlist->p_input->b_dead )
446 playlist_release_current_input( p_playlist );
448 /* sout-keep: no need to anything here.
449 * The last input will destroy its sout, if any, by itself */
454 else if( p_playlist->p_input->b_die )
456 /* This input is dying, leave it alone */
459 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
461 input_StopThread( p_playlist->p_input );
467 p_playlist->p_input->b_eof = 1;
471 msleep( INTF_IDLE_SLEEP );
475 /* close the remaining sout-keep (if there was no input atm) */
476 sout_instance_t *p_sout = libvlc_priv (p_playlist->p_libvlc)->p_sout;
478 sout_DeleteInstance( p_sout );
481 /* Core should have terminated all SDs before the playlist */
482 /* TODO: It fails to do so when not playing anything -- Courmisch */
483 playlist_ServicesDiscoveryKillAll( p_playlist );
484 playlist_MLDump( p_playlist );
487 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
488 free( p_del->pp_children );
489 vlc_gc_decref( p_del->p_input );
492 ARRAY_RESET( p_playlist->all_items );
494 ARRAY_RESET( p_playlist->items );
495 ARRAY_RESET( p_playlist->current );
503 * Main loop for preparser queue
504 * \param p_obj items to preparse
507 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
509 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
510 input_item_t *p_current;
513 vlc_object_lock( p_obj );
515 while( vlc_object_alive( p_obj ) )
517 if( p_obj->i_waiting == 0 )
519 vlc_object_wait( p_obj );
523 p_current = p_obj->pp_waiting[0];
524 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
525 vlc_object_unlock( p_obj );
530 if( p_current->i_type == ITEM_TYPE_FILE )
532 stats_TimerStart( p_playlist, "Preparse run",
533 STATS_TIMER_PREPARSE );
534 /* Do not preparse if it is already done (like by playing it) */
535 if( !input_item_IsPreparsed( p_current ) )
538 input_Preparse( p_playlist, p_current );
541 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
543 input_item_SetPreparsed( p_current, true );
544 var_SetInteger( p_playlist, "item-change", p_current->i_id );
547 /* If we haven't retrieved enough meta, add to secondary queue
548 * which will run the "meta fetchers".
549 * This only checks for meta, not for art
550 * \todo don't do this for things we won't get meta for, like vids
552 char *psz_arturl = input_item_GetArtURL( p_current );
553 char *psz_name = input_item_GetName( p_current );
554 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
555 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
557 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
558 vlc_object_lock( p_playlist->p_fetcher );
559 INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
560 p_playlist->p_fetcher->i_waiting,
561 p_playlist->p_fetcher->i_waiting, p_current);
562 vlc_object_signal_unlocked( p_playlist->p_fetcher );
563 vlc_object_unlock( p_playlist->p_fetcher );
567 PL_DEBUG( "no fetch required for %s (art currently %s)",
568 psz_name, psz_arturl );
569 vlc_gc_decref( p_current );
578 vlc_object_lock( p_obj );
579 i_activity = var_GetInteger( p_playlist, "activity" );
580 if( i_activity < 0 ) i_activity = 0;
581 vlc_object_unlock( p_obj );
582 /* Sleep at least 1ms */
583 msleep( (i_activity+1) * 1000 );
584 vlc_object_lock( p_obj );
586 vlc_object_unlock( p_obj );
592 * Main loop for secondary preparser queue
593 * \param p_obj items to preparse
596 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
598 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
599 input_item_t *p_item;
602 vlc_object_lock( p_obj );
604 while( vlc_object_alive( p_obj ) )
606 if( p_obj->i_waiting == 0 )
608 vlc_object_wait( p_obj );
612 p_item = p_obj->pp_waiting[0];
613 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
614 vlc_object_unlock( p_obj );
619 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
620 * (This can happen if we fetch art on play)
621 * FIXME this doesn't work if we need to fetch meta before art ... */
622 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
626 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
627 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
634 i_ret = input_ArtFind( p_playlist, p_item );
637 PL_DEBUG( "downloading art for %s", p_item->psz_name );
638 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
639 input_item_SetArtNotFound( p_item, true );
641 input_item_SetArtFetched( p_item, true );
642 var_SetInteger( p_playlist, "item-change",
646 else if( i_ret == 0 ) /* Was in cache */
648 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
649 input_item_SetArtFetched( p_item, true );
650 var_SetInteger( p_playlist, "item-change", p_item->i_id );
654 PL_DEBUG( "art not found for %s", p_item->psz_name );
655 input_item_SetArtNotFound( p_item, true );
657 vlc_gc_decref( p_item );
659 vlc_object_lock( p_obj );
660 i_activity = var_GetInteger( p_playlist, "activity" );
661 if( i_activity < 0 ) i_activity = 0;
662 vlc_object_unlock( p_obj );
663 /* Sleep at least 1ms */
664 msleep( (i_activity+1) * 1000 );
665 vlc_object_lock( p_obj );
667 vlc_object_unlock( p_obj );
670 static void VariablesInit( playlist_t *p_playlist )
673 /* These variables control updates */
674 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
676 var_Set( p_playlist, "intf-change", val );
678 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
680 var_Set( p_playlist, "item-change", val );
682 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
684 var_Set( p_playlist, "item-deleted", val );
686 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
688 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
690 var_Set( p_playlist, "playlist-current", val );
692 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
693 var_SetInteger( p_playlist, "activity", 0 );
695 /* Variables to control playback */
696 var_CreateGetBool( p_playlist, "play-and-stop" );
697 var_CreateGetBool( p_playlist, "play-and-exit" );
698 var_CreateGetBool( p_playlist, "random" );
699 var_CreateGetBool( p_playlist, "repeat" );
700 var_CreateGetBool( p_playlist, "loop" );
702 var_AddCallback( p_playlist, "random", RandomCallback, NULL );