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