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 )
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 while( ( p_obj = vlc_object_find( p_playlist->p_libvlc, VLC_OBJECT_VOUT,
201 vlc_object_release( p_obj );
202 if( p_obj->p_parent == VLC_OBJECT(p_playlist->p_libvlc) )
204 msg_Dbg( p_playlist, "garbage collector destroying 1 vout" );
205 vlc_object_release( p_obj ); /* Hmm, is this (thread-)safe?? */
208 p_playlist->b_cant_sleep = false;
209 vlc_mutex_unlock( &p_playlist->gc_lock );
213 static void input_state_changed( const vlc_event_t * event, void * data )
216 playlist_t * p_playlist = data;
217 playlist_Signal( p_playlist );
221 static void input_selected_stream_changed( const vlc_event_t * event, void * data )
224 playlist_t * p_playlist = data;
226 p_playlist->gc_date = mdate();
227 vlc_object_signal_unlocked( p_playlist );
232 void playlist_release_current_input( playlist_t * p_playlist )
234 vlc_assert_locked( &(vlc_internals(p_playlist)->lock) );
236 if( !p_playlist->p_input ) return;
238 input_thread_t * p_input = p_playlist->p_input;
239 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
241 vlc_event_detach( p_em, vlc_InputStateChanged,
242 input_state_changed, p_playlist );
243 vlc_event_detach( p_em, vlc_InputSelectedStreamChanged,
244 input_selected_stream_changed, p_playlist );
245 p_playlist->p_input = NULL;
247 /* Release the playlist lock, because we may get stuck
248 * in vlc_object_release() for some time. */
250 vlc_object_release( p_input );
254 void playlist_set_current_input(
255 playlist_t * p_playlist, input_thread_t * p_input )
257 vlc_assert_locked( &(vlc_internals(p_playlist)->lock) );
259 playlist_release_current_input( p_playlist );
263 vlc_object_yield( p_input );
264 p_playlist->p_input = p_input;
265 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
266 vlc_event_attach( p_em, vlc_InputStateChanged,
267 input_state_changed, p_playlist );
268 vlc_event_attach( p_em, vlc_InputSelectedStreamChanged,
269 input_selected_stream_changed, p_playlist );
281 * Main loop for the playlist
282 * \param p_playlist the playlist object
285 void playlist_MainLoop( playlist_t *p_playlist )
287 playlist_item_t *p_item = NULL;
288 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
291 if( p_playlist->b_reset_currently_playing &&
292 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
294 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
295 p_playlist->status.p_item );
296 p_playlist->last_rebuild_date = mdate();
300 /* If there is an input, check that it doesn't need to die. */
301 if( p_playlist->p_input )
303 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
305 PL_DEBUG( "incoming request - stopping current input" );
306 input_StopThread( p_playlist->p_input );
309 /* This input is dead. Remove it ! */
310 if( p_playlist->p_input->b_dead )
313 input_thread_t *p_input;
314 sout_instance_t **pp_sout =
315 &libvlc_priv(p_playlist->p_libvlc)->p_sout;
317 PL_DEBUG( "dead input" );
319 p_input = p_playlist->p_input;
321 assert( *pp_sout == NULL );
322 if( var_CreateGetBool( p_input, "sout-keep" ) )
323 *pp_sout = input_DetachSout( p_input );
326 playlist_release_current_input( p_playlist );
328 p_playlist->gc_date = mdate();
329 p_playlist->b_cant_sleep = true;
331 if( p_playlist->status.p_item->i_flags
332 & PLAYLIST_REMOVE_FLAG )
334 PL_DEBUG( "%s was marked for deletion, deleting",
335 PLI_NAME( p_playlist->status.p_item ) );
336 playlist_ItemDelete( p_playlist->status.p_item );
337 if( p_playlist->request.p_item == p_playlist->status.p_item )
338 p_playlist->request.p_item = NULL;
339 p_playlist->status.p_item = NULL;
342 i_activity= var_GetInteger( p_playlist, "activity" );
343 var_SetInteger( p_playlist, "activity", i_activity -
344 DEFAULT_INPUT_ACTIVITY );
348 /* This input is dying, let it do */
349 else if( p_playlist->p_input->b_die )
351 PL_DEBUG( "dying input" );
353 msleep( INTF_IDLE_SLEEP );
357 /* This input has finished, ask it to die ! */
358 else if( p_playlist->p_input->b_error
359 || p_playlist->p_input->b_eof )
361 PL_DEBUG( "finished input" );
362 input_StopThread( p_playlist->p_input );
363 /* No need to wait here, we'll wait in the p_input->b_die case */
366 else if( p_playlist->p_input->i_state != INIT_S )
369 ObjectGarbageCollector( p_playlist, false );
375 /* No input. Several cases
376 * - No request, running status -> start new item
377 * - No request, stopped status -> collect garbage
378 * - Request, running requested -> start new item
379 * - Request, stopped requested -> collect garbage
381 int i_status = p_playlist->request.b_request ?
382 p_playlist->request.i_status : p_playlist->status.i_status;
383 if( i_status != PLAYLIST_STOPPED )
385 msg_Dbg( p_playlist, "starting new item" );
386 p_item = playlist_NextItem( p_playlist );
390 msg_Dbg( p_playlist, "nothing to play" );
391 p_playlist->status.i_status = PLAYLIST_STOPPED;
394 if( b_playexit == true )
396 msg_Info( p_playlist, "end of playlist, exiting" );
397 vlc_object_kill( p_playlist->p_libvlc );
399 ObjectGarbageCollector( p_playlist, true );
402 playlist_PlayItem( p_playlist, p_item );
406 const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
408 p_playlist->status.i_status = PLAYLIST_STOPPED;
409 if( p_playlist->status.p_item &&
410 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
412 PL_DEBUG( "deleting item marked for deletion" );
413 playlist_ItemDelete( p_playlist->status.p_item );
414 p_playlist->status.p_item = NULL;
417 /* Collect garbage */
419 ObjectGarbageCollector( p_playlist, b_gc_forced );
429 * The playlist is dying so do the last loop
430 * \param p_playlist the playlist object
433 void playlist_LastLoop( playlist_t *p_playlist )
435 /* If there is an input, kill it */
439 if( p_playlist->p_input == NULL )
445 if( p_playlist->p_input->b_dead )
448 playlist_release_current_input( p_playlist );
450 /* sout-keep: no need to anything here.
451 * The last input will destroy its sout, if any, by itself */
456 else if( p_playlist->p_input->b_die )
458 /* This input is dying, leave it alone */
461 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
463 input_StopThread( p_playlist->p_input );
469 p_playlist->p_input->b_eof = 1;
473 msleep( INTF_IDLE_SLEEP );
477 /* close the remaining sout-keep (if there was no input atm) */
478 sout_instance_t *p_sout = libvlc_priv (p_playlist->p_libvlc)->p_sout;
480 sout_DeleteInstance( p_sout );
483 /* Core should have terminated all SDs before the playlist */
484 /* TODO: It fails to do so when not playing anything -- Courmisch */
485 playlist_ServicesDiscoveryKillAll( p_playlist );
486 playlist_MLDump( p_playlist );
489 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
490 free( p_del->pp_children );
491 vlc_gc_decref( p_del->p_input );
494 ARRAY_RESET( p_playlist->all_items );
496 ARRAY_RESET( p_playlist->items );
497 ARRAY_RESET( p_playlist->current );
505 * Main loop for preparser queue
506 * \param p_obj items to preparse
509 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
511 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
512 input_item_t *p_current;
515 vlc_object_lock( p_obj );
517 while( vlc_object_alive( p_obj ) )
519 if( p_obj->i_waiting == 0 )
521 vlc_object_wait( p_obj );
525 p_current = p_obj->pp_waiting[0];
526 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
527 vlc_object_unlock( p_obj );
532 if( p_current->i_type == ITEM_TYPE_FILE )
534 stats_TimerStart( p_playlist, "Preparse run",
535 STATS_TIMER_PREPARSE );
536 /* Do not preparse if it is already done (like by playing it) */
537 if( !input_item_IsPreparsed( p_current ) )
540 input_Preparse( p_playlist, p_current );
543 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
545 input_item_SetPreparsed( p_current, true );
546 var_SetInteger( p_playlist, "item-change", p_current->i_id );
549 /* If we haven't retrieved enough meta, add to secondary queue
550 * which will run the "meta fetchers".
551 * This only checks for meta, not for art
552 * \todo don't do this for things we won't get meta for, like vids
554 char *psz_arturl = input_item_GetArtURL( p_current );
555 char *psz_name = input_item_GetName( p_current );
556 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
557 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
559 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
560 vlc_object_lock( p_playlist->p_fetcher );
561 INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
562 p_playlist->p_fetcher->i_waiting,
563 p_playlist->p_fetcher->i_waiting, p_current);
564 vlc_object_signal_unlocked( p_playlist->p_fetcher );
565 vlc_object_unlock( p_playlist->p_fetcher );
569 PL_DEBUG( "no fetch required for %s (art currently %s)",
570 psz_name, psz_arturl );
571 vlc_gc_decref( p_current );
580 vlc_object_lock( p_obj );
581 i_activity = var_GetInteger( p_playlist, "activity" );
582 if( i_activity < 0 ) i_activity = 0;
583 vlc_object_unlock( p_obj );
584 /* Sleep at least 1ms */
585 msleep( (i_activity+1) * 1000 );
586 vlc_object_lock( p_obj );
588 vlc_object_unlock( p_obj );
594 * Main loop for secondary preparser queue
595 * \param p_obj items to preparse
598 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
600 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
601 input_item_t *p_item;
604 vlc_object_lock( p_obj );
606 while( vlc_object_alive( p_obj ) )
608 if( p_obj->i_waiting == 0 )
610 vlc_object_wait( p_obj );
614 p_item = p_obj->pp_waiting[0];
615 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
616 vlc_object_unlock( p_obj );
621 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
622 * (This can happen if we fetch art on play)
623 * FIXME this doesn't work if we need to fetch meta before art ... */
624 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
628 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
629 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
636 i_ret = input_ArtFind( p_playlist, p_item );
639 PL_DEBUG( "downloading art for %s", p_item->psz_name );
640 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
641 input_item_SetArtNotFound( p_item, true );
643 input_item_SetArtFetched( p_item, true );
644 var_SetInteger( p_playlist, "item-change",
648 else if( i_ret == 0 ) /* Was in cache */
650 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
651 input_item_SetArtFetched( p_item, true );
652 var_SetInteger( p_playlist, "item-change", p_item->i_id );
656 PL_DEBUG( "art not found for %s", p_item->psz_name );
657 input_item_SetArtNotFound( p_item, true );
659 vlc_gc_decref( p_item );
661 vlc_object_lock( p_obj );
662 i_activity = var_GetInteger( p_playlist, "activity" );
663 if( i_activity < 0 ) i_activity = 0;
664 vlc_object_unlock( p_obj );
665 /* Sleep at least 1ms */
666 msleep( (i_activity+1) * 1000 );
667 vlc_object_lock( p_obj );
669 vlc_object_unlock( p_obj );
672 static void VariablesInit( playlist_t *p_playlist )
675 /* These variables control updates */
676 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
678 var_Set( p_playlist, "intf-change", val );
680 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
682 var_Set( p_playlist, "item-change", val );
684 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
686 var_Set( p_playlist, "item-deleted", val );
688 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
690 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
692 var_Set( p_playlist, "playlist-current", val );
694 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
695 var_SetInteger( p_playlist, "activity", 0 );
697 /* Variables to control playback */
698 var_CreateGetBool( p_playlist, "play-and-stop" );
699 var_CreateGetBool( p_playlist, "play-and-exit" );
700 var_CreateGetBool( p_playlist, "random" );
701 var_CreateGetBool( p_playlist, "repeat" );
702 var_CreateGetBool( p_playlist, "loop" );
704 var_AddCallback( p_playlist, "random", RandomCallback, NULL );