vlc_playlist.h 16.3 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_playlist.h : Playlist functions
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
4
 * Copyright (C) 1999-2004 VLC authors and VideoLAN
5
 * $Id$
6
 *
7
 * Authors: Samuel Hocevar <sam@zoy.org>
8
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
9 10 11
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
12
 * (at your option) any later version.
13
 *
14 15
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
18
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
19 20 21
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23
 *****************************************************************************/

24 25
#ifndef VLC_PLAYLIST_H_
#define VLC_PLAYLIST_H_
26

27 28 29 30
# ifdef __cplusplus
extern "C" {
# endif

31
#include <vlc_events.h>
32
#include <vlc_aout.h>
33

34
TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t)
35

36 37
struct intf_thread_t;

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
38
/**
39
 * \defgroup playlist VLC playlist
40 41
 * VLC playlist controls
 * @{
Clément Stenac's avatar
Clément Stenac committed
42
 * \file
43
 * VLC playlist control interface
44 45 46 47
 *
 * The VLC playlist system has a tree structure. This allows advanced
 * categorization, like for SAP streams (which are grouped by "sap groups").
 *
48 49
 * The base structure for all playlist operations is the playlist_item_t.
 * This is essentially a node within the playlist tree. Each playlist item
50
 * references an input_item_t which contains the input stream info, such as
51
 * location, name and meta-data.
52
 *
53 54 55 56
 * A playlist item is uniquely identified by its input item:
 * \ref playlist_ItemGetByInput(). A single input item cannot be used by more
 * than one playlist item at a time; if necessary, a copy of the input item can
 * be made instead.
57
 *
58 59
 * The same playlist tree is visible to all user interfaces. To arbitrate
 * access, a lock is used, see \ref playlist_Lock() and \ref playlist_Unlock().
60
 *
61
 * Under the playlist root item node, the top-level items are the main
62 63 64 65 66
 * media sources and include:
 * - the actual playlist,
 * - the media library,
 * - the service discovery root node, whose children are services discovery
 *   module instances.
67 68
 *
 * So, here is an example:
69
 * \verbatim
70 71 72 73
 * Inputs array
 *  - input 1 -> name = foo 1 uri = ...
 *  - input 2 -> name = foo 2 uri = ...
 *
74 75 76 77 78
 * Playlist items tree
 * - playlist (id 1)
 *    - category 1 (id 2)
 *      - foo 2 (id 6 - input 2)
 * - media library (id 2)
79
 *    - foo 1 (id 5 - input 1)
80
 * \endverbatim
81 82
 *
 * Sometimes, an item creates subitems. This happens for the directory access
83 84
 * for example. In that case, if the item is under the "playlist" top-level
 * item and playlist is configured to be flat then the item will be deleted and
85 86 87
 * replaced with new subitems. If the item is under another top-level item, it
 * will be transformed to a node and removed from the list of all items without
 * nodes.
88
 *
89 90
 * For "standard" item addition, you can use playlist_Add(), playlist_AddExt()
 * (more options) or playlist_AddInput() if you already created your input
91 92 93
 * item. This will add the item at the root of "Playlist" or of "Media library"
 * in each of the two trees.
 *
94 95 96
 * You can create nodes with playlist_NodeCreate() and can create items from
 * existing input items to be placed under any node with
 * playlist_NodeAddInput().
97
 *
98
 * To delete an item, use playlist_NodeDelete( p_item ).
99
 *
100
 * The playlist defines the following event variables:
101
 *
102 103
 * - "item-change": It will contain a pointer to the input_item_t of a
 * changed input item monitored by the playlist.
104
 *
105
 * - "playlist-item-append": It will contain a pointer to a playlist_item_t.
106 107
 * - "playlist-item-deleted": It will contain a pointer to the playlist_item_t
 * about to be deleted.
108
 *
109 110
 * - "leaf-to-parent": It will contain the playlist_item_t->i_id of an item that is transformed
 *   into a node.
111
 *
112 113
 * The playlist contains rate-variable which is propagated to current input if
 * available also rate-slower/rate-faster is in use.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
114 115
 */

116
/** Helper structure to export to file part of the playlist */
117
typedef struct playlist_export_t
118
{
119
    struct vlc_common_members obj;
120
    char *base_url;
121
    FILE *p_file;
122
    playlist_item_t *p_root;
123
} playlist_export_t;
124

