vlc_playlist.h 18 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
 *****************************************************************************
4
 * Copyright (C) 1999-2004 the VideoLAN team
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 9 10 11 12
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (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 16 17 18 19 20
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
22 23
 *****************************************************************************/

24 25 26
#ifndef _VLC_PLAYLIST_H_
#define _VLC_PLAYLIST_H_

27
#include <assert.h>
28 29 30
#include <vlc_input.h>
#include <stdio.h>
#include <stdlib.h>
31

Clément Stenac's avatar
Clément Stenac committed
32 33
TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t);
TYPEDEF_ARRAY(input_item_t*, input_item_array_t);
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
34
/**
Clément Stenac's avatar
Clément Stenac committed
35 36 37 38
 * \file
 * This file contain structures and function prototypes related
 * to the playlist in vlc
 *
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
39
 * \defgroup vlc_playlist Playlist
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
 *
 * 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.
 *
 * In the playlist itself, there are two trees, that should always be kept
 * in sync. The "category" tree contains the whole tree structure with
 * several levels, while the onelevel tree contains only one level :), ie
 * it only contains "real" items, not nodes
 * For example, if you open a directory, you will have
62
 *\verbatim
63 64 65 66 67 68
 * Category tree:               Onevelel tree:
 * Playlist                     Playlist
 *  - Dir                         - item1
 *    - Subdir                    - item2
 *      - item1
 *      - item2
69
 *\endverbatim
70 71 72 73 74 75 76 77 78 79 80 81
 * The top-level items of both tree are the same, and they are reproduced
 * in the left-part of the playlist GUIs, they are the "sources" from the
 * source selectors. Top-level items include: playlist, media library, SAP,
 * Shoutcast, devices, ...
 *
 * 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:
82
 * \verbatim
83 84 85 86 87 88 89 90 91 92
 * Inputs array
 *  - input 1 -> name = foo 1 uri = ...
 *  - input 2 -> name = foo 2 uri = ...
 *
 * Category tree                        Onlevel tree
 * - playlist (id 1)                    - playlist (id 3)
 *    - category 1 (id 2)                - foo 2 (id 8 - input 2)
 *      - foo 2 (id 6 - input 2)       - media library (id 4)
 * - media library (id 2)                - foo 1 (id6 - input 1)
 *    - foo 1 (id 5 - input 1)
93
 * \endverbatim
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
 * Sometimes, an item must be transformed to a node. This happens for the
 * directory access for example. In that case, the item is removed from
 * the onelevel tree, as it is not a real item anymore.
 *
 * 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.
 *
 * If you want more control (like, adding the item as the child of a given
 * node in the category tree, use playlist_BothAddInput. You'll have to provide
 * the node in the category tree. The item will be added as a child of
 * this node in the category tree, and as a child of the matching top-level
 * node in the onelevel tree. (Nodes are created with playlist_NodeCreate)
 *
 * Generally speaking, playlist_NodeAddInput should not be used in newer code, it
 * will maybe become useful again when we merge VLM;
 *
 * To delete an item, use playlist_DeleteFromInput( input_id ) which will
 * remove all occurences of the input in both trees
 *
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
115 116 117
 * @{
 */

118
/** Helper structure to export to file part of the playlist */
119 120 121 122
struct playlist_export_t
{
    char *psz_filename;
    FILE *p_file;
123
    playlist_item_t *p_root;
124 125
};

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

    /* Tree specific fields */
    int                    i_children;  /**< Number of children
                                             -1 if not a node */
    playlist_item_t      **pp_children; /**< Children nodes/items */
135
    playlist_item_t       *p_parent;    /**< Item parent */
136

137
    int                    i_id;        /**< Playlist item specific id */
138

139
    uint8_t                i_flags;     /**< Flags */
140
};
Sam Hocevar's avatar
 
Sam Hocevar committed
141

