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