* Add a "media-library" option to enable/disable ML
[vlc.git] / src / playlist / engine.c
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  $
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *          ClĂ©ment Stenac <zorglub@videolan.org>
9  *
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.
14  *
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.
19  *
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  *****************************************************************************/
24 #include <vlc/vlc.h>
25 #include <vlc/vout.h>
26 #include <vlc/sout.h>
27 #include <vlc/input.h>
28 #include "vlc_playlist.h"
29 #include "vlc_interaction.h"
30
31 /*****************************************************************************
32  * Local prototypes
33  *****************************************************************************/
34 static void VariablesInit( playlist_t *p_playlist );
35
36 /**
37  * Create playlist
38  *
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
42  */
43 playlist_t * playlist_Create( vlc_object_t *p_parent )
44 {
45     playlist_t *p_playlist;
46
47     /* Allocate structure */
48     p_playlist = vlc_object_create( p_parent, VLC_OBJECT_PLAYLIST );
49     if( !p_playlist )
50     {
51         msg_Err( p_parent, "out of memory" );
52         return NULL;
53     }
54
55     VariablesInit( p_playlist );
56
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;
62
63     p_playlist->i_vout_destroyed_date = 0;
64     p_playlist->i_sout_destroyed_date = 0;
65
66     p_playlist->i_size = 0;
67     p_playlist->pp_items = NULL;
68     p_playlist->i_all_size = 0;
69     p_playlist->pp_all_items = NULL;
70
71     p_playlist->i_input_items = 0;
72     p_playlist->pp_input_items = NULL;
73
74     p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL);
75     p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL);
76
77     /* Create playlist and media library */
78     p_playlist->p_local_category = playlist_NodeCreate( p_playlist,
79                                  _( "Playlist" ),p_playlist->p_root_category );
80     p_playlist->p_local_onelevel =  playlist_NodeCreate( p_playlist,
81                                 _( "Playlist" ), p_playlist->p_root_onelevel );
82     p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
83     p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
84
85     /* Link the nodes together. Todo: actually create them from the same input*/
86     p_playlist->p_local_onelevel->p_input->i_id =
87         p_playlist->p_local_category->p_input->i_id;
88
89     if( config_GetInt( p_playlist, "media-library") )
90     {
91         p_playlist->p_ml_category =   playlist_NodeCreate( p_playlist,
92                            _( "Media Library" ), p_playlist->p_root_category );
93         p_playlist->p_ml_onelevel =  playlist_NodeCreate( p_playlist,
94                            _( "Media Library" ), p_playlist->p_root_onelevel );
95         p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
96         p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
97         p_playlist->p_ml_onelevel->p_input->i_id =
98              p_playlist->p_ml_category->p_input->i_id;
99     }
100     else
101     {
102         p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
103     }
104
105     /* Initial status */
106     p_playlist->status.p_item = NULL;
107     p_playlist->status.p_node = p_playlist->p_root_onelevel;
108     p_playlist->request.b_request = VLC_FALSE;
109     p_playlist->status.i_status = PLAYLIST_STOPPED;
110
111     p_playlist->i_sort = SORT_ID;
112     p_playlist->i_order = ORDER_NORMAL;
113
114     vlc_object_attach( p_playlist, p_parent );
115     return p_playlist;
116 }
117
118 void playlist_Destroy( playlist_t *p_playlist )
119 {
120     while( p_playlist->i_sds )
121     {
122         playlist_ServicesDiscoveryRemove( p_playlist,
123                                           p_playlist->pp_sds[0]->psz_module );
124     }
125     vlc_thread_join( p_playlist->p_preparse );
126     vlc_thread_join( p_playlist );
127
128     vlc_object_detach( p_playlist->p_preparse );
129
130     var_Destroy( p_playlist, "intf-change" );
131     var_Destroy( p_playlist, "item-change" );
132     var_Destroy( p_playlist, "playlist-current" );
133     var_Destroy( p_playlist, "intf-popmenu" );
134     var_Destroy( p_playlist, "intf-show" );
135     var_Destroy( p_playlist, "play-and-stop" );
136     var_Destroy( p_playlist, "random" );
137     var_Destroy( p_playlist, "repeat" );
138     var_Destroy( p_playlist, "loop" );
139     var_Destroy( p_playlist, "activity" );
140
141     PL_LOCK;
142     playlist_NodeDelete( p_playlist, p_playlist->p_root_category, VLC_TRUE,
143                          VLC_TRUE );
144     playlist_NodeDelete( p_playlist, p_playlist->p_root_onelevel, VLC_TRUE,
145                          VLC_TRUE );
146     PL_UNLOCK;
147
148     if( p_playlist->p_stats )
149         free( p_playlist->p_stats );
150
151     vlc_mutex_destroy( &p_playlist->gc_lock );
152     vlc_object_destroy( p_playlist->p_preparse );
153     vlc_object_destroy( p_playlist );
154
155 }
156 /* Destroy remaining objects */
157 static mtime_t ObjectGarbageCollector( playlist_t *p_playlist, int i_type,
158                                        mtime_t destroy_date )
159 {
160     vlc_object_t *p_obj;
161
162     if( destroy_date > mdate() ) return destroy_date;
163
164     if( destroy_date == 0 )
165     {
166         /* give a little time */
167         return mdate() + I64C(1000000);
168     }
169     else
170     {
171         vlc_mutex_lock( &p_playlist->gc_lock );
172         while( ( p_obj = vlc_object_find( p_playlist, i_type, FIND_CHILD ) ) )
173         {
174             if( p_obj->p_parent != (vlc_object_t*)p_playlist )
175             {
176                 /* only first child (ie unused) */
177                 vlc_object_release( p_obj );
178                 break;
179             }
180             if( i_type == VLC_OBJECT_VOUT )
181             {
182                 msg_Dbg( p_playlist, "garbage collector destroying 1 vout" );
183                 vlc_object_detach( p_obj );
184                 vlc_object_release( p_obj );
185                 vout_Destroy( (vout_thread_t *)p_obj );
186             }
187             else if( i_type == VLC_OBJECT_SOUT )
188             {
189                 vlc_object_release( p_obj );
190                 sout_DeleteInstance( (sout_instance_t*)p_obj );
191             }
192         }
193         vlc_mutex_unlock( &p_playlist->gc_lock );
194         return 0;
195     }
196 }
197
198 /** Main loop for the playlist */
199 void playlist_MainLoop( playlist_t *p_playlist )
200 {
201     playlist_item_t *p_item = NULL;
202
203
204     PL_LOCK
205
206     /* First, check if we have something to do */
207     /* FIXME : this can be called several times */
208     if( p_playlist->request.b_request )
209     {
210         /* Stop the existing input */
211         if( p_playlist->p_input && !p_playlist->p_input->b_die )
212         {
213             PL_DEBUG( "incoming request - stopping current input" );
214             input_StopThread( p_playlist->p_input );
215         }
216     }
217
218     /* If there is an input, check that it doesn't need to die. */
219     if( p_playlist->p_input )
220     {
221         /* This input is dead. Remove it ! */
222         if( p_playlist->p_input->b_dead )
223         {
224             int i_activity;
225             input_thread_t *p_input;
226
227             p_input = p_playlist->p_input;
228             p_playlist->p_input = NULL;
229
230             /* Release the playlist lock, because we may get stuck
231              * in input_DestroyThread() for some time. */
232             PL_UNLOCK
233
234             /* Destroy input */
235             input_DestroyThread( p_input );
236
237             /* Unlink current input
238              * (_after_ input_DestroyThread for vout garbage collector) */
239             vlc_object_detach( p_input );
240
241             /* Destroy object */
242             vlc_object_destroy( p_input );
243
244             p_playlist->i_vout_destroyed_date = 0;
245             p_playlist->i_sout_destroyed_date = 0;
246
247             if( p_playlist->status.p_item->i_flags
248                 & PLAYLIST_REMOVE_FLAG )
249             {
250                  playlist_ItemDelete( p_playlist->status.p_item );
251                  if( p_playlist->request.p_item == p_playlist->status.p_item )
252                      p_playlist->request.p_item = NULL;
253                  p_playlist->status.p_item = NULL;
254             }
255
256             i_activity= var_GetInteger( p_playlist, "activity") ;
257             var_SetInteger( p_playlist, "activity", i_activity -
258                             DEFAULT_INPUT_ACTIVITY );
259
260             return;
261         }
262         /* This input is dying, let it do */
263         else if( p_playlist->p_input->b_die )
264         {
265             ;
266         }
267         /* This input has finished, ask it to die ! */
268         else if( p_playlist->p_input->b_error
269                   || p_playlist->p_input->b_eof )
270         {
271             input_StopThread( p_playlist->p_input );
272             /* Select the next playlist item */
273             PL_UNLOCK
274             return;
275         }
276         else if( p_playlist->p_input->i_state != INIT_S )
277         {
278             PL_UNLOCK
279             p_playlist->i_vout_destroyed_date =
280                 ObjectGarbageCollector( p_playlist, VLC_OBJECT_VOUT,
281                                         p_playlist->i_vout_destroyed_date );
282             p_playlist->i_sout_destroyed_date =
283                 ObjectGarbageCollector( p_playlist, VLC_OBJECT_SOUT,
284                                         p_playlist->i_sout_destroyed_date );
285             PL_LOCK
286         }
287     }
288     else
289     {
290         /* No input. Several cases
291          *  - No request, running status -> start new item
292          *  - No request, stopped status -> collect garbage
293          *  - Request, running requested -> start new item
294          *  - Request, stopped requested -> collect garbage
295          */
296          if( (!p_playlist->request.b_request &&
297               p_playlist->status.i_status != PLAYLIST_STOPPED) ||
298               ( p_playlist->request.b_request &&
299                 p_playlist->request.i_status != PLAYLIST_STOPPED ) )
300          {
301              msg_Dbg( p_playlist, "Starting new item" );
302              stats_TimerStart( p_playlist, "Playlist walk",
303                                   STATS_TIMER_PLAYLIST_WALK );
304              p_item = playlist_NextItem( p_playlist );
305              stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_WALK );
306
307              if( p_item == NULL )
308              {
309                 msg_Dbg( p_playlist, "nothing to play" );
310                 p_playlist->status.i_status = PLAYLIST_STOPPED;
311                 PL_UNLOCK
312                 return;
313              }
314              playlist_PlayItem( p_playlist, p_item );
315          }
316          else
317          {
318              if( p_item && p_playlist->status.p_item &&
319                  p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
320              {
321                  playlist_ItemDelete( p_item );
322                  p_playlist->status.p_item = NULL;
323              }
324
325              /* Collect garbage */
326              PL_UNLOCK
327              p_playlist->i_sout_destroyed_date =
328              ObjectGarbageCollector( p_playlist, VLC_OBJECT_SOUT, mdate() );
329              p_playlist->i_vout_destroyed_date =
330              ObjectGarbageCollector( p_playlist, VLC_OBJECT_VOUT, mdate() );
331              PL_LOCK
332          }
333     }
334     PL_UNLOCK
335 }
336
337 /** Playlist dying last loop */
338 void playlist_LastLoop( playlist_t *p_playlist )
339 {
340     vlc_object_t *p_obj;
341
342     /* If there is an input, kill it */
343     while( 1 )
344     {
345         PL_LOCK
346
347         if( p_playlist->p_input == NULL )
348         {
349             PL_UNLOCK
350             break;
351         }
352
353         if( p_playlist->p_input->b_dead )
354         {
355             input_thread_t *p_input;
356
357             /* Unlink current input */
358             p_input = p_playlist->p_input;
359             p_playlist->p_input = NULL;
360             PL_UNLOCK
361
362             /* Destroy input */
363             input_DestroyThread( p_input );
364             /* Unlink current input (_after_ input_DestroyThread for vout
365              * garbage collector)*/
366             vlc_object_detach( p_input );
367
368             /* Destroy object */
369             vlc_object_destroy( p_input );
370             continue;
371         }
372         else if( p_playlist->p_input->b_die )
373         {
374             /* This input is dying, leave it alone */
375             ;
376         }
377         else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
378         {
379             input_StopThread( p_playlist->p_input );
380             PL_UNLOCK
381             continue;
382         }
383         else
384         {
385             p_playlist->p_input->b_eof = 1;
386         }
387
388         PL_UNLOCK
389
390         msleep( INTF_IDLE_SLEEP );
391     }
392
393     /* close all remaining sout */
394     while( ( p_obj = vlc_object_find( p_playlist,
395                                       VLC_OBJECT_SOUT, FIND_CHILD ) ) )
396     {
397         vlc_object_release( p_obj );
398         sout_DeleteInstance( (sout_instance_t*)p_obj );
399     }
400
401     /* close all remaining vout */
402     while( ( p_obj = vlc_object_find( p_playlist,
403                                       VLC_OBJECT_VOUT, FIND_CHILD ) ) )
404     {
405         vlc_object_detach( p_obj );
406         vlc_object_release( p_obj );
407         vout_Destroy( (vout_thread_t *)p_obj );
408     }
409 }
410
411 /** Main loop for preparser queue */
412 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
413 {
414     playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
415     int i_activity;
416
417     vlc_mutex_lock( &p_obj->object_lock );
418
419     if( p_obj->i_waiting > 0 )
420     {
421         input_item_t *p_current = p_playlist->p_preparse->pp_waiting[0];
422         REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
423         vlc_mutex_unlock( &p_obj->object_lock );
424         vlc_mutex_lock( &p_playlist->object_lock );
425         if( p_current )
426         {
427             vlc_bool_t b_preparsed = VLC_FALSE;
428             if( strncmp( p_current->psz_uri, "http:", 5 ) &&
429                 strncmp( p_current->psz_uri, "rtsp:", 5 ) &&
430                 strncmp( p_current->psz_uri, "udp:", 4 ) &&
431                 strncmp( p_current->psz_uri, "mms:", 4 ) &&
432                 strncmp( p_current->psz_uri, "cdda:", 4 ) &&
433                 strncmp( p_current->psz_uri, "dvd:", 4 ) &&
434                 strncmp( p_current->psz_uri, "v4l:", 4 ) &&
435                 strncmp( p_current->psz_uri, "dshow:", 6 ) )
436             {
437                 b_preparsed = VLC_TRUE;
438                 stats_TimerStart( p_playlist, "Preparse run",
439                                   STATS_TIMER_PREPARSE );
440                 input_Preparse( p_playlist, p_current );
441                 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
442             }
443             vlc_mutex_unlock( &p_playlist->object_lock );
444             if( b_preparsed )
445             {
446                 var_SetInteger( p_playlist, "item-change",
447                                 p_current->i_id );
448             }
449             vlc_gc_decref( p_current );
450         }
451         else
452         {
453             vlc_mutex_unlock( &p_playlist->object_lock );
454         }
455         vlc_mutex_lock( &p_obj->object_lock );
456         i_activity=  var_GetInteger( p_playlist, "activity" );
457         if( i_activity < 0 ) i_activity = 0;
458         vlc_mutex_unlock( &p_obj->object_lock );
459         msleep( (i_activity+1) * 1000 );
460         return;
461     }
462     vlc_mutex_unlock( &p_obj->object_lock );
463 }
464
465 static void VariablesInit( playlist_t *p_playlist )
466 {
467     vlc_value_t val;
468     /* These variables control updates */
469     var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
470     val.b_bool = VLC_TRUE;
471     var_Set( p_playlist, "intf-change", val );
472
473     var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
474     val.i_int = -1;
475     var_Set( p_playlist, "item-change", val );
476
477     var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
478     val.i_int = -1;
479     var_Set( p_playlist, "item-deleted", val );
480
481     var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
482
483     var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
484     val.i_int = -1;
485     var_Set( p_playlist, "playlist-current", val );
486
487     var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
488
489     var_Create( p_playlist, "intf-show", VLC_VAR_BOOL );
490     val.b_bool = VLC_TRUE;
491     var_Set( p_playlist, "intf-show", val );
492
493     var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
494     var_SetInteger( p_playlist, "activity", 0 );
495
496     /* Variables to control playback */
497     var_CreateGetBool( p_playlist, "play-and-stop" );
498     var_CreateGetBool( p_playlist, "random" );
499     var_CreateGetBool( p_playlist, "repeat" );
500     var_CreateGetBool( p_playlist, "loop" );
501 }