vlc_playlist.h 15.6 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.
zorglub's avatar
zorglub 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
dionoea's avatar
dionoea 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_

sigmunau's avatar
sigmunau committed
27 28 29 30 31 32 33 34 35 36 37 38
/**
 *  \file
 *  This file contain structures and function prototypes related
 *  to the playlist in vlc
 */

/**
 * \defgroup vlc_playlist Playlist
 * Brief description. Longer description
 * @{
 */

zorglub's avatar
zorglub committed
39 40 41 42 43 44 45
/**
 * playlist export helper structure
 */
struct playlist_export_t
{
    char *psz_filename;
    FILE *p_file;
46
    playlist_item_t *p_root;
zorglub's avatar
zorglub committed
47 48
};

sigmunau's avatar
sigmunau committed
49
/**
zorglub's avatar
zorglub committed
50
 * playlist item / node
sigmunau's avatar
sigmunau committed
51 52
 * \see playlist_t
 */
53
struct playlist_item_t
Sam Hocevar's avatar
 
Sam Hocevar committed
54
{
55
    input_item_t           *p_input;    /**< input item descriptor */
zorglub's avatar
zorglub committed
56 57 58 59 60

    /* Tree specific fields */
    int                    i_children;  /**< Number of children
                                             -1 if not a node */
    playlist_item_t      **pp_children; /**< Children nodes/items */
61
    playlist_item_t       *p_parent;    /**< Item parent */
zorglub's avatar
zorglub committed
62

63
    int                    i_id;        /**< Playlist item specific id */
zorglub's avatar
zorglub committed
64

65
    uint8_t                i_flags;     /**< Flags */
66
};
Sam Hocevar's avatar
 
Sam Hocevar committed
67

68 69 70 71 72 73 74
#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 */
#define PLAYLIST_PREFCAT_FLAG   0x0040    /**< Prefer category */
zorglub's avatar
zorglub committed
75

sigmunau's avatar
sigmunau committed
76 77 78
/**
 * Playlist status
 */
