vlc_playlist.h 15.5 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 40 41 42
 * \defgroup vlc_playlist Playlist
 * @{
 */

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

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

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

67
    int                    i_id;        /**< Playlist item specific id */
68

69
    uint8_t                i_flags;     /**< Flags */
70
};
Sam Hocevar's avatar
 
Sam Hocevar committed
71

72 73 74 75 76 77
#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 */
78

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

83 84 85 86

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

    module_t *p_module;

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

95
/** Structure containing information about the playlist */
96
struct playlist_t
Sam Hocevar's avatar
 
Sam Hocevar committed
97
{
98
    VLC_COMMON_MEMBERS
Clément Stenac's avatar
Clément Stenac committed
99
    int                   i_enabled; /**< How many items are enabled ? */
100

Clément Stenac's avatar
Clément Stenac committed
101 102 103 104 105 106 107 108 109
    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;
110
    mtime_t               last_rebuild_date;
Clément Stenac's avatar
Clément Stenac committed
111

112 113
    int                   i_last_playlist_id; /**< Last id to an item */
    int                   i_last_input_id ; /**< Last id on an input */
114

115 116
    services_discovery_t **pp_sds;
    int                   i_sds;
117

118
    /* Predefined items */
119 120 121 122 123 124
    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 */
125

126 127 128
    vlc_bool_t            b_always_tree;/**< Always display as tree */
    vlc_bool_t            b_never_tree;/**< Never display as tree */

129 130 131
    vlc_bool_t            b_doing_ml; /**< Doing media library stuff, */
                                      /*get quicker */

132 133 134 135 136
    /* 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 */
137 138
    mtime_t               gc_date;
    vlc_bool_t            b_cant_sleep;
139
    playlist_preparse_t  *p_preparse; /**< Preparser object */
140
    playlist_fetcher_t   *p_fetcher;/**< Meta and art fetcher object */
141

142
    vlc_mutex_t gc_lock;         /**< Lock to protect the garbage collection */
143

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

    struct {
153 154
        /* Request. Use this to give orders to the playlist main loop  */
        int                 i_status; /**< requested playlist status */
155 156 157 158 159
        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 */

160 161 162 163
        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 */
164 165
    } request;

166
    // Playlist-unrelated fields
167
    interaction_t       *p_interaction;       /**< Interaction manager */
168 169
    /** The input thread computing stats */
    input_thread_t      *p_stats_computer;
170
    global_stats_t      *p_stats;             /**< Global statistics */
171
};
Sam Hocevar's avatar
 
Sam Hocevar committed
172

173
/** Helper to add an item */
Clément Stenac's avatar
Clément Stenac committed
174 175
struct playlist_add_t
{
Clément Stenac's avatar
Clément Stenac committed
176 177
    int i_node;
    int i_item;
Clément Stenac's avatar
Clément Stenac committed
178 179 180
    int i_position;
};

181 182
#define SORT_ID 0
#define SORT_TITLE 1
183
#define SORT_TITLE_NODES_FIRST 2
Clément Stenac's avatar
Clément Stenac committed
184
#define SORT_ARTIST 3
185 186 187 188
#define SORT_GENRE 4
#define SORT_RANDOM 5
#define SORT_DURATION 6
#define SORT_TITLE_NUMERIC 7
189
#define SORT_ALBUM 8
Clément Stenac's avatar
Clément Stenac committed
190

191 192
#define ORDER_NORMAL 0
#define ORDER_REVERSE 1
Clément Stenac's avatar
Clément Stenac committed
193

Sam Hocevar's avatar
 
Sam Hocevar committed
194 195 196
/*****************************************************************************
 * Prototypes
 *****************************************************************************/
197

198 199
/* Global thread */
#define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
200
void        __playlist_ThreadCreate   ( vlc_object_t * );
201 202 203 204 205 206
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 );

207 208 209 210 211 212 213 214 215 216
#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 );

217
/* Playlist control */
218 219 220 221 222 223
#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)
224

225
VLC_EXPORT( int, playlist_Control, ( playlist_t *, int, ...  ) );
226
VLC_EXPORT( int, playlist_LockControl, ( playlist_t *, int, ...  ) );
227

228 229
VLC_EXPORT( void,  playlist_Clear, ( playlist_t * ) );
VLC_EXPORT( void,  playlist_LockClear, ( playlist_t * ) );
230

231
VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
232
VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) );
233
VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *) );
234

235 236 237
/* Services discovery */

VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
238
VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
239
VLC_EXPORT( int, playlist_AddSDModules, (playlist_t *, char *));
240 241
VLC_EXPORT( vlc_bool_t, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));

242 243 244 245 246 247 248 249 250 251 252 253 254
/* 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_Export, ( playlist_t *, const char *, playlist_item_t *, const char * ) );

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

/*************************** Item creation **************************/
255

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
256
VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int , const char *const *, int, int) );
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271

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

272 273 274
#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 ) );

275
/*************************** Item deletion **************************/
276
VLC_EXPORT( int, playlist_ItemDelete, ( playlist_item_t * ) );
277 278 279 280 281
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 ) );
282

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

286 287
/******************** 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
288
VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char *const *,int, vlc_bool_t ) );
289 290 291 292
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 ) );
293

294
/********************** Misc item operations **********************/
295 296
VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *) );
VLC_EXPORT( playlist_item_t*, playlist_LockItemToNode, (playlist_t *,playlist_item_t *) );
297

298
playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
Clément Stenac's avatar
Clément Stenac committed
299 300
                                   int i_input_id, playlist_item_t *p_root,
                                   vlc_bool_t );
301

302
/********************************** Item search *************************/
303
VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
Clément Stenac's avatar
Clément Stenac committed
304
VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) );
305

306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
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 *) );
327

328 329 330 331 332
/********************************************************
 * 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* ) );
333

334
/* Node management */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
335
VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent ) );
336 337 338 339 340 341
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
342
VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, const char *, playlist_item_t **, playlist_item_t **, vlc_bool_t ) );
343
VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) );
344

345 346 347
/***********************************************************************
 * Inline functions
 ***********************************************************************/
348 349 350 351 352 353 354 355 356 357 358
/** 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;
}
359

360
/** Tell if the playlist is currently running */
361
#define playlist_IsPlaying( pl ) ( pl->status.i_status == PLAYLIST_RUNNING )
362

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

366
/** Tell the number of items in the current playing context */
367 368
#define playlist_CurrentSize( obj ) obj->p_libvlc->p_playlist->current.i_size

369

370 371 372 373 374 375 376 377
/** 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
378 379 380
/**
 * @}
 */
381 382

#endif