playlist: Move more members as private.
[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     playlist_item_array_t items; /**< Arrays of items */
162     playlist_item_array_t all_items; /**< Array of items and nodes */
163     playlist_item_array_t items_to_delete; /**< Array of items and nodes to
164             delete... At the very end. This sucks. */
165
166     playlist_item_array_t current; /**< Items currently being played */
167     int                   i_current_index; /**< Index in current array */
168     /** Reset current item array */
169     bool            b_reset_currently_playing;
170     mtime_t               last_rebuild_date;
171
172     int                   i_last_playlist_id; /**< Last id to an item */
173
174     /* Predefined items */
175     playlist_item_t *     p_root_category; /**< Root of category tree */
176     playlist_item_t *     p_root_onelevel; /**< Root of onelevel tree */
177     playlist_item_t *     p_local_category; /** < "Playlist" in CATEGORY view */
178     playlist_item_t *     p_ml_category; /** < "Library" in CATEGORY view */
179     playlist_item_t *     p_local_onelevel; /** < "Playlist" in ONELEVEL view */
180     playlist_item_t *     p_ml_onelevel; /** < "Library" in ONELEVEL view */
181
182     bool                  b_tree; /**< Display as a tree */
183
184     bool            b_doing_ml; /**< Doing media library stuff,
185                                        * get quicker */
186     bool            b_auto_preparse;
187
188     /* Runtime */
189     int                   i_sort; /**< Last sorting applied to the playlist */
190     int                   i_order; /**< Last ordering applied to the playlist */
191     mtime_t               gc_date;
192     bool            b_cant_sleep;
193
194 };
195
196 /** Helper to add an item */
197 struct playlist_add_t
198 {
199     int i_node;
200     int i_item;
201     int i_position;
202 };
203
204 #define SORT_ID 0
205 #define SORT_TITLE 1
206 #define SORT_TITLE_NODES_FIRST 2
207 #define SORT_ARTIST 3
208 #define SORT_GENRE 4
209 #define SORT_RANDOM 5
210 #define SORT_DURATION 6
211 #define SORT_TITLE_NUMERIC 7
212 #define SORT_ALBUM 8
213 #define SORT_TRACK_NUMBER 9
214 #define SORT_DESCRIPTION 10
215 #define SORT_RATING 11
216 #define SORT_URI 12
217
218 #define ORDER_NORMAL 0
219 #define ORDER_REVERSE 1
220
221 /* Used by playlist_Import */
222 #define PLAYLIST_INSERT          0x0001
223 #define PLAYLIST_APPEND          0x0002
224 #define PLAYLIST_GO              0x0004
225 #define PLAYLIST_PREPARSE        0x0008
226 #define PLAYLIST_SPREPARSE       0x0010
227 #define PLAYLIST_NO_REBUILD      0x0020
228
229 #define PLAYLIST_END           -666
230
231 enum pl_locked_state
232 {
233     pl_Locked = true,
234     pl_Unlocked = false
235 };
236
237 /*****************************************************************************
238  * Prototypes
239  *****************************************************************************/
240
241 /* Helpers */
242 #define PL_LOCK vlc_object_lock( p_playlist )
243 #define PL_UNLOCK vlc_object_unlock( p_playlist )
244
245 VLC_EXPORT( playlist_t *, __pl_Hold, ( vlc_object_t * ) );
246 #define pl_Hold( a ) __pl_Hold( VLC_OBJECT(a) )
247
248 VLC_EXPORT( void, __pl_Release, ( vlc_object_t * ) );
249 #define pl_Release(a) __pl_Release( VLC_OBJECT(a) )
250
251 /* Playlist control */
252 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
253 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
254 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
255 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
256 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
257 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked,  i)
258
259 /**
260  * Do a playlist action.
261  * If there is something in the playlist then you can do playlist actions.
262  * Possible queries are listed in vlc_common.h
263  * \param p_playlist the playlist to do the command on
264  * \param i_query the command to do
265  * \param b_locked TRUE if playlist is locked when entering this function
266  * \param variable number of arguments
267  * \return VLC_SUCCESS or an error
268  */
269 VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, bool b_locked, ...  ) );
270
271 /** Get current playing input. The object is retained.
272  */
273 VLC_EXPORT( input_thread_t *, playlist_CurrentInput, ( playlist_t *p_playlist ) );
274
275 /** Clear the playlist
276  * \param b_locked TRUE if playlist is locked when entering this function
277  */
278 VLC_EXPORT( void,  playlist_Clear, ( playlist_t *, bool ) );
279
280 /** Enqueue an input item for preparsing */
281 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
282
283 /** Enqueue a playlist item and all of its children if any for preparsing */
284 VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) );
285 /** Request the art for an input item to be fetched */
286 VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *) );
287
288 /* Playlist sorting */
289 VLC_EXPORT( int,  playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
290 VLC_EXPORT( int,  playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
291
292 VLC_EXPORT( playlist_item_t *,  playlist_CurrentPlayingItem, ( playlist_t * ) );
293 VLC_EXPORT( int,  playlist_CurrentId, ( playlist_t * ) );
294 VLC_EXPORT( bool,  playlist_IsPlaying, ( playlist_t * ) );
295 VLC_EXPORT( int,   playlist_Status, ( playlist_t * ) );
296
297 /**
298  * Export a node of the playlist to a certain type of playlistfile
299  * \param p_playlist the playlist to export
300  * \param psz_filename the location where the exported file will be saved
301  * \param p_export_root the root node to export
302  * \param psz_type the type of playlist file to create (m3u, pls, ..)
303  * \return VLC_SUCCESS on success
304  */
305 VLC_EXPORT( int,  playlist_Export, ( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type ) );
306
307 /********************** Services discovery ***********************/
308
309 /** Add a list of comma-separated service discovery modules */
310 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
311 /** Remove a services discovery module by name */
312 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
313 /** Check whether a given SD is loaded */
314 VLC_EXPORT( bool, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
315
316
317
318 /********************************************************
319  * Item management
320  ********************************************************/
321
322 /*************************** Item creation **************************/
323
324 VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( playlist_t *,const char *,const char *, int , const char *const *, int, int) );
325
326 /** Create a new item, without adding it to the playlist
327  * \param p_obj a vlc object (anyone will do)
328  * \param psz_uri the mrl of the item
329  * \param psz_name a text giving a name or description of the item
330  * \return the new item or NULL on failure
331  */
332 #define playlist_ItemNew( a , b, c ) \
333     playlist_ItemNewWithType( VLC_OBJECT(a) , b , c, 0, NULL, -1, 0 )
334
335
336 /*************************** Item deletion **************************/
337 VLC_EXPORT( int,  playlist_DeleteFromInput, ( playlist_t *, int, bool ) );
338
339 /*************************** Item fields accessors **************************/
340 VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, const char * ) );
341
342 /******************** Item addition ********************/
343 VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int, bool, bool ) );
344 VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char *const *,int, bool, bool ) );
345 VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, bool, bool ) );
346 VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int*, bool ) );
347
348 /********************** Misc item operations **********************/
349 VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *, bool) );
350
351 /********************************** Item search *************************/
352 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int, bool ) );
353 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t *, bool ) );
354 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInputId, (playlist_t *, int, playlist_item_t *) );
355
356 VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) );
357
358 /********************************************************
359  * Tree management
360  ********************************************************/
361 VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
362
363 /* Node management */
364 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_flags, input_item_t * ) );
365 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) );
366 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) );
367 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
368 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
369 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, bool , bool ) );
370 VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, bool ) );
371 VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, const char *, playlist_item_t **, playlist_item_t **, bool ) );
372 VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) );
373 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 ) );
374 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 ) );
375 VLC_EXPORT( playlist_item_t *, playlist_GetLastLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root ) );
376
377 /***********************************************************************
378  * Inline functions
379  ***********************************************************************/
380 /** Open a playlist file, add its content to the current playlist */
381 static inline int playlist_Import( playlist_t *p_playlist, const char *psz_file)
382 {
383     char psz_uri[256+10];
384     input_item_t *p_input;
385     snprintf( psz_uri, 256+9, "file/://%s", psz_file );
386     const char *const psz_option = "meta-file";
387     p_input = input_item_NewExt( p_playlist, psz_uri, psz_file,
388                                 1, &psz_option, -1 );
389     playlist_AddInput( p_playlist, p_input, PLAYLIST_APPEND, PLAYLIST_END,
390                        true, false );
391     input_Read( p_playlist, p_input, true );
392     return VLC_SUCCESS;
393 }
394
395 /** Small helper tp get current playing input or NULL. Release the input after use. */
396 #define pl_CurrentInput(a) __pl_CurrentInput( VLC_OBJECT(a) )
397 static  inline input_thread_t * __pl_CurrentInput( vlc_object_t * p_this )
398 {
399     playlist_t * p_playlist = pl_Hold( p_this );
400     if( !p_playlist ) return NULL;
401     input_thread_t * p_input = playlist_CurrentInput( p_playlist );
402     pl_Release( p_this );
403     return p_input;
404 }
405
406 /** Tell if the playlist is empty */
407 #define playlist_IsEmpty( pl ) ( pl->items.i_size == 0 )
408
409 /** Tell the number of items in the current playing context */
410 #define playlist_CurrentSize( pl ) pl->current.i_size
411
412 /** Ask the playlist to do some work */
413 #define playlist_Signal( p_playlist ) vlc_object_signal( p_playlist )
414
415 /** @} */
416 # ifdef __cplusplus
417 }
418 # endif
419
420 #endif