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->i_size <= 0 )
95 p_playlist->request.i_status = PLAYLIST_STOPPED;
96 p_playlist->request.b_request = VLC_TRUE;
97 p_playlist->request.p_item = NULL;
100 // Node can be null, it will keep the same. Use with care ...
101 // Item null = take the first child of node
102 case PLAYLIST_VIEWPLAY:
103 p_playlist->b_reset_random = VLC_TRUE;
104 p_node = (playlist_item_t *)va_arg( args, playlist_item_t * );
105 p_item = (playlist_item_t *)va_arg( args, playlist_item_t * );
106 if ( p_node == NULL )
108 p_node = p_playlist->status.p_node;
111 p_playlist->request.i_status = PLAYLIST_RUNNING;
112 p_playlist->request.i_skip = 0;
113 p_playlist->request.b_request = VLC_TRUE;
114 p_playlist->request.p_node = p_node;
115 p_playlist->request.p_item = p_item;
119 if( p_playlist->p_input )
121 val.i_int = PLAYING_S;
122 var_Set( p_playlist->p_input, "state", val );
127 p_playlist->request.i_status = PLAYLIST_RUNNING;
128 p_playlist->request.b_request = VLC_TRUE;
129 p_playlist->request.p_node = p_playlist->status.p_node;
130 p_playlist->request.p_item = p_playlist->status.p_item;
131 p_playlist->request.i_skip = 0;
135 case PLAYLIST_AUTOPLAY:
136 // AUTOPLAY is an ugly hack for initial status.
137 // Hopefully it will disappear
138 p_playlist->status.i_status = PLAYLIST_RUNNING;
139 p_playlist->request.p_node = p_playlist->status.p_node;
140 p_playlist->request.b_request = VLC_FALSE;
145 if( p_playlist->p_input )
146 var_Get( p_playlist->p_input, "state", &val );
148 if( val.i_int == PAUSE_S )
150 p_playlist->status.i_status = PLAYLIST_RUNNING;
151 if( p_playlist->p_input )
153 val.i_int = PLAYING_S;
154 var_Set( p_playlist->p_input, "state", val );
159 p_playlist->status.i_status = PLAYLIST_PAUSED;
160 if( p_playlist->p_input )
163 var_Set( p_playlist->p_input, "state", val );
169 p_playlist->request.p_node = p_playlist->status.p_node;
170 p_playlist->request.p_item = p_playlist->status.p_item;
171 p_playlist->request.i_skip = (int) va_arg( args, int );
172 /* if already running, keep running */
173 if( p_playlist->status.i_status != PLAYLIST_STOPPED )
174 p_playlist->request.i_status = p_playlist->status.i_status;
175 p_playlist->request.b_request = VLC_TRUE;
179 msg_Err( p_playlist, "unknown playlist query" );
187 /*****************************************************************************
189 *****************************************************************************/
190 /** Enqueue an item for preparsing */
191 int playlist_PreparseEnqueue( playlist_t *p_playlist,
192 input_item_t *p_item )
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,
200 vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
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,
234 vlc_mutex_unlock( &p_playlist->p_secondary_preparse->object_lock );
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 /** This function calculates the next playlist item, depending
264 * on the playlist course mode (forward, backward, random, view,...). */
265 playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
267 playlist_item_t *p_new = NULL;
270 vlc_bool_t b_loop = var_GetBool( p_playlist, "loop" );
271 vlc_bool_t b_random = var_GetBool( p_playlist, "random" );
272 vlc_bool_t b_repeat = var_GetBool( p_playlist, "repeat" );
273 vlc_bool_t b_playstop = var_GetBool( p_playlist, "play-and-stop" );
275 /* Handle quickly a few special cases */
276 /* No items to play */
277 if( p_playlist->i_size == 0 )
279 msg_Info( p_playlist, "playlist is empty" );
283 /* Repeat and play/stop */
284 if( !p_playlist->request.b_request && b_repeat == VLC_TRUE &&
285 p_playlist->status.p_item )
287 msg_Dbg( p_playlist,"repeating item" );
288 return p_playlist->status.p_item;
290 if( !p_playlist->request.b_request && b_playstop == VLC_TRUE )
292 msg_Dbg( p_playlist,"stopping (play and stop)");
296 if( !p_playlist->request.b_request && p_playlist->status.p_item )
298 playlist_item_t *p_parent = p_playlist->status.p_item;
301 if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
303 msg_Dbg( p_playlist, "blocking item, stopping") ;
306 p_parent = p_parent->p_parent;
310 /* Random case. This is an exception: if request, but request is skip +- 1
311 * we don't go to next item but select a new random one. */
313 ( !p_playlist->request.b_request ||
314 ( p_playlist->request.b_request &&
315 ( p_playlist->request.p_item == NULL ||
316 p_playlist->request.i_skip == 1 ||
317 p_playlist->request.i_skip == -1 ) ) ) )
319 PL_DEBUG( "doing random, have %i items, currently at %i, reset %i\n",
320 p_playlist->i_random, p_playlist->i_random_index,
321 p_playlist->b_reset_random );
322 if( p_playlist->b_reset_random )
325 FREE( p_playlist->pp_random );
326 if( !p_playlist->b_reset_random && !b_loop ) goto end;
327 p_playlist->i_random = 0;
328 p_playlist->i_random_index = 0;
329 p_playlist->i_random = playlist_GetAllEnabledChildren(
331 p_playlist->status.p_node,
332 &p_playlist->pp_random );
333 /* Shuffle the array */
334 srand( (unsigned int)mdate() );
336 for( j = p_playlist->i_random -1; j > 0; j-- )
339 int i = rand() % (j+1); /* between 0 and j */
340 playlist_item_t *p_tmp;
341 p_tmp = p_playlist->pp_random[i];
342 p_playlist->pp_random[i] = p_playlist->pp_random[j];
343 p_playlist->pp_random[j] = p_tmp;
345 p_playlist->b_reset_random = VLC_FALSE;
346 PL_DEBUG( "random rebuilt, have %i items", p_playlist->i_random );
350 /* Go backward or forward */
351 if( !p_playlist->request.b_request || !p_playlist->request.p_item ||
352 p_playlist->request.i_skip == 1 )
353 p_playlist->i_random_index++;
355 p_playlist->i_random_index--;
356 /* Handle bounds situations */
357 if( p_playlist->i_random_index == -1 )
359 if( !b_loop || p_playlist->i_random == 0 ) goto end;
360 p_playlist->i_random_index = p_playlist->i_random - 1;
362 else if( p_playlist->i_random_index == p_playlist->i_random )
364 if( !b_loop || p_playlist->i_random == 0 ) goto end;
365 p_playlist->i_random_index = 0;
368 PL_DEBUG( "using random item %i", p_playlist->i_random_index );
369 if ( p_playlist->i_random == 0 ) goto end; /* Can this happen ?? */
370 p_new = p_playlist->pp_random[p_playlist->i_random_index];
372 if( !p_new ) p_playlist->b_reset_random = VLC_TRUE;
373 p_playlist->request.i_skip = 0;
374 p_playlist->request.b_request = VLC_FALSE;
378 /* Start the real work */
379 if( p_playlist->request.b_request )
381 p_new = p_playlist->request.p_item;
382 i_skip = p_playlist->request.i_skip;
383 PL_DEBUG( "processing request item %s node %s skip %i",
384 PLI_NAME( p_playlist->request.p_item ),
385 PLI_NAME( p_playlist->request.p_node ), i_skip );
387 if( p_playlist->request.p_node )
388 p_playlist->status.p_node = p_playlist->request.p_node;
390 /* If we are asked for a node, dont take it */
391 if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
396 for( i = i_skip; i > 0 ; i-- )
398 p_new = playlist_GetNextLeaf( p_playlist,
399 p_playlist->request.p_node,
400 p_new, VLC_TRUE, VLC_FALSE );
403 PL_DEBUG( "looping - restarting at beginning of node" );
404 p_new = playlist_GetNextLeaf( p_playlist,
405 p_playlist->request.p_node,
406 NULL, VLC_TRUE, VLC_FALSE);
407 if( p_new == NULL ) break;
411 else if( i_skip < 0 )
413 for( i = i_skip; i < 0 ; i++ )
415 p_new = playlist_GetPrevLeaf( p_playlist,
416 p_playlist->request.p_node,
417 p_new, VLC_FALSE, VLC_FALSE );
420 PL_DEBUG( "looping - restarting at end of node" );
421 /** \bug This is needed because GetPrevLeaf does not loop
423 p_new = playlist_GetLastLeaf( p_playlist,
424 p_playlist->request.p_node );
426 if( p_new == NULL ) break;
429 /* Clear the request */
430 p_playlist->request.b_request = VLC_FALSE;
432 /* "Automatic" item change ( next ) */
435 PL_DEBUG( "changing item without a request" );
436 /* Cant go to next from current item */
437 if( p_playlist->status.p_item &&
438 p_playlist->status.p_item->i_flags & PLAYLIST_SKIP_FLAG )
441 p_new = playlist_GetNextLeaf( p_playlist,
442 p_playlist->status.p_node,
443 p_playlist->status.p_item,
444 VLC_TRUE, VLC_FALSE );
445 if( p_new == NULL && b_loop )
447 PL_DEBUG( "looping" );
448 p_new = playlist_GetNextLeaf( p_playlist,
449 p_playlist->status.p_node,
450 NULL, VLC_TRUE, VLC_FALSE );
452 /* The new item can't be autoselected */
453 if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
458 msg_Dbg( p_playlist, "did not find something to play" );
463 /** Start the input for an item */
464 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
467 int i_activity = var_GetInteger( p_playlist, "activity") ;
469 msg_Dbg( p_playlist, "creating new input thread" );
471 p_item->p_input->i_nb_played++;
472 p_playlist->status.p_item = p_item;
474 p_playlist->status.i_status = PLAYLIST_RUNNING;
476 var_SetInteger( p_playlist, "activity", i_activity +
477 DEFAULT_INPUT_ACTIVITY );
478 p_playlist->p_input = input_CreateThread( p_playlist, p_item->p_input );
480 val.i_int = p_item->p_input->i_id;
481 /* unlock the playlist to set the var...mmm */
482 vlc_mutex_unlock( &p_playlist->object_lock);
483 var_Set( p_playlist, "playlist-current", val);
484 vlc_mutex_lock( &p_playlist->object_lock);