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 *****************************************************************************/
30 #include <vlc_common.h>
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 );
42 static void playlist_Destructor( vlc_object_t * p_this );
44 static int RandomCallback( vlc_object_t *p_this, char const *psz_cmd,
45 vlc_value_t oldval, vlc_value_t newval, void *a )
47 (void)psz_cmd; (void)oldval; (void)newval; (void)a;
49 ((playlist_t*)p_this)->b_reset_currently_playing = true;
50 playlist_Signal( ((playlist_t*)p_this) );
57 * Create a playlist structure.
58 * \param p_parent the vlc object that is to be the parent of this playlist
59 * \return a pointer to the created playlist, or NULL on error
61 playlist_t * playlist_Create( vlc_object_t *p_parent )
63 static const char playlist_name[] = "playlist";
64 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 libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
80 VariablesInit( p_playlist );
82 /* Initialise data structures */
83 vlc_mutex_init( &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 = 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 = true;
96 p_playlist->last_rebuild_date = 0;
98 p_playlist->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
100 p_playlist->b_doing_ml = false;
102 p_playlist->b_auto_preparse =
103 var_CreateGetBool( p_playlist, "auto-preparse" ) ;
105 p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
107 p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
108 0, p_playlist->p_root_category->p_input );
110 if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
113 /* Create playlist and media library */
114 playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
115 &p_playlist->p_local_category,
116 &p_playlist->p_local_onelevel, false );
118 p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
119 p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
121 if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
122 !p_playlist->p_local_category->p_input ||
123 !p_playlist->p_local_onelevel->p_input )
126 if( config_GetInt( p_playlist, "media-library") )
128 playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
129 &p_playlist->p_ml_category,
130 &p_playlist->p_ml_onelevel, false );
132 if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
135 p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
136 p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
140 p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
144 p_playlist->status.p_item = NULL;
145 p_playlist->status.p_node = p_playlist->p_local_onelevel;
146 p_playlist->request.b_request = false;
147 p_playlist->status.i_status = PLAYLIST_STOPPED;
149 p_playlist->i_sort = SORT_ID;
150 p_playlist->i_order = ORDER_NORMAL;
153 b_save = p_playlist->b_auto_preparse;
154 p_playlist->b_auto_preparse = false;
155 playlist_MLLoad( p_playlist );
156 p_playlist->b_auto_preparse = true;
158 vlc_object_set_destructor( p_playlist, playlist_Destructor );
166 * Destroy a playlist structure.
167 * \param p_playlist the playlist object
171 static void playlist_Destructor( vlc_object_t * p_this )
173 playlist_t * p_playlist = (playlist_t *)p_this;
175 if( p_playlist->p_preparse )
176 vlc_object_release( p_playlist->p_preparse );
178 if( p_playlist->p_fetcher )
179 vlc_object_release( p_playlist->p_fetcher );
181 libvlc_priv (p_this->p_libvlc)->p_playlist = NULL; /* pl_Yield() will fail */
185 /* Destroy remaining objects */
186 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
192 if( mdate() - p_playlist->gc_date < 1000000 )
194 p_playlist->b_cant_sleep = true;
197 else if( p_playlist->gc_date == 0 )
201 vlc_mutex_lock( &p_playlist->gc_lock );
202 p_playlist->b_cant_sleep = false;
203 vlc_mutex_unlock( &p_playlist->gc_lock );
207 void playlist_release_current_input( playlist_t * p_playlist )
209 vlc_assert_locked( &p_playlist->object_lock );
211 if( !p_playlist->p_input ) return;
213 input_thread_t * p_input = p_playlist->p_input;
214 p_playlist->p_input = NULL;
216 /* Release the playlist lock, because we may get stuck
217 * in vlc_object_release() for some time. */
219 vlc_object_release( p_input );
223 void playlist_set_current_input(
224 playlist_t * p_playlist, input_thread_t * p_input )
226 vlc_assert_locked( &p_playlist->object_lock );
228 playlist_release_current_input( p_playlist );
232 vlc_object_yield( p_input );
233 p_playlist->p_input = p_input;
244 * Main loop for the playlist
245 * \param p_playlist the playlist object
248 void playlist_MainLoop( playlist_t *p_playlist )
250 playlist_item_t *p_item = NULL;
251 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
254 if( p_playlist->b_reset_currently_playing &&
255 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
257 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
258 p_playlist->status.p_item );
259 p_playlist->last_rebuild_date = mdate();
263 /* If there is an input, check that it doesn't need to die. */
264 if( p_playlist->p_input )
266 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
268 PL_DEBUG( "incoming request - stopping current input" );
269 input_StopThread( p_playlist->p_input );
272 /* This input is dead. Remove it ! */
273 if( p_playlist->p_input->b_dead )
276 input_thread_t *p_input;
277 sout_instance_t **pp_sout =
278 &libvlc_priv(p_playlist->p_libvlc)->p_sout;
280 PL_DEBUG( "dead input" );
282 p_input = p_playlist->p_input;
284 assert( *pp_sout == NULL );
285 if( var_CreateGetBool( p_input, "sout-keep" ) )
286 *pp_sout = input_DetachSout( p_input );
289 playlist_release_current_input( p_playlist );
291 p_playlist->gc_date = mdate();
292 p_playlist->b_cant_sleep = true;
294 if( p_playlist->status.p_item->i_flags
295 & PLAYLIST_REMOVE_FLAG )
297 PL_DEBUG( "%s was marked for deletion, deleting",
298 PLI_NAME( p_playlist->status.p_item ) );
299 playlist_ItemDelete( p_playlist->status.p_item );
300 if( p_playlist->request.p_item == p_playlist->status.p_item )
301 p_playlist->request.p_item = NULL;
302 p_playlist->status.p_item = NULL;
305 i_activity= var_GetInteger( p_playlist, "activity" );
306 var_SetInteger( p_playlist, "activity", i_activity -
307 DEFAULT_INPUT_ACTIVITY );
311 /* This input is dying, let it do */
312 else if( p_playlist->p_input->b_die )
314 PL_DEBUG( "dying input" );
316 msleep( INTF_IDLE_SLEEP );
320 /* This input has finished, ask it to die ! */
321 else if( p_playlist->p_input->b_error
322 || p_playlist->p_input->b_eof )
324 PL_DEBUG( "finished input" );
325 input_StopThread( p_playlist->p_input );
326 /* No need to wait here, we'll wait in the p_input->b_die case */
329 else if( p_playlist->p_input->i_state != INIT_S )
332 ObjectGarbageCollector( p_playlist, false );
338 /* No input. Several cases
339 * - No request, running status -> start new item
340 * - No request, stopped status -> collect garbage
341 * - Request, running requested -> start new item
342 * - Request, stopped requested -> collect garbage
344 int i_status = p_playlist->request.b_request ?
345 p_playlist->request.i_status : p_playlist->status.i_status;
346 if( i_status != PLAYLIST_STOPPED )
348 msg_Dbg( p_playlist, "starting new item" );
349 p_item = playlist_NextItem( p_playlist );
353 msg_Dbg( p_playlist, "nothing to play" );
354 p_playlist->status.i_status = PLAYLIST_STOPPED;
357 if( b_playexit == true )
359 msg_Info( p_playlist, "end of playlist, exiting" );
360 vlc_object_kill( p_playlist->p_libvlc );
362 ObjectGarbageCollector( p_playlist, true );
365 playlist_PlayItem( p_playlist, p_item );
369 const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
371 p_playlist->status.i_status = PLAYLIST_STOPPED;
372 if( p_playlist->status.p_item &&
373 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
375 PL_DEBUG( "deleting item marked for deletion" );
376 playlist_ItemDelete( p_playlist->status.p_item );
377 p_playlist->status.p_item = NULL;
380 /* Collect garbage */
382 ObjectGarbageCollector( p_playlist, b_gc_forced );
392 * The playlist is dying so do the last loop
393 * \param p_playlist the playlist object
396 void playlist_LastLoop( playlist_t *p_playlist )
400 /* If there is an input, kill it */
404 if( p_playlist->p_input == NULL )
410 if( p_playlist->p_input->b_dead )
413 playlist_release_current_input( p_playlist );
415 /* sout-keep: no need to anything here.
416 * The last input will destroy its sout, if any, by itself */
421 else if( p_playlist->p_input->b_die )
423 /* This input is dying, leave it alone */
426 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
428 input_StopThread( p_playlist->p_input );
434 p_playlist->p_input->b_eof = 1;
438 msleep( INTF_IDLE_SLEEP );
442 /* close the remaining sout-keep (if there was no input atm) */
443 sout_instance_t *p_sout = libvlc_priv (p_playlist->p_libvlc)->p_sout;
445 sout_DeleteInstance( p_sout );
448 /* Core should have terminated all SDs before the playlist */
449 assert( p_playlist->i_sds == 0 );
450 playlist_MLDump( p_playlist );
453 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
454 free( p_del->pp_children );
455 vlc_gc_decref( p_del->p_input );
458 ARRAY_RESET( p_playlist->all_items );
460 ARRAY_RESET( p_playlist->items );
461 ARRAY_RESET( p_playlist->current );
469 * Main loop for preparser queue
470 * \param p_obj items to preparse
473 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
475 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
476 input_item_t *p_current;
479 vlc_object_lock( p_obj );
481 while( vlc_object_alive( p_obj ) )
483 if( p_obj->i_waiting == 0 )
485 vlc_object_wait( p_obj );
489 p_current = p_obj->pp_waiting[0];
490 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
491 vlc_object_unlock( p_obj );
496 if( p_current->i_type == ITEM_TYPE_FILE )
498 stats_TimerStart( p_playlist, "Preparse run",
499 STATS_TIMER_PREPARSE );
500 /* Do not preparse if it is already done (like by playing it) */
501 if( !input_item_IsPreparsed( p_current ) )
504 input_Preparse( p_playlist, p_current );
507 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
509 input_item_SetPreparsed( p_current, true );
510 var_SetInteger( p_playlist, "item-change", p_current->i_id );
513 /* If we haven't retrieved enough meta, add to secondary queue
514 * which will run the "meta fetchers".
515 * This only checks for meta, not for art
516 * \todo don't do this for things we won't get meta for, like vids
518 char *psz_arturl = input_item_GetArtURL( p_current );
519 char *psz_name = input_item_GetName( p_current );
520 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
521 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
523 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
524 vlc_object_lock( p_playlist->p_fetcher );
525 INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
526 p_playlist->p_fetcher->i_waiting,
527 p_playlist->p_fetcher->i_waiting, p_current);
528 vlc_object_signal_unlocked( p_playlist->p_fetcher );
529 vlc_object_unlock( p_playlist->p_fetcher );
533 PL_DEBUG( "no fetch required for %s (art currently %s)",
534 psz_name, psz_arturl );
535 vlc_gc_decref( p_current );
544 vlc_object_lock( p_obj );
545 i_activity = var_GetInteger( p_playlist, "activity" );
546 if( i_activity < 0 ) i_activity = 0;
547 vlc_object_unlock( p_obj );
548 /* Sleep at least 1ms */
549 msleep( (i_activity+1) * 1000 );
550 vlc_object_lock( p_obj );
552 vlc_object_unlock( p_obj );
558 * Main loop for secondary preparser queue
559 * \param p_obj items to preparse
562 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
564 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
565 input_item_t *p_item;
568 vlc_mutex_lock( &p_obj->object_lock );
570 while( vlc_object_alive( p_obj ) )
572 if( p_obj->i_waiting == 0 )
574 vlc_object_wait( p_obj );
578 p_item = p_obj->pp_waiting[0];
579 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
580 vlc_mutex_unlock( &p_obj->object_lock );
585 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
586 * (This can happen if we fetch art on play)
587 * FIXME this doesn't work if we need to fetch meta before art ... */
588 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
592 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
593 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
600 i_ret = input_ArtFind( p_playlist, p_item );
603 PL_DEBUG( "downloading art for %s", p_item->psz_name );
604 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
605 input_item_SetArtNotFound( p_item, true );
607 input_item_SetArtFetched( p_item, true );
608 var_SetInteger( p_playlist, "item-change",
612 else if( i_ret == 0 ) /* Was in cache */
614 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
615 input_item_SetArtFetched( p_item, true );
616 var_SetInteger( p_playlist, "item-change", p_item->i_id );
620 PL_DEBUG( "art not found for %s", p_item->psz_name );
621 input_item_SetArtNotFound( p_item, true );
623 vlc_gc_decref( p_item );
625 vlc_object_lock( p_obj );
626 i_activity = var_GetInteger( p_playlist, "activity" );
627 if( i_activity < 0 ) i_activity = 0;
628 vlc_object_unlock( p_obj );
629 /* Sleep at least 1ms */
630 msleep( (i_activity+1) * 1000 );
631 vlc_mutex_lock( &p_obj->object_lock );
633 vlc_mutex_unlock( &p_obj->object_lock );
636 static void VariablesInit( playlist_t *p_playlist )
639 /* These variables control updates */
640 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
642 var_Set( p_playlist, "intf-change", val );
644 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
646 var_Set( p_playlist, "item-change", val );
648 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
650 var_Set( p_playlist, "item-deleted", val );
652 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
654 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
656 var_Set( p_playlist, "playlist-current", val );
658 var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
660 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
661 var_SetInteger( p_playlist, "activity", 0 );
663 /* Variables to control playback */
664 var_CreateGetBool( p_playlist, "play-and-stop" );
665 var_CreateGetBool( p_playlist, "play-and-exit" );
666 var_CreateGetBool( p_playlist, "random" );
667 var_CreateGetBool( p_playlist, "repeat" );
668 var_CreateGetBool( p_playlist, "loop" );
670 var_AddCallback( p_playlist, "random", RandomCallback, NULL );