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 ? */
71 vlc_bool_t b_autodeletion; /**< Indicates whther this item is to
72 * be deleted after playback. True mean
73 * that this item is to be deleted
74 * after playback, false otherwise */
75 vlc_bool_t b_enabled; /**< Indicates whether this item is to be
76 * played or skipped */
79 #define PLAYLIST_SAVE_FLAG 0x1 /**< Must it be saved */
80 #define PLAYLIST_SKIP_FLAG 0x2 /**< Must playlist skip after it ? */
81 #define PLAYLIST_ENA_FLAG 0x4 /**< Is it enabled ? */
82 #define PLAYLIST_DEL_FLAG 0x8 /**< Autodelete ? */
88 struct playlist_view_t
90 char * psz_name; /**< View name */
91 int i_id; /**< Identifier for the view */
92 playlist_item_t * p_root; /**< Root node */
100 #define VIEW_CATEGORY 1
101 #define VIEW_SIMPLE 2
103 #define VIEW_FIRST_SORTED 4
104 #define VIEW_S_AUTHOR 4
106 #define VIEW_LAST_SORTED 4
108 #define VIEW_FIRST_CUSTOM 100
113 typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
116 * Structure containing information about the playlist
123 These members are uniq to playlist_t
126 int i_index; /**< current index into the playlist */
127 int i_enabled; /**< How many items are enabled ? */
129 int i_size; /**< total size of the list */
130 playlist_item_t ** pp_items; /**< array of pointers to the
133 int i_views; /**< Number of views */
134 playlist_view_t ** pp_views; /**< array of pointers to the
137 input_thread_t * p_input; /**< the input thread ascosiated
138 * with the current item */
140 mtime_t request_date; /**< Used for profiling */
142 int i_last_id; /**< Last id to an item */
143 int i_sort; /**< Last sorting applied to the playlist */
144 int i_order; /**< Last ordering applied to the playlist */
146 playlist_item_t * p_general; /**< Keep a pointer on the "general"
149 vlc_bool_t b_go_next; /*< Go further than the parent node ? */
153 playlist_status_t i_status; /**< Current status of playlist */
155 /* R/O fields, don't touch if you aren't the playlist thread */
157 playlist_item_t * p_item; /**< Currently playing/active item */
158 playlist_item_t * p_node; /**< Current node to play from */
159 int i_view; /**< Current view */
164 /* Playlist thread uses this info to calculate the next position */
165 int i_view; /**< requested view id */
166 playlist_item_t * p_node; /**< requested node to play from */
167 playlist_item_t * p_item; /**< requested item to play in the node */
169 int i_skip; /**< Number of items to skip */
170 int i_goto; /**< Direct index to go to (non-view)*/
172 vlc_bool_t b_request; /**< Set to true by the requester
173 The playlist sets it back to false
174 when processing the request */
175 vlc_mutex_t lock; /**< Lock to protect request */
183 #define SORT_AUTHOR 2
184 #define SORT_RANDOM 4
185 #define SORT_DURATION 5
187 #define ORDER_NORMAL 0
188 #define ORDER_REVERSE 1
190 /*****************************************************************************
192 *****************************************************************************/
194 /* Creation/Deletion */
195 #define playlist_Create(a) __playlist_Create(VLC_OBJECT(a))
196 playlist_t * __playlist_Create ( vlc_object_t * );
197 void playlist_Destroy ( playlist_t * );
199 /* Playlist control */
200 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY )
201 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE )
202 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP )
203 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP , 1)
204 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP , -1)
205 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP,i)
206 #define playlist_Goto(p,i) playlist_Control(p,PLAYLIST_GOTO,i)
208 VLC_EXPORT( int, playlist_Control, ( playlist_t *, int, ... ) );
210 VLC_EXPORT( int, playlist_Clear, ( playlist_t * ) );
213 /* Item management functions (act on items) */
214 #define playlist_AddItem(p,pi,i1,i2) playlist_ItemAdd(p,pi,i1,i2)
215 #define playlist_ItemNew( a , b, c ) __playlist_ItemNew(VLC_OBJECT(a) , b , c )
216 VLC_EXPORT( playlist_item_t* , __playlist_ItemNew, ( vlc_object_t *,const char *,const char * ) );
217 VLC_EXPORT( void, playlist_ItemDelete, ( playlist_item_t * ) );
218 VLC_EXPORT( void, playlist_ItemAddParent, ( playlist_item_t *, int,playlist_item_t *) );
219 /* Item informations accessors */
220 VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, char * ) );
221 VLC_EXPORT( int, playlist_ItemSetDuration, (playlist_item_t *, mtime_t ) );
224 /* View management functions */
225 VLC_EXPORT( int, playlist_ViewInsert, (playlist_t *, int, char * ) );
226 VLC_EXPORT( void, playlist_ViewDelete, (playlist_t *,playlist_view_t* ) );
227 VLC_EXPORT( playlist_view_t *, playlist_ViewFind, (playlist_t *, int ) );
228 VLC_EXPORT( int, playlist_ViewUpdate, (playlist_t *, int ) );
229 VLC_EXPORT( void, playlist_ViewDump, (playlist_t *, playlist_view_t * ) );
230 VLC_EXPORT( int, playlist_ViewEmpty, (playlist_t *, int, vlc_bool_t ) );
232 /* Node management */
233 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *,int,char *, playlist_item_t * p_parent ) );
234 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,int,playlist_item_t*,playlist_item_t *) );
235 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,int,playlist_item_t*,playlist_item_t *, int) );
236 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
237 VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
238 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
239 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, vlc_bool_t ) );
240 VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, vlc_bool_t ) );
244 playlist_item_t *playlist_FindNextFromParent( playlist_t *p_playlist,
246 playlist_item_t *p_root,
247 playlist_item_t *p_node,
248 playlist_item_t *p_item );
249 playlist_item_t *playlist_FindPrevFromParent( playlist_t *p_playlist,
251 playlist_item_t *p_root,
252 playlist_item_t *p_node,
253 playlist_item_t *p_item );
256 /* Simple add/remove functions */
257 /* These functions add the item to the "simple" view (+all & category )*/
258 VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, int, int ) );
259 VLC_EXPORT( int, playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int ) );
260 VLC_EXPORT( int, playlist_ItemAdd, ( playlist_t *, playlist_item_t *, int, int ) );
261 VLC_EXPORT(int, playlist_NodeAddItem, ( playlist_t *, playlist_item_t *,int,playlist_item_t *,int , int ) );
263 /* Misc item operations (act on item+playlist) */
264 VLC_EXPORT( int, playlist_Delete, ( playlist_t *, int ) );
265 VLC_EXPORT( int, playlist_Disable, ( playlist_t *, playlist_item_t * ) );
266 VLC_EXPORT( int, playlist_Enable, ( playlist_t *, playlist_item_t * ) );
267 VLC_EXPORT( void, playlist_ItemToNode, (playlist_t *,playlist_item_t *) );
270 /* Item search functions */
271 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
272 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByPos, (playlist_t *, int) );
273 VLC_EXPORT( int, playlist_GetPositionById, (playlist_t *,int ) );
276 VLC_EXPORT( char * , playlist_GetInfo, ( playlist_t * , int, const char *, const char *) );
277 VLC_EXPORT( char * , playlist_ItemGetInfo, ( playlist_item_t * , const char *, const char *) );
279 VLC_EXPORT( info_category_t*, playlist_ItemGetCategory, ( playlist_item_t *, const char *) );
281 VLC_EXPORT( info_category_t*, playlist_ItemCreateCategory, ( playlist_item_t *, const char *) );
283 VLC_EXPORT( int, playlist_AddInfo, (playlist_t *, int, const char * , const char *, const char *, ...) );
284 VLC_EXPORT( int, playlist_ItemAddInfo, (playlist_item_t *, const char * , const char *, const char *, ...) );
285 VLC_EXPORT( int, playlist_ItemAddOption, (playlist_item_t *, const char *) );
287 /* Playlist sorting */
288 #define playlist_SortID(p, i) playlist_Sort( p, SORT_ID, i)
289 #define playlist_SortTitle(p, i) playlist_Sort( p, SORT_TITLE, i)
290 #define playlist_SortAuthor(p, i) playlist_Sort( p, SORT_AUTHOR, i)
291 #define playlist_SortGroup(p, i) playlist_Sort( p, SORT_GROUP, i)
292 VLC_EXPORT( int, playlist_Sort, ( playlist_t *, int, int) );
293 VLC_EXPORT( int, playlist_Move, ( playlist_t *, int, int ) );
294 VLC_EXPORT( int, playlist_NodeGroup, ( playlist_t *, int,playlist_item_t *,playlist_item_t **,int, int, int ) );
297 VLC_EXPORT( int, playlist_Import, ( playlist_t *, const char * ) );
298 VLC_EXPORT( int, playlist_Export, ( playlist_t *, const char *, const char * ) );
300 /***********************************************************************
302 ***********************************************************************/
306 * tell if a playlist is currently playing.
307 * \param p_playlist the playlist to check
308 * \return true if playlist is playing, false otherwise
310 static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
312 vlc_bool_t b_playing;
314 vlc_mutex_lock( &p_playlist->object_lock );
315 b_playing = p_playlist->status.i_status == PLAYLIST_RUNNING;
316 vlc_mutex_unlock( &p_playlist->object_lock );
322 * tell if a playlist is currently empty
323 * \param p_playlist the playlist to check
324 * \return true if the playlist is empty, false otherwise
326 static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
330 vlc_mutex_lock( &p_playlist->object_lock );
331 b_empty = p_playlist->i_size == 0;
332 vlc_mutex_unlock( &p_playlist->object_lock );