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" );
108 /* Create the root node */
110 p_playlist->p_root = playlist_NodeCreate( p_playlist, NULL, NULL,
113 if( !p_playlist->p_root ) return NULL;
115 /* Create currently playing items node */
117 p_playlist->p_playing = playlist_NodeCreate(
118 p_playlist, _( "Playlist" ), p_playlist->p_root,
119 PLAYLIST_RO_FLAG, NULL );
123 if( !p_playlist->p_playing ) return NULL;
125 /* Create media library node */
126 const bool b_ml = var_InheritBool( p_parent, "media-library");
130 p_playlist->p_media_library = playlist_NodeCreate(
131 p_playlist, _( "Media Library" ), p_playlist->p_root,
132 PLAYLIST_RO_FLAG, NULL );
135 if(!p_playlist->p_media_library ) return NULL;
139 p_playlist->p_media_library = NULL;
142 p_playlist->p_root_category = p_playlist->p_root;
143 p_playlist->p_root_onelevel = p_playlist->p_root;
144 p_playlist->p_local_category = p_playlist->p_playing;
145 p_playlist->p_local_onelevel = p_playlist->p_playing;
146 p_playlist->p_ml_category = p_playlist->p_media_library;
147 p_playlist->p_ml_onelevel = p_playlist->p_media_library;;
150 pl_priv(p_playlist)->status.p_item = NULL;
151 pl_priv(p_playlist)->status.p_node = p_playlist->p_playing;
152 pl_priv(p_playlist)->request.b_request = false;
153 pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
157 const bool b_auto_preparse = pl_priv(p_playlist)->b_auto_preparse;
158 pl_priv(p_playlist)->b_auto_preparse = false;
159 playlist_MLLoad( p_playlist );
160 pl_priv(p_playlist)->b_auto_preparse = b_auto_preparse;
163 vlc_object_set_destructor( p_playlist, playlist_Destructor );
171 * Destroy a playlist structure.
172 * \param p_playlist the playlist object
176 static void playlist_Destructor( vlc_object_t * p_this )
178 playlist_t *p_playlist = (playlist_t *)p_this;
179 playlist_private_t *p_sys = pl_priv(p_playlist);
181 assert( !p_sys->p_input );
182 assert( !p_sys->p_input_resource );
183 assert( !p_sys->p_preparser );
184 assert( !p_sys->p_fetcher );
186 vlc_cond_destroy( &p_sys->signal );
187 vlc_mutex_destroy( &p_sys->lock );
189 /* Remove all remaining items */
190 FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
191 free( p_del->pp_children );
192 vlc_gc_decref( p_del->p_input );
195 ARRAY_RESET( p_playlist->all_items );
196 FOREACH_ARRAY( playlist_item_t *p_del, p_sys->items_to_delete )
197 free( p_del->pp_children );
198 vlc_gc_decref( p_del->p_input );
201 ARRAY_RESET( p_sys->items_to_delete );
203 ARRAY_RESET( p_playlist->items );
204 ARRAY_RESET( p_playlist->current );
206 msg_Dbg( p_this, "Destroyed" );
209 /** Get current playing input.
211 input_thread_t * playlist_CurrentInput( playlist_t * p_playlist )
213 input_thread_t * p_input;
215 p_input = pl_priv(p_playlist)->p_input;
216 if( p_input ) vlc_object_hold( p_input );
225 /** Accessor for status item and status nodes.
227 playlist_item_t * get_current_status_item( playlist_t * p_playlist )
231 return pl_priv(p_playlist)->status.p_item;
234 playlist_item_t * get_current_status_node( playlist_t * p_playlist )
238 return pl_priv(p_playlist)->status.p_node;
241 void set_current_status_item( playlist_t * p_playlist,
242 playlist_item_t * p_item )
246 if( pl_priv(p_playlist)->status.p_item &&
247 pl_priv(p_playlist)->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG &&
248 pl_priv(p_playlist)->status.p_item != p_item )
250 /* It's unsafe given current design to delete a playlist item :(
251 playlist_ItemDelete( pl_priv(p_playlist)->status.p_item ); */
253 pl_priv(p_playlist)->status.p_item = p_item;
256 void set_current_status_node( playlist_t * p_playlist,
257 playlist_item_t * p_node )
261 if( pl_priv(p_playlist)->status.p_node &&
262 pl_priv(p_playlist)->status.p_node->i_flags & PLAYLIST_REMOVE_FLAG &&
263 pl_priv(p_playlist)->status.p_node != p_node )
265 /* It's unsafe given current design to delete a playlist item :(
266 playlist_ItemDelete( pl_priv(p_playlist)->status.p_node ); */
268 pl_priv(p_playlist)->status.p_node = p_node;
271 static void VariablesInit( playlist_t *p_playlist )
273 /* These variables control updates */
274 var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
275 var_SetBool( p_playlist, "intf-change", true );
277 var_Create( p_playlist, "item-change", VLC_VAR_ADDRESS );
278 var_Create( p_playlist, "leaf-to-parent", VLC_VAR_ADDRESS );
280 var_Create( p_playlist, "playlist-item-deleted", VLC_VAR_INTEGER );
281 var_SetInteger( p_playlist, "playlist-item-deleted", -1 );
283 var_Create( p_playlist, "playlist-item-append", VLC_VAR_ADDRESS );
285 var_Create( p_playlist, "item-current", VLC_VAR_ADDRESS );
286 var_Create( p_playlist, "input-current", VLC_VAR_ADDRESS );
288 var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
289 var_SetInteger( p_playlist, "activity", 0 );
291 /* Variables to control playback */
292 var_Create( p_playlist, "play-and-stop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
293 var_Create( p_playlist, "play-and-exit", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
294 var_Create( p_playlist, "random", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
295 var_Create( p_playlist, "repeat", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
296 var_Create( p_playlist, "loop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
298 var_AddCallback( p_playlist, "random", RandomCallback, NULL );
301 var_Create( p_playlist, "album-art", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
304 playlist_item_t * playlist_CurrentPlayingItem( playlist_t * p_playlist )
308 return pl_priv(p_playlist)->status.p_item;
311 int playlist_Status( playlist_t * p_playlist )
315 return pl_priv(p_playlist)->status.i_status;