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 along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 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
);
38 * This file contain structures and function prototypes related
39 * to the playlist in vlc
41 * \defgroup vlc_playlist Playlist
43 * The VLC playlist system has a tree structure. This allows advanced
44 * categorization, like for SAP streams (which are grouped by "sap groups").
46 * The base structure for all playlist operations is the input_item_t. This
47 * contains all information needed to play a stream and get info, ie, mostly,
48 * mrl and metadata. This structure contains a unique i_id field. ids are
49 * not recycled when an item is destroyed.
51 * Input items are not used directly, but through playlist items.
52 * The playlist items are themselves in a tree structure. They only contain
53 * a link to the input item, a unique id and a few flags. the playlist
54 * item id is NOT the same as the input item id.
55 * Several playlist items can be attached to a single input item. The input
56 * item is refcounted and is automatically destroyed when it is not used
59 * In the playlist itself, there are two trees, that should always be kept
60 * in sync. The "category" tree contains the whole tree structure with
61 * several levels, while the onelevel tree contains only one level :), ie
62 * it only contains "real" items, not nodes
63 * For example, if you open a directory, you will have
65 * Category tree: Onelevel tree:
72 * The top-level items of both tree are the same, and they are reproduced
73 * in the left-part of the playlist GUIs, they are the "sources" from the
74 * source selectors. Top-level items include: playlist, media library, SAP,
75 * Shoutcast, devices, ...
77 * It is envisioned that a third tree will appear: VLM, but it's not done yet
79 * The playlist also stores, for utility purposes, an array of all input
80 * items, an array of all playlist items and an array of all playlist items
81 * and nodes (both are represented by the same structure).
83 * So, here is an example:
86 * - input 1 -> name = foo 1 uri = ...
87 * - input 2 -> name = foo 2 uri = ...
89 * Category tree Onelevel tree
90 * - playlist (id 1) - playlist (id 3)
91 * - category 1 (id 2) - foo 2 (id 8 - input 2)
92 * - foo 2 (id 6 - input 2) - media library (id 4)
93 * - media library (id 2) - foo 1 (id6 - input 1)
94 * - foo 1 (id 5 - input 1)
96 * Sometimes, an item must be transformed to a node. This happens for the
97 * directory access for example. In that case, the item is removed from
98 * the onelevel tree, as it is not a real item anymore.
100 * For "standard" item addition, you can use playlist_Add, playlist_AddExt
101 * (more options) or playlist_AddInput if you already created your input
102 * item. This will add the item at the root of "Playlist" or of "Media library"
103 * in each of the two trees.
105 * If you want more control (like, adding the item as the child of a given
106 * node in the category tree, use playlist_BothAddInput. You'll have to provide
107 * the node in the category tree. The item will be added as a child of
108 * this node in the category tree, and as a child of the matching top-level
109 * node in the onelevel tree. (Nodes are created with playlist_NodeCreate)
111 * Generally speaking, playlist_NodeAddInput should not be used in newer code, it
112 * will maybe become useful again when we merge VLM;
114 * To delete an item, use playlist_DeleteFromInput( p_item ) which will
115 * remove all occurrences of the input in both trees
118 * The playlist defines the following event variables:
120 * - "item-change": It will contains the input_item_t->i_id of a changed input
121 * item monitored by the playlist.
122 * * - "item-current": It will contains a input_item_t->i_id of the current
125 * - "playlist-item-append": It will contains a pointer to a playlist_add_t.
126 * - "playlist-item-deleted": It will contains the playlist_item_t->i_id of a deleted
129 * XXX Be really carefull, playlist_item_t->i_id and input_item_t->i_id are not
130 * the same. Yes, the situation is pretty bad.
135 /** Helper structure to export to file part of the playlist */
136 typedef struct playlist_export_t
139 const char *psz_filename
;
141 playlist_item_t
*p_root
;
144 /** playlist item / node */
145 struct playlist_item_t
147 input_item_t
*p_input
; /**< Linked input item */
148 /** Number of children, -1 if not a node */
150 playlist_item_t
**pp_children
; /**< Children nodes/items */
151 playlist_item_t
*p_parent
; /**< Item parent */
153 int i_id
; /**< Playlist item specific id */
154 uint8_t i_flags
; /**< Flags */
155 playlist_t
*p_playlist
; /**< Parent playlist */
158 #define PLAYLIST_SAVE_FLAG 0x0001 /**< Must it be saved */
159 #define PLAYLIST_SKIP_FLAG 0x0002 /**< Must playlist skip after it ? */
160 #define PLAYLIST_DBL_FLAG 0x0004 /**< Is it disabled ? */
161 #define PLAYLIST_RO_FLAG 0x0008 /**< Write-enabled ? */
162 #define PLAYLIST_REMOVE_FLAG 0x0010 /**< Remove this item at the end */
163 #define PLAYLIST_EXPANDED_FLAG 0x0020 /**< Expanded node */
165 /** Playlist status */
167 { PLAYLIST_STOPPED
,PLAYLIST_RUNNING
,PLAYLIST_PAUSED
} playlist_status_t
;
169 /** Structure containing information about the playlist */
174 playlist_item_array_t items
; /**< Arrays of items */
175 playlist_item_array_t all_items
; /**< Array of items and nodes */
177 playlist_item_array_t current
; /**< Items currently being played */
178 int i_current_index
; /**< Index in current array */
180 /* Predefined items */
181 playlist_item_t
* p_root_category
; /**< Root of category tree */
182 playlist_item_t
* p_root_onelevel
; /**< Root of onelevel tree */
183 playlist_item_t
* p_local_category
; /** < "Playlist" in CATEGORY view */
184 playlist_item_t
* p_ml_category
; /** < "Library" in CATEGORY view */
185 playlist_item_t
* p_local_onelevel
; /** < "Playlist" in ONELEVEL view */
186 playlist_item_t
* p_ml_onelevel
; /** < "Library" in ONELEVEL view */
189 /** Helper to add an item */
190 struct playlist_add_t
192 int i_node
; /**< Playist id of the parent node */
193 int i_item
; /**< Playist id of the playlist_item_t */
196 /* A bit of macro magic to generate an enum out of the following list,
197 * and later, to generate a list of static functions out of the same list.
198 * There is also SORT_RANDOM, which is always last and handled specially.
200 #define VLC_DEFINE_SORT_FUNCTIONS \
203 DEF( SORT_TITLE_NODES_FIRST )\
206 DEF( SORT_DURATION )\
207 DEF( SORT_TITLE_NUMERIC )\
209 DEF( SORT_TRACK_NUMBER )\
210 DEF( SORT_DESCRIPTION )\
217 VLC_DEFINE_SORT_FUNCTIONS
219 NUM_SORT_FNS
=SORT_RANDOM
222 #ifndef VLC_INTERNAL_PLAYLIST_SORT_FUNCTIONS
223 #undef VLC_DEFINE_SORT_FUNCTIONS
232 /* Used by playlist_Import */
233 #define PLAYLIST_INSERT 0x0001
234 #define PLAYLIST_APPEND 0x0002
235 #define PLAYLIST_GO 0x0004
236 #define PLAYLIST_PREPARSE 0x0008
237 #define PLAYLIST_SPREPARSE 0x0010
238 #define PLAYLIST_NO_REBUILD 0x0020
240 #define PLAYLIST_END -666
248 /*****************************************************************************
250 *****************************************************************************/
253 #define PL_LOCK playlist_Lock( p_playlist )
254 #define PL_UNLOCK playlist_Unlock( p_playlist )
255 #define PL_ASSERT_LOCKED playlist_AssertLocked( p_playlist )
257 VLC_EXPORT( playlist_t
*, __pl_Hold
, ( vlc_object_t
* ) );
258 #define pl_Hold( a ) __pl_Hold( VLC_OBJECT(a) )
260 VLC_EXPORT( void, __pl_Release
, ( vlc_object_t
* ) );
261 #define pl_Release(a) __pl_Release( VLC_OBJECT(a) )
263 /* Playlist control */
264 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
265 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
266 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
267 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
268 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
269 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, (i) )
271 VLC_EXPORT( void, playlist_Lock
, ( playlist_t
* ) );
272 VLC_EXPORT( void, playlist_Unlock
, ( playlist_t
* ) );
273 VLC_EXPORT( void, playlist_AssertLocked
, ( playlist_t
* ) );
276 * Do a playlist action.
277 * If there is something in the playlist then you can do playlist actions.
278 * Possible queries are listed in vlc_common.h
279 * \param p_playlist the playlist to do the command on
280 * \param i_query the command to do
281 * \param b_locked TRUE if playlist is locked when entering this function
282 * \param variable number of arguments
283 * \return VLC_SUCCESS or an error
285 VLC_EXPORT( int, playlist_Control
, ( playlist_t
*p_playlist
, int i_query
, bool b_locked
, ... ) );
287 /** Get current playing input. The object is retained.
289 VLC_EXPORT( input_thread_t
*, playlist_CurrentInput
, ( playlist_t
*p_playlist
) );
291 /** Clear the playlist
292 * \param b_locked TRUE if playlist is locked when entering this function
294 VLC_EXPORT( void, playlist_Clear
, ( playlist_t
*, bool ) );
296 /** Enqueue an input item for preparsing */
297 VLC_EXPORT( int, playlist_PreparseEnqueue
, (playlist_t
*, input_item_t
*, bool b_locked
) );
299 /** Request the art for an input item to be fetched */
300 VLC_EXPORT( int, playlist_AskForArtEnqueue
, (playlist_t
*, input_item_t
*, bool b_locked
) );
302 /* Playlist sorting */
303 VLC_EXPORT( int, playlist_TreeMove
, ( playlist_t
*, playlist_item_t
*, playlist_item_t
*, int ) );
304 VLC_EXPORT( int, playlist_TreeMoveMany
, ( playlist_t
*, int, playlist_item_t
**, playlist_item_t
*, int ) );
305 VLC_EXPORT( int, playlist_RecursiveNodeSort
, ( playlist_t
*, playlist_item_t
*,int, int ) );
307 VLC_EXPORT( playlist_item_t
*, playlist_CurrentPlayingItem
, ( playlist_t
* ) );
308 VLC_EXPORT( int, playlist_Status
, ( playlist_t
* ) );
311 * Export a node of the playlist to a certain type of playlistfile
312 * \param p_playlist the playlist to export
313 * \param psz_filename the location where the exported file will be saved
314 * \param p_export_root the root node to export
315 * \param psz_type the type of playlist file to create (m3u, pls, ..)
316 * \return VLC_SUCCESS on success
318 VLC_EXPORT( int, playlist_Export
, ( playlist_t
*p_playlist
, const char *psz_name
, playlist_item_t
*p_export_root
, const char *psz_type
) );
321 * Open a playlist file, add its content to the current playlist
323 VLC_EXPORT( int, playlist_Import
, ( playlist_t
*p_playlist
, const char *psz_file
) );
325 /********************** Services discovery ***********************/
327 /** Add a list of comma-separated service discovery modules */
328 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd
, (playlist_t
*, const char *));
329 /** Remove a services discovery module by name */
330 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove
, (playlist_t
*, const char *));
331 /** Check whether a given SD is loaded */
332 VLC_EXPORT( bool, playlist_IsServicesDiscoveryLoaded
, ( playlist_t
*,const char *));
336 /********************************************************
338 ********************************************************/
340 /*************************** Item deletion **************************/
341 VLC_EXPORT( int, playlist_DeleteFromInput
, ( playlist_t
*, input_item_t
*, bool ) );
343 /******************** Item addition ********************/
344 VLC_EXPORT( int, playlist_Add
, ( playlist_t
*, const char *, const char *, int, int, bool, bool ) );
345 VLC_EXPORT( int, playlist_AddExt
, ( playlist_t
*, const char *, const char *, int, int, mtime_t
, int, const char *const *, unsigned, bool, bool ) );
346 VLC_EXPORT( int, playlist_AddInput
, ( playlist_t
*, input_item_t
*, int, int, bool, bool ) );
347 VLC_EXPORT( int, playlist_BothAddInput
, ( playlist_t
*, input_item_t
*,playlist_item_t
*,int , int, int*, int*, bool ) );
349 /********************************** Item search *************************/
350 VLC_EXPORT( playlist_item_t
*, playlist_ItemGetById
, (playlist_t
*, int ) );
351 VLC_EXPORT( playlist_item_t
*, playlist_ItemGetByInput
, (playlist_t
*,input_item_t
* ) );
353 VLC_EXPORT( int, playlist_LiveSearchUpdate
, (playlist_t
*, playlist_item_t
*, const char *) );
355 /********************************************************
357 ********************************************************/
358 /* Node management */
359 VLC_EXPORT( playlist_item_t
*, playlist_NodeCreate
, ( playlist_t
*, const char *, playlist_item_t
* p_parent
, int i_flags
, input_item_t
* ) );
360 VLC_EXPORT( int, playlist_NodeAppend
, (playlist_t
*,playlist_item_t
*,playlist_item_t
*) );
361 VLC_EXPORT( int, playlist_NodeInsert
, (playlist_t
*,playlist_item_t
*,playlist_item_t
*, int) );
362 VLC_EXPORT( int, playlist_NodeRemoveItem
, (playlist_t
*,playlist_item_t
*,playlist_item_t
*) );
363 VLC_EXPORT( playlist_item_t
*, playlist_ChildSearchName
, (playlist_item_t
*, const char* ) );
364 VLC_EXPORT( int, playlist_NodeDelete
, ( playlist_t
*, playlist_item_t
*, bool , bool ) );
366 VLC_EXPORT( playlist_item_t
*, playlist_GetPreferredNode
, ( playlist_t
*p_playlist
, playlist_item_t
*p_node
) );
367 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
) );
368 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
) );
370 /***********************************************************************
372 ***********************************************************************/
373 /** Small helper tp get current playing input or NULL. Release the input after use. */
374 #define pl_CurrentInput(a) __pl_CurrentInput( VLC_OBJECT(a) )
375 static inline input_thread_t
* __pl_CurrentInput( vlc_object_t
* p_this
)
377 playlist_t
* p_playlist
= pl_Hold( p_this
);
378 if( !p_playlist
) return NULL
;
379 input_thread_t
* p_input
= playlist_CurrentInput( p_playlist
);
380 pl_Release( p_this
);
384 /** Tell if the playlist is empty */
385 static inline bool playlist_IsEmpty( playlist_t
*p_playlist
)
388 return p_playlist
->items
.i_size
== 0;
391 /** Tell the number of items in the current playing context */
392 static inline int playlist_CurrentSize( playlist_t
*p_playlist
)
395 return p_playlist
->current
.i_size
;