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 void playlist_Signal( playlist_t *p_playlist )
72 /* TODO: assert playlist lock? */
73 vlc_object_signal( p_playlist );
76 int playlist_Control( playlist_t * p_playlist, int i_query,
81 va_start( args, b_locked );
82 PL_LOCK_IF( !b_locked );
83 i_result = PlaylistVAControl( p_playlist, i_query, args );
85 PL_UNLOCK_IF( !b_locked );
90 static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args )
92 playlist_item_t *p_item, *p_node;
97 if( !vlc_object_alive( p_playlist ) )
100 if( playlist_IsEmpty( p_playlist ) )
106 pl_priv(p_playlist)->request.i_status = PLAYLIST_STOPPED;
107 pl_priv(p_playlist)->request.b_request = true;
108 pl_priv(p_playlist)->request.p_item = NULL;
111 // Node can be null, it will keep the same. Use with care ...
112 // Item null = take the first child of node
113 case PLAYLIST_VIEWPLAY:
114 p_node = (playlist_item_t *)va_arg( args, playlist_item_t * );
115 p_item = (playlist_item_t *)va_arg( args, playlist_item_t * );
116 if ( p_node == NULL )
118 p_node = get_current_status_node( p_playlist );
121 pl_priv(p_playlist)->request.i_status = PLAYLIST_RUNNING;
122 pl_priv(p_playlist)->request.i_skip = 0;
123 pl_priv(p_playlist)->request.b_request = true;
124 pl_priv(p_playlist)->request.p_node = p_node;
125 pl_priv(p_playlist)->request.p_item = p_item;
126 if( p_item && var_GetBool( p_playlist, "random" ) )
127 pl_priv(p_playlist)->b_reset_currently_playing = true;
131 if( pl_priv(p_playlist)->p_input )
133 val.i_int = PLAYING_S;
134 var_Set( pl_priv(p_playlist)->p_input, "state", val );
139 pl_priv(p_playlist)->request.i_status = PLAYLIST_RUNNING;
140 pl_priv(p_playlist)->request.b_request = true;
141 pl_priv(p_playlist)->request.p_node = get_current_status_node( p_playlist );
142 pl_priv(p_playlist)->request.p_item = get_current_status_item( p_playlist );
143 pl_priv(p_playlist)->request.i_skip = 0;
149 if( pl_priv(p_playlist)->p_input )
150 var_Get( pl_priv(p_playlist)->p_input, "state", &val );
152 if( val.i_int == PAUSE_S )
154 pl_priv(p_playlist)->status.i_status = PLAYLIST_RUNNING;
155 if( pl_priv(p_playlist)->p_input )
157 val.i_int = PLAYING_S;
158 var_Set( pl_priv(p_playlist)->p_input, "state", val );
163 pl_priv(p_playlist)->status.i_status = PLAYLIST_PAUSED;
164 if( pl_priv(p_playlist)->p_input )
167 var_Set( pl_priv(p_playlist)->p_input, "state", val );
173 pl_priv(p_playlist)->request.p_node = get_current_status_node( p_playlist );
174 pl_priv(p_playlist)->request.p_item = get_current_status_item( p_playlist );
175 pl_priv(p_playlist)->request.i_skip = (int) va_arg( args, int );
176 /* if already running, keep running */
177 if( pl_priv(p_playlist)->status.i_status != PLAYLIST_STOPPED )
178 pl_priv(p_playlist)->request.i_status = pl_priv(p_playlist)->status.i_status;
179 pl_priv(p_playlist)->request.b_request = true;
183 msg_Err( p_playlist, "unknown playlist query" );
186 vlc_object_signal_unlocked( p_playlist );
191 /*****************************************************************************
193 *****************************************************************************/
194 /** Enqueue an item for preparsing */
195 int playlist_PreparseEnqueue( playlist_t *p_playlist,
196 input_item_t *p_item )
198 playlist_preparse_t *p_preparse = &pl_priv(p_playlist)->preparse;
200 vlc_gc_incref( p_item );
202 vlc_mutex_lock( &p_preparse->lock );
203 INSERT_ELEM( p_preparse->pp_waiting, p_preparse->i_waiting,
204 p_preparse->i_waiting, p_item );
205 vlc_cond_signal( &p_preparse->wait );
206 vlc_mutex_unlock( &p_preparse->lock );
210 /** Enqueue a playlist item or a node for preparsing.
211 * This function shall be called without playlist and preparser locks */
212 int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
213 playlist_item_t *p_item )
215 playlist_preparse_t *p_preparse = &pl_priv(p_playlist)->preparse;
217 vlc_object_lock( p_playlist );
218 vlc_mutex_lock( &p_preparse->lock );
219 PreparseEnqueueItemSub( p_playlist, p_item );
220 vlc_mutex_unlock( &p_preparse->lock );
221 vlc_object_unlock( p_playlist );
225 int playlist_AskForArtEnqueue( playlist_t *p_playlist,
226 input_item_t *p_item )
228 playlist_fetcher_t *p_fetcher = &pl_priv(p_playlist)->fetcher;
230 vlc_gc_incref( p_item );
232 vlc_mutex_lock( &p_fetcher->lock );
233 INSERT_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting,
234 p_fetcher->i_waiting, p_item );
235 vlc_cond_signal( &p_fetcher->wait );
236 vlc_mutex_unlock( &p_fetcher->lock );
240 static void PreparseEnqueueItemSub( playlist_t *p_playlist,
241 playlist_item_t *p_item )
243 playlist_preparse_t *p_preparse = &pl_priv(p_playlist)->preparse;
245 if( p_item->i_children == -1 )
248 vlc_gc_incref( p_item->p_input );
249 INSERT_ELEM( p_preparse->pp_waiting,
250 p_preparse->i_waiting,
251 p_preparse->i_waiting,
256 /* Non-leaf item: recurse */
257 for( int i = 0; i < p_item->i_children; i++)
259 PreparseEnqueueItemSub( p_playlist, p_item->pp_children[i] );
264 /*****************************************************************************
266 *****************************************************************************/
269 * Synchronise the current index of the playlist
270 * to match the index of the current item.
272 * \param p_playlist the playlist structure
273 * \param p_cur the current playlist item
276 static void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur )
278 PL_DEBUG( "resyncing on %s", PLI_NAME( p_cur ) );
279 /* Simply resync index */
281 p_playlist->i_current_index = -1;
282 for( i = 0 ; i< p_playlist->current.i_size; i++ )
284 if( ARRAY_VAL( p_playlist->current, i ) == p_cur )
286 p_playlist->i_current_index = i;
290 PL_DEBUG( "%s is at %i", PLI_NAME( p_cur ), p_playlist->i_current_index );
293 void ResetCurrentlyPlaying( playlist_t *p_playlist, bool b_random,
294 playlist_item_t *p_cur )
296 playlist_item_t *p_next = NULL;
297 stats_TimerStart( p_playlist, "Items array build",
298 STATS_TIMER_PLAYLIST_BUILD );
299 PL_DEBUG( "rebuilding array of current - root %s",
300 PLI_NAME( pl_priv(p_playlist)->status.p_node ) );
301 ARRAY_RESET( p_playlist->current );
302 p_playlist->i_current_index = -1;
305 /** FIXME: this is *slow* */
306 p_next = playlist_GetNextLeaf( p_playlist,
307 pl_priv(p_playlist)->status.p_node,
308 p_next, true, false );
311 if( p_next == p_cur )
312 p_playlist->i_current_index = p_playlist->current.i_size;
313 ARRAY_APPEND( p_playlist->current, p_next);
317 PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
318 p_playlist->i_current_index);
321 /* Shuffle the array */
322 srand( (unsigned int)mdate() );
324 for( j = p_playlist->current.i_size - 1; j > 0; j-- )
326 int i = rand() % (j+1); /* between 0 and j */
327 playlist_item_t *p_tmp;
328 /* swap the two items */
329 p_tmp = ARRAY_VAL(p_playlist->current, i);
330 ARRAY_VAL(p_playlist->current,i) = ARRAY_VAL(p_playlist->current,j);
331 ARRAY_VAL(p_playlist->current,j) = p_tmp;
334 pl_priv(p_playlist)->b_reset_currently_playing = false;
335 stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_BUILD );
339 * Compute the next playlist item depending on
340 * the playlist course mode (forward, backward, random, view,...).
342 * \param p_playlist the playlist object
345 playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
347 playlist_item_t *p_new = NULL;
350 bool b_loop = var_GetBool( p_playlist, "loop" );
351 bool b_random = var_GetBool( p_playlist, "random" );
352 bool b_repeat = var_GetBool( p_playlist, "repeat" );
353 bool b_playstop = var_GetBool( p_playlist, "play-and-stop" );
355 /* Handle quickly a few special cases */
356 /* No items to play */
357 if( p_playlist->items.i_size == 0 )
359 msg_Info( p_playlist, "playlist is empty" );
363 /* Repeat and play/stop */
364 if( !pl_priv(p_playlist)->request.b_request && b_repeat == true &&
365 get_current_status_item( p_playlist ) )
367 msg_Dbg( p_playlist,"repeating item" );
368 return get_current_status_item( p_playlist );
370 if( !pl_priv(p_playlist)->request.b_request && b_playstop == true )
372 msg_Dbg( p_playlist,"stopping (play and stop)" );
376 if( !pl_priv(p_playlist)->request.b_request &&
377 get_current_status_item( p_playlist ) )
379 playlist_item_t *p_parent = get_current_status_item( p_playlist );
382 if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
384 msg_Dbg( p_playlist, "blocking item, stopping") ;
387 p_parent = p_parent->p_parent;
391 /* Start the real work */
392 if( pl_priv(p_playlist)->request.b_request )
394 p_new = pl_priv(p_playlist)->request.p_item;
395 i_skip = pl_priv(p_playlist)->request.i_skip;
396 PL_DEBUG( "processing request item %s node %s skip %i",
397 PLI_NAME( pl_priv(p_playlist)->request.p_item ),
398 PLI_NAME( pl_priv(p_playlist)->request.p_node ), i_skip );
400 if( pl_priv(p_playlist)->request.p_node &&
401 pl_priv(p_playlist)->request.p_node != get_current_status_node( p_playlist ) )
404 set_current_status_node( p_playlist, pl_priv(p_playlist)->request.p_node );
405 pl_priv(p_playlist)->request.p_node = NULL;
406 pl_priv(p_playlist)->b_reset_currently_playing = true;
409 /* If we are asked for a node, go to it's first child */
410 if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
415 p_new = playlist_GetNextLeaf( p_playlist, p_new, NULL, true, false );
416 for( i = 0; i < p_playlist->current.i_size; i++ )
418 if( p_new == ARRAY_VAL( p_playlist->current, i ) )
420 p_playlist->i_current_index = i;
427 if( pl_priv(p_playlist)->b_reset_currently_playing )
428 /* A bit too bad to reset twice ... */
429 ResetCurrentlyPlaying( p_playlist, b_random, p_new );
431 ResyncCurrentIndex( p_playlist, p_new );
433 p_playlist->i_current_index = -1;
435 if( p_playlist->current.i_size && (i_skip > 0) )
437 if( p_playlist->i_current_index < -1 )
438 p_playlist->i_current_index = -1;
439 for( i = i_skip; i > 0 ; i-- )
441 p_playlist->i_current_index++;
442 if( p_playlist->i_current_index >= p_playlist->current.i_size )
444 PL_DEBUG( "looping - restarting at beginning of node" );
445 p_playlist->i_current_index = 0;
448 p_new = ARRAY_VAL( p_playlist->current,
449 p_playlist->i_current_index );
451 else if( p_playlist->current.i_size && (i_skip < 0) )
453 for( i = i_skip; i < 0 ; i++ )
455 p_playlist->i_current_index--;
456 if( p_playlist->i_current_index <= -1 )
458 PL_DEBUG( "looping - restarting at end of node" );
459 p_playlist->i_current_index = p_playlist->current.i_size-1;
462 p_new = ARRAY_VAL( p_playlist->current,
463 p_playlist->i_current_index );
465 /* Clear the request */
466 pl_priv(p_playlist)->request.b_request = false;
468 /* "Automatic" item change ( next ) */
471 PL_DEBUG( "changing item without a request (current %i/%i)",
472 p_playlist->i_current_index, p_playlist->current.i_size );
473 /* Cant go to next from current item */
474 if( get_current_status_item( p_playlist ) &&
475 get_current_status_item( p_playlist )->i_flags & PLAYLIST_SKIP_FLAG )
478 if( pl_priv(p_playlist)->b_reset_currently_playing )
479 ResetCurrentlyPlaying( p_playlist, b_random,
480 get_current_status_item( p_playlist ) );
482 p_playlist->i_current_index++;
483 assert( p_playlist->i_current_index <= p_playlist->current.i_size );
484 if( p_playlist->i_current_index == p_playlist->current.i_size )
486 if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
487 p_playlist->i_current_index = 0;
489 PL_DEBUG( "using item %i", p_playlist->i_current_index );
490 if ( p_playlist->current.i_size == 0 ) return NULL;
492 p_new = ARRAY_VAL( p_playlist->current, p_playlist->i_current_index );
493 /* The new item can't be autoselected */
494 if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
501 * Start the input for an item
503 * \param p_playlist the playlist object
504 * \param p_item the item to play
507 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
509 input_item_t *p_input = p_item->p_input;
510 sout_instance_t **pp_sout = &pl_priv(p_playlist)->p_sout;
511 int i_activity = var_GetInteger( p_playlist, "activity" ) ;
513 msg_Dbg( p_playlist, "creating new input thread" );
515 p_input->i_nb_played++;
516 set_current_status_item( p_playlist, p_item );
518 pl_priv(p_playlist)->status.i_status = PLAYLIST_RUNNING;
520 var_SetInteger( p_playlist, "activity", i_activity +
521 DEFAULT_INPUT_ACTIVITY );
523 input_thread_t * p_input_thread =
524 input_CreateThreadExtended( p_playlist, p_input, NULL, *pp_sout );
525 playlist_set_current_input( p_playlist, p_input_thread );
526 vlc_object_release( p_input_thread );
530 char *psz_uri = input_item_GetURI( p_item->p_input );
531 if( psz_uri && ( !strncmp( psz_uri, "directory:", 10 ) ||
532 !strncmp( psz_uri, "vlc:", 4 ) ) )
539 if( pl_priv(p_playlist)->fetcher.i_art_policy == ALBUM_ART_WHEN_PLAYED )
543 char *psz_arturl, *psz_name;
544 psz_arturl = input_item_GetArtURL( p_input );
545 psz_name = input_item_GetName( p_input );
547 /* p_input->p_meta should not be null after a successfull CreateThread */
548 b_has_art = !EMPTY_STR( psz_arturl );
550 if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
552 PL_DEBUG( "requesting art for %s", psz_name );
553 playlist_AskForArtEnqueue( p_playlist, p_input );
560 var_SetInteger( p_playlist, "playlist-current", p_input->i_id );