098b3f20389c6f5db2859f9062486abc0bcb22b2
[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 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  *****************************************************************************/
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( p_item ) which will
115  * remove all occurrences of the input in both trees
116  *
117  *
118  * The playlist defines the following event variables:
119  *
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
123  * item being played.
124  *
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
127  * playlist_item_t.
128  *
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.
131  *
132  * @{
133  */
134
135 /** Helper structure to export to file part of the playlist */
136 struct playlist_export_t
137 {
138     char *psz_filename;
139     FILE *p_file;
140     playlist_item_t *p_root;
141 };
142
143 /** playlist item / node */
144 struct playlist_item_t
145 {
146     input_item_t           *p_input;    /**< Linked input item */
147     /** Number of children, -1 if not a node */
148     int                    i_children;
149     playlist_item_t      **pp_children; /**< Children nodes/items */
150     playlist_item_t       *p_parent;    /**< Item parent */
151
152     int                    i_id;        /**< Playlist item specific id */
153     uint8_t                i_flags;     /**< Flags */
154     playlist_t            *p_playlist;  /**< Parent playlist */
155 };
156
157 #define PLAYLIST_SAVE_FLAG      0x0001    /**< Must it be saved */
158 #define PLAYLIST_SKIP_FLAG      0x0002    /**< Must playlist skip after it ? */
159 #define PLAYLIST_DBL_FLAG       0x0004    /**< Is it disabled ? */
160 #define PLAYLIST_RO_FLAG        0x0008    /**< Write-enabled ? */
161 #define PLAYLIST_REMOVE_FLAG    0x0010    /**< Remove this item at the end */
162 #define PLAYLIST_EXPANDED_FLAG  0x0020    /**< Expanded node */
163
164 /** Playlist status */
165 typedef enum
166 { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
167
168 /** Structure containing information about the playlist */
169 struct playlist_t
170 {
171     VLC_COMMON_MEMBERS
172
173     playlist_item_array_t items; /**< Arrays of items */
174     playlist_item_array_t all_items; /**< Array of items and nodes */
175
176     playlist_item_array_t current; /**< Items currently being played */
177     int                   i_current_index; /**< Index in current array */
178
179     /* Predefined items */
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 */
186 };
187
188 /** Helper to add an item */
189 struct playlist_add_t
190 {
191     int i_node; /**< Playist id of the parent node */
192     int i_item; /**< Playist id of the playlist_item_t */
193 };
194
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.
198  */
199 #define VLC_DEFINE_SORT_FUNCTIONS \
200     DEF( SORT_ID )\
201     DEF( SORT_TITLE )\
202     DEF( SORT_TITLE_NODES_FIRST )\
203     DEF( SORT_ARTIST )\
204     DEF( SORT_GENRE )\
205     DEF( SORT_DURATION )\
206     DEF( SORT_TITLE_NUMERIC )\
207     DEF( SORT_ALBUM )\
208     DEF( SORT_TRACK_NUMBER )\
209     DEF( SORT_DESCRIPTION )\
210     DEF( SORT_RATING )\
211     DEF( SORT_URI )
212
213 #define DEF( s ) s,
214 enum
215 {
216     VLC_DEFINE_SORT_FUNCTIONS
217     SORT_RANDOM,
218     NUM_SORT_FNS=SORT_RANDOM
219 };
220 #undef  DEF
221 #ifndef VLC_INTERNAL_PLAYLIST_SORT_FUNCTIONS
222 #undef  VLC_DEFINE_SORT_FUNCTIONS
223 #endif
224
225 enum
226 {
227     ORDER_NORMAL = 0,
228     ORDER_REVERSE = 1,
229 };
230
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
238
239 #define PLAYLIST_END           -666
240
241 enum pl_locked_state
242 {
243     pl_Locked = true,
244     pl_Unlocked = false
245 };
246
247 /*****************************************************************************
248  * Prototypes
249  *****************************************************************************/
250
251 /* Helpers */
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 )
255
256 VLC_EXPORT( playlist_t *, __pl_Hold, ( vlc_object_t * ) );
257 #define pl_Hold( a ) __pl_Hold( VLC_OBJECT(a) )
258
259 VLC_EXPORT( void, __pl_Release, ( vlc_object_t * ) );
260 #define pl_Release(a) __pl_Release( VLC_OBJECT(a) )
261
262 /* Playlist control */
263 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
264 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
265 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
266 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
267 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
268 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked,  (i) )
269
270 VLC_EXPORT( void, playlist_Lock, ( playlist_t * ) );
271 VLC_EXPORT( void, playlist_Unlock, ( playlist_t * ) );
272 VLC_EXPORT( void, playlist_AssertLocked, ( playlist_t * ) );
273
274 /**
275  * Do a playlist action.
276  * If there is something in the playlist then you can do playlist actions.
277  * Possible queries are listed in vlc_common.h
278  * \param p_playlist the playlist to do the command on
279  * \param i_query the command to do
280  * \param b_locked TRUE if playlist is locked when entering this function
281  * \param variable number of arguments
282  * \return VLC_SUCCESS or an error
283  */
284 VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, bool b_locked, ...  ) );
285
286 /** Get current playing input. The object is retained.
287  */
288 VLC_EXPORT( input_thread_t *, playlist_CurrentInput, ( playlist_t *p_playlist ) );
289
290 /** Clear the playlist
291  * \param b_locked TRUE if playlist is locked when entering this function
292  */
293 VLC_EXPORT( void,  playlist_Clear, ( playlist_t *, bool ) );
294
295 /** Enqueue an input item for preparsing */
296 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *, bool b_locked ) );
297
298 /** Request the art for an input item to be fetched */
299 VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *, bool b_locked ) );
300
301 /* Playlist sorting */
302 VLC_EXPORT( int,  playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
303 VLC_EXPORT( int,  playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
304
305 VLC_EXPORT( playlist_item_t *,  playlist_CurrentPlayingItem, ( playlist_t * ) );
306 VLC_EXPORT( int,   playlist_Status, ( playlist_t * ) );
307
308 /**
309  * Export a node of the playlist to a certain type of playlistfile
310  * \param p_playlist the playlist to export
311  * \param psz_filename the location where the exported file will be saved
312  * \param p_export_root the root node to export
313  * \param psz_type the type of playlist file to create (m3u, pls, ..)
314  * \return VLC_SUCCESS on success
315  */
316 VLC_EXPORT( int,  playlist_Export, ( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type ) );
317
318 /**
319  * Open a playlist file, add its content to the current playlist
320  */
321 VLC_EXPORT( int, playlist_Import, ( playlist_t *p_playlist, const char *psz_file ) );
322
323 /********************** Services discovery ***********************/
324
325 /** Add a list of comma-separated service discovery modules */
326 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
327 /** Remove a services discovery module by name */
328 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
329 /** Check whether a given SD is loaded */
330 VLC_EXPORT( bool, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
331
332
333
334 /********************************************************
335  * Item management
336  ********************************************************/
337
338 /*************************** Item deletion **************************/
339 VLC_EXPORT( int,  playlist_DeleteFromInput, ( playlist_t *, input_item_t *, bool ) );
340
341 /******************** Item addition ********************/
342 VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int, bool, bool ) );
343 VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, int, const char *const *, unsigned, bool, bool ) );
344 VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, bool, bool ) );
345 VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int*, bool ) );
346
347 /********************************** Item search *************************/
348 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int ) );
349 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) );
350
351 VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) );
352
353 /********************************************************
354  * Tree management
355  ********************************************************/
356 /* Node management */
357 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_flags, input_item_t * ) );
358 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) );
359 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) );
360 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
361 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
362 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, bool , bool ) );
363
364 VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) );
365 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 ) );
366 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 ) );
367 VLC_EXPORT( playlist_item_t *, playlist_GetLastLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root ) );
368
369 /***********************************************************************
370  * Inline functions
371  ***********************************************************************/
372 /** Small helper tp get current playing input or NULL. Release the input after use. */
373 #define pl_CurrentInput(a) __pl_CurrentInput( VLC_OBJECT(a) )
374 static  inline input_thread_t * __pl_CurrentInput( vlc_object_t * p_this )
375 {
376     playlist_t * p_playlist = pl_Hold( p_this );
377     if( !p_playlist ) return NULL;
378     input_thread_t * p_input = playlist_CurrentInput( p_playlist );
379     pl_Release( p_this );
380     return p_input;
381 }
382
383 /** Tell if the playlist is empty */
384 static inline bool playlist_IsEmpty( playlist_t *p_playlist )
385 {
386     PL_ASSERT_LOCKED;
387     return p_playlist->items.i_size == 0;
388 }
389
390 /** Tell the number of items in the current playing context */
391 static inline int playlist_CurrentSize( playlist_t *p_playlist )
392 {
393     PL_ASSERT_LOCKED;
394     return p_playlist->current.i_size;
395 }
396
397 /** @} */
398 # ifdef __cplusplus
399 }
400 # endif
401
402 #endif