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_
31 #include <vlc_input.h>
32 #include <vlc_events.h>
33 #include <vlc_services_discovery.h>
37 TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t);
41 * This file contain structures and function prototypes related
42 * to the playlist in vlc
44 * \defgroup vlc_playlist Playlist
46 * The VLC playlist system has a tree structure. This allows advanced
47 * categorization, like for SAP streams (which are grouped by "sap groups").
49 * The base structure for all playlist operations is the input_item_t. This
50 * contains all information needed to play a stream and get info, ie, mostly,
51 * mrl and metadata. This structure contains a unique i_id field. ids are
52 * not recycled when an item is destroyed.
54 * Input items are not used directly, but through playlist items.
55 * The playlist items are themselves in a tree structure. They only contain
56 * a link to the input item, a unique id and a few flags. the playlist
57 * item id is NOT the same as the input item id.
58 * Several playlist items can be attached to a single input item. The input
59 * item is refcounted and is automatically destroyed when it is not used
62 * In the playlist itself, there are two trees, that should always be kept
63 * in sync. The "category" tree contains the whole tree structure with
64 * several levels, while the onelevel tree contains only one level :), ie
65 * it only contains "real" items, not nodes
66 * For example, if you open a directory, you will have
68 * Category tree: Onelevel tree:
75 * The top-level items of both tree are the same, and they are reproduced
76 * in the left-part of the playlist GUIs, they are the "sources" from the
77 * source selectors. Top-level items include: playlist, media library, SAP,
78 * Shoutcast, devices, ...
80 * It is envisioned that a third tree will appear: VLM, but it's not done yet
82 * The playlist also stores, for utility purposes, an array of all input
83 * items, an array of all playlist items and an array of all playlist items
84 * and nodes (both are represented by the same structure).
86 * So, here is an example:
89 * - input 1 -> name = foo 1 uri = ...
90 * - input 2 -> name = foo 2 uri = ...
92 * Category tree Onelevel tree
93 * - playlist (id 1) - playlist (id 3)
94 * - category 1 (id 2) - foo 2 (id 8 - input 2)
95 * - foo 2 (id 6 - input 2) - media library (id 4)
96 * - media library (id 2) - foo 1 (id6 - input 1)
97 * - foo 1 (id 5 - input 1)
99 * Sometimes, an item must be transformed to a node. This happens for the
100 * directory access for example. In that case, the item is removed from
101 * the onelevel tree, as it is not a real item anymore.
103 * For "standard" item addition, you can use playlist_Add, playlist_AddExt
104 * (more options) or playlist_AddInput if you already created your input
105 * item. This will add the item at the root of "Playlist" or of "Media library"
106 * in each of the two trees.
108 * If you want more control (like, adding the item as the child of a given
109 * node in the category tree, use playlist_BothAddInput. You'll have to provide
110 * the node in the category tree. The item will be added as a child of
111 * this node in the category tree, and as a child of the matching top-level
112 * node in the onelevel tree. (Nodes are created with playlist_NodeCreate)
114 * Generally speaking, playlist_NodeAddInput should not be used in newer code, it
115 * will maybe become useful again when we merge VLM;
117 * To delete an item, use playlist_DeleteFromInput( input_id ) which will
118 * remove all occurrences of the input in both trees
123 /** Helper structure to export to file part of the playlist */
124 struct playlist_export_t
128 playlist_item_t *p_root;
131 /** playlist item / node */
132 struct playlist_item_t
134 input_item_t *p_input; /**< Linked input item */
135 /** Number of children, -1 if not a node */
137 playlist_item_t **pp_children; /**< Children nodes/items */
138 playlist_item_t *p_parent; /**< Item parent */
140 int i_id; /**< Playlist item specific id */
141 uint8_t i_flags; /**< Flags */
142 playlist_t *p_playlist; /**< Parent playlist */
145 #define PLAYLIST_SAVE_FLAG 0x0001 /**< Must it be saved */
146 #define PLAYLIST_SKIP_FLAG 0x0002 /**< Must playlist skip after it ? */
147 #define PLAYLIST_DBL_FLAG 0x0004 /**< Is it disabled ? */
148 #define PLAYLIST_RO_FLAG 0x0008 /**< Write-enabled ? */
149 #define PLAYLIST_REMOVE_FLAG 0x0010 /**< Remove this item at the end */
150 #define PLAYLIST_EXPANDED_FLAG 0x0020 /**< Expanded node */
152 /** Playlist status */
154 { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
156 /** Structure containing information about the playlist */
161 playlist_item_array_t items; /**< Arrays of items */
162 playlist_item_array_t all_items; /**< Array of items and nodes */
164 playlist_item_array_t current; /**< Items currently being played */
165 int i_current_index; /**< Index in current array */
166 /** Reset current item array */
167 bool b_reset_currently_playing;
168 mtime_t last_rebuild_date;
170 int i_last_playlist_id; /**< Last id to an item */
172 /* Predefined items */
173 playlist_item_t * p_root_category; /**< Root of category tree */
174 playlist_item_t * p_root_onelevel; /**< Root of onelevel tree */
175 playlist_item_t * p_local_category; /** < "Playlist" in CATEGORY view */
176 playlist_item_t * p_ml_category; /** < "Library" in CATEGORY view */
177 playlist_item_t * p_local_onelevel; /** < "Playlist" in ONELEVEL view */
178 playlist_item_t * p_ml_onelevel; /** < "Library" in ONELEVEL view */
181 int i_sort; /**< Last sorting applied to the playlist */
182 int i_order; /**< Last ordering applied to the playlist */
188 /** Helper to add an item */
189 struct playlist_add_t
198 #define SORT_TITLE_NODES_FIRST 2
199 #define SORT_ARTIST 3
201 #define SORT_RANDOM 5
202 #define SORT_DURATION 6
203 #define SORT_TITLE_NUMERIC 7
205 #define SORT_TRACK_NUMBER 9
206 #define SORT_DESCRIPTION 10
207 #define SORT_RATING 11
210 #define ORDER_NORMAL 0
211 #define ORDER_REVERSE 1
213 /* Used by playlist_Import */
214 #define PLAYLIST_INSERT 0x0001
215 #define PLAYLIST_APPEND 0x0002
216 #define PLAYLIST_GO 0x0004
217 #define PLAYLIST_PREPARSE 0x0008
218 #define PLAYLIST_SPREPARSE 0x0010
219 #define PLAYLIST_NO_REBUILD 0x0020
221 #define PLAYLIST_END -666
229 /*****************************************************************************
231 *****************************************************************************/
234 #define PL_LOCK vlc_object_lock( p_playlist )
235 #define PL_UNLOCK vlc_object_unlock( p_playlist )
237 VLC_EXPORT( playlist_t *, __pl_Hold, ( vlc_object_t * ) );
238 #define pl_Hold( a ) __pl_Hold( VLC_OBJECT(a) )
240 VLC_EXPORT( void, __pl_Release, ( vlc_object_t * ) );
241 #define pl_Release(a) __pl_Release( VLC_OBJECT(a) )
243 /* Playlist control */
244 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
245 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
246 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
247 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
248 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
249 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, i)
252 * Do a playlist action.
253 * If there is something in the playlist then you can do playlist actions.
254 * Possible queries are listed in vlc_common.h
255 * \param p_playlist the playlist to do the command on
256 * \param i_query the command to do
257 * \param b_locked TRUE if playlist is locked when entering this function
258 * \param variable number of arguments
259 * \return VLC_SUCCESS or an error
261 VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, bool b_locked, ... ) );
263 /** Get current playing input. The object is retained.
265 VLC_EXPORT( input_thread_t *, playlist_CurrentInput, ( playlist_t *p_playlist ) );
267 /** Clear the playlist
268 * \param b_locked TRUE if playlist is locked when entering this function
270 VLC_EXPORT( void, playlist_Clear, ( playlist_t *, bool ) );
272 /** Enqueue an input item for preparsing */
273 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
275 /** Enqueue a playlist item and all of its children if any for preparsing */
276 VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) );
277 /** Request the art for an input item to be fetched */
278 VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *) );
280 /* Playlist sorting */
281 VLC_EXPORT( int, playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
282 VLC_EXPORT( int, playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
284 VLC_EXPORT( playlist_item_t *, playlist_CurrentPlayingItem, ( playlist_t * ) );
285 VLC_EXPORT( int, playlist_CurrentId, ( playlist_t * ) );
286 VLC_EXPORT( bool, playlist_IsPlaying, ( playlist_t * ) );
287 VLC_EXPORT( int, playlist_Status, ( playlist_t * ) );
290 * Export a node of the playlist to a certain type of playlistfile
291 * \param p_playlist the playlist to export
292 * \param psz_filename the location where the exported file will be saved
293 * \param p_export_root the root node to export
294 * \param psz_type the type of playlist file to create (m3u, pls, ..)
295 * \return VLC_SUCCESS on success
297 VLC_EXPORT( int, playlist_Export, ( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type ) );
299 /********************** Services discovery ***********************/
301 /** Add a list of comma-separated service discovery modules */
302 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
303 /** Remove a services discovery module by name */
304 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
305 /** Check whether a given SD is loaded */
306 VLC_EXPORT( bool, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
310 /********************************************************
312 ********************************************************/
314 /*************************** Item creation **************************/
316 VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( playlist_t *,const char *,const char *, int , const char *const *, int, int) );
318 /** Create a new item, without adding it to the playlist
319 * \param p_obj a vlc object (anyone will do)
320 * \param psz_uri the mrl of the item
321 * \param psz_name a text giving a name or description of the item
322 * \return the new item or NULL on failure
324 #define playlist_ItemNew( a , b, c ) \
325 playlist_ItemNewWithType( VLC_OBJECT(a) , b , c, 0, NULL, -1, 0 )
328 /*************************** Item deletion **************************/
329 VLC_EXPORT( int, playlist_DeleteFromInput, ( playlist_t *, int, bool ) );
331 /*************************** Item fields accessors **************************/
332 VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, const char * ) );
334 /******************** Item addition ********************/
335 VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, int, int, bool, bool ) );
336 VLC_EXPORT( int, playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char *const *,int, bool, bool ) );
337 VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, bool, bool ) );
338 VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int*, bool ) );
340 /********************** Misc item operations **********************/
341 VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *, bool) );
343 /********************************** Item search *************************/
344 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int, bool ) );
345 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t *, bool ) );
346 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInputId, (playlist_t *, int, playlist_item_t *) );
348 VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) );
350 /********************************************************
352 ********************************************************/
353 VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
355 /* Node management */
356 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_flags, input_item_t * ) );
357 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) );
358 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) );
359 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
360 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
361 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, bool , bool ) );
362 VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, bool ) );
363 VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, const char *, playlist_item_t **, playlist_item_t **, bool ) );
364 VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) );
365 VLC_EXPORT( playlist_item_t *, playlist_GetNextLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, bool b_ena, bool b_unplayed ) );
366 VLC_EXPORT( playlist_item_t *, playlist_GetPrevLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, bool b_ena, bool b_unplayed ) );
367 VLC_EXPORT( playlist_item_t *, playlist_GetLastLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root ) );
369 /***********************************************************************
371 ***********************************************************************/
372 /** Open a playlist file, add its content to the current playlist */
373 static inline int playlist_Import( playlist_t *p_playlist, const char *psz_file)
375 char psz_uri[256+10];
376 input_item_t *p_input;
377 snprintf( psz_uri, 256+9, "file/://%s", psz_file );
378 const char *const psz_option = "meta-file";
379 p_input = input_item_NewExt( p_playlist, psz_uri, psz_file,
380 1, &psz_option, -1 );
381 playlist_AddInput( p_playlist, p_input, PLAYLIST_APPEND, PLAYLIST_END,
383 input_Read( p_playlist, p_input, true );
387 /** Small helper tp get current playing input or NULL. Release the input after use. */
388 #define pl_CurrentInput(a) __pl_CurrentInput( VLC_OBJECT(a) )
389 static inline input_thread_t * __pl_CurrentInput( vlc_object_t * p_this )
391 playlist_t * p_playlist = pl_Hold( p_this );
392 if( !p_playlist ) return NULL;
393 input_thread_t * p_input = playlist_CurrentInput( p_playlist );
394 pl_Release( p_this );
398 /** Tell if the playlist is empty */
399 #define playlist_IsEmpty( pl ) ( pl->items.i_size == 0 )
401 /** Tell the number of items in the current playing context */
402 #define playlist_CurrentSize( pl ) pl->current.i_size
404 /** Ask the playlist to do some work */
405 #define playlist_Signal( p_playlist ) vlc_object_signal( p_playlist )