142 143 144 145 146 147
#define PLAYLIST_SAVE_FLAG      0x0001    /**< Must it be saved */
#define PLAYLIST_SKIP_FLAG      0x0002    /**< Must playlist skip after it ? */
#define PLAYLIST_DBL_FLAG       0x0004    /**< Is it disabled ? */
#define PLAYLIST_RO_FLAG        0x0008    /**< Write-enabled ? */
#define PLAYLIST_REMOVE_FLAG    0x0010    /**< Remove this item at the end */
#define PLAYLIST_EXPANDED_FLAG  0x0020    /**< Expanded node */
148

149
/** Playlist status */
150 151
typedef enum
{ PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
152

153 154 155 156

struct services_discovery_t
{
    VLC_COMMON_MEMBERS
157
    char *psz_module;
158 159 160 161 162 163 164

    module_t *p_module;

    services_discovery_sys_t *p_sys;
    void (*pf_run) ( services_discovery_t *);
};

165
/** Structure containing information about the playlist */
166
struct playlist_t
Sam Hocevar's avatar
 
Sam Hocevar committed
167
{
168
    VLC_COMMON_MEMBERS
Clément Stenac's avatar
Clément Stenac committed
169
    int                   i_enabled; /**< How many items are enabled ? */
170

Clément Stenac's avatar
Clément Stenac committed
171 172 173 174 175 176 177
    playlist_item_array_t items; /**< Arrays of items */
    playlist_item_array_t all_items; /**< Array of items and nodes */

    input_item_array_t    input_items; /**< Array of input items */

    playlist_item_array_t current; /**< Items currently being played */
    int                   i_current_index; /**< Index in current array */
178
    /** Reset current item array */
Clément Stenac's avatar
Clément Stenac committed
179
    vlc_bool_t            b_reset_currently_playing;
180
    mtime_t               last_rebuild_date;
Clément Stenac's avatar
Clément Stenac committed
181

182 183
    int                   i_last_playlist_id; /**< Last id to an item */
    int                   i_last_input_id ; /**< Last id on an input */
184

185 186
    services_discovery_t **pp_sds; /**< Loaded service discovery modules */
    int                   i_sds;   /**< Number of service discovery modules */
187

188
    /* Predefined items */
189 190
    playlist_item_t *     p_root_category; /**< Root of category tree */
    playlist_item_t *     p_root_onelevel; /**< Root of onelevel tree */
191 192 193 194
    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 */
    playlist_item_t *     p_ml_onelevel; /** < "Library" in ONELEVEL iew */
195

196 197 198
    vlc_bool_t            b_always_tree;/**< Always display as tree */
    vlc_bool_t            b_never_tree;/**< Never display as tree */

199 200
    vlc_bool_t            b_doing_ml; /**< Doing media library stuff, */
                                      /*get quicker */
201
    vlc_bool_t            b_auto_preparse;
202

203 204 205 206 207
    /* Runtime */
    input_thread_t *      p_input;  /**< the input thread associated
                                     * with the current item */
    int                   i_sort; /**< Last sorting applied to the playlist */
    int                   i_order; /**< Last ordering applied to the playlist */
208 209
    mtime_t               gc_date;
    vlc_bool_t            b_cant_sleep;
210
    playlist_preparse_t  *p_preparse; /**< Preparser object */
211
    playlist_fetcher_t   *p_fetcher;/**< Meta and art fetcher object */
212

213
    vlc_mutex_t gc_lock;         /**< Lock to protect the garbage collection */
214

215
    struct {
216 217
        /* Current status. These fields are readonly, only the playlist
         * main loop can touch it*/
218 219
        playlist_status_t   i_status;  /**< Current status of playlist */
        playlist_item_t *   p_item; /**< Currently playing/active item */
220
        playlist_item_t *   p_node; /**< Current node to play from */
221 222 223
    } status;

    struct {
224 225
        /* Request. Use this to give orders to the playlist main loop  */
        int                 i_status; /**< requested playlist status */
226 227 228 229 230
        playlist_item_t *   p_node;   /**< requested node to play from */
        playlist_item_t *   p_item;   /**< requested item to play in the node */

        int                 i_skip;   /**< Number of items to skip */

231 232 233 234
        vlc_bool_t          b_request;/**< Set to true by the requester
                                           The playlist sets it back to false
                                           when processing the request */
        vlc_mutex_t         lock;     /**< Lock to protect request */
235 236
    } request;

237
    // Playlist-unrelated fields
238 239 240
    interaction_t       *p_interaction;    /**< Interaction manager */
    input_thread_t      *p_stats_computer; /**< Input thread computing stats */
    global_stats_t      *p_stats;          /**< Global statistics */
241
};
Sam Hocevar's avatar
 
Sam Hocevar committed
242

243
/** Helper to add an item */
Clément Stenac's avatar
Clément Stenac committed
244 245
struct playlist_add_t
{
Clément Stenac's avatar
Clément Stenac committed
246 247
    int i_node;
    int i_item;
Clément Stenac's avatar
Clément Stenac committed
248 249 250
    int i_position;
};

251 252
#define SORT_ID 0
#define SORT_TITLE 1
253
#define SORT_TITLE_NODES_FIRST 2
Clément Stenac's avatar
Clément Stenac committed
254
#define SORT_ARTIST 3
255 256 257 258
#define SORT_GENRE 4
#define SORT_RANDOM 5
#define SORT_DURATION 6
#define SORT_TITLE_NUMERIC 7
259
#define SORT_ALBUM 8
Clément Stenac's avatar
Clément Stenac committed
260

261 262
#define ORDER_NORMAL 0
#define ORDER_REVERSE 1
Clément Stenac's avatar
Clément Stenac committed
263

Sam Hocevar's avatar
 
Sam Hocevar committed
264 265 266
/*****************************************************************************
 * Prototypes
 *****************************************************************************/
267

268 269
/* Global thread */
#define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
270
void        __playlist_ThreadCreate   ( vlc_object_t * );
271 272 273 274 275 276
int           playlist_ThreadDestroy  ( playlist_t * );

/* Helpers */
#define PL_LOCK vlc_mutex_lock( &p_playlist->object_lock );
#define PL_UNLOCK vlc_mutex_unlock( &p_playlist->object_lock );

277 278 279 280 281 282 283 284 285 286
#define pl_Get( a ) a->p_libvlc->p_playlist
#define pl_Yield( a ) __pl_Yield( VLC_OBJECT(a) )
static inline playlist_t *__pl_Yield( vlc_object_t *p_this )
{
    assert( p_this->p_libvlc->p_playlist );
    vlc_object_yield( p_this->p_libvlc->p_playlist );
    return p_this->p_libvlc->p_playlist;
}
#define pl_Release(a) vlc_object_release( a->p_libvlc->p_playlist );

287
/* Playlist control */
288 289 290 291 292 293
#define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, VLC_FALSE )
#define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, VLC_FALSE )
#define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, VLC_FALSE )
#define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, VLC_FALSE, 1)
#define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, VLC_FALSE, -1)
#define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, VLC_FALSE,  i)
294

295
VLC_EXPORT( int, playlist_Control, ( playlist_t *, int, vlc_bool_t, ...  ) );
296

297
VLC_EXPORT( void,  playlist_Clear, ( playlist_t *, vlc_bool_t ) );
298

299
VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
300
VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) );
301
VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *) );
302

