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 )
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_node = (playlist_item_t *)va_arg( args, playlist_item_t * );
104 p_item = (playlist_item_t *)va_arg( args, playlist_item_t * );
105 if ( p_node == NULL )
107 p_node = p_playlist->status.p_node;
110 p_playlist->request.i_status = PLAYLIST_RUNNING;
111 p_playlist->request.i_skip = 0;
112 p_playlist->request.b_request = VLC_TRUE;
113 p_playlist->request.p_node = p_node;
114 p_playlist->request.p_item = p_item;
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 );
203 /** Enqueue a playlist item or a node for peparsing.
204 * This function should be entered without playlist and preparser locks */
205 int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
206 playlist_item_t *p_item )
208 vlc_mutex_lock( &p_playlist->object_lock );
209 vlc_mutex_lock( &p_playlist->p_preparse->object_lock );
210 PreparseEnqueueItemSub( p_playlist, p_item );
211 vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
212 vlc_mutex_unlock( &p_playlist->object_lock );
216 void PreparseEnqueueItemSub( playlist_t *p_playlist,
217 playlist_item_t *p_item )
220 if( p_item->i_children == -1 )
222 vlc_gc_incref( p_item );
223 INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
224 p_playlist->p_preparse->i_waiting,
225 p_playlist->p_preparse->i_waiting,
230 for( i = 0; i < p_item->i_children; i++)
232 PreparseEnqueueItemSub( p_playlist,
233 p_item->pp_children[i] );
238 /*****************************************************************************
240 *****************************************************************************/
242 /** This function calculates the next playlist item, depending
243 * on the playlist course mode (forward, backward, random, view,...). */
244 playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
246 playlist_item_t *p_new = NULL;
249 vlc_bool_t b_loop = var_GetBool( p_playlist, "loop" );
250 vlc_bool_t b_random = var_GetBool( p_playlist, "random" );
251 vlc_bool_t b_repeat = var_GetBool( p_playlist, "repeat" );
252 vlc_bool_t b_playstop = var_GetBool( p_playlist, "play-and-stop" );
254 /* Handle quickly a few special cases */
255 /* No items to play */
256 if( p_playlist->i_size == 0 )
258 msg_Info( p_playlist, "playlist is empty" );
262 /* Repeat and play/stop */
263 if( !p_playlist->request.b_request && b_repeat == VLC_TRUE &&
264 p_playlist->status.p_item )
266 msg_Dbg( p_playlist,"repeating item" );
267 return p_playlist->status.p_item;
269 if( !p_playlist->request.b_request && b_playstop == VLC_TRUE )
271 msg_Dbg( p_playlist,"stopping (play and stop)");
275 if( !p_playlist->request.b_request && p_playlist->status.p_item &&
276 p_playlist->status.p_item->i_flags & PLAYLIST_SKIP_FLAG )
278 msg_Dbg( p_playlist, "blocking item, stopping") ;
282 /* Random case. This is an exception: if request, but request is skip +- 1
283 * we don't go to next item but select a new random one. */
285 msg_Err( p_playlist, "random unsupported" );
288 ( !p_playlist->request.b_request ||
289 ( p_playlist->request.b_request && ( p_playlist->request.p_item == NULL ||
290 p_playlist->request.i_skip == 1 || p_playlist->request.i_skip == -1 ) ) ) )
292 /* how many items to choose from ? */
294 for ( i = 0; i < p_playlist->i_size; i++ )
296 if ( p_playlist->pp_items[i]->p_input->i_nb_played == 0 )
302 /* Don't loop? Exit! */
305 /* Otherwise reset the counter */
306 for ( i = 0; i < p_playlist->i_size; i++ )
308 p_playlist->pp_items[i]->p_input->i_nb_played = 0;
310 i_count = p_playlist->i_size;
312 srand( (unsigned int)mdate() );
313 i = rand() % i_count + 1 ;
314 /* loop thru the list and count down the unplayed items to the selected one */
315 for ( i_new = 0; i_new < p_playlist->i_size && i > 0; i_new++ )
317 if ( p_playlist->pp_items[i_new]->p_input->i_nb_played == 0 )
322 p_playlist->request.i_skip = 0;
323 p_playlist->request.b_request = VLC_FALSE;
324 return p_playlist->pp_items[i_new];
328 /* Start the real work */
329 if( p_playlist->request.b_request )
331 PL_DEBUG( "processing request" );
332 p_new = p_playlist->request.p_item;
333 i_skip = p_playlist->request.i_skip;
335 if( p_playlist->request.p_node )
336 p_playlist->status.p_node = p_playlist->request.p_node;
338 /* If we are asked for a node, dont take it */
339 if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
344 for( i = i_skip; i > 0 ; i-- )
346 p_new = playlist_GetNextEnabledLeaf( p_playlist,
347 p_playlist->request.p_node,
351 PL_DEBUG( "looping - restarting at beginning of node" );
352 p_new = playlist_GetNextLeaf( p_playlist,
353 p_playlist->request.p_node,
355 if( p_new == NULL ) break;
359 else if( i_skip < 0 )
361 for( i = i_skip; i < 0 ; i++ )
363 p_new = playlist_GetPrevLeaf( p_playlist,
364 p_playlist->request.p_node,
368 PL_DEBUG( "looping - restarting at end of node" );
369 /** \bug This is needed because GetPrevLeaf does not loop
371 p_new = playlist_GetLastLeaf( p_playlist,
372 p_playlist->request.p_node );
374 if( p_new == NULL ) break;
377 /* Clear the request */
378 p_playlist->request.b_request = VLC_FALSE;
380 /* "Automatic" item change ( next ) */
383 PL_DEBUG( "changing item without a request" );
384 /* Cant go to next from current item */
385 if( p_playlist->status.p_item &&
386 p_playlist->status.p_item->i_flags & PLAYLIST_SKIP_FLAG )
389 p_new = playlist_GetNextLeaf( p_playlist,
390 p_playlist->status.p_node,
391 p_playlist->status.p_item );
392 if( p_new == NULL && b_loop )
394 PL_DEBUG( "looping" );
395 p_new = playlist_GetNextLeaf( p_playlist,
396 p_playlist->status.p_node,
399 /* The new item can't be autoselected */
400 if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
405 msg_Dbg( p_playlist, "did not find something to play" );
410 /** Start the input for an item */
411 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
414 int i_activity = var_GetInteger( p_playlist, "activity") ;
416 msg_Dbg( p_playlist, "creating new input thread" );
418 p_item->p_input->i_nb_played++;
419 p_playlist->status.p_item = p_item;
421 p_playlist->status.i_status = PLAYLIST_RUNNING;
423 var_SetInteger( p_playlist, "activity", i_activity +
424 DEFAULT_INPUT_ACTIVITY );
425 p_playlist->p_input = input_CreateThread( p_playlist, p_item->p_input );
427 val.i_int = p_item->p_input->i_id;
428 /* unlock the playlist to set the var...mmm */
429 vlc_mutex_unlock( &p_playlist->object_lock);
430 var_Set( p_playlist, "playlist-current", val);
431 vlc_mutex_lock( &p_playlist->object_lock);