vlc_playlist.h 16 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_input.h>
32
#include <vlc_events.h>
33

34
TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t)
35

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
36
/**
Clément Stenac's avatar
Clément Stenac committed
37 38 39 40
 * \file
 * This file contain structures and function prototypes related
 * to the playlist in vlc
 *
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
41
 * \defgroup vlc_playlist Playlist
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
 *
 * 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
59 60
 * The top-level items are the main media sources and include:
 * playlist, media library, SAP, Shoutcast, devices, ...
61 62 63 64 65 66 67 68
 *
 * 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:
69
 * \verbatim
70 71 72 73
 * Inputs array
 *  - input 1 -> name = foo 1 uri = ...
 *  - input 2 -> name = foo 2 uri = ...
 *
Jakob Leben's avatar
Jakob Leben committed
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
Jakob Leben's avatar
Jakob Leben committed
81 82 83 84 85 86 87
 *
 * 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.
88 89 90 91 92 93
 *
 * 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
94 95
 * You can create nodes with playlist_NodeCreate and can create items from
 * existing input items to be placed under any node with playlist_NodeAddInput.
96
 *
97
 * To delete an item, use playlist_DeleteFromInput( p_item ) which will
Jakob Leben's avatar
Jakob Leben committed
98
 * remove all occurrences of the input.
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.
 *
Jakob Leben's avatar
Jakob Leben committed
107 108 109 110
 * - "playlist-item-append": It will contain a pointer to a playlist_add_t.
 * - "playlist-item-deleted": It will contain the playlist_item_t->i_id of a
 * deleted playlist_item_t.
 *
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
 *
 * XXX Be really carefull, playlist_item_t->i_id and input_item_t->i_id are not
118
 * the same. Yes, the situation is pretty bad.
119
 *
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
120 121 122
 * @{
 */

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

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

137
    playlist_item_t      **pp_children; /**< Children nodes/items */
138
    playlist_item_t       *p_parent;    /**< Item parent */
139
    int                    i_children;  /**< Number of children, -1 if not a node */
140

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

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

147 148 149 150 151 152 153 154 155
typedef enum {
    PLAYLIST_SAVE_FLAG         = 0x0001,  /**< Must it be saved */
    PLAYLIST_SKIP_FLAG         = 0x0002,  /**< Must playlist skip after it ? */
    PLAYLIST_DBL_FLAG          = 0x0004,  /**< Is it disabled ? */
    PLAYLIST_RO_FLAG           = 0x0008,  /**< Write-enabled ? */
    PLAYLIST_REMOVE_FLAG       = 0x0010,  /**< Remove this item at the end */
    PLAYLIST_EXPANDED_FLAG     = 0x0020,  /**< Expanded node */
    PLAYLIST_SUBITEM_STOP_FLAG = 0x0040,  /**< Must playlist stop if the item gets subitems ?*/
} playlist_item_flags_e;
156

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

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

Clément Stenac's avatar
Clément Stenac committed
166 167 168 169 170
    playlist_item_array_t items; /**< Arrays of items */
    playlist_item_array_t all_items; /**< Array of items and nodes */

    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
171

172
    /* Predefined items */
173 174 175 176 177
    playlist_item_t *     p_root;
    playlist_item_t *     p_playing;
    playlist_item_t *     p_media_library;

    //Phony ones, point to those above;
178 179
    playlist_item_t *     p_root_category; /**< Root of category tree */
    playlist_item_t *     p_root_onelevel; /**< Root of onelevel tree */
180 181 182
    playlist_item_t *     p_local_category; /** < "Playlist" in CATEGORY view */
    playlist_item_t *     p_ml_category; /** < "Library" in CATEGORY view */
    playlist_item_t *     p_local_onelevel; /** < "Playlist" in ONELEVEL view */
183
    playlist_item_t *     p_ml_onelevel; /** < "Library" in ONELEVEL view */
184
};
Sam Hocevar's avatar
 
Sam Hocevar committed
185

