Removed unused field and clean up (playlist).
[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  * 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 enum
196 {
197     SORT_ID = 0,
198     SORT_TITLE = 1,
199     SORT_TITLE_NODES_FIRST = 2,
200     SORT_ARTIST = 3,
201     SORT_GENRE = 4,
202     SORT_RANDOM = 5,
203     SORT_DURATION = 6,
204     SORT_TITLE_NUMERIC = 7,
205     SORT_ALBUM = 8,
206     SORT_TRACK_NUMBER = 9,
207     SORT_DESCRIPTION = 10,
208     SORT_RATING = 11,
209     SORT_URI = 12,
210 };
211 enum
212 {
213     ORDER_NORMAL = 0,
214     ORDER_REVERSE = 1,
215 };
216
217 /* Used by playlist_Import */
218 #define PLAYLIST_INSERT          0x0001
219 #define PLAYLIST_APPEND          0x0002
220 #define PLAYLIST_GO              0x0004
221 #define PLAYLIST_PREPARSE        0x0008
222 #define PLAYLIST_SPREPARSE       0x0010
223 #define PLAYLIST_NO_REBUILD      0x0020
224
225 #define PLAYLIST_END           -666
226
227 enum pl_locked_state
228 {
229     pl_Locked = true,
230     pl_Unlocked = false
231 };
232
233 /*****************************************************************************
234  * Prototypes
235  *****************************************************************************/
236
237 /* Helpers */
238 #define PL_LOCK playlist_Lock( p_playlist )
239 #define PL_UNLOCK playlist_Unlock( p_playlist )
240 #define PL_ASSERT_LOCKED playlist_AssertLocked( p_playlist )
241
242 VLC_EXPORT( playlist_t *, __pl_Hold, ( vlc_object_t * ) );
243 #define pl_Hold( a ) __pl_Hold( VLC_OBJECT(a) )
244
245 VLC_EXPORT( void, __pl_Release, ( vlc_object_t * ) );
246 #define pl_Release(a) __pl_Release( VLC_OBJECT(a) )
247
248 /* Playlist control */
249 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
250 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
251 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
252 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
253 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
254 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked,  (i) )
255
256 VLC_EXPORT( void, playlist_Lock, ( playlist_t * ) );
257 VLC_EXPORT( void, playlist_Unlock, ( playlist_t * ) );
258 VLC_EXPORT( void, playlist_AssertLocked, ( playlist_t * ) );
259
260 /**
261  * Do a playlist action.
262  * If there is something in the playlist then you can do playlist actions.
263  * Possible queries are listed in vlc_common.h
264  * \param p_playlist the playlist to do the command on
265  * \param i_query the command to do
266  * \param b_locked TRUE if playlist is locked when entering this function
267  * \param variable number of arguments
268  * \return VLC_SUCCESS or an error
269  */
270 VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, bool b_locked, ...  ) );
271
272 /** Get current playing input. The object is retained.
273  */
274 VLC_EXPORT( input_thread_t *, playlist_CurrentInput, ( playlist_t *p_playlist ) );
275
276 /** Clear the playlist
277  * \param b_locked TRUE if playlist is locked when entering this function
278  */
279 VLC_EXPORT( void,  playlist_Clear, ( playlist_t *, bool ) );
280
281 /** Enqueue an input item for preparsing */
282 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *, bool b_locked ) );
283
284 /** Request the art for an input item to be fetched */
285 VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *, bool b_locked ) );
286
287 /* Playlist sorting */
288 VLC_EXPORT( int,  playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
289 VLC_EXPORT( int,  playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
290
291 VLC_EXPORT( playlist_item_t *,  playlist_CurrentPlayingItem, ( playlist_t * ) );
292 VLC_EXPORT( int,   playlist_Status, ( playlist_t * ) );
293
294 /**
295  * Export a node of the playlist to a certain type of playlistfile
296  * \param p_playlist the playlist to export
297  * \param psz_filename the location where the exported file will be saved
298  * \param p_export_root the root node to export
299  * \param psz_type the type of playlist file to create (m3u, pls, ..)
300  * \return VLC_SUCCESS on success
301  */
302 VLC_EXPORT( int,  playlist_Export, ( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type ) );
303
304 /**
305  * Open a playlist file, add its content to the current playlist
306  */
307 VLC_EXPORT( int, playlist_Import, ( playlist_t *p_playlist, const char *psz_file ) );
308
309 /********************** Services discovery ***********************/
310
311 /** Add a list of comma-separated service discovery modules */
312 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
313 /** Remove a services discovery module by name */
314 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
315 /** Check whether a given SD is loaded */
316 VLC_EXPORT( bool, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
317
318
319
320 /********************************************************
321  * Item management
322  ********************************************************/
323
324 /*************************** Item deletion **************************/
325 VLC_EXPORT( int,  playlist_DeleteFromInput, ( playlist_t *, int, bool ) );
326
327 /******************** Item addition ********************/
328 VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int, bool, bool ) );
329 VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, int, const char *const *, unsigned, bool, bool ) );
330 VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, bool, bool ) );
331 VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int*, bool ) );
332
333 /********************************** Item search *************************/
334 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int ) );
335 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) );
336 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInputId, (playlist_t *, int, playlist_item_t *) );
337
338 VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) );
339
340 /********************************************************
341  * Tree management
342  ********************************************************/
343 /* Node management */
344 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_flags, input_item_t * ) );
345 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) );
346 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) );
347 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
348 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
349 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, bool , bool ) );
350
351 VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) );
352 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 ) );
353 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 ) );
354 VLC_EXPORT( playlist_item_t *, playlist_GetLastLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root ) );
355
356 /***********************************************************************
357  * Inline functions
358  ***********************************************************************/
359 /** Small helper tp get current playing input or NULL. Release the input after use. */
360 #define pl_CurrentInput(a) __pl_CurrentInput( VLC_OBJECT(a) )
361 static  inline input_thread_t * __pl_CurrentInput( vlc_object_t * p_this )
362 {
363     playlist_t * p_playlist = pl_Hold( p_this );
364     if( !p_playlist ) return NULL;
365     input_thread_t * p_input = playlist_CurrentInput( p_playlist );
366     pl_Release( p_this );
367     return p_input;
368 }
369
370 /** Tell if the playlist is empty */
371 static inline bool playlist_IsEmpty( playlist_t *p_playlist )
372 {
373     PL_ASSERT_LOCKED;
374     return p_playlist->items.i_size == 0;
375 }
376
377 /** Tell the number of items in the current playing context */
378 static inline int playlist_CurrentSize( playlist_t *p_playlist )
379 {
380     PL_ASSERT_LOCKED;
381     return p_playlist->current.i_size;
382 }
383
384 /** @} */
385 # ifdef __cplusplus
386 }
387 # endif
388
389 #endif