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 while( p_playlist->i_sds )
163 playlist_ServicesDiscoveryRemove( p_playlist,
164 p_playlist->pp_sds[0]->psz_module );
167 playlist_MLDump( p_playlist );
169 vlc_thread_join( p_playlist->p_preparse );
170 vlc_thread_join( p_playlist->p_fetcher );
171 vlc_thread_join( p_playlist );
173 vlc_object_detach( p_playlist->p_preparse );
174 vlc_object_detach( p_playlist->p_fetcher );
176 var_Destroy( p_playlist, "intf-change" );
177 var_Destroy( p_playlist, "item-change" );
178 var_Destroy( p_playlist, "playlist-current" );
179 var_Destroy( p_playlist, "intf-popmenu" );
180 var_Destroy( p_playlist, "intf-show" );
181 var_Destroy( p_playlist, "play-and-stop" );
182 var_Destroy( p_playlist, "play-and-exit" );
183 var_Destroy( p_playlist, "random" );
184 var_Destroy( p_playlist, "repeat" );
185 var_Destroy( p_playlist, "loop" );
186 var_Destroy( p_playlist, "activity" );
189 /* Go through all items, and simply free everything without caring
190 * about the tree structure. Do not decref, it will be done by doing
191 * the same thing on the input items array */
192 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
193 free( p_del->pp_children );
196 ARRAY_RESET( p_playlist->all_items );
198 FOREACH_ARRAY( input_item_t *p_del, p_playlist->input_items )
199 input_ItemClean( p_del );
202 ARRAY_RESET( p_playlist->input_items );
204 ARRAY_RESET( p_playlist->items );
205 ARRAY_RESET( p_playlist->current );
209 vlc_mutex_destroy( &p_playlist->p_stats->lock );
210 if( p_playlist->p_stats )
211 free( p_playlist->p_stats );
213 vlc_mutex_destroy( &p_playlist->gc_lock );
214 vlc_object_destroy( p_playlist->p_preparse );
215 vlc_object_destroy( p_playlist->p_fetcher );
216 vlc_object_detach( p_playlist );
217 vlc_object_destroy( p_playlist );
220 /* Destroy remaining objects */
221 static void ObjectGarbageCollector( playlist_t *p_playlist )
225 if( mdate() - p_playlist->gc_date < 1000000 )
227 p_playlist->b_cant_sleep = VLC_TRUE;
230 else if( p_playlist->gc_date == 0 )
233 vlc_mutex_lock( &p_playlist->gc_lock );
234 while( ( p_obj = vlc_object_find( p_playlist, VLC_OBJECT_VOUT,
237 if( p_obj->p_parent != (vlc_object_t*)p_playlist )
239 vlc_object_release( p_obj );
242 msg_Dbg( p_playlist, "garbage collector destroying 1 vout" );
243 vlc_object_detach( p_obj );
244 vlc_object_release( p_obj );
245 vout_Destroy( (vout_thread_t *)p_obj );
247 while( ( p_obj = vlc_object_find( p_playlist, VLC_OBJECT_SOUT,
250 if( p_obj->p_parent != (vlc_object_t*)p_playlist )
252 vlc_object_release( p_obj );
255 vlc_object_release( p_obj );
256 sout_DeleteInstance( (sout_instance_t*)p_obj );
258 p_playlist->b_cant_sleep = VLC_FALSE;
259 vlc_mutex_unlock( &p_playlist->gc_lock );
262 /** Main loop for the playlist */
263 void playlist_MainLoop( playlist_t *p_playlist )
265 playlist_item_t *p_item = NULL;
266 vlc_bool_t b_playexit = var_GetBool( p_playlist, "play-and-exit" );
269 if( p_playlist->b_reset_currently_playing &&
270 mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
272 ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random"),
273 p_playlist->status.p_item );
274 p_playlist->last_rebuild_date = mdate();
278 /* If there is an input, check that it doesn't need to die. */
279 if( p_playlist->p_input )
281 if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
283 PL_DEBUG( "incoming request - stopping current input" );
284 input_StopThread( p_playlist->p_input );
287 /* This input is dead. Remove it ! */
288 if( p_playlist->p_input->b_dead )
291 input_thread_t *p_input;
292 PL_DEBUG( "dead input" );
294 p_input = p_playlist->p_input;
295 p_playlist->p_input = NULL;
297 /* Release the playlist lock, because we may get stuck
298 * in input_DestroyThread() for some time. */
302 input_DestroyThread( p_input );
304 /* Unlink current input
305 * (_after_ input_DestroyThread for vout garbage collector) */
306 vlc_object_detach( p_input );
309 vlc_object_destroy( p_input );
313 p_playlist->gc_date = mdate();
314 p_playlist->b_cant_sleep = VLC_TRUE;
316 if( p_playlist->status.p_item->i_flags
317 & PLAYLIST_REMOVE_FLAG )
319 PL_DEBUG( "%s was marked for deletion, deleting",
320 PLI_NAME( p_playlist->status.p_item ) );
321 playlist_ItemDelete( p_playlist->status.p_item );
322 if( p_playlist->request.p_item == p_playlist->status.p_item )
323 p_playlist->request.p_item = NULL;
324 p_playlist->status.p_item = NULL;
327 i_activity= var_GetInteger( p_playlist, "activity") ;
328 var_SetInteger( p_playlist, "activity", i_activity -
329 DEFAULT_INPUT_ACTIVITY );
332 /* This input is dying, let it do */
333 else if( p_playlist->p_input->b_die )
335 PL_DEBUG( "dying input" );
336 msleep( 25000 ); // 25 ms
339 /* This input has finished, ask it to die ! */
340 else if( p_playlist->p_input->b_error
341 || p_playlist->p_input->b_eof )
343 PL_DEBUG( "finished input" );
344 input_StopThread( p_playlist->p_input );
345 /* No need to wait here, we'll wait in the p_input->b_die case */
348 else if( p_playlist->p_input->i_state != INIT_S )
351 ObjectGarbageCollector( p_playlist );
357 /* No input. Several cases
358 * - No request, running status -> start new item
359 * - No request, stopped status -> collect garbage
360 * - Request, running requested -> start new item
361 * - Request, stopped requested -> collect garbage
363 if( (!p_playlist->request.b_request &&
364 p_playlist->status.i_status != PLAYLIST_STOPPED) ||
365 ( p_playlist->request.b_request &&
366 p_playlist->request.i_status != PLAYLIST_STOPPED ) )
368 msg_Dbg( p_playlist, "starting new item" );
369 p_item = playlist_NextItem( p_playlist );
373 msg_Dbg( p_playlist, "nothing to play" );
374 if( b_playexit == VLC_TRUE )
376 msg_Info( p_playlist, "end of playlist, exiting" );
377 p_playlist->p_libvlc->b_die = VLC_TRUE;
379 p_playlist->status.i_status = PLAYLIST_STOPPED;
383 playlist_PlayItem( p_playlist, p_item );
387 p_playlist->status.i_status = PLAYLIST_STOPPED;
388 if( p_playlist->status.p_item &&
389 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
391 PL_DEBUG( "deleting item marked for deletion" );
392 playlist_ItemDelete( p_playlist->status.p_item );
393 p_playlist->status.p_item = NULL;
396 /* Collect garbage */
398 ObjectGarbageCollector( p_playlist );
405 /** Playlist dying last loop */
406 void playlist_LastLoop( playlist_t *p_playlist )
410 /* If there is an input, kill it */
415 if( p_playlist->p_input == NULL )
421 if( p_playlist->p_input->b_dead )
423 input_thread_t *p_input;
425 /* Unlink current input */
426 p_input = p_playlist->p_input;
427 p_playlist->p_input = NULL;
431 input_DestroyThread( p_input );
432 /* Unlink current input (_after_ input_DestroyThread for vout
433 * garbage collector)*/
434 vlc_object_detach( p_input );
437 vlc_object_destroy( p_input );
440 else if( p_playlist->p_input->b_die )
442 /* This input is dying, leave it alone */
445 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
447 input_StopThread( p_playlist->p_input );
453 p_playlist->p_input->b_eof = 1;
458 msleep( INTF_IDLE_SLEEP );
461 /* close all remaining sout */
462 while( ( p_obj = vlc_object_find( p_playlist,
463 VLC_OBJECT_SOUT, FIND_CHILD ) ) )
465 vlc_object_release( p_obj );
466 sout_DeleteInstance( (sout_instance_t*)p_obj );
469 /* close all remaining vout */
470 while( ( p_obj = vlc_object_find( p_playlist,
471 VLC_OBJECT_VOUT, FIND_CHILD ) ) )
473 vlc_object_detach( p_obj );
474 vlc_object_release( p_obj );
475 vout_Destroy( (vout_thread_t *)p_obj );
479 /** Main loop for preparser queue */
480 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
482 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
483 input_item_t *p_current;
487 while( !p_playlist->b_die )
489 vlc_mutex_lock( &p_obj->object_lock );
490 while( p_obj->i_waiting == 0 )
492 vlc_cond_wait( &p_obj->object_wait, &p_obj->object_lock );
493 if( p_playlist->b_die )
495 vlc_mutex_unlock( &p_obj->object_lock );
500 p_current = p_obj->pp_waiting[0];
501 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
502 vlc_mutex_unlock( &p_obj->object_lock );
507 vlc_bool_t b_preparsed = VLC_FALSE;
508 if( strncmp( p_current->psz_uri, "http:", 5 ) &&
509 strncmp( p_current->psz_uri, "rtsp:", 5 ) &&
510 strncmp( p_current->psz_uri, "udp:", 4 ) &&
511 strncmp( p_current->psz_uri, "mms:", 4 ) &&
512 strncmp( p_current->psz_uri, "cdda:", 4 ) &&
513 strncmp( p_current->psz_uri, "dvd:", 4 ) &&
514 strncmp( p_current->psz_uri, "v4l:", 4 ) &&
515 strncmp( p_current->psz_uri, "dshow:", 6 ) )
517 b_preparsed = VLC_TRUE;
518 stats_TimerStart( p_playlist, "Preparse run",
519 STATS_TIMER_PREPARSE );
521 input_Preparse( p_playlist, p_current );
523 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
528 p_current->p_meta->i_status |= ITEM_PREPARSED;
529 var_SetInteger( p_playlist, "item-change", p_current->i_id );
533 /* If we haven't retrieved enough meta, add to secondary queue
534 * which will run the "meta fetchers".
535 * This only checks for meta, not for art
536 * \todo don't do this for things we won't get meta for, like vids
538 if( p_current->p_meta &&
539 !input_MetaSatisfied( p_playlist, p_current, &i_m, &i_o ) )
542 PL_DEBUG("need to fetch meta for %s", p_current->psz_name );
543 p.p_item = p_current;
544 p.b_fetch_art = VLC_FALSE;
545 vlc_mutex_lock( &p_playlist->p_fetcher->object_lock );
546 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
547 p_playlist->p_fetcher->i_waiting,
548 p_playlist->p_fetcher->i_waiting, p);
549 vlc_mutex_unlock( &p_playlist->p_fetcher->object_lock );
550 vlc_cond_signal( &p_playlist->p_fetcher->object_wait );
552 /* We already have all needed meta, but we need art right now */
553 else if( p_current->p_meta &&
554 p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
555 EMPTY_STR( p_current->p_meta->psz_arturl ) )
558 PL_DEBUG("meta ok for %s, need to fetch art",
559 p_current->psz_name );
560 p.p_item = p_current;
561 p.b_fetch_art = VLC_TRUE;
562 vlc_mutex_lock( &p_playlist->p_fetcher->object_lock );
563 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
564 p_playlist->p_fetcher->i_waiting,
565 p_playlist->p_fetcher->i_waiting, p);
566 vlc_mutex_unlock( &p_playlist->p_fetcher->object_lock );
567 vlc_cond_signal( &p_playlist->p_fetcher->object_wait );
571 PL_DEBUG( "no fetch required for %s (art currently %s)",
573 p_current->p_meta ? p_current->p_meta->psz_arturl:
575 vlc_gc_decref( p_current );
582 vlc_mutex_lock( &p_obj->object_lock );
583 i_activity = var_GetInteger( p_playlist, "activity" );
584 if( i_activity < 0 ) i_activity = 0;
585 vlc_mutex_unlock( &p_obj->object_lock );
586 /* Sleep at least 1ms */
587 msleep( (i_activity+1) * 1000 );
591 /** Main loop for secondary preparser queue */
592 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
594 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
595 vlc_bool_t b_fetch_art;
596 input_item_t *p_item;
599 while( !p_playlist->b_die )
601 vlc_mutex_lock( &p_obj->object_lock );
602 while( p_obj->i_waiting == 0 )
604 vlc_cond_wait( &p_obj->object_wait, &p_obj->object_lock );
605 if( p_playlist->b_die )
607 vlc_mutex_unlock( &p_obj->object_lock );
612 b_fetch_art = p_obj->p_waiting->b_fetch_art;
613 p_item = p_obj->p_waiting->p_item;
614 REMOVE_ELEM( p_obj->p_waiting, p_obj->i_waiting, 0 );
615 vlc_mutex_unlock( &p_obj->object_lock );
618 assert( p_item->p_meta );
621 input_MetaFetch( p_playlist, p_item );
622 p_item->p_meta->i_status |= ITEM_META_FETCHED;
623 var_SetInteger( p_playlist, "item-change", p_item->i_id );
624 /* Fetch right now */
625 if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL )
627 vlc_mutex_lock( &p_obj->object_lock );
630 p.b_fetch_art = VLC_TRUE;
631 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
632 p_playlist->p_fetcher->i_waiting,
634 PL_DEBUG("meta fetched for %s, get art", p_item->psz_name);
635 vlc_mutex_unlock( &p_obj->object_lock );
639 vlc_gc_decref( p_item );
643 int i_ret = input_ArtFind( p_playlist, p_item );
646 PL_DEBUG("downloading art for %s", p_item->psz_name );
647 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
648 p_item->p_meta->i_status |= ITEM_ART_NOTFOUND;
650 p_item->p_meta->i_status |= ITEM_ART_FETCHED;
651 var_SetInteger( p_playlist, "item-change",
655 else if( i_ret == 0 ) /* Was in cache */
657 PL_DEBUG("found art for %s in cache", p_item->psz_name );
658 p_item->p_meta->i_status |= ITEM_ART_FETCHED;
659 var_SetInteger( p_playlist, "item-change", p_item->i_id );
663 PL_DEBUG("art not found for %s", p_item->psz_name );
664 p_item->p_meta->i_status |= ITEM_ART_NOTFOUND;
666 vlc_gc_decref( p_item );
669 vlc_mutex_lock( &p_obj->object_lock );
670 i_activity = var_GetInteger( p_playlist, "activity" );
671 if( i_activity < 0 ) i_activity = 0;
672 vlc_mutex_unlock( &p_obj->object_lock );
673 /* Sleep at least 1ms */
674 msleep( (i_activity+1) * 1000 );
678 static void VariablesInit( playlist_t *p_playlist )
681 /* These variables control updates */
682 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
683 val.b_bool = VLC_TRUE;
684 var_Set( p_playlist, "intf-change", val );
686 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
688 var_Set( p_playlist, "item-change", val );
690 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
692 var_Set( p_playlist, "item-deleted", val );
694 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
696 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
698 var_Set( p_playlist, "playlist-current", val );
700 var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
702 var_Create( p_playlist, "intf-show", VLC_VAR_BOOL );
703 val.b_bool = VLC_TRUE;
704 var_Set( p_playlist, "intf-show", val );
706 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
707 var_SetInteger( p_playlist, "activity", 0 );
709 /* Variables to control playback */
710 var_CreateGetBool( p_playlist, "play-and-stop" );
711 var_CreateGetBool( p_playlist, "play-and-exit" );
712 var_CreateGetBool( p_playlist, "random" );
713 var_CreateGetBool( p_playlist, "repeat" );
714 var_CreateGetBool( p_playlist, "loop" );
716 var_AddCallback( p_playlist, "random", RandomCallback, NULL );