vlc_playlist.h 17.9 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 28
#include <assert.h>

Clément Stenac's avatar
Clément Stenac committed
29 30
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
31
/**
Clément Stenac's avatar
Clément Stenac committed
32 33 34 35
 * \file
 * This file contain structures and function prototypes related
 * to the playlist in vlc
 *
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
36 37 38 39
 * \defgroup vlc_playlist Playlist
 * @{
 */

40 41 42 43 44 45 46
/**
 * playlist export helper structure
 */
struct playlist_export_t
{
    char *psz_filename;
    FILE *p_file;
47
    playlist_item_t *p_root;
48 49
};

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

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

64
    int                    i_id;        /**< Playlist item specific id */
65

66
    uint8_t                i_flags;     /**< Flags */
67
};
Sam Hocevar's avatar
 
Sam Hocevar committed
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 */
75

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

82 83 84 85

struct services_discovery_t
{
    VLC_COMMON_MEMBERS
86
    char *psz_module;
87 88 89 90 91 92 93

    module_t *p_module;

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

94
/** Structure containing information about the playlist */
95
struct playlist_t
Sam Hocevar's avatar
 
Sam Hocevar committed
96
{
97
    VLC_COMMON_MEMBERS
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
98 99 100 101 102
/**
   \name playlist_t
   These members are uniq to playlist_t
*/
/*@{*/
Clément Stenac's avatar
Clément Stenac committed
103
    int                   i_enabled; /**< How many items are enabled ? */
104

Clément Stenac's avatar
Clément Stenac committed
105 106 107 108 109 110 111 112 113
    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 */
    /** Reset current item ? */
    vlc_bool_t            b_reset_currently_playing;
114
    mtime_t               last_rebuild_date;
Clément Stenac's avatar
Clément Stenac committed
115

116 117
    int                   i_last_playlist_id; /**< Last id to an item */
    int                   i_last_input_id ; /**< Last id on an input */
118

119 120
    services_discovery_t **pp_sds;
    int                   i_sds;
121

122
    /* Predefined items */
123 124 125 126 127 128
    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 */
129

130 131 132
    vlc_bool_t            b_always_tree;/**< Always display as tree */
    vlc_bool_t            b_never_tree;/**< Never display as tree */

133 134 135
    vlc_bool_t            b_doing_ml; /**< Doing media library stuff, */
                                      /*get quicker */

136 137 138 139 140
    /* 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 */
141 142
    mtime_t               gc_date;
    vlc_bool_t            b_cant_sleep;
143
    playlist_preparse_t  *p_preparse; /**< Preparser object */
144
    playlist_secondary_preparse_t *p_secondary_preparse;/**< Preparser object */
145

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

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

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

164 165 166 167
        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 */
168 169
    } request;

170
    // Playlist-unrelated fields
171
    interaction_t       *p_interaction;       /**< Interaction manager */
172 173
    /** The input thread computing stats */
    input_thread_t      *p_stats_computer;
174
    global_stats_t      *p_stats;             /**< Global statistics */
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
175
    /*@}*/
176
};
Sam Hocevar's avatar
 
Sam Hocevar committed
177

Clément Stenac's avatar
Clément Stenac committed
178 179 180
/* Helper to add an item */
struct playlist_add_t
{
Clément Stenac's avatar
Clément Stenac committed
181 182
    int i_node;
    int i_item;
Clément Stenac's avatar
Clément Stenac committed
183 184 185
    int i_position;
};

186 187
#define SORT_ID 0
#define SORT_TITLE 1
188
#define SORT_TITLE_NODES_FIRST 2
Clément Stenac's avatar
Clément Stenac committed
189
#define SORT_ARTIST 3
190 191 192 193
#define SORT_GENRE 4
#define SORT_RANDOM 5
#define SORT_DURATION 6
#define SORT_TITLE_NUMERIC 7
194
#define SORT_ALBUM 8
Clément Stenac's avatar
Clément Stenac committed
195

196 197
#define ORDER_NORMAL 0
#define ORDER_REVERSE 1
Clément Stenac's avatar
Clément Stenac committed
198

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

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

212 213 214 215 216 217 218 219 220 221
#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 );

222
/* Playlist control */
223 224 225 226 227 228
#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)
229

230
VLC_EXPORT( int, playlist_Control, ( playlist_t *, int, ...  ) );
231
VLC_EXPORT( int, playlist_LockControl, ( playlist_t *, int, ...  ) );
232

233 234
VLC_EXPORT( void,  playlist_Clear, ( playlist_t * ) );
VLC_EXPORT( void,  playlist_LockClear, ( playlist_t * ) );
235

236
VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
237
VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) );
238
VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *) );
239

240 241 242
/* Services discovery */

VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
243
VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
244
VLC_EXPORT( int, playlist_AddSDModules, (playlist_t *, char *));
245 246
VLC_EXPORT( vlc_bool_t, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));

247 248 249 250 251 252 253 254 255 256 257 258 259 260
/* 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 ) );

/* Load/Save */
VLC_EXPORT( int,  playlist_Import, ( playlist_t *, const char *, playlist_item_t *, vlc_bool_t ) );
VLC_EXPORT( int,  playlist_Export, ( playlist_t *, const char *, playlist_item_t *, const char * ) );

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

/*************************** Item creation **************************/
261

262
VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int , const char **, int, int) );
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277

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

278 279 280
#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 ) );

