]> git.sesse.net Git - vlc/blob - src/playlist/engine.c
playlist: Respond to input state changed event.
[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_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 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 #ifndef NDEBUG
181     libvlc_priv (p_this->p_libvlc)->p_playlist = NULL; /* pl_Yield() will fail */
182 #endif
183 }
184
185 /* Destroy remaining objects */
186 static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
187 {
188     vlc_object_t *p_obj;
189
190     if( !b_force )
191     {
192         if( mdate() - p_playlist->gc_date < 1000000 )
193         {
194             p_playlist->b_cant_sleep = true;
195             return;
196         }
197         else if( p_playlist->gc_date == 0 )
198             return;
199     }
200
201     vlc_mutex_lock( &p_playlist->gc_lock );
202     p_playlist->b_cant_sleep = false;
203     vlc_mutex_unlock( &p_playlist->gc_lock );
204 }
205
206 /* Input Callback */
207 static void input_state_changed( const vlc_event_t * event, void * data )
208 {
209     (void)event;
210     playlist_t * p_playlist = data;
211     playlist_Signal( p_playlist );
212 }
213
214 /* Internals */
215 void playlist_release_current_input( playlist_t * p_playlist )
216 {
217     vlc_assert_locked( &p_playlist->object_lock );
218
219     if( !p_playlist->p_input ) return;
220
221     input_thread_t * p_input = p_playlist->p_input;
222     vlc_event_manager_t * p_em = input_get_event_manager( p_input );
223
224     vlc_event_detach( p_em, vlc_InputStateChanged,
225                       input_state_changed, p_playlist );
226     p_playlist->p_input = NULL;
227
228     /* Release the playlist lock, because we may get stuck
229      * in vlc_object_release() for some time. */
230     PL_UNLOCK;
231     vlc_object_release( p_input );
232     PL_LOCK;
233 }
234
235 void playlist_set_current_input(
236     playlist_t * p_playlist, input_thread_t * p_input )
237 {
238     vlc_assert_locked( &p_playlist->object_lock );
239
240     playlist_release_current_input( p_playlist );
241
242     if( p_input )
243     {
244         vlc_object_yield( p_input );
245         p_playlist->p_input = p_input;
246         vlc_event_manager_t * p_em = input_get_event_manager( p_input );
247         vlc_event_attach( p_em, vlc_InputStateChanged,
248                           input_state_changed, p_playlist );
249     }
250 }
251
252
253 /**
254  * @}
255  */
256
257 /**
258  * Main loop
259  *
260  * Main loop for the playlist
261  * \param p_playlist the playlist object
262  * \return nothing
263  */
264 void playlist_MainLoop( playlist_t *p_playlist )
265 {
266     playlist_item_t *p_item = NULL;
267     bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
268     PL_LOCK;
269
270     if( p_playlist->b_reset_currently_playing &&
271         mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
272     {
273         ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
274                              p_playlist->status.p_item );
275         p_playlist->last_rebuild_date = mdate();
276     }
277
278 check_input:
279     /* If there is an input, check that it doesn't need to die. */
280     if( p_playlist->p_input )
281     {
282         if( p_playlist->request.b_request && !p_playlist->p_input->b_die )
283         {
284             PL_DEBUG( "incoming request - stopping current input" );
285             input_StopThread( p_playlist->p_input );
286         }
287
288         /* This input is dead. Remove it ! */
289         if( p_playlist->p_input->b_dead )
290         {
291             int i_activity;
292             input_thread_t *p_input;
293             sout_instance_t **pp_sout =
294                 &libvlc_priv(p_playlist->p_libvlc)->p_sout;
295
296             PL_DEBUG( "dead input" );
297
298             p_input = p_playlist->p_input;
299
300             assert( *pp_sout == NULL );
301             if( var_CreateGetBool( p_input, "sout-keep" ) )
302                 *pp_sout = input_DetachSout( p_input );
303
304             /* Destroy input */
305             playlist_release_current_input( p_playlist );
306
307             p_playlist->gc_date = mdate();
308             p_playlist->b_cant_sleep = true;
309
310             if( p_playlist->status.p_item->i_flags
311                 & PLAYLIST_REMOVE_FLAG )
312             {
313                  PL_DEBUG( "%s was marked for deletion, deleting",
314                                  PLI_NAME( p_playlist->status.p_item  ) );
315                  playlist_ItemDelete( p_playlist->status.p_item );
316                  if( p_playlist->request.p_item == p_playlist->status.p_item )
317                      p_playlist->request.p_item = NULL;
318                  p_playlist->status.p_item = NULL;
319             }
320
321             i_activity= var_GetInteger( p_playlist, "activity" );
322             var_SetInteger( p_playlist, "activity", i_activity -
323                             DEFAULT_INPUT_ACTIVITY );
324
325             goto check_input;
326         }
327         /* This input is dying, let it do */
328         else if( p_playlist->p_input->b_die )
329         {
330             PL_DEBUG( "dying input" );
331             PL_UNLOCK;
332             msleep( INTF_IDLE_SLEEP );
333             PL_LOCK;
334             goto check_input;
335         }
336         /* This input has finished, ask it to die ! */
337         else if( p_playlist->p_input->b_error
338                   || p_playlist->p_input->b_eof )
339         {
340             PL_DEBUG( "finished input" );
341             input_StopThread( p_playlist->p_input );
342             /* No need to wait here, we'll wait in the p_input->b_die case */
343             goto check_input;
344         }
345         else if( p_playlist->p_input->i_state != INIT_S )
346         {
347             PL_UNLOCK;
348             ObjectGarbageCollector( p_playlist, false );
349             PL_LOCK;
350         }
351     }
352     else
353     {
354         /* No input. Several cases
355          *  - No request, running status -> start new item
356          *  - No request, stopped status -> collect garbage
357          *  - Request, running requested -> start new item
358          *  - Request, stopped requested -> collect garbage
359         */
360         int i_status = p_playlist->request.b_request ?
361             p_playlist->request.i_status : p_playlist->status.i_status;
362         if( i_status != PLAYLIST_STOPPED )
363         {
364             msg_Dbg( p_playlist, "starting new item" );
365             p_item = playlist_NextItem( p_playlist );
366
367             if( p_item == NULL )
368             {
369                 msg_Dbg( p_playlist, "nothing to play" );
370                 p_playlist->status.i_status = PLAYLIST_STOPPED;
371                 PL_UNLOCK;
372
373                 if( b_playexit == true )
374                 {
375                     msg_Info( p_playlist, "end of playlist, exiting" );
376                     vlc_object_kill( p_playlist->p_libvlc );
377                 }
378                 ObjectGarbageCollector( p_playlist, true );
379                 return;
380              }
381              playlist_PlayItem( p_playlist, p_item );
382          }
383          else
384          {
385             const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
386
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 )
390             {
391                 PL_DEBUG( "deleting item marked for deletion" );
392                 playlist_ItemDelete( p_playlist->status.p_item );
393                 p_playlist->status.p_item = NULL;
394             }
395
396             /* Collect garbage */
397             PL_UNLOCK;
398             ObjectGarbageCollector( p_playlist, b_gc_forced );
399             PL_LOCK;
400         }
401     }
402     PL_UNLOCK;
403 }
404
405 /**
406  * Last loop
407  *
408  * The playlist is dying so do the last loop
409  * \param p_playlist the playlist object
410  * \return nothing
411 */
412 void playlist_LastLoop( playlist_t *p_playlist )
413 {
414     vlc_object_t *p_obj;
415
416     /* If there is an input, kill it */
417     while( 1 )
418     {
419         PL_LOCK;
420         if( p_playlist->p_input == NULL )
421         {
422             PL_UNLOCK;
423             break;
424         }
425
426         if( p_playlist->p_input->b_dead )
427         {
428             /* remove input */
429             playlist_release_current_input( p_playlist );
430
431             /* sout-keep: no need to anything here.
432              * The last input will destroy its sout, if any, by itself */
433
434             PL_UNLOCK;
435             continue;
436         }
437         else if( p_playlist->p_input->b_die )
438         {
439             /* This input is dying, leave it alone */
440             ;
441         }
442         else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
443         {
444             input_StopThread( p_playlist->p_input );
445             PL_UNLOCK;
446             continue;
447         }
448         else
449         {
450             p_playlist->p_input->b_eof = 1;
451         }
452         PL_UNLOCK;
453
454         msleep( INTF_IDLE_SLEEP );
455     }
456
457 #ifdef ENABLE_SOUT
458     /* close the remaining sout-keep (if there was no input atm) */
459     sout_instance_t *p_sout = libvlc_priv (p_playlist->p_libvlc)->p_sout;
460     if (p_sout)
461         sout_DeleteInstance( p_sout );
462 #endif
463
464     /* Core should have terminated all SDs before the playlist */
465     assert( p_playlist->i_sds == 0 );
466     playlist_MLDump( p_playlist );
467
468     PL_LOCK;
469     FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
470         free( p_del->pp_children );
471         vlc_gc_decref( p_del->p_input );
472         free( p_del );
473     FOREACH_END();
474     ARRAY_RESET( p_playlist->all_items );
475
476     ARRAY_RESET( p_playlist->items );
477     ARRAY_RESET( p_playlist->current );
478
479     PL_UNLOCK;
480 }
481
482 /**
483  * Preparse loop
484  *
485  * Main loop for preparser queue
486  * \param p_obj items to preparse
487  * \return nothing
488  */
489 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
490 {
491     playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
492     input_item_t *p_current;
493     int i_activity;
494
495     vlc_object_lock( p_obj );
496
497     while( vlc_object_alive( p_obj ) )
498     {
499         if( p_obj->i_waiting == 0 )
500         {
501             vlc_object_wait( p_obj );
502             continue;
503         }
504
505         p_current = p_obj->pp_waiting[0];
506         REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
507         vlc_object_unlock( p_obj );
508
509         PL_LOCK;
510         if( p_current )
511         {
512             if( p_current->i_type == ITEM_TYPE_FILE )
513             {
514                 stats_TimerStart( p_playlist, "Preparse run",
515                                   STATS_TIMER_PREPARSE );
516                 /* Do not preparse if it is already done (like by playing it) */
517                 if( !input_item_IsPreparsed( p_current ) )
518                 {
519                     PL_UNLOCK;
520                     input_Preparse( p_playlist, p_current );
521                     PL_LOCK;
522                 }
523                 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
524                 PL_UNLOCK;
525                 input_item_SetPreparsed( p_current, true );
526                 var_SetInteger( p_playlist, "item-change", p_current->i_id );
527                 PL_LOCK;
528             }
529             /* If we haven't retrieved enough meta, add to secondary queue
530              * which will run the "meta fetchers".
531              * This only checks for meta, not for art
532              * \todo don't do this for things we won't get meta for, like vids
533              */
534             char *psz_arturl = input_item_GetArtURL( p_current );
535             char *psz_name = input_item_GetName( p_current );
536             if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
537                         ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
538             {
539                 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
540                 vlc_object_lock( p_playlist->p_fetcher );
541                 INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
542                              p_playlist->p_fetcher->i_waiting,
543                              p_playlist->p_fetcher->i_waiting, p_current);
544                 vlc_object_signal_unlocked( p_playlist->p_fetcher );
545                 vlc_object_unlock( p_playlist->p_fetcher );
546             }
547             else
548             {
549                 PL_DEBUG( "no fetch required for %s (art currently %s)",
550                           psz_name, psz_arturl );
551                 vlc_gc_decref( p_current );
552             }
553             free( psz_name );
554             free( psz_arturl );
555             PL_UNLOCK;
556         }
557         else
558             PL_UNLOCK;
559
560         vlc_object_lock( p_obj );
561         i_activity = var_GetInteger( p_playlist, "activity" );
562         if( i_activity < 0 ) i_activity = 0;
563         vlc_object_unlock( p_obj );
564         /* Sleep at least 1ms */
565         msleep( (i_activity+1) * 1000 );
566         vlc_object_lock( p_obj );
567     }
568     vlc_object_unlock( p_obj );
569 }
570
571 /**
572  * Fetcher loop
573  *
574  * Main loop for secondary preparser queue
575  * \param p_obj items to preparse
576  * \return nothing
577  */
578 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
579 {
580     playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
581     input_item_t *p_item;
582     int i_activity;
583
584     vlc_mutex_lock( &p_obj->object_lock );
585
586     while( vlc_object_alive( p_obj ) )
587     {
588         if( p_obj->i_waiting == 0 )
589         {
590             vlc_object_wait( p_obj );
591             continue;
592         }
593
594         p_item = p_obj->pp_waiting[0];
595         REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
596         vlc_mutex_unlock( &p_obj->object_lock );
597         if( p_item )
598         {
599             int i_ret;
600
601             /* Check if it is not yet preparsed and if so wait for it (at most 0.5s)
602              * (This can happen if we fetch art on play)
603              * FIXME this doesn't work if we need to fetch meta before art ... */
604             for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
605             {
606                 bool b_break;
607                 PL_LOCK;
608                 b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item  ||
609                             p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
610                 PL_UNLOCK;
611                 if( b_break )
612                     break;
613                 msleep( 50000 );
614             }
615
616             i_ret = input_ArtFind( p_playlist, p_item );
617             if( i_ret == 1 )
618             {
619                 PL_DEBUG( "downloading art for %s", p_item->psz_name );
620                 if( input_DownloadAndCacheArt( p_playlist, p_item ) )
621                     input_item_SetArtNotFound( p_item, true );
622                 else {
623                     input_item_SetArtFetched( p_item, true );
624                     var_SetInteger( p_playlist, "item-change",
625                                     p_item->i_id );
626                 }
627             }
628             else if( i_ret == 0 ) /* Was in cache */
629             {
630                 PL_DEBUG( "found art for %s in cache", p_item->psz_name );
631                 input_item_SetArtFetched( p_item, true );
632                 var_SetInteger( p_playlist, "item-change", p_item->i_id );
633             }
634             else
635             {
636                 PL_DEBUG( "art not found for %s", p_item->psz_name );
637                 input_item_SetArtNotFound( p_item, true );
638             }
639             vlc_gc_decref( p_item );
640         }
641         vlc_object_lock( p_obj );
642         i_activity = var_GetInteger( p_playlist, "activity" );
643         if( i_activity < 0 ) i_activity = 0;
644         vlc_object_unlock( p_obj );
645         /* Sleep at least 1ms */
646         msleep( (i_activity+1) * 1000 );
647         vlc_mutex_lock( &p_obj->object_lock );
648     }
649     vlc_mutex_unlock( &p_obj->object_lock );
650 }
651
652 static void VariablesInit( playlist_t *p_playlist )
653 {
654     vlc_value_t val;
655     /* These variables control updates */
656     var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
657     val.b_bool = true;
658     var_Set( p_playlist, "intf-change", val );
659
660     var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
661     val.i_int = -1;
662     var_Set( p_playlist, "item-change", val );
663
664     var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
665     val.i_int = -1;
666     var_Set( p_playlist, "item-deleted", val );
667
668     var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
669
670     var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
671     val.i_int = -1;
672     var_Set( p_playlist, "playlist-current", val );
673
674     var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
675
676     var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
677     var_SetInteger( p_playlist, "activity", 0 );
678
679     /* Variables to control playback */
680     var_CreateGetBool( p_playlist, "play-and-stop" );
681     var_CreateGetBool( p_playlist, "play-and-exit" );
682     var_CreateGetBool( p_playlist, "random" );
683     var_CreateGetBool( p_playlist, "repeat" );
684     var_CreateGetBool( p_playlist, "loop" );
685
686     var_AddCallback( p_playlist, "random", RandomCallback, NULL );
687 }