125
/** playlist item / node */
126
struct playlist_item_t
127
{
128
    input_item_t           *p_input;    /**< Linked input item */
129

130
    playlist_item_t      **pp_children; /**< Children nodes/items */
131
    playlist_item_t       *p_parent;    /**< Item parent */
132
    int                    i_children;  /**< Number of children, -1 if not a node */
133
    unsigned               i_nb_played; /**< Times played */
134

135
    int                    i_id;        /**< Playlist item specific id */
136
    uint8_t                i_flags;     /**< Flags \see playlist_item_flags_e */
137
};
138

139
typedef enum {
140 141 142 143
    PLAYLIST_DBL_FLAG          = 0x04,  /**< Is it disabled ? */
    PLAYLIST_RO_FLAG           = 0x08,  /**< Write-enabled ? */
    PLAYLIST_SUBITEM_STOP_FLAG = 0x40,  /**< Must playlist stop if the item gets subitems ?*/
    PLAYLIST_NO_INHERIT_FLAG   = 0x80,  /**< Will children inherit flags the R/O flag ? */
144
} playlist_item_flags_e;
145

146
/** Playlist status */
147 148
typedef enum
{ PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
149

150
/** Structure containing information about the playlist */
151
struct playlist_t
152
{
153
    struct vlc_common_members obj;
154

Clément Stenac's avatar
Clément Stenac committed
155 156 157 158
    playlist_item_array_t items; /**< Arrays of items */

    playlist_item_array_t current; /**< Items currently being played */
    int                   i_current_index; /**< Index in current array */
Clément Stenac's avatar
Clément Stenac committed
159

160
    /* Predefined items */
161 162 163
    playlist_item_t  root;
    playlist_item_t *p_playing;
    playlist_item_t *p_media_library;
164
};
165

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
/* A bit of macro magic to generate an enum out of the following list,
 * and later, to generate a list of static functions out of the same list.
 * There is also SORT_RANDOM, which is always last and handled specially.
 */
#define VLC_DEFINE_SORT_FUNCTIONS \
    DEF( SORT_ID )\
    DEF( SORT_TITLE )\
    DEF( SORT_TITLE_NODES_FIRST )\
    DEF( SORT_ARTIST )\
    DEF( SORT_GENRE )\
    DEF( SORT_DURATION )\
    DEF( SORT_TITLE_NUMERIC )\
    DEF( SORT_ALBUM )\
    DEF( SORT_TRACK_NUMBER )\
    DEF( SORT_DESCRIPTION )\
    DEF( SORT_RATING )\
182
    DEF( SORT_URI )\
183 184
    DEF( SORT_DISC_NUMBER )\
    DEF( SORT_DATE )
185 186

#define DEF( s ) s,
187 188
enum
{
189 190 191
    VLC_DEFINE_SORT_FUNCTIONS
    SORT_RANDOM,
    NUM_SORT_FNS=SORT_RANDOM
192
};
193 194 195 196 197
#undef  DEF
#ifndef VLC_INTERNAL_PLAYLIST_SORT_FUNCTIONS
#undef  VLC_DEFINE_SORT_FUNCTIONS
#endif

198 199 200 201 202
enum
{
    ORDER_NORMAL = 0,
    ORDER_REVERSE = 1,
};
203

204
#define PLAYLIST_END           -1
205

206 207 208 209 210 211
enum pl_locked_state
{
    pl_Locked = true,
    pl_Unlocked = false
};

212 213 214
/*****************************************************************************
 * Prototypes
 *****************************************************************************/
215

216
/* Helpers */
217 218 219
#define PL_LOCK playlist_Lock( p_playlist )
#define PL_UNLOCK playlist_Unlock( p_playlist )
#define PL_ASSERT_LOCKED playlist_AssertLocked( p_playlist )
220

221 222 223 224 225
/** Playlist commands */
enum {
    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
    PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
                        /**  arg2 = playlist_item_t*          , res=can fail */
226
    PLAYLIST_TOGGLE_PAUSE, /**< No arg                          res=can fail */
227 228
    PLAYLIST_STOP,      /**< No arg                             res=can fail*/
    PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
229 230
    PLAYLIST_PAUSE,     /**< No arg */
    PLAYLIST_RESUME,    /**< No arg */
231 232
};

233
#define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
234 235
#define playlist_TogglePause(p) \
        playlist_Control(p, PLAYLIST_TOGGLE_PAUSE, pl_Unlocked)
236 237 238
#define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
#define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
#define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
239
#define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked,  (i) )
240 241 242 243
#define playlist_Pause(p) \
        playlist_Control(p, PLAYLIST_PAUSE, pl_Unlocked)
#define playlist_Resume(p) \
        playlist_Control(p, PLAYLIST_RESUME, pl_Unlocked)
244

245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
/**
 * Locks the playlist.
 *
 * This function locks the playlist. While the playlist is locked, no other
 * thread can modify the playlist tree layout or current playing item and node.
 *
 * Locking the playlist is necessary before accessing, either for reading or
 * writing, any playlist item.
 *
 * \note Because of the potential for lock inversion / deadlocks, locking the
 * playlist shall not be attemped while holding an input item lock. An input
 * item lock can be acquired while holding the playlist lock.
 *
 * While holding the playlist lock, a thread shall not attempt to:
 * - probe, initialize or deinitialize a module or a plugin,
 * - install or deinstall a variable or event callback,
 * - set a variable or trigger a variable callback, with the sole exception
262
 *   of the playlist core triggering add/remove/leaf item callbacks,
263 264 265 266
 * - invoke a module/plugin callback other than:
 *   - playlist export,
 *   - logger message callback.
 */
267
VLC_API void playlist_Lock( playlist_t * );
268 269 270 271 272 273 274 275

/**
 * Unlocks the playlist.
 *
 * This function unlocks the playlist, allowing other threads to lock it. The
 * calling thread must have called playlist_Lock() before.
 *
 * This function invalidates all or any playlist item pointers.
276
 * There are no ways to ensure that playlist items are not modified or deleted
277 278 279 280 281 282 283 284 285 286 287 288 289 290
 * by another thread past this function call.
 *
 * To retain a reference to a playlist item while not holding the playlist
 * lock, a thread should take a reference to the input item within the
 * playlist item before unlocking. If this is not practical, then the thread
 * can store the playlist item ID (i_id) before unlocking.
 * Either way, this will not ensure that the playlist item is not deleted, so
 * the thread must be ready to handle that case later when calling
 * playlist_ItemGetByInput() or playlist_ItemGetById().
 *
 * Furthermore, if ID is used, then the playlist item might be deleted, and
 * another item could be assigned the same ID. To avoid that problem, use
 * the input item instead of the ID.
 */
291
VLC_API void playlist_Unlock( playlist_t * );
292

293
VLC_API void playlist_AssertLocked( playlist_t * );
294
VLC_API void playlist_Deactivate( playlist_t * );
295

296 297 298 299 300 301 302 303 304
/**
 * Do a playlist action.
 * If there is something in the playlist then you can do playlist actions.
 * Possible queries are listed in vlc_common.h
 * \param p_playlist the playlist to do the command on
 * \param i_query the command to do
 * \param b_locked TRUE if playlist is locked when entering this function
 * \param variable number of arguments
 */
305
VLC_API void playlist_Control( playlist_t *p_playlist, int i_query, int b_locked, ...  );
306

307 308 309 310 311 312
static inline void playlist_ViewPlay(playlist_t *pl, playlist_item_t *node,
                                     playlist_item_t *item)
{
    playlist_Control(pl, PLAYLIST_VIEWPLAY, pl_Locked, node, item);
}

313 314
/** Get current playing input. The object is retained.
 */
315
VLC_API input_thread_t * playlist_CurrentInput( playlist_t *p_playlist ) VLC_USED;
316
VLC_API input_thread_t *playlist_CurrentInputLocked( playlist_t *p_playlist ) VLC_USED;
317

318 319 320 321
/** Get the duration of all items in a node.
 */
VLC_API mtime_t playlist_GetNodeDuration( playlist_item_t * );

322 323 324
/** Clear the playlist
 * \param b_locked TRUE if playlist is locked when entering this function
 */
325
VLC_API void playlist_Clear( playlist_t *, bool );
326

327
/* Playlist sorting */
328 329 330
VLC_API int playlist_TreeMove( playlist_t *, playlist_item_t *, playlist_item_t *, int );
VLC_API int playlist_TreeMoveMany( playlist_t *, int, playlist_item_t **, playlist_item_t *, int );
VLC_API int playlist_RecursiveNodeSort( playlist_t *, playlist_item_t *,int, int );
331

332
VLC_API playlist_item_t * playlist_CurrentPlayingItem( playlist_t * ) VLC_USED;
333
VLC_API int playlist_Status( playlist_t * );
334

335 336
/**
 * Export a node of the playlist to a certain type of playlistfile
337
 * \param b_playlist true for the playlist, false for the media library
338 339 340 341
 * \param psz_filename the location where the exported file will be saved
 * \param psz_type the type of playlist file to create (m3u, pls, ..)
 * \return VLC_SUCCESS on success
 */
342 343
VLC_API int playlist_Export( playlist_t *p_playlist, const char *psz_name,
                             bool b_playlist, const char *psz_type );
344

345 346 347
/**
 * Open a playlist file, add its content to the current playlist
 */
348
VLC_API int playlist_Import( playlist_t *p_playlist, const char *psz_file );
349

350 351
/********************** Services discovery ***********************/

352
/** Add a service discovery module */
353
VLC_API int playlist_ServicesDiscoveryAdd(playlist_t *, const char *);
354
/** Remove a services discovery module by name */
355
VLC_API int playlist_ServicesDiscoveryRemove(playlist_t *, const char *);
356
/** Check whether a given SD is loaded */
357
VLC_API bool playlist_IsServicesDiscoveryLoaded( playlist_t *,const char *) VLC_DEPRECATED;
358
/** Query a services discovery */
359
VLC_API int playlist_ServicesDiscoveryControl( playlist_t *, const char *, int, ... );
360

361 362 363 364 365 366 367 368
/********************** Renderer ***********************/
/**
 * Sets a renderer or remove the current one
 * @param p_item    The renderer item to be used, or NULL to disable the current
 *                  one. If a renderer is provided, its reference count will be
 *                  incremented.
 */
VLC_API int playlist_SetRenderer( playlist_t* p_pl, vlc_renderer_item_t* p_item );
369 370


371 372 373 374 375
/********************************************************
 * Item management
 ********************************************************/

/******************** Item addition ********************/
376
VLC_API int playlist_Add( playlist_t *, const char *, bool );
377
VLC_API int playlist_AddExt( playlist_t *, const char *, const char *, bool, int, const char *const *, unsigned, bool );
378
VLC_API int playlist_AddInput( playlist_t *, input_item_t *, bool, bool );
379
VLC_API playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *, playlist_item_t *, int );
380
VLC_API int playlist_NodeAddCopy( playlist_t *, playlist_item_t *, playlist_item_t *, int );
381

