vlc_playlist.h 14.7 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1
/*****************************************************************************
2
 * vlc_playlist.h : Playlist functions
Sam Hocevar's avatar
 
Sam Hocevar committed
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 1999-2004 VLC authors and VideoLAN
5
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
6
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
7
 * Authors: Samuel Hocevar <sam@zoy.org>
Sam Hocevar's avatar
 
Sam Hocevar committed
8
 *
Jean-Baptiste Kempf's avatar
LGPL  
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
Sam Hocevar's avatar
 
Sam Hocevar committed
12
 * (at your option) any later version.
Clément Stenac's avatar
Clément Stenac committed
13
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
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
LGPL  
Jean-Baptiste Kempf committed
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
Sam Hocevar's avatar
 
Sam Hocevar committed
18
 *
Jean-Baptiste Kempf's avatar
LGPL  
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.
Sam Hocevar's avatar
 
Sam Hocevar committed
22 23
 *****************************************************************************/

24 25
#ifndef VLC_PLAYLIST_H_
#define VLC_PLAYLIST_H_
26

Clément Stenac's avatar
Clément Stenac committed
27 28 29 30
# ifdef __cplusplus
extern "C" {
# endif

31
#include <vlc_events.h>
32

33
TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t)
34

35 36
struct intf_thread_t;

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
37
/**
38
 * \defgroup playlist VLC playlist
39 40
 * VLC playlist controls
 * @{
Clément Stenac's avatar
Clément Stenac committed
41
 * \file
42
 * VLC playlist control interface
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
 *
 * The VLC playlist system has a tree structure. This allows advanced
 * categorization, like for SAP streams (which are grouped by "sap groups").
 *
 * The base structure for all playlist operations is the input_item_t. This
 * contains all information needed to play a stream and get info, ie, mostly,
 * mrl and metadata. This structure contains a unique i_id field. ids are
 * not recycled when an item is destroyed.
 *
 * Input items are not used directly, but through playlist items.
 * The playlist items are themselves in a tree structure. They only contain
 * a link to the input item, a unique id and a few flags. the playlist
 * item id is NOT the same as the input item id.
 * Several playlist items can be attached to a single input item. The input
 * item is refcounted and is automatically destroyed when it is not used
 * anymore.
 *
Jakob Leben's avatar
Jakob Leben committed
60 61
 * The top-level items are the main media sources and include:
 * playlist, media library, SAP, Shoutcast, devices, ...
62 63 64 65 66 67 68 69
 *
 * It is envisioned that a third tree will appear: VLM, but it's not done yet
 *
 * The playlist also stores, for utility purposes, an array of all input
 * items, an array of all playlist items and an array of all playlist items
 * and nodes (both are represented by the same structure).
 *
 * So, here is an example:
70
 * \verbatim
71 72 73 74
 * Inputs array
 *  - input 1 -> name = foo 1 uri = ...
 *  - input 2 -> name = foo 2 uri = ...
 *
Jakob Leben's avatar
Jakob Leben committed
75 76 77 78 79
 * Playlist items tree
 * - playlist (id 1)
 *    - category 1 (id 2)
 *      - foo 2 (id 6 - input 2)
 * - media library (id 2)
80
 *    - foo 1 (id 5 - input 1)
81
 * \endverbatim
Jakob Leben's avatar
Jakob Leben committed
82 83 84 85 86 87 88
 *
 * Sometimes, an item creates subitems. This happens for the directory access
 * 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
 * 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.
89 90 91 92 93 94
 *
 * For "standard" item addition, you can use playlist_Add, playlist_AddExt
 * (more options) or playlist_AddInput if you already created your input
 * item. This will add the item at the root of "Playlist" or of "Media library"
 * in each of the two trees.
 *
Jakob Leben's avatar
Jakob Leben committed
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 101
 *
 * The playlist defines the following event variables:
102
 *
Jakob Leben's avatar
Jakob Leben committed
103
 * - "item-change": It will contain the input_item_t->i_id of a changed input
104
 * item monitored by the playlist.
105 106
 * item being played.
 *
107
 * - "playlist-item-append": It will contain a pointer to a playlist_item_t.
108 109
 * - "playlist-item-deleted": It will contain a pointer to the playlist_item_t
 * about to be deleted.
Jakob Leben's avatar
Jakob Leben committed
110
 *
111 112
 * - "leaf-to-parent": It will contain the playlist_item_t->i_id of an item that is transformed
 *   into a node.
Jakob Leben's avatar
Jakob Leben committed
113
 *
114 115
 * The playlist contains rate-variable which is propagated to current input if available
 * also rate-slower/rate-faster is in use
116
 *
117
 * \warning Be really careful, playlist_item_t->i_id and input_item_t->i_id
118
 * are not the same. Yes, the situation is pretty bad.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
119 120
 */

