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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
26 * This file contain structures and function prototypes related
27 * to the playlist in vlc
31 * \defgroup vlc_playlist Playlist
32 * Brief description. Longer description
37 * playlist export helper structure
39 struct playlist_export_t
48 playlist_item_t *p_parent;
52 * playlist item / node
55 struct playlist_item_t
57 input_item_t input; /**< input item descriptor */
59 /* Tree specific fields */
60 int i_children; /**< Number of children
62 playlist_item_t **pp_children; /**< Children nodes/items */
63 int i_parents; /**< Number of parents */
64 struct item_parent_t **pp_parents; /**< Parents */
65 int i_serial; /**< Has this node been updated ? */
67 uint8_t i_flags; /**< Flags */
70 int i_nb_played; /**< How many times was this item played ? */
73 vlc_bool_t b_autodeletion; /**< Indicates whther this item is to
74 * be deleted after playback. True mean
75 * that this item is to be deleted
76 * after playback, false otherwise */
77 vlc_bool_t b_enabled; /**< Indicates whether this item is to be
78 * played or skipped */
79 /* END LEGACY FIELDS */
82 #define PLAYLIST_SAVE_FLAG 0x01 /**< Must it be saved */
83 #define PLAYLIST_SKIP_FLAG 0x02 /**< Must playlist skip after it ? */
84 #define PLAYLIST_ENA_FLAG 0x04 /**< Is it enabled ? */
85 #define PLAYLIST_DEL_FLAG 0x08 /**< Autodelete ? */
86 #define PLAYLIST_RO_FLAG 0x10 /**< Write-enabled ? */
87 #define PLAYLIST_REMOVE_FLAG 0x20 /**< Remove this item at the end */
93 struct playlist_view_t
95 char * psz_name; /**< View name */
96 int i_id; /**< Identifier for the view */
97 playlist_item_t * p_root; /**< Root node */
105 #define VIEW_CATEGORY 1
106 #define VIEW_SIMPLE 2
108 #define VIEW_FIRST_SORTED 4
109 #define VIEW_S_AUTHOR 4
110 #define VIEW_S_GENRE 5
111 #define VIEW_S_ALBUM 6
113 #define VIEW_LAST_SORTED 10
115 #define VIEW_FIRST_CUSTOM 100
120 typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
123 struct services_discovery_t
130 services_discovery_sys_t *p_sys;
131 void (*pf_run) ( services_discovery_t *);
134 struct playlist_preparse_t
139 input_item_t **pp_waiting;
144 * Structure containing information about the playlist
151 These members are uniq to playlist_t
154 int i_index; /**< current index into the playlist */
155 int i_enabled; /**< How many items are enabled ? */
157 int i_size; /**< total size of the list */
158 playlist_item_t ** pp_items; /**< array of pointers to the
160 int i_all_size; /**< size of list of items and nodes */
161 playlist_item_t ** pp_all_items; /**< array of pointers to the
162 * playlist items and nodes */
164 int i_views; /**< Number of views */
165 playlist_view_t ** pp_views; /**< array of pointers to the
168 input_thread_t * p_input; /**< the input thread ascosiated
169 * with the current item */
171 mtime_t request_date; /**< Used for profiling */
173 int i_last_id; /**< Last id to an item */
174 int i_sort; /**< Last sorting applied to the playlist */
175 int i_order; /**< Last ordering applied to the playlist */
177 playlist_item_t * p_general; /**< Keep a pointer on the "general"
180 services_discovery_t **pp_sds;
183 vlc_bool_t b_go_next; /*< Go further than the parent node ? */
187 playlist_status_t i_status; /**< Current status of playlist */
189 /* R/O fields, don't touch if you aren't the playlist thread */
191 playlist_item_t * p_item; /**< Currently playing/active item */
192 playlist_item_t * p_node; /**< Current node to play from */
193 int i_view; /**< Current view */
198 /* Playlist thread uses this info to calculate the next position */
199 int i_view; /**< requested view id */
200 playlist_item_t * p_node; /**< requested node to play from */
201 playlist_item_t * p_item; /**< requested item to play in the node */
203 int i_skip; /**< Number of items to skip */
204 int i_goto; /**< Direct index to go to (non-view)*/
206 vlc_bool_t b_request; /**< Set to true by the requester
207 The playlist sets it back to false
208 when processing the request */
209 vlc_mutex_t lock; /**< Lock to protect request */
212 playlist_preparse_t *p_preparse;
214 vlc_mutex_t gc_lock; /**< Lock to protect the garbage collection */
219 /* Helper to add an item */
220 struct playlist_add_t
230 #define SORT_TITLE_NODES_FIRST 2
231 #define SORT_AUTHOR 3
233 #define SORT_RANDOM 5
234 #define SORT_DURATION 6
235 #define SORT_TITLE_NUMERIC 7
238 #define ORDER_NORMAL 0
239 #define ORDER_REVERSE 1
241 /*****************************************************************************
243 *****************************************************************************/
245 /* Creation/Deletion */
246 #define playlist_Create(a) __playlist_Create(VLC_OBJECT(a))
247 playlist_t * __playlist_Create ( vlc_object_t * );
248 int playlist_Destroy ( playlist_t * );
250 /* Playlist control */
251 #define playlist_Play(p) playlist_LockControl(p,PLAYLIST_PLAY )
252 #define playlist_Pause(p) playlist_LockControl(p,PLAYLIST_PAUSE )
253 #define playlist_Stop(p) playlist_LockControl(p,PLAYLIST_STOP )
254 #define playlist_Next(p) playlist_LockControl(p,PLAYLIST_SKIP, 1)
255 #define playlist_Prev(p) playlist_LockControl(p,PLAYLIST_SKIP, -1)
256 #define playlist_Skip(p,i) playlist_LockControl(p,PLAYLIST_SKIP, i)
257 #define playlist_Goto(p,i) playlist_LockControl(p,PLAYLIST_GOTO, i)
259 VLC_EXPORT( int, playlist_Control, ( playlist_t *, int, ... ) );
260 VLC_EXPORT( int, playlist_LockControl, ( playlist_t *, int, ... ) );
262 VLC_EXPORT( int, playlist_Clear, ( playlist_t * ) );
263 VLC_EXPORT( int, playlist_LockClear, ( playlist_t * ) );
265 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
266 VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) );
268 /* Services discovery */
270 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
271 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
272 VLC_EXPORT( int, playlist_AddSDModules, (playlist_t *, char *));
273 VLC_EXPORT( vlc_bool_t, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
276 /* Item management functions (act on items) */
277 #define playlist_AddItem(p,pi,i1,i2) playlist_ItemAdd(p,pi,i1,i2)
278 #define playlist_ItemNew( a , b, c ) __playlist_ItemNew(VLC_OBJECT(a) , b , c )
279 #define playlist_ItemCopy( a, b ) __playlist_ItemCopy(VLC_OBJECT(a), b )
280 VLC_EXPORT( playlist_item_t* , __playlist_ItemNew, ( vlc_object_t *,const char *,const char * ) );
281 VLC_EXPORT( playlist_item_t* , __playlist_ItemCopy, ( vlc_object_t *,playlist_item_t* ) );
282 VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int ) );
283 VLC_EXPORT( int, playlist_ItemDelete, ( playlist_item_t * ) );
284 VLC_EXPORT( int, playlist_ItemAddParent, ( playlist_item_t *, int,playlist_item_t *) );
285 VLC_EXPORT( int, playlist_CopyParents, ( playlist_item_t *,playlist_item_t *) );
286 /* Item informations accessors */
287 VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, char * ) );
288 VLC_EXPORT( int, playlist_ItemSetDuration, (playlist_item_t *, mtime_t ) );
291 /* View management functions */
292 VLC_EXPORT( int, playlist_ViewInsert, (playlist_t *, int, char * ) );
293 VLC_EXPORT( int, playlist_ViewDelete, (playlist_t *,playlist_view_t* ) );
294 VLC_EXPORT( playlist_view_t *, playlist_ViewFind, (playlist_t *, int ) );
295 VLC_EXPORT( int, playlist_ViewUpdate, (playlist_t *, int ) );
296 VLC_EXPORT( int, playlist_ViewDump, (playlist_t *, playlist_view_t * ) );
297 VLC_EXPORT( int, playlist_ViewEmpty, (playlist_t *, int, vlc_bool_t ) );
299 /* Node management */
300 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *,int,char *, playlist_item_t * p_parent ) );
301 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,int,playlist_item_t*,playlist_item_t *) );
302 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,int,playlist_item_t*,playlist_item_t *, int) );
303 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
304 VLC_EXPORT( int, playlist_NodeRemoveParent, (playlist_t *,playlist_item_t*,playlist_item_t *) );
305 VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
306 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
307 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, vlc_bool_t , vlc_bool_t ) );
308 VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, vlc_bool_t ) );
311 playlist_item_t *playlist_FindNextFromParent( playlist_t *p_playlist,
313 playlist_item_t *p_root,
314 playlist_item_t *p_node,
315 playlist_item_t *p_item );
316 playlist_item_t *playlist_FindPrevFromParent( playlist_t *p_playlist,
318 playlist_item_t *p_root,
319 playlist_item_t *p_node,
320 playlist_item_t *p_item );
323 /* Simple add/remove functions */
324 /* These functions add the item to the "simple" view (+all & category )*/
325 VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, int, int ) );
326 VLC_EXPORT( int, playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int ) );
327 VLC_EXPORT( int, playlist_ItemAdd, ( playlist_t *, playlist_item_t *, int, int ) );
328 VLC_EXPORT(int, playlist_NodeAddItem, ( playlist_t *, playlist_item_t *,int,playlist_item_t *,int , int ) );
330 /* Misc item operations (act on item+playlist) */
331 VLC_EXPORT( int, playlist_Delete, ( playlist_t *, int ) );
332 VLC_EXPORT( int, playlist_LockDelete, ( playlist_t *, int ) );
333 VLC_EXPORT( int, playlist_Disable, ( playlist_t *, playlist_item_t * ) );
334 VLC_EXPORT( int, playlist_Enable, ( playlist_t *, playlist_item_t * ) );
335 VLC_EXPORT( int, playlist_ItemToNode, (playlist_t *,playlist_item_t *) );
336 VLC_EXPORT( int, playlist_LockItemToNode, (playlist_t *,playlist_item_t *) );
337 VLC_EXPORT( int, playlist_Replace, (playlist_t *,playlist_item_t *, input_item_t*) );
338 VLC_EXPORT( int, playlist_LockReplace, (playlist_t *,playlist_item_t *, input_item_t*) );
341 /* Item search functions */
342 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
343 VLC_EXPORT( playlist_item_t *, playlist_LockItemGetById, (playlist_t *, int) );
344 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByPos, (playlist_t *, int) );
345 VLC_EXPORT( playlist_item_t *, playlist_LockItemGetByPos, (playlist_t *, int) );
346 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) );
347 VLC_EXPORT( playlist_item_t *, playlist_LockItemGetByInput, (playlist_t *,input_item_t * ) );
348 VLC_EXPORT( int, playlist_GetPositionById, (playlist_t *,int ) );
350 VLC_EXPORT( int, playlist_ItemAddOption, (playlist_item_t *, const char *) );
352 /* Playlist sorting */
353 #define playlist_SortID(p, i) playlist_Sort( p, SORT_ID, i)
354 #define playlist_SortTitle(p, i) playlist_Sort( p, SORT_TITLE, i)
355 #define playlist_SortAuthor(p, i) playlist_Sort( p, SORT_AUTHOR, i)
356 #define playlist_SortAlbum(p, i) playlist_Sort( p, SORT_ALBUM, i)
357 #define playlist_SortGroup(p, i) playlist_Sort( p, SORT_GROUP, i)
358 VLC_EXPORT( int, playlist_Sort, ( playlist_t *, int, int) );
359 VLC_EXPORT( int, playlist_Move, ( playlist_t *, int, int ) );
360 VLC_EXPORT( int, playlist_NodeGroup, ( playlist_t *, int,playlist_item_t *,playlist_item_t **,int, int, int ) );
361 VLC_EXPORT( int, playlist_NodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
362 VLC_EXPORT( int, playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
365 VLC_EXPORT( int, playlist_Import, ( playlist_t *, const char * ) );
366 VLC_EXPORT( int, playlist_Export, ( playlist_t *, const char *, const char * ) );
368 /***********************************************************************
370 ***********************************************************************/
374 * tell if a playlist is currently playing.
375 * \param p_playlist the playlist to check
376 * \return true if playlist is playing, false otherwise
378 static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
380 vlc_bool_t b_playing;
382 vlc_mutex_lock( &p_playlist->object_lock );
383 b_playing = p_playlist->status.i_status == PLAYLIST_RUNNING;
384 vlc_mutex_unlock( &p_playlist->object_lock );
390 * tell if a playlist is currently empty
391 * \param p_playlist the playlist to check
392 * \return true if the playlist is empty, false otherwise
394 static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
398 vlc_mutex_lock( &p_playlist->object_lock );
399 b_empty = p_playlist->i_size == 0;
400 vlc_mutex_unlock( &p_playlist->object_lock );