382
/********************************** Item search *************************/
383
VLC_API playlist_item_t * playlist_ItemGetById(playlist_t *, int ) VLC_USED;
384 385 386
VLC_API playlist_item_t *playlist_ItemGetByInput(playlist_t *,
                                                 const input_item_t * )
VLC_USED;
387

388
VLC_API int playlist_LiveSearchUpdate(playlist_t *, playlist_item_t *, const char *, bool );
389

390 391 392 393
/********************************************************
 * Tree management
 ********************************************************/
/* Node management */
394
VLC_API playlist_item_t * playlist_NodeCreate( playlist_t *, const char *, playlist_item_t * p_parent, int i_pos, int i_flags );
395
VLC_API playlist_item_t * playlist_ChildSearchName(playlist_item_t*, const char* ) VLC_USED;
396
VLC_API void playlist_NodeDelete( playlist_t *, playlist_item_t * );
397

398 399 400 401
/**************************
 * Audio output management
 **************************/

402 403
VLC_API audio_output_t *playlist_GetAout( playlist_t * );

404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
VLC_API float playlist_VolumeGet( playlist_t * );
VLC_API int playlist_VolumeSet( playlist_t *, float );
VLC_API int playlist_VolumeUp( playlist_t *, int, float * );
#define playlist_VolumeDown(a, b, c) playlist_VolumeUp(a, -(b), c)
VLC_API int playlist_MuteSet( playlist_t *, bool );
VLC_API int playlist_MuteGet( playlist_t * );

static inline int playlist_MuteToggle( playlist_t *pl )
{
    int val = playlist_MuteGet( pl );
    if (val >= 0)
        val = playlist_MuteSet( pl, !val );
    return val;
}

VLC_API void playlist_EnableAudioFilter( playlist_t *, const char *, bool );

421 422 423
/***********************************************************************
 * Inline functions
 ***********************************************************************/
424
/** Tell if the playlist is empty */
425 426 427 428 429
static inline bool playlist_IsEmpty( playlist_t *p_playlist )
{
    PL_ASSERT_LOCKED;
    return p_playlist->items.i_size == 0;
}
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
430

431
/** Tell the number of items in the current playing context */
432 433 434 435 436
static inline int playlist_CurrentSize( playlist_t *p_playlist )
{
    PL_ASSERT_LOCKED;
    return p_playlist->current.i_size;
}
437

438
/** @} */
439 440 441
# ifdef __cplusplus
}
# endif
442 443

#endif