20bce26e89efb6b2f97388bd6205c9d68a0f52e6
[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 <vlc_events.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 occurences 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
162 struct services_discovery_t
163 {
164     VLC_COMMON_MEMBERS
165     char *              psz_module;
166     module_t *          p_module;
167
168     char *              psz_localized_name; /* Accessed through Setters for non class function */
169     vlc_event_manager_t event_manager;      /* Accessed through Setters for non class function */
170
171     services_discovery_sys_t *p_sys;
172     void (*pf_run) ( services_discovery_t *);
173 };
174
175 /** Structure containing information about the playlist */
176 struct playlist_t
177 {
178     VLC_COMMON_MEMBERS
179     int                   i_enabled; /**< How many items are enabled ? */
180
181     playlist_item_array_t items; /**< Arrays of items */
182     playlist_item_array_t all_items; /**< Array of items and nodes */
183
184     input_item_array_t    input_items; /**< Array of input items */
185
186     playlist_item_array_t current; /**< Items currently being played */
187     int                   i_current_index; /**< Index in current array */
188     /** Reset current item array */
189     vlc_bool_t            b_reset_currently_playing;
190     mtime_t               last_rebuild_date;
191
192     int                   i_last_playlist_id; /**< Last id to an item */
193     int                   i_last_input_id ; /**< Last id on an input */
194
195     struct playlist_archived_services_discovery_t {
196         services_discovery_t * p_sd; /* The service discovery module */
197         playlist_item_t      * p_cat;/* Corresponding item in the category view */
198         playlist_item_t      * p_one;/* Corresponding item in the one level view */
199     }                   **pp_asds; /**< Loaded service discovery modules */
200     int                   i_asds;   /**< Number of service discovery modules */
201
202     /* Predefined items */
203     playlist_item_t *     p_root_category; /**< Root of category tree */
204     playlist_item_t *     p_root_onelevel; /**< Root of onelevel tree */
205     playlist_item_t *     p_local_category; /** < "Playlist" in CATEGORY view */
206     playlist_item_t *     p_ml_category; /** < "Library" in CATEGORY view */
207     playlist_item_t *     p_local_onelevel; /** < "Playlist" in ONELEVEL view */
208     playlist_item_t *     p_ml_onelevel; /** < "Library" in ONELEVEL view */
209
210     vlc_bool_t            b_always_tree;/**< Always display as tree */
211     vlc_bool_t            b_never_tree;/**< Never display as tree */
212
213     vlc_bool_t            b_doing_ml; /**< Doing media library stuff,
214                                        * get quicker */
215     vlc_bool_t            b_auto_preparse;
216
217     /* Runtime */
218     input_thread_t *      p_input;  /**< the input thread associated
219                                      * with the current item */
220     int                   i_sort; /**< Last sorting applied to the playlist */
221     int                   i_order; /**< Last ordering applied to the playlist */
222     mtime_t               gc_date;
223     vlc_bool_t            b_cant_sleep;
224     playlist_preparse_t  *p_preparse; /**< Preparser object */
225     playlist_fetcher_t   *p_fetcher;/**< Meta and art fetcher object */
226
227     vlc_mutex_t gc_lock;         /**< Lock to protect the garbage collection */
228
229     struct {
230         /* Current status. These fields are readonly, only the playlist
231          * main loop can touch it*/
232         playlist_status_t   i_status;  /**< Current status of playlist */
233         playlist_item_t *   p_item; /**< Currently playing/active item */
234         playlist_item_t *   p_node; /**< Current node to play from */
235     } status;
236
237     struct {
238         /* Request. Use this to give orders to the playlist main loop  */
239         int                 i_status; /**< requested playlist status */
240         playlist_item_t *   p_node;   /**< requested node to play from */
241         playlist_item_t *   p_item;   /**< requested item to play in the node */
242
243         int                 i_skip;   /**< Number of items to skip */
244
245         vlc_bool_t          b_request;/**< Set to true by the requester
246                                            The playlist sets it back to false
247                                            when processing the request */
248         vlc_mutex_t         lock;     /**< Lock to protect request */
249     } request;
250
251     // Playlist-unrelated fields
252     interaction_t       *p_interaction;    /**< Interaction manager */
253     input_thread_t      *p_stats_computer; /**< Input thread computing stats */
254     global_stats_t      *p_stats;          /**< Global statistics */
255 };
256
257 /** Helper to add an item */
258 struct playlist_add_t
259 {
260     int i_node;
261     int i_item;
262     int i_position;
263 };
264
265 #define SORT_ID 0
266 #define SORT_TITLE 1
267 #define SORT_TITLE_NODES_FIRST 2
268 #define SORT_ARTIST 3
269 #define SORT_GENRE 4
270 #define SORT_RANDOM 5
271 #define SORT_DURATION 6
272 #define SORT_TITLE_NUMERIC 7
273 #define SORT_ALBUM 8
274
275 #define ORDER_NORMAL 0
276 #define ORDER_REVERSE 1
277
278 /*****************************************************************************
279  * Prototypes
280  *****************************************************************************/
281
282 /* Helpers */
283 #define PL_LOCK vlc_mutex_lock( &p_playlist->object_lock );
284 #define PL_UNLOCK vlc_mutex_unlock( &p_playlist->object_lock );
285
286 #define pl_Get( a ) a->p_libvlc->p_playlist
287 #define pl_Yield( a ) __pl_Yield( VLC_OBJECT(a) )
288 static inline playlist_t *__pl_Yield( vlc_object_t *p_this )
289 {
290     assert( p_this->p_libvlc->p_playlist );
291     vlc_object_yield( p_this->p_libvlc->p_playlist );
292     return p_this->p_libvlc->p_playlist;
293 }
294 #define pl_Release(a) vlc_object_release( a->p_libvlc->p_playlist );
295
296 /* Playlist control */
297 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, VLC_FALSE )
298 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, VLC_FALSE )
299 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, VLC_FALSE )
300 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, VLC_FALSE, 1)
301 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, VLC_FALSE, -1)
302 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, VLC_FALSE,  i)
303
304 /**
305  * Do a playlist action.
306  * If there is something in the playlist then you can do playlist actions.
307  * Possible queries are listed in vlc_common.h
308  * \param p_playlist the playlist to do the command on
309  * \param i_query the command to do
310  * \param b_locked TRUE if playlist is locked when entering this function
311  * \param variable number of arguments
312  * \return VLC_SUCCESS or an error
313  */
314 VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, vlc_bool_t b_locked, ...  ) );
315
316 /** Clear the playlist
317  * \param b_locked TRUE if playlist is locked when entering this function
318  */
319 VLC_EXPORT( void,  playlist_Clear, ( playlist_t *, vlc_bool_t ) );
320
321 /** Enqueue an input item for preparsing */
322 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
323
324 /** Enqueue a playlist item and all of its children if any for preparsing */
325 VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) );
326 /** Request the art for an input item to be fetched */
327 VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *) );
328
329 /********************** Services discovery ***********************/
330
331 /** Add a list of comma-separated service discovery modules */
332 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
333 /** Remove a services discovery module by name */
334 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
335 /** Check whether a given SD is loaded */
336 VLC_EXPORT( vlc_bool_t, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
337
338 /* Playlist sorting */
339 VLC_EXPORT( int,  playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
340 VLC_EXPORT( int,  playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
341
342 /**
343  * Export a node of the playlist to a certain type of playlistfile
344  * \param p_playlist the playlist to export
345  * \param psz_filename the location where the exported file will be saved
346  * \param p_export_root the root node to export
347  * \param psz_type the type of playlist file to create (m3u, pls, ..)
348  * \return VLC_SUCCESS on success
349  */
350 VLC_EXPORT( int,  playlist_Export, ( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type ) );
351
352 /********************************************************
353  * Item management
354  ********************************************************/
355
356 /*************************** Item creation **************************/
357
358 VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int , const char *const *, int, int) );
359
360 /** Create a new item, without adding it to the playlist
361  * \param p_obj a vlc object (anyone will do)
362  * \param psz_uri the mrl of the item
363  * \param psz_name a text giving a name or description of the item
364  * \return the new item or NULL on failure
365  */
366 #define playlist_ItemNew( a , b, c ) \
367     playlist_ItemNewWithType( VLC_OBJECT(a) , b , c, 0, NULL, -1, 0 )
368
369 #define playlist_ItemNewFromInput(a,b) __playlist_ItemNewFromInput(VLC_OBJECT(a),b)
370 VLC_EXPORT( playlist_item_t *, __playlist_ItemNewFromInput, ( vlc_object_t *p_obj,input_item_t *p_input ) );
371
372 /*************************** Item deletion **************************/
373 VLC_EXPORT( int,  playlist_DeleteFromInput, ( playlist_t *, int, vlc_bool_t ) );
374 VLC_EXPORT( int,  playlist_DeleteInputInParent, ( playlist_t *, int, playlist_item_t *, vlc_bool_t ) );
375
376 /*************************** Item fields accessors **************************/
377 VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, const char * ) );
378
379 /******************** Item addition ********************/
380 VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int, vlc_bool_t, vlc_bool_t ) );
381 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 ) );
382 VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, vlc_bool_t, vlc_bool_t ) );
383 VLC_EXPORT( playlist_item_t *, playlist_NodeAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, vlc_bool_t ) );
384 VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int*, vlc_bool_t ) );
385
386 /********************** Misc item operations **********************/
387 VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *, vlc_bool_t) );
388
389 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
390                                    int i_input_id, playlist_item_t *p_root,
391                                    vlc_bool_t );
392
393 /********************************** Item search *************************/
394 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int, vlc_bool_t ) );
395 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t *, vlc_bool_t ) );
396 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInputId, (playlist_t *, int, playlist_item_t *) );
397
398 VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) );
399
400 /********************************************************
401  * Tree management
402  ********************************************************/
403 VLC_EXPORT(void, playlist_NodeDump, ( playlist_t *p_playlist, playlist_item_t *p_item, int i_level ) );
404 VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
405
406 /* Node management */
407 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_flags ) );
408 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) );
409 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) );
410 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
411 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
412 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, vlc_bool_t , vlc_bool_t ) );
413 VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, vlc_bool_t ) );
414 VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, const char *, playlist_item_t **, playlist_item_t **, vlc_bool_t ) );
415 VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) );
416 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 ) ); 
417 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 ) ); 
418 VLC_EXPORT( playlist_item_t *, playlist_GetLastLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root ) );
419
420 /***********************************************************************
421  * Service Discovery
422  ***********************************************************************/
423 /* XXX: no need to inline */
424 /* XXX: no need to inline */
425 /* Return the number of services_discovery available */
426
427 /* Creation of a service_discovery object */
428 VLC_EXPORT( services_discovery_t *, services_discovery_Create, ( vlc_object_t * p_super, const char * psz_service_name ) );
429 VLC_EXPORT( void,                   services_discovery_Destroy, ( services_discovery_t * p_this ) );
430 VLC_EXPORT( int,                    services_discovery_Start, ( services_discovery_t * p_this ) );
431 VLC_EXPORT( void,                   services_discovery_Stop, ( services_discovery_t * p_this ) );
432
433 /* Read info from discovery object */
434 VLC_EXPORT( char *,                 services_discovery_GetLocalizedName, ( services_discovery_t * p_this ) );
435
436 /* Receive event notification (prefered way to get new items) */
437 VLC_EXPORT( vlc_event_manager_t *,  services_discovery_EventManager, ( services_discovery_t * p_this ) );
438
439 /* Used by services_discovery to post update about their items */
440 VLC_EXPORT( void,                   services_discovery_SetLocalizedName, ( services_discovery_t * p_this, const char * ) );
441     /* About the psz_category, it is a legacy way to add info to the item,
442      * for more options, directly set the (meta) data on the input item */
443 VLC_EXPORT( void,                   services_discovery_AddItem, ( services_discovery_t * p_this, input_item_t * p_item, const char * psz_category ) );
444 VLC_EXPORT( void,                   services_discovery_RemoveItem, ( services_discovery_t * p_this, input_item_t * p_item ) );
445
446 /***********************************************************************
447  * Inline functions
448  ***********************************************************************/
449 /** Open a playlist file, add its content to the current playlist */
450 static inline int playlist_Import( playlist_t *p_playlist, const char *psz_file)
451 {
452     char psz_uri[256+10];
453     input_item_t *p_input;
454     snprintf( psz_uri, 256+9, "file/://%s", psz_file );
455     p_input = input_ItemNewExt( p_playlist, psz_uri, psz_file, 0, NULL, -1 );
456     playlist_AddInput( p_playlist, p_input, PLAYLIST_APPEND, PLAYLIST_END,
457                        VLC_TRUE, VLC_FALSE );
458     input_Read( p_playlist, p_input, VLC_TRUE );
459     return VLC_SUCCESS;
460 }
461
462 /** Tell if the playlist is currently running */
463 #define playlist_IsPlaying( pl ) ( pl->status.i_status == PLAYLIST_RUNNING )
464
465 /** Tell if the playlist is empty */
466 #define playlist_IsEmpty( pl ) ( pl->items.i_size == 0 )
467
468 /** Tell the number of items in the current playing context */
469 #define playlist_CurrentSize( obj ) obj->p_libvlc->p_playlist->current.i_size
470
471 /** Ask the playlist to do some work */
472 static inline void playlist_Signal( playlist_t *p_playlist )
473 {
474     PL_LOCK;
475     vlc_cond_signal( &p_playlist->object_wait );
476     PL_UNLOCK;
477 }
478
479 /** @} */
480 # ifdef __cplusplus
481 }
482 # endif
483
484 #endif