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 #if !defined( __LIBVLC__ )
25 #error You are not libvlc or one of its plugins. You cannot include this file
28 #ifndef _VLC_PLAYLIST_H_
29 #define _VLC_PLAYLIST_H_
35 #include <vlc_input.h>
36 #include <vlc_events.h>
37 #include <vlc_services_discovery.h>
41 TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t);
45 * This file contain structures and function prototypes related
46 * to the playlist in vlc
48 * \defgroup vlc_playlist Playlist
50 * The VLC playlist system has a tree structure. This allows advanced
51 * categorization, like for SAP streams (which are grouped by "sap groups").
53 * The base structure for all playlist operations is the input_item_t. This
54 * contains all information needed to play a stream and get info, ie, mostly,
55 * mrl and metadata. This structure contains a unique i_id field. ids are
56 * not recycled when an item is destroyed.
58 * Input items are not used directly, but through playlist items.
59 * The playlist items are themselves in a tree structure. They only contain
60 * a link to the input item, a unique id and a few flags. the playlist
61 * item id is NOT the same as the input item id.
62 * Several playlist items can be attached to a single input item. The input
63 * item is refcounted and is automatically destroyed when it is not used
66 * In the playlist itself, there are two trees, that should always be kept
67 * in sync. The "category" tree contains the whole tree structure with
68 * several levels, while the onelevel tree contains only one level :), ie
69 * it only contains "real" items, not nodes
70 * For example, if you open a directory, you will have
72 * Category tree: Onelevel tree:
79 * The top-level items of both tree are the same, and they are reproduced
80 * in the left-part of the playlist GUIs, they are the "sources" from the
81 * source selectors. Top-level items include: playlist, media library, SAP,
82 * Shoutcast, devices, ...
84 * It is envisioned that a third tree will appear: VLM, but it's not done yet
86 * The playlist also stores, for utility purposes, an array of all input
87 * items, an array of all playlist items and an array of all playlist items
88 * and nodes (both are represented by the same structure).
90 * So, here is an example:
93 * - input 1 -> name = foo 1 uri = ...
94 * - input 2 -> name = foo 2 uri = ...
96 * Category tree Onelevel tree
97 * - playlist (id 1) - playlist (id 3)
98 * - category 1 (id 2) - foo 2 (id 8 - input 2)
99 * - foo 2 (id 6 - input 2) - media library (id 4)
100 * - media library (id 2) - foo 1 (id6 - input 1)
101 * - foo 1 (id 5 - input 1)
103 * Sometimes, an item must be transformed to a node. This happens for the
104 * directory access for example. In that case, the item is removed from
105 * the onelevel tree, as it is not a real item anymore.
107 * For "standard" item addition, you can use playlist_Add, playlist_AddExt
108 * (more options) or playlist_AddInput if you already created your input
109 * item. This will add the item at the root of "Playlist" or of "Media library"
110 * in each of the two trees.
112 * If you want more control (like, adding the item as the child of a given
113 * node in the category tree, use playlist_BothAddInput. You'll have to provide
114 * the node in the category tree. The item will be added as a child of
115 * this node in the category tree, and as a child of the matching top-level
116 * node in the onelevel tree. (Nodes are created with playlist_NodeCreate)
118 * Generally speaking, playlist_NodeAddInput should not be used in newer code, it
119 * will maybe become useful again when we merge VLM;
121 * To delete an item, use playlist_DeleteFromInput( input_id ) which will
122 * remove all occurrences of the input in both trees
127 /** Helper structure to export to file part of the playlist */
128 struct playlist_export_t
132 playlist_item_t *p_root;
135 /** playlist item / node */
136 struct playlist_item_t
138 input_item_t *p_input; /**< Linked input item */
139 /** Number of children, -1 if not a node */
141 playlist_item_t **pp_children; /**< Children nodes/items */
142 playlist_item_t *p_parent; /**< Item parent */
144 int i_id; /**< Playlist item specific id */
145 uint8_t i_flags; /**< Flags */
146 playlist_t *p_playlist; /**< Parent playlist */
149 #define PLAYLIST_SAVE_FLAG 0x0001 /**< Must it be saved */
150 #define PLAYLIST_SKIP_FLAG 0x0002 /**< Must playlist skip after it ? */
151 #define PLAYLIST_DBL_FLAG 0x0004 /**< Is it disabled ? */
152 #define PLAYLIST_RO_FLAG 0x0008 /**< Write-enabled ? */
153 #define PLAYLIST_REMOVE_FLAG 0x0010 /**< Remove this item at the end */
154 #define PLAYLIST_EXPANDED_FLAG 0x0020 /**< Expanded node */
156 /** Playlist status */
158 { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
160 /** Structure containing information about the playlist */
165 struct playlist_services_discovery_support_t {
166 /* the playlist items for category and onelevel */
167 playlist_item_t* p_cat;
168 playlist_item_t* p_one;
169 services_discovery_t * p_sd; /**< Loaded service discovery modules */
171 int i_sds; /**< Number of service discovery modules */
173 int i_enabled; /**< How many items are enabled ? */
175 playlist_item_array_t items; /**< Arrays of items */
176 playlist_item_array_t all_items; /**< Array of items and nodes */
178 playlist_item_array_t current; /**< Items currently being played */
179 int i_current_index; /**< Index in current array */
180 /** Reset current item array */
181 vlc_bool_t b_reset_currently_playing;
182 mtime_t last_rebuild_date;
184 int i_last_playlist_id; /**< Last id to an item */
186 /* Predefined items */
187 playlist_item_t * p_root_category; /**< Root of category tree */
188 playlist_item_t * p_root_onelevel; /**< Root of onelevel tree */
189 playlist_item_t * p_local_category; /** < "Playlist" in CATEGORY view */
190 playlist_item_t * p_ml_category; /** < "Library" in CATEGORY view */
191 playlist_item_t * p_local_onelevel; /** < "Playlist" in ONELEVEL view */
192 playlist_item_t * p_ml_onelevel; /** < "Library" in ONELEVEL view */
194 vlc_bool_t b_always_tree;/**< Always display as tree */
195 vlc_bool_t b_never_tree;/**< Never display as tree */
197 vlc_bool_t b_doing_ml; /**< Doing media library stuff,
199 vlc_bool_t b_auto_preparse;
202 input_thread_t * p_input; /**< the input thread associated
203 * with the current item */
204 int i_sort; /**< Last sorting applied to the playlist */
205 int i_order; /**< Last ordering applied to the playlist */
207 vlc_bool_t b_cant_sleep;
208 playlist_preparse_t *p_preparse; /**< Preparser object */
209 playlist_fetcher_t *p_fetcher;/**< Meta and art fetcher object */
211 vlc_mutex_t gc_lock; /**< Lock to protect the garbage collection */
214 /* Current status. These fields are readonly, only the playlist
215 * main loop can touch it*/
216 playlist_status_t i_status; /**< Current status of playlist */
217 playlist_item_t * p_item; /**< Currently playing/active item */
218 playlist_item_t * p_node; /**< Current node to play from */
222 /* Request. Use this to give orders to the playlist main loop */
223 int i_status; /**< requested playlist status */
224 playlist_item_t * p_node; /**< requested node to play from */
225 playlist_item_t * p_item; /**< requested item to play in the node */
227 int i_skip; /**< Number of items to skip */
229 vlc_bool_t b_request;/**< Set to true by the requester
230 The playlist sets it back to false
231 when processing the request */
232 vlc_mutex_t lock; /**< Lock to protect request */
235 // Playlist-unrelated fields
236 input_thread_t *p_stats_computer; /**< Input thread computing stats */
237 global_stats_t *p_stats; /**< Global statistics */
240 /** Helper to add an item */
241 struct playlist_add_t
250 #define SORT_TITLE_NODES_FIRST 2
251 #define SORT_ARTIST 3
253 #define SORT_RANDOM 5
254 #define SORT_DURATION 6
255 #define SORT_TITLE_NUMERIC 7
257 #define SORT_TRACK_NUMBER 9
258 #define SORT_DESCRIPTION 10
259 #define SORT_RATING 11
261 #define ORDER_NORMAL 0
262 #define ORDER_REVERSE 1
264 /*****************************************************************************
266 *****************************************************************************/
269 #define PL_LOCK vlc_object_lock( p_playlist )
270 #define PL_UNLOCK vlc_object_unlock( p_playlist )
272 #define pl_Get( a ) a->p_libvlc->p_playlist
274 VLC_EXPORT( playlist_t *, __pl_Yield, ( vlc_object_t * ) );
275 #define pl_Yield( a ) __pl_Yield( VLC_OBJECT(a) )
277 VLC_EXPORT( void, __pl_Release, ( vlc_object_t * ) );
278 #define pl_Release(a) __pl_Release( VLC_OBJECT(a) )
280 /* Playlist control */
281 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, VLC_FALSE )
282 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, VLC_FALSE )
283 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, VLC_FALSE )
284 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, VLC_FALSE, 1)
285 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, VLC_FALSE, -1)
286 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, VLC_FALSE, i)
289 * Do a playlist action.
290 * If there is something in the playlist then you can do playlist actions.
291 * Possible queries are listed in vlc_common.h
292 * \param p_playlist the playlist to do the command on
293 * \param i_query the command to do
294 * \param b_locked TRUE if playlist is locked when entering this function
295 * \param variable number of arguments
296 * \return VLC_SUCCESS or an error
298 VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, vlc_bool_t b_locked, ... ) );
300 /** Clear the playlist
301 * \param b_locked TRUE if playlist is locked when entering this function
303 VLC_EXPORT( void, playlist_Clear, ( playlist_t *, vlc_bool_t ) );
305 /** Enqueue an input item for preparsing */
306 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
308 /** Enqueue a playlist item and all of its children if any for preparsing */
309 VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) );
310 /** Request the art for an input item to be fetched */
311 VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *) );
313 /********************** Services discovery ***********************/
315 /** Add a list of comma-separated service discovery modules */
316 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
317 /** Remove a services discovery module by name */
318 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
319 /** Check whether a given SD is loaded */
320 VLC_EXPORT( vlc_bool_t, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
322 /* Playlist sorting */
323 VLC_EXPORT( int, playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
324 VLC_EXPORT( int, playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
327 * Export a node of the playlist to a certain type of playlistfile
328 * \param p_playlist the playlist to export
329 * \param psz_filename the location where the exported file will be saved
330 * \param p_export_root the root node to export
331 * \param psz_type the type of playlist file to create (m3u, pls, ..)
332 * \return VLC_SUCCESS on success
334 VLC_EXPORT( int, playlist_Export, ( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type ) );
336 /********************************************************
338 ********************************************************/
340 /*************************** Item creation **************************/
342 VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int , const char *const *, int, int) );
344 /** Create a new item, without adding it to the playlist
345 * \param p_obj a vlc object (anyone will do)
346 * \param psz_uri the mrl of the item
347 * \param psz_name a text giving a name or description of the item
348 * \return the new item or NULL on failure
350 #define playlist_ItemNew( a , b, c ) \
351 playlist_ItemNewWithType( VLC_OBJECT(a) , b , c, 0, NULL, -1, 0 )
353 #define playlist_ItemNewFromInput(a,b) __playlist_ItemNewFromInput(VLC_OBJECT(a),b)
354 VLC_EXPORT( playlist_item_t *, __playlist_ItemNewFromInput, ( vlc_object_t *p_obj,input_item_t *p_input ) );
356 /*************************** Item deletion **************************/
357 VLC_EXPORT( int, playlist_DeleteFromInput, ( playlist_t *, int, vlc_bool_t ) );
358 VLC_EXPORT( int, playlist_DeleteInputInParent, ( playlist_t *, int, playlist_item_t *, vlc_bool_t ) );
360 /*************************** Item fields accessors **************************/
361 VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, const char * ) );
363 /******************** Item addition ********************/
364 VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, int, int, vlc_bool_t, vlc_bool_t ) );
365 VLC_EXPORT( int, playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char *const *,int, vlc_bool_t, vlc_bool_t ) );
366 VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, vlc_bool_t, vlc_bool_t ) );
367 VLC_EXPORT( playlist_item_t *, playlist_NodeAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, vlc_bool_t ) );
368 VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int*, vlc_bool_t ) );
370 /********************** Misc item operations **********************/
371 VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *, vlc_bool_t) );
373 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
374 int i_input_id, playlist_item_t *p_root,
377 /********************************** Item search *************************/
378 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int, vlc_bool_t ) );
379 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t *, vlc_bool_t ) );
380 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInputId, (playlist_t *, int, playlist_item_t *) );
382 VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) );
384 /********************************************************
386 ********************************************************/
387 VLC_EXPORT(void, playlist_NodeDump, ( playlist_t *p_playlist, playlist_item_t *p_item, int i_level ) );
388 VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
390 /* Node management */
391 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_flags, input_item_t * ) );
392 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) );
393 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) );
394 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
395 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
396 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, vlc_bool_t , vlc_bool_t ) );
397 VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, vlc_bool_t ) );
398 VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, const char *, playlist_item_t **, playlist_item_t **, vlc_bool_t ) );
399 VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) );
400 VLC_EXPORT( playlist_item_t *, playlist_GetNextLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, vlc_bool_t b_ena, vlc_bool_t b_unplayed ) );
401 VLC_EXPORT( playlist_item_t *, playlist_GetPrevLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, vlc_bool_t b_ena, vlc_bool_t b_unplayed ) );
402 VLC_EXPORT( playlist_item_t *, playlist_GetLastLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root ) );
404 /***********************************************************************
406 ***********************************************************************/
407 /** Open a playlist file, add its content to the current playlist */
408 static inline int playlist_Import( playlist_t *p_playlist, const char *psz_file)
410 char psz_uri[256+10];
411 input_item_t *p_input;
412 snprintf( psz_uri, 256+9, "file/://%s", psz_file );
413 const char *const psz_option = "meta-file";
414 p_input = input_ItemNewExt( p_playlist, psz_uri, psz_file,
415 1, &psz_option, -1 );
416 playlist_AddInput( p_playlist, p_input, PLAYLIST_APPEND, PLAYLIST_END,
417 VLC_TRUE, VLC_FALSE );
418 input_Read( p_playlist, p_input, VLC_TRUE );
422 /** Tell if the playlist is currently running */
423 #define playlist_IsPlaying( pl ) ( pl->status.i_status == PLAYLIST_RUNNING )
425 /** Tell if the playlist is empty */
426 #define playlist_IsEmpty( pl ) ( pl->items.i_size == 0 )
428 /** Tell the number of items in the current playing context */
429 #define playlist_CurrentSize( obj ) obj->p_libvlc->p_playlist->current.i_size
431 /** Ask the playlist to do some work */
432 #define playlist_Signal( p_playlist ) vlc_object_signal( p_playlist )