1 /*****************************************************************************
2 * engine.c : Run the playlist and handle its control
3 *****************************************************************************
4 * Copyright (C) 1999-2004 the VideoLAN team
5 * $Id: /local/vlc/0.8.6-playlist-vlm/src/playlist/playlist.c 13741 2006-03-21T19:29:39.792444Z zorglub $
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 *****************************************************************************/
27 #include <vlc/input.h>
28 #include "vlc_playlist.h"
29 #include "vlc_interaction.h"
31 /*****************************************************************************
33 *****************************************************************************/
34 static void VariablesInit( playlist_t *p_playlist );
39 * Create a playlist structure.
40 * \param p_parent the vlc object that is to be the parent of this playlist
41 * \return a pointer to the created playlist, or NULL on error
43 playlist_t * playlist_Create( vlc_object_t *p_parent )
45 playlist_t *p_playlist;
47 /* Allocate structure */
48 p_playlist = vlc_object_create( p_parent, VLC_OBJECT_PLAYLIST );
51 msg_Err( p_parent, "out of memory" );
55 VariablesInit( p_playlist );
57 /* Initialise data structures */
58 vlc_mutex_init( p_playlist, &p_playlist->gc_lock );
59 p_playlist->i_last_playlist_id = 0;
60 p_playlist->i_last_input_id = 0;
61 p_playlist->p_input = NULL;
63 p_playlist->i_size = 0;
64 p_playlist->pp_items = NULL;
65 p_playlist->i_all_size = 0;
66 p_playlist->pp_all_items = NULL;
68 p_playlist->i_input_items = 0;
69 p_playlist->pp_input_items = NULL;
71 p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL);
72 p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL);
74 /* Create playlist and media library */
75 p_playlist->p_local_category = playlist_NodeCreate( p_playlist,
76 _( "Playlist" ),p_playlist->p_root_category );
77 p_playlist->p_ml_category = playlist_NodeCreate( p_playlist,
78 _( "Media Library" ), p_playlist->p_root_category );
79 p_playlist->p_local_onelevel = playlist_NodeCreate( p_playlist,
80 _( "Playlist" ), p_playlist->p_root_onelevel );
81 p_playlist->p_ml_onelevel = playlist_NodeCreate( p_playlist,
82 _( "Media Library" ), p_playlist->p_root_onelevel );
84 /* This is a hack to find it later. Quite ugly, but I haven't found a
86 p_playlist->p_local_onelevel->p_input->i_id =
87 p_playlist->p_local_category->p_input->i_id;
88 p_playlist->p_ml_onelevel->p_input->i_id =
89 p_playlist->p_ml_category->p_input->i_id;
92 p_playlist->status.p_item = NULL;
93 p_playlist->status.p_node = p_playlist->p_root_onelevel;
94 p_playlist->request.b_request = VLC_FALSE;
95 p_playlist->status.i_status = PLAYLIST_STOPPED;
97 p_playlist->i_sort = SORT_ID;
98 p_playlist->i_order = ORDER_NORMAL;
100 vlc_object_attach( p_playlist, p_parent );
104 void playlist_Destroy( playlist_t *p_playlist )
106 while( p_playlist->i_sds )
108 playlist_ServicesDiscoveryRemove( p_playlist,
109 p_playlist->pp_sds[0]->psz_module );
111 vlc_thread_join( p_playlist->p_preparse );
112 vlc_thread_join( p_playlist );
114 vlc_object_detach( p_playlist->p_preparse );
116 var_Destroy( p_playlist, "intf-change" );
117 var_Destroy( p_playlist, "item-change" );
118 var_Destroy( p_playlist, "playlist-current" );
119 var_Destroy( p_playlist, "intf-popmenu" );
120 var_Destroy( p_playlist, "intf-show" );
121 var_Destroy( p_playlist, "play-and-stop" );
122 var_Destroy( p_playlist, "random" );
123 var_Destroy( p_playlist, "repeat" );
124 var_Destroy( p_playlist, "loop" );
125 var_Destroy( p_playlist, "activity" );
127 playlist_LockClear( p_playlist );
129 if( p_playlist->p_stats )
130 free( p_playlist->p_stats );
132 vlc_mutex_destroy( &p_playlist->gc_lock );
133 vlc_object_destroy( p_playlist->p_preparse );
134 vlc_object_destroy( p_playlist );
137 /* Destroy remaining objects */
138 static mtime_t ObjectGarbageCollector( playlist_t *p_playlist, int i_type,
139 mtime_t destroy_date )
143 if( destroy_date > mdate() ) return destroy_date;
145 if( destroy_date == 0 )
147 /* give a little time */
148 return mdate() + I64C(1000000);
152 vlc_mutex_lock( &p_playlist->gc_lock );
153 while( ( p_obj = vlc_object_find( p_playlist, i_type, FIND_CHILD ) ) )
155 if( p_obj->p_parent != (vlc_object_t*)p_playlist )
157 /* only first child (ie unused) */
158 vlc_object_release( p_obj );
161 if( i_type == VLC_OBJECT_VOUT )
163 msg_Dbg( p_playlist, "garbage collector destroying 1 vout" );
164 vlc_object_detach( p_obj );
165 vlc_object_release( p_obj );
166 vout_Destroy( (vout_thread_t *)p_obj );
168 else if( i_type == VLC_OBJECT_SOUT )
170 vlc_object_release( p_obj );
171 sout_DeleteInstance( (sout_instance_t*)p_obj );
174 vlc_mutex_unlock( &p_playlist->gc_lock );
179 /** Main loop for the playlist */
180 void playlist_MainLoop( playlist_t *p_playlist )
182 playlist_item_t *p_item = NULL;
184 mtime_t i_vout_destroyed_date = 0;
185 mtime_t i_sout_destroyed_date = 0;
189 /* First, check if we have something to do */
190 /* FIXME : this can be called several times */
191 if( p_playlist->request.b_request )
193 PL_DEBUG( "incoming request - stopping current input" );
194 /* Stop the existing input */
195 if( p_playlist->p_input )
197 input_StopThread( p_playlist->p_input );
201 /* If there is an input, check that it doesn't need to die. */
202 if( p_playlist->p_input )
204 /* This input is dead. Remove it ! */
205 if( p_playlist->p_input->b_dead )
208 input_thread_t *p_input;
210 p_input = p_playlist->p_input;
211 p_playlist->p_input = NULL;
213 /* Release the playlist lock, because we may get stuck
214 * in input_DestroyThread() for some time. */
218 input_DestroyThread( p_input );
220 /* Unlink current input
221 * (_after_ input_DestroyThread for vout garbage collector) */
222 vlc_object_detach( p_input );
225 vlc_object_destroy( p_input );
227 i_vout_destroyed_date = 0;
228 i_sout_destroyed_date = 0;
230 if( p_playlist->status.p_item->i_flags
231 & PLAYLIST_REMOVE_FLAG )
233 playlist_ItemDelete( p_playlist->status.p_item );
234 p_playlist->status.p_item = NULL;
237 i_activity= var_GetInteger( p_playlist, "activity") ;
238 var_SetInteger( p_playlist, "activity", i_activity -
239 DEFAULT_INPUT_ACTIVITY );
243 /* This input is dying, let it do */
244 else if( p_playlist->p_input->b_die )
248 /* This input has finished, ask it to die ! */
249 else if( p_playlist->p_input->b_error
250 || p_playlist->p_input->b_eof )
252 input_StopThread( p_playlist->p_input );
253 /* Select the next playlist item */
257 else if( p_playlist->p_input->i_state != INIT_S )
260 i_vout_destroyed_date =
261 ObjectGarbageCollector( p_playlist, VLC_OBJECT_VOUT,
262 i_vout_destroyed_date );
263 i_sout_destroyed_date =
264 ObjectGarbageCollector( p_playlist, VLC_OBJECT_SOUT,
265 i_sout_destroyed_date );
271 /* No input. Several cases
272 * - No request, running status -> start new item
273 * - No request, stopped status -> collect garbage
274 * - Request, running requested -> start new item
275 * - Request, stopped requested -> collect garbage
277 if( (!p_playlist->request.b_request &&
278 p_playlist->status.i_status != PLAYLIST_STOPPED) ||
279 ( p_playlist->request.b_request &&
280 p_playlist->request.i_status != PLAYLIST_STOPPED ) )
282 msg_Dbg( p_playlist, "Starting new item" );
283 stats_TimerStart( p_playlist, "Playlist walk",
284 STATS_TIMER_PLAYLIST_WALK );
285 p_item = playlist_NextItem( p_playlist );
286 stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_WALK );
290 msg_Dbg( p_playlist, "nothing to play" );
291 p_playlist->status.i_status = PLAYLIST_STOPPED;
295 playlist_PlayItem( p_playlist, p_item );
299 if( p_item && p_playlist->status.p_item &&
300 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
302 playlist_ItemDelete( p_item );
303 p_playlist->status.p_item = NULL;
306 /* Collect garbage */
308 i_sout_destroyed_date =
309 ObjectGarbageCollector( p_playlist, VLC_OBJECT_SOUT, mdate() );
310 i_vout_destroyed_date =
311 ObjectGarbageCollector( p_playlist, VLC_OBJECT_VOUT, mdate() );
318 /** Playlist dying last loop */
319 void playlist_LastLoop( playlist_t *p_playlist )
323 /* If there is an input, kill it */
328 if( p_playlist->p_input == NULL )
334 if( p_playlist->p_input->b_dead )
336 input_thread_t *p_input;
338 /* Unlink current input */
339 p_input = p_playlist->p_input;
340 p_playlist->p_input = NULL;
344 input_DestroyThread( p_input );
345 /* Unlink current input (_after_ input_DestroyThread for vout
346 * garbage collector)*/
347 vlc_object_detach( p_input );
350 vlc_object_destroy( p_input );
353 else if( p_playlist->p_input->b_die )
355 /* This input is dying, leave it alone */
358 else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
360 input_StopThread( p_playlist->p_input );
366 p_playlist->p_input->b_eof = 1;
371 msleep( INTF_IDLE_SLEEP );
374 /* close all remaining sout */
375 while( ( p_obj = vlc_object_find( p_playlist,
376 VLC_OBJECT_SOUT, FIND_CHILD ) ) )
378 vlc_object_release( p_obj );
379 sout_DeleteInstance( (sout_instance_t*)p_obj );
382 /* close all remaining vout */
383 while( ( p_obj = vlc_object_find( p_playlist,
384 VLC_OBJECT_VOUT, FIND_CHILD ) ) )
386 vlc_object_detach( p_obj );
387 vlc_object_release( p_obj );
388 vout_Destroy( (vout_thread_t *)p_obj );
392 /** Main loop for preparser queue */
393 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
395 playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
398 vlc_mutex_lock( &p_obj->object_lock );
400 if( p_obj->i_waiting > 0 )
402 input_item_t *p_current = p_playlist->p_preparse->pp_waiting[0];
403 REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
404 vlc_mutex_unlock( &p_obj->object_lock );
405 vlc_mutex_lock( &p_playlist->object_lock );
408 vlc_bool_t b_preparsed = VLC_FALSE;
409 if( strncmp( p_current->psz_uri, "http:", 5 ) &&
410 strncmp( p_current->psz_uri, "rtsp:", 5 ) &&
411 strncmp( p_current->psz_uri, "udp:", 4 ) &&
412 strncmp( p_current->psz_uri, "mms:", 4 ) &&
413 strncmp( p_current->psz_uri, "cdda:", 4 ) &&
414 strncmp( p_current->psz_uri, "dvd:", 4 ) &&
415 strncmp( p_current->psz_uri, "v4l:", 4 ) &&
416 strncmp( p_current->psz_uri, "dshow:", 6 ) )
418 b_preparsed = VLC_TRUE;
419 stats_TimerStart( p_playlist, "Preparse run",
420 STATS_TIMER_PREPARSE );
421 input_Preparse( p_playlist, p_current );
422 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
424 vlc_mutex_unlock( &p_playlist->object_lock );
427 var_SetInteger( p_playlist, "item-change",
430 vlc_gc_decref( p_current );
434 vlc_mutex_unlock( &p_playlist->object_lock );
436 vlc_mutex_lock( &p_obj->object_lock );
437 i_activity= var_GetInteger( p_playlist, "activity" );
438 if( i_activity < 0 ) i_activity = 0;
439 vlc_mutex_unlock( &p_obj->object_lock );
440 msleep( (i_activity+1) * 1000 );
443 vlc_mutex_unlock( &p_obj->object_lock );
446 static void VariablesInit( playlist_t *p_playlist )
449 /* These variables control updates */
450 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
451 val.b_bool = VLC_TRUE;
452 var_Set( p_playlist, "intf-change", val );
454 var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
456 var_Set( p_playlist, "item-change", val );
458 var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
460 var_Set( p_playlist, "item-deleted", val );
462 var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
464 var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
466 var_Set( p_playlist, "playlist-current", val );
468 var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
470 var_Create( p_playlist, "intf-show", VLC_VAR_BOOL );
471 val.b_bool = VLC_TRUE;
472 var_Set( p_playlist, "intf-show", val );
474 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
475 var_SetInteger( p_playlist, "activity", 0 );
477 /* Variables to control playback */
478 var_CreateGetBool( p_playlist, "play-and-stop" );
479 var_CreateGetBool( p_playlist, "random" );
480 var_CreateGetBool( p_playlist, "repeat" );
481 var_CreateGetBool( p_playlist, "loop" );