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_events.h>
33 TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t)
39 * This file contain structures and function prototypes related
40 * to the playlist in vlc
42 * \defgroup vlc_playlist Playlist
44 * The VLC playlist system has a tree structure. This allows advanced
45 * categorization, like for SAP streams (which are grouped by "sap groups").
47 * The base structure for all playlist operations is the input_item_t. This
48 * contains all information needed to play a stream and get info, ie, mostly,
49 * mrl and metadata. This structure contains a unique i_id field. ids are
50 * not recycled when an item is destroyed.
52 * Input items are not used directly, but through playlist items.
53 * The playlist items are themselves in a tree structure. They only contain
54 * a link to the input item, a unique id and a few flags. the playlist
55 * item id is NOT the same as the input item id.
56 * Several playlist items can be attached to a single input item. The input
57 * item is refcounted and is automatically destroyed when it is not used
60 * The top-level items are the main media sources and include:
61 * playlist, media library, SAP, Shoutcast, devices, ...
63 * It is envisioned that a third tree will appear: VLM, but it's not done yet
65 * The playlist also stores, for utility purposes, an array of all input
66 * items, an array of all playlist items and an array of all playlist items
67 * and nodes (both are represented by the same structure).
69 * So, here is an example:
72 * - input 1 -> name = foo 1 uri = ...
73 * - input 2 -> name = foo 2 uri = ...
78 * - foo 2 (id 6 - input 2)
79 * - media library (id 2)
80 * - foo 1 (id 5 - input 1)
83 * Sometimes, an item creates subitems. This happens for the directory access
84 * for example. In that case, if the item is under the "playlist" top-level item
85 * and playlist is configured to be flat then the item will be deleted and
86 * replaced with new subitems. If the item is under another top-level item, it
87 * will be transformed to a node and removed from the list of all items without
90 * For "standard" item addition, you can use playlist_Add, playlist_AddExt
91 * (more options) or playlist_AddInput if you already created your input
92 * item. This will add the item at the root of "Playlist" or of "Media library"
93 * in each of the two trees.
95 * You can create nodes with playlist_NodeCreate and can create items from
96 * existing input items to be placed under any node with playlist_NodeAddInput.
98 * To delete an item, use playlist_DeleteFromInput( p_item ) which will
99 * remove all occurrences of the input.
102 * The playlist defines the following event variables:
104 * - "item-change": It will contain the input_item_t->i_id of a changed input
105 * item monitored by the playlist.
108 * - "playlist-item-append": It will contain a pointer to a playlist_add_t.
109 * - "playlist-item-deleted": It will contain the playlist_item_t->i_id of a
110 * deleted playlist_item_t.
112 * - "leaf-to-parent": It will contain the playlist_item_t->i_id of an item that is transformed
115 * The playlist contains rate-variable which is propagated to current input if available
116 * also rate-slower/rate-faster is in use
118 * XXX Be really carefull, playlist_item_t->i_id and input_item_t->i_id are not
119 * the same. Yes, the situation is pretty bad.
124 /** Helper structure to export to file part of the playlist */
125 typedef struct playlist_export_t
128 const char *psz_filename;
130 playlist_item_t *p_root;
133 /** playlist item / node */
134 struct playlist_item_t
136 input_item_t *p_input; /**< Linked input item */
138 playlist_item_t **pp_children; /**< Children nodes/items */
139 playlist_item_t *p_parent; /**< Item parent */
140 int i_children; /**< Number of children, -1 if not a node */
142 int i_id; /**< Playlist item specific id */
143 uint8_t i_flags; /**< Flags \see playlist_item_flags_e */
145 playlist_t *p_playlist; /**< Parent playlist */
149 PLAYLIST_SAVE_FLAG = 0x0001, /**< Must it be saved */
150 PLAYLIST_SKIP_FLAG = 0x0002, /**< Must playlist skip after it ? */
151 PLAYLIST_DBL_FLAG = 0x0004, /**< Is it disabled ? */
152 PLAYLIST_RO_FLAG = 0x0008, /**< Write-enabled ? */
153 PLAYLIST_REMOVE_FLAG = 0x0010, /**< Remove this item at the end */
154 PLAYLIST_EXPANDED_FLAG = 0x0020, /**< Expanded node */
155 PLAYLIST_SUBITEM_STOP_FLAG = 0x0040, /**< Must playlist stop if the item gets subitems ?*/
156 } playlist_item_flags_e;
158 /** Playlist status */
160 { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
162 /** Structure containing information about the playlist */
167 playlist_item_array_t items; /**< Arrays of items */
168 playlist_item_array_t all_items; /**< Array of items and nodes */
170 playlist_item_array_t current; /**< Items currently being played */
171 int i_current_index; /**< Index in current array */
173 /* Predefined items */
174 playlist_item_t * p_root;
175 playlist_item_t * p_playing;
176 playlist_item_t * p_media_library;
178 //Phony ones, point to those above;
179 playlist_item_t * p_root_category; /**< Root of category tree */
180 playlist_item_t * p_root_onelevel; /**< Root of onelevel tree */
181 playlist_item_t * p_local_category; /** < "Playlist" in CATEGORY view */
182 playlist_item_t * p_ml_category; /** < "Library" in CATEGORY view */
183 playlist_item_t * p_local_onelevel; /** < "Playlist" in ONELEVEL view */
184 playlist_item_t * p_ml_onelevel; /** < "Library" in ONELEVEL view */
187 /** Helper to add an item */
188 struct playlist_add_t
190 int i_node; /**< Playist id of the parent node */
191 int i_item; /**< Playist id of the playlist_item_t */
194 /* A bit of macro magic to generate an enum out of the following list,
195 * and later, to generate a list of static functions out of the same list.
196 * There is also SORT_RANDOM, which is always last and handled specially.
198 #define VLC_DEFINE_SORT_FUNCTIONS \
201 DEF( SORT_TITLE_NODES_FIRST )\
204 DEF( SORT_DURATION )\
205 DEF( SORT_TITLE_NUMERIC )\
207 DEF( SORT_TRACK_NUMBER )\
208 DEF( SORT_DESCRIPTION )\
215 VLC_DEFINE_SORT_FUNCTIONS
217 NUM_SORT_FNS=SORT_RANDOM
220 #ifndef VLC_INTERNAL_PLAYLIST_SORT_FUNCTIONS
221 #undef VLC_DEFINE_SORT_FUNCTIONS
230 /* Used by playlist_Import */
231 #define PLAYLIST_INSERT 0x0001
232 #define PLAYLIST_APPEND 0x0002
233 #define PLAYLIST_GO 0x0004
234 #define PLAYLIST_PREPARSE 0x0008
235 #define PLAYLIST_SPREPARSE 0x0010
236 #define PLAYLIST_NO_REBUILD 0x0020
238 #define PLAYLIST_END -666
246 /*****************************************************************************
248 *****************************************************************************/
251 #define PL_LOCK playlist_Lock( p_playlist )
252 #define PL_UNLOCK playlist_Unlock( p_playlist )
253 #define PL_ASSERT_LOCKED playlist_AssertLocked( p_playlist )
255 /* Playlist control */
256 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
257 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
258 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
259 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
260 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
261 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, (i) )
263 VLC_API void playlist_Lock( playlist_t * );
264 VLC_API void playlist_Unlock( playlist_t * );
265 VLC_API void playlist_AssertLocked( playlist_t * );
266 VLC_API void playlist_Deactivate( playlist_t * );
269 * Do a playlist action.
270 * If there is something in the playlist then you can do playlist actions.
271 * Possible queries are listed in vlc_common.h
272 * \param p_playlist the playlist to do the command on
273 * \param i_query the command to do
274 * \param b_locked TRUE if playlist is locked when entering this function
275 * \param variable number of arguments
276 * \return VLC_SUCCESS or an error
278 VLC_API int playlist_Control( playlist_t *p_playlist, int i_query, bool b_locked, ... );
280 /** Get current playing input. The object is retained.
282 VLC_API input_thread_t * playlist_CurrentInput( playlist_t *p_playlist ) VLC_USED;
284 /** Get the duration of all items in a node.
286 VLC_API mtime_t playlist_GetNodeDuration( playlist_item_t * );
288 /** Clear the playlist
289 * \param b_locked TRUE if playlist is locked when entering this function
291 VLC_API void playlist_Clear( playlist_t *, bool );
293 /* Playlist sorting */
294 VLC_API int playlist_TreeMove( playlist_t *, playlist_item_t *, playlist_item_t *, int );
295 VLC_API int playlist_TreeMoveMany( playlist_t *, int, playlist_item_t **, playlist_item_t *, int );
296 VLC_API int playlist_RecursiveNodeSort( playlist_t *, playlist_item_t *,int, int );
298 VLC_API playlist_item_t * playlist_CurrentPlayingItem( playlist_t * ) VLC_USED;
299 VLC_API int playlist_Status( playlist_t * );
302 * Export a node of the playlist to a certain type of playlistfile
303 * \param p_playlist the playlist to export
304 * \param psz_filename the location where the exported file will be saved
305 * \param p_export_root the root node to export
306 * \param psz_type the type of playlist file to create (m3u, pls, ..)
307 * \return VLC_SUCCESS on success
309 VLC_API int playlist_Export( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type );
312 * Open a playlist file, add its content to the current playlist
314 VLC_API int playlist_Import( playlist_t *p_playlist, const char *psz_file );
316 /********************** Services discovery ***********************/
318 /** Add a list of comma-separated service discovery modules */
319 VLC_API int playlist_ServicesDiscoveryAdd(playlist_t *, const char *);
320 /** Remove a services discovery module by name */
321 VLC_API int playlist_ServicesDiscoveryRemove(playlist_t *, const char *);
322 /** Check whether a given SD is loaded */
323 VLC_API bool playlist_IsServicesDiscoveryLoaded( playlist_t *,const char *) VLC_DEPRECATED;
324 /** Query a services discovery */
325 VLC_API int playlist_ServicesDiscoveryControl( playlist_t *, const char *, int, ... );
329 /********************************************************
331 ********************************************************/
333 /*************************** Item deletion **************************/
334 VLC_API int playlist_DeleteFromInput( playlist_t *, input_item_t *, bool );
336 /******************** Item addition ********************/
337 VLC_API int playlist_Add( playlist_t *, const char *, const char *, int, int, bool, bool );
338 VLC_API int playlist_AddExt( playlist_t *, const char *, const char *, int, int, mtime_t, int, const char *const *, unsigned, bool, bool );
339 VLC_API int playlist_AddInput( playlist_t *, input_item_t *, int, int, bool, bool );
340 VLC_API playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *, playlist_item_t *, int, int, bool );
341 VLC_API int playlist_NodeAddCopy( playlist_t *, playlist_item_t *, playlist_item_t *, int );
343 /********************************** Item search *************************/
344 VLC_API playlist_item_t * playlist_ItemGetById(playlist_t *, int ) VLC_USED;
345 VLC_API playlist_item_t * playlist_ItemGetByInput(playlist_t *,input_item_t * ) VLC_USED;
347 VLC_API int playlist_LiveSearchUpdate(playlist_t *, playlist_item_t *, const char *, bool );
349 /********************************************************
351 ********************************************************/
352 /* Node management */
353 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 * );
354 VLC_API int playlist_NodeAppend(playlist_t *,playlist_item_t*,playlist_item_t *);
355 VLC_API int playlist_NodeInsert(playlist_t *,playlist_item_t*,playlist_item_t *, int);
356 VLC_API int playlist_NodeRemoveItem(playlist_t *,playlist_item_t*,playlist_item_t *);
357 VLC_API playlist_item_t * playlist_ChildSearchName(playlist_item_t*, const char* ) VLC_USED;
358 VLC_API int playlist_NodeDelete( playlist_t *, playlist_item_t *, bool , bool );
360 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;
361 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;
363 /**************************
364 * Audio output management
365 **************************/
367 VLC_API audio_output_t *playlist_GetAout( playlist_t * );
369 #define AOUT_VOLUME_DEFAULT 256
370 #define AOUT_VOLUME_MAX 512
372 VLC_API float playlist_VolumeGet( playlist_t * );
373 VLC_API int playlist_VolumeSet( playlist_t *, float );
374 VLC_API int playlist_VolumeUp( playlist_t *, int, float * );
375 #define playlist_VolumeDown(a, b, c) playlist_VolumeUp(a, -(b), c)
376 VLC_API int playlist_MuteSet( playlist_t *, bool );
377 VLC_API int playlist_MuteGet( playlist_t * );
379 static inline int playlist_MuteToggle( playlist_t *pl )
381 int val = playlist_MuteGet( pl );
383 val = playlist_MuteSet( pl, !val );
387 VLC_API void playlist_EnableAudioFilter( playlist_t *, const char *, bool );
389 /***********************************************************************
391 ***********************************************************************/
392 /** Tell if the playlist is empty */
393 static inline bool playlist_IsEmpty( playlist_t *p_playlist )
396 return p_playlist->items.i_size == 0;
399 /** Tell the number of items in the current playing context */
400 static inline int playlist_CurrentSize( playlist_t *p_playlist )
403 return p_playlist->current.i_size;