1 /*****************************************************************************
2 * vlc_playlist.h : Playlist functions
3 *****************************************************************************
4 * Copyright (C) 1999-2004 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.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 *****************************************************************************/
24 #ifndef _VLC_PLAYLIST_H_
25 #define _VLC_PLAYLIST_H_
29 * This file contain structures and function prototypes related
30 * to the playlist in vlc
34 * \defgroup vlc_playlist Playlist
39 * playlist export helper structure
41 struct playlist_export_t
45 playlist_item_t *p_root;
49 * playlist item / node
52 struct playlist_item_t
54 input_item_t *p_input; /**< input item descriptor */
56 /* Tree specific fields */
57 int i_children; /**< Number of children
59 playlist_item_t **pp_children; /**< Children nodes/items */
60 playlist_item_t *p_parent; /**< Item parent */
62 int i_id; /**< Playlist item specific id */
64 uint8_t i_flags; /**< Flags */
67 #define PLAYLIST_SAVE_FLAG 0x0001 /**< Must it be saved */
68 #define PLAYLIST_SKIP_FLAG 0x0002 /**< Must playlist skip after it ? */
69 #define PLAYLIST_DBL_FLAG 0x0004 /**< Is it disabled ? */
70 #define PLAYLIST_RO_FLAG 0x0008 /**< Write-enabled ? */
71 #define PLAYLIST_REMOVE_FLAG 0x0010 /**< Remove this item at the end */
72 #define PLAYLIST_EXPANDED_FLAG 0x0020 /**< Expanded node */
73 #define PLAYLIST_PREFCAT_FLAG 0x0040 /**< Prefer category */
79 { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
82 struct services_discovery_t
89 services_discovery_sys_t *p_sys;
90 void (*pf_run) ( services_discovery_t *);
93 struct playlist_preparse_t
98 input_item_t **pp_waiting;
102 /** Structure containing information about the playlist */
108 These members are uniq to playlist_t
111 int i_enabled; /**< How many items are enabled ? */
113 /* Arrays of items */
114 int i_size; /**< total size of the list */
115 playlist_item_t ** pp_items; /**< array of pointers to the
117 int i_all_size; /**< size of list of items and nodes */
118 playlist_item_t ** pp_all_items; /**< array of pointers to the
119 * playlist items and nodes */
121 input_item_t ** pp_input_items;
123 int i_random; /**< Number of candidates for random */
124 playlist_item_t ** pp_random; /**< Random candidate items */
125 int i_random_index; /**< Current random item */
126 vlc_bool_t b_reset_random; /**< Recreate random array ?*/
128 int i_last_playlist_id; /**< Last id to an item */
129 int i_last_input_id ; /**< Last id on an input */
131 services_discovery_t **pp_sds;
134 /* Predefined items */
135 playlist_item_t * p_root_category;
136 playlist_item_t * p_root_onelevel;
137 playlist_item_t * p_local_category; /** < "Playlist" in CATEGORY view */
138 playlist_item_t * p_ml_category; /** < "Library" in CATEGORY view */
139 playlist_item_t * p_local_onelevel; /** < "Playlist" in ONELEVEL view */
140 playlist_item_t * p_ml_onelevel; /** < "Library" in ONELEVEL iew */
142 vlc_bool_t b_always_tree;/**< Always display as tree */
143 vlc_bool_t b_never_tree;/**< Never display as tree */
145 vlc_bool_t b_doing_ml; /**< Doing media library stuff, */
149 input_thread_t * p_input; /**< the input thread associated
150 * with the current item */
151 int i_sort; /**< Last sorting applied to the playlist */
152 int i_order; /**< Last ordering applied to the playlist */
153 mtime_t i_vout_destroyed_date;
154 mtime_t i_sout_destroyed_date;
155 playlist_preparse_t *p_preparse; /**< Preparser object */
157 vlc_mutex_t gc_lock; /**< Lock to protect the garbage collection */
160 /* Current status. These fields are readonly, only the playlist
161 * main loop can touch it*/
162 playlist_status_t i_status; /**< Current status of playlist */
163 playlist_item_t * p_item; /**< Currently playing/active item */
164 playlist_item_t * p_node; /**< Current node to play from */
168 /* Request. Use this to give orders to the playlist main loop */
169 int i_status; /**< requested playlist status */
170 playlist_item_t * p_node; /**< requested node to play from */
171 playlist_item_t * p_item; /**< requested item to play in the node */
173 int i_skip; /**< Number of items to skip */
175 vlc_bool_t b_request;/**< Set to true by the requester
176 The playlist sets it back to false
177 when processing the request */
178 vlc_mutex_t lock; /**< Lock to protect request */
181 // Playlist-unrelated fields
182 interaction_t *p_interaction; /**< Interaction manager */
183 global_stats_t *p_stats; /**< Global statistics */
187 /* Helper to add an item */
188 struct playlist_add_t
197 #define SORT_TITLE_NODES_FIRST 2
198 #define SORT_ARTIST 3
200 #define SORT_RANDOM 5
201 #define SORT_DURATION 6
202 #define SORT_TITLE_NUMERIC 7
205 #define ORDER_NORMAL 0
206 #define ORDER_REVERSE 1
208 /*****************************************************************************
210 *****************************************************************************/
213 #define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
214 playlist_t *__playlist_ThreadCreate ( vlc_object_t * );
215 int playlist_ThreadDestroy ( playlist_t * );
218 #define PL_LOCK vlc_mutex_lock( &p_playlist->object_lock );
219 #define PL_UNLOCK vlc_mutex_unlock( &p_playlist->object_lock );
221 /* Creation/Deletion */
222 playlist_t *playlist_Create ( vlc_object_t * );
223 void playlist_Destroy ( playlist_t * );
226 void playlist_MainLoop( playlist_t * );
227 void playlist_LastLoop( playlist_t * );
228 void playlist_PreparseLoop( playlist_preparse_t * );
231 playlist_item_t * playlist_NextItem ( playlist_t * );
232 int playlist_PlayItem ( playlist_t *, playlist_item_t * );
234 /* Playlist control */
235 #define playlist_Play(p) playlist_LockControl(p,PLAYLIST_PLAY )
236 #define playlist_Pause(p) playlist_LockControl(p,PLAYLIST_PAUSE )
237 #define playlist_Stop(p) playlist_LockControl(p,PLAYLIST_STOP )
238 #define playlist_Next(p) playlist_LockControl(p,PLAYLIST_SKIP, 1)
239 #define playlist_Prev(p) playlist_LockControl(p,PLAYLIST_SKIP, -1)
240 #define playlist_Skip(p,i) playlist_LockControl(p,PLAYLIST_SKIP, i)
242 VLC_EXPORT( int, playlist_Control, ( playlist_t *, int, ... ) );
243 VLC_EXPORT( int, playlist_LockControl, ( playlist_t *, int, ... ) );
245 VLC_EXPORT( void, playlist_Clear, ( playlist_t * ) );
246 VLC_EXPORT( void, playlist_LockClear, ( playlist_t * ) );
248 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
249 VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) );
251 /* Services discovery */
253 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
254 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
255 VLC_EXPORT( int, playlist_AddSDModules, (playlist_t *, char *));
256 VLC_EXPORT( vlc_bool_t, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
258 /* Playlist sorting */
259 VLC_EXPORT( int, playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
260 VLC_EXPORT( int, playlist_NodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
261 VLC_EXPORT( int, playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
264 VLC_EXPORT( int, playlist_Import, ( playlist_t *, const char *, playlist_item_t *, vlc_bool_t ) );
265 VLC_EXPORT( int, playlist_Export, ( playlist_t *, const char *, playlist_item_t *, const char * ) );
266 int playlist_MLLoad( playlist_t *p_playlist );
267 int playlist_MLDump( playlist_t *p_playlist );
269 /********************************************************
271 ********************************************************/
273 /*************************** Item creation **************************/
275 VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int , const char **, int, int) );
277 #define playlist_ItemNew( a , b, c ) __playlist_ItemNew(VLC_OBJECT(a) , b , c )
278 /** Create a new item, without adding it to the playlist
279 * \param p_obj a vlc object (anyone will do)
280 * \param psz_uri the mrl of the item
281 * \param psz_name a text giving a name or description of the item
282 * \return the new item or NULL on failure
284 static inline playlist_item_t * __playlist_ItemNew( vlc_object_t *p_obj,
285 const char *psz_uri, const char *psz_name )
287 /* 0 = ITEM_TYPE_UNKNOWN */
288 return playlist_ItemNewWithType( p_obj, psz_uri, psz_name, 0, NULL, -1,0);
291 #define playlist_ItemNewFromInput(a,b) __playlist_ItemNewFromInput(VLC_OBJECT(a),b)
292 VLC_EXPORT( playlist_item_t *, __playlist_ItemNewFromInput, ( vlc_object_t *p_obj,input_item_t *p_input ) );
294 /*************************** Item deletion **************************/
295 VLC_EXPORT( int, playlist_ItemDelete, ( playlist_item_t * ) );
296 VLC_EXPORT( int, playlist_DeleteAllFromInput, ( playlist_t *, int ) );
297 VLC_EXPORT( int, playlist_DeleteFromInput, ( playlist_t *, int, playlist_item_t *, vlc_bool_t ) );
298 VLC_EXPORT( int, playlist_DeleteFromItemId, ( playlist_t *, int ) );
299 VLC_EXPORT( int, playlist_LockDelete, ( playlist_t *, int ) );
300 VLC_EXPORT( int, playlist_LockDeleteAllFromInput, ( playlist_t *, int ) );
302 /*************************** Item fields accessors **************************/
303 VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, char * ) );
305 /******************** Item addition ********************/
306 VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, int, int, vlc_bool_t ) );
307 VLC_EXPORT( int, playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int, vlc_bool_t ) );
308 VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *,int , int, vlc_bool_t ) );
309 VLC_EXPORT( playlist_item_t *, playlist_NodeAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int ) );
310 VLC_EXPORT( void, playlist_NodeAddItem, ( playlist_t *, playlist_item_t *, playlist_item_t *,int , int ) );
311 VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int ) );
312 VLC_EXPORT( void, playlist_AddWhereverNeeded, (playlist_t* , input_item_t*, playlist_item_t*,playlist_item_t*,vlc_bool_t, int ) );
314 /** Add a MRL into the playlist.
317 static inline int playlist_PlaylistAdd( playlist_t *p_playlist,
318 const char *psz_uri, const char *psz_name,
319 int i_mode, int i_pos )
321 return playlist_Add( p_playlist, psz_uri, psz_name, i_mode, i_pos,
325 /** Add a MRL to the media library
328 static inline int playlist_MLAdd( playlist_t *p_playlist, const char *psz_uri,
329 const char *psz_name, int i_mode, int i_pos )
331 return playlist_Add( p_playlist, psz_uri, psz_name, i_mode, i_pos,
335 /** Add a MRL to the playlist, with duration and options given
336 * \see playlist_AddExt
338 static inline int playlist_PlaylistAddExt( playlist_t *p_playlist,
339 const char * psz_uri, const char *psz_name, int i_mode, int i_pos,
340 mtime_t i_duration, const char **ppsz_options, int i_options )
342 return playlist_AddExt( p_playlist, psz_uri, psz_name, i_mode, i_pos,
343 i_duration, ppsz_options, i_options, VLC_TRUE );
346 /** Add a MRL to the media library, with duration and options given
347 * \see playlist_AddExt
349 static inline int playlist_MLAddExt( playlist_t *p_playlist,
350 const char * psz_uri, const char *psz_name, int i_mode, int i_pos,
351 mtime_t i_duration, const char **ppsz_options, int i_options )
353 return playlist_AddExt( p_playlist, psz_uri, psz_name, i_mode, i_pos,
354 i_duration, ppsz_options, i_options, VLC_FALSE );
357 /** Add an input item to the playlist node
358 * \see playlist_AddInput
360 static inline int playlist_PlaylistAddInput( playlist_t* p_playlist,
361 input_item_t *p_input, int i_mode, int i_pos )
363 return playlist_AddInput( p_playlist, p_input, i_mode, i_pos, VLC_TRUE );
366 /** Add an input item to the media library
367 * \see playlist_AddInput
369 static inline int playlist_MLAddInput( playlist_t* p_playlist,
370 input_item_t *p_input, int i_mode, int i_pos )
372 return playlist_AddInput( p_playlist, p_input, i_mode, i_pos, VLC_FALSE );
375 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id, int i_node_id );
377 /********************** Misc item operations **********************/
378 VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *) );
379 VLC_EXPORT( playlist_item_t*, playlist_LockItemToNode, (playlist_t *,playlist_item_t *) );
381 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
382 int i_input_id, playlist_item_t *p_root );
384 /********************************** Item search *************************/
385 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
386 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) );
388 static inline playlist_item_t *playlist_LockItemGetById( playlist_t *p_playlist,
391 playlist_item_t *p_ret;
392 vlc_mutex_lock( &p_playlist->object_lock );
393 p_ret = playlist_ItemGetById( p_playlist, i_id );
394 vlc_mutex_unlock( &p_playlist->object_lock );
398 static inline playlist_item_t *playlist_LockItemGetByInput(
399 playlist_t *p_playlist, input_item_t *p_item )
401 playlist_item_t *p_ret;
402 vlc_mutex_lock( &p_playlist->object_lock );
403 p_ret = playlist_ItemGetByInput( p_playlist, p_item );
404 vlc_mutex_unlock( &p_playlist->object_lock );
408 VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) );
410 /********************************************************
412 ********************************************************/
413 VLC_EXPORT(void, playlist_NodeDump, ( playlist_t *p_playlist, playlist_item_t *p_item, int i_level ) );
414 VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
416 /* Node management */
417 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, char *, playlist_item_t * p_parent ) );
418 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) );
419 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) );
420 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
421 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
422 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, vlc_bool_t , vlc_bool_t ) );
423 VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, vlc_bool_t ) );
424 VLC_EXPORT( void, playlist_NodesCreateForSD, (playlist_t *, char *, playlist_item_t **, playlist_item_t ** ) );
425 VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) );
427 /* Tree walking - These functions are only for playlist, not plugins */
428 int playlist_GetAllEnabledChildren( playlist_t *p_playlist,
429 playlist_item_t *p_node,
430 playlist_item_t ***ppp_items );
431 playlist_item_t *playlist_GetNextLeaf( playlist_t *p_playlist,
432 playlist_item_t *p_root,
433 playlist_item_t *, vlc_bool_t, vlc_bool_t );
434 playlist_item_t *playlist_GetPrevLeaf( playlist_t *p_playlist,
435 playlist_item_t *p_root,
436 playlist_item_t *, vlc_bool_t, vlc_bool_t );
437 playlist_item_t *playlist_GetLastLeaf( playlist_t *p_playlist,
438 playlist_item_t *p_root );
440 /***********************************************************************
442 ***********************************************************************/
444 /** Tell if the playlist is currently running */
445 static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
447 vlc_bool_t b_playing;
448 vlc_mutex_lock( &p_playlist->object_lock );
449 b_playing = p_playlist->status.i_status == PLAYLIST_RUNNING;
450 vlc_mutex_unlock( &p_playlist->object_lock );
454 /** Tell if the playlist is empty */
455 static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
458 vlc_mutex_lock( &p_playlist->object_lock );
459 b_empty = p_playlist->i_size == 0;
460 vlc_mutex_unlock( &p_playlist->object_lock );
468 #define PLAYLIST_DEBUG 1
470 #ifdef PLAYLIST_DEBUG
471 #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
473 #define PL_DEBUG( msg, args ... ) {}
476 #define PLI_NAME( p ) p ? p->p_input->psz_name : "null"