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 vlc_object_yield (pl);
55 void __pl_Release( vlc_object_t *p_this )
57 playlist_t *pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
59 vlc_object_release( pl );
62 int playlist_Control( playlist_t * p_playlist, int i_query,
67 va_start( args, b_locked );
68 PL_LOCK_IF( !b_locked );
69 i_result = PlaylistVAControl( p_playlist, i_query, args );
71 PL_UNLOCK_IF( !b_locked );
76 static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args )
78 playlist_item_t *p_item, *p_node;
81 if( !vlc_object_alive( p_playlist ) )
84 if( playlist_IsEmpty( p_playlist ) )
90 p_playlist->request.i_status = PLAYLIST_STOPPED;
91 p_playlist->request.b_request = true;
92 p_playlist->request.p_item = NULL;
95 // Node can be null, it will keep the same. Use with care ...
96 // Item null = take the first child of node
97 case PLAYLIST_VIEWPLAY:
98 p_node = (playlist_item_t *)va_arg( args, playlist_item_t * );
99 p_item = (playlist_item_t *)va_arg( args, playlist_item_t * );
100 if ( p_node == NULL )
102 p_node = p_playlist->status.p_node;
105 p_playlist->request.i_status = PLAYLIST_RUNNING;
106 p_playlist->request.i_skip = 0;
107 p_playlist->request.b_request = true;
108 p_playlist->request.p_node = p_node;
109 p_playlist->request.p_item = p_item;
110 if( p_item && var_GetBool( p_playlist, "random" ) )
111 p_playlist->b_reset_currently_playing = true;
115 if( p_playlist->p_input )
117 val.i_int = PLAYING_S;
118 var_Set( p_playlist->p_input, "state", val );
123 p_playlist->request.i_status = PLAYLIST_RUNNING;
124 p_playlist->request.b_request = true;
125 p_playlist->request.p_node = get_current_status_node( p_playlist );
126 p_playlist->request.p_item = get_current_status_item( p_playlist );
127 p_playlist->request.i_skip = 0;
133 if( p_playlist->p_input )
134 var_Get( p_playlist->p_input, "state", &val );
136 if( val.i_int == PAUSE_S )
138 p_playlist->status.i_status = PLAYLIST_RUNNING;
139 if( p_playlist->p_input )
141 val.i_int = PLAYING_S;
142 var_Set( p_playlist->p_input, "state", val );
147 p_playlist->status.i_status = PLAYLIST_PAUSED;
148 if( p_playlist->p_input )
151 var_Set( p_playlist->p_input, "state", val );
157 p_playlist->request.p_node = get_current_status_node( p_playlist );
158 p_playlist->request.p_item = get_current_status_item( p_playlist );
159 p_playlist->request.i_skip = (int) va_arg( args, int );
160 /* if already running, keep running */
161 if( p_playlist->status.i_status != PLAYLIST_STOPPED )
162 p_playlist->request.i_status = p_playlist->status.i_status;
163 p_playlist->request.b_request = true;
167 msg_Err( p_playlist, "unknown playlist query" );
171 vlc_object_signal_maybe( VLC_OBJECT(p_playlist) );
176 /*****************************************************************************
178 *****************************************************************************/
179 /** Enqueue an item for preparsing */
180 int playlist_PreparseEnqueue( playlist_t *p_playlist,
181 input_item_t *p_item )
183 vlc_object_lock( p_playlist->p_preparse );
184 if( !vlc_object_alive( p_playlist->p_preparse ) )
186 vlc_object_unlock( p_playlist->p_preparse );
189 vlc_gc_incref( p_item );
190 INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
191 p_playlist->p_preparse->i_waiting,
192 p_playlist->p_preparse->i_waiting,
194 vlc_object_signal_unlocked( p_playlist->p_preparse );
195 vlc_object_unlock( p_playlist->p_preparse );
199 /** Enqueue a playlist item or a node for peparsing.
200 * This function should be entered without playlist and preparser locks */
201 int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
202 playlist_item_t *p_item )
204 vlc_object_lock( p_playlist );
205 vlc_object_lock( p_playlist->p_preparse );
206 if( !vlc_object_alive( p_playlist->p_preparse ) )
208 vlc_object_unlock( p_playlist->p_preparse );
209 vlc_object_unlock( p_playlist );
212 PreparseEnqueueItemSub( p_playlist, p_item );
213 vlc_object_unlock( p_playlist->p_preparse );
214 vlc_object_unlock( p_playlist );
218 int playlist_AskForArtEnqueue( playlist_t *p_playlist,
219 input_item_t *p_item )
221 vlc_object_lock( p_playlist->p_fetcher );
222 if( !vlc_object_alive( p_playlist->p_fetcher ) )
224 vlc_object_unlock( p_playlist->p_fetcher );
228 vlc_gc_incref( p_item );
229 INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
230 p_playlist->p_fetcher->i_waiting,
231 p_playlist->p_fetcher->i_waiting, p_item );
232 vlc_object_signal_unlocked( p_playlist->p_fetcher );
233 vlc_object_unlock( p_playlist->p_fetcher );
237 static void PreparseEnqueueItemSub( playlist_t *p_playlist,
238 playlist_item_t *p_item )
241 if( p_item->i_children == -1 )
243 vlc_gc_incref( p_item->p_input );
244 INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
245 p_playlist->p_preparse->i_waiting,
246 p_playlist->p_preparse->i_waiting,
251 for( 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( 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 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( !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( !p_playlist->request.b_request && b_playstop == true )
366 msg_Dbg( p_playlist,"stopping (play and stop)" );
370 if( !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( p_playlist->request.b_request )
388 p_new = p_playlist->request.p_item;
389 i_skip = p_playlist->request.i_skip;
390 PL_DEBUG( "processing request item %s node %s skip %i",
391 PLI_NAME( p_playlist->request.p_item ),
392 PLI_NAME( p_playlist->request.p_node ), i_skip );
394 if( p_playlist->request.p_node &&
395 p_playlist->request.p_node != get_current_status_node( p_playlist ) )
398 set_current_status_node( p_playlist, p_playlist->request.p_node );
399 p_playlist->request.p_node = NULL;
400 p_playlist->b_reset_currently_playing = true;
403 /* If we are asked for a node, don't take it */
404 if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
407 if( p_playlist->b_reset_currently_playing )
408 /* A bit too bad to reset twice ... */
409 ResetCurrentlyPlaying( p_playlist, b_random, p_new );
411 ResyncCurrentIndex( p_playlist, p_new );
413 p_playlist->i_current_index = -1;
415 if( p_playlist->current.i_size && (i_skip > 0) )
417 if( p_playlist->i_current_index < -1 )
418 p_playlist->i_current_index = -1;
419 for( i = i_skip; i > 0 ; i-- )
421 p_playlist->i_current_index++;
422 if( p_playlist->i_current_index >= p_playlist->current.i_size )
424 PL_DEBUG( "looping - restarting at beginning of node" );
425 p_playlist->i_current_index = 0;
428 p_new = ARRAY_VAL( p_playlist->current,
429 p_playlist->i_current_index );
431 else if( p_playlist->current.i_size && (i_skip < 0) )
433 for( i = i_skip; i < 0 ; i++ )
435 p_playlist->i_current_index--;
436 if( p_playlist->i_current_index <= -1 )
438 PL_DEBUG( "looping - restarting at end of node" );
439 p_playlist->i_current_index = p_playlist->current.i_size-1;
442 p_new = ARRAY_VAL( p_playlist->current,
443 p_playlist->i_current_index );
445 /* Clear the request */
446 p_playlist->request.b_request = false;
448 /* "Automatic" item change ( next ) */
451 PL_DEBUG( "changing item without a request (current %i/%i)",
452 p_playlist->i_current_index, p_playlist->current.i_size );
453 /* Cant go to next from current item */
454 if( get_current_status_item( p_playlist ) &&
455 get_current_status_item( p_playlist )->i_flags & PLAYLIST_SKIP_FLAG )
458 if( p_playlist->b_reset_currently_playing )
459 ResetCurrentlyPlaying( p_playlist, b_random,
460 get_current_status_item( p_playlist ) );
462 p_playlist->i_current_index++;
463 assert( p_playlist->i_current_index <= p_playlist->current.i_size );
464 if( p_playlist->i_current_index == p_playlist->current.i_size )
466 if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
467 p_playlist->i_current_index = 0;
469 PL_DEBUG( "using item %i", p_playlist->i_current_index );
470 if ( p_playlist->current.i_size == 0 ) return NULL;
472 p_new = ARRAY_VAL( p_playlist->current, p_playlist->i_current_index );
473 /* The new item can't be autoselected */
474 if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
481 * Start the input for an item
483 * \param p_playlist the playlist objetc
484 * \param p_item the item to play
487 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
489 input_item_t *p_input = p_item->p_input;
490 sout_instance_t **pp_sout = &libvlc_priv(p_playlist->p_libvlc)->p_sout;
491 int i_activity = var_GetInteger( p_playlist, "activity" ) ;
493 msg_Dbg( p_playlist, "creating new input thread" );
495 p_input->i_nb_played++;
496 set_current_status_item( p_playlist, p_item );
498 p_playlist->status.i_status = PLAYLIST_RUNNING;
500 var_SetInteger( p_playlist, "activity", i_activity +
501 DEFAULT_INPUT_ACTIVITY );
503 input_thread_t * p_input_thread =
504 input_CreateThreadExtended( p_playlist, p_input, NULL, *pp_sout );
505 playlist_set_current_input( p_playlist, p_input_thread );
506 vlc_object_release( p_input_thread );
510 char *psz_uri = input_item_GetURI( p_item->p_input );
511 if( psz_uri && ( !strncmp( psz_uri, "directory:", 10 ) ||
512 !strncmp( psz_uri, "vlc:", 4 ) ) )
519 if( p_playlist->p_fetcher &&
520 p_playlist->p_fetcher->i_art_policy == ALBUM_ART_WHEN_PLAYED )
524 char *psz_arturl, *psz_name;
525 psz_arturl = input_item_GetArtURL( p_input );
526 psz_name = input_item_GetName( p_input );
528 /* p_input->p_meta should not be null after a successfull CreateThread */
529 b_has_art = !EMPTY_STR( psz_arturl );
531 if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
533 PL_DEBUG( "requesting art for %s", psz_name );
534 playlist_AskForArtEnqueue( p_playlist, p_input );
541 var_SetInteger( p_playlist, "playlist-current", p_input->i_id );