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_Hold( vlc_object_t *p_this )
49 pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
51 assert( VLC_OBJECT(pl) != p_this /* This does not make sense to hold the playlist
52 using pl_Hold. use vlc_object_hold in this case */ );
59 void __pl_Release( vlc_object_t *p_this )
61 playlist_t *pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
64 assert( VLC_OBJECT(pl) != p_this /* The rule is that pl_Release() should act on
65 the same object than pl_Hold() */ );
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;
91 if( !vlc_object_alive( p_playlist ) )
94 if( playlist_IsEmpty( p_playlist ) )
100 pl_priv(p_playlist)->request.i_status = PLAYLIST_STOPPED;
101 pl_priv(p_playlist)->request.b_request = true;
102 pl_priv(p_playlist)->request.p_item = NULL;
105 // Node can be null, it will keep the same. Use with care ...
106 // Item null = take the first child of node
107 case PLAYLIST_VIEWPLAY:
108 p_node = (playlist_item_t *)va_arg( args, playlist_item_t * );
109 p_item = (playlist_item_t *)va_arg( args, playlist_item_t * );
110 if ( p_node == NULL )
112 p_node = get_current_status_node( p_playlist );
115 pl_priv(p_playlist)->request.i_status = PLAYLIST_RUNNING;
116 pl_priv(p_playlist)->request.i_skip = 0;
117 pl_priv(p_playlist)->request.b_request = true;
118 pl_priv(p_playlist)->request.p_node = p_node;
119 pl_priv(p_playlist)->request.p_item = p_item;
120 if( p_item && var_GetBool( p_playlist, "random" ) )
121 p_playlist->b_reset_currently_playing = true;
125 if( pl_priv(p_playlist)->p_input )
127 val.i_int = PLAYING_S;
128 var_Set( pl_priv(p_playlist)->p_input, "state", val );
133 pl_priv(p_playlist)->request.i_status = PLAYLIST_RUNNING;
134 pl_priv(p_playlist)->request.b_request = true;
135 pl_priv(p_playlist)->request.p_node = get_current_status_node( p_playlist );
136 pl_priv(p_playlist)->request.p_item = get_current_status_item( p_playlist );
137 pl_priv(p_playlist)->request.i_skip = 0;
143 if( pl_priv(p_playlist)->p_input )
144 var_Get( pl_priv(p_playlist)->p_input, "state", &val );
146 if( val.i_int == PAUSE_S )
148 pl_priv(p_playlist)->status.i_status = PLAYLIST_RUNNING;
149 if( pl_priv(p_playlist)->p_input )
151 val.i_int = PLAYING_S;
152 var_Set( pl_priv(p_playlist)->p_input, "state", val );
157 pl_priv(p_playlist)->status.i_status = PLAYLIST_PAUSED;
158 if( pl_priv(p_playlist)->p_input )
161 var_Set( pl_priv(p_playlist)->p_input, "state", val );
167 pl_priv(p_playlist)->request.p_node = get_current_status_node( p_playlist );
168 pl_priv(p_playlist)->request.p_item = get_current_status_item( p_playlist );
169 pl_priv(p_playlist)->request.i_skip = (int) va_arg( args, int );
170 /* if already running, keep running */
171 if( pl_priv(p_playlist)->status.i_status != PLAYLIST_STOPPED )
172 pl_priv(p_playlist)->request.i_status = pl_priv(p_playlist)->status.i_status;
173 pl_priv(p_playlist)->request.b_request = true;
177 msg_Err( p_playlist, "unknown playlist query" );
180 vlc_object_signal_unlocked( p_playlist );
185 /*****************************************************************************
187 *****************************************************************************/
188 /** Enqueue an item for preparsing */
189 int playlist_PreparseEnqueue( playlist_t *p_playlist,
190 input_item_t *p_item )
192 playlist_preparse_t *p_preparse = &pl_priv(p_playlist)->preparse;
194 vlc_gc_incref( p_item );
196 vlc_mutex_lock( &p_preparse->lock );
197 INSERT_ELEM( p_preparse->pp_waiting, p_preparse->i_waiting,
198 p_preparse->i_waiting, p_item );
199 vlc_cond_signal( &p_preparse->wait );
200 vlc_mutex_unlock( &p_preparse->lock );
204 /** Enqueue a playlist item or a node for preparsing.
205 * This function shall be called without playlist and preparser locks */
206 int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
207 playlist_item_t *p_item )
209 playlist_preparse_t *p_preparse = &pl_priv(p_playlist)->preparse;
211 vlc_object_lock( p_playlist );
212 vlc_mutex_lock( &p_preparse->lock );
213 PreparseEnqueueItemSub( p_playlist, p_item );
214 vlc_mutex_unlock( &p_preparse->lock );
215 vlc_object_unlock( p_playlist );
219 int playlist_AskForArtEnqueue( playlist_t *p_playlist,
220 input_item_t *p_item )
222 playlist_fetcher_t *p_fetcher = &pl_priv(p_playlist)->fetcher;
224 vlc_gc_incref( p_item );
226 vlc_mutex_lock( &p_fetcher->lock );
227 INSERT_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting,
228 p_fetcher->i_waiting, p_item );
229 vlc_cond_signal( &p_fetcher->wait );
230 vlc_mutex_unlock( &p_fetcher->lock );
234 static void PreparseEnqueueItemSub( playlist_t *p_playlist,
235 playlist_item_t *p_item )
237 playlist_preparse_t *p_preparse = &pl_priv(p_playlist)->preparse;
239 if( p_item->i_children == -1 )
242 vlc_gc_incref( p_item->p_input );
243 INSERT_ELEM( p_preparse->pp_waiting,
244 p_preparse->i_waiting,
245 p_preparse->i_waiting,
250 /* Non-leaf item: recurse */
251 for( int i = 0; i < p_item->i_children; i++)
253 PreparseEnqueueItemSub( p_playlist, p_item->pp_children[i] );
258 /*****************************************************************************
260 *****************************************************************************/
263 * Synchronise the current index of the playlist
264 * to match the index of the current item.
266 * \param p_playlist the playlist structure
267 * \param p_cur the current playlist item
270 static void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur )
272 PL_DEBUG( "resyncing on %s", PLI_NAME( p_cur ) );
273 /* Simply resync index */
275 p_playlist->i_current_index = -1;
276 for( i = 0 ; i< p_playlist->current.i_size; i++ )
278 if( ARRAY_VAL( p_playlist->current, i ) == p_cur )
280 p_playlist->i_current_index = i;
284 PL_DEBUG( "%s is at %i", PLI_NAME( p_cur ), p_playlist->i_current_index );
287 void ResetCurrentlyPlaying( playlist_t *p_playlist, bool b_random,
288 playlist_item_t *p_cur )
290 playlist_item_t *p_next = NULL;
291 stats_TimerStart( p_playlist, "Items array build",
292 STATS_TIMER_PLAYLIST_BUILD );
293 PL_DEBUG( "rebuilding array of current - root %s",
294 PLI_NAME( pl_priv(p_playlist)->status.p_node ) );
295 ARRAY_RESET( p_playlist->current );
296 p_playlist->i_current_index = -1;
299 /** FIXME: this is *slow* */
300 p_next = playlist_GetNextLeaf( p_playlist,
301 pl_priv(p_playlist)->status.p_node,
302 p_next, true, false );
305 if( p_next == p_cur )
306 p_playlist->i_current_index = p_playlist->current.i_size;
307 ARRAY_APPEND( p_playlist->current, p_next);
311 PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
312 p_playlist->i_current_index);
315 /* Shuffle the array */
316 srand( (unsigned int)mdate() );
318 for( j = p_playlist->current.i_size - 1; j > 0; j-- )
320 int i = rand() % (j+1); /* between 0 and j */
321 playlist_item_t *p_tmp;
322 /* swap the two items */
323 p_tmp = ARRAY_VAL(p_playlist->current, i);
324 ARRAY_VAL(p_playlist->current,i) = ARRAY_VAL(p_playlist->current,j);
325 ARRAY_VAL(p_playlist->current,j) = p_tmp;
328 p_playlist->b_reset_currently_playing = false;
329 stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_BUILD );
333 * Compute the next playlist item depending on
334 * the playlist course mode (forward, backward, random, view,...).
336 * \param p_playlist the playlist object
339 playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
341 playlist_item_t *p_new = NULL;
344 bool b_loop = var_GetBool( p_playlist, "loop" );
345 bool b_random = var_GetBool( p_playlist, "random" );
346 bool b_repeat = var_GetBool( p_playlist, "repeat" );
347 bool b_playstop = var_GetBool( p_playlist, "play-and-stop" );
349 /* Handle quickly a few special cases */
350 /* No items to play */
351 if( p_playlist->items.i_size == 0 )
353 msg_Info( p_playlist, "playlist is empty" );
357 /* Repeat and play/stop */
358 if( !pl_priv(p_playlist)->request.b_request && b_repeat == true &&
359 get_current_status_item( p_playlist ) )
361 msg_Dbg( p_playlist,"repeating item" );
362 return get_current_status_item( p_playlist );
364 if( !pl_priv(p_playlist)->request.b_request && b_playstop == true )
366 msg_Dbg( p_playlist,"stopping (play and stop)" );
370 if( !pl_priv(p_playlist)->request.b_request &&
371 get_current_status_item( p_playlist ) )
373 playlist_item_t *p_parent = get_current_status_item( p_playlist );
376 if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
378 msg_Dbg( p_playlist, "blocking item, stopping") ;
381 p_parent = p_parent->p_parent;
385 /* Start the real work */
386 if( pl_priv(p_playlist)->request.b_request )
388 p_new = pl_priv(p_playlist)->request.p_item;
389 i_skip = pl_priv(p_playlist)->request.i_skip;
390 PL_DEBUG( "processing request item %s node %s skip %i",
391 PLI_NAME( pl_priv(p_playlist)->request.p_item ),
392 PLI_NAME( pl_priv(p_playlist)->request.p_node ), i_skip );
394 if( pl_priv(p_playlist)->request.p_node &&
395 pl_priv(p_playlist)->request.p_node != get_current_status_node( p_playlist ) )
398 set_current_status_node( p_playlist, pl_priv(p_playlist)->request.p_node );
399 pl_priv(p_playlist)->request.p_node = NULL;
400 p_playlist->b_reset_currently_playing = true;
403 /* If we are asked for a node, go to it's first child */
404 if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
409 p_new = playlist_GetNextLeaf( p_playlist, p_new, NULL, true, false );
410 for( i = 0; i < p_playlist->current.i_size; i++ )
412 if( p_new == ARRAY_VAL( p_playlist->current, i ) )
414 p_playlist->i_current_index = i;
421 if( p_playlist->b_reset_currently_playing )
422 /* A bit too bad to reset twice ... */
423 ResetCurrentlyPlaying( p_playlist, b_random, p_new );
425 ResyncCurrentIndex( p_playlist, p_new );
427 p_playlist->i_current_index = -1;
429 if( p_playlist->current.i_size && (i_skip > 0) )
431 if( p_playlist->i_current_index < -1 )
432 p_playlist->i_current_index = -1;
433 for( i = i_skip; i > 0 ; i-- )
435 p_playlist->i_current_index++;
436 if( p_playlist->i_current_index >= p_playlist->current.i_size )
438 PL_DEBUG( "looping - restarting at beginning of node" );
439 p_playlist->i_current_index = 0;
442 p_new = ARRAY_VAL( p_playlist->current,
443 p_playlist->i_current_index );
445 else if( p_playlist->current.i_size && (i_skip < 0) )
447 for( i = i_skip; i < 0 ; i++ )
449 p_playlist->i_current_index--;
450 if( p_playlist->i_current_index <= -1 )
452 PL_DEBUG( "looping - restarting at end of node" );
453 p_playlist->i_current_index = p_playlist->current.i_size-1;
456 p_new = ARRAY_VAL( p_playlist->current,
457 p_playlist->i_current_index );
459 /* Clear the request */
460 pl_priv(p_playlist)->request.b_request = false;
462 /* "Automatic" item change ( next ) */
465 PL_DEBUG( "changing item without a request (current %i/%i)",
466 p_playlist->i_current_index, p_playlist->current.i_size );
467 /* Cant go to next from current item */
468 if( get_current_status_item( p_playlist ) &&
469 get_current_status_item( p_playlist )->i_flags & PLAYLIST_SKIP_FLAG )
472 if( p_playlist->b_reset_currently_playing )
473 ResetCurrentlyPlaying( p_playlist, b_random,
474 get_current_status_item( p_playlist ) );
476 p_playlist->i_current_index++;
477 assert( p_playlist->i_current_index <= p_playlist->current.i_size );
478 if( p_playlist->i_current_index == p_playlist->current.i_size )
480 if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
481 p_playlist->i_current_index = 0;
483 PL_DEBUG( "using item %i", p_playlist->i_current_index );
484 if ( p_playlist->current.i_size == 0 ) return NULL;
486 p_new = ARRAY_VAL( p_playlist->current, p_playlist->i_current_index );
487 /* The new item can't be autoselected */
488 if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
495 * Start the input for an item
497 * \param p_playlist the playlist object
498 * \param p_item the item to play
501 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
503 input_item_t *p_input = p_item->p_input;
504 sout_instance_t **pp_sout = &pl_priv(p_playlist)->p_sout;
505 int i_activity = var_GetInteger( p_playlist, "activity" ) ;
507 msg_Dbg( p_playlist, "creating new input thread" );
509 p_input->i_nb_played++;
510 set_current_status_item( p_playlist, p_item );
512 pl_priv(p_playlist)->status.i_status = PLAYLIST_RUNNING;
514 var_SetInteger( p_playlist, "activity", i_activity +
515 DEFAULT_INPUT_ACTIVITY );
517 input_thread_t * p_input_thread =
518 input_CreateThreadExtended( p_playlist, p_input, NULL, *pp_sout );
519 playlist_set_current_input( p_playlist, p_input_thread );
520 vlc_object_release( p_input_thread );
524 char *psz_uri = input_item_GetURI( p_item->p_input );
525 if( psz_uri && ( !strncmp( psz_uri, "directory:", 10 ) ||
526 !strncmp( psz_uri, "vlc:", 4 ) ) )
533 if( pl_priv(p_playlist)->fetcher.i_art_policy == ALBUM_ART_WHEN_PLAYED )
537 char *psz_arturl, *psz_name;
538 psz_arturl = input_item_GetArtURL( p_input );
539 psz_name = input_item_GetName( p_input );
541 /* p_input->p_meta should not be null after a successfull CreateThread */
542 b_has_art = !EMPTY_STR( psz_arturl );
544 if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
546 PL_DEBUG( "requesting art for %s", psz_name );
547 playlist_AskForArtEnqueue( p_playlist, p_input );
554 var_SetInteger( p_playlist, "playlist-current", p_input->i_id );