Don't loop continuously the playlist thread, use cond.
[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: /local/vlc/0.8.6-playlist-vlm/src/playlist/playlist.c 13741 2006-03-21T19:29:39.792444Z zorglub  $
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 #include <vlc/vlc.h>
25 #include <vlc/input.h>
26 #include "vlc_playlist.h"
27 #include "playlist_internal.h"
28 #include <assert.h>
29
30 /*****************************************************************************
31  * Local prototypes
32  *****************************************************************************/
33 int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args );
34
35 void PreparseEnqueueItemSub( playlist_t *, playlist_item_t * );
36
37 playlist_item_t *playlist_RecursiveFindLast(playlist_t *p_playlist,
38                                             playlist_item_t *p_node );
39
40 /*****************************************************************************
41  * Playlist control
42  *****************************************************************************/
43
44 /**
45  * Do a playlist action. Should be entered without playlist lock
46  * \see playlist_Control
47  */
48 int playlist_LockControl( playlist_t * p_playlist, int i_query, ... )
49 {
50     va_list args;
51     int i_result;
52     va_start( args, i_query );
53     vlc_mutex_lock( &p_playlist->object_lock );
54     i_result = PlaylistVAControl( p_playlist, i_query, args );
55     va_end( args );
56     vlc_mutex_unlock( &p_playlist->object_lock );
57     return i_result;
58 }
59
60 /**
61  * Do a playlist action.
62  * If there is something in the playlist then you can do playlist actions.
63  * Should be entered with playlist lock. See include/vlc_playlist.h for
64  * possible queries
65  *
66  * \param p_playlist the playlist to do the command on
67  * \param i_query the command to do
68  * \param variable number of arguments
69  * \return VLC_SUCCESS or an error
70  */
71 int playlist_Control( playlist_t * p_playlist, int i_query, ... )
72 {
73     va_list args;
74     int i_result;
75     va_start( args, i_query );
76     i_result = PlaylistVAControl( p_playlist, i_query, args );
77     va_end( args );
78
79     return i_result;
80 }
81
82 int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args )
83 {
84     playlist_item_t *p_item, *p_node;
85     vlc_value_t val;
86
87     if( p_playlist->items.i_size <= 0 )
88         return VLC_EGENERIC;
89
90     switch( i_query )
91     {
92     case PLAYLIST_STOP:
93         p_playlist->request.i_status = PLAYLIST_STOPPED;
94         p_playlist->request.b_request = VLC_TRUE;
95         p_playlist->request.p_item = NULL;
96         break;
97
98     // Node can be null, it will keep the same. Use with care ...
99     // Item null = take the first child of node
100     case PLAYLIST_VIEWPLAY:
101         p_node = (playlist_item_t *)va_arg( args, playlist_item_t * );
102         p_item = (playlist_item_t *)va_arg( args, playlist_item_t * );
103         if ( p_node == NULL )
104         {
105             p_node = p_playlist->status.p_node;
106             assert( p_node );
107         }
108         p_playlist->request.i_status = PLAYLIST_RUNNING;
109         p_playlist->request.i_skip = 0;
110         p_playlist->request.b_request = VLC_TRUE;
111         p_playlist->request.p_node = p_node;
112         p_playlist->request.p_item = p_item;
113         if( p_item && var_GetBool( p_playlist, "random" ) )
114             p_playlist->b_reset_currently_playing = VLC_TRUE;
115         break;
116
117     case PLAYLIST_PLAY:
118         if( p_playlist->p_input )
119         {
120             val.i_int = PLAYING_S;
121             var_Set( p_playlist->p_input, "state", val );
122             break;
123         }
124         else
125         {
126             p_playlist->request.i_status = PLAYLIST_RUNNING;
127             p_playlist->request.b_request = VLC_TRUE;
128             p_playlist->request.p_node = p_playlist->status.p_node;
129             p_playlist->request.p_item = p_playlist->status.p_item;
130             p_playlist->request.i_skip = 0;
131         }
132         break;
133
134     case PLAYLIST_AUTOPLAY:
135         // AUTOPLAY is an ugly hack for initial status.
136         // Hopefully it will disappear
137         p_playlist->status.i_status = PLAYLIST_RUNNING;
138         p_playlist->request.p_node = p_playlist->status.p_node;
139         p_playlist->request.b_request = VLC_FALSE;
140         break;
141
142     case PLAYLIST_PAUSE:
143         val.i_int = 0;
144         if( p_playlist->p_input )
145             var_Get( p_playlist->p_input, "state", &val );
146
147         if( val.i_int == PAUSE_S )
148         {
149             p_playlist->status.i_status = PLAYLIST_RUNNING;
150             if( p_playlist->p_input )
151             {
152                 val.i_int = PLAYING_S;
153                 var_Set( p_playlist->p_input, "state", val );
154             }
155         }
156         else
157         {
158             p_playlist->status.i_status = PLAYLIST_PAUSED;
159             if( p_playlist->p_input )
160             {
161                 val.i_int = PAUSE_S;
162                 var_Set( p_playlist->p_input, "state", val );
163             }
164         }
165         break;
166
167     case PLAYLIST_SKIP:
168         p_playlist->request.p_node = p_playlist->status.p_node;
169         p_playlist->request.p_item = p_playlist->status.p_item;
170         p_playlist->request.i_skip = (int) va_arg( args, int );
171         /* if already running, keep running */
172         if( p_playlist->status.i_status != PLAYLIST_STOPPED )
173             p_playlist->request.i_status = p_playlist->status.i_status;
174         p_playlist->request.b_request = VLC_TRUE;
175         break;
176
177     default:
178         msg_Err( p_playlist, "unknown playlist query" );
179         return VLC_EBADVAR;
180         break;
181     }
182     vlc_cond_signal( &p_playlist->object_wait );
183
184     return VLC_SUCCESS;
185 }
186
187 /*****************************************************************************
188  * Preparse control
189  *****************************************************************************/
190 /** Enqueue an item for preparsing */
191 int playlist_PreparseEnqueue( playlist_t *p_playlist,
192                               input_item_t *p_item )
193 {
194     vlc_mutex_lock( &p_playlist->p_preparse->object_lock );
195     vlc_gc_incref( p_item );
196     INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
197                  p_playlist->p_preparse->i_waiting,
198                  p_playlist->p_preparse->i_waiting,
199                  p_item );
200     vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
201     vlc_cond_signal( &p_playlist->p_preparse->object_wait );
202     return VLC_SUCCESS;
203 }
204
205 /** Enqueue a playlist item or a node for peparsing.
206  *  This function should be entered without playlist and preparser locks */
207 int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
208                                   playlist_item_t *p_item )
209 {
210     vlc_mutex_lock( &p_playlist->object_lock );
211     vlc_mutex_lock( &p_playlist->p_preparse->object_lock );
212     PreparseEnqueueItemSub( p_playlist, p_item );
213     vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
214     vlc_mutex_unlock( &p_playlist->object_lock );
215     return VLC_SUCCESS;
216 }
217
218 int playlist_AskForArtEnqueue( playlist_t *p_playlist,
219                               input_item_t *p_item )
220 {
221     int i;
222     preparse_item_t p;
223     p.p_item = p_item;
224     p.b_fetch_art = VLC_TRUE;
225
226     vlc_mutex_lock( &p_playlist->p_secondary_preparse->object_lock );
227     for( i = 0; i < p_playlist->p_secondary_preparse->i_waiting &&
228          p_playlist->p_secondary_preparse->p_waiting->b_fetch_art == VLC_TRUE;
229          i++ );
230     vlc_gc_incref( p_item );
231     INSERT_ELEM( p_playlist->p_secondary_preparse->p_waiting,
232                  p_playlist->p_secondary_preparse->i_waiting,
233                  i, p );
234     vlc_mutex_unlock( &p_playlist->p_secondary_preparse->object_lock );
235     vlc_cond_signal( &p_playlist->p_secondary_preparse->object_wait );
236     return VLC_SUCCESS;
237 }
238
239 void PreparseEnqueueItemSub( playlist_t *p_playlist,
240                              playlist_item_t *p_item )
241 {
242     int i;
243     if( p_item->i_children == -1 )
244     {
245         vlc_gc_incref( p_item );
246         INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
247                      p_playlist->p_preparse->i_waiting,
248                      p_playlist->p_preparse->i_waiting,
249                      p_item->p_input );
250     }
251     else
252     {
253         for( i = 0; i < p_item->i_children; i++)
254         {
255             PreparseEnqueueItemSub( p_playlist, p_item->pp_children[i] );
256         }
257     }
258 }
259
260 /*****************************************************************************
261  * Playback logic
262  *****************************************************************************/
263
264 static void ResyncCurrentIndex(playlist_t *p_playlist, playlist_item_t *p_cur )
265 {
266      PL_DEBUG("resyncing on %s", PLI_NAME(p_cur) );
267      /* Simply resync index */
268      int i;
269      p_playlist->i_current_index = -1;
270      for( i = 0 ; i< p_playlist->current.i_size; i++ )
271      {
272           if( ARRAY_VAL(p_playlist->current, i) == p_cur )
273           {
274               p_playlist->i_current_index = i;
275               break;
276           }
277      }
278      PL_DEBUG("%s is at %i", PLI_NAME(p_cur), p_playlist->i_current_index );
279 }
280
281 static void ResetCurrentlyPlaying( playlist_t *p_playlist, vlc_bool_t b_random,
282                                    playlist_item_t *p_cur )
283 {
284     playlist_item_t *p_next = NULL;
285     PL_DEBUG("rebuilding array of current - root %s",
286               PLI_NAME(p_playlist->status.p_node) );
287     ARRAY_RESET(p_playlist->current);
288     p_playlist->i_current_index = -1;
289     while( 1 )
290     {
291         /** FIXME: this is *slow* */
292         p_next = playlist_GetNextLeaf( p_playlist,
293                                        p_playlist->status.p_node,
294                                        p_next, VLC_TRUE, VLC_FALSE );
295         if( p_next )
296         {
297             if( p_next == p_cur )
298                 p_playlist->i_current_index = p_playlist->current.i_size;
299             ARRAY_APPEND( p_playlist->current, p_next);
300         }
301         else break;
302     }
303     PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
304                                                   p_playlist->i_current_index);
305     if( b_random )
306     {
307         /* Shuffle the array */
308         srand( (unsigned int)mdate() );
309         int swap = 0;
310         int j;
311         for( j = p_playlist->current.i_size - 1; j > 0; j-- )
312         {
313             swap++;
314             int i = rand() % (j+1); /* between 0 and j */
315             playlist_item_t *p_tmp;
316             p_tmp = ARRAY_VAL(p_playlist->current, i);
317             ARRAY_VAL(p_playlist->current,i) = ARRAY_VAL(p_playlist->current,j);
318             ARRAY_VAL(p_playlist->current,j) = p_tmp;
319         }
320     }
321     p_playlist->b_reset_currently_playing = VLC_FALSE;
322 }
323
324 /** This function calculates the next playlist item, depending
325  *  on the playlist course mode (forward, backward, random, view,...). */
326 playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
327 {
328     playlist_item_t *p_new = NULL;
329     int i_skip = 0, i;
330
331     vlc_bool_t b_loop = var_GetBool( p_playlist, "loop" );
332     vlc_bool_t b_random = var_GetBool( p_playlist, "random" );
333     vlc_bool_t b_repeat = var_GetBool( p_playlist, "repeat" );
334     vlc_bool_t b_playstop = var_GetBool( p_playlist, "play-and-stop" );
335
336     /* Handle quickly a few special cases */
337     /* No items to play */
338     if( p_playlist->items.i_size == 0 )
339     {
340         msg_Info( p_playlist, "playlist is empty" );
341         return NULL;
342     }
343
344     /* Repeat and play/stop */
345     if( !p_playlist->request.b_request && b_repeat == VLC_TRUE &&
346          p_playlist->status.p_item )
347     {
348         msg_Dbg( p_playlist,"repeating item" );
349         return p_playlist->status.p_item;
350     }
351     if( !p_playlist->request.b_request && b_playstop == VLC_TRUE )
352     {
353         msg_Dbg( p_playlist,"stopping (play and stop)");
354         return NULL;
355     }
356
357     if( !p_playlist->request.b_request && p_playlist->status.p_item )
358     {
359         playlist_item_t *p_parent = p_playlist->status.p_item;
360         while( p_parent )
361         {
362             if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
363             {
364                 msg_Dbg( p_playlist, "blocking item, stopping") ;
365                 return NULL;
366             }
367             p_parent = p_parent->p_parent;
368         }
369     }
370
371     /* Start the real work */
372     if( p_playlist->request.b_request )
373     {
374         p_new = p_playlist->request.p_item;
375         i_skip = p_playlist->request.i_skip;
376         PL_DEBUG( "processing request item %s node %s skip %i",
377                         PLI_NAME( p_playlist->request.p_item ),
378                         PLI_NAME( p_playlist->request.p_node ), i_skip );
379
380         if( p_playlist->request.p_node &&
381             p_playlist->request.p_node != p_playlist->status.p_node )
382         {
383             p_playlist->status.p_node = p_playlist->request.p_node;
384             p_playlist->b_reset_currently_playing = VLC_TRUE;
385         }
386
387         /* If we are asked for a node, dont take it */
388         if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
389             i_skip++;
390
391         if( p_playlist->b_reset_currently_playing )
392             ResetCurrentlyPlaying( p_playlist, b_random, p_new );
393         else if( p_new )
394             ResyncCurrentIndex( p_playlist, p_new );
395         else
396             p_playlist->i_current_index = -1;
397
398         if( p_playlist->current.i_size && i_skip > 0 )
399         {
400             for( i = i_skip; i > 0 ; i-- )
401             {
402                 p_playlist->i_current_index++;
403                 if( p_playlist->i_current_index == p_playlist->current.i_size )
404                 {
405                     PL_DEBUG( "looping - restarting at beginning of node" );
406                     p_playlist->i_current_index = 0;
407                 }
408             }
409             p_new = ARRAY_VAL( p_playlist->current,
410                                p_playlist->i_current_index );
411         }
412         else if( p_playlist->current.i_size && i_skip < 0 )
413         {
414             for( i = i_skip; i < 0 ; i++ )
415             {
416                 p_playlist->i_current_index--;
417                 if( p_playlist->i_current_index == -1 )
418                 {
419                     PL_DEBUG( "looping - restarting at end of node" );
420                     p_playlist->i_current_index = p_playlist->current.i_size-1;
421                 }
422             }
423             p_new = ARRAY_VAL( p_playlist->current,
424                                p_playlist->i_current_index );
425         }
426         /* Clear the request */
427         p_playlist->request.b_request = VLC_FALSE;
428     }
429     /* "Automatic" item change ( next ) */
430     else
431     {
432         PL_DEBUG( "changing item without a request (current %i/%i)",
433                   p_playlist->i_current_index, p_playlist->current.i_size );
434         /* Cant go to next from current item */
435         if( p_playlist->status.p_item &&
436             p_playlist->status.p_item->i_flags & PLAYLIST_SKIP_FLAG )
437             return NULL;
438
439         if( p_playlist->b_reset_currently_playing )
440             ResetCurrentlyPlaying( p_playlist, b_random,
441                                    p_playlist->status.p_item );
442
443         p_playlist->i_current_index++;
444         if( p_playlist->i_current_index == p_playlist->current.i_size )
445         {
446             if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
447             p_playlist->i_current_index = 0;
448         }
449         PL_DEBUG( "using item %i", p_playlist->i_current_index );
450         if ( p_playlist->current.i_size == 0 ) return NULL;
451
452         p_new = ARRAY_VAL( p_playlist->current, p_playlist->i_current_index );
453         /* The new item can't be autoselected  */
454         if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
455             return NULL;
456     }
457     return p_new;
458 }
459
460 /** Start the input for an item */
461 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
462 {
463     vlc_value_t val;
464     int i_activity = var_GetInteger( p_playlist, "activity") ;
465
466     msg_Dbg( p_playlist, "creating new input thread" );
467
468     p_item->p_input->i_nb_played++;
469     p_playlist->status.p_item = p_item;
470
471     p_playlist->status.i_status = PLAYLIST_RUNNING;
472
473     var_SetInteger( p_playlist, "activity", i_activity +
474                     DEFAULT_INPUT_ACTIVITY );
475     p_playlist->p_input = input_CreateThread( p_playlist, p_item->p_input );
476
477     val.i_int = p_item->p_input->i_id;
478     /* unlock the playlist to set the var...mmm */
479     vlc_mutex_unlock( &p_playlist->object_lock);
480     var_Set( p_playlist, "playlist-current", val);
481     vlc_mutex_lock( &p_playlist->object_lock);
482
483     return VLC_SUCCESS;
484 }