303 304 305
/* Services discovery */

VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
306
VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
307
VLC_EXPORT( int, playlist_AddSDModules, (playlist_t *, char *));
308 309
VLC_EXPORT( vlc_bool_t, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));

310 311 312 313 314
/* Playlist sorting */
VLC_EXPORT( int,  playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
VLC_EXPORT( int,  playlist_NodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
VLC_EXPORT( int,  playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );

315
/* Save a playlist file */
316 317 318 319 320 321 322
VLC_EXPORT( int,  playlist_Export, ( playlist_t *, const char *, playlist_item_t *, const char * ) );

/********************************************************
 * Item management
 ********************************************************/

/*************************** Item creation **************************/
323

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
324
VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int , const char *const *, int, int) );
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339

#define playlist_ItemNew( a , b, c ) __playlist_ItemNew(VLC_OBJECT(a) , b , c )
/** Create a new item, without adding it to the playlist
 * \param p_obj a vlc object (anyone will do)
 * \param psz_uri the mrl of the item
 * \param psz_name a text giving a name or description of the item
 * \return the new item or NULL on failure
 */
static inline playlist_item_t * __playlist_ItemNew( vlc_object_t *p_obj,
                                     const char *psz_uri, const char *psz_name )
{
    /* 0 = ITEM_TYPE_UNKNOWN */
    return playlist_ItemNewWithType( p_obj, psz_uri,  psz_name, 0, NULL, -1,0);
}

