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;
153 b_save = p_playlist->b_auto_preparse;
154 p_playlist->b_auto_preparse = VLC_FALSE;
155 playlist_MLLoad( p_playlist );
156 p_playlist->b_auto_preparse = VLC_TRUE;
163 * Destroy a playlist structure.
164 * \param p_playlist the playlist object
167 void playlist_Destroy( playlist_t *p_playlist )
169 var_Destroy( p_playlist, "intf-change" );
170 var_Destroy( p_playlist, "item-change" );
171 var_Destroy( p_playlist, "playlist-current" );
172 var_Destroy( p_playlist, "intf-popupmenu" );
173 var_Destroy( p_playlist, "intf-show" );
174 var_Destroy( p_playlist, "play-and-stop" );
175 var_Destroy( p_playlist, "play-and-exit" );
176 var_Destroy( p_playlist, "random" );
177 var_Destroy( p_playlist, "repeat" );
178 var_Destroy( p_playlist, "loop" );
179 var_Destroy( p_playlist, "activity" );
181 vlc_mutex_destroy( &p_playlist->gc_lock );
182 vlc_object_detach( p_playlist );
183 vlc_object_destroy( p_playlist );
186 /* Destroy remaining objects */
187 static void ObjectGarbageCollector( playlist_t *p_playlist, vlc_bool_t b_force )
193 if( mdate() - p_playlist->gc_date < 1000000 )
195 p_playlist->b_cant_sleep = VLC_TRUE;
198 else if( p_playlist->gc_date == 0 )
202 vlc_mutex_lock( &p_playlist->gc_lock );
203 while( ( p_obj = vlc_object_find( p_playlist, VLC_OBJECT_VOUT,
206 if( p_obj->p_parent != VLC_OBJECT(p_playlist) )
208 vlc_object_release( p_obj );
211 msg_Dbg( p_playlist, "garbage collector destroying 1 vout" );
212 vlc_object_detach( p_obj );
213 vlc_object_release( p_obj );
214 vout_Destroy( (vout_thread_t *)p_obj );
216 while( ( p_obj = vlc_object_find( p_playlist, VLC_OBJECT_SOUT,
219 if( p_obj->p_parent != VLC_OBJECT(p_playlist) )
221 vlc_object_release( p_obj );
224 msg_Dbg( p_playlist, "garbage collector destroying 1 sout" );
225 vlc_object_detach( p_obj );
226 vlc_object_release( p_obj );
227 sout_DeleteInstance( (sout_instance_t*)p_obj );
229 p_playlist->b_cant_sleep = VLC_FALSE;
230 vlc_mutex_unlock( &p_playlist->gc_lock );
236 * Main loop for the playlist
237 * \param p_playlist the playlist object
240 void playlist_MainLoop( playlist_t *p_playlist )
242 playlist_item_t *p_item = NULL;
243 vlc_bool_t b_playexit = var_GetBool( p_playlist, "play-and-exit" );
246 if( p_playlist->b_reset_currently_playing &&
247 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
249 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
250 p_playlist->status.p_item );
251 p_playlist->last_rebuild_date = mdate();
255 /* If there is an input, check that it doesn't need to die. */
256 if( p_playlist->p_input )
258 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
260 PL_DEBUG( "incoming request - stopping current input" );
261 input_StopThread( p_playlist->p_input );
264 /* This input is dead. Remove it ! */
265 if( p_playlist->p_input->b_dead )
268 input_thread_t *p_input;
269 PL_DEBUG( "dead input" );
271 p_input = p_playlist->p_input;
272 p_playlist->p_input = NULL;
274 /* Release the playlist lock, because we may get stuck
275 * in input_DestroyThread() for some time. */
279 input_DestroyThread( p_input );
283 p_playlist->gc_date = mdate();
284 p_playlist->b_cant_sleep = VLC_TRUE;
286 if( p_playlist->status.p_item->i_flags
287 & PLAYLIST_REMOVE_FLAG )
289 PL_DEBUG( "%s was marked for deletion, deleting",
290 PLI_NAME( p_playlist->status.p_item ) );
291 playlist_ItemDelete( p_playlist->status.p_item );
292 if( p_playlist->request.p_item == p_playlist->status.p_item )
293 p_playlist->request.p_item = NULL;
294 p_playlist->status.p_item = NULL;
297 i_activity= var_GetInteger( p_playlist, "activity" );
298 var_SetInteger( p_playlist, "activity", i_activity -
299 DEFAULT_INPUT_ACTIVITY );
302 /* This input is dying, let it do */
303 else if( p_playlist->p_input->b_die )
305 PL_DEBUG( "dying input" );
307 msleep( INTF_IDLE_SLEEP );
311 /* This input has finished, ask it to die ! */
312 else if( p_playlist->p_input->b_error
313 || p_playlist->p_input->b_eof )
315 PL_DEBUG( "finished input" );
316 input_StopThread( p_playlist->p_input );
317 /* No need to wait here, we'll wait in the p_input->b_die case */
320 else if( p_playlist->p_input->i_state != INIT_S )
323 ObjectGarbageCollector( p_playlist, VLC_FALSE );
329 /* No input. Several cases
330 * - No request, running status -> start new item
331 * - No request, stopped status -> collect garbage
332 * - Request, running requested -> start new item
333 * - Request, stopped requested -> collect garbage
335 if( p_playlist->request.i_status != PLAYLIST_STOPPED )
337 msg_Dbg( p_playlist, "starting new item" );
338 p_item = playlist_NextItem( p_playlist );
342 msg_Dbg( p_playlist, "nothing to play" );
343 p_playlist->status.i_status = PLAYLIST_STOPPED;
346 if( b_playexit == VLC_TRUE )
348 msg_Info( p_playlist, "end of playlist, exiting" );
349 vlc_object_kill( p_playlist->p_libvlc );
351 ObjectGarbageCollector( p_playlist, VLC_TRUE );
354 playlist_PlayItem( p_playlist, p_item );
358 const vlc_bool_t b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
360 p_playlist->status.i_status = PLAYLIST_STOPPED;
361 if( p_playlist->status.p_item &&
362 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
364 PL_DEBUG( "deleting item marked for deletion" );
365 playlist_ItemDelete( p_playlist->status.p_item );
366 p_playlist->status.p_item = NULL;
369 /* Collect garbage */
371 ObjectGarbageCollector( p_playlist, b_gc_forced );
382 * The playlist is dying so do the last loop
383 * \param p_playlist the playlist object
386 void playlist_LastLoop( playlist_t *p_playlist )
390 /* If there is an input, kill it */
394 if( p_playlist->p_input == NULL )
400 if( p_playlist->p_input->b_dead )
402 input_thread_t *p_input;
404 /* Unlink current input */
405 p_input = p_playlist->p_input;
406 p_playlist->p_input = NULL;
410 input_DestroyThread( p_input );
413 else if( p_playlist->p_input->b_die )
415 /* This input is dying, leave it alone */
418 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
420 input_StopThread( p_playlist->p_input );
426 p_playlist->p_input->b_eof = 1;
430 msleep( INTF_IDLE_SLEEP );
433 /* close all remaining sout */
434 while( ( p_obj = vlc_object_find( p_playlist,
435 VLC_OBJECT_SOUT, FIND_CHILD ) ) )
437 vlc_object_detach( p_obj );
438 vlc_object_release( p_obj );
439 sout_DeleteInstance( (sout_instance_t*)p_obj );
442 /* close all remaining vout */
443 while( ( p_obj = vlc_object_find( p_playlist,
444 VLC_OBJECT_VOUT, FIND_CHILD ) ) )
446 vlc_object_detach( p_obj );
447 vlc_object_release( p_obj );
448 vout_Destroy( (vout_thread_t *)p_obj );
451 while( p_playlist->i_sds )
453 playlist_ServicesDiscoveryRemove( p_playlist,
454 p_playlist->pp_sds[0]->p_sd->psz_module );
457 playlist_MLDump( p_playlist );
460 /* Go through all items, and simply free everything without caring
461 * about the tree structure. Do not decref, it will be done by doing
462 * the same thing on the input items array */
463 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
464 free( p_del->pp_children );
467 ARRAY_RESET( p_playlist->all_items );
469 FOREACH_ARRAY( input_item_t *p_del, p_playlist->input_items )
470 input_ItemClean( p_del );
473 ARRAY_RESET( p_playlist->input_items );
475 ARRAY_RESET( p_playlist->items );
476 ARRAY_RESET( p_playlist->current );
484 * Main loop for preparser queue
485 * \param p_obj items to preparse
488 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
490 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
491 input_item_t *p_current;
495 while( !p_playlist->b_die )
497 vlc_mutex_lock( &p_obj->object_lock );
498 while( p_obj->i_waiting == 0 )
500 vlc_cond_wait( &p_obj->object_wait, &p_obj->object_lock );
501 if( p_playlist->b_die )
503 vlc_mutex_unlock( &p_obj->object_lock );
508 p_current = p_obj->pp_waiting[0];
509 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
510 vlc_mutex_unlock( &p_obj->object_lock );
515 if( p_current->i_type == ITEM_TYPE_FILE )
517 stats_TimerStart( p_playlist, "Preparse run",
518 STATS_TIMER_PREPARSE );
519 /* Do not preparse if it is already done (like by playing it) */
520 if( !input_item_IsPreparsed( p_current ) )
523 input_Preparse( p_playlist, p_current );
526 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
528 input_item_SetPreparsed( p_current, VLC_TRUE );
529 var_SetInteger( p_playlist, "item-change", p_current->i_id );
532 /* If we haven't retrieved enough meta, add to secondary queue
533 * which will run the "meta fetchers".
534 * This only checks for meta, not for art
535 * \todo don't do this for things we won't get meta for, like vids
537 char *psz_arturl = input_item_GetArtURL( p_current );
538 char *psz_name = input_item_GetName( p_current );
539 if( !input_MetaSatisfied( p_playlist, p_current, &i_m, &i_o ) )
542 PL_DEBUG( "need to fetch meta for %s", p_current->psz_name );
543 p.p_item = p_current;
544 p.b_fetch_art = VLC_FALSE;
545 vlc_mutex_lock( &p_playlist->p_fetcher->object_lock );
546 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
547 p_playlist->p_fetcher->i_waiting,
548 p_playlist->p_fetcher->i_waiting, p);
549 vlc_cond_signal( &p_playlist->p_fetcher->object_wait );
550 vlc_mutex_unlock( &p_playlist->p_fetcher->object_lock );
552 /* We already have all needed meta, but we need art right now */
553 else if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
554 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
557 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
558 p.p_item = p_current;
559 p.b_fetch_art = VLC_TRUE;
560 vlc_mutex_lock( &p_playlist->p_fetcher->object_lock );
561 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
562 p_playlist->p_fetcher->i_waiting,
563 p_playlist->p_fetcher->i_waiting, p);
564 vlc_cond_signal( &p_playlist->p_fetcher->object_wait );
565 vlc_mutex_unlock( &p_playlist->p_fetcher->object_lock );
569 PL_DEBUG( "no fetch required for %s (art currently %s)",
570 psz_name, psz_arturl );
571 vlc_gc_decref( p_current );
580 vlc_mutex_lock( &p_obj->object_lock );
581 i_activity = var_GetInteger( p_playlist, "activity" );
582 if( i_activity < 0 ) i_activity = 0;
583 vlc_mutex_unlock( &p_obj->object_lock );
584 /* Sleep at least 1ms */
585 msleep( (i_activity+1) * 1000 );
592 * Main loop for secondary preparser queue
593 * \param p_obj items to preparse
596 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
598 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
599 vlc_bool_t b_fetch_art;
600 input_item_t *p_item;
603 while( !p_playlist->b_die )
605 vlc_mutex_lock( &p_obj->object_lock );
606 while( p_obj->i_waiting == 0 )
608 vlc_cond_wait( &p_obj->object_wait, &p_obj->object_lock );
609 if( p_playlist->b_die )
611 vlc_mutex_unlock( &p_obj->object_lock );
616 b_fetch_art = p_obj->p_waiting->b_fetch_art;
617 p_item = p_obj->p_waiting->p_item;
618 REMOVE_ELEM( p_obj->p_waiting, p_obj->i_waiting, 0 );
619 vlc_mutex_unlock( &p_obj->object_lock );
624 /* If the user doesn't want us to fetch meta automatically
626 if( p_playlist->p_fetcher->b_fetch_meta )
628 input_MetaFetch( p_playlist, p_item );
629 var_SetInteger( p_playlist, "item-change", p_item->i_id );
632 /* Fetch right now */
633 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL )
635 vlc_mutex_lock( &p_obj->object_lock );
638 p.b_fetch_art = VLC_TRUE;
639 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
640 p_playlist->p_fetcher->i_waiting,
642 PL_DEBUG( "meta fetched for %s, get art", p_item->psz_name );
643 vlc_mutex_unlock( &p_obj->object_lock );
647 vlc_gc_decref( p_item );
653 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
654 * (This can happen if we fetch art on play)
655 * FIXME this doesn't work if we need to fetch meta before art ... */
656 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
660 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
661 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
668 i_ret = input_ArtFind( p_playlist, p_item );
671 PL_DEBUG( "downloading art for %s", p_item->psz_name );
672 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
673 input_item_SetArtNotFound( p_item, VLC_TRUE );
675 input_item_SetArtFetched( p_item, VLC_TRUE );
676 var_SetInteger( p_playlist, "item-change",
680 else if( i_ret == 0 ) /* Was in cache */
682 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
683 input_item_SetArtFetched( p_item, VLC_TRUE );
684 var_SetInteger( p_playlist, "item-change", p_item->i_id );
688 PL_DEBUG( "art not found for %s", p_item->psz_name );
689 input_item_SetArtNotFound( p_item, VLC_TRUE );
691 vlc_gc_decref( p_item );
694 vlc_mutex_lock( &p_obj->object_lock );
695 i_activity = var_GetInteger( p_playlist, "activity" );
696 if( i_activity < 0 ) i_activity = 0;
697 vlc_mutex_unlock( &p_obj->object_lock );
698 /* Sleep at least 1ms */
699 msleep( (i_activity+1) * 1000 );
703 static void VariablesInit( playlist_t *p_playlist )
706 /* These variables control updates */
707 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
708 val.b_bool = VLC_TRUE;
709 var_Set( p_playlist, "intf-change", val );
711 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
713 var_Set( p_playlist, "item-change", val );
715 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
717 var_Set( p_playlist, "item-deleted", val );
719 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
721 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
723 var_Set( p_playlist, "playlist-current", val );
725 var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
727 var_Create( p_playlist, "intf-show", VLC_VAR_BOOL );
728 val.b_bool = VLC_TRUE;
729 var_Set( p_playlist, "intf-show", val );
731 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
732 var_SetInteger( p_playlist, "activity", 0 );
734 /* Variables to control playback */
735 var_CreateGetBool( p_playlist, "play-and-stop" );
736 var_CreateGetBool( p_playlist, "play-and-exit" );
737 var_CreateGetBool( p_playlist, "random" );
738 var_CreateGetBool( p_playlist, "repeat" );
739 var_CreateGetBool( p_playlist, "loop" );
741 var_AddCallback( p_playlist, "random", RandomCallback, NULL );