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 = 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 static const char playlist_name[] = "playlist";
62 playlist_t *p_playlist;
65 /* Allocate structure */
66 p_playlist = vlc_custom_create( p_parent, sizeof( *p_playlist ),
67 VLC_OBJECT_PLAYLIST, playlist_name );
70 msg_Err( p_parent, "out of memory" );
74 TAB_INIT( p_playlist->i_sds, p_playlist->pp_sds );
76 libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
78 VariablesInit( p_playlist );
80 /* Initialise data structures */
81 vlc_mutex_init( &p_playlist->gc_lock );
82 p_playlist->i_last_playlist_id = 0;
83 p_playlist->p_input = NULL;
85 p_playlist->gc_date = 0;
86 p_playlist->b_cant_sleep = false;
88 ARRAY_INIT( p_playlist->items );
89 ARRAY_INIT( p_playlist->all_items );
90 ARRAY_INIT( p_playlist->current );
92 p_playlist->i_current_index = 0;
93 p_playlist->b_reset_currently_playing = true;
94 p_playlist->last_rebuild_date = 0;
96 p_playlist->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
98 p_playlist->b_doing_ml = false;
100 p_playlist->b_auto_preparse =
101 var_CreateGetBool( p_playlist, "auto-preparse" ) ;
103 p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
105 p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
106 0, p_playlist->p_root_category->p_input );
108 if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
111 /* Create playlist and media library */
112 playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
113 &p_playlist->p_local_category,
114 &p_playlist->p_local_onelevel, false );
116 p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
117 p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
119 if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
120 !p_playlist->p_local_category->p_input ||
121 !p_playlist->p_local_onelevel->p_input )
124 if( config_GetInt( p_playlist, "media-library") )
126 playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
127 &p_playlist->p_ml_category,
128 &p_playlist->p_ml_onelevel, false );
130 if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
133 p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
134 p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
138 p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
142 p_playlist->status.p_item = NULL;
143 p_playlist->status.p_node = p_playlist->p_local_onelevel;
144 p_playlist->request.b_request = false;
145 p_playlist->status.i_status = PLAYLIST_STOPPED;
147 p_playlist->i_sort = SORT_ID;
148 p_playlist->i_order = ORDER_NORMAL;
151 b_save = p_playlist->b_auto_preparse;
152 p_playlist->b_auto_preparse = false;
153 playlist_MLLoad( p_playlist );
154 p_playlist->b_auto_preparse = true;
162 * Destroy a playlist structure.
163 * \param p_playlist the playlist object
166 void playlist_Destroy( playlist_t *p_playlist )
168 var_Destroy( p_playlist, "intf-change" );
169 var_Destroy( p_playlist, "item-change" );
170 var_Destroy( p_playlist, "playlist-current" );
171 var_Destroy( p_playlist, "intf-popupmenu" );
172 var_Destroy( p_playlist, "intf-show" );
173 var_Destroy( p_playlist, "play-and-stop" );
174 var_Destroy( p_playlist, "play-and-exit" );
175 var_Destroy( p_playlist, "random" );
176 var_Destroy( p_playlist, "repeat" );
177 var_Destroy( p_playlist, "loop" );
178 var_Destroy( p_playlist, "activity" );
180 if( p_playlist->p_preparse )
181 vlc_object_release( p_playlist->p_preparse );
182 if( p_playlist->p_fetcher )
183 vlc_object_release( p_playlist->p_fetcher );
185 vlc_object_release( p_playlist );
188 /* Destroy remaining objects */
189 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
195 if( mdate() - p_playlist->gc_date < 1000000 )
197 p_playlist->b_cant_sleep = true;
200 else if( p_playlist->gc_date == 0 )
204 vlc_mutex_lock( &p_playlist->gc_lock );
205 while( ( p_obj = vlc_object_find( p_playlist->p_libvlc, VLC_OBJECT_VOUT,
208 if( p_obj->p_parent != VLC_OBJECT(p_playlist->p_libvlc) )
210 vlc_object_release( p_obj );
213 msg_Dbg( p_playlist, "garbage collector destroying 1 vout" );
214 vlc_object_detach( p_obj );
215 vlc_object_release( p_obj );
216 vout_Destroy( (vout_thread_t *)p_obj );
219 while( ( p_obj = vlc_object_find( p_playlist, VLC_OBJECT_SOUT,
222 if( p_obj->p_parent != VLC_OBJECT(p_playlist) )
224 vlc_object_release( p_obj );
227 msg_Dbg( p_playlist, "garbage collector destroying 1 sout" );
228 vlc_object_detach( p_obj );
229 vlc_object_release( p_obj );
230 sout_DeleteInstance( (sout_instance_t*)p_obj );
233 p_playlist->b_cant_sleep = false;
234 vlc_mutex_unlock( &p_playlist->gc_lock );
240 * Main loop for the playlist
241 * \param p_playlist the playlist object
244 void playlist_MainLoop( playlist_t *p_playlist )
246 playlist_item_t *p_item = NULL;
247 bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
250 if( p_playlist->b_reset_currently_playing &&
251 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
253 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
254 p_playlist->status.p_item );
255 p_playlist->last_rebuild_date = mdate();
259 /* If there is an input, check that it doesn't need to die. */
260 if( p_playlist->p_input )
262 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
264 PL_DEBUG( "incoming request - stopping current input" );
265 input_StopThread( p_playlist->p_input );
268 /* This input is dead. Remove it ! */
269 if( p_playlist->p_input->b_dead )
272 input_thread_t *p_input;
273 PL_DEBUG( "dead input" );
275 p_input = p_playlist->p_input;
276 p_playlist->p_input = NULL;
278 /* Release the playlist lock, because we may get stuck
279 * in vlc_object_release() for some time. */
283 vlc_object_release( p_input );
287 p_playlist->gc_date = mdate();
288 p_playlist->b_cant_sleep = true;
290 if( p_playlist->status.p_item->i_flags
291 & PLAYLIST_REMOVE_FLAG )
293 PL_DEBUG( "%s was marked for deletion, deleting",
294 PLI_NAME( p_playlist->status.p_item ) );
295 playlist_ItemDelete( p_playlist->status.p_item );
296 if( p_playlist->request.p_item == p_playlist->status.p_item )
297 p_playlist->request.p_item = NULL;
298 p_playlist->status.p_item = NULL;
301 i_activity= var_GetInteger( p_playlist, "activity" );
302 var_SetInteger( p_playlist, "activity", i_activity -
303 DEFAULT_INPUT_ACTIVITY );
306 /* This input is dying, let it do */
307 else if( p_playlist->p_input->b_die )
309 PL_DEBUG( "dying input" );
311 msleep( INTF_IDLE_SLEEP );
315 /* This input has finished, ask it to die ! */
316 else if( p_playlist->p_input->b_error
317 || p_playlist->p_input->b_eof )
319 PL_DEBUG( "finished input" );
320 input_StopThread( p_playlist->p_input );
321 /* No need to wait here, we'll wait in the p_input->b_die case */
324 else if( p_playlist->p_input->i_state != INIT_S )
327 ObjectGarbageCollector( p_playlist, false );
333 /* No input. Several cases
334 * - No request, running status -> start new item
335 * - No request, stopped status -> collect garbage
336 * - Request, running requested -> start new item
337 * - Request, stopped requested -> collect garbage
339 int i_status = p_playlist->request.b_request ?
340 p_playlist->request.i_status : p_playlist->status.i_status;
341 if( i_status != PLAYLIST_STOPPED )
343 msg_Dbg( p_playlist, "starting new item" );
344 p_item = playlist_NextItem( p_playlist );
348 msg_Dbg( p_playlist, "nothing to play" );
349 p_playlist->status.i_status = PLAYLIST_STOPPED;
352 if( b_playexit == true )
354 msg_Info( p_playlist, "end of playlist, exiting" );
355 vlc_object_kill( p_playlist->p_libvlc );
357 ObjectGarbageCollector( p_playlist, true );
360 playlist_PlayItem( p_playlist, p_item );
364 const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
366 p_playlist->status.i_status = PLAYLIST_STOPPED;
367 if( p_playlist->status.p_item &&
368 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
370 PL_DEBUG( "deleting item marked for deletion" );
371 playlist_ItemDelete( p_playlist->status.p_item );
372 p_playlist->status.p_item = NULL;
375 /* Collect garbage */
377 ObjectGarbageCollector( p_playlist, b_gc_forced );
387 * The playlist is dying so do the last loop
388 * \param p_playlist the playlist object
391 void playlist_LastLoop( playlist_t *p_playlist )
395 /* If there is an input, kill it */
399 if( p_playlist->p_input == NULL )
405 if( p_playlist->p_input->b_dead )
407 input_thread_t *p_input;
409 /* Unlink current input */
410 p_input = p_playlist->p_input;
411 p_playlist->p_input = NULL;
415 vlc_object_release( p_input );
418 else if( p_playlist->p_input->b_die )
420 /* This input is dying, leave it alone */
423 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
425 input_StopThread( p_playlist->p_input );
431 p_playlist->p_input->b_eof = 1;
435 msleep( INTF_IDLE_SLEEP );
439 /* close all remaining sout */
440 while( ( p_obj = vlc_object_find( p_playlist,
441 VLC_OBJECT_SOUT, FIND_CHILD ) ) )
443 vlc_object_detach( p_obj );
444 vlc_object_release( p_obj );
445 sout_DeleteInstance( (sout_instance_t*)p_obj );
449 /* close all remaining vout */
450 while( ( p_obj = vlc_object_find( p_playlist,
451 VLC_OBJECT_VOUT, FIND_CHILD ) ) )
453 vlc_object_detach( p_obj );
454 vlc_object_release( p_obj );
455 vout_Destroy( (vout_thread_t *)p_obj );
458 while( p_playlist->i_sds )
460 playlist_ServicesDiscoveryRemove( p_playlist,
461 p_playlist->pp_sds[0]->p_sd->psz_module );
464 playlist_MLDump( p_playlist );
467 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
468 free( p_del->pp_children );
469 vlc_gc_decref( p_del->p_input );
472 ARRAY_RESET( p_playlist->all_items );
474 ARRAY_RESET( p_playlist->items );
475 ARRAY_RESET( p_playlist->current );
483 * Main loop for preparser queue
484 * \param p_obj items to preparse
487 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
489 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
490 input_item_t *p_current;
493 while( !p_playlist->b_die )
495 vlc_object_lock( p_obj );
496 while( p_obj->i_waiting == 0 )
498 if( vlc_object_wait( p_obj ) || p_playlist->b_die )
500 vlc_object_unlock( p_obj );
505 p_current = p_obj->pp_waiting[0];
506 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
507 vlc_object_unlock( p_obj );
512 if( p_current->i_type == ITEM_TYPE_FILE )
514 stats_TimerStart( p_playlist, "Preparse run",
515 STATS_TIMER_PREPARSE );
516 /* Do not preparse if it is already done (like by playing it) */
517 if( !input_item_IsPreparsed( p_current ) )
520 input_Preparse( p_playlist, p_current );
523 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
525 input_item_SetPreparsed( p_current, true );
526 var_SetInteger( p_playlist, "item-change", p_current->i_id );
529 /* If we haven't retrieved enough meta, add to secondary queue
530 * which will run the "meta fetchers".
531 * This only checks for meta, not for art
532 * \todo don't do this for things we won't get meta for, like vids
534 char *psz_arturl = input_item_GetArtURL( p_current );
535 char *psz_name = input_item_GetName( p_current );
536 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
537 ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
539 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
540 vlc_object_lock( p_playlist->p_fetcher );
541 INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
542 p_playlist->p_fetcher->i_waiting,
543 p_playlist->p_fetcher->i_waiting, p_current);
544 vlc_object_signal_unlocked( p_playlist->p_fetcher );
545 vlc_object_unlock( p_playlist->p_fetcher );
549 PL_DEBUG( "no fetch required for %s (art currently %s)",
550 psz_name, psz_arturl );
551 vlc_gc_decref( p_current );
560 vlc_object_lock( p_obj );
561 i_activity = var_GetInteger( p_playlist, "activity" );
562 if( i_activity < 0 ) i_activity = 0;
563 vlc_object_unlock( p_obj );
564 /* Sleep at least 1ms */
565 msleep( (i_activity+1) * 1000 );
572 * Main loop for secondary preparser queue
573 * \param p_obj items to preparse
576 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
578 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
579 input_item_t *p_item;
582 while( !p_playlist->b_die )
584 vlc_mutex_lock( &p_obj->object_lock );
585 while( p_obj->i_waiting == 0 )
587 vlc_cond_wait( &p_obj->object_wait, &p_obj->object_lock );
588 if( p_playlist->b_die )
590 vlc_mutex_unlock( &p_obj->object_lock );
595 p_item = p_obj->pp_waiting[0];
596 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
597 vlc_mutex_unlock( &p_obj->object_lock );
602 /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
603 * (This can happen if we fetch art on play)
604 * FIXME this doesn't work if we need to fetch meta before art ... */
605 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
609 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item ||
610 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
617 i_ret = input_ArtFind( p_playlist, p_item );
620 PL_DEBUG( "downloading art for %s", p_item->psz_name );
621 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
622 input_item_SetArtNotFound( p_item, true );
624 input_item_SetArtFetched( p_item, true );
625 var_SetInteger( p_playlist, "item-change",
629 else if( i_ret == 0 ) /* Was in cache */
631 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
632 input_item_SetArtFetched( p_item, true );
633 var_SetInteger( p_playlist, "item-change", p_item->i_id );
637 PL_DEBUG( "art not found for %s", p_item->psz_name );
638 input_item_SetArtNotFound( p_item, true );
640 vlc_gc_decref( p_item );
642 vlc_object_lock( p_obj );
643 i_activity = var_GetInteger( p_playlist, "activity" );
644 if( i_activity < 0 ) i_activity = 0;
645 vlc_object_unlock( p_obj );
646 /* Sleep at least 1ms */
647 msleep( (i_activity+1) * 1000 );
651 static void VariablesInit( playlist_t *p_playlist )
654 /* These variables control updates */
655 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
657 var_Set( p_playlist, "intf-change", val );
659 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
661 var_Set( p_playlist, "item-change", val );
663 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
665 var_Set( p_playlist, "item-deleted", val );
667 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
669 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
671 var_Set( p_playlist, "playlist-current", val );
673 var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
675 var_Create( p_playlist, "intf-show", VLC_VAR_BOOL );
677 var_Set( p_playlist, "intf-show", val );
679 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
680 var_SetInteger( p_playlist, "activity", 0 );
682 /* Variables to control playback */
683 var_CreateGetBool( p_playlist, "play-and-stop" );
684 var_CreateGetBool( p_playlist, "play-and-exit" );
685 var_CreateGetBool( p_playlist, "random" );
686 var_CreateGetBool( p_playlist, "repeat" );
687 var_CreateGetBool( p_playlist, "loop" );
689 var_AddCallback( p_playlist, "random", RandomCallback, NULL );