79 80
typedef enum
{ PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
sigmunau's avatar
sigmunau committed
81

zorglub's avatar
zorglub committed
82 83 84 85

struct services_discovery_t
{
    VLC_COMMON_MEMBERS
86
    char *psz_module;
zorglub's avatar
zorglub committed
87 88 89 90 91 92 93

    module_t *p_module;

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

94 95 96 97 98
struct playlist_preparse_t
{
    VLC_COMMON_MEMBERS
    vlc_mutex_t     lock;
    int             i_waiting;
99
    input_item_t  **pp_waiting;
100 101
};

zorglub's avatar
zorglub committed
102

103
/** Structure containing information about the playlist */
104
struct playlist_t
Sam Hocevar's avatar
 
Sam Hocevar committed
105
{
106
    VLC_COMMON_MEMBERS
sigmunau's avatar
sigmunau committed
107 108 109 110 111
/**
   \name playlist_t
   These members are uniq to playlist_t
*/
/*@{*/
zorglub's avatar
zorglub committed
112
    int                   i_enabled; /**< How many items are enabled ? */
zorglub's avatar
zorglub committed
113

114
    /* Arrays of items */
zorglub's avatar
zorglub committed
115
    int                   i_size;   /**< total size of the list */
sigmunau's avatar
sigmunau committed
116 117
    playlist_item_t **    pp_items; /**< array of pointers to the
                                     * playlist items */
118 119 120
    int                   i_all_size; /**< size of list of items and nodes */
    playlist_item_t **    pp_all_items; /**< array of pointers to the
                                         * playlist items and nodes */
121
    int                   i_input_items;
122
    input_item_t **       pp_input_items;
zorglub's avatar
zorglub committed
123

124 125
    int                   i_last_playlist_id; /**< Last id to an item */
    int                   i_last_input_id ; /**< Last id on an input */
zorglub's avatar
zorglub committed
126

127 128
    services_discovery_t **pp_sds;
    int                   i_sds;
zorglub's avatar
zorglub committed
129

130
    /* Predefined items */
131 132 133 134 135 136
    playlist_item_t *     p_root_category;
    playlist_item_t *     p_root_onelevel;
    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 */
zorglub's avatar
zorglub committed
137

138 139 140 141 142 143 144 145
    /* 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 */
    mtime_t               i_vout_destroyed_date;
    mtime_t               i_sout_destroyed_date;
    playlist_preparse_t  *p_preparse; /**< Preparser object */
zorglub's avatar
zorglub committed
146

147
    vlc_mutex_t gc_lock;         /**< Lock to protect the garbage collection */
148

zorglub's avatar
zorglub committed
149
    struct {
150 151
        /* Current status. These fields are readonly, only the playlist
         * main loop can touch it*/
zorglub's avatar
zorglub committed
152 153
        playlist_status_t   i_status;  /**< Current status of playlist */
        playlist_item_t *   p_item; /**< Currently playing/active item */
154
        playlist_item_t *   p_node; /**< Current node to play from */
zorglub's avatar
zorglub committed
155 156 157
    } status;

    struct {
158 159
        /* Request. Use this to give orders to the playlist main loop  */
        int                 i_status; /**< requested playlist status */
zorglub's avatar
zorglub committed
160 161 162 163 164
        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 */

165 166 167 168
        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 */
zorglub's avatar
zorglub committed
169 170
    } request;

171
    // Playlist-unrelated fields
172 173
    interaction_t       *p_interaction;       /**< Interaction manager */
    global_stats_t      *p_stats;             /**< Global statistics */
sigmunau's avatar
sigmunau committed
174
    /*@}*/
175
};
Sam Hocevar's avatar
 
Sam Hocevar committed
176

zorglub's avatar
zorglub committed
177 178 179
/* Helper to add an item */
struct playlist_add_t
{
zorglub's avatar
zorglub committed
180 181
    int i_node;
    int i_item;
zorglub's avatar
zorglub committed
182 183 184
    int i_position;
};

hartman's avatar
hartman committed
185 186
#define SORT_ID 0
#define SORT_TITLE 1
187 188
#define SORT_TITLE_NODES_FIRST 2
#define SORT_AUTHOR 3
189 190 191 192
#define SORT_GENRE 4
#define SORT_RANDOM 5
#define SORT_DURATION 6
#define SORT_TITLE_NUMERIC 7
193
#define SORT_ALBUM 8
zorglub's avatar
zorglub committed
194

195 196
#define ORDER_NORMAL 0
#define ORDER_REVERSE 1
zorglub's avatar
zorglub committed
197

Sam Hocevar's avatar
 
Sam Hocevar committed
198 199 200
/*****************************************************************************
 * Prototypes
 *****************************************************************************/
zorglub's avatar
zorglub committed
201

202 203 204 205 206 207 208 209 210
/* Global thread */
#define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
playlist_t *__playlist_ThreadCreate   ( vlc_object_t * );
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 );

zorglub's avatar
zorglub committed
211
/* Creation/Deletion */
212 213 214 215 216 217 218 219 220 221 222
playlist_t *playlist_Create   ( vlc_object_t * );
void        playlist_Destroy  ( playlist_t * );

/* Engine */
void playlist_MainLoop( playlist_t * );
void playlist_LastLoop( playlist_t * );
void playlist_PreparseLoop( playlist_preparse_t * );

/* Control */
playlist_item_t * playlist_NextItem  ( playlist_t * );
int playlist_PlayItem  ( playlist_t *, playlist_item_t * );
223

zorglub's avatar
zorglub committed
224
/* Playlist control */
225 226 227 228 229 230
#define playlist_Play(p) playlist_LockControl(p,PLAYLIST_PLAY )
#define playlist_Pause(p) playlist_LockControl(p,PLAYLIST_PAUSE )
#define playlist_Stop(p) playlist_LockControl(p,PLAYLIST_STOP )
#define playlist_Next(p) playlist_LockControl(p,PLAYLIST_SKIP, 1)
#define playlist_Prev(p) playlist_LockControl(p,PLAYLIST_SKIP, -1)
#define playlist_Skip(p,i) playlist_LockControl(p,PLAYLIST_SKIP, i)
231

zorglub's avatar
zorglub committed
232
VLC_EXPORT( int, playlist_Control, ( playlist_t *, int, ...  ) );
233
VLC_EXPORT( int, playlist_LockControl, ( playlist_t *, int, ...  ) );
zorglub's avatar
zorglub committed
234

235 236
VLC_EXPORT( void,  playlist_Clear, ( playlist_t * ) );
VLC_EXPORT( void,  playlist_LockClear, ( playlist_t * ) );
237

238
VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
239
VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) );
240