186
/** Helper to add an item */
Clément Stenac's avatar
Clément Stenac committed
187 188
struct playlist_add_t
{
189 190
    int i_node; /**< Playist id of the parent node */
    int i_item; /**< Playist id of the playlist_item_t */
Clément Stenac's avatar
Clément Stenac committed
191 192
};

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
/* 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 )\
    DEF( SORT_URI )

#define DEF( s ) s,
212 213
enum
{
214 215 216
    VLC_DEFINE_SORT_FUNCTIONS
    SORT_RANDOM,
    NUM_SORT_FNS=SORT_RANDOM
217
};
218 219 220 221 222
#undef  DEF
#ifndef VLC_INTERNAL_PLAYLIST_SORT_FUNCTIONS
#undef  VLC_DEFINE_SORT_FUNCTIONS
#endif

223 224 225 226 227
enum
{
    ORDER_NORMAL = 0,
    ORDER_REVERSE = 1,
};
Clément Stenac's avatar
Clément Stenac committed
228

229 230 231 232 233 234 235 236 237 238
/* 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

#define PLAYLIST_END           -666

239 240 241 242 243 244
enum pl_locked_state
{
    pl_Locked = true,
    pl_Unlocked = false
};

Sam Hocevar's avatar
 
Sam Hocevar committed
245 246 247
/*****************************************************************************
 * Prototypes
 *****************************************************************************/
248

249
/* Helpers */
250 251 252
#define PL_LOCK playlist_Lock( p_playlist )
#define PL_UNLOCK playlist_Unlock( p_playlist )
#define PL_ASSERT_LOCKED playlist_AssertLocked( p_playlist )
253

254
VLC_API playlist_t * pl_Get( vlc_object_t * );
255
#define pl_Get( a ) pl_Get( VLC_OBJECT(a) )
256

257
/* Playlist control */
258 259 260 261 262
#define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
#define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
#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)
263
#define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked,  (i) )
264

265 266 267
VLC_API void playlist_Lock( playlist_t * );
VLC_API void playlist_Unlock( playlist_t * );
VLC_API void playlist_AssertLocked( playlist_t * );
268
VLC_API void playlist_Deactivate( playlist_t * );
269

270 271 272 273 274 275 276 277 278 279
/**
 * 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
 * \return VLC_SUCCESS or an error
 */
280
VLC_API int playlist_Control( playlist_t *p_playlist, int i_query, bool b_locked, ...  );
281

282 283
/** Get current playing input. The object is retained.
 */
284
VLC_API input_thread_t * playlist_CurrentInput( playlist_t *p_playlist ) VLC_USED;
285

286 287 288 289
/** Get the duration of all items in a node.
 */
VLC_API mtime_t playlist_GetNodeDuration( playlist_item_t * );

290 291 292
/** Clear the playlist
 * \param b_locked TRUE if playlist is locked when entering this function
 */
293
VLC_API void playlist_Clear( playlist_t *, bool );
294

295
/** Enqueue an input item for preparsing */
296
VLC_API int playlist_PreparseEnqueue(playlist_t *, input_item_t * );
297 298

/** Request the art for an input item to be fetched */
299
VLC_API int playlist_AskForArtEnqueue(playlist_t *, input_item_t * );
300

301
/* Playlist sorting */
302 303 304
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 );
305

306
VLC_API playlist_item_t * playlist_CurrentPlayingItem( playlist_t * ) VLC_USED;
307
VLC_API int playlist_Status( playlist_t * );
308

309 310 311 312 313 314 315 316
/**
 * Export a node of the playlist to a certain type of playlistfile
 * \param p_playlist the playlist to export
 * \param psz_filename the location where the exported file will be saved
 * \param p_export_root the root node to export
 * \param psz_type the type of playlist file to create (m3u, pls, ..)
 * \return VLC_SUCCESS on success
 */
317
VLC_API int playlist_Export( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type );
318

319 320 321
/**
 * Open a playlist file, add its content to the current playlist
 */
322
VLC_API int playlist_Import( playlist_t *p_playlist, const char *psz_file );
323

