vlc_playlist.h 13.8 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 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
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
21
22
23
 * 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
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

sigmunau's avatar
sigmunau committed
24
25
26
27
28
29
30
31
32
33
34
35
/**
 *  \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
36
37
38
39
40
41
42
43
44
/**
 * playlist export helper structure
 */
struct playlist_export_t
{
    char *psz_filename;
    FILE *p_file;
};

zorglub's avatar
zorglub committed
45
46
47
48
49
50
struct item_parent_t
{
    int i_view;
    playlist_item_t *p_parent;
};

sigmunau's avatar
sigmunau committed
51
/**
zorglub's avatar
zorglub committed
52
 * playlist item / node
sigmunau's avatar
sigmunau committed
53
54
 * \see playlist_t
 */
55
struct playlist_item_t
Sam Hocevar's avatar
 
Sam Hocevar committed
56
{
zorglub's avatar
zorglub committed
57
58
59
60
61
62
63
64
65
66
67
68
69
70
    input_item_t           input;       /**< input item descriptor */

    /* Tree specific fields */
    int                    i_children;  /**< Number of children
                                             -1 if not a node */
    playlist_item_t      **pp_children; /**< Children nodes/items */
    int                    i_parents;   /**< Number of parents */
    struct item_parent_t **pp_parents;  /**< Parents */
    int                    i_serial;    /**< Has this node been updated ? */

    uint8_t                i_flags;     /**< Flags */


    int        i_nb_played;       /**< How many times was this item played ? */
zorglub's avatar
zorglub committed
71
72

    /* LEGACY FIELDS */
zorglub's avatar
zorglub committed
73
74
75
76
77
78
    vlc_bool_t b_autodeletion;    /**< Indicates whther this item is to
                                   * be deleted after playback. True mean
                                   * that this item is to be deleted
                                   * after playback, false otherwise */
    vlc_bool_t b_enabled;         /**< Indicates whether this item is to be
                                   * played or skipped */
zorglub's avatar
zorglub committed
79
    /* END LEGACY FIELDS */
80
};
Sam Hocevar's avatar
 
Sam Hocevar committed
81

zorglub's avatar
zorglub committed
82
83
84
85
86
#define PLAYLIST_SAVE_FLAG      0x1     /**< Must it be saved */
#define PLAYLIST_SKIP_FLAG      0x2     /**< Must playlist skip after it ? */
#define PLAYLIST_ENA_FLAG       0x4     /**< Is it enabled ? */
#define PLAYLIST_DEL_FLAG       0x8     /**< Autodelete ? */

87
/**
zorglub's avatar
zorglub committed
88
 * playlist view
89
 * \see playlist_t
zorglub's avatar
zorglub committed
90
91
*/
struct playlist_view_t
zorglub's avatar
zorglub committed
92
{
zorglub's avatar
zorglub committed
93
94
95
    char            *   psz_name;        /**< View name */
    int                 i_id;            /**< Identifier for the view */
    playlist_item_t *   p_root;          /**< Root node */
zorglub's avatar
zorglub committed
96
97
};

zorglub's avatar
zorglub committed
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

/**
 * predefined views
 *
 */
#define VIEW_CATEGORY 1
#define VIEW_SIMPLE   2
#define VIEW_ALL      3
#define VIEW_FIRST_SORTED  4
#define VIEW_S_AUTHOR 4

#define VIEW_LAST_SORTED  4

#define VIEW_FIRST_CUSTOM 100

sigmunau's avatar
sigmunau committed
113
114
115
116
117
/**
 * Playlist status
 */
typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;

zorglub's avatar
zorglub committed
118
119
120
121
122
123
124
125
126
127
128
129
130

struct services_discovery_t
{
    VLC_COMMON_MEMBERS
    const char *psz_module;