zorglub's avatar
zorglub committed
241 242 243
/* Services discovery */

VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
zorglub's avatar
zorglub committed
244
VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
zorglub's avatar
zorglub committed
245
VLC_EXPORT( int, playlist_AddSDModules, (playlist_t *, char *));
246 247
VLC_EXPORT( vlc_bool_t, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));

zorglub's avatar
zorglub committed
248

zorglub's avatar
zorglub committed
249
/* Item management functions (act on items) */
250 251
#define playlist_ItemNew( a , b, c ) __playlist_ItemNew(VLC_OBJECT(a) , b , c )
VLC_EXPORT( playlist_item_t* , __playlist_ItemNew, ( vlc_object_t *,const char *,const char * ) );
252 253 254 255 256
VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int , const char **, int, int) );
#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 ) );


zorglub's avatar
zorglub committed
257
VLC_EXPORT( int, playlist_ItemDelete, ( playlist_item_t * ) );
258

zorglub's avatar
zorglub committed
259 260 261 262
/* Item informations accessors */
VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *,  char * ) );
VLC_EXPORT( int, playlist_ItemSetDuration, (playlist_item_t *, mtime_t ) );

263
VLC_EXPORT( void, playlist_ItemAddOption, (playlist_item_t *, const char *) );
264

265 266 267 268
VLC_EXPORT(void, playlist_NodeDump, ( playlist_t *p_playlist, playlist_item_t *p_item, int i_level ) );

/** Counts the items of a view */
VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
zorglub's avatar
zorglub committed
269 270

/* Node management */
271 272 273
VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, char *, playlist_item_t * p_parent ) );
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) );
zorglub's avatar
zorglub committed
274 275
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* ) );
276
VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, vlc_bool_t , vlc_bool_t ) );
zorglub's avatar
zorglub committed
277
VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, vlc_bool_t ) );
278
VLC_EXPORT( void, playlist_NodesCreateForSD, (playlist_t *, char *, playlist_item_t **, playlist_item_t ** ) );
zorglub's avatar
zorglub committed
279

280 281 282 283 284 285 286 287 288 289 290 291
/* Tree walking - These functions are only for playlist, not plugins */
playlist_item_t *playlist_GetNextLeaf( playlist_t *p_playlist,
                                       playlist_item_t *p_root,
                                       playlist_item_t *p_item );
playlist_item_t *playlist_GetNextEnabledLeaf( playlist_t *p_playlist,
                                              playlist_item_t *p_root,
                                              playlist_item_t *p_item );
playlist_item_t *playlist_GetPrevLeaf( playlist_t *p_playlist,
                                       playlist_item_t *p_root,
                                       playlist_item_t *p_item );
playlist_item_t *playlist_GetLastLeaf( playlist_t *p_playlist,
                                       playlist_item_t *p_root );
zorglub's avatar
zorglub committed
292 293 294


/* Simple add/remove functions */
295 296 297 298 299 300 301 302 303
VLC_EXPORT( int,  playlist_PlaylistAdd,    ( playlist_t *, const char *, const char *, int, int ) );
VLC_EXPORT( int,  playlist_PlaylistAddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int ) );
VLC_EXPORT( int, playlist_PlaylistAddInput, ( playlist_t *, input_item_t *,int , int ) );
VLC_EXPORT( playlist_item_t *, playlist_NodeAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int ) );
VLC_EXPORT( void, playlist_NodeAddItem, ( playlist_t *, playlist_item_t *, playlist_item_t *,int , int ) );
VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int ) );
VLC_EXPORT( void, playlist_AddWhereverNeeded, (playlist_t* , input_item_t*, playlist_item_t*,playlist_item_t*,vlc_bool_t, int ) );

void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id, int i_node_id );
304

