1 /*****************************************************************************
2 * engine.c : Run the playlist and handle its control
3 *****************************************************************************
4 * Copyright (C) 1999-2007 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
8 * Clément Stenac <zorglub@videolan.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
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 );
42 static void playlist_Destructor( vlc_object_t * p_this );
44 static int RandomCallback( vlc_object_t *p_this, char const *psz_cmd,
45 vlc_value_t oldval, vlc_value_t newval, void *a )
47 (void)psz_cmd; (void)oldval; (void)newval; (void)a;
49 ((playlist_t*)p_this)->b_reset_currently_playing = true;
50 playlist_Signal( ((playlist_t*)p_this) );
57 * Create a playlist structure.
58 * \param p_parent the vlc object that is to be the parent of this playlist
59 * \return a pointer to the created playlist, or NULL on error
61 playlist_t * playlist_Create( vlc_object_t *p_parent )
63 static const char playlist_name[] = "playlist";
64 playlist_t *p_playlist;
67 /* Allocate structure */
68 p_playlist = vlc_custom_create( p_parent, sizeof( *p_playlist ),
69 VLC_OBJECT_GENERIC, playlist_name );
72 msg_Err( p_parent, "out of memory" );
76 TAB_INIT( p_playlist->i_sds, p_playlist->pp_sds );
78 libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
80 VariablesInit( p_playlist );
82 /* Initialise data structures */
83 vlc_mutex_init( &p_playlist->gc_lock );
84 p_playlist->i_last_playlist_id = 0;
85 p_playlist->p_input = NULL;
87 p_playlist->gc_date = 0;
88 p_playlist->b_cant_sleep = false;
90 ARRAY_INIT( p_playlist->items );
91 ARRAY_INIT( p_playlist->all_items );
92 ARRAY_INIT( p_playlist->current );
94 p_playlist->i_current_index = 0;
95 p_playlist->b_reset_currently_playing = true;
96 p_playlist->last_rebuild_date = 0;
98 p_playlist->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
100 p_playlist->b_doing_ml = false;
102 p_playlist->b_auto_preparse =
103 var_CreateGetBool( p_playlist, "auto-preparse" ) ;
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 );
110 if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
113 /* Create playlist and media library */
114 playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
115 &p_playlist->p_local_category,
116 &p_playlist->p_local_onelevel, false );
118 p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
119 p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
121 if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
122 !p_playlist->p_local_category->p_input ||
123 !p_playlist->p_local_onelevel->p_input )
126 if( config_GetInt( p_playlist, "media-library") )
128 playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
129 &p_playlist->p_ml_category,
130 &p_playlist->p_ml_onelevel, false );
132 if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
135 p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
136 p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
140 p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
144 p_playlist->status.p_item = NULL;
145 p_playlist->status.p_node = p_playlist->p_local_onelevel;
146 p_playlist->request.b_request = false;
147 p_playlist->status.i_status = PLAYLIST_STOPPED;
149 p_playlist->i_sort = SORT_ID;
150 p_playlist->i_order = ORDER_NORMAL;
153 b_save = p_playlist->b_auto_preparse;
154 p_playlist->b_auto_preparse = false;
155 playlist_MLLoad( p_playlist );
156 p_playlist->b_auto_preparse = true;
158 vlc_object_set_destructor( p_playlist, playlist_Destructor );
166 * Destroy a playlist structure.
167 * \param p_playlist the playlist object
171 static void playlist_Destructor( vlc_object_t * p_this )
173 playlist_t * p_playlist = (playlist_t *)p_this;
175 if( p_playlist->p_preparse )
176 vlc_object_release( p_playlist->p_preparse );
178 if( p_playlist->p_fetcher )
179 vlc_object_release( p_playlist->p_fetcher );
181 libvlc_priv (p_this->p_libvlc)->p_playlist = NULL; /* pl_Yield() will fail */
185 /* Destroy remaining objects */
186 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
192 if( mdate() - p_playlist->gc_date < 1000000 )
194 p_playlist->b_cant_sleep = true;
197 else if( p_playlist->gc_date == 0 )
201 vlc_mutex_lock( &p_playlist->gc_lock );
202 p_playlist->b_cant_sleep = false;
203 vlc_mutex_unlock( &p_playlist->gc_lock );
207 static void input_state_changed( const vlc_event_t * event, void * data )
210 playlist_t * p_playlist = data;
211 playlist_Signal( p_playlist );
215 static void input_selected_stream_changed( const vlc_event_t * event, void * data )
218 playlist_t * p_playlist = data;
220 p_playlist->gc_date = mdate();
221 vlc_object_signal_unlocked( p_playlist );
226 void playlist_release_current_input( playlist_t * p_playlist )
228 vlc_assert_locked( &p_playlist->object_lock );
230 if( !p_playlist->p_input ) return;
232 input_thread_t * p_input = p_playlist->p_input;
233 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
235 vlc_event_detach( p_em, vlc_InputStateChanged,
236 input_state_changed, p_playlist );
237 vlc_event_detach( p_em, vlc_InputSelectedStreamChanged,
238 input_selected_stream_changed, p_playlist );
239 p_playlist->p_input = NULL;
241 /* Release the playlist lock, because we may get stuck
242 * in vlc_object_release() for some time. */
244 vlc_object_release( p_input );
248 void playlist_set_current_input(
249 playlist_t * p_playlist, input_thread_t * p_input )
251 vlc_assert_locked( &p_playlist->object_lock );
253 playlist_release_current_input( p_playlist );
257 vlc_object_yield( p_input );
258 p_playlist->p_input = p_input;
259 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
260 vlc_event_attach( p_em, vlc_InputStateChanged,
261 input_state_changed, p_playlist );
262 vlc_event_attach( p_em, vlc_InputSelectedStreamChanged,
263 input_selected_stream_changed, p_playlist );
275 * Main loop for the playlist
276 * \param p_playlist the playlist object
279 void playlist_MainLoop( playlist_t *p_playlist )
281 playlist_item_t *p_item = NULL;
282 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
285 if( p_playlist->b_reset_currently_playing &&
286 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
288 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
289 p_playlist->status.p_item );
290 p_playlist->last_rebuild_date = mdate();
294 /* If there is an input, check that it doesn't need to die. */
295 if( p_playlist->p_input )
297 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
299 PL_DEBUG( "incoming request - stopping current input" );
300 input_StopThread( p_playlist->p_input );
303 /* This input is dead. Remove it ! */
304 if( p_playlist->p_input->b_dead )
307 input_thread_t *p_input;
308 sout_instance_t **pp_sout =
309 &libvlc_priv(p_playlist->p_libvlc)->p_sout;
311 PL_DEBUG( "dead input" );
313 p_input = p_playlist->p_input;
315 assert( *pp_sout == NULL );
316 if( var_CreateGetBool( p_input, "sout-keep" ) )
317 *pp_sout = input_DetachSout( p_input );
320 playlist_release_current_input( p_playlist );
322 p_playlist->gc_date = mdate();
323 p_playlist->b_cant_sleep = true;
325 if( p_playlist->status.p_item->i_flags
326 & PLAYLIST_REMOVE_FLAG )
328 PL_DEBUG( "%s was marked for deletion, deleting",
329 PLI_NAME( p_playlist->status.p_item ) );
330 playlist_ItemDelete( p_playlist->status.p_item );
331 if( p_playlist->request.p_item == p_playlist->status.p_item )
332 p_playlist->request.p_item = NULL;
333 p_playlist->status.p_item = NULL;
336 i_activity= var_GetInteger( p_playlist, "activity" );
337 var_SetInteger( p_playlist, "activity", i_activity -
338 DEFAULT_INPUT_ACTIVITY );
342 /* This input is dying, let it do */
343 else if( p_playlist->p_input->b_die )
345 PL_DEBUG( "dying input" );
347 msleep( INTF_IDLE_SLEEP );
351 /* This input has finished, ask it to die ! */
352 else if( p_playlist->p_input->b_error
353 || p_playlist->p_input->b_eof )
355 PL_DEBUG( "finished input" );
356 input_StopThread( p_playlist->p_input );
357 /* No need to wait here, we'll wait in the p_input->b_die case */
360 else if( p_playlist->p_input->i_state != INIT_S )
363 ObjectGarbageCollector( p_playlist, false );
369 /* No input. Several cases
370 * - No request, running status -> start new item
371 * - No request, stopped status -> collect garbage
372 * - Request, running requested -> start new item
373 * - Request, stopped requested -> collect garbage
375 int i_status = p_playlist->request.b_request ?
376 p_playlist->request.i_status : p_playlist->status.i_status;
377 if( i_status != PLAYLIST_STOPPED )
379 msg_Dbg( p_playlist, "starting new item" );
380 p_item = playlist_NextItem( p_playlist );
384 msg_Dbg( p_playlist, "nothing to play" );
385 p_playlist->status.i_status = PLAYLIST_STOPPED;
388 if( b_playexit == true )
390 msg_Info( p_playlist, "end of playlist, exiting" );
391 vlc_object_kill( p_playlist->p_libvlc );
393 ObjectGarbageCollector( p_playlist, true );
396 playlist_PlayItem( p_playlist, p_item );
400 const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
402 p_playlist->status.i_status = PLAYLIST_STOPPED;
403 if( p_playlist->status.p_item &&
404 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
406 PL_DEBUG( "deleting item marked for deletion" );
407 playlist_ItemDelete( p_playlist->status.p_item );
408 p_playlist->status.p_item = NULL;
411 /* Collect garbage */
413 ObjectGarbageCollector( p_playlist, b_gc_forced );
423 * The playlist is dying so do the last loop
424 * \param p_playlist the playlist object
427 void playlist_LastLoop( playlist_t *p_playlist )
431 /* If there is an input, kill it */
435 if( p_playlist->p_input == NULL )
441 if( p_playlist->p_input->b_dead )
444 playlist_release_current_input( p_playlist );
446 /* sout-keep: no need to anything here.
447 * The last input will destroy its sout, if any, by itself */
452 else if( p_playlist->p_input->b_die )
454 /* This input is dying, leave it alone */
457 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
459 input_StopThread( p_playlist->p_input );
465 p_playlist->p_input->b_eof = 1;
469 msleep( INTF_IDLE_SLEEP );
473 /* close the remaining sout-keep (if there was no input atm) */
474 sout_instance_t *p_sout = libvlc_priv (p_playlist->p_libvlc)->p_sout;
476 sout_DeleteInstance( p_sout );
479 /* Core should have terminated all SDs before the playlist */
480 assert( p_playlist->i_sds == 0 );
481 playlist_MLDump( p_playlist );
484 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
485 free( p_del->pp_children );
486 vlc_gc_decref( p_del->p_input );
489 ARRAY_RESET( p_playlist->all_items );
491 ARRAY_RESET( p_playlist->items );
492 ARRAY_RESET( p_playlist->current );
500 * Main loop for preparser queue
501 * \param p_obj items to preparse
504 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
506 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
507 input_item_t *p_current;
510 vlc_object_lock( p_obj );
512 while( vlc_object_alive( p_obj ) )
514 if( p_obj->i_waiting == 0 )
516 vlc_object_wait( p_obj );
520 p_current = p_obj->pp_waiting[0];
521 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
522 vlc_object_unlock( p_obj );
527 if( p_current->i_type == ITEM_TYPE_FILE )
529 stats_TimerStart( p_playlist, "Preparse run",
530 STATS_TIMER_PREPARSE );
531 /* Do not preparse if it is already done (like by playing it) */
532 if( !input_item_IsPreparsed( p_current ) )
535 input_Preparse( p_playlist, p_current );
538 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
540 input_item_SetPreparsed( p_current, true );
541 var_SetInteger( p_playlist, "item-change", p_current->i_id );
544 /* If we haven't retrieved enough meta, add to secondary queue
545 * which will run the "meta fetchers".
546 * This only checks for meta, not for art
547 * \todo don't do this for things we won't get meta for, like vids
549 char *psz_arturl = input_item_GetArtURL( p_current );
550 char *psz_name = input_item_GetName( p_current );
551 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
552 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
554 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
555 vlc_object_lock( p_playlist->p_fetcher );
556 INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
557 p_playlist->p_fetcher->i_waiting,
558 p_playlist->p_fetcher->i_waiting, p_current);
559 vlc_object_signal_unlocked( p_playlist->p_fetcher );
560 vlc_object_unlock( p_playlist->p_fetcher );
564 PL_DEBUG( "no fetch required for %s (art currently %s)",
565 psz_name, psz_arturl );
566 vlc_gc_decref( p_current );
575 vlc_object_lock( p_obj );
576 i_activity = var_GetInteger( p_playlist, "activity" );
577 if( i_activity < 0 ) i_activity = 0;
578 vlc_object_unlock( p_obj );
579 /* Sleep at least 1ms */
580 msleep( (i_activity+1) * 1000 );
581 vlc_object_lock( p_obj );
583 vlc_object_unlock( p_obj );
589 * Main loop for secondary preparser queue
590 * \param p_obj items to preparse
593 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
595 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
596 input_item_t *p_item;
599 vlc_object_lock( p_obj );
601 while( vlc_object_alive( p_obj ) )
603 if( p_obj->i_waiting == 0 )
605 vlc_object_wait( p_obj );
609 p_item = p_obj->pp_waiting[0];
610 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
611 vlc_object_unlock( p_obj );
616 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
617 * (This can happen if we fetch art on play)
618 * FIXME this doesn't work if we need to fetch meta before art ... */
619 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
623 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
624 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
631 i_ret = input_ArtFind( p_playlist, p_item );
634 PL_DEBUG( "downloading art for %s", p_item->psz_name );
635 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
636 input_item_SetArtNotFound( p_item, true );
638 input_item_SetArtFetched( p_item, true );
639 var_SetInteger( p_playlist, "item-change",
643 else if( i_ret == 0 ) /* Was in cache */
645 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
646 input_item_SetArtFetched( p_item, true );
647 var_SetInteger( p_playlist, "item-change", p_item->i_id );
651 PL_DEBUG( "art not found for %s", p_item->psz_name );
652 input_item_SetArtNotFound( p_item, true );
654 vlc_gc_decref( p_item );
656 vlc_object_lock( p_obj );
657 i_activity = var_GetInteger( p_playlist, "activity" );
658 if( i_activity < 0 ) i_activity = 0;
659 vlc_object_unlock( p_obj );
660 /* Sleep at least 1ms */
661 msleep( (i_activity+1) * 1000 );
662 vlc_object_lock( p_obj );
664 vlc_object_unlock( p_obj );
667 static void VariablesInit( playlist_t *p_playlist )
670 /* These variables control updates */
671 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
673 var_Set( p_playlist, "intf-change", val );
675 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
677 var_Set( p_playlist, "item-change", val );
679 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
681 var_Set( p_playlist, "item-deleted", val );
683 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
685 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
687 var_Set( p_playlist, "playlist-current", val );
689 var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
691 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
692 var_SetInteger( p_playlist, "activity", 0 );
694 /* Variables to control playback */
695 var_CreateGetBool( p_playlist, "play-and-stop" );
696 var_CreateGetBool( p_playlist, "play-and-exit" );
697 var_CreateGetBool( p_playlist, "random" );
698 var_CreateGetBool( p_playlist, "repeat" );
699 var_CreateGetBool( p_playlist, "loop" );
701 var_AddCallback( p_playlist, "random", RandomCallback, NULL );