121
/** Helper structure to export to file part of the playlist */
122
typedef struct playlist_export_t
123
{
124 125
    VLC_COMMON_MEMBERS
    const char *psz_filename;
126
    FILE *p_file;
127
    playlist_item_t *p_root;
128
} playlist_export_t;
129

130
/** playlist item / node */
131
struct playlist_item_t
Sam Hocevar's avatar
 
Sam Hocevar committed
132
{
133
    input_item_t           *p_input;    /**< Linked input item */
134

135
    playlist_item_t      **pp_children; /**< Children nodes/items */
136
    playlist_item_t       *p_parent;    /**< Item parent */
137
    int                    i_children;  /**< Number of children, -1 if not a node */
138
    unsigned               i_nb_played; /**< Times played */
139

140
    int                    i_id;        /**< Playlist item specific id */
141 142
    uint8_t                i_flags;     /**< Flags \see playlist_item_flags_e */

143
    playlist_t            *p_playlist;  /**< Parent playlist */
144
};
Sam Hocevar's avatar
 
Sam Hocevar committed
145

146 147 148 149 150 151
typedef enum {
    PLAYLIST_SKIP_FLAG         = 0x0002,  /**< Must playlist skip after it ? */
    PLAYLIST_DBL_FLAG          = 0x0004,  /**< Is it disabled ? */
    PLAYLIST_RO_FLAG           = 0x0008,  /**< Write-enabled ? */
    PLAYLIST_EXPANDED_FLAG     = 0x0020,  /**< Expanded node */
    PLAYLIST_SUBITEM_STOP_FLAG = 0x0040,  /**< Must playlist stop if the item gets subitems ?*/
152
    PLAYLIST_NO_INHERIT_FLAG   = 0x0080,  /**< Childs must not inherit flags from parent node */
153
} playlist_item_flags_e;
154

155
/** Playlist status */
156 157
typedef enum
{ PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
158

159
/** Structure containing information about the playlist */
160
struct playlist_t
Sam Hocevar's avatar
 
Sam Hocevar committed
161
{
162
    VLC_COMMON_MEMBERS
163

Clément Stenac's avatar
Clément Stenac committed
164 165 166 167
    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
168

169
    /* Predefined items */
170 171 172
    playlist_item_t *     p_root;
    playlist_item_t *     p_playing;
    playlist_item_t *     p_media_library;
173
};
Sam Hocevar's avatar
 
Sam Hocevar committed
174

175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
/* 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 )\
191 192
    DEF( SORT_URI )\
    DEF( SORT_DISC_NUMBER )
193 194

#define DEF( s ) s,
195 196
enum
{
197 198 199
    VLC_DEFINE_SORT_FUNCTIONS
    SORT_RANDOM,
    NUM_SORT_FNS=SORT_RANDOM
200
};
201 202 203 204 205
#undef  DEF
#ifndef VLC_INTERNAL_PLAYLIST_SORT_FUNCTIONS
#undef  VLC_DEFINE_SORT_FUNCTIONS
#endif

206 207 208 209 210
enum
{
    ORDER_NORMAL = 0,
    ORDER_REVERSE = 1,
};
Clément Stenac's avatar
Clément Stenac committed
211

212 213 214 215 216 217 218 219
/* Used by playlist_Import */
#define PLAYLIST_INSERT          0x0001
#define PLAYLIST_APPEND          0x0002
#define PLAYLIST_GO              0x0004
#define PLAYLIST_PREPARSE        0x0008
#define PLAYLIST_SPREPARSE       0x0010
#define PLAYLIST_NO_REBUILD      0x0020

220
#define PLAYLIST_END           -1
221

222 223 224 225 226 227
enum pl_locked_state
{
    pl_Locked = true,
    pl_Unlocked = false
};

Sam Hocevar's avatar
 
Sam Hocevar committed
228 229 230
/*****************************************************************************
 * Prototypes
 *****************************************************************************/
231

232
/* Helpers */
233 234 235
#define PL_LOCK playlist_Lock( p_playlist )
#define PL_UNLOCK playlist_Unlock( p_playlist )
#define PL_ASSERT_LOCKED playlist_AssertLocked( p_playlist )
236

237 238 239 240 241
/** Playlist commands */
enum {
    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
    PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
                        /**  arg2 = playlist_item_t*          , res=can fail */
242
    PLAYLIST_TOGGLE_PAUSE, /**< No arg                          res=can fail */
243 244
    PLAYLIST_STOP,      /**< No arg                             res=can fail*/
    PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
245 246
    PLAYLIST_PAUSE,     /**< No arg */
    PLAYLIST_RESUME,    /**< No arg */
247 248
};

249
#define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
250 251
#define playlist_TogglePause(p) \
        playlist_Control(p, PLAYLIST_TOGGLE_PAUSE, pl_Unlocked)
252 253 254
#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)
255
#define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked,  (i) )
256 257 258 259
#define playlist_Pause(p) \
        playlist_Control(p, PLAYLIST_PAUSE, pl_Unlocked)
#define playlist_Resume(p) \
        playlist_Control(p, PLAYLIST_RESUME, pl_Unlocked)
260

261 262 263
VLC_API void playlist_Lock( playlist_t * );
VLC_API void playlist_Unlock( playlist_t * );
VLC_API void playlist_AssertLocked( playlist_t * );
264
VLC_API void playlist_Deactivate( playlist_t * );
265

266 267 268 269 270 271 272 273 274
/**
 * 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
 */
275
VLC_API void playlist_Control( playlist_t *p_playlist, int i_query, bool b_locked, ...  );
276

277 278
/** Get current playing input. The object is retained.
 */
279
VLC_API input_thread_t * playlist_CurrentInput( playlist_t *p_playlist ) VLC_USED;
280
VLC_API input_thread_t *playlist_CurrentInputLocked( playlist_t *p_playlist ) VLC_USED;
281

282 283 284 285
/** Get the duration of all items in a node.
 */
VLC_API mtime_t playlist_GetNodeDuration( playlist_item_t * );

286 287 288
/** Clear the playlist
 * \param b_locked TRUE if playlist is locked when entering this function
 */
289
VLC_API void playlist_Clear( playlist_t *, bool );
290

291
/* Playlist sorting */
292 293 294
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 );
295