zorglub's avatar
zorglub committed
305
/* Misc item operations (act on item+playlist) */
306 307 308
VLC_EXPORT( int,  playlist_DeleteAllFromInput, ( playlist_t *, int ) );
VLC_EXPORT( int,  playlist_DeleteFromInput, ( playlist_t *, int, playlist_item_t *, vlc_bool_t ) );
VLC_EXPORT( int,  playlist_DeleteFromItemId, ( playlist_t *, int ) );
309
VLC_EXPORT( int,  playlist_LockDelete, ( playlist_t *, int ) );
310 311 312
VLC_EXPORT( int,  playlist_LockDeleteAllFromInput, ( playlist_t *, int ) );
VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *) );
VLC_EXPORT( playlist_item_t*, playlist_LockItemToNode, (playlist_t *,playlist_item_t *) );
313

314 315
playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
                                   int i_input_id, playlist_item_t *p_root );
316 317

/* Item search functions */
318
VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
zorglub's avatar
zorglub committed
319
VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) );
zorglub's avatar
zorglub committed
320

321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
static inline playlist_item_t *playlist_LockItemGetById( playlist_t *p_playlist,
                                                         int i_id)
{
    playlist_item_t *p_ret;
    vlc_mutex_lock( &p_playlist->object_lock );
    p_ret = playlist_ItemGetById( p_playlist, i_id );
    vlc_mutex_unlock( &p_playlist->object_lock );
    return p_ret;
}

static inline playlist_item_t *playlist_LockItemGetByInput(
                                playlist_t *p_playlist, input_item_t *p_item )
{
    playlist_item_t *p_ret;
    vlc_mutex_lock( &p_playlist->object_lock );
    p_ret = playlist_ItemGetByInput( p_playlist, p_item );
    vlc_mutex_unlock( &p_playlist->object_lock );
    return p_ret;
}

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

/* Playlist sorting */
hartman's avatar
hartman committed
344
#define playlist_SortID(p, i) playlist_Sort( p, SORT_ID, i)
zorglub's avatar
zorglub committed
345 346
#define playlist_SortTitle(p, i) playlist_Sort( p, SORT_TITLE, i)
#define playlist_SortAuthor(p, i) playlist_Sort( p, SORT_AUTHOR, i)
347
#define playlist_SortAlbum(p, i) playlist_Sort( p, SORT_ALBUM, i)
zorglub's avatar
zorglub committed
348
#define playlist_SortGroup(p, i) playlist_Sort( p, SORT_GROUP, i)
349 350
VLC_EXPORT( int,  playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
VLC_EXPORT( int,  playlist_NodeGroup, ( playlist_t *, playlist_item_t *,playlist_item_t **,int, int, int ) );
351
VLC_EXPORT( int,  playlist_NodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
zorglub's avatar
zorglub committed
352
VLC_EXPORT( int,  playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
353 354

/* Load/Save */
zorglub's avatar
zorglub committed
355
VLC_EXPORT( int,  playlist_Import, ( playlist_t *, const char * ) );
356
VLC_EXPORT( int,  playlist_Export, ( playlist_t *, const char *, playlist_item_t *, const char * ) );
357

zorglub's avatar
zorglub committed
358 359 360 361
/***********************************************************************
 * Inline functions
 ***********************************************************************/

362
/** Tell if the playlist is currently running */
363 364 365 366
static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
{
    vlc_bool_t b_playing;
    vlc_mutex_lock( &p_playlist->object_lock );
zorglub's avatar
zorglub committed
367
    b_playing = p_playlist->status.i_status == PLAYLIST_RUNNING;
368 369 370 371
    vlc_mutex_unlock( &p_playlist->object_lock );
    return( b_playing );
}

372
/** Tell if the playlist is empty */
373 374 375 376 377 378 379 380
static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
{
    vlc_bool_t b_empty;
    vlc_mutex_lock( &p_playlist->object_lock );
    b_empty = p_playlist->i_size == 0;
    vlc_mutex_unlock( &p_playlist->object_lock );
    return( b_empty );
}
sigmunau's avatar
sigmunau committed
381 382 383 384

/**
 * @}
 */
385

zorglub's avatar
zorglub committed
386 387 388 389 390 391 392 393
#define PLAYLIST_DEBUG 1

#ifdef PLAYLIST_DEBUG
#define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
#else
#define PL_DEBUG( msg, args ... ) {}
#endif

394
#endif