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( VLC_OBJECT(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( VLC_OBJECT(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;
91 if( !vlc_object_alive( p_playlist ) )
94 if( playlist_IsEmpty( p_playlist ) )
100 p_playlist->request.i_status = PLAYLIST_STOPPED;
101 p_playlist->request.b_request = true;
102 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 p_playlist->request.i_status = PLAYLIST_RUNNING;
116 p_playlist->request.i_skip = 0;
117 p_playlist->request.b_request = true;
118 p_playlist->request.p_node = p_node;
119 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( p_playlist->p_input )
127 val.i_int = PLAYING_S;
128 var_Set( p_playlist->p_input, "state", val );
133 p_playlist->request.i_status = PLAYLIST_RUNNING;
134 p_playlist->request.b_request = true;
135 p_playlist->request.p_node = get_current_status_node( p_playlist );
136 p_playlist->request.p_item = get_current_status_item( p_playlist );
137 p_playlist->request.i_skip = 0;
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 = get_current_status_node( p_playlist );
168 p_playlist->request.p_item = get_current_status_item( p_playlist );
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 = true;
177 msg_Err( p_playlist, "unknown playlist query" );
181 vlc_object_signal_unlocked( p_playlist );
186 /*****************************************************************************
188 *****************************************************************************/
189 /** Enqueue an item for preparsing */
190 int playlist_PreparseEnqueue( playlist_t *p_playlist,
191 input_item_t *p_item )
193 vlc_object_lock( p_playlist->p->p_preparse );
194 if( !vlc_object_alive( p_playlist->p->p_preparse ) )
196 vlc_object_unlock( p_playlist->p->p_preparse );
199 vlc_gc_incref( p_item );
200 INSERT_ELEM( p_playlist->p->p_preparse->pp_waiting,
201 p_playlist->p->p_preparse->i_waiting,
202 p_playlist->p->p_preparse->i_waiting,
204 vlc_object_signal_unlocked( p_playlist->p->p_preparse );
205 vlc_object_unlock( p_playlist->p->p_preparse );
209 /** Enqueue a playlist item or a node for peparsing.
210 * This function should be entered without playlist and preparser locks */
211 int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
212 playlist_item_t *p_item )
214 vlc_object_lock( p_playlist );
215 vlc_object_lock( p_playlist->p->p_preparse );
216 if( !vlc_object_alive( p_playlist->p->p_preparse ) )
218 vlc_object_unlock( p_playlist->p->p_preparse );
219 vlc_object_unlock( p_playlist );
222 PreparseEnqueueItemSub( p_playlist, p_item );
223 vlc_object_unlock( p_playlist->p->p_preparse );
224 vlc_object_unlock( p_playlist );
228 int playlist_AskForArtEnqueue( playlist_t *p_playlist,
229 input_item_t *p_item )
231 vlc_object_lock( p_playlist->p->p_fetcher );
232 if( !vlc_object_alive( p_playlist->p->p_fetcher ) )
234 vlc_object_unlock( p_playlist->p->p_fetcher );
238 vlc_gc_incref( p_item );
239 INSERT_ELEM( p_playlist->p->p_fetcher->pp_waiting,
240 p_playlist->p->p_fetcher->i_waiting,
241 p_playlist->p->p_fetcher->i_waiting, p_item );
242 vlc_object_signal_unlocked( p_playlist->p->p_fetcher );
243 vlc_object_unlock( p_playlist->p->p_fetcher );
247 static void PreparseEnqueueItemSub( playlist_t *p_playlist,
248 playlist_item_t *p_item )
251 if( p_item->i_children == -1 )
253 vlc_gc_incref( p_item->p_input );
254 INSERT_ELEM( p_playlist->p->p_preparse->pp_waiting,
255 p_playlist->p->p_preparse->i_waiting,
256 p_playlist->p->p_preparse->i_waiting,
261 for( i = 0; i < p_item->i_children; i++)
263 PreparseEnqueueItemSub( p_playlist, p_item->pp_children[i] );
268 /*****************************************************************************
270 *****************************************************************************/
273 * Synchronise the current index of the playlist
274 * to match the index of the current item.
276 * \param p_playlist the playlist structure
277 * \param p_cur the current playlist item
280 static void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur )
282 PL_DEBUG( "resyncing on %s", PLI_NAME( p_cur ) );
283 /* Simply resync index */
285 p_playlist->i_current_index = -1;
286 for( i = 0 ; i< p_playlist->current.i_size; i++ )
288 if( ARRAY_VAL( p_playlist->current, i ) == p_cur )
290 p_playlist->i_current_index = i;
294 PL_DEBUG( "%s is at %i", PLI_NAME( p_cur ), p_playlist->i_current_index );
297 void ResetCurrentlyPlaying( playlist_t *p_playlist, bool b_random,
298 playlist_item_t *p_cur )
300 playlist_item_t *p_next = NULL;
301 stats_TimerStart( p_playlist, "Items array build",
302 STATS_TIMER_PLAYLIST_BUILD );
303 PL_DEBUG( "rebuilding array of current - root %s",
304 PLI_NAME( p_playlist->status.p_node ) );
305 ARRAY_RESET( p_playlist->current );
306 p_playlist->i_current_index = -1;
309 /** FIXME: this is *slow* */
310 p_next = playlist_GetNextLeaf( p_playlist,
311 p_playlist->status.p_node,
312 p_next, true, false );
315 if( p_next == p_cur )
316 p_playlist->i_current_index = p_playlist->current.i_size;
317 ARRAY_APPEND( p_playlist->current, p_next);
321 PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
322 p_playlist->i_current_index);
325 /* Shuffle the array */
326 srand( (unsigned int)mdate() );
328 for( j = p_playlist->current.i_size - 1; j > 0; j-- )
330 int i = rand() % (j+1); /* between 0 and j */
331 playlist_item_t *p_tmp;
332 /* swap the two items */
333 p_tmp = ARRAY_VAL(p_playlist->current, i);
334 ARRAY_VAL(p_playlist->current,i) = ARRAY_VAL(p_playlist->current,j);
335 ARRAY_VAL(p_playlist->current,j) = p_tmp;
338 p_playlist->b_reset_currently_playing = false;
339 stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_BUILD );
343 * Compute the next playlist item depending on
344 * the playlist course mode (forward, backward, random, view,...).
346 * \param p_playlist the playlist object
349 playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
351 playlist_item_t *p_new = NULL;
354 bool b_loop = var_GetBool( p_playlist, "loop" );
355 bool b_random = var_GetBool( p_playlist, "random" );
356 bool b_repeat = var_GetBool( p_playlist, "repeat" );
357 bool b_playstop = var_GetBool( p_playlist, "play-and-stop" );
359 /* Handle quickly a few special cases */
360 /* No items to play */
361 if( p_playlist->items.i_size == 0 )
363 msg_Info( p_playlist, "playlist is empty" );
367 /* Repeat and play/stop */
368 if( !p_playlist->request.b_request && b_repeat == true &&
369 get_current_status_item( p_playlist ) )
371 msg_Dbg( p_playlist,"repeating item" );
372 return get_current_status_item( p_playlist );
374 if( !p_playlist->request.b_request && b_playstop == true )
376 msg_Dbg( p_playlist,"stopping (play and stop)" );
380 if( !p_playlist->request.b_request &&
381 get_current_status_item( p_playlist ) )
383 playlist_item_t *p_parent = get_current_status_item( p_playlist );
386 if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
388 msg_Dbg( p_playlist, "blocking item, stopping") ;
391 p_parent = p_parent->p_parent;
395 /* Start the real work */
396 if( p_playlist->request.b_request )
398 p_new = p_playlist->request.p_item;
399 i_skip = p_playlist->request.i_skip;
400 PL_DEBUG( "processing request item %s node %s skip %i",
401 PLI_NAME( p_playlist->request.p_item ),
402 PLI_NAME( p_playlist->request.p_node ), i_skip );
404 if( p_playlist->request.p_node &&
405 p_playlist->request.p_node != get_current_status_node( p_playlist ) )
408 set_current_status_node( p_playlist, p_playlist->request.p_node );
409 p_playlist->request.p_node = NULL;
410 p_playlist->b_reset_currently_playing = true;
413 /* If we are asked for a node, go to it's first child */
414 if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
419 p_new = playlist_GetNextLeaf( p_playlist, p_new, NULL, true, false );
420 for( i = 0; i < p_playlist->current.i_size; i++ )
422 if( p_new == ARRAY_VAL( p_playlist->current, i ) )
424 p_playlist->i_current_index = i;
431 if( p_playlist->b_reset_currently_playing )
432 /* A bit too bad to reset twice ... */
433 ResetCurrentlyPlaying( p_playlist, b_random, p_new );
435 ResyncCurrentIndex( p_playlist, p_new );
437 p_playlist->i_current_index = -1;
439 if( p_playlist->current.i_size && (i_skip > 0) )
441 if( p_playlist->i_current_index < -1 )
442 p_playlist->i_current_index = -1;
443 for( i = i_skip; i > 0 ; i-- )
445 p_playlist->i_current_index++;
446 if( p_playlist->i_current_index >= p_playlist->current.i_size )
448 PL_DEBUG( "looping - restarting at beginning of node" );
449 p_playlist->i_current_index = 0;
452 p_new = ARRAY_VAL( p_playlist->current,
453 p_playlist->i_current_index );
455 else if( p_playlist->current.i_size && (i_skip < 0) )
457 for( i = i_skip; i < 0 ; i++ )
459 p_playlist->i_current_index--;
460 if( p_playlist->i_current_index <= -1 )
462 PL_DEBUG( "looping - restarting at end of node" );
463 p_playlist->i_current_index = p_playlist->current.i_size-1;
466 p_new = ARRAY_VAL( p_playlist->current,
467 p_playlist->i_current_index );
469 /* Clear the request */
470 p_playlist->request.b_request = false;
472 /* "Automatic" item change ( next ) */
475 PL_DEBUG( "changing item without a request (current %i/%i)",
476 p_playlist->i_current_index, p_playlist->current.i_size );
477 /* Cant go to next from current item */
478 if( get_current_status_item( p_playlist ) &&
479 get_current_status_item( p_playlist )->i_flags & PLAYLIST_SKIP_FLAG )
482 if( p_playlist->b_reset_currently_playing )
483 ResetCurrentlyPlaying( p_playlist, b_random,
484 get_current_status_item( p_playlist ) );
486 p_playlist->i_current_index++;
487 assert( p_playlist->i_current_index <= p_playlist->current.i_size );
488 if( p_playlist->i_current_index == p_playlist->current.i_size )
490 if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
491 p_playlist->i_current_index = 0;
493 PL_DEBUG( "using item %i", p_playlist->i_current_index );
494 if ( p_playlist->current.i_size == 0 ) return NULL;
496 p_new = ARRAY_VAL( p_playlist->current, p_playlist->i_current_index );
497 /* The new item can't be autoselected */
498 if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
505 * Start the input for an item
507 * \param p_playlist the playlist objetc
508 * \param p_item the item to play
511 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
513 input_item_t *p_input = p_item->p_input;
514 sout_instance_t **pp_sout = &libvlc_priv(p_playlist->p_libvlc)->p_sout;
515 int i_activity = var_GetInteger( p_playlist, "activity" ) ;
517 msg_Dbg( p_playlist, "creating new input thread" );
519 p_input->i_nb_played++;
520 set_current_status_item( p_playlist, p_item );
522 p_playlist->status.i_status = PLAYLIST_RUNNING;
524 var_SetInteger( p_playlist, "activity", i_activity +
525 DEFAULT_INPUT_ACTIVITY );
527 input_thread_t * p_input_thread =
528 input_CreateThreadExtended( p_playlist, p_input, NULL, *pp_sout );
529 playlist_set_current_input( p_playlist, p_input_thread );
530 vlc_object_release( p_input_thread );
534 char *psz_uri = input_item_GetURI( p_item->p_input );
535 if( psz_uri && ( !strncmp( psz_uri, "directory:", 10 ) ||
536 !strncmp( psz_uri, "vlc:", 4 ) ) )
543 if( p_playlist->p->p_fetcher &&
544 p_playlist->p->p_fetcher->i_art_policy == ALBUM_ART_WHEN_PLAYED )
548 char *psz_arturl, *psz_name;
549 psz_arturl = input_item_GetArtURL( p_input );
550 psz_name = input_item_GetName( p_input );
552 /* p_input->p_meta should not be null after a successfull CreateThread */
553 b_has_art = !EMPTY_STR( psz_arturl );
555 if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
557 PL_DEBUG( "requesting art for %s", psz_name );
558 playlist_AskForArtEnqueue( p_playlist, p_input );
565 var_SetInteger( p_playlist, "playlist-current", p_input->i_id );