8307d40a6c46aaecbbe93e77b167af06f093de98
[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 #include <vlc_services_discovery.h>
34 #include <stdio.h>
35 #include <stdlib.h>
36
37 TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t);
38
39 /**
40  * \file
41  * This file contain structures and function prototypes related
42  * to the playlist in vlc
43  *
44  * \defgroup vlc_playlist Playlist
45  *
46  * The VLC playlist system has a tree structure. This allows advanced
47  * categorization, like for SAP streams (which are grouped by "sap groups").
48  *
49  * The base structure for all playlist operations is the input_item_t. This
50  * contains all information needed to play a stream and get info, ie, mostly,
51  * mrl and metadata. This structure contains a unique i_id field. ids are
52  * not recycled when an item is destroyed.
53  *
54  * Input items are not used directly, but through playlist items.
55  * The playlist items are themselves in a tree structure. They only contain
56  * a link to the input item, a unique id and a few flags. the playlist
57  * item id is NOT the same as the input item id.
58  * Several playlist items can be attached to a single input item. The input
59  * item is refcounted and is automatically destroyed when it is not used
60  * anymore.
61  *
62  * In the playlist itself, there are two trees, that should always be kept
63  * in sync. The "category" tree contains the whole tree structure with
64  * several levels, while the onelevel tree contains only one level :), ie
65  * it only contains "real" items, not nodes
66  * For example, if you open a directory, you will have
67  *\verbatim
68  * Category tree:               Onelevel tree:
69  * Playlist                     Playlist
70  *  - Dir                         - item1
71  *    - Subdir                    - item2
72  *      - item1
73  *      - item2
74  *\endverbatim
75  * The top-level items of both tree are the same, and they are reproduced
76  * in the left-part of the playlist GUIs, they are the "sources" from the
77  * source selectors. Top-level items include: playlist, media library, SAP,
78  * Shoutcast, devices, ...
79  *
80  * It is envisioned that a third tree will appear: VLM, but it's not done yet
81  *
82  * The playlist also stores, for utility purposes, an array of all input
83  * items, an array of all playlist items and an array of all playlist items
84  * and nodes (both are represented by the same structure).
85  *
86  * So, here is an example:
87  * \verbatim
88  * Inputs array
89  *  - input 1 -> name = foo 1 uri = ...
90  *  - input 2 -> name = foo 2 uri = ...
91  *
92  * Category tree                        Onelevel tree
93  * - playlist (id 1)                    - playlist (id 3)
94  *    - category 1 (id 2)                - foo 2 (id 8 - input 2)
95  *      - foo 2 (id 6 - input 2)       - media library (id 4)
96  * - media library (id 2)                - foo 1 (id6 - input 1)
97  *    - foo 1 (id 5 - input 1)
98  * \endverbatim
99  * Sometimes, an item must be transformed to a node. This happens for the
100  * directory access for example. In that case, the item is removed from
101  * the onelevel tree, as it is not a real item anymore.
102  *
103  * For "standard" item addition, you can use playlist_Add, playlist_AddExt
104  * (more options) or playlist_AddInput if you already created your input
105  * item. This will add the item at the root of "Playlist" or of "Media library"
106  * in each of the two trees.
107  *
108  * If you want more control (like, adding the item as the child of a given
109  * node in the category tree, use playlist_BothAddInput. You'll have to provide
110  * the node in the category tree. The item will be added as a child of
111  * this node in the category tree, and as a child of the matching top-level
112  * node in the onelevel tree. (Nodes are created with playlist_NodeCreate)
113  *
114  * Generally speaking, playlist_NodeAddInput should not be used in newer code, it
115  * will maybe become useful again when we merge VLM;
116  *
117  * To delete an item, use playlist_DeleteFromInput( input_id ) which will
118  * remove all occurrences of the input in both trees
119  *
120  * @{
121  */
122
123 /** Helper structure to export to file part of the playlist */
124 struct playlist_export_t
125 {
126     char *psz_filename;
127     FILE *p_file;
128     playlist_item_t *p_root;
129 };
130
131 /** playlist item / node */
132 struct playlist_item_t
133 {
134     input_item_t           *p_input;    /**< Linked input item */
135     /** Number of children, -1 if not a node */
136     int                    i_children;
137     playlist_item_t      **pp_children; /**< Children nodes/items */
138     playlist_item_t       *p_parent;    /**< Item parent */
139
140     int                    i_id;        /**< Playlist item specific id */
141     uint8_t                i_flags;     /**< Flags */
142     playlist_t            *p_playlist;  /**< Parent playlist */
143 };
144
145 #define PLAYLIST_SAVE_FLAG      0x0001    /**< Must it be saved */
146 #define PLAYLIST_SKIP_FLAG      0x0002    /**< Must playlist skip after it ? */
147 #define PLAYLIST_DBL_FLAG       0x0004    /**< Is it disabled ? */
148 #define PLAYLIST_RO_FLAG        0x0008    /**< Write-enabled ? */
149 #define PLAYLIST_REMOVE_FLAG    0x0010    /**< Remove this item at the end */
150 #define PLAYLIST_EXPANDED_FLAG  0x0020    /**< Expanded node */
151
152 /** Playlist status */
153 typedef enum
154 { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
155
156 /** Structure containing information about the playlist */
157 struct playlist_t
158 {
159     VLC_COMMON_MEMBERS
160
161     struct playlist_services_discovery_support_t {
162         /* the playlist items for category and onelevel */
163         playlist_item_t*    p_cat;
164         playlist_item_t*    p_one;
165         services_discovery_t * p_sd; /**< Loaded service discovery modules */
166     } ** pp_sds;
167     int                   i_sds;   /**< Number of service discovery modules */
168
169     playlist_item_array_t items; /**< Arrays of items */
170     playlist_item_array_t all_items; /**< Array of items and nodes */
171     playlist_item_array_t items_to_delete; /**< Array of items and nodes to
172             delete... At the very end. This sucks. */
173
174     playlist_item_array_t current; /**< Items currently being played */
175     int                   i_current_index; /**< Index in current array */
176     /** Reset current item array */
177     bool            b_reset_currently_playing;
178     mtime_t               last_rebuild_date;
179
180     int                   i_last_playlist_id; /**< Last id to an item */
181
182     /* Predefined items */
183     playlist_item_t *     p_root_category; /**< Root of category tree */
184     playlist_item_t *     p_root_onelevel; /**< Root of onelevel tree */
185     playlist_item_t *     p_local_category; /** < "Playlist" in CATEGORY view */
186     playlist_item_t *     p_ml_category; /** < "Library" in CATEGORY view */
187     playlist_item_t *     p_local_onelevel; /** < "Playlist" in ONELEVEL view */
188     playlist_item_t *     p_ml_onelevel; /** < "Library" in ONELEVEL view */
189
190     bool                  b_tree; /**< Display as a tree */
191
192     bool            b_doing_ml; /**< Doing media library stuff,
193                                        * get quicker */
194     bool            b_auto_preparse;
195
196     /* Runtime */
197     input_thread_t *      p_input;  /**< the input thread associated
198                                      * with the current item */
199     int                   i_sort; /**< Last sorting applied to the playlist */
200     int                   i_order; /**< Last ordering applied to the playlist */
201     mtime_t               gc_date;
202     bool            b_cant_sleep;
203
204     struct {
205         /* Current status. These fields are readonly, only the playlist
206          * main loop can touch it*/
207         playlist_status_t   i_status;  /**< Current status of playlist */
208         playlist_item_t *   p_item; /**< Currently playing/active item */
209         playlist_item_t *   p_node; /**< Current node to play from */
210     } status;
211
212     struct {
213         /* Request. Use this to give orders to the playlist main loop  */
214         playlist_status_t   i_status; /**< requested playlist status */
215         playlist_item_t *   p_node;   /**< requested node to play from */
216         playlist_item_t *   p_item;   /**< requested item to play in the node */
217
218         int                 i_skip;   /**< Number of items to skip */
219
220         bool          b_request;/**< Set to true by the requester
221                                            The playlist sets it back to false
222                                            when processing the request */
223         vlc_mutex_t         lock;     /**< Lock to protect request */
224     } request;
225 };
226
227 /** Helper to add an item */
228 struct playlist_add_t
229 {
230     int i_node;
231     int i_item;
232     int i_position;
233 };
234
235 #define SORT_ID 0
236 #define SORT_TITLE 1
237 #define SORT_TITLE_NODES_FIRST 2
238 #define SORT_ARTIST 3
239 #define SORT_GENRE 4
240 #define SORT_RANDOM 5
241 #define SORT_DURATION 6
242 #define SORT_TITLE_NUMERIC 7
243 #define SORT_ALBUM 8
244 #define SORT_TRACK_NUMBER 9
245 #define SORT_DESCRIPTION 10
246 #define SORT_RATING 11
247 #define SORT_URI 12
248
249 #define ORDER_NORMAL 0
250 #define ORDER_REVERSE 1
251
252 /* Used by playlist_Import */
253 #define PLAYLIST_INSERT          0x0001
254 #define PLAYLIST_APPEND          0x0002
255 #define PLAYLIST_GO              0x0004
256 #define PLAYLIST_PREPARSE        0x0008
257 #define PLAYLIST_SPREPARSE       0x0010
258 #define PLAYLIST_NO_REBUILD      0x0020
259
260 #define PLAYLIST_END           -666
261
262 enum pl_locked_state
263 {
264     pl_Locked = true,
265     pl_Unlocked = false
266 };
267
268 /*****************************************************************************
269  * Prototypes
270  *****************************************************************************/
271
272 /* Helpers */
273 #define PL_LOCK vlc_object_lock( p_playlist )
274 #define PL_UNLOCK vlc_object_unlock( p_playlist )
275
276 VLC_EXPORT( playlist_t *, __pl_Hold, ( vlc_object_t * ) );
277 #define pl_Hold( a ) __pl_Hold( VLC_OBJECT(a) )
278
279 VLC_EXPORT( void, __pl_Release, ( vlc_object_t * ) );
280 #define pl_Release(a) __pl_Release( VLC_OBJECT(a) )
281
282 /* Playlist control */
283 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
284 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
285 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
286 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
287 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
288 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked,  i)
289
290 /**
291  * Do a playlist action.
292  * If there is something in the playlist then you can do playlist actions.
293  * Possible queries are listed in vlc_common.h
294  * \param p_playlist the playlist to do the command on
295  * \param i_query the command to do
296  * \param b_locked TRUE if playlist is locked when entering this function
297  * \param variable number of arguments
298  * \return VLC_SUCCESS or an error
299  */
300 VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, bool b_locked, ...  ) );
301
302 /** Get current playing input. The object is retained.
303  */
304 VLC_EXPORT( input_thread_t *, playlist_CurrentInput, ( playlist_t *p_playlist ) );
305
306 /** Clear the playlist
307  * \param b_locked TRUE if playlist is locked when entering this function
308  */
309 VLC_EXPORT( void,  playlist_Clear, ( playlist_t *, bool ) );
310
311 /** Enqueue an input item for preparsing */
312 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
313
314 /** Enqueue a playlist item and all of its children if any for preparsing */
315 VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) );
316 /** Request the art for an input item to be fetched */
317 VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *) );
318
319 /********************** Services discovery ***********************/
320
321 /** Add a list of comma-separated service discovery modules */
322 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
323 /** Remove a services discovery module by name */
324 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
325 /** Check whether a given SD is loaded */
326 VLC_EXPORT( bool, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
327
328 /* Playlist sorting */
329 VLC_EXPORT( int,  playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
330 VLC_EXPORT( int,  playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
331
332 /**
333  * Export a node of the playlist to a certain type of playlistfile
334  * \param p_playlist the playlist to export
335  * \param psz_filename the location where the exported file will be saved
336  * \param p_export_root the root node to export
337  * \param psz_type the type of playlist file to create (m3u, pls, ..)
338  * \return VLC_SUCCESS on success
339  */
340 VLC_EXPORT( int,  playlist_Export, ( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type ) );
341
342 /********************************************************
343  * Item management
344  ********************************************************/
345
346 /*************************** Item creation **************************/
347
348 VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( playlist_t *,const char *,const char *, int , const char *const *, int, int) );
349
350 /** Create a new item, without adding it to the playlist
351  * \param p_obj a vlc object (anyone will do)
352  * \param psz_uri the mrl of the item
353  * \param psz_name a text giving a name or description of the item
354  * \return the new item or NULL on failure
355  */
356 #define playlist_ItemNew( a , b, c ) \
357     playlist_ItemNewWithType( VLC_OBJECT(a) , b , c, 0, NULL, -1, 0 )
358
359
360 /*************************** Item deletion **************************/
361 VLC_EXPORT( int,  playlist_DeleteFromInput, ( playlist_t *, int, bool ) );
362
363 /*************************** Item fields accessors **************************/
364 VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, const char * ) );
365
366 /******************** Item addition ********************/
367 VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int, bool, bool ) );
368 VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char *const *,int, bool, bool ) );
369 VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, bool, bool ) );
370 VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int*, bool ) );
371
372 /********************** Misc item operations **********************/
373 VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *, bool) );
374
375 /********************************** Item search *************************/
376 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int, bool ) );
377 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t *, bool ) );
378 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInputId, (playlist_t *, int, playlist_item_t *) );
379
380 VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) );
381
382 /********************************************************
383  * Tree management
384  ********************************************************/
385 VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
386
387 /* Node management */
388 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_flags, input_item_t * ) );
389 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) );
390 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) );
391 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
392 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
393 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, bool , bool ) );
394 VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, bool ) );
395 VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, const char *, playlist_item_t **, playlist_item_t **, bool ) );
396 VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) );
397 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 ) );
398 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 ) );
399 VLC_EXPORT( playlist_item_t *, playlist_GetLastLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root ) );
400
401 /***********************************************************************
402  * Inline functions
403  ***********************************************************************/
404 /** Open a playlist file, add its content to the current playlist */
405 static inline int playlist_Import( playlist_t *p_playlist, const char *psz_file)
406 {
407     char psz_uri[256+10];
408     input_item_t *p_input;
409     snprintf( psz_uri, 256+9, "file/://%s", psz_file );
410     const char *const psz_option = "meta-file";
411     p_input = input_item_NewExt( p_playlist, psz_uri, psz_file,
412                                 1, &psz_option, -1 );
413     playlist_AddInput( p_playlist, p_input, PLAYLIST_APPEND, PLAYLIST_END,
414                        true, false );
415     input_Read( p_playlist, p_input, true );
416     return VLC_SUCCESS;
417 }
418
419 /** Small helper tp get current playing input or NULL. Release the input after use. */
420 #define pl_CurrentInput(a) __pl_CurrentInput( VLC_OBJECT(a) )
421 static  inline input_thread_t * __pl_CurrentInput( vlc_object_t * p_this )
422 {
423     playlist_t * p_playlist = pl_Hold( p_this );
424     if( !p_playlist ) return NULL;
425     input_thread_t * p_input = playlist_CurrentInput( p_playlist );
426     pl_Release( p_this );
427     return p_input;
428 }
429
430 /** Tell if the playlist is currently running */
431 #define playlist_IsPlaying( pl ) ( pl->status.i_status == PLAYLIST_RUNNING && \
432             !(pl->request.b_request && pl->request.i_status == PLAYLIST_STOPPED) )
433
434 #define playlist_IsStopped( pl ) ( pl->status.i_status == PLAYLIST_STOPPED || \
435             (pl->request.b_request && pl->request.i_status == PLAYLIST_STOPPED) )
436
437 /** Tell if the playlist is empty */
438 #define playlist_IsEmpty( pl ) ( pl->items.i_size == 0 )
439
440 /** Tell the number of items in the current playing context */
441 #define playlist_CurrentSize( pl ) pl->current.i_size
442
443 /** Tell the current item id in current  playing context */
444 #define playlist_CurrentId( pl ) pl->status.p_item->i_id
445
446 /** Ask the playlist to do some work */
447 #define playlist_Signal( p_playlist ) vlc_object_signal( p_playlist )
448
449 /** @} */
450 # ifdef __cplusplus
451 }
452 # endif
453
454 #endif