1 /*****************************************************************************
2 * engine.c : Run the playlist and handle its control
3 *****************************************************************************
4 * Copyright (C) 1999-2008 the VideoLAN team
6 * Authors: Samuel Hocevar <sam@zoy.org>
7 * Clément Stenac <zorglub@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
30 #include <vlc_common.h>
32 #include <vlc_playlist.h>
33 #include <vlc_interface.h>
34 #include "playlist_internal.h"
35 #include "stream_output/stream_output.h" /* sout_DeleteInstance */
37 /*****************************************************************************
39 *****************************************************************************/
40 static void VariablesInit( playlist_t *p_playlist );
41 static void playlist_Destructor( vlc_object_t * p_this );
43 static int RandomCallback( vlc_object_t *p_this, char const *psz_cmd,
44 vlc_value_t oldval, vlc_value_t newval, void *a )
46 (void)psz_cmd; (void)oldval; (void)newval; (void)a;
47 playlist_t *p_playlist = (playlist_t*)p_this;
51 pl_priv(p_playlist)->b_reset_currently_playing = true;
52 vlc_cond_signal( &pl_priv(p_playlist)->signal );
61 * Create a playlist structure.
62 * \param p_parent the vlc object that is to be the parent of this playlist
63 * \return a pointer to the created playlist, or NULL on error
65 playlist_t * playlist_Create( vlc_object_t *p_parent )
67 static const char playlist_name[] = "playlist";
68 playlist_t *p_playlist;
69 playlist_private_t *p;
71 /* Allocate structure */
72 p = vlc_custom_create( p_parent, sizeof( *p ),
73 VLC_OBJECT_GENERIC, playlist_name );
77 assert( offsetof( playlist_private_t, public_data ) == 0 );
78 p_playlist = &p->public_data;
79 vlc_object_attach( p_playlist, p_parent );
80 TAB_INIT( pl_priv(p_playlist)->i_sds, pl_priv(p_playlist)->pp_sds );
82 libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
84 VariablesInit( p_playlist );
85 vlc_mutex_init( &p->lock );
86 vlc_cond_init( &p->signal );
88 /* Initialise data structures */
89 pl_priv(p_playlist)->i_last_playlist_id = 0;
90 pl_priv(p_playlist)->p_input = NULL;
92 ARRAY_INIT( p_playlist->items );
93 ARRAY_INIT( p_playlist->all_items );
94 ARRAY_INIT( pl_priv(p_playlist)->items_to_delete );
95 ARRAY_INIT( p_playlist->current );
97 p_playlist->i_current_index = 0;
98 pl_priv(p_playlist)->b_reset_currently_playing = true;
99 pl_priv(p_playlist)->last_rebuild_date = 0;
101 pl_priv(p_playlist)->b_tree = var_InheritBool( p_parent, "playlist-tree" );
103 pl_priv(p_playlist)->b_doing_ml = false;
105 pl_priv(p_playlist)->b_auto_preparse =
106 var_InheritBool( p_parent, "auto-preparse" );
109 p->p_fetcher = playlist_fetcher_New( p_playlist );
110 if( unlikely(p->p_fetcher == NULL) )
112 msg_Err( p_playlist, "cannot create fetcher" );
113 p->p_preparser = NULL;
117 p->p_preparser = playlist_preparser_New( p_playlist, p->p_fetcher );
118 if( unlikely(p->p_preparser == NULL) )
119 msg_Err( p_playlist, "cannot create preparser" );
122 /* Create the root node */
124 p_playlist->p_root = playlist_NodeCreate( p_playlist, NULL, NULL,
127 if( !p_playlist->p_root ) return NULL;
129 /* Create currently playing items node */
131 p_playlist->p_playing = playlist_NodeCreate(
132 p_playlist, _( "Playlist" ), p_playlist->p_root,
133 PLAYLIST_RO_FLAG, NULL );
137 if( !p_playlist->p_playing ) return NULL;
139 /* Create media library node */
140 const bool b_ml = var_InheritBool( p_parent, "media-library");
144 p_playlist->p_media_library = playlist_NodeCreate(
145 p_playlist, _( "Media Library" ), p_playlist->p_root,
146 PLAYLIST_RO_FLAG, NULL );
149 if(!p_playlist->p_media_library ) return NULL;
153 p_playlist->p_media_library = NULL;
156 p_playlist->p_root_category = p_playlist->p_root;
157 p_playlist->p_root_onelevel = p_playlist->p_root;
158 p_playlist->p_local_category = p_playlist->p_playing;
159 p_playlist->p_local_onelevel = p_playlist->p_playing;
160 p_playlist->p_ml_category = p_playlist->p_media_library;
161 p_playlist->p_ml_onelevel = p_playlist->p_media_library;;
164 pl_priv(p_playlist)->status.p_item = NULL;
165 pl_priv(p_playlist)->status.p_node = p_playlist->p_playing;
166 pl_priv(p_playlist)->request.b_request = false;
167 pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
171 const bool b_auto_preparse = pl_priv(p_playlist)->b_auto_preparse;
172 pl_priv(p_playlist)->b_auto_preparse = false;
173 playlist_MLLoad( p_playlist );
174 pl_priv(p_playlist)->b_auto_preparse = b_auto_preparse;
177 vlc_object_set_destructor( p_playlist, playlist_Destructor );
182 void playlist_Destroy( playlist_t *p_playlist )
184 playlist_private_t *p_sys = pl_priv(p_playlist);
186 msg_Dbg( p_playlist, "destroying" );
187 if( p_sys->p_preparser )
188 playlist_preparser_Delete( p_sys->p_preparser );
189 if( p_sys->p_fetcher )
190 playlist_fetcher_Delete( p_sys->p_fetcher );
191 vlc_object_release( p_playlist );
197 * Destroy a playlist structure.
198 * \param p_playlist the playlist object
202 static void playlist_Destructor( vlc_object_t * p_this )
204 playlist_t *p_playlist = (playlist_t *)p_this;
205 playlist_private_t *p_sys = pl_priv(p_playlist);
207 assert( !p_sys->p_input );
208 assert( !p_sys->p_input_resource );
210 vlc_cond_destroy( &p_sys->signal );
211 vlc_mutex_destroy( &p_sys->lock );
213 /* Remove all remaining items */
214 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
215 free( p_del->pp_children );
216 vlc_gc_decref( p_del->p_input );
219 ARRAY_RESET( p_playlist->all_items );
220 FOREACH_ARRAY( playlist_item_t *p_del, p_sys->items_to_delete )
221 free( p_del->pp_children );
222 vlc_gc_decref( p_del->p_input );
225 ARRAY_RESET( p_sys->items_to_delete );
227 ARRAY_RESET( p_playlist->items );
228 ARRAY_RESET( p_playlist->current );
230 msg_Dbg( p_this, "Destroyed" );
233 /** Get current playing input.
235 input_thread_t * playlist_CurrentInput( playlist_t * p_playlist )
237 input_thread_t * p_input;
239 p_input = pl_priv(p_playlist)->p_input;
240 if( p_input ) vlc_object_hold( p_input );
249 /** Accessor for status item and status nodes.
251 playlist_item_t * get_current_status_item( playlist_t * p_playlist )
255 return pl_priv(p_playlist)->status.p_item;
258 playlist_item_t * get_current_status_node( playlist_t * p_playlist )
262 return pl_priv(p_playlist)->status.p_node;
265 void set_current_status_item( playlist_t * p_playlist,
266 playlist_item_t * p_item )
270 if( pl_priv(p_playlist)->status.p_item &&
271 pl_priv(p_playlist)->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG &&
272 pl_priv(p_playlist)->status.p_item != p_item )
274 /* It's unsafe given current design to delete a playlist item :(
275 playlist_ItemDelete( pl_priv(p_playlist)->status.p_item ); */
277 pl_priv(p_playlist)->status.p_item = p_item;
280 void set_current_status_node( playlist_t * p_playlist,
281 playlist_item_t * p_node )
285 if( pl_priv(p_playlist)->status.p_node &&
286 pl_priv(p_playlist)->status.p_node->i_flags & PLAYLIST_REMOVE_FLAG &&
287 pl_priv(p_playlist)->status.p_node != p_node )
289 /* It's unsafe given current design to delete a playlist item :(
290 playlist_ItemDelete( pl_priv(p_playlist)->status.p_node ); */
292 pl_priv(p_playlist)->status.p_node = p_node;
295 static void VariablesInit( playlist_t *p_playlist )
297 /* These variables control updates */
298 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
299 var_SetBool( p_playlist, "intf-change", true );
301 var_Create( p_playlist, "item-change", VLC_VAR_ADDRESS );
302 var_Create( p_playlist, "leaf-to-parent", VLC_VAR_ADDRESS );
304 var_Create( p_playlist, "playlist-item-deleted", VLC_VAR_INTEGER );
305 var_SetInteger( p_playlist, "playlist-item-deleted", -1 );
307 var_Create( p_playlist, "playlist-item-append", VLC_VAR_ADDRESS );
309 var_Create( p_playlist, "item-current", VLC_VAR_ADDRESS );
310 var_Create( p_playlist, "input-current", VLC_VAR_ADDRESS );
312 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
313 var_SetInteger( p_playlist, "activity", 0 );
315 /* Variables to control playback */
316 var_Create( p_playlist, "play-and-stop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
317 var_Create( p_playlist, "play-and-exit", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
318 var_Create( p_playlist, "random", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
319 var_Create( p_playlist, "repeat", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
320 var_Create( p_playlist, "loop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
322 var_AddCallback( p_playlist, "random", RandomCallback, NULL );
325 var_Create( p_playlist, "album-art", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
328 playlist_item_t * playlist_CurrentPlayingItem( playlist_t * p_playlist )
332 return pl_priv(p_playlist)->status.p_item;
335 int playlist_Status( playlist_t * p_playlist )
339 return pl_priv(p_playlist)->status.i_status;