1 /*****************************************************************************
2 * engine.c : Run the playlist and handle its control
3 *****************************************************************************
4 * Copyright (C) 1999-2004 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 ((playlist_t*)p_this)->b_reset_currently_playing = VLC_TRUE;
42 playlist_Signal( ((playlist_t*)p_this) );
49 * Create a playlist structure.
50 * \param p_parent the vlc object that is to be the parent of this playlist
51 * \return a pointer to the created playlist, or NULL on error
53 playlist_t * playlist_Create( vlc_object_t *p_parent )
55 playlist_t *p_playlist;
59 /* Allocate structure */
60 p_playlist = vlc_object_create( p_parent, VLC_OBJECT_PLAYLIST );
63 msg_Err( p_parent, "out of memory" );
66 p_parent->p_libvlc->p_playlist = p_playlist;
68 VariablesInit( p_playlist );
70 /* Initialise data structures */
71 vlc_mutex_init( p_playlist, &p_playlist->gc_lock );
72 p_playlist->i_last_playlist_id = 0;
73 p_playlist->i_last_input_id = 0;
74 p_playlist->p_input = NULL;
76 p_playlist->gc_date = 0;
77 p_playlist->b_cant_sleep = VLC_FALSE;
79 ARRAY_INIT( p_playlist->items );
80 ARRAY_INIT( p_playlist->all_items );
81 ARRAY_INIT( p_playlist->input_items );
82 ARRAY_INIT( p_playlist->current );
84 p_playlist->i_current_index = 0;
85 p_playlist->b_reset_currently_playing = VLC_TRUE;
86 p_playlist->last_rebuild_date = 0;
88 i_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
89 p_playlist->b_always_tree = (i_tree == 1);
90 p_playlist->b_never_tree = (i_tree == 2);
92 p_playlist->b_doing_ml = VLC_FALSE;
94 p_playlist->b_auto_preparse =
95 var_CreateGetBool( p_playlist, "auto-preparse") ;
97 p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
99 p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
102 if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
105 /* Create playlist and media library */
106 p_playlist->p_local_category = playlist_NodeCreate( p_playlist,
107 _( "Playlist" ),p_playlist->p_root_category, 0 );
108 p_playlist->p_local_onelevel = playlist_NodeCreate( p_playlist,
109 _( "Playlist" ), p_playlist->p_root_onelevel, 0 );
110 p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
111 p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
113 if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
114 !p_playlist->p_local_category->p_input ||
115 !p_playlist->p_local_onelevel->p_input )
118 /* Link the nodes together. Todo: actually create them from the same input*/
119 p_playlist->p_local_onelevel->p_input->i_id =
120 p_playlist->p_local_category->p_input->i_id;
122 if( config_GetInt( p_playlist, "media-library") )
124 p_playlist->p_ml_category = playlist_NodeCreate( p_playlist,
125 _( "Media Library" ), p_playlist->p_root_category, 0 );
126 p_playlist->p_ml_onelevel = playlist_NodeCreate( p_playlist,
127 _( "Media Library" ), p_playlist->p_root_onelevel, 0 );
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;
134 p_playlist->p_ml_onelevel->p_input->i_id =
135 p_playlist->p_ml_category->p_input->i_id;
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 = VLC_FALSE;
147 p_playlist->status.i_status = PLAYLIST_STOPPED;
149 p_playlist->i_sort = SORT_ID;
150 p_playlist->i_order = ORDER_NORMAL;
152 b_save = p_playlist->b_auto_preparse;
153 p_playlist->b_auto_preparse = VLC_FALSE;
154 playlist_MLLoad( p_playlist );
155 p_playlist->b_auto_preparse = VLC_TRUE;
159 void playlist_Destroy( playlist_t *p_playlist )
161 var_Destroy( p_playlist, "intf-change" );
162 var_Destroy( p_playlist, "item-change" );
163 var_Destroy( p_playlist, "playlist-current" );
164 var_Destroy( p_playlist, "intf-popmenu" );
165 var_Destroy( p_playlist, "intf-show" );
166 var_Destroy( p_playlist, "play-and-stop" );
167 var_Destroy( p_playlist, "play-and-exit" );
168 var_Destroy( p_playlist, "random" );
169 var_Destroy( p_playlist, "repeat" );
170 var_Destroy( p_playlist, "loop" );
171 var_Destroy( p_playlist, "activity" );
173 vlc_mutex_destroy( &p_playlist->gc_lock );
174 vlc_object_detach( p_playlist );
175 vlc_object_destroy( p_playlist );
178 /* Destroy remaining objects */
179 static void ObjectGarbageCollector( playlist_t *p_playlist )
183 if( mdate() - p_playlist->gc_date < 1000000 )
185 p_playlist->b_cant_sleep = VLC_TRUE;
188 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_t*)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_t*)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( 25000 ); // 25 ms
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 );
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 if( b_playexit == VLC_TRUE )
331 msg_Info( p_playlist, "end of playlist, exiting" );
332 p_playlist->p_libvlc->b_die = VLC_TRUE;
334 p_playlist->status.i_status = PLAYLIST_STOPPED;
338 playlist_PlayItem( p_playlist, p_item );
342 p_playlist->status.i_status = PLAYLIST_STOPPED;
343 if( p_playlist->status.p_item &&
344 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
346 PL_DEBUG( "deleting item marked for deletion" );
347 playlist_ItemDelete( p_playlist->status.p_item );
348 p_playlist->status.p_item = NULL;
351 /* Collect garbage */
353 ObjectGarbageCollector( p_playlist );
360 /** Playlist dying last loop */
361 void playlist_LastLoop( playlist_t *p_playlist )
365 /* If there is an input, kill it */
370 if( p_playlist->p_input == NULL )
376 if( p_playlist->p_input->b_dead )
378 input_thread_t *p_input;
380 /* Unlink current input */
381 p_input = p_playlist->p_input;
382 p_playlist->p_input = NULL;
386 input_DestroyThread( p_input );
389 else if( p_playlist->p_input->b_die )
391 /* This input is dying, leave it alone */
394 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
396 input_StopThread( p_playlist->p_input );
402 p_playlist->p_input->b_eof = 1;
407 msleep( INTF_IDLE_SLEEP );
410 /* close all remaining sout */
411 while( ( p_obj = vlc_object_find( p_playlist,
412 VLC_OBJECT_SOUT, FIND_CHILD ) ) )
414 vlc_object_detach( p_obj );
415 vlc_object_release( p_obj );
416 sout_DeleteInstance( (sout_instance_t*)p_obj );
419 /* close all remaining vout */
420 while( ( p_obj = vlc_object_find( p_playlist,
421 VLC_OBJECT_VOUT, FIND_CHILD ) ) )
423 vlc_object_detach( p_obj );
424 vlc_object_release( p_obj );
425 vout_Destroy( (vout_thread_t *)p_obj );
428 while( p_playlist->i_sds )
430 playlist_ServicesDiscoveryRemove( p_playlist,
431 p_playlist->pp_sds[0]->psz_module );
434 playlist_MLDump( p_playlist );
437 /* Go through all items, and simply free everything without caring
438 * about the tree structure. Do not decref, it will be done by doing
439 * the same thing on the input items array */
440 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
441 free( p_del->pp_children );
444 ARRAY_RESET( p_playlist->all_items );
446 FOREACH_ARRAY( input_item_t *p_del, p_playlist->input_items )
447 input_ItemClean( p_del );
450 ARRAY_RESET( p_playlist->input_items );
452 ARRAY_RESET( p_playlist->items );
453 ARRAY_RESET( p_playlist->current );
458 /** Main loop for preparser queue */
459 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
461 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
462 input_item_t *p_current;
466 while( !p_playlist->b_die )
468 vlc_mutex_lock( &p_obj->object_lock );
469 while( p_obj->i_waiting == 0 )
471 vlc_cond_wait( &p_obj->object_wait, &p_obj->object_lock );
472 if( p_playlist->b_die )
474 vlc_mutex_unlock( &p_obj->object_lock );
479 p_current = p_obj->pp_waiting[0];
480 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
481 vlc_mutex_unlock( &p_obj->object_lock );
486 vlc_bool_t b_preparsed = VLC_FALSE;
487 if( strncmp( p_current->psz_uri, "http:", 5 ) &&
488 strncmp( p_current->psz_uri, "rtsp:", 5 ) &&
489 strncmp( p_current->psz_uri, "udp:", 4 ) &&
490 strncmp( p_current->psz_uri, "mms:", 4 ) &&
491 strncmp( p_current->psz_uri, "cdda:", 4 ) &&
492 strncmp( p_current->psz_uri, "dvd:", 4 ) &&
493 strncmp( p_current->psz_uri, "v4l:", 4 ) &&
494 strncmp( p_current->psz_uri, "dshow:", 6 ) )
496 b_preparsed = VLC_TRUE;
497 stats_TimerStart( p_playlist, "Preparse run",
498 STATS_TIMER_PREPARSE );
500 input_Preparse( p_playlist, p_current );
502 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
507 p_current->p_meta->i_status |= ITEM_PREPARSED;
508 var_SetInteger( p_playlist, "item-change", p_current->i_id );
512 /* If we haven't retrieved enough meta, add to secondary queue
513 * which will run the "meta fetchers".
514 * This only checks for meta, not for art
515 * \todo don't do this for things we won't get meta for, like vids
517 if( p_current->p_meta &&
518 !input_MetaSatisfied( p_playlist, p_current, &i_m, &i_o ) )
521 PL_DEBUG("need to fetch meta for %s", p_current->psz_name );
522 p.p_item = p_current;
523 p.b_fetch_art = VLC_FALSE;
524 vlc_mutex_lock( &p_playlist->p_fetcher->object_lock );
525 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
526 p_playlist->p_fetcher->i_waiting,
527 p_playlist->p_fetcher->i_waiting, p);
528 vlc_mutex_unlock( &p_playlist->p_fetcher->object_lock );
529 vlc_cond_signal( &p_playlist->p_fetcher->object_wait );
531 /* We already have all needed meta, but we need art right now */
532 else if( p_current->p_meta &&
533 p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
534 EMPTY_STR( p_current->p_meta->psz_arturl ) )
537 PL_DEBUG("meta ok for %s, need to fetch art",
538 p_current->psz_name );
539 p.p_item = p_current;
540 p.b_fetch_art = VLC_TRUE;
541 vlc_mutex_lock( &p_playlist->p_fetcher->object_lock );
542 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
543 p_playlist->p_fetcher->i_waiting,
544 p_playlist->p_fetcher->i_waiting, p);
545 vlc_mutex_unlock( &p_playlist->p_fetcher->object_lock );
546 vlc_cond_signal( &p_playlist->p_fetcher->object_wait );
550 PL_DEBUG( "no fetch required for %s (art currently %s)",
552 p_current->p_meta ? p_current->p_meta->psz_arturl:
554 vlc_gc_decref( p_current );
561 vlc_mutex_lock( &p_obj->object_lock );
562 i_activity = var_GetInteger( p_playlist, "activity" );
563 if( i_activity < 0 ) i_activity = 0;
564 vlc_mutex_unlock( &p_obj->object_lock );
565 /* Sleep at least 1ms */
566 msleep( (i_activity+1) * 1000 );
570 /** Main loop for secondary preparser queue */
571 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
573 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
574 vlc_bool_t b_fetch_art;
575 input_item_t *p_item;
578 while( !p_playlist->b_die )
580 vlc_mutex_lock( &p_obj->object_lock );
581 while( p_obj->i_waiting == 0 )
583 vlc_cond_wait( &p_obj->object_wait, &p_obj->object_lock );
584 if( p_playlist->b_die )
586 vlc_mutex_unlock( &p_obj->object_lock );
591 b_fetch_art = p_obj->p_waiting->b_fetch_art;
592 p_item = p_obj->p_waiting->p_item;
593 REMOVE_ELEM( p_obj->p_waiting, p_obj->i_waiting, 0 );
594 vlc_mutex_unlock( &p_obj->object_lock );
597 if( !p_item->p_meta )
601 input_MetaFetch( p_playlist, p_item );
602 p_item->p_meta->i_status |= ITEM_META_FETCHED;
603 var_SetInteger( p_playlist, "item-change", p_item->i_id );
604 /* Fetch right now */
605 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL )
607 vlc_mutex_lock( &p_obj->object_lock );
610 p.b_fetch_art = VLC_TRUE;
611 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
612 p_playlist->p_fetcher->i_waiting,
614 PL_DEBUG("meta fetched for %s, get art", p_item->psz_name);
615 vlc_mutex_unlock( &p_obj->object_lock );
619 vlc_gc_decref( p_item );
623 int i_ret = input_ArtFind( p_playlist, p_item );
626 PL_DEBUG("downloading art for %s", p_item->psz_name );
627 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
628 p_item->p_meta->i_status |= ITEM_ART_NOTFOUND;
630 p_item->p_meta->i_status |= ITEM_ART_FETCHED;
631 var_SetInteger( p_playlist, "item-change",
635 else if( i_ret == 0 ) /* Was in cache */
637 PL_DEBUG("found art for %s in cache", p_item->psz_name );
638 p_item->p_meta->i_status |= ITEM_ART_FETCHED;
639 var_SetInteger( p_playlist, "item-change", p_item->i_id );
643 PL_DEBUG("art not found for %s", p_item->psz_name );
644 p_item->p_meta->i_status |= ITEM_ART_NOTFOUND;
646 vlc_gc_decref( p_item );
649 vlc_mutex_lock( &p_obj->object_lock );
650 i_activity = var_GetInteger( p_playlist, "activity" );
651 if( i_activity < 0 ) i_activity = 0;
652 vlc_mutex_unlock( &p_obj->object_lock );
653 /* Sleep at least 1ms */
654 msleep( (i_activity+1) * 1000 );
658 static void VariablesInit( playlist_t *p_playlist )
661 /* These variables control updates */
662 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
663 val.b_bool = VLC_TRUE;
664 var_Set( p_playlist, "intf-change", val );
666 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
668 var_Set( p_playlist, "item-change", val );
670 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
672 var_Set( p_playlist, "item-deleted", val );
674 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
676 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
678 var_Set( p_playlist, "playlist-current", val );
680 var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
682 var_Create( p_playlist, "intf-show", VLC_VAR_BOOL );
683 val.b_bool = VLC_TRUE;
684 var_Set( p_playlist, "intf-show", val );
686 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
687 var_SetInteger( p_playlist, "activity", 0 );
689 /* Variables to control playback */
690 var_CreateGetBool( p_playlist, "play-and-stop" );
691 var_CreateGetBool( p_playlist, "play-and-exit" );
692 var_CreateGetBool( p_playlist, "random" );
693 var_CreateGetBool( p_playlist, "repeat" );
694 var_CreateGetBool( p_playlist, "loop" );
696 var_AddCallback( p_playlist, "random", RandomCallback, NULL );