296
VLC_API playlist_item_t * playlist_CurrentPlayingItem( playlist_t * ) VLC_USED;
297
VLC_API int playlist_Status( playlist_t * );
298

299 300
/**
 * Export a node of the playlist to a certain type of playlistfile
301
 * \param b_playlist true for the playlist, false for the media library
302 303 304 305
 * \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
 */
306 307
VLC_API int playlist_Export( playlist_t *p_playlist, const char *psz_name,
                             bool b_playlist, const char *psz_type );
308

309 310 311
/**
 * Open a playlist file, add its content to the current playlist
 */
312
VLC_API int playlist_Import( playlist_t *p_playlist, const char *psz_file );
313

314 315
/********************** Services discovery ***********************/

316
/** Add a service discovery module */
317
VLC_API int playlist_ServicesDiscoveryAdd(playlist_t *, const char *);
318
/** Remove a services discovery module by name */
319
VLC_API int playlist_ServicesDiscoveryRemove(playlist_t *, const char *);
320
/** Check whether a given SD is loaded */
321
VLC_API bool playlist_IsServicesDiscoveryLoaded( playlist_t *,const char *) VLC_DEPRECATED;
322
/** Query a services discovery */
323
VLC_API int playlist_ServicesDiscoveryControl( playlist_t *, const char *, int, ... );
324 325 326



327 328 329 330 331
/********************************************************
 * Item management
 ********************************************************/

/******************** Item addition ********************/
332
VLC_API int playlist_Add( playlist_t *, const char *, const char *, int, int, bool );
333
VLC_API int playlist_AddExt( playlist_t *, const char *, const char *, int, int, mtime_t, int, const char *const *, unsigned, bool );
334
VLC_API int playlist_AddInput( playlist_t *, input_item_t *, int, int, bool );
335
VLC_API playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *, playlist_item_t *, int, int );
336
VLC_API int playlist_NodeAddCopy( playlist_t *, playlist_item_t *, playlist_item_t *, int );
337

338
/********************************** Item search *************************/
339
VLC_API playlist_item_t * playlist_ItemGetById(playlist_t *, int ) VLC_USED;
340 341 342
VLC_API playlist_item_t *playlist_ItemGetByInput(playlist_t *,
                                                 const input_item_t * )
VLC_USED;
343

344
VLC_API int playlist_LiveSearchUpdate(playlist_t *, playlist_item_t *, const char *, bool );
345

346 347 348 349
/********************************************************
 * Tree management
 ********************************************************/
/* Node management */
350
VLC_API playlist_item_t * playlist_NodeCreate( playlist_t *, const char *, playlist_item_t * p_parent, int i_pos, int i_flags );
351
VLC_API playlist_item_t * playlist_ChildSearchName(playlist_item_t*, const char* ) VLC_USED;
352
VLC_API void playlist_NodeDelete( playlist_t *, playlist_item_t *, bool );
353

354 355 356 357
/**************************
 * Audio output management
 **************************/

358 359
VLC_API audio_output_t *playlist_GetAout( playlist_t * );

360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
#define AOUT_VOLUME_DEFAULT             256
#define AOUT_VOLUME_MAX                 512

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 );

380 381 382
/***********************************************************************
 * Inline functions
 ***********************************************************************/
383
/** Tell if the playlist is empty */
384 385 386 387 388
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
389

390
/** Tell the number of items in the current playing context */
391 392 393 394 395
static inline int playlist_CurrentSize( playlist_t *p_playlist )
{
    PL_ASSERT_LOCKED;
    return p_playlist->current.i_size;
}
396

397
/** @} */
Clément Stenac's avatar
Clément Stenac committed
398 399 400
# ifdef __cplusplus
}
# endif
401 402

#endif