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 *****************************************************************************/
28 #include <vlc_playlist.h>
29 #include <vlc_interface.h>
30 #include "playlist_internal.h"
31 #include "stream_output/stream_output.h" /* sout_DeleteInstance */
33 /*****************************************************************************
35 *****************************************************************************/
36 static void VariablesInit( playlist_t *p_playlist );
38 static int RandomCallback( vlc_object_t *p_this, char const *psz_cmd,
39 vlc_value_t oldval, vlc_value_t newval, void *a )
41 (void)psz_cmd; (void)oldval; (void)newval; (void)a;
43 ((playlist_t*)p_this)->b_reset_currently_playing = VLC_TRUE;
44 playlist_Signal( ((playlist_t*)p_this) );
51 * Create a playlist structure.
52 * \param p_parent the vlc object that is to be the parent of this playlist
53 * \return a pointer to the created playlist, or NULL on error
55 playlist_t * playlist_Create( vlc_object_t *p_parent )
57 playlist_t *p_playlist;
61 /* Allocate structure */
62 p_playlist = vlc_object_create( p_parent, VLC_OBJECT_PLAYLIST );
65 msg_Err( p_parent, "out of memory" );
69 TAB_INIT( p_playlist->i_sds, p_playlist->pp_sds );
71 p_parent->p_libvlc->p_playlist = p_playlist;
73 VariablesInit( p_playlist );
75 /* Initialise data structures */
76 vlc_mutex_init( p_playlist, &p_playlist->gc_lock );
77 p_playlist->i_last_playlist_id = 0;
78 p_playlist->i_last_input_id = 0;
79 p_playlist->p_input = NULL;
81 p_playlist->gc_date = 0;
82 p_playlist->b_cant_sleep = VLC_FALSE;
84 ARRAY_INIT( p_playlist->items );
85 ARRAY_INIT( p_playlist->all_items );
86 ARRAY_INIT( p_playlist->input_items );
87 ARRAY_INIT( p_playlist->current );
89 p_playlist->i_current_index = 0;
90 p_playlist->b_reset_currently_playing = VLC_TRUE;
91 p_playlist->last_rebuild_date = 0;
93 i_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
94 p_playlist->b_always_tree = (i_tree == 1);
95 p_playlist->b_never_tree = (i_tree == 2);
97 p_playlist->b_doing_ml = VLC_FALSE;
99 p_playlist->b_auto_preparse =
100 var_CreateGetBool( p_playlist, "auto-preparse") ;
102 p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
104 p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
105 0, p_playlist->p_root_category->p_input );
107 if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
110 /* Create playlist and media library */
111 playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
112 &p_playlist->p_local_category,
113 &p_playlist->p_local_onelevel, VLC_FALSE );
115 p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
116 p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
118 if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
119 !p_playlist->p_local_category->p_input ||
120 !p_playlist->p_local_onelevel->p_input )
123 if( config_GetInt( p_playlist, "media-library") )
125 playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
126 &p_playlist->p_ml_category,
127 &p_playlist->p_ml_onelevel, VLC_FALSE );
129 if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
132 p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
133 p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
137 p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
141 p_playlist->status.p_item = NULL;
142 p_playlist->status.p_node = p_playlist->p_local_onelevel;
143 p_playlist->request.b_request = VLC_FALSE;
144 p_playlist->status.i_status = PLAYLIST_STOPPED;
146 p_playlist->i_sort = SORT_ID;
147 p_playlist->i_order = ORDER_NORMAL;
149 b_save = p_playlist->b_auto_preparse;
150 p_playlist->b_auto_preparse = VLC_FALSE;
151 playlist_MLLoad( p_playlist );
152 p_playlist->b_auto_preparse = VLC_TRUE;
156 void playlist_Destroy( playlist_t *p_playlist )
158 var_Destroy( p_playlist, "intf-change" );
159 var_Destroy( p_playlist, "item-change" );
160 var_Destroy( p_playlist, "playlist-current" );
161 var_Destroy( p_playlist, "intf-popupmenu" );
162 var_Destroy( p_playlist, "intf-show" );
163 var_Destroy( p_playlist, "play-and-stop" );
164 var_Destroy( p_playlist, "play-and-exit" );
165 var_Destroy( p_playlist, "random" );
166 var_Destroy( p_playlist, "repeat" );
167 var_Destroy( p_playlist, "loop" );
168 var_Destroy( p_playlist, "activity" );
170 vlc_mutex_destroy( &p_playlist->gc_lock );
171 vlc_object_detach( p_playlist );
172 vlc_object_destroy( p_playlist );
175 /* Destroy remaining objects */
176 static void ObjectGarbageCollector( playlist_t *p_playlist, vlc_bool_t b_force )
182 if( mdate() - p_playlist->gc_date < 1000000 )
184 p_playlist->b_cant_sleep = VLC_TRUE;
187 else if( p_playlist->gc_date == 0 )
191 vlc_mutex_lock( &p_playlist->gc_lock );
192 while( ( p_obj = vlc_object_find( p_playlist, VLC_OBJECT_VOUT,
195 if( p_obj->p_parent != VLC_OBJECT(p_playlist) )
197 vlc_object_release( p_obj );
200 msg_Dbg( p_playlist, "garbage collector destroying 1 vout" );
201 vlc_object_detach( p_obj );
202 vlc_object_release( p_obj );
203 vout_Destroy( (vout_thread_t *)p_obj );
205 while( ( p_obj = vlc_object_find( p_playlist, VLC_OBJECT_SOUT,
208 if( p_obj->p_parent != VLC_OBJECT(p_playlist) )
210 vlc_object_release( p_obj );
213 msg_Dbg( p_playlist, "garbage collector destroying 1 sout" );
214 vlc_object_detach( p_obj );
215 vlc_object_release( p_obj );
216 sout_DeleteInstance( (sout_instance_t*)p_obj );
218 p_playlist->b_cant_sleep = VLC_FALSE;
219 vlc_mutex_unlock( &p_playlist->gc_lock );
222 /** Main loop for the playlist */
223 void playlist_MainLoop( playlist_t *p_playlist )
225 playlist_item_t *p_item = NULL;
226 vlc_bool_t b_playexit = var_GetBool( p_playlist, "play-and-exit" );
229 if( p_playlist->b_reset_currently_playing &&
230 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
232 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random"),
233 p_playlist->status.p_item );
234 p_playlist->last_rebuild_date = mdate();
238 /* If there is an input, check that it doesn't need to die. */
239 if( p_playlist->p_input )
241 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
243 PL_DEBUG( "incoming request - stopping current input" );
244 input_StopThread( p_playlist->p_input );
247 /* This input is dead. Remove it ! */
248 if( p_playlist->p_input->b_dead )
251 input_thread_t *p_input;
252 PL_DEBUG( "dead input" );
254 p_input = p_playlist->p_input;
255 p_playlist->p_input = NULL;
257 /* Release the playlist lock, because we may get stuck
258 * in input_DestroyThread() for some time. */
262 input_DestroyThread( p_input );
266 p_playlist->gc_date = mdate();
267 p_playlist->b_cant_sleep = VLC_TRUE;
269 if( p_playlist->status.p_item->i_flags
270 & PLAYLIST_REMOVE_FLAG )
272 PL_DEBUG( "%s was marked for deletion, deleting",
273 PLI_NAME( p_playlist->status.p_item ) );
274 playlist_ItemDelete( p_playlist->status.p_item );
275 if( p_playlist->request.p_item == p_playlist->status.p_item )
276 p_playlist->request.p_item = NULL;
277 p_playlist->status.p_item = NULL;
280 i_activity= var_GetInteger( p_playlist, "activity") ;
281 var_SetInteger( p_playlist, "activity", i_activity -
282 DEFAULT_INPUT_ACTIVITY );
285 /* This input is dying, let it do */
286 else if( p_playlist->p_input->b_die )
288 PL_DEBUG( "dying input" );
290 msleep( INTF_IDLE_SLEEP );
294 /* This input has finished, ask it to die ! */
295 else if( p_playlist->p_input->b_error
296 || p_playlist->p_input->b_eof )
298 PL_DEBUG( "finished input" );
299 input_StopThread( p_playlist->p_input );
300 /* No need to wait here, we'll wait in the p_input->b_die case */
303 else if( p_playlist->p_input->i_state != INIT_S )
306 ObjectGarbageCollector( p_playlist, VLC_FALSE );
312 /* No input. Several cases
313 * - No request, running status -> start new item
314 * - No request, stopped status -> collect garbage
315 * - Request, running requested -> start new item
316 * - Request, stopped requested -> collect garbage
318 if( (!p_playlist->request.b_request &&
319 p_playlist->status.i_status != PLAYLIST_STOPPED) ||
320 ( p_playlist->request.b_request &&
321 p_playlist->request.i_status != PLAYLIST_STOPPED ) )
323 msg_Dbg( p_playlist, "starting new item" );
324 p_item = playlist_NextItem( p_playlist );
328 msg_Dbg( p_playlist, "nothing to play" );
329 p_playlist->status.i_status = PLAYLIST_STOPPED;
332 if( b_playexit == VLC_TRUE )
334 msg_Info( p_playlist, "end of playlist, exiting" );
335 vlc_object_kill( p_playlist->p_libvlc );
337 ObjectGarbageCollector( p_playlist, VLC_TRUE );
340 playlist_PlayItem( p_playlist, p_item );
344 const vlc_bool_t b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
346 p_playlist->status.i_status = PLAYLIST_STOPPED;
347 if( p_playlist->status.p_item &&
348 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
350 PL_DEBUG( "deleting item marked for deletion" );
351 playlist_ItemDelete( p_playlist->status.p_item );
352 p_playlist->status.p_item = NULL;
355 /* Collect garbage */
357 ObjectGarbageCollector( p_playlist, b_gc_forced );
364 /** Playlist dying last loop */
365 void playlist_LastLoop( playlist_t *p_playlist )
369 /* If there is an input, kill it */
373 if( p_playlist->p_input == NULL )
379 if( p_playlist->p_input->b_dead )
381 input_thread_t *p_input;
383 /* Unlink current input */
384 p_input = p_playlist->p_input;
385 p_playlist->p_input = NULL;
389 input_DestroyThread( p_input );
392 else if( p_playlist->p_input->b_die )
394 /* This input is dying, leave it alone */
397 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
399 input_StopThread( p_playlist->p_input );
405 p_playlist->p_input->b_eof = 1;
409 msleep( INTF_IDLE_SLEEP );
412 /* close all remaining sout */
413 while( ( p_obj = vlc_object_find( p_playlist,
414 VLC_OBJECT_SOUT, FIND_CHILD ) ) )
416 vlc_object_detach( p_obj );
417 vlc_object_release( p_obj );
418 sout_DeleteInstance( (sout_instance_t*)p_obj );
421 /* close all remaining vout */
422 while( ( p_obj = vlc_object_find( p_playlist,
423 VLC_OBJECT_VOUT, FIND_CHILD ) ) )
425 vlc_object_detach( p_obj );
426 vlc_object_release( p_obj );
427 vout_Destroy( (vout_thread_t *)p_obj );
430 while( p_playlist->i_sds )
432 playlist_ServicesDiscoveryRemove( p_playlist,
433 p_playlist->pp_sds[0]->p_sd->psz_module );
436 playlist_MLDump( p_playlist );
439 /* Go through all items, and simply free everything without caring
440 * about the tree structure. Do not decref, it will be done by doing
441 * the same thing on the input items array */
442 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
443 free( p_del->pp_children );
446 ARRAY_RESET( p_playlist->all_items );
448 FOREACH_ARRAY( input_item_t *p_del, p_playlist->input_items )
449 input_ItemClean( p_del );
452 ARRAY_RESET( p_playlist->input_items );
454 ARRAY_RESET( p_playlist->items );
455 ARRAY_RESET( p_playlist->current );
460 /** Main loop for preparser queue */
461 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
463 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
464 input_item_t *p_current;
468 while( !p_playlist->b_die )
470 vlc_mutex_lock( &p_obj->object_lock );
471 while( p_obj->i_waiting == 0 )
473 vlc_cond_wait( &p_obj->object_wait, &p_obj->object_lock );
474 if( p_playlist->b_die )
476 vlc_mutex_unlock( &p_obj->object_lock );
481 p_current = p_obj->pp_waiting[0];
482 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
483 vlc_mutex_unlock( &p_obj->object_lock );
488 if( p_current->i_type == ITEM_TYPE_FILE )
490 stats_TimerStart( p_playlist, "Preparse run",
491 STATS_TIMER_PREPARSE );
492 /* Do not preparse if it is already done (like by playing it) */
493 if( !input_item_IsPreparsed( p_current ) )
496 input_Preparse( p_playlist, p_current );
499 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
501 input_item_SetPreparsed( p_current, VLC_TRUE );
502 var_SetInteger( p_playlist, "item-change", p_current->i_id );
505 /* If we haven't retrieved enough meta, add to secondary queue
506 * which will run the "meta fetchers".
507 * This only checks for meta, not for art
508 * \todo don't do this for things we won't get meta for, like vids
510 char *psz_arturl = input_item_GetArtURL( p_current );
511 char *psz_name = input_item_GetName( p_current );
512 if( !input_MetaSatisfied( p_playlist, p_current, &i_m, &i_o ) )
515 PL_DEBUG("need to fetch meta for %s", p_current->psz_name );
516 p.p_item = p_current;
517 p.b_fetch_art = VLC_FALSE;
518 vlc_mutex_lock( &p_playlist->p_fetcher->object_lock );
519 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
520 p_playlist->p_fetcher->i_waiting,
521 p_playlist->p_fetcher->i_waiting, p);
522 vlc_cond_signal( &p_playlist->p_fetcher->object_wait );
523 vlc_mutex_unlock( &p_playlist->p_fetcher->object_lock );
525 /* We already have all needed meta, but we need art right now */
526 else if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
527 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
530 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
531 p.p_item = p_current;
532 p.b_fetch_art = VLC_TRUE;
533 vlc_mutex_lock( &p_playlist->p_fetcher->object_lock );
534 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
535 p_playlist->p_fetcher->i_waiting,
536 p_playlist->p_fetcher->i_waiting, p);
537 vlc_cond_signal( &p_playlist->p_fetcher->object_wait );
538 vlc_mutex_unlock( &p_playlist->p_fetcher->object_lock );
542 PL_DEBUG( "no fetch required for %s (art currently %s)",
543 psz_name, psz_arturl );
544 vlc_gc_decref( p_current );
553 vlc_mutex_lock( &p_obj->object_lock );
554 i_activity = var_GetInteger( p_playlist, "activity" );
555 if( i_activity < 0 ) i_activity = 0;
556 vlc_mutex_unlock( &p_obj->object_lock );
557 /* Sleep at least 1ms */
558 msleep( (i_activity+1) * 1000 );
562 /** Main loop for secondary preparser queue */
563 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
565 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
566 vlc_bool_t b_fetch_art;
567 input_item_t *p_item;
570 while( !p_playlist->b_die )
572 vlc_mutex_lock( &p_obj->object_lock );
573 while( p_obj->i_waiting == 0 )
575 vlc_cond_wait( &p_obj->object_wait, &p_obj->object_lock );
576 if( p_playlist->b_die )
578 vlc_mutex_unlock( &p_obj->object_lock );
583 b_fetch_art = p_obj->p_waiting->b_fetch_art;
584 p_item = p_obj->p_waiting->p_item;
585 REMOVE_ELEM( p_obj->p_waiting, p_obj->i_waiting, 0 );
586 vlc_mutex_unlock( &p_obj->object_lock );
591 /* If the user doesn't want us to fetch meta automatically
593 if( p_playlist->p_fetcher->b_fetch_meta )
595 input_MetaFetch( p_playlist, p_item );
596 var_SetInteger( p_playlist, "item-change", p_item->i_id );
599 /* Fetch right now */
600 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL )
602 vlc_mutex_lock( &p_obj->object_lock );
605 p.b_fetch_art = VLC_TRUE;
606 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
607 p_playlist->p_fetcher->i_waiting,
609 PL_DEBUG("meta fetched for %s, get art", p_item->psz_name);
610 vlc_mutex_unlock( &p_obj->object_lock );
614 vlc_gc_decref( p_item );
620 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
621 * (This can happen if we fetch art on play)
622 * FIXME this doesn't work if we need to fetch meta before art ... */
623 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
627 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
628 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
635 i_ret = input_ArtFind( p_playlist, p_item );
638 PL_DEBUG("downloading art for %s", p_item->psz_name );
639 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
640 input_item_SetArtNotFound( p_item, VLC_TRUE );
642 input_item_SetArtFetched( p_item, VLC_TRUE );
643 var_SetInteger( p_playlist, "item-change",
647 else if( i_ret == 0 ) /* Was in cache */
649 PL_DEBUG("found art for %s in cache", p_item->psz_name );
650 input_item_SetArtFetched( p_item, VLC_TRUE );
651 var_SetInteger( p_playlist, "item-change", p_item->i_id );
655 PL_DEBUG("art not found for %s", p_item->psz_name );
656 input_item_SetArtNotFound( p_item, VLC_TRUE );
658 vlc_gc_decref( p_item );
661 vlc_mutex_lock( &p_obj->object_lock );
662 i_activity = var_GetInteger( p_playlist, "activity" );
663 if( i_activity < 0 ) i_activity = 0;
664 vlc_mutex_unlock( &p_obj->object_lock );
665 /* Sleep at least 1ms */
666 msleep( (i_activity+1) * 1000 );
670 static void VariablesInit( playlist_t *p_playlist )
673 /* These variables control updates */
674 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
675 val.b_bool = VLC_TRUE;
676 var_Set( p_playlist, "intf-change", val );
678 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
680 var_Set( p_playlist, "item-change", val );
682 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
684 var_Set( p_playlist, "item-deleted", val );
686 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
688 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
690 var_Set( p_playlist, "playlist-current", val );
692 var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
694 var_Create( p_playlist, "intf-show", VLC_VAR_BOOL );
695 val.b_bool = VLC_TRUE;
696 var_Set( p_playlist, "intf-show", val );
698 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
699 var_SetInteger( p_playlist, "activity", 0 );
701 /* Variables to control playback */
702 var_CreateGetBool( p_playlist, "play-and-stop" );
703 var_CreateGetBool( p_playlist, "play-and-exit" );
704 var_CreateGetBool( p_playlist, "random" );
705 var_CreateGetBool( p_playlist, "repeat" );
706 var_CreateGetBool( p_playlist, "loop" );
708 var_AddCallback( p_playlist, "random", RandomCallback, NULL );