ea96549105902f5f065c2835622e0e27648f7bfe
[vlc.git] / src / playlist / thread.c
1 /*****************************************************************************
2  * thread.c : Playlist management functions
3  *****************************************************************************
4  * Copyright © 1999-2008 VLC authors and VideoLAN
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 it
11  * under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24 #ifdef HAVE_CONFIG_H
25 # include "config.h"
26 #endif
27
28 #include <assert.h>
29
30 #include <vlc_common.h>
31 #include <vlc_es.h>
32 #include <vlc_input.h>
33 #include <vlc_interface.h>
34 #include <vlc_playlist.h>
35 #include <vlc_rand.h>
36 #include "playlist_internal.h"
37
38 /*****************************************************************************
39  * Local prototypes
40  *****************************************************************************/
41 static void *Thread   ( void * );
42
43 /*****************************************************************************
44  * Main functions for the global thread
45  *****************************************************************************/
46
47 /**
48  * Creates the main playlist thread.
49  */
50 void playlist_Activate( playlist_t *p_playlist )
51 {
52     playlist_private_t *p_sys = pl_priv(p_playlist);
53
54     if( vlc_clone( &p_sys->thread, Thread, p_playlist,
55                    VLC_THREAD_PRIORITY_LOW ) )
56     {
57         msg_Err( p_playlist, "cannot spawn playlist thread" );
58         abort();
59     }
60 }
61
62 /**
63  * Stops the playlist forever (but do not destroy it yet).
64  * Any input is stopped.
65  * \return Nothing but waits for the playlist to be deactivated.
66  */
67 void playlist_Deactivate( playlist_t *p_playlist )
68 {
69     playlist_private_t *p_sys = pl_priv(p_playlist);
70
71     PL_LOCK;
72     /* WARNING: There is a latent bug. It is assumed that only one thread will
73      * be waiting for playlist deactivation at a time. So far, that works
74      * as playlist_Deactivate() is only ever called while closing an
75      * interface and interfaces are shut down serially by intf_DestroyAll(). */
76     if( p_sys->killed )
77     {
78         PL_UNLOCK;
79         return;
80     }
81
82     msg_Dbg( p_playlist, "deactivating the playlist" );
83     p_sys->killed = true;
84     vlc_cond_signal( &p_sys->signal );
85     PL_UNLOCK;
86
87     vlc_join( p_sys->thread, NULL );
88 }
89
90 /* */
91
92 /* Input Callback */
93 static int InputEvent( vlc_object_t *p_this, char const *psz_cmd,
94                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
95 {
96     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
97     playlist_t *p_playlist = p_data;
98
99     if( newval.i_int != INPUT_EVENT_STATE &&
100         newval.i_int != INPUT_EVENT_DEAD )
101         return VLC_SUCCESS;
102
103     PL_LOCK;
104
105     /* XXX: signaling while not changing any parameter... suspicious... */
106     vlc_cond_signal( &pl_priv(p_playlist)->signal );
107
108     PL_UNLOCK;
109     return VLC_SUCCESS;
110 }
111
112 /**
113  * Synchronise the current index of the playlist
114  * to match the index of the current item.
115  *
116  * \param p_playlist the playlist structure
117  * \param p_cur the current playlist item
118  * \return nothing
119  */
120 void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur )
121 {
122     PL_ASSERT_LOCKED;
123
124     PL_DEBUG( "resyncing on %s", PLI_NAME( p_cur ) );
125     /* Simply resync index */
126     int i;
127     p_playlist->i_current_index = -1;
128     for( i = 0 ; i< p_playlist->current.i_size; i++ )
129     {
130         if( ARRAY_VAL( p_playlist->current, i ) == p_cur )
131         {
132             p_playlist->i_current_index = i;
133             break;
134         }
135     }
136     PL_DEBUG( "%s is at %i", PLI_NAME( p_cur ), p_playlist->i_current_index );
137 }
138
139 /**
140  * Reset the currently playing playlist.
141  *
142  * \param p_playlist the playlist structure
143  * \param p_cur the current playlist item
144  * \return nothing
145  */
146 void ResetCurrentlyPlaying( playlist_t *p_playlist,
147                                    playlist_item_t *p_cur )
148 {
149     playlist_private_t *p_sys = pl_priv(p_playlist);
150
151     PL_DEBUG( "rebuilding array of current - root %s",
152               PLI_NAME( p_sys->status.p_node ) );
153     ARRAY_RESET( p_playlist->current );
154     p_playlist->i_current_index = -1;
155     for( playlist_item_t *p_next = NULL; ; )
156     {
157         /** FIXME: this is *slow* */
158         p_next = playlist_GetNextLeaf( p_playlist,
159                                        p_sys->status.p_node,
160                                        p_next, true, false );
161         if( !p_next )
162             break;
163
164         if( p_next == p_cur )
165             p_playlist->i_current_index = p_playlist->current.i_size;
166         ARRAY_APPEND( p_playlist->current, p_next);
167     }
168     PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
169                                                   p_playlist->i_current_index);
170
171     if( var_GetBool( p_playlist, "random" ) && ( p_playlist->current.i_size > 0 ) )
172     {
173         /* Shuffle the array */
174         for( unsigned j = p_playlist->current.i_size - 1; j > 0; j-- )
175         {
176             unsigned i = vlc_lrand48() % (j+1); /* between 0 and j */
177             playlist_item_t *p_tmp;
178             /* swap the two items */
179             p_tmp = ARRAY_VAL(p_playlist->current, i);
180             ARRAY_VAL(p_playlist->current,i) = ARRAY_VAL(p_playlist->current,j);
181             ARRAY_VAL(p_playlist->current,j) = p_tmp;
182         }
183     }
184     p_sys->b_reset_currently_playing = false;
185 }
186
187
188 /**
189  * Start the input for an item
190  *
191  * \param p_playlist the playlist object
192  * \param p_item the item to play
193  * \return nothing
194  */
195 static void PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
196 {
197     playlist_private_t *p_sys = pl_priv(p_playlist);
198     input_item_t *p_input = p_item->p_input;
199
200     PL_ASSERT_LOCKED;
201
202     msg_Dbg( p_playlist, "creating new input thread" );
203
204     p_item->i_nb_played++;
205     set_current_status_item( p_playlist, p_item );
206
207     p_sys->status.i_status = PLAYLIST_RUNNING;
208
209     assert( p_sys->p_input == NULL );
210     PL_UNLOCK;
211
212     input_thread_t *p_input_thread = input_Create( p_playlist, p_input, NULL,
213                                                    p_sys->p_input_resource );
214     if( likely(p_input_thread != NULL) )
215     {
216         var_AddCallback( p_input_thread, "intf-event",
217                          InputEvent, p_playlist );
218
219         if( input_Start( p_input_thread ) )
220         {
221             var_DelCallback( p_input_thread, "intf-event",
222                              InputEvent, p_playlist );
223             vlc_object_release( p_input_thread );
224             p_input_thread = NULL;
225         }
226         else
227             var_SetAddress( p_playlist, "input-current", p_input_thread );
228     }
229
230     /* TODO store art policy in playlist private data */
231     char *psz_arturl = input_item_GetArtURL( p_input );
232     /* p_input->p_meta should not be null after a successful CreateThread */
233     bool b_has_art = !EMPTY_STR( psz_arturl );
234
235     if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
236     {
237         PL_DEBUG( "requesting art for new input thread" );
238         libvlc_ArtRequest( p_playlist->p_libvlc, p_input, META_REQUEST_OPTION_NONE );
239     }
240     free( psz_arturl );
241
242     var_TriggerCallback( p_playlist, "activity" );
243
244     PL_LOCK;
245     p_sys->p_input = p_input_thread;
246 }
247
248 /**
249  * Compute the next playlist item depending on
250  * the playlist course mode (forward, backward, random, view,...).
251  *
252  * \param p_playlist the playlist object
253  * \return nothing
254  */
255 static playlist_item_t *NextItem( playlist_t *p_playlist )
256 {
257     playlist_private_t *p_sys = pl_priv(p_playlist);
258     playlist_item_t *p_new = NULL;
259
260     /* Handle quickly a few special cases */
261     /* No items to play */
262     if( p_playlist->items.i_size == 0 )
263     {
264         msg_Info( p_playlist, "playlist is empty" );
265         return NULL;
266     }
267
268     /* Start the real work */
269     if( p_sys->request.b_request )
270     {
271         p_new = p_sys->request.p_item;
272         int i_skip = p_sys->request.i_skip;
273         PL_DEBUG( "processing request item: %s, node: %s, skip: %i",
274                         PLI_NAME( p_sys->request.p_item ),
275                         PLI_NAME( p_sys->request.p_node ), i_skip );
276
277         if( p_sys->request.p_node &&
278             p_sys->request.p_node != get_current_status_node( p_playlist ) )
279         {
280
281             set_current_status_node( p_playlist, p_sys->request.p_node );
282             p_sys->request.p_node = NULL;
283             p_sys->b_reset_currently_playing = true;
284         }
285
286         /* If we are asked for a node, go to it's first child */
287         if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
288         {
289             i_skip++;
290             if( p_new != NULL )
291             {
292                 p_new = playlist_GetNextLeaf( p_playlist, p_new, NULL, true, false );
293                 for( int i = 0; i < p_playlist->current.i_size; i++ )
294                 {
295                     if( p_new == ARRAY_VAL( p_playlist->current, i ) )
296                     {
297                         p_playlist->i_current_index = i;
298                         i_skip = 0;
299                     }
300                 }
301             }
302         }
303
304         if( p_sys->b_reset_currently_playing )
305             /* A bit too bad to reset twice ... */
306             ResetCurrentlyPlaying( p_playlist, p_new );
307         else if( p_new )
308             ResyncCurrentIndex( p_playlist, p_new );
309         else
310             p_playlist->i_current_index = -1;
311
312         if( p_playlist->current.i_size && (i_skip > 0) )
313         {
314             if( p_playlist->i_current_index < -1 )
315                 p_playlist->i_current_index = -1;
316             for( int i = i_skip; i > 0 ; i-- )
317             {
318                 p_playlist->i_current_index++;
319                 if( p_playlist->i_current_index >= p_playlist->current.i_size )
320                 {
321                     PL_DEBUG( "looping - restarting at beginning of node" );
322                     /* reshuffle playlist when end is reached */
323                     if( var_GetBool( p_playlist, "random" ) ) {
324                         PL_DEBUG( "reshuffle playlist" );
325                         ResetCurrentlyPlaying( p_playlist,
326                                 get_current_status_item( p_playlist ) );
327                     }
328                     p_playlist->i_current_index = 0;
329                 }
330             }
331             p_new = ARRAY_VAL( p_playlist->current,
332                                p_playlist->i_current_index );
333         }
334         else if( p_playlist->current.i_size && (i_skip < 0) )
335         {
336             for( int i = i_skip; i < 0 ; i++ )
337             {
338                 p_playlist->i_current_index--;
339                 if( p_playlist->i_current_index <= -1 )
340                 {
341                     PL_DEBUG( "looping - restarting at end of node" );
342                     /* reshuffle playlist when beginning is reached */
343                     if( var_GetBool( p_playlist, "random" ) ) {
344                         PL_DEBUG( "reshuffle playlist" );
345                         ResetCurrentlyPlaying( p_playlist,
346                                 get_current_status_item( p_playlist ) );
347                     }
348                     p_playlist->i_current_index = p_playlist->current.i_size-1;
349                 }
350             }
351             p_new = ARRAY_VAL( p_playlist->current,
352                                p_playlist->i_current_index );
353         }
354         /* Clear the request */
355         p_sys->request.b_request = false;
356     }
357     /* "Automatic" item change ( next ) */
358     else
359     {
360         bool b_loop = var_GetBool( p_playlist, "loop" );
361         bool b_repeat = var_GetBool( p_playlist, "repeat" );
362         bool b_playstop = var_InheritBool( p_playlist, "play-and-stop" );
363
364         /* Repeat and play/stop */
365         if( b_repeat && get_current_status_item( p_playlist ) )
366         {
367             msg_Dbg( p_playlist,"repeating item" );
368             return get_current_status_item( p_playlist );
369         }
370         if( b_playstop )
371         {
372             msg_Dbg( p_playlist,"stopping (play and stop)" );
373             return NULL;
374         }
375
376         /* */
377         if( get_current_status_item( p_playlist ) )
378         {
379             playlist_item_t *p_parent = get_current_status_item( p_playlist );
380             while( p_parent )
381             {
382                 if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
383                 {
384                     msg_Dbg( p_playlist, "blocking item, stopping") ;
385                     return NULL;
386                 }
387                 p_parent = p_parent->p_parent;
388             }
389         }
390
391         PL_DEBUG( "changing item without a request (current %i/%i)",
392                   p_playlist->i_current_index, p_playlist->current.i_size );
393         /* Cant go to next from current item */
394         if( get_current_status_item( p_playlist ) &&
395             get_current_status_item( p_playlist )->i_flags & PLAYLIST_SKIP_FLAG )
396             return NULL;
397
398         if( p_sys->b_reset_currently_playing )
399             ResetCurrentlyPlaying( p_playlist,
400                                    get_current_status_item( p_playlist ) );
401
402         p_playlist->i_current_index++;
403         assert( p_playlist->i_current_index <= p_playlist->current.i_size );
404         if( p_playlist->i_current_index == p_playlist->current.i_size )
405         {
406             if( !b_loop || p_playlist->current.i_size == 0 )
407                 return NULL;
408             /* reshuffle after last item has been played */
409             if( var_GetBool( p_playlist, "random" ) ) {
410                 PL_DEBUG( "reshuffle playlist" );
411                 ResetCurrentlyPlaying( p_playlist,
412                                        get_current_status_item( p_playlist ) );
413             }
414             p_playlist->i_current_index = 0;
415         }
416         PL_DEBUG( "using item %i", p_playlist->i_current_index );
417         if ( p_playlist->current.i_size == 0 )
418             return NULL;
419
420         p_new = ARRAY_VAL( p_playlist->current, p_playlist->i_current_index );
421         /* The new item can't be autoselected  */
422         if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
423             return NULL;
424     }
425     return p_new;
426 }
427
428 static void LoopInput( playlist_t *p_playlist )
429 {
430     playlist_private_t *p_sys = pl_priv(p_playlist);
431     input_thread_t *p_input = p_sys->p_input;
432
433     assert( p_input != NULL );
434
435     if( p_sys->request.b_request || p_sys->killed )
436     {
437         PL_DEBUG( "incoming request - stopping current input" );
438         input_Stop( p_input, true );
439     }
440
441 #warning Unsynchronized access to *p_input flags...
442     /* This input is dead. Remove it ! */
443     if( p_input->b_dead )
444     {
445         p_sys->p_input = NULL;
446         PL_DEBUG( "dead input" );
447         PL_UNLOCK;
448
449         /* WARNING: Input resource manipulation and callback deletion are
450          * incompatible with the playlist lock. */
451         if( !var_InheritBool( p_input, "sout-keep" ) )
452             input_resource_TerminateSout( p_sys->p_input_resource );
453         var_DelCallback( p_input, "intf-event", InputEvent, p_playlist );
454
455         input_Close( p_input );
456         var_TriggerCallback( p_playlist, "activity" );
457         PL_LOCK;
458         return;
459     }
460     /* This input has finished, ask it to die ! */
461     else if( p_input->b_error || p_input->b_eof )
462     {
463         PL_DEBUG( "finished input" );
464         input_Stop( p_input, false );
465     }
466
467     vlc_cond_wait( &p_sys->signal, &p_sys->lock );
468 }
469
470 static void LoopRequest( playlist_t *p_playlist, int i_status )
471 {
472     playlist_private_t *p_sys = pl_priv(p_playlist);
473     assert( !p_sys->p_input );
474
475     /* No input. Several cases
476      *  - No request, running status -> start new item
477      *  - No request, stopped status -> collect garbage
478      *  - Request, running requested -> start new item
479      *  - Request, stopped requested -> collect garbage
480     */
481     if( i_status == PLAYLIST_STOPPED )
482     {
483         p_sys->status.i_status = PLAYLIST_STOPPED;
484         vlc_cond_wait( &p_sys->signal, &p_sys->lock );
485         return;
486     }
487
488     playlist_item_t *p_item = NextItem( p_playlist );
489     if( p_item )
490     {
491         msg_Dbg( p_playlist, "starting playback of the new playlist item" );
492         ResyncCurrentIndex( p_playlist, p_item );
493         PlayItem( p_playlist, p_item );
494         return;
495     }
496
497     msg_Dbg( p_playlist, "nothing to play" );
498     p_sys->status.i_status = PLAYLIST_STOPPED;
499
500     if( var_InheritBool( p_playlist, "play-and-exit" ) )
501     {
502         msg_Info( p_playlist, "end of playlist, exiting" );
503         libvlc_Quit( p_playlist->p_libvlc );
504     }
505 }
506
507 /**
508  * Run the main control thread itself
509  */
510 static void *Thread ( void *data )
511 {
512     playlist_t *p_playlist = data;
513     playlist_private_t *p_sys = pl_priv(p_playlist);
514
515     PL_LOCK;
516     for( ;; )
517     {
518         while( p_sys->p_input != NULL )
519             LoopInput( p_playlist );
520
521         if( p_sys->killed )
522             break; /* THE END */
523
524         const int status = p_sys->request.b_request ?
525                            p_sys->request.i_status : p_sys->status.i_status;
526
527         /* Destroy any video display if the playlist is supposed to stop */
528         if( status == PLAYLIST_STOPPED
529          && input_resource_HasVout( p_sys->p_input_resource ) )
530         {
531             PL_UNLOCK; /* Mind: NO LOCKS while manipulating input resources! */
532             input_resource_TerminateVout( p_sys->p_input_resource );
533             PL_LOCK;
534             continue; /* lost lock = lost state */
535         }
536
537         LoopRequest( p_playlist, status );
538     }
539     p_sys->status.i_status = PLAYLIST_STOPPED;
540     PL_UNLOCK;
541
542     input_resource_Terminate( p_sys->p_input_resource );
543     return NULL;
544 }