1 /*****************************************************************************
2 * control.c : Hanle 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"
29 /*****************************************************************************
31 *****************************************************************************/
32 int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args );
34 void PreparseEnqueueItemSub( playlist_t *, playlist_item_t * );
36 playlist_item_t *playlist_RecursiveFindLast(playlist_t *p_playlist,
37 playlist_item_t *p_node );
39 /*****************************************************************************
41 *****************************************************************************/
44 * Do a playlist action. Should be entered without playlist lock
45 * \see playlist_Control
47 int playlist_LockControl( playlist_t * p_playlist, int i_query, ... )
51 va_start( args, i_query );
52 vlc_mutex_lock( &p_playlist->object_lock );
53 i_result = PlaylistVAControl( p_playlist, i_query, args );
55 vlc_mutex_unlock( &p_playlist->object_lock );
60 * Do a playlist action.
61 * If there is something in the playlist then you can do playlist actions.
62 * Should be entered with playlist lock. See include/vlc_playlist.h for
65 * \param p_playlist the playlist to do the command on
66 * \param i_query the command to do
67 * \param variable number of arguments
68 * \return VLC_SUCCESS or an error
70 int playlist_Control( playlist_t * p_playlist, int i_query, ... )
74 va_start( args, i_query );
75 i_result = PlaylistVAControl( p_playlist, i_query, args );
81 int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args )
83 playlist_item_t *p_item, *p_node;
86 if( p_playlist->i_size <= 0 )
94 p_playlist->request.i_status = PLAYLIST_STOPPED;
95 p_playlist->request.b_request = VLC_TRUE;
96 p_playlist->request.p_item = NULL;
99 // Node can be null, it will keep the same. Use with care ...
100 // Item null = take the first child of node
101 case PLAYLIST_VIEWPLAY:
102 p_node = (playlist_item_t *)va_arg( args, playlist_item_t * );
103 p_item = (playlist_item_t *)va_arg( args, playlist_item_t * );
104 if ( p_node == NULL )
106 p_node = p_playlist->status.p_node;
109 p_playlist->request.i_status = PLAYLIST_RUNNING;
110 p_playlist->request.i_skip = 0;
111 p_playlist->request.b_request = VLC_TRUE;
112 p_playlist->request.p_node = p_node;
113 p_playlist->request.p_item = p_item;
117 if( p_playlist->p_input )
119 val.i_int = PLAYING_S;
120 var_Set( p_playlist->p_input, "state", val );
125 p_playlist->request.i_status = PLAYLIST_RUNNING;
126 p_playlist->request.b_request = VLC_TRUE;
127 p_playlist->request.p_node = p_playlist->status.p_node;
128 p_playlist->request.p_item = p_playlist->status.p_item;
129 p_playlist->request.i_skip = 0;
133 case PLAYLIST_AUTOPLAY:
134 // AUTOPLAY is an ugly hack for initial status.
135 // Hopefully it will disappear
136 p_playlist->status.i_status = PLAYLIST_RUNNING;
137 p_playlist->request.p_node = p_playlist->status.p_node;
138 p_playlist->request.b_request = VLC_FALSE;
143 if( p_playlist->p_input )
144 var_Get( p_playlist->p_input, "state", &val );
146 if( val.i_int == PAUSE_S )
148 p_playlist->status.i_status = PLAYLIST_RUNNING;
149 if( p_playlist->p_input )
151 val.i_int = PLAYING_S;
152 var_Set( p_playlist->p_input, "state", val );
157 p_playlist->status.i_status = PLAYLIST_PAUSED;
158 if( p_playlist->p_input )
161 var_Set( p_playlist->p_input, "state", val );
167 p_playlist->request.p_node = p_playlist->status.p_node;
168 p_playlist->request.p_item = p_playlist->status.p_item;
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 = VLC_TRUE;
177 msg_Err( p_playlist, "unknown playlist query" );
185 /*****************************************************************************
187 *****************************************************************************/
188 /** Enqueue an item for preparsing */
189 int playlist_PreparseEnqueue( playlist_t *p_playlist,
190 input_item_t *p_item )
192 vlc_mutex_lock( &p_playlist->p_preparse->object_lock );
193 vlc_gc_incref( p_item );
194 INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
195 p_playlist->p_preparse->i_waiting,
196 p_playlist->p_preparse->i_waiting,
198 vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
202 /** Enqueue a playlist item or a node for peparsing.
203 * This function should be entered without playlist and preparser locks */
204 int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
205 playlist_item_t *p_item )
207 vlc_mutex_lock( &p_playlist->object_lock );
208 vlc_mutex_lock( &p_playlist->p_preparse->object_lock );
209 PreparseEnqueueItemSub( p_playlist, p_item );
210 vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
211 vlc_mutex_unlock( &p_playlist->object_lock );
215 void PreparseEnqueueItemSub( playlist_t *p_playlist,
216 playlist_item_t *p_item )
219 if( p_item->i_children == -1 )
221 vlc_gc_incref( p_item );
222 INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
223 p_playlist->p_preparse->i_waiting,
224 p_playlist->p_preparse->i_waiting,
229 for( i = 0; i < p_item->i_children; i++)
231 PreparseEnqueueItemSub( p_playlist,
232 p_item->pp_children[i] );
237 /*****************************************************************************
239 *****************************************************************************/
241 /** This function calculates the next playlist item, depending
242 * on the playlist course mode (forward, backward, random, view,...). */
243 playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
245 playlist_item_t *p_new = NULL;
248 vlc_bool_t b_loop = var_GetBool( p_playlist, "loop" );
249 vlc_bool_t b_random = var_GetBool( p_playlist, "random" );
250 vlc_bool_t b_repeat = var_GetBool( p_playlist, "repeat" );
251 vlc_bool_t b_playstop = var_GetBool( p_playlist, "play-and-stop" );
253 /* Handle quickly a few special cases */
254 /* No items to play */
255 if( p_playlist->i_size == 0 )
257 msg_Info( p_playlist, "playlist is empty" );
261 /* Repeat and play/stop */
262 if( !p_playlist->request.b_request && b_repeat == VLC_TRUE &&
263 p_playlist->status.p_item )
265 msg_Dbg( p_playlist,"repeating item" );
266 return p_playlist->status.p_item;
268 if( !p_playlist->request.b_request && b_playstop == VLC_TRUE )
270 msg_Dbg( p_playlist,"stopping (play and stop)");
274 if( !p_playlist->request.b_request && p_playlist->status.p_item &&
275 p_playlist->status.p_item->i_flags & PLAYLIST_SKIP_FLAG )
277 msg_Dbg( p_playlist, "blocking item, stopping") ;
281 /* Random case. This is an exception: if request, but request is skip +- 1
282 * we don't go to next item but select a new random one. */
284 ( !p_playlist->request.b_request ||
285 ( p_playlist->request.b_request &&
286 ( p_playlist->request.p_item == NULL ||
287 p_playlist->request.i_skip == 1 ||
288 p_playlist->request.i_skip == -1 ) ) ) )
291 /* how many items to choose from ? */
292 int i_count = 0, i_new;
293 for ( i = 0; i < p_playlist->i_size; i++ )
295 if ( p_playlist->pp_items[i]->p_input->i_nb_played == 0 )
301 /* Don't loop? Exit! */
304 /* Otherwise reset the counter */
305 for ( i = 0; i < p_playlist->i_size; i++ )
307 p_playlist->pp_items[i]->p_input->i_nb_played = 0;
309 i_count = p_playlist->i_size;
311 srand( (unsigned int)mdate() );
312 i = rand() % i_count + 1 ;
313 /* loop thru the list and count down the unplayed items to the selected one */
314 for ( i_new = 0; i_new < p_playlist->i_size && i > 0; i_new++ )
316 if ( p_playlist->pp_items[i_new]->p_input->i_nb_played == 0 )
321 p_playlist->request.i_skip = 0;
322 p_playlist->request.b_request = VLC_FALSE;
323 return p_playlist->pp_items[i_new];
327 /* Start the real work */
328 if( p_playlist->request.b_request )
330 PL_DEBUG( "processing request node %s item %s skip %i",
331 PLI_NAME( p_playlist->request.p_item ),
332 PLI_NAME( p_playlist->request.p_node ), i_skip );
333 p_new = p_playlist->request.p_item;
334 i_skip = p_playlist->request.i_skip;
336 if( p_playlist->request.p_node )
337 p_playlist->status.p_node = p_playlist->request.p_node;
339 /* If we are asked for a node, dont take it */
340 if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
345 for( i = i_skip; i > 0 ; i-- )
347 p_new = playlist_GetNextLeaf( p_playlist,
348 p_playlist->request.p_node,
349 p_new, VLC_TRUE, VLC_FALSE );
352 PL_DEBUG( "looping - restarting at beginning of node" );
353 p_new = playlist_GetNextLeaf( p_playlist,
354 p_playlist->request.p_node,
355 NULL, VLC_TRUE, VLC_FALSE);
356 if( p_new == NULL ) break;
360 else if( i_skip < 0 )
362 for( i = i_skip; i < 0 ; i++ )
364 p_new = playlist_GetPrevLeaf( p_playlist,
365 p_playlist->request.p_node,
366 p_new, VLC_FALSE, VLC_FALSE );
369 PL_DEBUG( "looping - restarting at end of node" );
370 /** \bug This is needed because GetPrevLeaf does not loop
372 p_new = playlist_GetLastLeaf( p_playlist,
373 p_playlist->request.p_node );
375 if( p_new == NULL ) break;
378 /* Clear the request */
379 p_playlist->request.b_request = VLC_FALSE;
381 /* "Automatic" item change ( next ) */
384 PL_DEBUG( "changing item without a request" );
385 /* Cant go to next from current item */
386 if( p_playlist->status.p_item &&
387 p_playlist->status.p_item->i_flags & PLAYLIST_SKIP_FLAG )
390 p_new = playlist_GetNextLeaf( p_playlist,
391 p_playlist->status.p_node,
392 p_playlist->status.p_item,
393 VLC_TRUE, VLC_FALSE );
394 if( p_new == NULL && b_loop )
396 PL_DEBUG( "looping" );
397 p_new = playlist_GetNextLeaf( p_playlist,
398 p_playlist->status.p_node,
399 NULL, VLC_TRUE, VLC_FALSE );
401 /* The new item can't be autoselected */
402 if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
407 msg_Dbg( p_playlist, "did not find something to play" );
412 /** Start the input for an item */
413 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
416 int i_activity = var_GetInteger( p_playlist, "activity") ;
418 msg_Dbg( p_playlist, "creating new input thread" );
420 p_item->p_input->i_nb_played++;
421 p_playlist->status.p_item = p_item;
423 p_playlist->status.i_status = PLAYLIST_RUNNING;
425 var_SetInteger( p_playlist, "activity", i_activity +
426 DEFAULT_INPUT_ACTIVITY );
427 p_playlist->p_input = input_CreateThread( p_playlist, p_item->p_input );
429 val.i_int = p_item->p_input->i_id;
430 /* unlock the playlist to set the var...mmm */
431 vlc_mutex_unlock( &p_playlist->object_lock);
432 var_Set( p_playlist, "playlist-current", val);
433 vlc_mutex_lock( &p_playlist->object_lock);