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