1 /*****************************************************************************
2 * control.c : Handle control of the playlist & running through it
3 *****************************************************************************
4 * Copyright (C) 1999-2004 the VideoLAN team
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 *****************************************************************************/
28 #include <vlc_common.h>
29 #include "vlc_playlist.h"
30 #include "playlist_internal.h"
33 /*****************************************************************************
35 *****************************************************************************/
36 static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args );
38 static void PreparseEnqueueItemSub( playlist_t *, playlist_item_t * );
40 /*****************************************************************************
42 *****************************************************************************/
44 playlist_t *__pl_Yield( vlc_object_t *p_this )
49 pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
51 assert( pl != p_this /* This does not make sense to yield the playlist
52 using pl_Yield. use vlc_object_yield in this case */ );
55 vlc_object_yield (pl);
59 void __pl_Release( vlc_object_t *p_this )
61 playlist_t *pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
64 assert( pl != p_this /* The rule is that pl_Release() should act on
65 the same object than pl_Yield() */ );
67 vlc_object_release( pl );
70 int playlist_Control( playlist_t * p_playlist, int i_query,
75 va_start( args, b_locked );
76 PL_LOCK_IF( !b_locked );
77 i_result = PlaylistVAControl( p_playlist, i_query, args );
79 PL_UNLOCK_IF( !b_locked );
84 static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args )
86 playlist_item_t *p_item, *p_node;
89 if( !vlc_object_alive( p_playlist ) )
92 if( playlist_IsEmpty( p_playlist ) )
98 p_playlist->request.i_status = PLAYLIST_STOPPED;
99 p_playlist->request.b_request = true;
100 p_playlist->request.p_item = NULL;
103 // Node can be null, it will keep the same. Use with care ...
104 // Item null = take the first child of node
105 case PLAYLIST_VIEWPLAY:
106 p_node = (playlist_item_t *)va_arg( args, playlist_item_t * );
107 p_item = (playlist_item_t *)va_arg( args, playlist_item_t * );
108 if ( p_node == NULL )
110 p_node = p_playlist->status.p_node;
113 p_playlist->request.i_status = PLAYLIST_RUNNING;
114 p_playlist->request.i_skip = 0;
115 p_playlist->request.b_request = true;
116 p_playlist->request.p_node = p_node;
117 p_playlist->request.p_item = p_item;
118 if( p_item && var_GetBool( p_playlist, "random" ) )
119 p_playlist->b_reset_currently_playing = true;
123 if( p_playlist->p_input )
125 val.i_int = PLAYING_S;
126 var_Set( p_playlist->p_input, "state", val );
131 p_playlist->request.i_status = PLAYLIST_RUNNING;
132 p_playlist->request.b_request = true;
133 p_playlist->request.p_node = get_current_status_node( p_playlist );
134 p_playlist->request.p_item = get_current_status_item( p_playlist );
135 p_playlist->request.i_skip = 0;
141 if( p_playlist->p_input )
142 var_Get( p_playlist->p_input, "state", &val );
144 if( val.i_int == PAUSE_S )
146 p_playlist->status.i_status = PLAYLIST_RUNNING;
147 if( p_playlist->p_input )
149 val.i_int = PLAYING_S;
150 var_Set( p_playlist->p_input, "state", val );
155 p_playlist->status.i_status = PLAYLIST_PAUSED;
156 if( p_playlist->p_input )
159 var_Set( p_playlist->p_input, "state", val );
165 p_playlist->request.p_node = get_current_status_node( p_playlist );
166 p_playlist->request.p_item = get_current_status_item( p_playlist );
167 p_playlist->request.i_skip = (int) va_arg( args, int );
168 /* if already running, keep running */
169 if( p_playlist->status.i_status != PLAYLIST_STOPPED )
170 p_playlist->request.i_status = p_playlist->status.i_status;
171 p_playlist->request.b_request = true;
175 msg_Err( p_playlist, "unknown playlist query" );
179 vlc_object_signal_maybe( VLC_OBJECT(p_playlist) );
184 /*****************************************************************************
186 *****************************************************************************/
187 /** Enqueue an item for preparsing */
188 int playlist_PreparseEnqueue( playlist_t *p_playlist,
189 input_item_t *p_item )
191 vlc_object_lock( p_playlist->p_preparse );
192 if( !vlc_object_alive( p_playlist->p_preparse ) )
194 vlc_object_unlock( p_playlist->p_preparse );
197 vlc_gc_incref( p_item );
198 INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
199 p_playlist->p_preparse->i_waiting,
200 p_playlist->p_preparse->i_waiting,
202 vlc_object_signal_unlocked( p_playlist->p_preparse );
203 vlc_object_unlock( p_playlist->p_preparse );
207 /** Enqueue a playlist item or a node for peparsing.
208 * This function should be entered without playlist and preparser locks */
209 int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
210 playlist_item_t *p_item )
212 vlc_object_lock( p_playlist );
213 vlc_object_lock( p_playlist->p_preparse );
214 if( !vlc_object_alive( p_playlist->p_preparse ) )
216 vlc_object_unlock( p_playlist->p_preparse );
217 vlc_object_unlock( p_playlist );
220 PreparseEnqueueItemSub( p_playlist, p_item );
221 vlc_object_unlock( p_playlist->p_preparse );
222 vlc_object_unlock( p_playlist );
226 int playlist_AskForArtEnqueue( playlist_t *p_playlist,
227 input_item_t *p_item )
229 vlc_object_lock( p_playlist->p_fetcher );
230 if( !vlc_object_alive( p_playlist->p_fetcher ) )
232 vlc_object_unlock( p_playlist->p_fetcher );
236 vlc_gc_incref( p_item );
237 INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
238 p_playlist->p_fetcher->i_waiting,
239 p_playlist->p_fetcher->i_waiting, p_item );
240 vlc_object_signal_unlocked( p_playlist->p_fetcher );
241 vlc_object_unlock( p_playlist->p_fetcher );
245 static void PreparseEnqueueItemSub( playlist_t *p_playlist,
246 playlist_item_t *p_item )
249 if( p_item->i_children == -1 )
251 vlc_gc_incref( p_item->p_input );
252 INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
253 p_playlist->p_preparse->i_waiting,
254 p_playlist->p_preparse->i_waiting,
259 for( i = 0; i < p_item->i_children; i++)
261 PreparseEnqueueItemSub( p_playlist, p_item->pp_children[i] );
266 /*****************************************************************************
268 *****************************************************************************/
271 * Synchronise the current index of the playlist
272 * to match the index of the current item.
274 * \param p_playlist the playlist structure
275 * \param p_cur the current playlist item
278 static void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur )
280 PL_DEBUG( "resyncing on %s", PLI_NAME( p_cur ) );
281 /* Simply resync index */
283 p_playlist->i_current_index = -1;
284 for( i = 0 ; i< p_playlist->current.i_size; i++ )
286 if( ARRAY_VAL( p_playlist->current, i ) == p_cur )
288 p_playlist->i_current_index = i;
292 PL_DEBUG( "%s is at %i", PLI_NAME( p_cur ), p_playlist->i_current_index );
295 void ResetCurrentlyPlaying( playlist_t *p_playlist, bool b_random,
296 playlist_item_t *p_cur )
298 playlist_item_t *p_next = NULL;
299 stats_TimerStart( p_playlist, "Items array build",
300 STATS_TIMER_PLAYLIST_BUILD );
301 PL_DEBUG( "rebuilding array of current - root %s",
302 PLI_NAME( p_playlist->status.p_node ) );
303 ARRAY_RESET( p_playlist->current );
304 p_playlist->i_current_index = -1;
307 /** FIXME: this is *slow* */
308 p_next = playlist_GetNextLeaf( p_playlist,
309 p_playlist->status.p_node,
310 p_next, true, false );
313 if( p_next == p_cur )
314 p_playlist->i_current_index = p_playlist->current.i_size;
315 ARRAY_APPEND( p_playlist->current, p_next);
319 PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
320 p_playlist->i_current_index);
323 /* Shuffle the array */
324 srand( (unsigned int)mdate() );
326 for( j = p_playlist->current.i_size - 1; j > 0; j-- )
328 int i = rand() % (j+1); /* between 0 and j */
329 playlist_item_t *p_tmp;
330 /* swap the two items */
331 p_tmp = ARRAY_VAL(p_playlist->current, i);
332 ARRAY_VAL(p_playlist->current,i) = ARRAY_VAL(p_playlist->current,j);
333 ARRAY_VAL(p_playlist->current,j) = p_tmp;
336 p_playlist->b_reset_currently_playing = false;
337 stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_BUILD );
341 * Compute the next playlist item depending on
342 * the playlist course mode (forward, backward, random, view,...).
344 * \param p_playlist the playlist object
347 playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
349 playlist_item_t *p_new = NULL;
352 bool b_loop = var_GetBool( p_playlist, "loop" );
353 bool b_random = var_GetBool( p_playlist, "random" );
354 bool b_repeat = var_GetBool( p_playlist, "repeat" );
355 bool b_playstop = var_GetBool( p_playlist, "play-and-stop" );
357 /* Handle quickly a few special cases */
358 /* No items to play */
359 if( p_playlist->items.i_size == 0 )
361 msg_Info( p_playlist, "playlist is empty" );
365 /* Repeat and play/stop */
366 if( !p_playlist->request.b_request && b_repeat == true &&
367 get_current_status_item( p_playlist ) )
369 msg_Dbg( p_playlist,"repeating item" );
370 return get_current_status_item( p_playlist );
372 if( !p_playlist->request.b_request && b_playstop == true )
374 msg_Dbg( p_playlist,"stopping (play and stop)" );
378 if( !p_playlist->request.b_request &&
379 get_current_status_item( p_playlist ) )
381 playlist_item_t *p_parent = get_current_status_item( p_playlist );
384 if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
386 msg_Dbg( p_playlist, "blocking item, stopping") ;
389 p_parent = p_parent->p_parent;
393 /* Start the real work */
394 if( p_playlist->request.b_request )
396 p_new = p_playlist->request.p_item;
397 i_skip = p_playlist->request.i_skip;
398 PL_DEBUG( "processing request item %s node %s skip %i",
399 PLI_NAME( p_playlist->request.p_item ),
400 PLI_NAME( p_playlist->request.p_node ), i_skip );
402 if( p_playlist->request.p_node &&
403 p_playlist->request.p_node != get_current_status_node( p_playlist ) )
406 set_current_status_node( p_playlist, p_playlist->request.p_node );
407 p_playlist->request.p_node = NULL;
408 p_playlist->b_reset_currently_playing = true;
411 /* If we are asked for a node, don't take it */
412 if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
415 if( p_playlist->b_reset_currently_playing )
416 /* A bit too bad to reset twice ... */
417 ResetCurrentlyPlaying( p_playlist, b_random, p_new );
419 ResyncCurrentIndex( p_playlist, p_new );
421 p_playlist->i_current_index = -1;
423 if( p_playlist->current.i_size && (i_skip > 0) )
425 if( p_playlist->i_current_index < -1 )
426 p_playlist->i_current_index = -1;
427 for( i = i_skip; i > 0 ; i-- )
429 p_playlist->i_current_index++;
430 if( p_playlist->i_current_index >= p_playlist->current.i_size )
432 PL_DEBUG( "looping - restarting at beginning of node" );
433 p_playlist->i_current_index = 0;
436 p_new = ARRAY_VAL( p_playlist->current,
437 p_playlist->i_current_index );
439 else if( p_playlist->current.i_size && (i_skip < 0) )
441 for( i = i_skip; i < 0 ; i++ )
443 p_playlist->i_current_index--;
444 if( p_playlist->i_current_index <= -1 )
446 PL_DEBUG( "looping - restarting at end of node" );
447 p_playlist->i_current_index = p_playlist->current.i_size-1;
450 p_new = ARRAY_VAL( p_playlist->current,
451 p_playlist->i_current_index );
453 /* Clear the request */
454 p_playlist->request.b_request = false;
456 /* "Automatic" item change ( next ) */
459 PL_DEBUG( "changing item without a request (current %i/%i)",
460 p_playlist->i_current_index, p_playlist->current.i_size );
461 /* Cant go to next from current item */
462 if( get_current_status_item( p_playlist ) &&
463 get_current_status_item( p_playlist )->i_flags & PLAYLIST_SKIP_FLAG )
466 if( p_playlist->b_reset_currently_playing )
467 ResetCurrentlyPlaying( p_playlist, b_random,
468 get_current_status_item( p_playlist ) );
470 p_playlist->i_current_index++;
471 assert( p_playlist->i_current_index <= p_playlist->current.i_size );
472 if( p_playlist->i_current_index == p_playlist->current.i_size )
474 if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
475 p_playlist->i_current_index = 0;
477 PL_DEBUG( "using item %i", p_playlist->i_current_index );
478 if ( p_playlist->current.i_size == 0 ) return NULL;
480 p_new = ARRAY_VAL( p_playlist->current, p_playlist->i_current_index );
481 /* The new item can't be autoselected */
482 if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
489 * Start the input for an item
491 * \param p_playlist the playlist objetc
492 * \param p_item the item to play
495 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
497 input_item_t *p_input = p_item->p_input;
498 sout_instance_t **pp_sout = &libvlc_priv(p_playlist->p_libvlc)->p_sout;
499 int i_activity = var_GetInteger( p_playlist, "activity" ) ;
501 msg_Dbg( p_playlist, "creating new input thread" );
503 p_input->i_nb_played++;
504 set_current_status_item( p_playlist, p_item );
506 p_playlist->status.i_status = PLAYLIST_RUNNING;
508 var_SetInteger( p_playlist, "activity", i_activity +
509 DEFAULT_INPUT_ACTIVITY );
511 input_thread_t * p_input_thread =
512 input_CreateThreadExtended( p_playlist, p_input, NULL, *pp_sout );
513 playlist_set_current_input( p_playlist, p_input_thread );
514 vlc_object_release( p_input_thread );
518 char *psz_uri = input_item_GetURI( p_item->p_input );
519 if( psz_uri && ( !strncmp( psz_uri, "directory:", 10 ) ||
520 !strncmp( psz_uri, "vlc:", 4 ) ) )
527 if( p_playlist->p_fetcher &&
528 p_playlist->p_fetcher->i_art_policy == ALBUM_ART_WHEN_PLAYED )
532 char *psz_arturl, *psz_name;
533 psz_arturl = input_item_GetArtURL( p_input );
534 psz_name = input_item_GetName( p_input );
536 /* p_input->p_meta should not be null after a successfull CreateThread */
537 b_has_art = !EMPTY_STR( psz_arturl );
539 if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
541 PL_DEBUG( "requesting art for %s", psz_name );
542 playlist_AskForArtEnqueue( p_playlist, p_input );
549 var_SetInteger( p_playlist, "playlist-current", p_input->i_id );