281
/*************************** Item deletion **************************/
282
VLC_EXPORT( int, playlist_ItemDelete, ( playlist_item_t * ) );
283 284 285 286 287
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 ) );
VLC_EXPORT( int,  playlist_LockDelete, ( playlist_t *, int ) );
VLC_EXPORT( int,  playlist_LockDeleteAllFromInput, ( playlist_t *, int ) );
288

289
/*************************** Item fields accessors **************************/
290 291
VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *,  char * ) );

292 293 294 295 296 297 298 299
/******************** Item addition ********************/
VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int, vlc_bool_t ) );
VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int, vlc_bool_t ) );
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 ) );
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 ) );
300

301 302 303 304 305 306 307 308 309 310
/** Add a MRL into the playlist.
 * \see playlist_Add
 */
static inline int playlist_PlaylistAdd( playlist_t *p_playlist,
                          const char *psz_uri, const char *psz_name,
                          int i_mode, int i_pos )
{
    return playlist_Add( p_playlist, psz_uri, psz_name, i_mode, i_pos,
                         VLC_TRUE);
}
311

312 313 314 315 316 317 318 319 320
/** Add a MRL to the media library
 * \see playlist_Add
 */
static inline int playlist_MLAdd( playlist_t *p_playlist, const char *psz_uri,
                                  const char *psz_name, int i_mode, int i_pos )
{
    return playlist_Add( p_playlist, psz_uri, psz_name, i_mode, i_pos,
                         VLC_FALSE );
}
321

322 323 324 325 326 327 328 329 330 331
/** Add a MRL to the playlist, with duration and options given
 * \see playlist_AddExt
 */
static inline int playlist_PlaylistAddExt( playlist_t *p_playlist,
            const char * psz_uri, const char *psz_name, int i_mode, int i_pos,
            mtime_t i_duration, const char **ppsz_options, int i_options ) 
{
    return playlist_AddExt( p_playlist, psz_uri, psz_name, i_mode, i_pos,
                            i_duration, ppsz_options, i_options, VLC_TRUE );
}
332

333 334 335 336 337 338 339 340 341 342
/** Add a MRL to the media library, with duration and options given
 * \see playlist_AddExt
 */
static inline int playlist_MLAddExt( playlist_t *p_playlist,
            const char * psz_uri, const char *psz_name, int i_mode, int i_pos,
            mtime_t i_duration, const char **ppsz_options, int i_options ) 
{
    return playlist_AddExt( p_playlist, psz_uri, psz_name, i_mode, i_pos,
                            i_duration, ppsz_options, i_options, VLC_FALSE );
}
343

Clément Stenac's avatar
Clément Stenac committed
344
/** Add an input item to the playlist node
345 346 347 348 349 350 351
 * \see playlist_AddInput
 */
static inline int playlist_PlaylistAddInput( playlist_t* p_playlist,
                                input_item_t *p_input, int i_mode, int i_pos )
{
    return playlist_AddInput( p_playlist, p_input, i_mode, i_pos, VLC_TRUE );
}
352

353
/** Add an input item to the media library
354 355 356 357 358 359 360
 * \see playlist_AddInput
 */
static inline int playlist_MLAddInput( playlist_t* p_playlist,
                                input_item_t *p_input, int i_mode, int i_pos )
{
    return playlist_AddInput( p_playlist, p_input, i_mode, i_pos, VLC_FALSE );
}
361

362
/********************** Misc item operations **********************/
363 364
VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *) );
VLC_EXPORT( playlist_item_t*, playlist_LockItemToNode, (playlist_t *,playlist_item_t *) );
365

366
playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
Clément Stenac's avatar
Clément Stenac committed
367 368
                                   int i_input_id, playlist_item_t *p_root,
                                   vlc_bool_t );
369

370
/********************************** Item search *************************/
371
VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
Clément Stenac's avatar
Clément Stenac committed
372
VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) );
373

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

396 397 398 399 400
/********************************************************
 * 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* ) );
401

402 403 404 405 406 407 408 409
/* Node management */
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) );
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 ) );
410
VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, char *, playlist_item_t **, playlist_item_t **, vlc_bool_t ) );
411
VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) );
412

413 414 415 416
/***********************************************************************
 * Inline functions
 ***********************************************************************/

417
/** Tell if the playlist is currently running */
418 419 420 421
static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
{
    vlc_bool_t b_playing;
    vlc_mutex_lock( &p_playlist->object_lock );
422
    b_playing = p_playlist->status.i_status == PLAYLIST_RUNNING;
423 424 425 426
    vlc_mutex_unlock( &p_playlist->object_lock );
    return( b_playing );
}

427
/** Tell if the playlist is empty */
428 429 430 431
static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
{
    vlc_bool_t b_empty;
    vlc_mutex_lock( &p_playlist->object_lock );
Clément Stenac's avatar
Clément Stenac committed
432
    b_empty = p_playlist->items.i_size == 0;
433 434 435
    vlc_mutex_unlock( &p_playlist->object_lock );
    return( b_empty );
}
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
436

437 438 439 440 441 442
/** Tell the number of items in the current playing context */
static inline int playlist_CurrentSize( vlc_object_t *p_this )
{
    return p_this->p_libvlc->p_playlist->current.i_size;
}

443 444 445 446 447 448 449 450
/** 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;
}

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
451 452 453
/**
 * @}
 */
454 455

#endif