Playlist: put private data after public data
[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_Yield( 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 yield the playlist
52     using pl_Yield. use vlc_object_yield in this case */ );
53
54     if (pl)
55         vlc_object_yield (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_Yield() */ );
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)->p_fetcher;
223     vlc_object_lock( p_fetcher );
224     if( !vlc_object_alive( p_fetcher ) )
225     {
226         vlc_object_unlock( p_fetcher );
227         return VLC_EGENERIC;
228     }
229
230     vlc_gc_incref( p_item );
231     INSERT_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting,
232                  p_fetcher->i_waiting, p_item );
233     vlc_object_signal_unlocked( p_fetcher );
234     vlc_object_unlock( p_fetcher );
235     return VLC_SUCCESS;
236 }
237
238 static void PreparseEnqueueItemSub( playlist_t *p_playlist,
239                                     playlist_item_t *p_item )
240 {
241     playlist_preparse_t *p_preparse = &pl_priv(p_playlist)->preparse;
242
243     if( p_item->i_children == -1 )
244     {
245         /* Leaf item */
246         vlc_gc_incref( p_item->p_input );
247         INSERT_ELEM( p_preparse->pp_waiting,
248                      p_preparse->i_waiting,
249                      p_preparse->i_waiting,
250                      p_item->p_input );
251     }
252     else
253     {
254         /* Non-leaf item: recurse */
255         for( int i = 0; i < p_item->i_children; i++)
256         {
257             PreparseEnqueueItemSub( p_playlist, p_item->pp_children[i] );
258         }
259     }
260 }
261
262 /*****************************************************************************
263  * Playback logic
264  *****************************************************************************/
265
266 /**
267  * Synchronise the current index of the playlist
268  * to match the index of the current item.
269  *
270  * \param p_playlist the playlist structure
271  * \param p_cur the current playlist item
272  * \return nothing
273  */
274 static void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur )
275 {
276      PL_DEBUG( "resyncing on %s", PLI_NAME( p_cur ) );
277      /* Simply resync index */
278      int i;
279      p_playlist->i_current_index = -1;
280      for( i = 0 ; i< p_playlist->current.i_size; i++ )
281      {
282           if( ARRAY_VAL( p_playlist->current, i ) == p_cur )
283           {
284               p_playlist->i_current_index = i;
285               break;
286           }
287      }
288      PL_DEBUG( "%s is at %i", PLI_NAME( p_cur ), p_playlist->i_current_index );
289 }
290
291 void ResetCurrentlyPlaying( playlist_t *p_playlist, bool b_random,
292                             playlist_item_t *p_cur )
293 {
294     playlist_item_t *p_next = NULL;
295     stats_TimerStart( p_playlist, "Items array build",
296                       STATS_TIMER_PLAYLIST_BUILD );
297     PL_DEBUG( "rebuilding array of current - root %s",
298               PLI_NAME( p_playlist->status.p_node ) );
299     ARRAY_RESET( p_playlist->current );
300     p_playlist->i_current_index = -1;
301     while( 1 )
302     {
303         /** FIXME: this is *slow* */
304         p_next = playlist_GetNextLeaf( p_playlist,
305                                        p_playlist->status.p_node,
306                                        p_next, true, false );
307         if( p_next )
308         {
309             if( p_next == p_cur )
310                 p_playlist->i_current_index = p_playlist->current.i_size;
311             ARRAY_APPEND( p_playlist->current, p_next);
312         }
313         else break;
314     }
315     PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
316                                                   p_playlist->i_current_index);
317     if( b_random )
318     {
319         /* Shuffle the array */
320         srand( (unsigned int)mdate() );
321         int j;
322         for( j = p_playlist->current.i_size - 1; j > 0; j-- )
323         {
324             int i = rand() % (j+1); /* between 0 and j */
325             playlist_item_t *p_tmp;
326             /* swap the two items */
327             p_tmp = ARRAY_VAL(p_playlist->current, i);
328             ARRAY_VAL(p_playlist->current,i) = ARRAY_VAL(p_playlist->current,j);
329             ARRAY_VAL(p_playlist->current,j) = p_tmp;
330         }
331     }
332     p_playlist->b_reset_currently_playing = false;
333     stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_BUILD );
334 }
335
336 /**
337  * Compute the next playlist item depending on
338  * the playlist course mode (forward, backward, random, view,...).
339  *
340  * \param p_playlist the playlist object
341  * \return nothing
342  */
343 playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
344 {
345     playlist_item_t *p_new = NULL;
346     int i_skip = 0, i;
347
348     bool b_loop = var_GetBool( p_playlist, "loop" );
349     bool b_random = var_GetBool( p_playlist, "random" );
350     bool b_repeat = var_GetBool( p_playlist, "repeat" );
351     bool b_playstop = var_GetBool( p_playlist, "play-and-stop" );
352
353     /* Handle quickly a few special cases */
354     /* No items to play */
355     if( p_playlist->items.i_size == 0 )
356     {
357         msg_Info( p_playlist, "playlist is empty" );
358         return NULL;
359     }
360
361     /* Repeat and play/stop */
362     if( !p_playlist->request.b_request && b_repeat == true &&
363          get_current_status_item( p_playlist ) )
364     {
365         msg_Dbg( p_playlist,"repeating item" );
366         return get_current_status_item( p_playlist );
367     }
368     if( !p_playlist->request.b_request && b_playstop == true )
369     {
370         msg_Dbg( p_playlist,"stopping (play and stop)" );
371         return NULL;
372     }
373
374     if( !p_playlist->request.b_request &&
375         get_current_status_item( p_playlist ) )
376     {
377         playlist_item_t *p_parent = get_current_status_item( p_playlist );
378         while( p_parent )
379         {
380             if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
381             {
382                 msg_Dbg( p_playlist, "blocking item, stopping") ;
383                 return NULL;
384             }
385             p_parent = p_parent->p_parent;
386         }
387     }
388
389     /* Start the real work */
390     if( p_playlist->request.b_request )
391     {
392         p_new = p_playlist->request.p_item;
393         i_skip = p_playlist->request.i_skip;
394         PL_DEBUG( "processing request item %s node %s skip %i",
395                         PLI_NAME( p_playlist->request.p_item ),
396                         PLI_NAME( p_playlist->request.p_node ), i_skip );
397
398         if( p_playlist->request.p_node &&
399             p_playlist->request.p_node != get_current_status_node( p_playlist ) )
400         {
401
402             set_current_status_node( p_playlist, p_playlist->request.p_node );
403             p_playlist->request.p_node = NULL;
404             p_playlist->b_reset_currently_playing = true;
405         }
406
407         /* If we are asked for a node, go to it's first child */
408         if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
409         {
410             i_skip++;
411             if( p_new != NULL )
412             {
413                 p_new = playlist_GetNextLeaf( p_playlist, p_new, NULL, true, false );
414                 for( i = 0; i < p_playlist->current.i_size; i++ )
415                 {
416                     if( p_new == ARRAY_VAL( p_playlist->current, i ) )
417                     {
418                         p_playlist->i_current_index = i;
419                         i_skip = 0;
420                     }
421                 }
422             }
423         }
424
425         if( p_playlist->b_reset_currently_playing )
426             /* A bit too bad to reset twice ... */
427             ResetCurrentlyPlaying( p_playlist, b_random, p_new );
428         else if( p_new )
429             ResyncCurrentIndex( p_playlist, p_new );
430         else
431             p_playlist->i_current_index = -1;
432
433         if( p_playlist->current.i_size && (i_skip > 0) )
434         {
435             if( p_playlist->i_current_index < -1 )
436                 p_playlist->i_current_index = -1;
437             for( i = i_skip; i > 0 ; i-- )
438             {
439                 p_playlist->i_current_index++;
440                 if( p_playlist->i_current_index >= p_playlist->current.i_size )
441                 {
442                     PL_DEBUG( "looping - restarting at beginning of node" );
443                     p_playlist->i_current_index = 0;
444                 }
445             }
446             p_new = ARRAY_VAL( p_playlist->current,
447                                p_playlist->i_current_index );
448         }
449         else if( p_playlist->current.i_size && (i_skip < 0) )
450         {
451             for( i = i_skip; i < 0 ; i++ )
452             {
453                 p_playlist->i_current_index--;
454                 if( p_playlist->i_current_index <= -1 )
455                 {
456                     PL_DEBUG( "looping - restarting at end of node" );
457                     p_playlist->i_current_index = p_playlist->current.i_size-1;
458                 }
459             }
460             p_new = ARRAY_VAL( p_playlist->current,
461                                p_playlist->i_current_index );
462         }
463         /* Clear the request */
464         p_playlist->request.b_request = false;
465     }
466     /* "Automatic" item change ( next ) */
467     else
468     {
469         PL_DEBUG( "changing item without a request (current %i/%i)",
470                   p_playlist->i_current_index, p_playlist->current.i_size );
471         /* Cant go to next from current item */
472         if( get_current_status_item( p_playlist ) &&
473             get_current_status_item( p_playlist )->i_flags & PLAYLIST_SKIP_FLAG )
474             return NULL;
475
476         if( p_playlist->b_reset_currently_playing )
477             ResetCurrentlyPlaying( p_playlist, b_random,
478                                    get_current_status_item( p_playlist ) );
479
480         p_playlist->i_current_index++;
481         assert( p_playlist->i_current_index <= p_playlist->current.i_size );
482         if( p_playlist->i_current_index == p_playlist->current.i_size )
483         {
484             if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
485             p_playlist->i_current_index = 0;
486         }
487         PL_DEBUG( "using item %i", p_playlist->i_current_index );
488         if ( p_playlist->current.i_size == 0 ) return NULL;
489
490         p_new = ARRAY_VAL( p_playlist->current, p_playlist->i_current_index );
491         /* The new item can't be autoselected  */
492         if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
493             return NULL;
494     }
495     return p_new;
496 }
497
498 /**
499  * Start the input for an item
500  *
501  * \param p_playlist the playlist objetc
502  * \param p_item the item to play
503  * \return nothing
504  */
505 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
506 {
507     input_item_t *p_input = p_item->p_input;
508     sout_instance_t **pp_sout = &pl_priv(p_playlist)->p_sout;
509     int i_activity = var_GetInteger( p_playlist, "activity" ) ;
510
511     msg_Dbg( p_playlist, "creating new input thread" );
512
513     p_input->i_nb_played++;
514     set_current_status_item( p_playlist, p_item );
515
516     p_playlist->status.i_status = PLAYLIST_RUNNING;
517
518     var_SetInteger( p_playlist, "activity", i_activity +
519                     DEFAULT_INPUT_ACTIVITY );
520
521     input_thread_t * p_input_thread =
522         input_CreateThreadExtended( p_playlist, p_input, NULL, *pp_sout );
523     playlist_set_current_input( p_playlist, p_input_thread );
524     vlc_object_release( p_input_thread );
525
526     *pp_sout = NULL;
527
528     char *psz_uri = input_item_GetURI( p_item->p_input );
529     if( psz_uri && ( !strncmp( psz_uri, "directory:", 10 ) ||
530                      !strncmp( psz_uri, "vlc:", 4 ) ) )
531     {
532         free( psz_uri );
533         return VLC_SUCCESS;
534     }
535     free( psz_uri );
536
537     if( pl_priv(p_playlist)->p_fetcher &&
538         pl_priv(p_playlist)->p_fetcher->i_art_policy == ALBUM_ART_WHEN_PLAYED )
539     {
540         bool b_has_art;
541
542         char *psz_arturl, *psz_name;
543         psz_arturl = input_item_GetArtURL( p_input );
544         psz_name = input_item_GetName( p_input );
545
546         /* p_input->p_meta should not be null after a successfull CreateThread */
547         b_has_art = !EMPTY_STR( psz_arturl );
548
549         if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
550         {
551             PL_DEBUG( "requesting art for %s", psz_name );
552             playlist_AskForArtEnqueue( p_playlist, p_input );
553         }
554         free( psz_arturl );
555         free( psz_name );
556     }
557
558     PL_UNLOCK;
559     var_SetInteger( p_playlist, "playlist-current", p_input->i_id );
560     PL_LOCK;
561
562     return VLC_SUCCESS;
563 }