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 vlc_mutex_destroy( &p_playlist->p_stats->lock );
208 if( p_playlist->p_stats )
209 free( p_playlist->p_stats );
212 /* Destroy remaining objects */
213 static void ObjectGarbageCollector( playlist_t *p_playlist, vlc_bool_t b_force )
219 if( mdate() - p_playlist->gc_date < 1000000 )
221 p_playlist->b_cant_sleep = VLC_TRUE;
224 else if( p_playlist->gc_date == 0 )
228 vlc_mutex_lock( &p_playlist->gc_lock );
229 while( ( p_obj = vlc_object_find( p_playlist->p_libvlc, VLC_OBJECT_VOUT,
232 if( p_obj->p_parent != VLC_OBJECT(p_playlist->p_libvlc) )
234 vlc_object_release( p_obj );
237 msg_Dbg( p_playlist, "garbage collector destroying 1 vout" );
238 vlc_object_detach( p_obj );
239 vlc_object_release( p_obj );
240 vout_Destroy( (vout_thread_t *)p_obj );
242 while( ( p_obj = vlc_object_find( p_playlist, VLC_OBJECT_SOUT,
245 if( p_obj->p_parent != VLC_OBJECT(p_playlist) )
247 vlc_object_release( p_obj );
250 msg_Dbg( p_playlist, "garbage collector destroying 1 sout" );
251 vlc_object_detach( p_obj );
252 vlc_object_release( p_obj );
253 sout_DeleteInstance( (sout_instance_t*)p_obj );
255 p_playlist->b_cant_sleep = VLC_FALSE;
256 vlc_mutex_unlock( &p_playlist->gc_lock );
262 * Main loop for the playlist
263 * \param p_playlist the playlist object
266 void playlist_MainLoop( playlist_t *p_playlist )
268 playlist_item_t *p_item = NULL;
269 vlc_bool_t b_playexit = var_GetBool( p_playlist, "play-and-exit" );
272 if( p_playlist->b_reset_currently_playing &&
273 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
275 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
276 p_playlist->status.p_item );
277 p_playlist->last_rebuild_date = mdate();
281 /* If there is an input, check that it doesn't need to die. */
282 if( p_playlist->p_input )
284 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
286 PL_DEBUG( "incoming request - stopping current input" );
287 input_StopThread( p_playlist->p_input );
290 /* This input is dead. Remove it ! */
291 if( p_playlist->p_input->b_dead )
294 input_thread_t *p_input;
295 PL_DEBUG( "dead input" );
297 p_input = p_playlist->p_input;
298 p_playlist->p_input = NULL;
300 /* Release the playlist lock, because we may get stuck
301 * in vlc_object_release() for some time. */
305 vlc_object_release( p_input );
309 p_playlist->gc_date = mdate();
310 p_playlist->b_cant_sleep = VLC_TRUE;
312 if( p_playlist->status.p_item->i_flags
313 & PLAYLIST_REMOVE_FLAG )
315 PL_DEBUG( "%s was marked for deletion, deleting",
316 PLI_NAME( p_playlist->status.p_item ) );
317 playlist_ItemDelete( p_playlist->status.p_item );
318 if( p_playlist->request.p_item == p_playlist->status.p_item )
319 p_playlist->request.p_item = NULL;
320 p_playlist->status.p_item = NULL;
323 i_activity= var_GetInteger( p_playlist, "activity" );
324 var_SetInteger( p_playlist, "activity", i_activity -
325 DEFAULT_INPUT_ACTIVITY );
328 /* This input is dying, let it do */
329 else if( p_playlist->p_input->b_die )
331 PL_DEBUG( "dying input" );
333 msleep( INTF_IDLE_SLEEP );
337 /* This input has finished, ask it to die ! */
338 else if( p_playlist->p_input->b_error
339 || p_playlist->p_input->b_eof )
341 PL_DEBUG( "finished input" );
342 input_StopThread( p_playlist->p_input );
343 /* No need to wait here, we'll wait in the p_input->b_die case */
346 else if( p_playlist->p_input->i_state != INIT_S )
349 ObjectGarbageCollector( p_playlist, VLC_FALSE );
355 /* No input. Several cases
356 * - No request, running status -> start new item
357 * - No request, stopped status -> collect garbage
358 * - Request, running requested -> start new item
359 * - Request, stopped requested -> collect garbage
361 if( p_playlist->request.i_status != PLAYLIST_STOPPED )
363 msg_Dbg( p_playlist, "starting new item" );
364 p_item = playlist_NextItem( p_playlist );
368 msg_Dbg( p_playlist, "nothing to play" );
369 p_playlist->status.i_status = PLAYLIST_STOPPED;
372 if( b_playexit == VLC_TRUE )
374 msg_Info( p_playlist, "end of playlist, exiting" );
375 vlc_object_kill( p_playlist->p_libvlc );
377 ObjectGarbageCollector( p_playlist, VLC_TRUE );
380 playlist_PlayItem( p_playlist, p_item );
384 const vlc_bool_t b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
386 p_playlist->status.i_status = PLAYLIST_STOPPED;
387 if( p_playlist->status.p_item &&
388 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
390 PL_DEBUG( "deleting item marked for deletion" );
391 playlist_ItemDelete( p_playlist->status.p_item );
392 p_playlist->status.p_item = NULL;
395 /* Collect garbage */
397 ObjectGarbageCollector( p_playlist, b_gc_forced );
408 * The playlist is dying so do the last loop
409 * \param p_playlist the playlist object
412 void playlist_LastLoop( playlist_t *p_playlist )
416 /* If there is an input, kill it */
420 if( p_playlist->p_input == NULL )
426 if( p_playlist->p_input->b_dead )
428 input_thread_t *p_input;
430 /* Unlink current input */
431 p_input = p_playlist->p_input;
432 p_playlist->p_input = NULL;
436 vlc_object_release( p_input );
439 else if( p_playlist->p_input->b_die )
441 /* This input is dying, leave it alone */
444 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
446 input_StopThread( p_playlist->p_input );
452 p_playlist->p_input->b_eof = 1;
456 msleep( INTF_IDLE_SLEEP );
459 /* close all remaining sout */
460 while( ( p_obj = vlc_object_find( p_playlist,
461 VLC_OBJECT_SOUT, FIND_CHILD ) ) )
463 vlc_object_detach( p_obj );
464 vlc_object_release( p_obj );
465 sout_DeleteInstance( (sout_instance_t*)p_obj );
468 /* close all remaining vout */
469 while( ( p_obj = vlc_object_find( p_playlist,
470 VLC_OBJECT_VOUT, FIND_CHILD ) ) )
472 vlc_object_detach( p_obj );
473 vlc_object_release( p_obj );
474 vout_Destroy( (vout_thread_t *)p_obj );
477 while( p_playlist->i_sds )
479 playlist_ServicesDiscoveryRemove( p_playlist,
480 p_playlist->pp_sds[0]->p_sd->psz_module );
483 playlist_MLDump( p_playlist );
486 /* Go through all items, and simply free everything without caring
487 * about the tree structure. Do not decref, it will be done by doing
488 * the same thing on the input items array */
489 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
490 free( p_del->pp_children );
493 ARRAY_RESET( p_playlist->all_items );
495 ARRAY_RESET( p_playlist->items );
496 ARRAY_RESET( p_playlist->current );
504 * Main loop for preparser queue
505 * \param p_obj items to preparse
508 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
510 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
511 input_item_t *p_current;
515 while( !p_playlist->b_die )
517 vlc_object_lock( p_obj );
518 while( p_obj->i_waiting == 0 )
520 if( vlc_object_wait( p_obj ) || p_playlist->b_die )
522 vlc_object_unlock( p_obj );
527 p_current = p_obj->pp_waiting[0];
528 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
529 vlc_object_unlock( p_obj );
534 if( p_current->i_type == ITEM_TYPE_FILE )
536 stats_TimerStart( p_playlist, "Preparse run",
537 STATS_TIMER_PREPARSE );
538 /* Do not preparse if it is already done (like by playing it) */
539 if( !input_item_IsPreparsed( p_current ) )
542 input_Preparse( p_playlist, p_current );
545 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
547 input_item_SetPreparsed( p_current, VLC_TRUE );
548 var_SetInteger( p_playlist, "item-change", p_current->i_id );
551 /* If we haven't retrieved enough meta, add to secondary queue
552 * which will run the "meta fetchers".
553 * This only checks for meta, not for art
554 * \todo don't do this for things we won't get meta for, like vids
556 char *psz_arturl = input_item_GetArtURL( p_current );
557 char *psz_name = input_item_GetName( p_current );
558 if( !input_MetaSatisfied( p_playlist, p_current, &i_m, &i_o ) )
561 PL_DEBUG( "need to fetch meta for %s", p_current->psz_name );
562 p.p_item = p_current;
563 p.b_fetch_art = VLC_FALSE;
564 vlc_object_lock( p_playlist->p_fetcher );
565 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
566 p_playlist->p_fetcher->i_waiting,
567 p_playlist->p_fetcher->i_waiting, p);
568 vlc_object_signal_unlocked( p_playlist->p_fetcher );
569 vlc_object_unlock( p_playlist->p_fetcher );
571 /* We already have all needed meta, but we need art right now */
572 else if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
573 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
576 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
577 p.p_item = p_current;
578 p.b_fetch_art = VLC_TRUE;
579 vlc_object_lock( p_playlist->p_fetcher );
580 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
581 p_playlist->p_fetcher->i_waiting,
582 p_playlist->p_fetcher->i_waiting, p);
583 vlc_object_signal_unlocked( p_playlist->p_fetcher );
584 vlc_object_unlock( p_playlist->p_fetcher );
588 PL_DEBUG( "no fetch required for %s (art currently %s)",
589 psz_name, psz_arturl );
590 vlc_gc_decref( p_current );
599 vlc_object_lock( p_obj );
600 i_activity = var_GetInteger( p_playlist, "activity" );
601 if( i_activity < 0 ) i_activity = 0;
602 vlc_object_unlock( p_obj );
603 /* Sleep at least 1ms */
604 msleep( (i_activity+1) * 1000 );
611 * Main loop for secondary preparser queue
612 * \param p_obj items to preparse
615 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
617 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
618 vlc_bool_t b_fetch_art;
619 input_item_t *p_item;
622 while( !p_playlist->b_die )
624 vlc_mutex_lock( &p_obj->object_lock );
625 while( p_obj->i_waiting == 0 )
627 vlc_cond_wait( &p_obj->object_wait, &p_obj->object_lock );
628 if( p_playlist->b_die )
630 vlc_mutex_unlock( &p_obj->object_lock );
635 b_fetch_art = p_obj->p_waiting->b_fetch_art;
636 p_item = p_obj->p_waiting->p_item;
637 REMOVE_ELEM( p_obj->p_waiting, p_obj->i_waiting, 0 );
638 vlc_mutex_unlock( &p_obj->object_lock );
643 /* If the user doesn't want us to fetch meta automatically
645 if( p_playlist->p_fetcher->b_fetch_meta )
647 input_MetaFetch( p_playlist, p_item );
648 var_SetInteger( p_playlist, "item-change", p_item->i_id );
651 /* Fetch right now */
652 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL )
654 vlc_mutex_lock( &p_obj->object_lock );
657 p.b_fetch_art = VLC_TRUE;
658 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
659 p_playlist->p_fetcher->i_waiting,
661 PL_DEBUG( "meta fetched for %s, get art", p_item->psz_name );
662 vlc_mutex_unlock( &p_obj->object_lock );
666 vlc_gc_decref( p_item );
672 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
673 * (This can happen if we fetch art on play)
674 * FIXME this doesn't work if we need to fetch meta before art ... */
675 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
679 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
680 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
687 i_ret = input_ArtFind( p_playlist, p_item );
690 PL_DEBUG( "downloading art for %s", p_item->psz_name );
691 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
692 input_item_SetArtNotFound( p_item, VLC_TRUE );
694 input_item_SetArtFetched( p_item, VLC_TRUE );
695 var_SetInteger( p_playlist, "item-change",
699 else if( i_ret == 0 ) /* Was in cache */
701 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
702 input_item_SetArtFetched( p_item, VLC_TRUE );
703 var_SetInteger( p_playlist, "item-change", p_item->i_id );
707 PL_DEBUG( "art not found for %s", p_item->psz_name );
708 input_item_SetArtNotFound( p_item, VLC_TRUE );
710 vlc_gc_decref( p_item );
713 vlc_object_lock( p_obj );
714 i_activity = var_GetInteger( p_playlist, "activity" );
715 if( i_activity < 0 ) i_activity = 0;
716 vlc_object_unlock( p_obj );
717 /* Sleep at least 1ms */
718 msleep( (i_activity+1) * 1000 );
722 static void VariablesInit( playlist_t *p_playlist )
725 /* These variables control updates */
726 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
727 val.b_bool = VLC_TRUE;
728 var_Set( p_playlist, "intf-change", val );
730 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
732 var_Set( p_playlist, "item-change", val );
734 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
736 var_Set( p_playlist, "item-deleted", val );
738 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
740 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
742 var_Set( p_playlist, "playlist-current", val );
744 var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
746 var_Create( p_playlist, "intf-show", VLC_VAR_BOOL );
747 val.b_bool = VLC_TRUE;
748 var_Set( p_playlist, "intf-show", val );
750 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
751 var_SetInteger( p_playlist, "activity", 0 );
753 /* Variables to control playback */
754 var_CreateGetBool( p_playlist, "play-and-stop" );
755 var_CreateGetBool( p_playlist, "play-and-exit" );
756 var_CreateGetBool( p_playlist, "random" );
757 var_CreateGetBool( p_playlist, "repeat" );
758 var_CreateGetBool( p_playlist, "loop" );
760 var_AddCallback( p_playlist, "random", RandomCallback, NULL );