    module_t *p_module;

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


sigmunau's avatar
sigmunau committed
131
132
133
/**
 * Structure containing information about the playlist
 */
134
struct playlist_t
Sam Hocevar's avatar
 
Sam Hocevar committed
135
{
136
    VLC_COMMON_MEMBERS
sigmunau's avatar
sigmunau committed
137
138
139
140
141
142
/**
   \name playlist_t
   These members are uniq to playlist_t
*/
/*@{*/
    int                   i_index;  /**< current index into the playlist */
zorglub's avatar
zorglub committed
143
    int                   i_enabled; /**< How many items are enabled ? */
zorglub's avatar
zorglub committed
144
145

    int                   i_size;   /**< total size of the list */
sigmunau's avatar
sigmunau committed
146
147
    playlist_item_t **    pp_items; /**< array of pointers to the
                                     * playlist items */
zorglub's avatar
zorglub committed
148
149
150
151
152

    int                   i_views; /**< Number of views */
    playlist_view_t **    pp_views; /**< array of pointers to the
                                     * playlist views */

sigmunau's avatar
sigmunau committed
153
154
    input_thread_t *      p_input;  /**< the input thread ascosiated
                                     * with the current item */
zorglub's avatar
zorglub committed
155
156
157

    mtime_t               request_date; /**< Used for profiling */

158
    int                   i_last_id; /**< Last id to an item */
hartman's avatar
hartman committed
159
160
    int                   i_sort; /**< Last sorting applied to the playlist */
    int                   i_order; /**< Last ordering applied to the playlist */
zorglub's avatar
zorglub committed
161
162
163
164

    playlist_item_t *    p_general; /**< Keep a pointer on the "general"
                                        category */

zorglub's avatar
zorglub committed
165
166
167
    services_discovery_t **pp_sds;
    int                   i_sds;

zorglub's avatar
zorglub committed
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
    vlc_bool_t          b_go_next; /*< Go further than the parent node ? */

    struct {
        /* Current status */
        playlist_status_t   i_status;  /**< Current status of playlist */

        /* R/O fields, don't touch if you aren't the playlist thread */
        /* Use a request */
        playlist_item_t *   p_item; /**< Currently playing/active item */
        playlist_item_t *   p_node;   /**< Current node to play from */
        int                 i_view;    /**< Current view */
    } status;

    struct {
        /* Request */
        /* Playlist thread uses this info to calculate the next position */
        int                 i_view;   /**< requested view id */
        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 */
        int                 i_goto;   /**< Direct index to go to (non-view)*/

        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 */
    } request;

sigmunau's avatar
sigmunau committed
197
    /*@}*/
198
};
Sam Hocevar's avatar
 
Sam Hocevar committed
199

zorglub's avatar
zorglub committed
200
201
202
203
204
205
206
207
208
/* Helper to add an item */
struct playlist_add_t
{
    playlist_item_t *p_parent;
    playlist_item_t *p_item;
    int i_view;
    int i_position;
};

hartman's avatar
hartman committed
209
210
211
212
#define SORT_ID 0
#define SORT_TITLE 1
#define SORT_AUTHOR 2
#define SORT_RANDOM 4
zorglub's avatar
zorglub committed
213
#define SORT_DURATION 5
zorglub's avatar
zorglub committed
214

215
216
#define ORDER_NORMAL 0
#define ORDER_REVERSE 1
zorglub's avatar
zorglub committed
217

Sam Hocevar's avatar
   
Sam Hocevar committed
218
219
220
/*****************************************************************************
 * Prototypes
 *****************************************************************************/
zorglub's avatar
zorglub committed
221
222

/* Creation/Deletion */
223
#define playlist_Create(a) __playlist_Create(VLC_OBJECT(a))
224
playlist_t * __playlist_Create   ( vlc_object_t * );
zorglub's avatar
zorglub committed
225
int            playlist_Destroy  ( playlist_t * );
226

zorglub's avatar
zorglub committed
227
228
229
230
231
232
233
234
/* Playlist control */
#define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY )
#define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE )
#define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP )
#define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP , 1)
#define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP , -1)
#define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP,i)
#define playlist_Goto(p,i) playlist_Control(p,PLAYLIST_GOTO,i)
235

zorglub's avatar
zorglub committed
236
237
238
VLC_EXPORT( int, playlist_Control, ( playlist_t *, int, ...  ) );

VLC_EXPORT( int,  playlist_Clear, ( playlist_t * ) );
239

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
252
#define playlist_AddItem(p,pi,i1,i2) playlist_ItemAdd(p,pi,i1,i2)
#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 * ) );
zorglub's avatar
zorglub committed
253
254
255
VLC_EXPORT( int, playlist_ItemDelete, ( playlist_item_t * ) );
VLC_EXPORT( int, playlist_ItemAddParent, ( playlist_item_t *, int,playlist_item_t *) );
VLC_EXPORT( int, playlist_CopyParents, ( playlist_item_t *,playlist_item_t *) );
zorglub's avatar
zorglub committed
256
257
258
259
/* Item informations accessors */
VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *,  char * ) );
VLC_EXPORT( int, playlist_ItemSetDuration, (playlist_item_t *, mtime_t ) );

260

zorglub's avatar
zorglub committed
261
262
/* View management functions */
VLC_EXPORT( int, playlist_ViewInsert, (playlist_t *, int, char * ) );
zorglub's avatar
zorglub committed
263
VLC_EXPORT( int, playlist_ViewDelete, (playlist_t *,playlist_view_t* ) );
zorglub's avatar
zorglub committed
264
265
VLC_EXPORT( playlist_view_t *, playlist_ViewFind, (playlist_t *, int ) );
VLC_EXPORT( int, playlist_ViewUpdate, (playlist_t *, int ) );
zorglub's avatar
zorglub committed
266
VLC_EXPORT( int, playlist_ViewDump, (playlist_t *, playlist_view_t * ) );
zorglub's avatar
zorglub committed
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
VLC_EXPORT( int, playlist_ViewEmpty, (playlist_t *, int, vlc_bool_t ) );

/* Node management */
VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *,int,char *, playlist_item_t * p_parent ) );
VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,int,playlist_item_t*,playlist_item_t *) );
VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,int,playlist_item_t*,playlist_item_t *, int) );
VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_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_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, vlc_bool_t ) );