324 325 326
/********************** Services discovery ***********************/

/** Add a list of comma-separated service discovery modules */
327
VLC_API int playlist_ServicesDiscoveryAdd(playlist_t *, const char *);
328
/** Remove a services discovery module by name */
329
VLC_API int playlist_ServicesDiscoveryRemove(playlist_t *, const char *);
330
/** Check whether a given SD is loaded */
331
VLC_API bool playlist_IsServicesDiscoveryLoaded( playlist_t *,const char *) VLC_DEPRECATED;
332
/** Query a services discovery */
333
VLC_API int playlist_ServicesDiscoveryControl( playlist_t *, const char *, int, ... );
334 335 336



337 338 339 340 341
/********************************************************
 * Item management
 ********************************************************/

/*************************** Item deletion **************************/
342
VLC_API int playlist_DeleteFromInput( playlist_t *, input_item_t *, bool );
343

344
/******************** Item addition ********************/
345 346 347 348 349
VLC_API int playlist_Add( playlist_t *, const char *, const char *, int, int, bool, bool );
VLC_API int playlist_AddExt( playlist_t *, const char *, const char *, int, int, mtime_t, int, const char *const *, unsigned, bool, bool );
VLC_API int playlist_AddInput( playlist_t *, input_item_t *, int, int, bool, bool );
VLC_API playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *, playlist_item_t *, int, int, bool );
VLC_API int playlist_NodeAddCopy( playlist_t *, playlist_item_t *, playlist_item_t *, int );
350

351
/********************************** Item search *************************/
352 353
VLC_API playlist_item_t * playlist_ItemGetById(playlist_t *, int ) VLC_USED;
VLC_API playlist_item_t * playlist_ItemGetByInput(playlist_t *,input_item_t * ) VLC_USED;
354

355
VLC_API int playlist_LiveSearchUpdate(playlist_t *, playlist_item_t *, const char *, bool );
356

357 358 359 360
/********************************************************
 * Tree management
 ********************************************************/
/* Node management */
361 362 363 364
VLC_API playlist_item_t * playlist_NodeCreate( playlist_t *, const char *, playlist_item_t * p_parent, int i_pos, int i_flags, input_item_t * );
VLC_API int playlist_NodeAppend(playlist_t *,playlist_item_t*,playlist_item_t *);
VLC_API int playlist_NodeInsert(playlist_t *,playlist_item_t*,playlist_item_t *, int);
VLC_API int playlist_NodeRemoveItem(playlist_t *,playlist_item_t*,playlist_item_t *);
365
VLC_API playlist_item_t * playlist_ChildSearchName(playlist_item_t*, const char* ) VLC_USED;
366 367
VLC_API int playlist_NodeDelete( playlist_t *, playlist_item_t *, bool , bool );

368 369
VLC_API 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 ) VLC_USED;
VLC_API 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 ) VLC_USED;
370

371 372 373 374
/**************************
 * Audio output management
 **************************/

375 376
VLC_API audio_output_t *playlist_GetAout( playlist_t * );

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
#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 );

397 398 399
/***********************************************************************
 * Inline functions
 ***********************************************************************/
400 401 402 403
/** Small helper tp get current playing input or NULL. Release the input after use. */
#define pl_CurrentInput(a) __pl_CurrentInput( VLC_OBJECT(a) )
static  inline input_thread_t * __pl_CurrentInput( vlc_object_t * p_this )
{
404
    return playlist_CurrentInput( pl_Get( p_this ) );
405
}
406

407
/** Tell if the playlist is empty */
408 409 410 411 412
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
413

414
/** Tell the number of items in the current playing context */
415 416 417 418 419
static inline int playlist_CurrentSize( playlist_t *p_playlist )
{
    PL_ASSERT_LOCKED;
    return p_playlist->current.i_size;
}
420

421
/** @} */
Clément Stenac's avatar
Clément Stenac committed
422 423 424
# ifdef __cplusplus
}
# endif
425 426

#endif