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 );
42 static int RandomCallback( vlc_object_t *p_this, char const *psz_cmd,
43 vlc_value_t oldval, vlc_value_t newval, void *a )
45 (void)psz_cmd; (void)oldval; (void)newval; (void)a;
47 ((playlist_t*)p_this)->b_reset_currently_playing = VLC_TRUE;
48 playlist_Signal( ((playlist_t*)p_this) );
55 * Create a playlist structure.
56 * \param p_parent the vlc object that is to be the parent of this playlist
57 * \return a pointer to the created playlist, or NULL on error
59 playlist_t * playlist_Create( vlc_object_t *p_parent )
61 playlist_t *p_playlist;
65 /* Allocate structure */
66 p_playlist = vlc_object_create( p_parent, VLC_OBJECT_PLAYLIST );
69 msg_Err( p_parent, "out of memory" );
73 TAB_INIT( p_playlist->i_sds, p_playlist->pp_sds );
75 p_parent->p_libvlc->p_playlist = p_playlist;
77 VariablesInit( p_playlist );
79 /* Initialise data structures */
80 vlc_mutex_init( p_playlist, &p_playlist->gc_lock );
81 p_playlist->i_last_playlist_id = 0;
82 p_playlist->i_last_input_id = 0;
83 p_playlist->p_input = NULL;
85 p_playlist->gc_date = 0;
86 p_playlist->b_cant_sleep = VLC_FALSE;
88 ARRAY_INIT( p_playlist->items );
89 ARRAY_INIT( p_playlist->all_items );
90 ARRAY_INIT( p_playlist->input_items );
91 ARRAY_INIT( p_playlist->current );
93 p_playlist->i_current_index = 0;
94 p_playlist->b_reset_currently_playing = VLC_TRUE;
95 p_playlist->last_rebuild_date = 0;
97 i_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
98 p_playlist->b_always_tree = (i_tree == 1);
99 p_playlist->b_never_tree = (i_tree == 2);
101 p_playlist->b_doing_ml = VLC_FALSE;
103 p_playlist->b_auto_preparse =
104 var_CreateGetBool( p_playlist, "auto-preparse" ) ;
106 p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
108 p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
109 0, p_playlist->p_root_category->p_input );
111 if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
114 /* Create playlist and media library */
115 playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
116 &p_playlist->p_local_category,
117 &p_playlist->p_local_onelevel, VLC_FALSE );
119 p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
120 p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
122 if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
123 !p_playlist->p_local_category->p_input ||
124 !p_playlist->p_local_onelevel->p_input )
127 if( config_GetInt( p_playlist, "media-library") )
129 playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
130 &p_playlist->p_ml_category,
131 &p_playlist->p_ml_onelevel, VLC_FALSE );
133 if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
136 p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
137 p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
141 p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
145 p_playlist->status.p_item = NULL;
146 p_playlist->status.p_node = p_playlist->p_local_onelevel;
147 p_playlist->request.b_request = VLC_FALSE;
148 p_playlist->status.i_status = PLAYLIST_STOPPED;
150 p_playlist->i_sort = SORT_ID;
151 p_playlist->i_order = ORDER_NORMAL;
155 * Init the interaction here, as playlist_MLLoad could trigger
156 * interaction init */
157 p_playlist->p_interaction = NULL;
159 b_save = p_playlist->b_auto_preparse;
160 p_playlist->b_auto_preparse = VLC_FALSE;
161 playlist_MLLoad( p_playlist );
162 p_playlist->b_auto_preparse = VLC_TRUE;
169 * Destroy a playlist structure.
170 * \param p_playlist the playlist object
173 void playlist_Destroy( playlist_t *p_playlist )
175 var_Destroy( p_playlist, "intf-change" );
176 var_Destroy( p_playlist, "item-change" );
177 var_Destroy( p_playlist, "playlist-current" );
178 var_Destroy( p_playlist, "intf-popupmenu" );
179 var_Destroy( p_playlist, "intf-show" );
180 var_Destroy( p_playlist, "play-and-stop" );
181 var_Destroy( p_playlist, "play-and-exit" );
182 var_Destroy( p_playlist, "random" );
183 var_Destroy( p_playlist, "repeat" );
184 var_Destroy( p_playlist, "loop" );
185 var_Destroy( p_playlist, "activity" );
187 vlc_mutex_destroy( &p_playlist->gc_lock );
188 vlc_object_detach( p_playlist );
189 vlc_object_release( p_playlist );
192 /* Destroy remaining objects */
193 static void ObjectGarbageCollector( playlist_t *p_playlist, vlc_bool_t b_force )
199 if( mdate() - p_playlist->gc_date < 1000000 )
201 p_playlist->b_cant_sleep = VLC_TRUE;
204 else if( p_playlist->gc_date == 0 )
208 vlc_mutex_lock( &p_playlist->gc_lock );
209 while( ( p_obj = vlc_object_find( p_playlist, VLC_OBJECT_VOUT,
212 if( p_obj->p_parent != VLC_OBJECT(p_playlist) )
214 vlc_object_release( p_obj );
217 msg_Dbg( p_playlist, "garbage collector destroying 1 vout" );
218 vlc_object_detach( p_obj );
219 vlc_object_release( p_obj );
220 vout_Destroy( (vout_thread_t *)p_obj );
222 while( ( p_obj = vlc_object_find( p_playlist, VLC_OBJECT_SOUT,
225 if( p_obj->p_parent != VLC_OBJECT(p_playlist) )
227 vlc_object_release( p_obj );
230 msg_Dbg( p_playlist, "garbage collector destroying 1 sout" );
231 vlc_object_detach( p_obj );
232 vlc_object_release( p_obj );
233 sout_DeleteInstance( (sout_instance_t*)p_obj );
235 p_playlist->b_cant_sleep = VLC_FALSE;
236 vlc_mutex_unlock( &p_playlist->gc_lock );
242 * Main loop for the playlist
243 * \param p_playlist the playlist object
246 void playlist_MainLoop( playlist_t *p_playlist )
248 playlist_item_t *p_item = NULL;
249 vlc_bool_t b_playexit = var_GetBool( p_playlist, "play-and-exit" );
252 if( p_playlist->b_reset_currently_playing &&
253 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
255 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
256 p_playlist->status.p_item );
257 p_playlist->last_rebuild_date = mdate();
261 /* If there is an input, check that it doesn't need to die. */
262 if( p_playlist->p_input )
264 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
266 PL_DEBUG( "incoming request - stopping current input" );
267 input_StopThread( p_playlist->p_input );
270 /* This input is dead. Remove it ! */
271 if( p_playlist->p_input->b_dead )
274 input_thread_t *p_input;
275 PL_DEBUG( "dead input" );
277 p_input = p_playlist->p_input;
278 p_playlist->p_input = NULL;
280 /* Release the playlist lock, because we may get stuck
281 * in input_DestroyThread() for some time. */
285 input_DestroyThread( p_input );
289 p_playlist->gc_date = mdate();
290 p_playlist->b_cant_sleep = VLC_TRUE;
292 if( p_playlist->status.p_item->i_flags
293 & PLAYLIST_REMOVE_FLAG )
295 PL_DEBUG( "%s was marked for deletion, deleting",
296 PLI_NAME( p_playlist->status.p_item ) );
297 playlist_ItemDelete( p_playlist->status.p_item );
298 if( p_playlist->request.p_item == p_playlist->status.p_item )
299 p_playlist->request.p_item = NULL;
300 p_playlist->status.p_item = NULL;
303 i_activity= var_GetInteger( p_playlist, "activity" );
304 var_SetInteger( p_playlist, "activity", i_activity -
305 DEFAULT_INPUT_ACTIVITY );
308 /* This input is dying, let it do */
309 else if( p_playlist->p_input->b_die )
311 PL_DEBUG( "dying input" );
313 msleep( INTF_IDLE_SLEEP );
317 /* This input has finished, ask it to die ! */
318 else if( p_playlist->p_input->b_error
319 || p_playlist->p_input->b_eof )
321 PL_DEBUG( "finished input" );
322 input_StopThread( p_playlist->p_input );
323 /* No need to wait here, we'll wait in the p_input->b_die case */
326 else if( p_playlist->p_input->i_state != INIT_S )
329 ObjectGarbageCollector( p_playlist, VLC_FALSE );
335 /* No input. Several cases
336 * - No request, running status -> start new item
337 * - No request, stopped status -> collect garbage
338 * - Request, running requested -> start new item
339 * - Request, stopped requested -> collect garbage
341 if( p_playlist->request.i_status != PLAYLIST_STOPPED )
343 msg_Dbg( p_playlist, "starting new item" );
344 p_item = playlist_NextItem( p_playlist );
348 msg_Dbg( p_playlist, "nothing to play" );
349 p_playlist->status.i_status = PLAYLIST_STOPPED;
352 if( b_playexit == VLC_TRUE )
354 msg_Info( p_playlist, "end of playlist, exiting" );
355 vlc_object_kill( p_playlist->p_libvlc );
357 ObjectGarbageCollector( p_playlist, VLC_TRUE );
360 playlist_PlayItem( p_playlist, p_item );
364 const vlc_bool_t b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
366 p_playlist->status.i_status = PLAYLIST_STOPPED;
367 if( p_playlist->status.p_item &&
368 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
370 PL_DEBUG( "deleting item marked for deletion" );
371 playlist_ItemDelete( p_playlist->status.p_item );
372 p_playlist->status.p_item = NULL;
375 /* Collect garbage */
377 ObjectGarbageCollector( p_playlist, b_gc_forced );
388 * The playlist is dying so do the last loop
389 * \param p_playlist the playlist object
392 void playlist_LastLoop( playlist_t *p_playlist )
396 /* If there is an input, kill it */
400 if( p_playlist->p_input == NULL )
406 if( p_playlist->p_input->b_dead )
408 input_thread_t *p_input;
410 /* Unlink current input */
411 p_input = p_playlist->p_input;
412 p_playlist->p_input = NULL;
416 input_DestroyThread( p_input );
419 else if( p_playlist->p_input->b_die )
421 /* This input is dying, leave it alone */
424 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
426 input_StopThread( p_playlist->p_input );
432 p_playlist->p_input->b_eof = 1;
436 msleep( INTF_IDLE_SLEEP );
439 /* close all remaining sout */
440 while( ( p_obj = vlc_object_find( p_playlist,
441 VLC_OBJECT_SOUT, FIND_CHILD ) ) )
443 vlc_object_detach( p_obj );
444 vlc_object_release( p_obj );
445 sout_DeleteInstance( (sout_instance_t*)p_obj );
448 /* close all remaining vout */
449 while( ( p_obj = vlc_object_find( p_playlist,
450 VLC_OBJECT_VOUT, FIND_CHILD ) ) )
452 vlc_object_detach( p_obj );
453 vlc_object_release( p_obj );
454 vout_Destroy( (vout_thread_t *)p_obj );
457 while( p_playlist->i_sds )
459 playlist_ServicesDiscoveryRemove( p_playlist,
460 p_playlist->pp_sds[0]->p_sd->psz_module );
463 playlist_MLDump( p_playlist );
466 /* Go through all items, and simply free everything without caring
467 * about the tree structure. Do not decref, it will be done by doing
468 * the same thing on the input items array */
469 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
470 free( p_del->pp_children );
473 ARRAY_RESET( p_playlist->all_items );
475 FOREACH_ARRAY( input_item_t *p_del, p_playlist->input_items )
476 input_ItemClean( p_del );
479 ARRAY_RESET( p_playlist->input_items );
481 ARRAY_RESET( p_playlist->items );
482 ARRAY_RESET( p_playlist->current );
490 * Main loop for preparser queue
491 * \param p_obj items to preparse
494 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
496 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
497 input_item_t *p_current;
501 while( !p_playlist->b_die )
503 vlc_object_lock( p_obj );
504 while( p_obj->i_waiting == 0 )
506 if( vlc_object_wait( p_obj ) || p_playlist->b_die )
508 vlc_object_unlock( p_obj );
513 p_current = p_obj->pp_waiting[0];
514 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
515 vlc_object_unlock( p_obj );
520 if( p_current->i_type == ITEM_TYPE_FILE )
522 stats_TimerStart( p_playlist, "Preparse run",
523 STATS_TIMER_PREPARSE );
524 /* Do not preparse if it is already done (like by playing it) */
525 if( !input_item_IsPreparsed( p_current ) )
528 input_Preparse( p_playlist, p_current );
531 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
533 input_item_SetPreparsed( p_current, VLC_TRUE );
534 var_SetInteger( p_playlist, "item-change", p_current->i_id );
537 /* If we haven't retrieved enough meta, add to secondary queue
538 * which will run the "meta fetchers".
539 * This only checks for meta, not for art
540 * \todo don't do this for things we won't get meta for, like vids
542 char *psz_arturl = input_item_GetArtURL( p_current );
543 char *psz_name = input_item_GetName( p_current );
544 if( !input_MetaSatisfied( p_playlist, p_current, &i_m, &i_o ) )
547 PL_DEBUG( "need to fetch meta for %s", p_current->psz_name );
548 p.p_item = p_current;
549 p.b_fetch_art = VLC_FALSE;
550 vlc_object_lock( p_playlist->p_fetcher );
551 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
552 p_playlist->p_fetcher->i_waiting,
553 p_playlist->p_fetcher->i_waiting, p);
554 vlc_object_signal_unlocked( p_playlist->p_fetcher );
555 vlc_object_unlock( p_playlist->p_fetcher );
557 /* We already have all needed meta, but we need art right now */
558 else if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
559 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
562 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
563 p.p_item = p_current;
564 p.b_fetch_art = VLC_TRUE;
565 vlc_object_lock( p_playlist->p_fetcher );
566 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
567 p_playlist->p_fetcher->i_waiting,
568 p_playlist->p_fetcher->i_waiting, p);
569 vlc_object_signal_unlocked( p_playlist->p_fetcher );
570 vlc_object_unlock( p_playlist->p_fetcher );
574 PL_DEBUG( "no fetch required for %s (art currently %s)",
575 psz_name, psz_arturl );
576 vlc_gc_decref( p_current );
585 vlc_object_lock( p_obj );
586 i_activity = var_GetInteger( p_playlist, "activity" );
587 if( i_activity < 0 ) i_activity = 0;
588 vlc_object_unlock( p_obj );
589 /* Sleep at least 1ms */
590 msleep( (i_activity+1) * 1000 );
597 * Main loop for secondary preparser queue
598 * \param p_obj items to preparse
601 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
603 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
604 vlc_bool_t b_fetch_art;
605 input_item_t *p_item;
608 while( !p_playlist->b_die )
610 vlc_mutex_lock( &p_obj->object_lock );
611 while( p_obj->i_waiting == 0 )
613 vlc_cond_wait( &p_obj->object_wait, &p_obj->object_lock );
614 if( p_playlist->b_die )
616 vlc_mutex_unlock( &p_obj->object_lock );
621 b_fetch_art = p_obj->p_waiting->b_fetch_art;
622 p_item = p_obj->p_waiting->p_item;
623 REMOVE_ELEM( p_obj->p_waiting, p_obj->i_waiting, 0 );
624 vlc_mutex_unlock( &p_obj->object_lock );
629 /* If the user doesn't want us to fetch meta automatically
631 if( p_playlist->p_fetcher->b_fetch_meta )
633 input_MetaFetch( p_playlist, p_item );
634 var_SetInteger( p_playlist, "item-change", p_item->i_id );
637 /* Fetch right now */
638 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL )
640 vlc_mutex_lock( &p_obj->object_lock );
643 p.b_fetch_art = VLC_TRUE;
644 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
645 p_playlist->p_fetcher->i_waiting,
647 PL_DEBUG( "meta fetched for %s, get art", p_item->psz_name );
648 vlc_mutex_unlock( &p_obj->object_lock );
652 vlc_gc_decref( p_item );
658 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
659 * (This can happen if we fetch art on play)
660 * FIXME this doesn't work if we need to fetch meta before art ... */
661 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
665 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
666 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
673 i_ret = input_ArtFind( p_playlist, p_item );
676 PL_DEBUG( "downloading art for %s", p_item->psz_name );
677 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
678 input_item_SetArtNotFound( p_item, VLC_TRUE );
680 input_item_SetArtFetched( p_item, VLC_TRUE );
681 var_SetInteger( p_playlist, "item-change",
685 else if( i_ret == 0 ) /* Was in cache */
687 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
688 input_item_SetArtFetched( p_item, VLC_TRUE );
689 var_SetInteger( p_playlist, "item-change", p_item->i_id );
693 PL_DEBUG( "art not found for %s", p_item->psz_name );
694 input_item_SetArtNotFound( p_item, VLC_TRUE );
696 vlc_gc_decref( p_item );
699 vlc_mutex_lock( &p_obj->object_lock );
700 i_activity = var_GetInteger( p_playlist, "activity" );
701 if( i_activity < 0 ) i_activity = 0;
702 vlc_mutex_unlock( &p_obj->object_lock );
703 /* Sleep at least 1ms */
704 msleep( (i_activity+1) * 1000 );
708 static void VariablesInit( playlist_t *p_playlist )
711 /* These variables control updates */
712 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
713 val.b_bool = VLC_TRUE;
714 var_Set( p_playlist, "intf-change", val );
716 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
718 var_Set( p_playlist, "item-change", val );
720 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
722 var_Set( p_playlist, "item-deleted", val );
724 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
726 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
728 var_Set( p_playlist, "playlist-current", val );
730 var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
732 var_Create( p_playlist, "intf-show", VLC_VAR_BOOL );
733 val.b_bool = VLC_TRUE;
734 var_Set( p_playlist, "intf-show", val );
736 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
737 var_SetInteger( p_playlist, "activity", 0 );
739 /* Variables to control playback */
740 var_CreateGetBool( p_playlist, "play-and-stop" );
741 var_CreateGetBool( p_playlist, "play-and-exit" );
742 var_CreateGetBool( p_playlist, "random" );
743 var_CreateGetBool( p_playlist, "repeat" );
744 var_CreateGetBool( p_playlist, "loop" );
746 var_AddCallback( p_playlist, "random", RandomCallback, NULL );