/* Tree walking */
playlist_item_t *playlist_FindNextFromParent( playlist_t *p_playlist,
                int i_view,
                playlist_item_t *p_root,
                playlist_item_t *p_node,
                playlist_item_t *p_item );
playlist_item_t *playlist_FindPrevFromParent( playlist_t *p_playlist,
                int i_view,
                playlist_item_t *p_root,
                playlist_item_t *p_node,
                playlist_item_t *p_item );


/* Simple add/remove functions */
/* These functions add the item to the "simple" view (+all & category )*/
295
VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int ) );
296
VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int ) );
zorglub's avatar
zorglub committed
297
298
VLC_EXPORT( int,  playlist_ItemAdd, ( playlist_t *, playlist_item_t *, int, int ) );
VLC_EXPORT(int, playlist_NodeAddItem, ( playlist_t *, playlist_item_t *,int,playlist_item_t *,int , int ) );
299

zorglub's avatar
zorglub committed
300
/* Misc item operations (act on item+playlist) */
Sam Hocevar's avatar
Sam Hocevar committed
301
VLC_EXPORT( int,  playlist_Delete, ( playlist_t *, int ) );
zorglub's avatar
zorglub committed
302
303
VLC_EXPORT( int,  playlist_Disable, ( playlist_t *, playlist_item_t * ) );
VLC_EXPORT( int,  playlist_Enable, ( playlist_t *, playlist_item_t * ) );
zorglub's avatar
zorglub committed
304
305
VLC_EXPORT( int, playlist_ItemToNode, (playlist_t *,playlist_item_t *) );
VLC_EXPORT( int, playlist_Replace, (playlist_t *,playlist_item_t *, input_item_t*) );
306

307
308

/* Item search functions */
309
310
VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
VLC_EXPORT( playlist_item_t *, playlist_ItemGetByPos, (playlist_t *, int) );
zorglub's avatar
zorglub committed
311
VLC_EXPORT( int, playlist_GetPositionById, (playlist_t *,int ) );
zorglub's avatar
zorglub committed
312
VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) );
zorglub's avatar
zorglub committed
313

314
315
/* Info functions */
VLC_EXPORT( char * , playlist_GetInfo, ( playlist_t * , int, const char *, const char *) );
316
VLC_EXPORT( char * , playlist_ItemGetInfo, ( playlist_item_t * , const char *, const char *) );
317

318
VLC_EXPORT( info_category_t*, playlist_ItemGetCategory, ( playlist_item_t *, const char *) );
319

320
VLC_EXPORT( info_category_t*, playlist_ItemCreateCategory, ( playlist_item_t *, const char *) );
321
322

VLC_EXPORT( int, playlist_AddInfo, (playlist_t *, int, const char * , const char *, const char *, ...) );
323
324
VLC_EXPORT( int, playlist_ItemAddInfo, (playlist_item_t *, const char * , const char *, const char *, ...) );
VLC_EXPORT( int, playlist_ItemAddOption, (playlist_item_t *, const char *) );
325
326

/* Playlist sorting */
hartman's avatar
hartman committed
327
#define playlist_SortID(p, i) playlist_Sort( p, SORT_ID, i)
zorglub's avatar
zorglub committed
328
329
330
331
#define playlist_SortTitle(p, i) playlist_Sort( p, SORT_TITLE, i)
#define playlist_SortAuthor(p, i) playlist_Sort( p, SORT_AUTHOR, i)
#define playlist_SortGroup(p, i) playlist_Sort( p, SORT_GROUP, i)
VLC_EXPORT( int,  playlist_Sort, ( playlist_t *, int, int) );
hartman's avatar
hartman committed
332
VLC_EXPORT( int,  playlist_Move, ( playlist_t *, int, int ) );
zorglub's avatar
zorglub committed
333
VLC_EXPORT( int,  playlist_NodeGroup, ( playlist_t *, int,playlist_item_t *,playlist_item_t **,int, int, int ) );
334
335

/* Load/Save */
zorglub's avatar
zorglub committed
336
337
VLC_EXPORT( int,  playlist_Import, ( playlist_t *, const char * ) );
VLC_EXPORT( int,  playlist_Export, ( playlist_t *, const char *, const char * ) );
338

zorglub's avatar
zorglub committed
339
340
341
342
343
/***********************************************************************
 * Inline functions
 ***********************************************************************/


sigmunau's avatar
sigmunau committed
344
345
346
347
348
/**
 *  tell if a playlist is currently playing.
 *  \param p_playlist the playlist to check
 *  \return true if playlist is playing, false otherwise
 */
349
350
351
352
353
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
354
    b_playing = p_playlist->status.i_status == PLAYLIST_RUNNING;
355
356
357
358
359
    vlc_mutex_unlock( &p_playlist->object_lock );

    return( b_playing );
}

sigmunau's avatar
sigmunau committed
360
361
362
363
364
/**
 *  tell if a playlist is currently empty
 *  \param p_playlist the playlist to check
 *  \return true if the playlist is empty, false otherwise
 */
365
366
367
368
369
370
371
372
373
374
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
375
376
377
378

/**
 * @}
 */