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 *****************************************************************************/
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 );
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_PLAYLIST, playlist_name );
71 msg_Err( p_parent, "out of memory" );
75 TAB_INIT( p_playlist->i_sds, p_playlist->pp_sds );
77 libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
79 VariablesInit( p_playlist );
81 /* Initialise data structures */
82 vlc_mutex_init( &p_playlist->gc_lock );
83 p_playlist->i_last_playlist_id = 0;
84 p_playlist->p_input = NULL;
86 p_playlist->gc_date = 0;
87 p_playlist->b_cant_sleep = false;
89 ARRAY_INIT( p_playlist->items );
90 ARRAY_INIT( p_playlist->all_items );
91 ARRAY_INIT( p_playlist->current );
93 p_playlist->i_current_index = 0;
94 p_playlist->b_reset_currently_playing = true;
95 p_playlist->last_rebuild_date = 0;
97 p_playlist->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
99 p_playlist->b_doing_ml = false;
101 p_playlist->b_auto_preparse =
102 var_CreateGetBool( p_playlist, "auto-preparse" ) ;
104 p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
106 p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
107 0, p_playlist->p_root_category->p_input );
109 if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
112 /* Create playlist and media library */
113 playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
114 &p_playlist->p_local_category,
115 &p_playlist->p_local_onelevel, false );
117 p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
118 p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
120 if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
121 !p_playlist->p_local_category->p_input ||
122 !p_playlist->p_local_onelevel->p_input )
125 if( config_GetInt( p_playlist, "media-library") )
127 playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
128 &p_playlist->p_ml_category,
129 &p_playlist->p_ml_onelevel, false );
131 if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
134 p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
135 p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
139 p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
143 p_playlist->status.p_item = NULL;
144 p_playlist->status.p_node = p_playlist->p_local_onelevel;
145 p_playlist->request.b_request = false;
146 p_playlist->status.i_status = PLAYLIST_STOPPED;
148 p_playlist->i_sort = SORT_ID;
149 p_playlist->i_order = ORDER_NORMAL;
152 b_save = p_playlist->b_auto_preparse;
153 p_playlist->b_auto_preparse = false;
154 playlist_MLLoad( p_playlist );
155 p_playlist->b_auto_preparse = true;
157 vlc_object_set_destructor( p_playlist, playlist_Destructor );
165 * Destroy a playlist structure.
166 * \param p_playlist the playlist object
169 void playlist_Destroy( playlist_t *p_playlist )
171 /* XXX: should go in the playlist destructor */
172 var_Destroy( p_playlist, "intf-change" );
173 var_Destroy( p_playlist, "item-change" );
174 var_Destroy( p_playlist, "playlist-current" );
175 var_Destroy( p_playlist, "intf-popupmenu" );
176 var_Destroy( p_playlist, "intf-show" );
177 var_Destroy( p_playlist, "play-and-stop" );
178 var_Destroy( p_playlist, "play-and-exit" );
179 var_Destroy( p_playlist, "random" );
180 var_Destroy( p_playlist, "repeat" );
181 var_Destroy( p_playlist, "loop" );
182 var_Destroy( p_playlist, "activity" );
184 vlc_object_release( p_playlist );
187 static void playlist_Destructor( vlc_object_t * p_this )
189 playlist_t * p_playlist = (playlist_t *)p_this;
192 if( p_playlist->p_preparse )
194 vlc_object_release( p_playlist->p_preparse );
198 if( p_playlist->p_fetcher )
200 vlc_object_release( p_playlist->p_fetcher );
204 /* Destroy remaining objects */
205 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
211 if( mdate() - p_playlist->gc_date < 1000000 )
213 p_playlist->b_cant_sleep = true;
216 else if( p_playlist->gc_date == 0 )
220 vlc_mutex_lock( &p_playlist->gc_lock );
221 while( ( p_obj = vlc_object_find( p_playlist->p_libvlc, VLC_OBJECT_VOUT,
224 if( p_obj->p_parent != VLC_OBJECT(p_playlist->p_libvlc) )
226 vlc_object_release( p_obj );
229 msg_Dbg( p_playlist, "garbage collector destroying 1 vout" );
230 vlc_object_detach( p_obj );
231 vlc_object_release( p_obj );
232 vout_Destroy( (vout_thread_t *)p_obj );
235 while( ( p_obj = vlc_object_find( p_playlist, VLC_OBJECT_SOUT,
238 if( p_obj->p_parent != VLC_OBJECT(p_playlist) )
240 vlc_object_release( p_obj );
243 msg_Dbg( p_playlist, "garbage collector destroying 1 sout" );
244 vlc_object_detach( p_obj );
245 vlc_object_release( p_obj );
246 sout_DeleteInstance( (sout_instance_t*)p_obj );
249 p_playlist->b_cant_sleep = false;
250 vlc_mutex_unlock( &p_playlist->gc_lock );
256 * Main loop for the playlist
257 * \param p_playlist the playlist object
260 void playlist_MainLoop( playlist_t *p_playlist )
262 playlist_item_t *p_item = NULL;
263 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
266 if( p_playlist->b_reset_currently_playing &&
267 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
269 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
270 p_playlist->status.p_item );
271 p_playlist->last_rebuild_date = mdate();
275 /* If there is an input, check that it doesn't need to die. */
276 if( p_playlist->p_input )
278 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
280 PL_DEBUG( "incoming request - stopping current input" );
281 input_StopThread( p_playlist->p_input );
284 /* This input is dead. Remove it ! */
285 if( p_playlist->p_input->b_dead )
288 input_thread_t *p_input;
289 PL_DEBUG( "dead input" );
291 p_input = p_playlist->p_input;
292 p_playlist->p_input = NULL;
294 /* Release the playlist lock, because we may get stuck
295 * in vlc_object_release() for some time. */
299 vlc_object_release( p_input );
303 p_playlist->gc_date = mdate();
304 p_playlist->b_cant_sleep = true;
306 if( p_playlist->status.p_item->i_flags
307 & PLAYLIST_REMOVE_FLAG )
309 PL_DEBUG( "%s was marked for deletion, deleting",
310 PLI_NAME( p_playlist->status.p_item ) );
311 playlist_ItemDelete( p_playlist->status.p_item );
312 if( p_playlist->request.p_item == p_playlist->status.p_item )
313 p_playlist->request.p_item = NULL;
314 p_playlist->status.p_item = NULL;
317 i_activity= var_GetInteger( p_playlist, "activity" );
318 var_SetInteger( p_playlist, "activity", i_activity -
319 DEFAULT_INPUT_ACTIVITY );
322 /* This input is dying, let it do */
323 else if( p_playlist->p_input->b_die )
325 PL_DEBUG( "dying input" );
327 msleep( INTF_IDLE_SLEEP );
331 /* This input has finished, ask it to die ! */
332 else if( p_playlist->p_input->b_error
333 || p_playlist->p_input->b_eof )
335 PL_DEBUG( "finished input" );
336 input_StopThread( p_playlist->p_input );
337 /* No need to wait here, we'll wait in the p_input->b_die case */
340 else if( p_playlist->p_input->i_state != INIT_S )
343 ObjectGarbageCollector( p_playlist, false );
349 /* No input. Several cases
350 * - No request, running status -> start new item
351 * - No request, stopped status -> collect garbage
352 * - Request, running requested -> start new item
353 * - Request, stopped requested -> collect garbage
355 int i_status = p_playlist->request.b_request ?
356 p_playlist->request.i_status : p_playlist->status.i_status;
357 if( i_status != PLAYLIST_STOPPED )
359 msg_Dbg( p_playlist, "starting new item" );
360 p_item = playlist_NextItem( p_playlist );
364 msg_Dbg( p_playlist, "nothing to play" );
365 p_playlist->status.i_status = PLAYLIST_STOPPED;
368 if( b_playexit == true )
370 msg_Info( p_playlist, "end of playlist, exiting" );
371 vlc_object_kill( p_playlist->p_libvlc );
373 ObjectGarbageCollector( p_playlist, true );
376 playlist_PlayItem( p_playlist, p_item );
380 const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
382 p_playlist->status.i_status = PLAYLIST_STOPPED;
383 if( p_playlist->status.p_item &&
384 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
386 PL_DEBUG( "deleting item marked for deletion" );
387 playlist_ItemDelete( p_playlist->status.p_item );
388 p_playlist->status.p_item = NULL;
391 /* Collect garbage */
393 ObjectGarbageCollector( p_playlist, b_gc_forced );
403 * The playlist is dying so do the last loop
404 * \param p_playlist the playlist object
407 void playlist_LastLoop( playlist_t *p_playlist )
411 /* If there is an input, kill it */
415 if( p_playlist->p_input == NULL )
421 if( p_playlist->p_input->b_dead )
423 input_thread_t *p_input;
425 /* Unlink current input */
426 p_input = p_playlist->p_input;
427 p_playlist->p_input = NULL;
431 vlc_object_release( p_input );
434 else if( p_playlist->p_input->b_die )
436 /* This input is dying, leave it alone */
439 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
441 input_StopThread( p_playlist->p_input );
447 p_playlist->p_input->b_eof = 1;
451 msleep( INTF_IDLE_SLEEP );
455 /* close all remaining sout */
456 while( ( p_obj = vlc_object_find( p_playlist,
457 VLC_OBJECT_SOUT, FIND_CHILD ) ) )
459 vlc_object_detach( p_obj );
460 vlc_object_release( p_obj );
461 sout_DeleteInstance( (sout_instance_t*)p_obj );
465 /* close all remaining vout */
466 while( ( p_obj = vlc_object_find( p_playlist,
467 VLC_OBJECT_VOUT, FIND_CHILD ) ) )
469 vlc_object_detach( p_obj );
470 vlc_object_release( p_obj );
471 vout_Destroy( (vout_thread_t *)p_obj );
474 while( p_playlist->i_sds )
476 playlist_ServicesDiscoveryRemove( p_playlist,
477 p_playlist->pp_sds[0]->p_sd->psz_module );
480 playlist_MLDump( p_playlist );
483 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
484 free( p_del->pp_children );
485 vlc_gc_decref( p_del->p_input );
488 ARRAY_RESET( p_playlist->all_items );
490 ARRAY_RESET( p_playlist->items );
491 ARRAY_RESET( p_playlist->current );
499 * Main loop for preparser queue
500 * \param p_obj items to preparse
503 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
505 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
506 input_item_t *p_current;
509 while( !p_playlist->b_die )
511 vlc_object_lock( p_obj );
512 while( p_obj->i_waiting == 0 )
514 if( vlc_object_wait( p_obj ) || p_playlist->b_die )
516 vlc_object_unlock( p_obj );
521 p_current = p_obj->pp_waiting[0];
522 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
523 vlc_object_unlock( p_obj );
528 if( p_current->i_type == ITEM_TYPE_FILE )
530 stats_TimerStart( p_playlist, "Preparse run",
531 STATS_TIMER_PREPARSE );
532 /* Do not preparse if it is already done (like by playing it) */
533 if( !input_item_IsPreparsed( p_current ) )
536 input_Preparse( p_playlist, p_current );
539 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
541 input_item_SetPreparsed( p_current, true );
542 var_SetInteger( p_playlist, "item-change", p_current->i_id );
545 /* If we haven't retrieved enough meta, add to secondary queue
546 * which will run the "meta fetchers".
547 * This only checks for meta, not for art
548 * \todo don't do this for things we won't get meta for, like vids
550 char *psz_arturl = input_item_GetArtURL( p_current );
551 char *psz_name = input_item_GetName( p_current );
552 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
553 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
555 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
556 vlc_object_lock( p_playlist->p_fetcher );
557 INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
558 p_playlist->p_fetcher->i_waiting,
559 p_playlist->p_fetcher->i_waiting, p_current);
560 vlc_object_signal_unlocked( p_playlist->p_fetcher );
561 vlc_object_unlock( p_playlist->p_fetcher );
565 PL_DEBUG( "no fetch required for %s (art currently %s)",
566 psz_name, psz_arturl );
567 vlc_gc_decref( p_current );
576 vlc_object_lock( p_obj );
577 i_activity = var_GetInteger( p_playlist, "activity" );
578 if( i_activity < 0 ) i_activity = 0;
579 vlc_object_unlock( p_obj );
580 /* Sleep at least 1ms */
581 msleep( (i_activity+1) * 1000 );
588 * Main loop for secondary preparser queue
589 * \param p_obj items to preparse
592 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
594 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
595 input_item_t *p_item;
598 while( !p_playlist->b_die )
600 vlc_mutex_lock( &p_obj->object_lock );
601 while( p_obj->i_waiting == 0 )
603 vlc_cond_wait( &p_obj->object_wait, &p_obj->object_lock );
604 if( p_playlist->b_die )
606 vlc_mutex_unlock( &p_obj->object_lock );
611 p_item = p_obj->pp_waiting[0];
612 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
613 vlc_mutex_unlock( &p_obj->object_lock );
618 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
619 * (This can happen if we fetch art on play)
620 * FIXME this doesn't work if we need to fetch meta before art ... */
621 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
625 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
626 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
633 i_ret = input_ArtFind( p_playlist, p_item );
636 PL_DEBUG( "downloading art for %s", p_item->psz_name );
637 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
638 input_item_SetArtNotFound( p_item, true );
640 input_item_SetArtFetched( p_item, true );
641 var_SetInteger( p_playlist, "item-change",
645 else if( i_ret == 0 ) /* Was in cache */
647 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
648 input_item_SetArtFetched( p_item, true );
649 var_SetInteger( p_playlist, "item-change", p_item->i_id );
653 PL_DEBUG( "art not found for %s", p_item->psz_name );
654 input_item_SetArtNotFound( p_item, true );
656 vlc_gc_decref( p_item );
658 vlc_object_lock( p_obj );
659 i_activity = var_GetInteger( p_playlist, "activity" );
660 if( i_activity < 0 ) i_activity = 0;
661 vlc_object_unlock( p_obj );
662 /* Sleep at least 1ms */
663 msleep( (i_activity+1) * 1000 );
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, "intf-show", VLC_VAR_BOOL );
693 var_Set( p_playlist, "intf-show", val );
695 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
696 var_SetInteger( p_playlist, "activity", 0 );
698 /* Variables to control playback */
699 var_CreateGetBool( p_playlist, "play-and-stop" );
700 var_CreateGetBool( p_playlist, "play-and-exit" );
701 var_CreateGetBool( p_playlist, "random" );
702 var_CreateGetBool( p_playlist, "repeat" );
703 var_CreateGetBool( p_playlist, "loop" );
705 var_AddCallback( p_playlist, "random", RandomCallback, NULL );