1 /*****************************************************************************
2 * vlc_playlist.h : Playlist functions
3 *****************************************************************************
4 * Copyright (C) 1999-2004 VLC authors and VideoLAN
7 * Authors: Samuel Hocevar <sam@zoy.org>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * 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>
34 TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t)
40 * This file contain structures and function prototypes related
41 * to the playlist in vlc
43 * \defgroup vlc_playlist Playlist
45 * The VLC playlist system has a tree structure. This allows advanced
46 * categorization, like for SAP streams (which are grouped by "sap groups").
48 * The base structure for all playlist operations is the input_item_t. This
49 * contains all information needed to play a stream and get info, ie, mostly,
50 * mrl and metadata. This structure contains a unique i_id field. ids are
51 * not recycled when an item is destroyed.
53 * Input items are not used directly, but through playlist items.
54 * The playlist items are themselves in a tree structure. They only contain
55 * a link to the input item, a unique id and a few flags. the playlist
56 * item id is NOT the same as the input item id.
57 * Several playlist items can be attached to a single input item. The input
58 * item is refcounted and is automatically destroyed when it is not used
61 * The top-level items are the main media sources and include:
62 * playlist, media library, SAP, Shoutcast, devices, ...
64 * It is envisioned that a third tree will appear: VLM, but it's not done yet
66 * The playlist also stores, for utility purposes, an array of all input
67 * items, an array of all playlist items and an array of all playlist items
68 * and nodes (both are represented by the same structure).
70 * So, here is an example:
73 * - input 1 -> name = foo 1 uri = ...
74 * - input 2 -> name = foo 2 uri = ...
79 * - foo 2 (id 6 - input 2)
80 * - media library (id 2)
81 * - foo 1 (id 5 - input 1)
84 * Sometimes, an item creates subitems. This happens for the directory access
85 * for example. In that case, if the item is under the "playlist" top-level item
86 * and playlist is configured to be flat then the item will be deleted and
87 * replaced with new subitems. If the item is under another top-level item, it
88 * will be transformed to a node and removed from the list of all items without
91 * For "standard" item addition, you can use playlist_Add, playlist_AddExt
92 * (more options) or playlist_AddInput if you already created your input
93 * item. This will add the item at the root of "Playlist" or of "Media library"
94 * in each of the two trees.
96 * You can create nodes with playlist_NodeCreate and can create items from
97 * existing input items to be placed under any node with playlist_NodeAddInput.
99 * To delete an item, use playlist_DeleteFromInput( p_item ) which will
100 * remove all occurrences of the input.
103 * The playlist defines the following event variables:
105 * - "item-change": It will contain the input_item_t->i_id of a changed input
106 * item monitored by the playlist.
109 * - "playlist-item-append": It will contain a pointer to a playlist_add_t.
110 * - "playlist-item-deleted": It will contain the playlist_item_t->i_id of a
111 * deleted playlist_item_t.
113 * - "leaf-to-parent": It will contain the playlist_item_t->i_id of an item that is transformed
116 * The playlist contains rate-variable which is propagated to current input if available
117 * also rate-slower/rate-faster is in use
119 * XXX Be really carefull, playlist_item_t->i_id and input_item_t->i_id are not
120 * the same. Yes, the situation is pretty bad.
125 /** Helper structure to export to file part of the playlist */
126 typedef struct playlist_export_t
129 const char *psz_filename;
131 playlist_item_t *p_root;
134 /** playlist item / node */
135 struct playlist_item_t
137 input_item_t *p_input; /**< Linked input item */
139 playlist_item_t **pp_children; /**< Children nodes/items */
140 playlist_item_t *p_parent; /**< Item parent */
141 int i_children; /**< Number of children, -1 if not a node */
143 int i_id; /**< Playlist item specific id */
144 uint8_t i_flags; /**< Flags \see playlist_item_flags_e */
146 playlist_t *p_playlist; /**< Parent playlist */
150 PLAYLIST_SAVE_FLAG = 0x0001, /**< Must it be saved */
151 PLAYLIST_SKIP_FLAG = 0x0002, /**< Must playlist skip after it ? */
152 PLAYLIST_DBL_FLAG = 0x0004, /**< Is it disabled ? */
153 PLAYLIST_RO_FLAG = 0x0008, /**< Write-enabled ? */
154 PLAYLIST_REMOVE_FLAG = 0x0010, /**< Remove this item at the end */
155 PLAYLIST_EXPANDED_FLAG = 0x0020, /**< Expanded node */
156 PLAYLIST_SUBITEM_STOP_FLAG = 0x0040, /**< Must playlist stop if the item gets subitems ?*/
157 } playlist_item_flags_e;
159 /** Playlist status */
161 { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
163 /** Structure containing information about the playlist */
168 playlist_item_array_t items; /**< Arrays of items */
169 playlist_item_array_t all_items; /**< Array of items and nodes */
171 playlist_item_array_t current; /**< Items currently being played */
172 int i_current_index; /**< Index in current array */
174 /* Predefined items */
175 playlist_item_t * p_root;
176 playlist_item_t * p_playing;
177 playlist_item_t * p_media_library;
179 //Phony ones, point to those above;
180 playlist_item_t * p_root_category; /**< Root of category tree */
181 playlist_item_t * p_root_onelevel; /**< Root of onelevel tree */
182 playlist_item_t * p_local_category; /** < "Playlist" in CATEGORY view */
183 playlist_item_t * p_ml_category; /** < "Library" in CATEGORY view */
184 playlist_item_t * p_local_onelevel; /** < "Playlist" in ONELEVEL view */
185 playlist_item_t * p_ml_onelevel; /** < "Library" in ONELEVEL view */
188 /** Helper to add an item */
189 struct playlist_add_t
191 int i_node; /**< Playist id of the parent node */
192 int i_item; /**< Playist id of the playlist_item_t */
195 /* A bit of macro magic to generate an enum out of the following list,
196 * and later, to generate a list of static functions out of the same list.
197 * There is also SORT_RANDOM, which is always last and handled specially.
199 #define VLC_DEFINE_SORT_FUNCTIONS \
202 DEF( SORT_TITLE_NODES_FIRST )\
205 DEF( SORT_DURATION )\
206 DEF( SORT_TITLE_NUMERIC )\
208 DEF( SORT_TRACK_NUMBER )\
209 DEF( SORT_DESCRIPTION )\
216 VLC_DEFINE_SORT_FUNCTIONS
218 NUM_SORT_FNS=SORT_RANDOM
221 #ifndef VLC_INTERNAL_PLAYLIST_SORT_FUNCTIONS
222 #undef VLC_DEFINE_SORT_FUNCTIONS
231 /* Used by playlist_Import */
232 #define PLAYLIST_INSERT 0x0001
233 #define PLAYLIST_APPEND 0x0002
234 #define PLAYLIST_GO 0x0004
235 #define PLAYLIST_PREPARSE 0x0008
236 #define PLAYLIST_SPREPARSE 0x0010
237 #define PLAYLIST_NO_REBUILD 0x0020
239 #define PLAYLIST_END -666
247 /*****************************************************************************
249 *****************************************************************************/
252 #define PL_LOCK playlist_Lock( p_playlist )
253 #define PL_UNLOCK playlist_Unlock( p_playlist )
254 #define PL_ASSERT_LOCKED playlist_AssertLocked( p_playlist )
256 VLC_API playlist_t * pl_Get( vlc_object_t * );
257 #define pl_Get( a ) pl_Get( VLC_OBJECT(a) )
259 /* Playlist control */
260 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
261 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
262 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
263 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
264 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
265 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, (i) )
267 VLC_API void playlist_Lock( playlist_t * );
268 VLC_API void playlist_Unlock( playlist_t * );
269 VLC_API void playlist_AssertLocked( playlist_t * );
270 VLC_API void playlist_Deactivate( playlist_t * );
273 * Do a playlist action.
274 * If there is something in the playlist then you can do playlist actions.
275 * Possible queries are listed in vlc_common.h
276 * \param p_playlist the playlist to do the command on
277 * \param i_query the command to do
278 * \param b_locked TRUE if playlist is locked when entering this function
279 * \param variable number of arguments
280 * \return VLC_SUCCESS or an error
282 VLC_API int playlist_Control( playlist_t *p_playlist, int i_query, bool b_locked, ... );
284 /** Get current playing input. The object is retained.
286 VLC_API input_thread_t * playlist_CurrentInput( playlist_t *p_playlist ) VLC_USED;
288 /** Get the duration of all items in a node.
290 VLC_API mtime_t playlist_GetNodeDuration( playlist_item_t * );
292 /** Clear the playlist
293 * \param b_locked TRUE if playlist is locked when entering this function
295 VLC_API void playlist_Clear( playlist_t *, bool );
297 /* Playlist sorting */
298 VLC_API int playlist_TreeMove( playlist_t *, playlist_item_t *, playlist_item_t *, int );
299 VLC_API int playlist_TreeMoveMany( playlist_t *, int, playlist_item_t **, playlist_item_t *, int );
300 VLC_API int playlist_RecursiveNodeSort( playlist_t *, playlist_item_t *,int, int );
302 VLC_API playlist_item_t * playlist_CurrentPlayingItem( playlist_t * ) VLC_USED;
303 VLC_API int playlist_Status( playlist_t * );
306 * Export a node of the playlist to a certain type of playlistfile
307 * \param p_playlist the playlist to export
308 * \param psz_filename the location where the exported file will be saved
309 * \param p_export_root the root node to export
310 * \param psz_type the type of playlist file to create (m3u, pls, ..)
311 * \return VLC_SUCCESS on success
313 VLC_API int playlist_Export( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type );
316 * Open a playlist file, add its content to the current playlist
318 VLC_API int playlist_Import( playlist_t *p_playlist, const char *psz_file );
320 /********************** Services discovery ***********************/
322 /** Add a list of comma-separated service discovery modules */
323 VLC_API int playlist_ServicesDiscoveryAdd(playlist_t *, const char *);
324 /** Remove a services discovery module by name */
325 VLC_API int playlist_ServicesDiscoveryRemove(playlist_t *, const char *);
326 /** Check whether a given SD is loaded */
327 VLC_API bool playlist_IsServicesDiscoveryLoaded( playlist_t *,const char *) VLC_DEPRECATED;
328 /** Query a services discovery */
329 VLC_API int playlist_ServicesDiscoveryControl( playlist_t *, const char *, int, ... );
333 /********************************************************
335 ********************************************************/
337 /*************************** Item deletion **************************/
338 VLC_API int playlist_DeleteFromInput( playlist_t *, input_item_t *, bool );
340 /******************** Item addition ********************/
341 VLC_API int playlist_Add( playlist_t *, const char *, const char *, int, int, bool, bool );
342 VLC_API int playlist_AddExt( playlist_t *, const char *, const char *, int, int, mtime_t, int, const char *const *, unsigned, bool, bool );
343 VLC_API int playlist_AddInput( playlist_t *, input_item_t *, int, int, bool, bool );
344 VLC_API playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *, playlist_item_t *, int, int, bool );
345 VLC_API int playlist_NodeAddCopy( playlist_t *, playlist_item_t *, playlist_item_t *, int );
347 /********************************** Item search *************************/
348 VLC_API playlist_item_t * playlist_ItemGetById(playlist_t *, int ) VLC_USED;
349 VLC_API playlist_item_t * playlist_ItemGetByInput(playlist_t *,input_item_t * ) VLC_USED;
351 VLC_API int playlist_LiveSearchUpdate(playlist_t *, playlist_item_t *, const char *, bool );
353 /********************************************************
355 ********************************************************/
356 /* Node management */
357 VLC_API playlist_item_t * playlist_NodeCreate( playlist_t *, const char *, playlist_item_t * p_parent, int i_pos, int i_flags, input_item_t * );
358 VLC_API int playlist_NodeAppend(playlist_t *,playlist_item_t*,playlist_item_t *);
359 VLC_API int playlist_NodeInsert(playlist_t *,playlist_item_t*,playlist_item_t *, int);
360 VLC_API int playlist_NodeRemoveItem(playlist_t *,playlist_item_t*,playlist_item_t *);
361 VLC_API playlist_item_t * playlist_ChildSearchName(playlist_item_t*, const char* ) VLC_USED;
362 VLC_API int playlist_NodeDelete( playlist_t *, playlist_item_t *, bool , bool );
364 VLC_API 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 ) VLC_USED;
365 VLC_API 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 ) VLC_USED;
367 /**************************
368 * Audio output management
369 **************************/
371 VLC_API audio_output_t *playlist_GetAout( playlist_t * );
373 #define AOUT_VOLUME_DEFAULT 256
374 #define AOUT_VOLUME_MAX 512
376 VLC_API float playlist_VolumeGet( playlist_t * );
377 VLC_API int playlist_VolumeSet( playlist_t *, float );
378 VLC_API int playlist_VolumeUp( playlist_t *, int, float * );
379 #define playlist_VolumeDown(a, b, c) playlist_VolumeUp(a, -(b), c)
380 VLC_API int playlist_MuteSet( playlist_t *, bool );
381 VLC_API int playlist_MuteGet( playlist_t * );
383 static inline int playlist_MuteToggle( playlist_t *pl )
385 int val = playlist_MuteGet( pl );
387 val = playlist_MuteSet( pl, !val );
391 VLC_API void playlist_EnableAudioFilter( playlist_t *, const char *, bool );
393 /***********************************************************************
395 ***********************************************************************/
396 /** Small helper tp get current playing input or NULL. Release the input after use. */
397 static inline input_thread_t *pl_CurrentInput( struct intf_thread_t *intf )
399 return playlist_CurrentInput( pl_Get( (vlc_object_t *)intf ) );
402 /** Tell if the playlist is empty */
403 static inline bool playlist_IsEmpty( playlist_t *p_playlist )
406 return p_playlist->items.i_size == 0;
409 /** Tell the number of items in the current playing context */
410 static inline int playlist_CurrentSize( playlist_t *p_playlist )
413 return p_playlist->current.i_size;