1 /*****************************************************************************
2 * vlc_playlist.h : Playlist functions
3 *****************************************************************************
4 * Copyright (C) 1999-2004 VideoLAN
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 0x1 /**< Must it be saved */
83 #define PLAYLIST_SKIP_FLAG 0x2 /**< Must playlist skip after it ? */
84 #define PLAYLIST_ENA_FLAG 0x4 /**< Is it enabled ? */
85 #define PLAYLIST_DEL_FLAG 0x8 /**< Autodelete ? */
91 struct playlist_view_t
93 char * psz_name; /**< View name */
94 int i_id; /**< Identifier for the view */
95 playlist_item_t * p_root; /**< Root node */
103 #define VIEW_CATEGORY 1
104 #define VIEW_SIMPLE 2
106 #define VIEW_FIRST_SORTED 4
107 #define VIEW_S_AUTHOR 4
109 #define VIEW_LAST_SORTED 4
111 #define VIEW_FIRST_CUSTOM 100
116 typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
119 struct services_discovery_t
122 const char *psz_module;
126 services_discovery_sys_t *p_sys;
127 void (*pf_run) ( services_discovery_t *);
130 struct playlist_preparse_t
135 input_item_t **pp_waiting;
140 * Structure containing information about the playlist
147 These members are uniq to playlist_t
150 int i_index; /**< current index into the playlist */
151 int i_enabled; /**< How many items are enabled ? */
153 int i_size; /**< total size of the list */
154 playlist_item_t ** pp_items; /**< array of pointers to the
157 int i_views; /**< Number of views */
158 playlist_view_t ** pp_views; /**< array of pointers to the
161 input_thread_t * p_input; /**< the input thread ascosiated
162 * with the current item */
164 mtime_t request_date; /**< Used for profiling */
166 int i_last_id; /**< Last id to an item */
167 int i_sort; /**< Last sorting applied to the playlist */
168 int i_order; /**< Last ordering applied to the playlist */
170 playlist_item_t * p_general; /**< Keep a pointer on the "general"
173 services_discovery_t **pp_sds;
176 vlc_bool_t b_go_next; /*< Go further than the parent node ? */
180 playlist_status_t i_status; /**< Current status of playlist */
182 /* R/O fields, don't touch if you aren't the playlist thread */
184 playlist_item_t * p_item; /**< Currently playing/active item */
185 playlist_item_t * p_node; /**< Current node to play from */
186 int i_view; /**< Current view */
191 /* Playlist thread uses this info to calculate the next position */
192 int i_view; /**< requested view id */
193 playlist_item_t * p_node; /**< requested node to play from */
194 playlist_item_t * p_item; /**< requested item to play in the node */
196 int i_skip; /**< Number of items to skip */
197 int i_goto; /**< Direct index to go to (non-view)*/
199 vlc_bool_t b_request; /**< Set to true by the requester
200 The playlist sets it back to false
201 when processing the request */
202 vlc_mutex_t lock; /**< Lock to protect request */
205 playlist_preparse_t *p_preparse;
210 /* Helper to add an item */
211 struct playlist_add_t
213 playlist_item_t *p_node;
214 playlist_item_t *p_item;
221 #define SORT_TITLE_NODES_FIRST 2
222 #define SORT_AUTHOR 3
223 #define SORT_RANDOM 4
224 #define SORT_DURATION 5
226 #define ORDER_NORMAL 0
227 #define ORDER_REVERSE 1
229 /*****************************************************************************
231 *****************************************************************************/
233 /* Creation/Deletion */
234 #define playlist_Create(a) __playlist_Create(VLC_OBJECT(a))
235 playlist_t * __playlist_Create ( vlc_object_t * );
236 int playlist_Destroy ( playlist_t * );
238 /* Playlist control */
239 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY )
240 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE )
241 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP )
242 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP , 1)
243 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP , -1)
244 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP,i)
245 #define playlist_Goto(p,i) playlist_Control(p,PLAYLIST_GOTO,i)
247 VLC_EXPORT( int, playlist_Control, ( playlist_t *, int, ... ) );
249 VLC_EXPORT( int, playlist_Clear, ( playlist_t * ) );
251 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
253 /* Services discovery */
255 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
256 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
257 VLC_EXPORT( int, playlist_AddSDModules, (playlist_t *, char *));
258 VLC_EXPORT( vlc_bool_t, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
261 /* Item management functions (act on items) */
262 #define playlist_AddItem(p,pi,i1,i2) playlist_ItemAdd(p,pi,i1,i2)
263 #define playlist_ItemNew( a , b, c ) __playlist_ItemNew(VLC_OBJECT(a) , b , c )
264 VLC_EXPORT( playlist_item_t* , __playlist_ItemNew, ( vlc_object_t *,const char *,const char * ) );
265 VLC_EXPORT( int, playlist_ItemDelete, ( playlist_item_t * ) );
266 VLC_EXPORT( int, playlist_ItemAddParent, ( playlist_item_t *, int,playlist_item_t *) );
267 VLC_EXPORT( int, playlist_CopyParents, ( playlist_item_t *,playlist_item_t *) );
268 /* Item informations accessors */
269 VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, char * ) );
270 VLC_EXPORT( int, playlist_ItemSetDuration, (playlist_item_t *, mtime_t ) );
273 /* View management functions */
274 VLC_EXPORT( int, playlist_ViewInsert, (playlist_t *, int, char * ) );
275 VLC_EXPORT( int, playlist_ViewDelete, (playlist_t *,playlist_view_t* ) );
276 VLC_EXPORT( playlist_view_t *, playlist_ViewFind, (playlist_t *, int ) );
277 VLC_EXPORT( int, playlist_ViewUpdate, (playlist_t *, int ) );
278 VLC_EXPORT( int, playlist_ViewDump, (playlist_t *, playlist_view_t * ) );
279 VLC_EXPORT( int, playlist_ViewEmpty, (playlist_t *, int, vlc_bool_t ) );
281 /* Node management */
282 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *,int,char *, playlist_item_t * p_parent ) );
283 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,int,playlist_item_t*,playlist_item_t *) );
284 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,int,playlist_item_t*,playlist_item_t *, int) );
285 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
286 VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
287 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
288 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, vlc_bool_t ) );
289 VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, vlc_bool_t ) );
293 playlist_item_t *playlist_FindNextFromParent( playlist_t *p_playlist,
295 playlist_item_t *p_root,
296 playlist_item_t *p_node,
297 playlist_item_t *p_item );
298 playlist_item_t *playlist_FindPrevFromParent( playlist_t *p_playlist,
300 playlist_item_t *p_root,
301 playlist_item_t *p_node,
302 playlist_item_t *p_item );
305 /* Simple add/remove functions */
306 /* These functions add the item to the "simple" view (+all & category )*/
307 VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, int, int ) );
308 VLC_EXPORT( int, playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int ) );
309 VLC_EXPORT( int, playlist_ItemAdd, ( playlist_t *, playlist_item_t *, int, int ) );
310 VLC_EXPORT(int, playlist_NodeAddItem, ( playlist_t *, playlist_item_t *,int,playlist_item_t *,int , int ) );
312 /* Misc item operations (act on item+playlist) */
313 VLC_EXPORT( int, playlist_Delete, ( playlist_t *, int ) );
314 VLC_EXPORT( int, playlist_Disable, ( playlist_t *, playlist_item_t * ) );
315 VLC_EXPORT( int, playlist_Enable, ( playlist_t *, playlist_item_t * ) );
316 VLC_EXPORT( int, playlist_ItemToNode, (playlist_t *,playlist_item_t *) );
317 VLC_EXPORT( int, playlist_Replace, (playlist_t *,playlist_item_t *, input_item_t*) );
320 /* Item search functions */
321 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
322 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByPos, (playlist_t *, int) );
323 VLC_EXPORT( int, playlist_GetPositionById, (playlist_t *,int ) );
324 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) );
327 VLC_EXPORT( char * , playlist_GetInfo, ( playlist_t * , int, const char *, const char *) );
328 VLC_EXPORT( char * , playlist_ItemGetInfo, ( playlist_item_t * , const char *, const char *) );
330 VLC_EXPORT( info_category_t*, playlist_ItemGetCategory, ( playlist_item_t *, const char *) );
332 VLC_EXPORT( info_category_t*, playlist_ItemCreateCategory, ( playlist_item_t *, const char *) );
334 VLC_EXPORT( int, playlist_AddInfo, (playlist_t *, int, const char * , const char *, const char *, ...) );
335 VLC_EXPORT( int, playlist_ItemAddInfo, (playlist_item_t *, const char * , const char *, const char *, ...) );
336 VLC_EXPORT( int, playlist_ItemAddOption, (playlist_item_t *, const char *) );
338 /* Playlist sorting */
339 #define playlist_SortID(p, i) playlist_Sort( p, SORT_ID, i)
340 #define playlist_SortTitle(p, i) playlist_Sort( p, SORT_TITLE, i)
341 #define playlist_SortAuthor(p, i) playlist_Sort( p, SORT_AUTHOR, i)
342 #define playlist_SortGroup(p, i) playlist_Sort( p, SORT_GROUP, i)
343 VLC_EXPORT( int, playlist_Sort, ( playlist_t *, int, int) );
344 VLC_EXPORT( int, playlist_Move, ( playlist_t *, int, int ) );
345 VLC_EXPORT( int, playlist_NodeGroup, ( playlist_t *, int,playlist_item_t *,playlist_item_t **,int, int, int ) );
346 VLC_EXPORT( int, playlist_NodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
347 VLC_EXPORT( int, playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
350 VLC_EXPORT( int, playlist_Import, ( playlist_t *, const char * ) );
351 VLC_EXPORT( int, playlist_Export, ( playlist_t *, const char *, const char * ) );
353 /***********************************************************************
355 ***********************************************************************/
359 * tell if a playlist is currently playing.
360 * \param p_playlist the playlist to check
361 * \return true if playlist is playing, false otherwise
363 static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
365 vlc_bool_t b_playing;
367 vlc_mutex_lock( &p_playlist->object_lock );
368 b_playing = p_playlist->status.i_status == PLAYLIST_RUNNING;
369 vlc_mutex_unlock( &p_playlist->object_lock );
375 * tell if a playlist is currently empty
376 * \param p_playlist the playlist to check
377 * \return true if the playlist is empty, false otherwise
379 static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
383 vlc_mutex_lock( &p_playlist->object_lock );
384 b_empty = p_playlist->i_size == 0;
385 vlc_mutex_unlock( &p_playlist->object_lock );