913423b4c8e6f78099b14acd9c1601a6865b25fa
[vlc.git] / src / playlist / control.c
1 /*****************************************************************************
2  * control.c : Handle control of the playlist & running through it
3  *****************************************************************************
4  * Copyright (C) 1999-2004 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 #ifdef HAVE_CONFIG_H
25 # include "config.h"
26 #endif
27
28 #include <vlc_common.h>
29 #include "vlc_playlist.h"
30 #include "playlist_internal.h"
31 #include <assert.h>
32
33 /*****************************************************************************
34  * Local prototypes
35  *****************************************************************************/
36 static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args );
37
38 static void PreparseEnqueueItemSub( playlist_t *, playlist_item_t * );
39
40 /*****************************************************************************
41  * Playlist control
42  *****************************************************************************/
43
44 playlist_t *__pl_Hold( vlc_object_t *p_this )
45 {
46     playlist_t *pl;
47
48     barrier ();
49     pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
50
51     assert( VLC_OBJECT(pl) != p_this /* This does not make sense to hold the playlist
52     using pl_Hold. use vlc_object_hold in this case */ );
53
54     if (pl)
55         vlc_object_hold (pl);
56     return pl;
57 }
58
59 void __pl_Release( vlc_object_t *p_this )
60 {
61     playlist_t *pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
62     assert( pl != NULL );
63
64     assert( VLC_OBJECT(pl) != p_this /* The rule is that pl_Release() should act on
65     the same object than pl_Hold() */ );
66
67     vlc_object_release( pl );
68 }
69
70 int playlist_Control( playlist_t * p_playlist, int i_query,
71                       bool b_locked, ... )
72 {
73     va_list args;
74     int i_result;
75     va_start( args, b_locked );
76     PL_LOCK_IF( !b_locked );
77     i_result = PlaylistVAControl( p_playlist, i_query, args );
78     va_end( args );
79     PL_UNLOCK_IF( !b_locked );
80
81     return i_result;
82 }
83
84 static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args )
85 {
86     playlist_item_t *p_item, *p_node;
87     vlc_value_t val;
88
89     PL_ASSERT_LOCKED;
90
91     if( !vlc_object_alive( p_playlist ) )
92         return VLC_EGENERIC;
93
94     if( playlist_IsEmpty( p_playlist ) )
95         return VLC_EGENERIC;
96
97     switch( i_query )
98     {
99     case PLAYLIST_STOP:
100         p_playlist->request.i_status = PLAYLIST_STOPPED;
101         p_playlist->request.b_request = true;
102         p_playlist->request.p_item = NULL;
103         break;
104
105     // Node can be null, it will keep the same. Use with care ...
106     // Item null = take the first child of node
107     case PLAYLIST_VIEWPLAY:
108         p_node = (playlist_item_t *)va_arg( args, playlist_item_t * );
109         p_item = (playlist_item_t *)va_arg( args, playlist_item_t * );
110         if ( p_node == NULL )
111         {
112             p_node = get_current_status_node( p_playlist );
113             assert( p_node );
114         }
115         p_playlist->request.i_status = PLAYLIST_RUNNING;
116         p_playlist->request.i_skip = 0;
117         p_playlist->request.b_request = true;
118         p_playlist->request.p_node = p_node;
119         p_playlist->request.p_item = p_item;
120         if( p_item && var_GetBool( p_playlist, "random" ) )
121             p_playlist->b_reset_currently_playing = true;
122         break;
123
124     case PLAYLIST_PLAY:
125         if( p_playlist->p_input )
126         {
127             val.i_int = PLAYING_S;
128             var_Set( p_playlist->p_input, "state", val );
129             break;
130         }
131         else
132         {
133             p_playlist->request.i_status = PLAYLIST_RUNNING;
134             p_playlist->request.b_request = true;
135             p_playlist->request.p_node = get_current_status_node( p_playlist );
136             p_playlist->request.p_item = get_current_status_item( p_playlist );
137             p_playlist->request.i_skip = 0;
138         }
139         break;
140
141     case PLAYLIST_PAUSE:
142         val.i_int = 0;
143         if( p_playlist->p_input )
144             var_Get( p_playlist->p_input, "state", &val );
145
146         if( val.i_int == PAUSE_S )
147         {
148             p_playlist->status.i_status = PLAYLIST_RUNNING;
149             if( p_playlist->p_input )
150             {
151                 val.i_int = PLAYING_S;
152                 var_Set( p_playlist->p_input, "state", val );
153             }
154         }
155         else
156         {
157             p_playlist->status.i_status = PLAYLIST_PAUSED;
158             if( p_playlist->p_input )
159             {
160                 val.i_int = PAUSE_S;
161                 var_Set( p_playlist->p_input, "state", val );
162             }
163         }
164         break;
165
166     case PLAYLIST_SKIP:
167         p_playlist->request.p_node = get_current_status_node( p_playlist );
168         p_playlist->request.p_item = get_current_status_item( p_playlist );
169         p_playlist->request.i_skip = (int) va_arg( args, int );
170         /* if already running, keep running */
171         if( p_playlist->status.i_status != PLAYLIST_STOPPED )
172             p_playlist->request.i_status = p_playlist->status.i_status;
173         p_playlist->request.b_request = true;
174         break;
175
176     default:
177         msg_Err( p_playlist, "unknown playlist query" );
178         return VLC_EBADVAR;
179     }
180     vlc_object_signal_unlocked( p_playlist );
181
182     return VLC_SUCCESS;
183 }
184
185 /*****************************************************************************
186  * Preparse control
187  *****************************************************************************/
188 /** Enqueue an item for preparsing */
189 int playlist_PreparseEnqueue( playlist_t *p_playlist,
190                               input_item_t *p_item )
191 {
192     playlist_preparse_t *p_preparse = &pl_priv(p_playlist)->preparse;
193
194     vlc_gc_incref( p_item );
195
196     vlc_mutex_lock( &p_preparse->lock );
197     INSERT_ELEM( p_preparse->pp_waiting, p_preparse->i_waiting,
198                  p_preparse->i_waiting, p_item );
199     vlc_cond_signal( &p_preparse->wait );
200     vlc_mutex_unlock( &p_preparse->lock );
201     return VLC_SUCCESS;
202 }
203
204 /** Enqueue a playlist item or a node for preparsing.
205  *  This function shall be called without playlist and preparser locks */
206 int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
207                                   playlist_item_t *p_item )
208 {
209     playlist_preparse_t *p_preparse = &pl_priv(p_playlist)->preparse;
210
211     vlc_object_lock( p_playlist );
212     vlc_mutex_lock( &p_preparse->lock );
213     PreparseEnqueueItemSub( p_playlist, p_item );
214     vlc_mutex_unlock( &p_preparse->lock );
215     vlc_object_unlock( p_playlist );
216     return VLC_SUCCESS;
217 }
218
219 int playlist_AskForArtEnqueue( playlist_t *p_playlist,
220                                input_item_t *p_item )
221 {
222     playlist_fetcher_t *p_fetcher = &pl_priv(p_playlist)->fetcher;
223
224     vlc_gc_incref( p_item );
225
226     vlc_mutex_lock( &p_fetcher->lock );
227     INSERT_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting,
228                  p_fetcher->i_waiting, p_item );
229     vlc_cond_signal( &p_fetcher->wait );
230     vlc_mutex_unlock( &p_fetcher->lock );
231     return VLC_SUCCESS;
232 }
233
234 static void PreparseEnqueueItemSub( playlist_t *p_playlist,
235                                     playlist_item_t *p_item )
236 {
237     playlist_preparse_t *p_preparse = &pl_priv(p_playlist)->preparse;
238
239     if( p_item->i_children == -1 )
240     {
241         /* Leaf item */
242         vlc_gc_incref( p_item->p_input );
243         INSERT_ELEM( p_preparse->pp_waiting,
244                      p_preparse->i_waiting,
245                      p_preparse->i_waiting,
246                      p_item->p_input );
247     }
248     else
249     {
250         /* Non-leaf item: recurse */
251         for( int i = 0; i < p_item->i_children; i++)
252         {
253             PreparseEnqueueItemSub( p_playlist, p_item->pp_children[i] );
254         }
255     }
256 }
257
258 /*****************************************************************************
259  * Playback logic
260  *****************************************************************************/
261
262 /**
263  * Synchronise the current index of the playlist
264  * to match the index of the current item.
265  *
266  * \param p_playlist the playlist structure
267  * \param p_cur the current playlist item
268  * \return nothing
269  */
270 static void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur )
271 {
272      PL_DEBUG( "resyncing on %s", PLI_NAME( p_cur ) );
273      /* Simply resync index */
274      int i;
275      p_playlist->i_current_index = -1;
276      for( i = 0 ; i< p_playlist->current.i_size; i++ )
277      {
278           if( ARRAY_VAL( p_playlist->current, i ) == p_cur )
279           {
280               p_playlist->i_current_index = i;
281               break;
282           }
283      }
284      PL_DEBUG( "%s is at %i", PLI_NAME( p_cur ), p_playlist->i_current_index );
285 }
286
287 void ResetCurrentlyPlaying( playlist_t *p_playlist, bool b_random,
288                             playlist_item_t *p_cur )
289 {
290     playlist_item_t *p_next = NULL;
291     stats_TimerStart( p_playlist, "Items array build",
292                       STATS_TIMER_PLAYLIST_BUILD );
293     PL_DEBUG( "rebuilding array of current - root %s",
294               PLI_NAME( p_playlist->status.p_node ) );
295     ARRAY_RESET( p_playlist->current );
296     p_playlist->i_current_index = -1;
297     while( 1 )
298     {
299         /** FIXME: this is *slow* */
300         p_next = playlist_GetNextLeaf( p_playlist,
301                                        p_playlist->status.p_node,
302                                        p_next, true, false );
303         if( p_next )
304         {
305             if( p_next == p_cur )
306                 p_playlist->i_current_index = p_playlist->current.i_size;
307             ARRAY_APPEND( p_playlist->current, p_next);
308         }
309         else break;
310     }
311     PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
312                                                   p_playlist->i_current_index);
313     if( b_random )
314     {
315         /* Shuffle the array */
316         srand( (unsigned int)mdate() );
317         int j;
318         for( j = p_playlist->current.i_size - 1; j > 0; j-- )
319         {
320             int i = rand() % (j+1); /* between 0 and j */
321             playlist_item_t *p_tmp;
322             /* swap the two items */
323             p_tmp = ARRAY_VAL(p_playlist->current, i);
324             ARRAY_VAL(p_playlist->current,i) = ARRAY_VAL(p_playlist->current,j);
325             ARRAY_VAL(p_playlist->current,j) = p_tmp;
326         }
327     }
328     p_playlist->b_reset_currently_playing = false;
329     stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_BUILD );
330 }
331
332 /**
333  * Compute the next playlist item depending on
334  * the playlist course mode (forward, backward, random, view,...).
335  *
336  * \param p_playlist the playlist object
337  * \return nothing
338  */
339 playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
340 {
341     playlist_item_t *p_new = NULL;
342     int i_skip = 0, i;
343
344     bool b_loop = var_GetBool( p_playlist, "loop" );
345     bool b_random = var_GetBool( p_playlist, "random" );
346     bool b_repeat = var_GetBool( p_playlist, "repeat" );
347     bool b_playstop = var_GetBool( p_playlist, "play-and-stop" );
348
349     /* Handle quickly a few special cases */
350     /* No items to play */
351     if( p_playlist->items.i_size == 0 )
352     {
353         msg_Info( p_playlist, "playlist is empty" );
354         return NULL;
355     }
356
357     /* Repeat and play/stop */
358     if( !p_playlist->request.b_request && b_repeat == true &&
359          get_current_status_item( p_playlist ) )
360     {
361         msg_Dbg( p_playlist,"repeating item" );
362         return get_current_status_item( p_playlist );
363     }
364     if( !p_playlist->request.b_request && b_playstop == true )
365     {
366         msg_Dbg( p_playlist,"stopping (play and stop)" );
367         return NULL;
368     }
369
370     if( !p_playlist->request.b_request &&
371         get_current_status_item( p_playlist ) )
372     {
373         playlist_item_t *p_parent = get_current_status_item( p_playlist );
374         while( p_parent )
375         {
376             if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
377             {
378                 msg_Dbg( p_playlist, "blocking item, stopping") ;
379                 return NULL;
380             }
381             p_parent = p_parent->p_parent;
382         }
383     }
384
385     /* Start the real work */
386     if( p_playlist->request.b_request )
387     {
388         p_new = p_playlist->request.p_item;
389         i_skip = p_playlist->request.i_skip;
390         PL_DEBUG( "processing request item %s node %s skip %i",
391                         PLI_NAME( p_playlist->request.p_item ),
392                         PLI_NAME( p_playlist->request.p_node ), i_skip );
393
394         if( p_playlist->request.p_node &&
395             p_playlist->request.p_node != get_current_status_node( p_playlist ) )
396         {
397
398             set_current_status_node( p_playlist, p_playlist->request.p_node );
399             p_playlist->request.p_node = NULL;
400             p_playlist->b_reset_currently_playing = true;
401         }
402
403         /* If we are asked for a node, go to it's first child */
404         if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
405         {
406             i_skip++;
407             if( p_new != NULL )
408             {
409                 p_new = playlist_GetNextLeaf( p_playlist, p_new, NULL, true, false );
410                 for( i = 0; i < p_playlist->current.i_size; i++ )
411                 {
412                     if( p_new == ARRAY_VAL( p_playlist->current, i ) )
413                     {
414                         p_playlist->i_current_index = i;
415                         i_skip = 0;
416                     }
417                 }
418             }
419         }
420
421         if( p_playlist->b_reset_currently_playing )
422             /* A bit too bad to reset twice ... */
423             ResetCurrentlyPlaying( p_playlist, b_random, p_new );
424         else if( p_new )
425             ResyncCurrentIndex( p_playlist, p_new );
426         else
427             p_playlist->i_current_index = -1;
428
429         if( p_playlist->current.i_size && (i_skip > 0) )
430         {
431             if( p_playlist->i_current_index < -1 )
432                 p_playlist->i_current_index = -1;
433             for( i = i_skip; i > 0 ; i-- )
434             {
435                 p_playlist->i_current_index++;
436                 if( p_playlist->i_current_index >= p_playlist->current.i_size )
437                 {
438                     PL_DEBUG( "looping - restarting at beginning of node" );
439                     p_playlist->i_current_index = 0;
440                 }
441             }
442             p_new = ARRAY_VAL( p_playlist->current,
443                                p_playlist->i_current_index );
444         }
445         else if( p_playlist->current.i_size && (i_skip < 0) )
446         {
447             for( i = i_skip; i < 0 ; i++ )
448             {
449                 p_playlist->i_current_index--;
450                 if( p_playlist->i_current_index <= -1 )
451                 {
452                     PL_DEBUG( "looping - restarting at end of node" );
453                     p_playlist->i_current_index = p_playlist->current.i_size-1;
454                 }
455             }
456             p_new = ARRAY_VAL( p_playlist->current,
457                                p_playlist->i_current_index );
458         }
459         /* Clear the request */
460         p_playlist->request.b_request = false;
461     }
462     /* "Automatic" item change ( next ) */
463     else
464     {
465         PL_DEBUG( "changing item without a request (current %i/%i)",
466                   p_playlist->i_current_index, p_playlist->current.i_size );
467         /* Cant go to next from current item */
468         if( get_current_status_item( p_playlist ) &&
469             get_current_status_item( p_playlist )->i_flags & PLAYLIST_SKIP_FLAG )
470             return NULL;
471
472         if( p_playlist->b_reset_currently_playing )
473             ResetCurrentlyPlaying( p_playlist, b_random,
474                                    get_current_status_item( p_playlist ) );
475
476         p_playlist->i_current_index++;
477         assert( p_playlist->i_current_index <= p_playlist->current.i_size );
478         if( p_playlist->i_current_index == p_playlist->current.i_size )
479         {
480             if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
481             p_playlist->i_current_index = 0;
482         }
483         PL_DEBUG( "using item %i", p_playlist->i_current_index );
484         if ( p_playlist->current.i_size == 0 ) return NULL;
485
486         p_new = ARRAY_VAL( p_playlist->current, p_playlist->i_current_index );
487         /* The new item can't be autoselected  */
488         if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
489             return NULL;
490     }
491     return p_new;
492 }
493
494 /**
495  * Start the input for an item
496  *
497  * \param p_playlist the playlist object
498  * \param p_item the item to play
499  * \return nothing
500  */
501 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
502 {
503     input_item_t *p_input = p_item->p_input;
504     sout_instance_t **pp_sout = &pl_priv(p_playlist)->p_sout;
505     int i_activity = var_GetInteger( p_playlist, "activity" ) ;
506
507     msg_Dbg( p_playlist, "creating new input thread" );
508
509     p_input->i_nb_played++;
510     set_current_status_item( p_playlist, p_item );
511
512     p_playlist->status.i_status = PLAYLIST_RUNNING;
513
514     var_SetInteger( p_playlist, "activity", i_activity +
515                     DEFAULT_INPUT_ACTIVITY );
516
517     input_thread_t * p_input_thread =
518         input_CreateThreadExtended( p_playlist, p_input, NULL, *pp_sout );
519     playlist_set_current_input( p_playlist, p_input_thread );
520     vlc_object_release( p_input_thread );
521
522     *pp_sout = NULL;
523
524     char *psz_uri = input_item_GetURI( p_item->p_input );
525     if( psz_uri && ( !strncmp( psz_uri, "directory:", 10 ) ||
526                      !strncmp( psz_uri, "vlc:", 4 ) ) )
527     {
528         free( psz_uri );
529         return VLC_SUCCESS;
530     }
531     free( psz_uri );
532
533     if( pl_priv(p_playlist)->fetcher.i_art_policy == ALBUM_ART_WHEN_PLAYED )
534     {
535         bool b_has_art;
536
537         char *psz_arturl, *psz_name;
538         psz_arturl = input_item_GetArtURL( p_input );
539         psz_name = input_item_GetName( p_input );
540
541         /* p_input->p_meta should not be null after a successfull CreateThread */
542         b_has_art = !EMPTY_STR( psz_arturl );
543
544         if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
545         {
546             PL_DEBUG( "requesting art for %s", psz_name );
547             playlist_AskForArtEnqueue( p_playlist, p_input );
548         }
549         free( psz_arturl );
550         free( psz_name );
551     }
552
553     PL_UNLOCK;
554     var_SetInteger( p_playlist, "playlist-current", p_input->i_id );
555     PL_LOCK;
556
557     return VLC_SUCCESS;
558 }