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 );
73 TAB_INIT( p_playlist->i_sds, p_playlist->pp_sds );
75 libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
77 VariablesInit( p_playlist );
79 /* Initialise data structures */
80 vlc_mutex_init( &p_playlist->gc_lock );
81 p_playlist->i_last_playlist_id = 0;
82 p_playlist->p_input = NULL;
84 p_playlist->gc_date = 0;
85 p_playlist->b_cant_sleep = false;
87 ARRAY_INIT( p_playlist->items );
88 ARRAY_INIT( p_playlist->all_items );
89 ARRAY_INIT( p_playlist->current );
91 p_playlist->i_current_index = 0;
92 p_playlist->b_reset_currently_playing = true;
93 p_playlist->last_rebuild_date = 0;
95 p_playlist->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
97 p_playlist->b_doing_ml = false;
99 p_playlist->b_auto_preparse =
100 var_CreateGetBool( p_playlist, "auto-preparse" ) ;
102 p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
104 p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
105 0, p_playlist->p_root_category->p_input );
107 if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
110 /* Create playlist and media library */
111 playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
112 &p_playlist->p_local_category,
113 &p_playlist->p_local_onelevel, false );
115 p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
116 p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
118 if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
119 !p_playlist->p_local_category->p_input ||
120 !p_playlist->p_local_onelevel->p_input )
123 if( config_GetInt( p_playlist, "media-library") )
125 playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
126 &p_playlist->p_ml_category,
127 &p_playlist->p_ml_onelevel, false );
129 if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
132 p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
133 p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
137 p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
141 p_playlist->status.p_item = NULL;
142 p_playlist->status.p_node = p_playlist->p_local_onelevel;
143 p_playlist->request.b_request = false;
144 p_playlist->status.i_status = PLAYLIST_STOPPED;
146 p_playlist->i_sort = SORT_ID;
147 p_playlist->i_order = ORDER_NORMAL;
150 b_save = p_playlist->b_auto_preparse;
151 p_playlist->b_auto_preparse = false;
152 playlist_MLLoad( p_playlist );
153 p_playlist->b_auto_preparse = true;
155 vlc_object_set_destructor( p_playlist, playlist_Destructor );
163 * Destroy a playlist structure.
164 * \param p_playlist the playlist object
168 static void playlist_Destructor( vlc_object_t * p_this )
170 playlist_t * p_playlist = (playlist_t *)p_this;
172 if( p_playlist->p_preparse )
173 vlc_object_release( p_playlist->p_preparse );
175 if( p_playlist->p_fetcher )
176 vlc_object_release( p_playlist->p_fetcher );
178 libvlc_priv (p_this->p_libvlc)->p_playlist = NULL; /* pl_Yield() will fail */
182 /* Destroy remaining objects */
183 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
189 if( mdate() - p_playlist->gc_date < 1000000 )
191 p_playlist->b_cant_sleep = true;
194 else if( p_playlist->gc_date == 0 )
198 vlc_mutex_lock( &p_playlist->gc_lock );
199 p_playlist->b_cant_sleep = false;
200 vlc_mutex_unlock( &p_playlist->gc_lock );
204 static void input_state_changed( const vlc_event_t * event, void * data )
207 playlist_t * p_playlist = data;
208 playlist_Signal( p_playlist );
212 static void input_selected_stream_changed( const vlc_event_t * event, void * data )
215 playlist_t * p_playlist = data;
217 p_playlist->gc_date = mdate();
218 vlc_object_signal_unlocked( p_playlist );
223 void playlist_release_current_input( playlist_t * p_playlist )
225 vlc_assert_locked( &(vlc_internals(p_playlist)->lock) );
227 if( !p_playlist->p_input ) return;
229 input_thread_t * p_input = p_playlist->p_input;
230 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
232 vlc_event_detach( p_em, vlc_InputStateChanged,
233 input_state_changed, p_playlist );
234 vlc_event_detach( p_em, vlc_InputSelectedStreamChanged,
235 input_selected_stream_changed, p_playlist );
236 p_playlist->p_input = NULL;
238 /* Release the playlist lock, because we may get stuck
239 * in vlc_object_release() for some time. */
241 vlc_object_release( p_input );
245 void playlist_set_current_input(
246 playlist_t * p_playlist, input_thread_t * p_input )
248 vlc_assert_locked( &(vlc_internals(p_playlist)->lock) );
250 playlist_release_current_input( p_playlist );
254 vlc_object_yield( p_input );
255 p_playlist->p_input = p_input;
256 vlc_event_manager_t * p_em = input_get_event_manager( p_input );
257 vlc_event_attach( p_em, vlc_InputStateChanged,
258 input_state_changed, p_playlist );
259 vlc_event_attach( p_em, vlc_InputSelectedStreamChanged,
260 input_selected_stream_changed, p_playlist );
272 * Main loop for the playlist
273 * \param p_playlist the playlist object
276 void playlist_MainLoop( playlist_t *p_playlist )
278 playlist_item_t *p_item = NULL;
279 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
282 if( p_playlist->b_reset_currently_playing &&
283 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
285 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
286 p_playlist->status.p_item );
287 p_playlist->last_rebuild_date = mdate();
291 /* If there is an input, check that it doesn't need to die. */
292 if( p_playlist->p_input )
294 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
296 PL_DEBUG( "incoming request - stopping current input" );
297 input_StopThread( p_playlist->p_input );
300 /* This input is dead. Remove it ! */
301 if( p_playlist->p_input->b_dead )
304 input_thread_t *p_input;
305 sout_instance_t **pp_sout =
306 &libvlc_priv(p_playlist->p_libvlc)->p_sout;
308 PL_DEBUG( "dead input" );
310 p_input = p_playlist->p_input;
312 assert( *pp_sout == NULL );
313 if( var_CreateGetBool( p_input, "sout-keep" ) )
314 *pp_sout = input_DetachSout( p_input );
317 playlist_release_current_input( p_playlist );
319 p_playlist->gc_date = mdate();
320 p_playlist->b_cant_sleep = true;
322 if( p_playlist->status.p_item->i_flags
323 & PLAYLIST_REMOVE_FLAG )
325 PL_DEBUG( "%s was marked for deletion, deleting",
326 PLI_NAME( p_playlist->status.p_item ) );
327 playlist_ItemDelete( p_playlist->status.p_item );
328 if( p_playlist->request.p_item == p_playlist->status.p_item )
329 p_playlist->request.p_item = NULL;
330 p_playlist->status.p_item = NULL;
333 i_activity= var_GetInteger( p_playlist, "activity" );
334 var_SetInteger( p_playlist, "activity", i_activity -
335 DEFAULT_INPUT_ACTIVITY );
339 /* This input is dying, let it do */
340 else if( p_playlist->p_input->b_die )
342 PL_DEBUG( "dying input" );
344 msleep( INTF_IDLE_SLEEP );
348 /* This input has finished, ask it to die ! */
349 else if( p_playlist->p_input->b_error
350 || p_playlist->p_input->b_eof )
352 PL_DEBUG( "finished input" );
353 input_StopThread( p_playlist->p_input );
354 /* No need to wait here, we'll wait in the p_input->b_die case */
357 else if( p_playlist->p_input->i_state != INIT_S )
360 ObjectGarbageCollector( p_playlist, false );
366 /* No input. Several cases
367 * - No request, running status -> start new item
368 * - No request, stopped status -> collect garbage
369 * - Request, running requested -> start new item
370 * - Request, stopped requested -> collect garbage
372 int i_status = p_playlist->request.b_request ?
373 p_playlist->request.i_status : p_playlist->status.i_status;
374 if( i_status != PLAYLIST_STOPPED )
376 msg_Dbg( p_playlist, "starting new item" );
377 p_item = playlist_NextItem( p_playlist );
381 msg_Dbg( p_playlist, "nothing to play" );
382 p_playlist->status.i_status = PLAYLIST_STOPPED;
385 if( b_playexit == true )
387 msg_Info( p_playlist, "end of playlist, exiting" );
388 vlc_object_kill( p_playlist->p_libvlc );
390 ObjectGarbageCollector( p_playlist, true );
393 playlist_PlayItem( p_playlist, p_item );
397 const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
399 p_playlist->status.i_status = PLAYLIST_STOPPED;
400 if( p_playlist->status.p_item &&
401 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
403 PL_DEBUG( "deleting item marked for deletion" );
404 playlist_ItemDelete( p_playlist->status.p_item );
405 p_playlist->status.p_item = NULL;
408 /* Collect garbage */
410 ObjectGarbageCollector( p_playlist, b_gc_forced );
420 * The playlist is dying so do the last loop
421 * \param p_playlist the playlist object
424 void playlist_LastLoop( playlist_t *p_playlist )
428 /* If there is an input, kill it */
432 if( p_playlist->p_input == NULL )
438 if( p_playlist->p_input->b_dead )
441 playlist_release_current_input( p_playlist );
443 /* sout-keep: no need to anything here.
444 * The last input will destroy its sout, if any, by itself */
449 else if( p_playlist->p_input->b_die )
451 /* This input is dying, leave it alone */
454 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
456 input_StopThread( p_playlist->p_input );
462 p_playlist->p_input->b_eof = 1;
466 msleep( INTF_IDLE_SLEEP );
470 /* close the remaining sout-keep (if there was no input atm) */
471 sout_instance_t *p_sout = libvlc_priv (p_playlist->p_libvlc)->p_sout;
473 sout_DeleteInstance( p_sout );
476 /* Core should have terminated all SDs before the playlist */
477 /* TODO: It fails to do so when not playing anything -- Courmisch */
478 playlist_ServicesDiscoveryKillAll( p_playlist );
479 playlist_MLDump( p_playlist );
482 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
483 free( p_del->pp_children );
484 vlc_gc_decref( p_del->p_input );
487 ARRAY_RESET( p_playlist->all_items );
489 ARRAY_RESET( p_playlist->items );
490 ARRAY_RESET( p_playlist->current );
498 * Main loop for preparser queue
499 * \param p_obj items to preparse
502 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
504 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
505 input_item_t *p_current;
508 vlc_object_lock( p_obj );
510 while( vlc_object_alive( p_obj ) )
512 if( p_obj->i_waiting == 0 )
514 vlc_object_wait( p_obj );
518 p_current = p_obj->pp_waiting[0];
519 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
520 vlc_object_unlock( p_obj );
525 if( p_current->i_type == ITEM_TYPE_FILE )
527 stats_TimerStart( p_playlist, "Preparse run",
528 STATS_TIMER_PREPARSE );
529 /* Do not preparse if it is already done (like by playing it) */
530 if( !input_item_IsPreparsed( p_current ) )
533 input_Preparse( p_playlist, p_current );
536 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
538 input_item_SetPreparsed( p_current, true );
539 var_SetInteger( p_playlist, "item-change", p_current->i_id );
542 /* If we haven't retrieved enough meta, add to secondary queue
543 * which will run the "meta fetchers".
544 * This only checks for meta, not for art
545 * \todo don't do this for things we won't get meta for, like vids
547 char *psz_arturl = input_item_GetArtURL( p_current );
548 char *psz_name = input_item_GetName( p_current );
549 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
550 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
552 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
553 vlc_object_lock( p_playlist->p_fetcher );
554 INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
555 p_playlist->p_fetcher->i_waiting,
556 p_playlist->p_fetcher->i_waiting, p_current);
557 vlc_object_signal_unlocked( p_playlist->p_fetcher );
558 vlc_object_unlock( p_playlist->p_fetcher );
562 PL_DEBUG( "no fetch required for %s (art currently %s)",
563 psz_name, psz_arturl );
564 vlc_gc_decref( p_current );
573 vlc_object_lock( p_obj );
574 i_activity = var_GetInteger( p_playlist, "activity" );
575 if( i_activity < 0 ) i_activity = 0;
576 vlc_object_unlock( p_obj );
577 /* Sleep at least 1ms */
578 msleep( (i_activity+1) * 1000 );
579 vlc_object_lock( p_obj );
581 vlc_object_unlock( p_obj );
587 * Main loop for secondary preparser queue
588 * \param p_obj items to preparse
591 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
593 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
594 input_item_t *p_item;
597 vlc_object_lock( p_obj );
599 while( vlc_object_alive( p_obj ) )
601 if( p_obj->i_waiting == 0 )
603 vlc_object_wait( p_obj );
607 p_item = p_obj->pp_waiting[0];
608 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
609 vlc_object_unlock( p_obj );
614 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
615 * (This can happen if we fetch art on play)
616 * FIXME this doesn't work if we need to fetch meta before art ... */
617 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
621 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
622 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
629 i_ret = input_ArtFind( p_playlist, p_item );
632 PL_DEBUG( "downloading art for %s", p_item->psz_name );
633 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
634 input_item_SetArtNotFound( p_item, true );
636 input_item_SetArtFetched( p_item, true );
637 var_SetInteger( p_playlist, "item-change",
641 else if( i_ret == 0 ) /* Was in cache */
643 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
644 input_item_SetArtFetched( p_item, true );
645 var_SetInteger( p_playlist, "item-change", p_item->i_id );
649 PL_DEBUG( "art not found for %s", p_item->psz_name );
650 input_item_SetArtNotFound( p_item, true );
652 vlc_gc_decref( p_item );
654 vlc_object_lock( p_obj );
655 i_activity = var_GetInteger( p_playlist, "activity" );
656 if( i_activity < 0 ) i_activity = 0;
657 vlc_object_unlock( p_obj );
658 /* Sleep at least 1ms */
659 msleep( (i_activity+1) * 1000 );
660 vlc_object_lock( p_obj );
662 vlc_object_unlock( p_obj );
665 static void VariablesInit( playlist_t *p_playlist )
668 /* These variables control updates */
669 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
671 var_Set( p_playlist, "intf-change", val );
673 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
675 var_Set( p_playlist, "item-change", val );
677 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
679 var_Set( p_playlist, "item-deleted", val );
681 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
683 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
685 var_Set( p_playlist, "playlist-current", val );
687 var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
689 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
690 var_SetInteger( p_playlist, "activity", 0 );
692 /* Variables to control playback */
693 var_CreateGetBool( p_playlist, "play-and-stop" );
694 var_CreateGetBool( p_playlist, "play-and-exit" );
695 var_CreateGetBool( p_playlist, "random" );
696 var_CreateGetBool( p_playlist, "repeat" );
697 var_CreateGetBool( p_playlist, "loop" );
699 var_AddCallback( p_playlist, "random", RandomCallback, NULL );