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 $
7 * Authors: Samuel Hocevar <sam@zoy.org>
8 * Clément Stenac <zorglub@videolan.org>
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.
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.
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 *****************************************************************************/
25 #include <vlc/input.h>
26 #include "vlc_playlist.h"
27 #include "playlist_internal.h"
30 /*****************************************************************************
32 *****************************************************************************/
33 int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args );
35 void PreparseEnqueueItemSub( playlist_t *, playlist_item_t * );
37 playlist_item_t *playlist_RecursiveFindLast(playlist_t *p_playlist,
38 playlist_item_t *p_node );
40 /*****************************************************************************
42 *****************************************************************************/
45 * Do a playlist action. Should be entered without playlist lock
46 * \see playlist_Control
48 int playlist_LockControl( playlist_t * p_playlist, int i_query, ... )
52 va_start( args, i_query );
53 vlc_mutex_lock( &p_playlist->object_lock );
54 i_result = PlaylistVAControl( p_playlist, i_query, args );
56 vlc_mutex_unlock( &p_playlist->object_lock );
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
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
71 int playlist_Control( playlist_t * p_playlist, int i_query, ... )
75 va_start( args, i_query );
76 i_result = PlaylistVAControl( p_playlist, i_query, args );
82 int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args )
84 playlist_item_t *p_item, *p_node;
87 if( p_playlist->items.i_size <= 0 )
93 p_playlist->request.i_status = PLAYLIST_STOPPED;
94 p_playlist->request.b_request = VLC_TRUE;
95 p_playlist->request.p_item = NULL;
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 )
105 p_node = p_playlist->status.p_node;
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;
118 if( p_playlist->p_input )
120 val.i_int = PLAYING_S;
121 var_Set( p_playlist->p_input, "state", val );
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;
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;
144 if( p_playlist->p_input )
145 var_Get( p_playlist->p_input, "state", &val );
147 if( val.i_int == PAUSE_S )
149 p_playlist->status.i_status = PLAYLIST_RUNNING;
150 if( p_playlist->p_input )
152 val.i_int = PLAYING_S;
153 var_Set( p_playlist->p_input, "state", val );
158 p_playlist->status.i_status = PLAYLIST_PAUSED;
159 if( p_playlist->p_input )
162 var_Set( p_playlist->p_input, "state", val );
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;
178 msg_Err( p_playlist, "unknown playlist query" );
186 /*****************************************************************************
188 *****************************************************************************/
189 /** Enqueue an item for preparsing */
190 int playlist_PreparseEnqueue( playlist_t *p_playlist,
191 input_item_t *p_item )
193 vlc_mutex_lock( &p_playlist->p_preparse->object_lock );
194 vlc_gc_incref( p_item );
195 INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
196 p_playlist->p_preparse->i_waiting,
197 p_playlist->p_preparse->i_waiting,
199 vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
200 vlc_cond_signal( &p_playlist->p_preparse->object_wait );
204 /** Enqueue a playlist item or a node for peparsing.
205 * This function should be entered without playlist and preparser locks */
206 int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
207 playlist_item_t *p_item )
209 vlc_mutex_lock( &p_playlist->object_lock );
210 vlc_mutex_lock( &p_playlist->p_preparse->object_lock );
211 PreparseEnqueueItemSub( p_playlist, p_item );
212 vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
213 vlc_mutex_unlock( &p_playlist->object_lock );
217 int playlist_AskForArtEnqueue( playlist_t *p_playlist,
218 input_item_t *p_item )
223 p.b_fetch_art = VLC_TRUE;
225 vlc_mutex_lock( &p_playlist->p_secondary_preparse->object_lock );
226 for( i = 0; i < p_playlist->p_secondary_preparse->i_waiting &&
227 p_playlist->p_secondary_preparse->p_waiting->b_fetch_art == VLC_TRUE;
229 vlc_gc_incref( p_item );
230 INSERT_ELEM( p_playlist->p_secondary_preparse->p_waiting,
231 p_playlist->p_secondary_preparse->i_waiting,
233 vlc_mutex_unlock( &p_playlist->p_secondary_preparse->object_lock );
234 vlc_cond_signal( &p_playlist->p_secondary_preparse->object_wait );
238 void PreparseEnqueueItemSub( playlist_t *p_playlist,
239 playlist_item_t *p_item )
242 if( p_item->i_children == -1 )
244 vlc_gc_incref( p_item );
245 INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
246 p_playlist->p_preparse->i_waiting,
247 p_playlist->p_preparse->i_waiting,
252 for( i = 0; i < p_item->i_children; i++)
254 PreparseEnqueueItemSub( p_playlist, p_item->pp_children[i] );
259 /*****************************************************************************
261 *****************************************************************************/
263 static void ResyncCurrentIndex(playlist_t *p_playlist, playlist_item_t *p_cur )
265 PL_DEBUG("resyncing on %s", PLI_NAME(p_cur) );
266 /* Simply resync index */
268 p_playlist->i_current_index = -1;
269 for( i = 0 ; i< p_playlist->current.i_size; i++ )
271 if( ARRAY_VAL(p_playlist->current, i) == p_cur )
273 p_playlist->i_current_index = i;
277 PL_DEBUG("%s is at %i", PLI_NAME(p_cur), p_playlist->i_current_index );
280 static void ResetCurrentlyPlaying( playlist_t *p_playlist, vlc_bool_t b_random,
281 playlist_item_t *p_cur )
283 playlist_item_t *p_next = NULL;
284 PL_DEBUG("rebuilding array of current - root %s",
285 PLI_NAME(p_playlist->status.p_node) );
286 ARRAY_RESET(p_playlist->current);
287 p_playlist->i_current_index = -1;
290 /** FIXME: this is *slow* */
291 p_next = playlist_GetNextLeaf( p_playlist,
292 p_playlist->status.p_node,
293 p_next, VLC_TRUE, VLC_FALSE );
296 if( p_next == p_cur )
297 p_playlist->i_current_index = p_playlist->current.i_size;
298 ARRAY_APPEND( p_playlist->current, p_next);
302 PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
303 p_playlist->i_current_index);
306 /* Shuffle the array */
307 srand( (unsigned int)mdate() );
310 for( j = p_playlist->current.i_size - 1; j > 0; j-- )
313 int i = rand() % (j+1); /* between 0 and j */
314 playlist_item_t *p_tmp;
315 p_tmp = ARRAY_VAL(p_playlist->current, i);
316 ARRAY_VAL(p_playlist->current,i) = ARRAY_VAL(p_playlist->current,j);
317 ARRAY_VAL(p_playlist->current,j) = p_tmp;
320 p_playlist->b_reset_currently_playing = VLC_FALSE;
323 /** This function calculates the next playlist item, depending
324 * on the playlist course mode (forward, backward, random, view,...). */
325 playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
327 playlist_item_t *p_new = NULL;
330 vlc_bool_t b_loop = var_GetBool( p_playlist, "loop" );
331 vlc_bool_t b_random = var_GetBool( p_playlist, "random" );
332 vlc_bool_t b_repeat = var_GetBool( p_playlist, "repeat" );
333 vlc_bool_t b_playstop = var_GetBool( p_playlist, "play-and-stop" );
335 /* Handle quickly a few special cases */
336 /* No items to play */
337 if( p_playlist->items.i_size == 0 )
339 msg_Info( p_playlist, "playlist is empty" );
343 /* Repeat and play/stop */
344 if( !p_playlist->request.b_request && b_repeat == VLC_TRUE &&
345 p_playlist->status.p_item )
347 msg_Dbg( p_playlist,"repeating item" );
348 return p_playlist->status.p_item;
350 if( !p_playlist->request.b_request && b_playstop == VLC_TRUE )
352 msg_Dbg( p_playlist,"stopping (play and stop)");
356 if( !p_playlist->request.b_request && p_playlist->status.p_item )
358 playlist_item_t *p_parent = p_playlist->status.p_item;
361 if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
363 msg_Dbg( p_playlist, "blocking item, stopping") ;
366 p_parent = p_parent->p_parent;
370 /* Start the real work */
371 if( p_playlist->request.b_request )
373 p_new = p_playlist->request.p_item;
374 i_skip = p_playlist->request.i_skip;
375 PL_DEBUG( "processing request item %s node %s skip %i",
376 PLI_NAME( p_playlist->request.p_item ),
377 PLI_NAME( p_playlist->request.p_node ), i_skip );
379 if( p_playlist->request.p_node &&
380 p_playlist->request.p_node != p_playlist->status.p_node )
382 p_playlist->status.p_node = p_playlist->request.p_node;
383 p_playlist->b_reset_currently_playing = VLC_TRUE;
386 /* If we are asked for a node, dont take it */
387 if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
390 if( p_playlist->b_reset_currently_playing )
391 ResetCurrentlyPlaying( p_playlist, b_random, p_new );
393 ResyncCurrentIndex( p_playlist, p_new );
395 p_playlist->i_current_index = -1;
397 if( p_playlist->current.i_size && i_skip > 0 )
399 for( i = i_skip; i > 0 ; i-- )
401 p_playlist->i_current_index++;
402 if( p_playlist->i_current_index == p_playlist->current.i_size )
404 PL_DEBUG( "looping - restarting at beginning of node" );
405 p_playlist->i_current_index = 0;
408 p_new = ARRAY_VAL( p_playlist->current,
409 p_playlist->i_current_index );
411 else if( p_playlist->current.i_size && i_skip < 0 )
413 for( i = i_skip; i < 0 ; i++ )
415 p_playlist->i_current_index--;
416 if( p_playlist->i_current_index == -1 )
418 PL_DEBUG( "looping - restarting at end of node" );
419 p_playlist->i_current_index = p_playlist->current.i_size-1;
422 p_new = ARRAY_VAL( p_playlist->current,
423 p_playlist->i_current_index );
425 /* Clear the request */
426 p_playlist->request.b_request = VLC_FALSE;
428 /* "Automatic" item change ( next ) */
431 PL_DEBUG( "changing item without a request (current %i/%i)",
432 p_playlist->i_current_index, p_playlist->current.i_size );
433 /* Cant go to next from current item */
434 if( p_playlist->status.p_item &&
435 p_playlist->status.p_item->i_flags & PLAYLIST_SKIP_FLAG )
438 if( p_playlist->b_reset_currently_playing )
439 ResetCurrentlyPlaying( p_playlist, b_random,
440 p_playlist->status.p_item );
442 p_playlist->i_current_index++;
443 if( p_playlist->i_current_index == p_playlist->current.i_size )
445 if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
446 p_playlist->i_current_index = 0;
448 PL_DEBUG( "using item %i", p_playlist->i_current_index );
449 if ( p_playlist->current.i_size == 0 ) return NULL;
451 p_new = ARRAY_VAL( p_playlist->current, p_playlist->i_current_index );
452 /* The new item can't be autoselected */
453 if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
459 /** Start the input for an item */
460 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
463 int i_activity = var_GetInteger( p_playlist, "activity") ;
465 msg_Dbg( p_playlist, "creating new input thread" );
467 p_item->p_input->i_nb_played++;
468 p_playlist->status.p_item = p_item;
470 p_playlist->status.i_status = PLAYLIST_RUNNING;
472 var_SetInteger( p_playlist, "activity", i_activity +
473 DEFAULT_INPUT_ACTIVITY );
474 p_playlist->p_input = input_CreateThread( p_playlist, p_item->p_input );
476 val.i_int = p_item->p_input->i_id;
477 /* unlock the playlist to set the var...mmm */
478 vlc_mutex_unlock( &p_playlist->object_lock);
479 var_Set( p_playlist, "playlist-current", val);
480 vlc_mutex_lock( &p_playlist->object_lock);