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 = VLC_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;
67 /* Allocate structure */
68 p_playlist = vlc_custom_create( p_parent, sizeof( *p_playlist ),
69 VLC_OBJECT_PLAYLIST, playlist_name );
72 msg_Err( p_parent, "out of memory" );
76 TAB_INIT( p_playlist->i_sds, p_playlist->pp_sds );
78 p_parent->p_libvlc->p_playlist = p_playlist;
80 VariablesInit( p_playlist );
82 /* Initialise data structures */
83 vlc_mutex_init( p_playlist, &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 = VLC_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 = VLC_TRUE;
96 p_playlist->last_rebuild_date = 0;
98 i_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
99 p_playlist->b_always_tree = (i_tree == 1);
100 p_playlist->b_never_tree = (i_tree == 2);
102 p_playlist->b_doing_ml = VLC_FALSE;
104 p_playlist->b_auto_preparse =
105 var_CreateGetBool( p_playlist, "auto-preparse" ) ;
107 p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
109 p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
110 0, p_playlist->p_root_category->p_input );
112 if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
115 /* Create playlist and media library */
116 playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
117 &p_playlist->p_local_category,
118 &p_playlist->p_local_onelevel, VLC_FALSE );
120 p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
121 p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
123 if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
124 !p_playlist->p_local_category->p_input ||
125 !p_playlist->p_local_onelevel->p_input )
128 if( config_GetInt( p_playlist, "media-library") )
130 playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
131 &p_playlist->p_ml_category,
132 &p_playlist->p_ml_onelevel, VLC_FALSE );
134 if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
137 p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
138 p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
142 p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
146 p_playlist->status.p_item = NULL;
147 p_playlist->status.p_node = p_playlist->p_local_onelevel;
148 p_playlist->request.b_request = VLC_FALSE;
149 p_playlist->status.i_status = PLAYLIST_STOPPED;
151 p_playlist->i_sort = SORT_ID;
152 p_playlist->i_order = ORDER_NORMAL;
155 b_save = p_playlist->b_auto_preparse;
156 p_playlist->b_auto_preparse = VLC_FALSE;
157 playlist_MLLoad( p_playlist );
158 p_playlist->b_auto_preparse = VLC_TRUE;
160 vlc_object_set_destructor( p_playlist, playlist_Destructor );
168 * Destroy a playlist structure.
169 * \param p_playlist the playlist object
172 void playlist_Destroy( playlist_t *p_playlist )
174 /* XXX: should go in the playlist destructor */
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_object_release( p_playlist );
190 static void playlist_Destructor( vlc_object_t * p_this )
192 playlist_t * p_playlist = (playlist_t *)p_this;
195 if( p_playlist->p_preparse )
197 vlc_object_release( p_playlist->p_preparse );
201 if( p_playlist->p_fetcher )
203 vlc_object_release( p_playlist->p_fetcher );
207 /* Destroy remaining objects */
208 static void ObjectGarbageCollector( playlist_t *p_playlist, vlc_bool_t b_force )
214 if( mdate() - p_playlist->gc_date < 1000000 )
216 p_playlist->b_cant_sleep = VLC_TRUE;
219 else if( p_playlist->gc_date == 0 )
223 vlc_mutex_lock( &p_playlist->gc_lock );
224 while( ( p_obj = vlc_object_find( p_playlist->p_libvlc, VLC_OBJECT_VOUT,
227 if( p_obj->p_parent != VLC_OBJECT(p_playlist->p_libvlc) )
229 vlc_object_release( p_obj );
232 msg_Dbg( p_playlist, "garbage collector destroying 1 vout" );
233 vlc_object_detach( p_obj );
234 vlc_object_release( p_obj );
235 vout_Destroy( (vout_thread_t *)p_obj );
237 while( ( p_obj = vlc_object_find( p_playlist, VLC_OBJECT_SOUT,
240 if( p_obj->p_parent != VLC_OBJECT(p_playlist) )
242 vlc_object_release( p_obj );
245 msg_Dbg( p_playlist, "garbage collector destroying 1 sout" );
246 vlc_object_detach( p_obj );
247 vlc_object_release( p_obj );
248 sout_DeleteInstance( (sout_instance_t*)p_obj );
250 p_playlist->b_cant_sleep = VLC_FALSE;
251 vlc_mutex_unlock( &p_playlist->gc_lock );
257 * Main loop for the playlist
258 * \param p_playlist the playlist object
261 void playlist_MainLoop( playlist_t *p_playlist )
263 playlist_item_t *p_item = NULL;
264 vlc_bool_t b_playexit = var_GetBool( p_playlist, "play-and-exit" );
267 if( p_playlist->b_reset_currently_playing &&
268 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
270 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
271 p_playlist->status.p_item );
272 p_playlist->last_rebuild_date = mdate();
276 /* If there is an input, check that it doesn't need to die. */
277 if( p_playlist->p_input )
279 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
281 PL_DEBUG( "incoming request - stopping current input" );
282 input_StopThread( p_playlist->p_input );
285 /* This input is dead. Remove it ! */
286 if( p_playlist->p_input->b_dead )
289 input_thread_t *p_input;
290 PL_DEBUG( "dead input" );
292 p_input = p_playlist->p_input;
293 p_playlist->p_input = NULL;
295 /* Release the playlist lock, because we may get stuck
296 * in vlc_object_release() for some time. */
300 vlc_object_release( p_input );
304 p_playlist->gc_date = mdate();
305 p_playlist->b_cant_sleep = VLC_TRUE;
307 if( p_playlist->status.p_item->i_flags
308 & PLAYLIST_REMOVE_FLAG )
310 PL_DEBUG( "%s was marked for deletion, deleting",
311 PLI_NAME( p_playlist->status.p_item ) );
312 playlist_ItemDelete( p_playlist->status.p_item );
313 if( p_playlist->request.p_item == p_playlist->status.p_item )
314 p_playlist->request.p_item = NULL;
315 p_playlist->status.p_item = NULL;
318 i_activity= var_GetInteger( p_playlist, "activity" );
319 var_SetInteger( p_playlist, "activity", i_activity -
320 DEFAULT_INPUT_ACTIVITY );
323 /* This input is dying, let it do */
324 else if( p_playlist->p_input->b_die )
326 PL_DEBUG( "dying input" );
328 msleep( INTF_IDLE_SLEEP );
332 /* This input has finished, ask it to die ! */
333 else if( p_playlist->p_input->b_error
334 || p_playlist->p_input->b_eof )
336 PL_DEBUG( "finished input" );
337 input_StopThread( p_playlist->p_input );
338 /* No need to wait here, we'll wait in the p_input->b_die case */
341 else if( p_playlist->p_input->i_state != INIT_S )
344 ObjectGarbageCollector( p_playlist, VLC_FALSE );
350 /* No input. Several cases
351 * - No request, running status -> start new item
352 * - No request, stopped status -> collect garbage
353 * - Request, running requested -> start new item
354 * - Request, stopped requested -> collect garbage
356 if( p_playlist->request.i_status != PLAYLIST_STOPPED )
358 msg_Dbg( p_playlist, "starting new item" );
359 p_item = playlist_NextItem( p_playlist );
363 msg_Dbg( p_playlist, "nothing to play" );
364 p_playlist->status.i_status = PLAYLIST_STOPPED;
367 if( b_playexit == VLC_TRUE )
369 msg_Info( p_playlist, "end of playlist, exiting" );
370 vlc_object_kill( p_playlist->p_libvlc );
372 ObjectGarbageCollector( p_playlist, VLC_TRUE );
375 playlist_PlayItem( p_playlist, p_item );
379 const vlc_bool_t b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
381 p_playlist->status.i_status = PLAYLIST_STOPPED;
382 if( p_playlist->status.p_item &&
383 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
385 PL_DEBUG( "deleting item marked for deletion" );
386 playlist_ItemDelete( p_playlist->status.p_item );
387 p_playlist->status.p_item = NULL;
390 /* Collect garbage */
392 ObjectGarbageCollector( p_playlist, b_gc_forced );
399 static void recursively_decref( playlist_item_t *p_node )
401 vlc_gc_decref( p_node->p_input );
404 if( p_node->i_children > 0 )
405 for( i = 0 ; i < p_node->i_children ; i++ )
406 recursively_decref( p_node->pp_children[i] );
412 * The playlist is dying so do the last loop
413 * \param p_playlist the playlist object
416 void playlist_LastLoop( playlist_t *p_playlist )
420 /* If there is an input, kill it */
424 if( p_playlist->p_input == NULL )
430 if( p_playlist->p_input->b_dead )
432 input_thread_t *p_input;
434 /* Unlink current input */
435 p_input = p_playlist->p_input;
436 p_playlist->p_input = NULL;
440 vlc_object_release( p_input );
443 else if( p_playlist->p_input->b_die )
445 /* This input is dying, leave it alone */
448 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
450 input_StopThread( p_playlist->p_input );
456 p_playlist->p_input->b_eof = 1;
460 msleep( INTF_IDLE_SLEEP );
463 /* close all remaining sout */
464 while( ( p_obj = vlc_object_find( p_playlist,
465 VLC_OBJECT_SOUT, FIND_CHILD ) ) )
467 vlc_object_detach( p_obj );
468 vlc_object_release( p_obj );
469 sout_DeleteInstance( (sout_instance_t*)p_obj );
472 /* close all remaining vout */
473 while( ( p_obj = vlc_object_find( p_playlist,
474 VLC_OBJECT_VOUT, FIND_CHILD ) ) )
476 vlc_object_detach( p_obj );
477 vlc_object_release( p_obj );
478 vout_Destroy( (vout_thread_t *)p_obj );
481 while( p_playlist->i_sds )
483 playlist_ServicesDiscoveryRemove( p_playlist,
484 p_playlist->pp_sds[0]->p_sd->psz_module );
487 playlist_MLDump( p_playlist );
489 /* Because this recursive function decreases the
490 * p_playlist->p_ml_category refcount, it may get deleted.
491 * However we will delete the p_playlist->p_ml_category in the
492 * following FOREACH. */
493 vlc_gc_incref( p_playlist->p_ml_category->p_input );
495 /* We don't need the media library anymore */
496 /* Decref all subitems, and the given items */
497 recursively_decref( p_playlist->p_ml_category );
500 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
501 free( p_del->pp_children );
502 vlc_gc_decref( p_del->p_input );
505 ARRAY_RESET( p_playlist->all_items );
507 ARRAY_RESET( p_playlist->items );
508 ARRAY_RESET( p_playlist->current );
516 * Main loop for preparser queue
517 * \param p_obj items to preparse
520 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
522 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
523 input_item_t *p_current;
527 while( !p_playlist->b_die )
529 vlc_object_lock( p_obj );
530 while( p_obj->i_waiting == 0 )
532 if( vlc_object_wait( p_obj ) || p_playlist->b_die )
534 vlc_object_unlock( p_obj );
539 p_current = p_obj->pp_waiting[0];
540 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
541 vlc_object_unlock( p_obj );
546 if( p_current->i_type == ITEM_TYPE_FILE )
548 stats_TimerStart( p_playlist, "Preparse run",
549 STATS_TIMER_PREPARSE );
550 /* Do not preparse if it is already done (like by playing it) */
551 if( !input_item_IsPreparsed( p_current ) )
554 input_Preparse( p_playlist, p_current );
557 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
559 input_item_SetPreparsed( p_current, VLC_TRUE );
560 var_SetInteger( p_playlist, "item-change", p_current->i_id );
563 /* If we haven't retrieved enough meta, add to secondary queue
564 * which will run the "meta fetchers".
565 * This only checks for meta, not for art
566 * \todo don't do this for things we won't get meta for, like vids
568 char *psz_arturl = input_item_GetArtURL( p_current );
569 char *psz_name = input_item_GetName( p_current );
570 if( !input_MetaSatisfied( p_playlist, p_current, &i_m, &i_o ) )
573 PL_DEBUG( "need to fetch meta for %s", p_current->psz_name );
574 p.p_item = p_current;
575 p.b_fetch_art = VLC_FALSE;
576 vlc_object_lock( p_playlist->p_fetcher );
577 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
578 p_playlist->p_fetcher->i_waiting,
579 p_playlist->p_fetcher->i_waiting, p);
580 vlc_object_signal_unlocked( p_playlist->p_fetcher );
581 vlc_object_unlock( p_playlist->p_fetcher );
583 /* We already have all needed meta, but we need art right now */
584 else if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
585 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
588 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
589 p.p_item = p_current;
590 p.b_fetch_art = VLC_TRUE;
591 vlc_object_lock( p_playlist->p_fetcher );
592 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
593 p_playlist->p_fetcher->i_waiting,
594 p_playlist->p_fetcher->i_waiting, p);
595 vlc_object_signal_unlocked( p_playlist->p_fetcher );
596 vlc_object_unlock( p_playlist->p_fetcher );
600 PL_DEBUG( "no fetch required for %s (art currently %s)",
601 psz_name, psz_arturl );
602 vlc_gc_decref( p_current );
611 vlc_object_lock( p_obj );
612 i_activity = var_GetInteger( p_playlist, "activity" );
613 if( i_activity < 0 ) i_activity = 0;
614 vlc_object_unlock( p_obj );
615 /* Sleep at least 1ms */
616 msleep( (i_activity+1) * 1000 );
623 * Main loop for secondary preparser queue
624 * \param p_obj items to preparse
627 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
629 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
630 vlc_bool_t b_fetch_art;
631 input_item_t *p_item;
634 while( !p_playlist->b_die )
636 vlc_mutex_lock( &p_obj->object_lock );
637 while( p_obj->i_waiting == 0 )
639 vlc_cond_wait( &p_obj->object_wait, &p_obj->object_lock );
640 if( p_playlist->b_die )
642 vlc_mutex_unlock( &p_obj->object_lock );
647 b_fetch_art = p_obj->p_waiting->b_fetch_art;
648 p_item = p_obj->p_waiting->p_item;
649 REMOVE_ELEM( p_obj->p_waiting, p_obj->i_waiting, 0 );
650 vlc_mutex_unlock( &p_obj->object_lock );
655 /* If the user doesn't want us to fetch meta automatically
657 if( p_playlist->p_fetcher->b_fetch_meta )
659 input_MetaFetch( p_playlist, p_item );
660 var_SetInteger( p_playlist, "item-change", p_item->i_id );
663 /* Fetch right now */
664 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL )
666 vlc_mutex_lock( &p_obj->object_lock );
669 p.b_fetch_art = VLC_TRUE;
670 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
671 p_playlist->p_fetcher->i_waiting,
673 PL_DEBUG( "meta fetched for %s, get art", p_item->psz_name );
674 vlc_mutex_unlock( &p_obj->object_lock );
678 vlc_gc_decref( p_item );
684 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
685 * (This can happen if we fetch art on play)
686 * FIXME this doesn't work if we need to fetch meta before art ... */
687 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
691 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
692 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
699 i_ret = input_ArtFind( p_playlist, p_item );
702 PL_DEBUG( "downloading art for %s", p_item->psz_name );
703 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
704 input_item_SetArtNotFound( p_item, VLC_TRUE );
706 input_item_SetArtFetched( p_item, VLC_TRUE );
707 var_SetInteger( p_playlist, "item-change",
711 else if( i_ret == 0 ) /* Was in cache */
713 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
714 input_item_SetArtFetched( p_item, VLC_TRUE );
715 var_SetInteger( p_playlist, "item-change", p_item->i_id );
719 PL_DEBUG( "art not found for %s", p_item->psz_name );
720 input_item_SetArtNotFound( p_item, VLC_TRUE );
722 vlc_gc_decref( p_item );
725 vlc_object_lock( p_obj );
726 i_activity = var_GetInteger( p_playlist, "activity" );
727 if( i_activity < 0 ) i_activity = 0;
728 vlc_object_unlock( p_obj );
729 /* Sleep at least 1ms */
730 msleep( (i_activity+1) * 1000 );
734 static void VariablesInit( playlist_t *p_playlist )
737 /* These variables control updates */
738 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
739 val.b_bool = VLC_TRUE;
740 var_Set( p_playlist, "intf-change", val );
742 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
744 var_Set( p_playlist, "item-change", val );
746 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
748 var_Set( p_playlist, "item-deleted", val );
750 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
752 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
754 var_Set( p_playlist, "playlist-current", val );
756 var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
758 var_Create( p_playlist, "intf-show", VLC_VAR_BOOL );
759 val.b_bool = VLC_TRUE;
760 var_Set( p_playlist, "intf-show", val );
762 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
763 var_SetInteger( p_playlist, "activity", 0 );
765 /* Variables to control playback */
766 var_CreateGetBool( p_playlist, "play-and-stop" );
767 var_CreateGetBool( p_playlist, "play-and-exit" );
768 var_CreateGetBool( p_playlist, "random" );
769 var_CreateGetBool( p_playlist, "repeat" );
770 var_CreateGetBool( p_playlist, "loop" );
772 var_AddCallback( p_playlist, "random", RandomCallback, NULL );