340 341 342
#define playlist_ItemNewFromInput(a,b) __playlist_ItemNewFromInput(VLC_OBJECT(a),b)
VLC_EXPORT( playlist_item_t *, __playlist_ItemNewFromInput, ( vlc_object_t *p_obj,input_item_t *p_input ) );

343
/*************************** Item deletion **************************/
344
VLC_EXPORT( int, playlist_ItemDelete, ( playlist_item_t * ) );
345
VLC_EXPORT( int,  playlist_DeleteFromInput, ( playlist_t *, int, vlc_bool_t ) );
346

347
/*************************** Item fields accessors **************************/
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
348
VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, const char * ) );
349

350 351
/******************** Item addition ********************/
VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int, vlc_bool_t ) );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
352
VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char *const *,int, vlc_bool_t ) );
353 354
VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *,int , int, vlc_bool_t ) );
VLC_EXPORT( playlist_item_t *, playlist_NodeAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int ) );
355
VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int* ) );
356

357
/********************** Misc item operations **********************/
358
VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *, vlc_bool_t) );
359

360
playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
Clément Stenac's avatar
Clément Stenac committed
361 362
                                   int i_input_id, playlist_item_t *p_root,
                                   vlc_bool_t );
363

364
/********************************** Item search *************************/
365 366
VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int, vlc_bool_t) );
VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t *, vlc_bool_t ) );
367 368

VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) );
369

370 371 372 373 374
/********************************************************
 * Tree management
 ********************************************************/
VLC_EXPORT(void, playlist_NodeDump, ( playlist_t *p_playlist, playlist_item_t *p_item, int i_level ) );
VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
375

376
/* Node management */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
377
VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent ) );
378 379 380 381 382 383
VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) );
VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) );
VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, vlc_bool_t , vlc_bool_t ) );
VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, vlc_bool_t ) );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
384
VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, const char *, playlist_item_t **, playlist_item_t **, vlc_bool_t ) );
385
VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) );
386

387 388 389
/***********************************************************************
 * Inline functions
 ***********************************************************************/
390 391 392 393 394 395 396 397 398 399 400
/** Open a playlist file, add its content to the current playlist */
static inline int playlist_Import( playlist_t *p_playlist, const char *psz_file){
    char psz_uri[256+10];
    input_item_t *p_input;
    snprintf( psz_uri, 256+9, "file/://%s", psz_file );
    p_input = input_ItemNewExt( p_playlist, psz_uri, psz_file, 0, NULL, -1 );
    playlist_AddInput( p_playlist, p_input, PLAYLIST_APPEND, PLAYLIST_END,
                       VLC_TRUE );
    input_Read( p_playlist, p_input, VLC_TRUE );
    return VLC_SUCCESS;
}
401

402
/** Tell if the playlist is currently running */
403
#define playlist_IsPlaying( pl ) ( pl->status.i_status == PLAYLIST_RUNNING )
404

405
/** Tell if the playlist is empty */
406
#define playlist_IsEmpty( pl ) ( pl->items.i_size == 0 )
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
407

408
/** Tell the number of items in the current playing context */
409 410
#define playlist_CurrentSize( obj ) obj->p_libvlc->p_playlist->current.i_size

411 412 413 414 415 416 417 418
/** Ask the playlist to do some work */
static inline void playlist_Signal( playlist_t *p_playlist )
{
    PL_LOCK;
    vlc_cond_signal( &p_playlist->object_wait );
    PL_UNLOCK;
}

419
/** @} */
420 421

#endif