4a885e55ee3acc77e8fbaa762100815f7e07acd3
[vlc.git] / include / vlc_playlist.h
1 /*****************************************************************************
2  * vlc_playlist.h : Playlist functions
3  *****************************************************************************
4  * Copyright (C) 1999-2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 #ifndef VLC_PLAYLIST_H_
25 #define VLC_PLAYLIST_H_
26
27 # ifdef __cplusplus
28 extern "C" {
29 # endif
30
31 #include <vlc_input.h>
32 #include <vlc_events.h>
33
34 TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t);
35
36 /**
37  * \file
38  * This file contain structures and function prototypes related
39  * to the playlist in vlc
40  *
41  * \defgroup vlc_playlist Playlist
42  *
43  * The VLC playlist system has a tree structure. This allows advanced
44  * categorization, like for SAP streams (which are grouped by "sap groups").
45  *
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.
50  *
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
57  * anymore.
58  *
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
64  *\verbatim
65  * Category tree:               Onelevel tree:
66  * Playlist                     Playlist
67  *  - Dir                         - item1
68  *    - Subdir                    - item2
69  *      - item1
70  *      - item2
71  *\endverbatim
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, ...
76  *
77  * It is envisioned that a third tree will appear: VLM, but it's not done yet
78  *
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).
82  *
83  * So, here is an example:
84  * \verbatim
85  * Inputs array
86  *  - input 1 -> name = foo 1 uri = ...
87  *  - input 2 -> name = foo 2 uri = ...
88  *
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)
95  * \endverbatim
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.
99  *
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.
104  *
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)
110  *
111  * Generally speaking, playlist_NodeAddInput should not be used in newer code, it
112  * will maybe become useful again when we merge VLM;
113  *
114  * To delete an item, use playlist_DeleteFromInput( input_id ) which will
115  * remove all occurrences of the input in both trees
116  *
117  * @{
118  */
119
120 /** Helper structure to export to file part of the playlist */
121 struct playlist_export_t
122 {
123     char *psz_filename;
124     FILE *p_file;
125     playlist_item_t *p_root;
126 };
127
128 /** playlist item / node */
129 struct playlist_item_t
130 {
131     input_item_t           *p_input;    /**< Linked input item */
132     /** Number of children, -1 if not a node */
133     int                    i_children;
134     playlist_item_t      **pp_children; /**< Children nodes/items */
135     playlist_item_t       *p_parent;    /**< Item parent */
136
137     int                    i_id;        /**< Playlist item specific id */
138     uint8_t                i_flags;     /**< Flags */
139     playlist_t            *p_playlist;  /**< Parent playlist */
140 };
141
142 #define PLAYLIST_SAVE_FLAG      0x0001    /**< Must it be saved */
143 #define PLAYLIST_SKIP_FLAG      0x0002    /**< Must playlist skip after it ? */
144 #define PLAYLIST_DBL_FLAG       0x0004    /**< Is it disabled ? */
145 #define PLAYLIST_RO_FLAG        0x0008    /**< Write-enabled ? */
146 #define PLAYLIST_REMOVE_FLAG    0x0010    /**< Remove this item at the end */
147 #define PLAYLIST_EXPANDED_FLAG  0x0020    /**< Expanded node */
148
149 /** Playlist status */
150 typedef enum
151 { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
152
153 /** Structure containing information about the playlist */
154 struct playlist_t
155 {
156     VLC_COMMON_MEMBERS
157
158     playlist_item_array_t items; /**< Arrays of items */
159     playlist_item_array_t all_items; /**< Array of items and nodes */
160
161     playlist_item_array_t current; /**< Items currently being played */
162     int                   i_current_index; /**< Index in current array */
163
164     /* Predefined items */
165     playlist_item_t *     p_root_category; /**< Root of category tree */
166     playlist_item_t *     p_root_onelevel; /**< Root of onelevel tree */
167     playlist_item_t *     p_local_category; /** < "Playlist" in CATEGORY view */
168     playlist_item_t *     p_ml_category; /** < "Library" in CATEGORY view */
169     playlist_item_t *     p_local_onelevel; /** < "Playlist" in ONELEVEL view */
170     playlist_item_t *     p_ml_onelevel; /** < "Library" in ONELEVEL view */
171 };
172
173 /** Helper to add an item */
174 struct playlist_add_t
175 {
176     int i_node;
177     int i_item;
178     int i_position;
179 };
180
181 enum
182 {
183     SORT_ID = 0,
184     SORT_TITLE = 1,
185     SORT_TITLE_NODES_FIRST = 2,
186     SORT_ARTIST = 3,
187     SORT_GENRE = 4,
188     SORT_RANDOM = 5,
189     SORT_DURATION = 6,
190     SORT_TITLE_NUMERIC = 7,
191     SORT_ALBUM = 8,
192     SORT_TRACK_NUMBER = 9,
193     SORT_DESCRIPTION = 10,
194     SORT_RATING = 11,
195     SORT_URI = 12,
196 };
197 enum
198 {
199     ORDER_NORMAL = 0,
200     ORDER_REVERSE = 1,
201 };
202
203 /* Used by playlist_Import */
204 #define PLAYLIST_INSERT          0x0001
205 #define PLAYLIST_APPEND          0x0002
206 #define PLAYLIST_GO              0x0004
207 #define PLAYLIST_PREPARSE        0x0008
208 #define PLAYLIST_SPREPARSE       0x0010
209 #define PLAYLIST_NO_REBUILD      0x0020
210
211 #define PLAYLIST_END           -666
212
213 enum pl_locked_state
214 {
215     pl_Locked = true,
216     pl_Unlocked = false
217 };
218
219 /*****************************************************************************
220  * Prototypes
221  *****************************************************************************/
222
223 /* Helpers */
224 #define PL_LOCK vlc_object_lock( p_playlist )
225 #define PL_UNLOCK vlc_object_unlock( p_playlist )
226 #define PL_ASSERT_LOCKED vlc_object_assert_locked( p_playlist )
227
228 VLC_EXPORT( playlist_t *, __pl_Hold, ( vlc_object_t * ) );
229 #define pl_Hold( a ) __pl_Hold( VLC_OBJECT(a) )
230
231 VLC_EXPORT( void, __pl_Release, ( vlc_object_t * ) );
232 #define pl_Release(a) __pl_Release( VLC_OBJECT(a) )
233
234 /* Playlist control */
235 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
236 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
237 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
238 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
239 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
240 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked,  (i) )
241
242 /**
243  * Do a playlist action.
244  * If there is something in the playlist then you can do playlist actions.
245  * Possible queries are listed in vlc_common.h
246  * \param p_playlist the playlist to do the command on
247  * \param i_query the command to do
248  * \param b_locked TRUE if playlist is locked when entering this function
249  * \param variable number of arguments
250  * \return VLC_SUCCESS or an error
251  */
252 VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, bool b_locked, ...  ) );
253
254 /** Get current playing input. The object is retained.
255  */
256 VLC_EXPORT( input_thread_t *, playlist_CurrentInput, ( playlist_t *p_playlist ) );
257
258 /** Clear the playlist
259  * \param b_locked TRUE if playlist is locked when entering this function
260  */
261 VLC_EXPORT( void,  playlist_Clear, ( playlist_t *, bool ) );
262
263 /** Enqueue an input item for preparsing */
264 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *, bool b_locked ) );
265
266 /** Request the art for an input item to be fetched */
267 VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *, bool b_locked ) );
268
269 /* Playlist sorting */
270 VLC_EXPORT( int,  playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
271 VLC_EXPORT( int,  playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
272
273 VLC_EXPORT( int,  playlist_CurrentId, ( playlist_t * ) );
274 VLC_EXPORT( playlist_item_t *,  playlist_CurrentPlayingItem, ( playlist_t * ) );
275 VLC_EXPORT( bool,  playlist_IsPlaying, ( playlist_t * ) );
276 VLC_EXPORT( int,   playlist_Status, ( playlist_t * ) );
277
278 /**
279  * Export a node of the playlist to a certain type of playlistfile
280  * \param p_playlist the playlist to export
281  * \param psz_filename the location where the exported file will be saved
282  * \param p_export_root the root node to export
283  * \param psz_type the type of playlist file to create (m3u, pls, ..)
284  * \return VLC_SUCCESS on success
285  */
286 VLC_EXPORT( int,  playlist_Export, ( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type ) );
287
288 /**
289  * Open a playlist file, add its content to the current playlist
290  */
291 VLC_EXPORT( int, playlist_Import, ( playlist_t *p_playlist, const char *psz_file ) );
292
293 /********************** Services discovery ***********************/
294
295 /** Add a list of comma-separated service discovery modules */
296 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
297 /** Remove a services discovery module by name */
298 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
299 /** Check whether a given SD is loaded */
300 VLC_EXPORT( bool, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
301
302
303
304 /********************************************************
305  * Item management
306  ********************************************************/
307
308 /*************************** Item creation **************************/
309
310 VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( playlist_t *,const char *,const char *, int , const char *const *, int, int) );
311
312 /** Create a new item, without adding it to the playlist
313  * \param p_obj a vlc object (anyone will do)
314  * \param psz_uri the mrl of the item
315  * \param psz_name a text giving a name or description of the item
316  * \return the new item or NULL on failure
317  */
318 #define playlist_ItemNew( a , b, c ) \
319     playlist_ItemNewWithType( VLC_OBJECT(a) , b , c, 0, NULL, -1, 0 )
320
321
322 /*************************** Item deletion **************************/
323 VLC_EXPORT( int,  playlist_DeleteFromInput, ( playlist_t *, int, bool ) );
324
325 /******************** Item addition ********************/
326 VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int, bool, bool ) );
327 VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char *const *,int, bool, bool ) );
328 VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, bool, bool ) );
329 VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int*, bool ) );
330
331 /********************** Misc item operations **********************/
332 VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *, bool) );
333
334 /********************************** Item search *************************/
335 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int, bool ) );
336 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t *, bool ) );
337 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInputId, (playlist_t *, int, playlist_item_t *) );
338
339 VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) );
340
341 /********************************************************
342  * Tree management
343  ********************************************************/
344 VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
345
346 /* Node management */
347 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_flags, input_item_t * ) );
348 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) );
349 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) );
350 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
351 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
352 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, bool , bool ) );
353 VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, bool ) );
354 VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, const char *, playlist_item_t **, playlist_item_t **, bool ) );
355 VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) );
356 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 ) );
357 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 ) );
358 VLC_EXPORT( playlist_item_t *, playlist_GetLastLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root ) );
359
360 /***********************************************************************
361  * Inline functions
362  ***********************************************************************/
363 /** Small helper tp get current playing input or NULL. Release the input after use. */
364 #define pl_CurrentInput(a) __pl_CurrentInput( VLC_OBJECT(a) )
365 static  inline input_thread_t * __pl_CurrentInput( vlc_object_t * p_this )
366 {
367     playlist_t * p_playlist = pl_Hold( p_this );
368     if( !p_playlist ) return NULL;
369     input_thread_t * p_input = playlist_CurrentInput( p_playlist );
370     pl_Release( p_this );
371     return p_input;
372 }
373
374 /** Tell if the playlist is empty */
375 static inline bool playlist_IsEmpty( playlist_t *p_playlist )
376 {
377     PL_ASSERT_LOCKED;
378     return p_playlist->items.i_size == 0;
379 }
380
381 /** Tell the number of items in the current playing context */
382 static inline int playlist_CurrentSize( playlist_t *p_playlist )
383 {
384     PL_ASSERT_LOCKED;
385     return p_playlist->current.i_size;
386 }
387
388 /** @} */
389 # ifdef __cplusplus
390 }
391 # endif
392
393 #endif