1f195f5b971ae21798adc103a46ad1354059b6d4
[vlc.git] / src / playlist / engine.c
1 /*****************************************************************************
2  * engine.c : Run the playlist and handle its control
3  *****************************************************************************
4  * Copyright (C) 1999-2007 the VideoLAN team
5  * $Id$
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
25 #ifdef HAVE_CONFIG_H
26 # include "config.h"
27 #endif
28
29 #include <vlc_common.h>
30 #include <vlc_vout.h>
31 #include <vlc_sout.h>
32 #include <vlc_playlist.h>
33 #include <vlc_interface.h>
34 #include "playlist_internal.h"
35 #include "stream_output/stream_output.h" /* sout_DeleteInstance */
36
37 /*****************************************************************************
38  * Local prototypes
39  *****************************************************************************/
40 static void VariablesInit( playlist_t *p_playlist );
41 static void playlist_Destructor( vlc_object_t * p_this );
42
43 static int RandomCallback( vlc_object_t *p_this, char const *psz_cmd,
44                            vlc_value_t oldval, vlc_value_t newval, void *a )
45 {
46     (void)psz_cmd; (void)oldval; (void)newval; (void)a;
47
48     ((playlist_t*)p_this)->b_reset_currently_playing = true;
49     playlist_Signal( ((playlist_t*)p_this) );
50     return VLC_SUCCESS;
51 }
52
53 /**
54  * Create playlist
55  *
56  * Create a playlist structure.
57  * \param p_parent the vlc object that is to be the parent of this playlist
58  * \return a pointer to the created playlist, or NULL on error
59  */
60 playlist_t * playlist_Create( vlc_object_t *p_parent )
61 {
62     static const char playlist_name[] = "playlist";
63     playlist_t *p_playlist;
64     bool b_save;
65
66     /* Allocate structure */
67     p_playlist = vlc_custom_create( p_parent, sizeof( *p_playlist ),
68                                     VLC_OBJECT_PLAYLIST, playlist_name );
69     if( !p_playlist )
70     {
71         msg_Err( p_parent, "out of memory" );
72         return NULL;
73     }
74
75     TAB_INIT( p_playlist->i_sds, p_playlist->pp_sds );
76
77     libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
78
79     VariablesInit( p_playlist );
80
81     /* Initialise data structures */
82     vlc_mutex_init( &p_playlist->gc_lock );
83     p_playlist->i_last_playlist_id = 0;
84     p_playlist->p_input = NULL;
85
86     p_playlist->gc_date = 0;
87     p_playlist->b_cant_sleep = false;
88
89     ARRAY_INIT( p_playlist->items );
90     ARRAY_INIT( p_playlist->all_items );
91     ARRAY_INIT( p_playlist->current );
92
93     p_playlist->i_current_index = 0;
94     p_playlist->b_reset_currently_playing = true;
95     p_playlist->last_rebuild_date = 0;
96
97     p_playlist->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
98
99     p_playlist->b_doing_ml = false;
100
101     p_playlist->b_auto_preparse =
102                         var_CreateGetBool( p_playlist, "auto-preparse" ) ;
103
104     p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
105                                     0, NULL );
106     p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
107                                     0, p_playlist->p_root_category->p_input );
108
109     if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
110         return NULL;
111
112     /* Create playlist and media library */
113     playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
114                             &p_playlist->p_local_category,
115                             &p_playlist->p_local_onelevel, false );
116
117     p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
118     p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
119
120     if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
121         !p_playlist->p_local_category->p_input ||
122         !p_playlist->p_local_onelevel->p_input )
123         return NULL;
124
125     if( config_GetInt( p_playlist, "media-library") )
126     {
127         playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
128                             &p_playlist->p_ml_category,
129                             &p_playlist->p_ml_onelevel, false );
130
131         if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
132             return NULL;
133
134         p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
135         p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
136     }
137     else
138     {
139         p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
140     }
141
142     /* Initial status */
143     p_playlist->status.p_item = NULL;
144     p_playlist->status.p_node = p_playlist->p_local_onelevel;
145     p_playlist->request.b_request = false;
146     p_playlist->status.i_status = PLAYLIST_STOPPED;
147
148     p_playlist->i_sort = SORT_ID;
149     p_playlist->i_order = ORDER_NORMAL;
150
151
152     b_save = p_playlist->b_auto_preparse;
153     p_playlist->b_auto_preparse = false;
154     playlist_MLLoad( p_playlist );
155     p_playlist->b_auto_preparse = true;
156
157     vlc_object_set_destructor( p_playlist, playlist_Destructor );
158
159     return p_playlist;
160 }
161
162 /**
163  * Destroy playlist
164  *
165  * Destroy a playlist structure.
166  * \param p_playlist the playlist object
167  * \return nothing
168  */
169
170 static void playlist_Destructor( vlc_object_t * p_this )
171 {
172     playlist_t * p_playlist = (playlist_t *)p_this;
173
174     if( p_playlist->p_preparse )
175         vlc_object_release( p_playlist->p_preparse );
176
177     if( p_playlist->p_fetcher )
178         vlc_object_release( p_playlist->p_fetcher );
179 }
180
181 /* Destroy remaining objects */
182 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
183 {
184     vlc_object_t *p_obj;
185
186     if( !b_force )
187     {
188         if( mdate() - p_playlist->gc_date < 1000000 )
189         {
190             p_playlist->b_cant_sleep = true;
191             return;
192         }
193         else if( p_playlist->gc_date == 0 )
194             return;
195     }
196
197     vlc_mutex_lock( &p_playlist->gc_lock );
198     while( ( p_obj = vlc_object_find( p_playlist->p_libvlc, VLC_OBJECT_VOUT,
199                                                   FIND_CHILD ) ) )
200     {
201         if( p_obj->p_parent != VLC_OBJECT(p_playlist->p_libvlc) )
202         {
203             vlc_object_release( p_obj );
204             break;
205         }
206         msg_Dbg( p_playlist, "garbage collector destroying 1 vout" );
207         vlc_object_detach( p_obj );
208         vlc_object_release( p_obj );
209         vlc_object_release( (vout_thread_t *)p_obj );
210     }
211 #ifdef ENABLE_SOUT
212     while( ( p_obj = vlc_object_find( p_playlist, VLC_OBJECT_SOUT,
213                                                   FIND_CHILD ) ) )
214     {
215         if( p_obj->p_parent != VLC_OBJECT(p_playlist) )
216         {
217             vlc_object_release( p_obj );
218             break;
219         }
220         msg_Dbg( p_playlist, "garbage collector destroying 1 sout" );
221         vlc_object_detach( p_obj );
222         vlc_object_release( p_obj );
223         sout_DeleteInstance( (sout_instance_t*)p_obj );
224     }
225 #endif
226     p_playlist->b_cant_sleep = false;
227     vlc_mutex_unlock( &p_playlist->gc_lock );
228 }
229
230 /**
231  * Main loop
232  *
233  * Main loop for the playlist
234  * \param p_playlist the playlist object
235  * \return nothing
236  */
237 void playlist_MainLoop( playlist_t *p_playlist )
238 {
239     playlist_item_t *p_item = NULL;
240     bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
241     PL_LOCK;
242
243     if( p_playlist->b_reset_currently_playing &&
244         mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
245     {
246         ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
247                              p_playlist->status.p_item );
248         p_playlist->last_rebuild_date = mdate();
249     }
250
251 check_input:
252     /* If there is an input, check that it doesn't need to die. */
253     if( p_playlist->p_input )
254     {
255         if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
256         {
257             PL_DEBUG( "incoming request - stopping current input" );
258             input_StopThread( p_playlist->p_input );
259         }
260
261         /* This input is dead. Remove it ! */
262         if( p_playlist->p_input->b_dead )
263         {
264             int i_activity;
265             input_thread_t *p_input;
266             PL_DEBUG( "dead input" );
267
268             p_input = p_playlist->p_input;
269             p_playlist->p_input = NULL;
270
271             /* Release the playlist lock, because we may get stuck
272              * in vlc_object_release() for some time. */
273             PL_UNLOCK;
274
275             /* Destroy input */
276             vlc_object_release( p_input );
277
278             PL_LOCK;
279
280             p_playlist->gc_date = mdate();
281             p_playlist->b_cant_sleep = true;
282
283             if( p_playlist->status.p_item->i_flags
284                 & PLAYLIST_REMOVE_FLAG )
285             {
286                  PL_DEBUG( "%s was marked for deletion, deleting",
287                                  PLI_NAME( p_playlist->status.p_item  ) );
288                  playlist_ItemDelete( p_playlist->status.p_item );
289                  if( p_playlist->request.p_item == p_playlist->status.p_item )
290                      p_playlist->request.p_item = NULL;
291                  p_playlist->status.p_item = NULL;
292             }
293
294             i_activity= var_GetInteger( p_playlist, "activity" );
295             var_SetInteger( p_playlist, "activity", i_activity -
296                             DEFAULT_INPUT_ACTIVITY );
297             goto check_input;
298         }
299         /* This input is dying, let it do */
300         else if( p_playlist->p_input->b_die )
301         {
302             PL_DEBUG( "dying input" );
303             PL_UNLOCK;
304             msleep( INTF_IDLE_SLEEP );
305             PL_LOCK;
306             goto check_input;
307         }
308         /* This input has finished, ask it to die ! */
309         else if( p_playlist->p_input->b_error
310                   || p_playlist->p_input->b_eof )
311         {
312             PL_DEBUG( "finished input" );
313             input_StopThread( p_playlist->p_input );
314             /* No need to wait here, we'll wait in the p_input->b_die case */
315             goto check_input;
316         }
317         else if( p_playlist->p_input->i_state != INIT_S )
318         {
319             PL_UNLOCK;
320             ObjectGarbageCollector( p_playlist, false );
321             PL_LOCK;
322         }
323     }
324     else
325     {
326         /* No input. Several cases
327          *  - No request, running status -> start new item
328          *  - No request, stopped status -> collect garbage
329          *  - Request, running requested -> start new item
330          *  - Request, stopped requested -> collect garbage
331         */
332         int i_status = p_playlist->request.b_request ?
333             p_playlist->request.i_status : p_playlist->status.i_status;
334         if( i_status != PLAYLIST_STOPPED )
335         {
336             msg_Dbg( p_playlist, "starting new item" );
337             p_item = playlist_NextItem( p_playlist );
338
339             if( p_item == NULL )
340             {
341                 msg_Dbg( p_playlist, "nothing to play" );
342                 p_playlist->status.i_status = PLAYLIST_STOPPED;
343                 PL_UNLOCK;
344
345                 if( b_playexit == true )
346                 {
347                     msg_Info( p_playlist, "end of playlist, exiting" );
348                     vlc_object_kill( p_playlist->p_libvlc );
349                 }
350                 ObjectGarbageCollector( p_playlist, true );
351                 return;
352              }
353              playlist_PlayItem( p_playlist, p_item );
354          }
355          else
356          {
357             const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
358
359             p_playlist->status.i_status = PLAYLIST_STOPPED;
360             if( p_playlist->status.p_item &&
361                 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
362             {
363                 PL_DEBUG( "deleting item marked for deletion" );
364                 playlist_ItemDelete( p_playlist->status.p_item );
365                 p_playlist->status.p_item = NULL;
366             }
367
368             /* Collect garbage */
369             PL_UNLOCK;
370             ObjectGarbageCollector( p_playlist, b_gc_forced );
371             PL_LOCK;
372         }
373     }
374     PL_UNLOCK;
375 }
376
377 /**
378  * Last loop
379  *
380  * The playlist is dying so do the last loop
381  * \param p_playlist the playlist object
382  * \return nothing
383 */
384 void playlist_LastLoop( playlist_t *p_playlist )
385 {
386     vlc_object_t *p_obj;
387
388     /* If there is an input, kill it */
389     while( 1 )
390     {
391         PL_LOCK;
392         if( p_playlist->p_input == NULL )
393         {
394             PL_UNLOCK;
395             break;
396         }
397
398         if( p_playlist->p_input->b_dead )
399         {
400             input_thread_t *p_input;
401
402             /* Unlink current input */
403             p_input = p_playlist->p_input;
404             p_playlist->p_input = NULL;
405             PL_UNLOCK;
406
407             /* Destroy input */
408             vlc_object_release( p_input );
409             continue;
410         }
411         else if( p_playlist->p_input->b_die )
412         {
413             /* This input is dying, leave it alone */
414             ;
415         }
416         else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
417         {
418             input_StopThread( p_playlist->p_input );
419             PL_UNLOCK;
420             continue;
421         }
422         else
423         {
424             p_playlist->p_input->b_eof = 1;
425         }
426         PL_UNLOCK;
427
428         msleep( INTF_IDLE_SLEEP );
429     }
430
431 #ifdef ENABLE_SOUT
432     /* close all remaining sout */
433     while( ( p_obj = vlc_object_find( p_playlist,
434                                       VLC_OBJECT_SOUT, FIND_CHILD ) ) )
435     {
436         vlc_object_detach( p_obj );
437         vlc_object_release( p_obj );
438         sout_DeleteInstance( (sout_instance_t*)p_obj );
439     }
440 #endif
441
442     /* close all remaining vout */
443     while( ( p_obj = vlc_object_find( p_playlist,
444                                       VLC_OBJECT_VOUT, FIND_CHILD ) ) )
445     {
446         vlc_object_detach( p_obj );
447         vlc_object_release( p_obj );
448         vlc_object_release( (vout_thread_t *)p_obj );
449     }
450
451     while( p_playlist->i_sds )
452     {
453         playlist_ServicesDiscoveryRemove( p_playlist,
454                                           p_playlist->pp_sds[0]->p_sd->psz_module );
455     }
456
457     playlist_MLDump( p_playlist );
458
459     PL_LOCK;
460     FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
461         free( p_del->pp_children );
462         vlc_gc_decref( p_del->p_input );
463         free( p_del );
464     FOREACH_END();
465     ARRAY_RESET( p_playlist->all_items );
466
467     ARRAY_RESET( p_playlist->items );
468     ARRAY_RESET( p_playlist->current );
469
470     PL_UNLOCK;
471 }
472
473 /**
474  * Preparse loop
475  *
476  * Main loop for preparser queue
477  * \param p_obj items to preparse
478  * \return nothing
479  */
480 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
481 {
482     playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
483     input_item_t *p_current;
484     int i_activity;
485
486     vlc_object_lock( p_obj );
487
488     while( vlc_object_alive( p_obj ) )
489     {
490         if( p_obj->i_waiting == 0 )
491         {
492             vlc_object_wait( p_obj );
493             continue;
494         }
495
496         p_current = p_obj->pp_waiting[0];
497         REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
498         vlc_object_unlock( p_obj );
499
500         PL_LOCK;
501         if( p_current )
502         {
503             if( p_current->i_type == ITEM_TYPE_FILE )
504             {
505                 stats_TimerStart( p_playlist, "Preparse run",
506                                   STATS_TIMER_PREPARSE );
507                 /* Do not preparse if it is already done (like by playing it) */
508                 if( !input_item_IsPreparsed( p_current ) )
509                 {
510                     PL_UNLOCK;
511                     input_Preparse( p_playlist, p_current );
512                     PL_LOCK;
513                 }
514                 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
515                 PL_UNLOCK;
516                 input_item_SetPreparsed( p_current, true );
517                 var_SetInteger( p_playlist, "item-change", p_current->i_id );
518                 PL_LOCK;
519             }
520             /* If we haven't retrieved enough meta, add to secondary queue
521              * which will run the "meta fetchers".
522              * This only checks for meta, not for art
523              * \todo don't do this for things we won't get meta for, like vids
524              */
525             char *psz_arturl = input_item_GetArtURL( p_current );
526             char *psz_name = input_item_GetName( p_current );
527             if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
528                         ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
529             {
530                 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
531                 vlc_object_lock( p_playlist->p_fetcher );
532                 INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
533                              p_playlist->p_fetcher->i_waiting,
534                              p_playlist->p_fetcher->i_waiting, p_current);
535                 vlc_object_signal_unlocked( p_playlist->p_fetcher );
536                 vlc_object_unlock( p_playlist->p_fetcher );
537             }
538             else
539             {
540                 PL_DEBUG( "no fetch required for %s (art currently %s)",
541                           psz_name, psz_arturl );
542                 vlc_gc_decref( p_current );
543             }
544             free( psz_name );
545             free( psz_arturl );
546             PL_UNLOCK;
547         }
548         else
549             PL_UNLOCK;
550
551         vlc_object_lock( p_obj );
552         i_activity = var_GetInteger( p_playlist, "activity" );
553         if( i_activity < 0 ) i_activity = 0;
554         vlc_object_unlock( p_obj );
555         /* Sleep at least 1ms */
556         msleep( (i_activity+1) * 1000 );
557         vlc_object_lock( p_obj );
558     }
559     vlc_object_unlock( p_obj );
560 }
561
562 /**
563  * Fetcher loop
564  *
565  * Main loop for secondary preparser queue
566  * \param p_obj items to preparse
567  * \return nothing
568  */
569 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
570 {
571     playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
572     input_item_t *p_item;
573     int i_activity;
574
575     vlc_mutex_lock( &p_obj->object_lock );
576
577     while( vlc_object_alive( p_obj ) )
578     {
579         if( p_obj->i_waiting == 0 )
580         {
581             vlc_object_wait( p_obj );
582             continue;
583         }
584
585         p_item = p_obj->pp_waiting[0];
586         REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
587         vlc_mutex_unlock( &p_obj->object_lock );
588         if( p_item )
589         {
590             int i_ret;
591
592             /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
593              * (This can happen if we fetch art on play)
594              * FIXME this doesn't work if we need to fetch meta before art ... */
595             for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
596             {
597                 bool b_break;
598                 PL_LOCK;
599                 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item  ||
600                             p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
601                 PL_UNLOCK;
602                 if( b_break )
603                     break;
604                 msleep( 50000 );
605             }
606
607             i_ret = input_ArtFind( p_playlist, p_item );
608             if( i_ret == 1 )
609             {
610                 PL_DEBUG( "downloading art for %s", p_item->psz_name );
611                 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
612                     input_item_SetArtNotFound( p_item, true );
613                 else {
614                     input_item_SetArtFetched( p_item, true );
615                     var_SetInteger( p_playlist, "item-change",
616                                     p_item->i_id );
617                 }
618             }
619             else if( i_ret == 0 ) /* Was in cache */
620             {
621                 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
622                 input_item_SetArtFetched( p_item, true );
623                 var_SetInteger( p_playlist, "item-change", p_item->i_id );
624             }
625             else
626             {
627                 PL_DEBUG( "art not found for %s", p_item->psz_name );
628                 input_item_SetArtNotFound( p_item, true );
629             }
630             vlc_gc_decref( p_item );
631         }
632         vlc_object_lock( p_obj );
633         i_activity = var_GetInteger( p_playlist, "activity" );
634         if( i_activity < 0 ) i_activity = 0;
635         vlc_object_unlock( p_obj );
636         /* Sleep at least 1ms */
637         msleep( (i_activity+1) * 1000 );
638         vlc_mutex_lock( &p_obj->object_lock );
639     }
640     vlc_mutex_unlock( &p_obj->object_lock );
641 }
642
643 static void VariablesInit( playlist_t *p_playlist )
644 {
645     vlc_value_t val;
646     /* These variables control updates */
647     var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
648     val.b_bool = true;
649     var_Set( p_playlist, "intf-change", val );
650
651     var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
652     val.i_int = -1;
653     var_Set( p_playlist, "item-change", val );
654
655     var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
656     val.i_int = -1;
657     var_Set( p_playlist, "item-deleted", val );
658
659     var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
660
661     var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
662     val.i_int = -1;
663     var_Set( p_playlist, "playlist-current", val );
664
665     var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
666
667     var_Create( p_playlist, "intf-show", VLC_VAR_BOOL );
668     val.b_bool = true;
669     var_Set( p_playlist, "intf-show", val );
670
671     var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
672     var_SetInteger( p_playlist, "activity", 0 );
673
674     /* Variables to control playback */
675     var_CreateGetBool( p_playlist, "play-and-stop" );
676     var_CreateGetBool( p_playlist, "play-and-exit" );
677     var_CreateGetBool( p_playlist, "random" );
678     var_CreateGetBool( p_playlist, "repeat" );
679     var_CreateGetBool( p_playlist, "loop" );
680
681     var_AddCallback( p_playlist, "random", RandomCallback, NULL );
682 }