include/vlc_playlist.h

   1 /*****************************************************************************
   2  * vlc_playlist.h : Playlist functions
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef VLC_PLAYLIST_H_
  25 #define VLC_PLAYLIST_H_
  26
  27 # ifdef __cplusplus
  28 extern "C" {
  29 # endif
  30
  31 #include <vlc_input.h>
  32 #include <vlc_events.h>
  33
  34 TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t)
  35
  36 /**
  37  * \file
  38  * This file contain structures and function prototypes related
  39  * to the playlist in vlc
  40  *
  41  * \defgroup vlc_playlist Playlist
  42  *
  43  * The VLC playlist system has a tree structure. This allows advanced
  44  * categorization, like for SAP streams (which are grouped by "sap groups").
  45  *
  46  * The base structure for all playlist operations is the input_item_t. This
  47  * contains all information needed to play a stream and get info, ie, mostly,
  48  * mrl and metadata. This structure contains a unique i_id field. ids are
  49  * not recycled when an item is destroyed.
  50  *
  51  * Input items are not used directly, but through playlist items.
  52  * The playlist items are themselves in a tree structure. They only contain
  53  * a link to the input item, a unique id and a few flags. the playlist
  54  * item id is NOT the same as the input item id.
  55  * Several playlist items can be attached to a single input item. The input
  56  * item is refcounted and is automatically destroyed when it is not used
  57  * anymore.
  58  *
  59  * In the playlist itself, there are two trees, that should always be kept
  60  * in sync. The "category" tree contains the whole tree structure with
  61  * several levels, while the onelevel tree contains only one level :), ie
  62  * it only contains "real" items, not nodes
  63  * For example, if you open a directory, you will have
  64  *\verbatim
  65  * Category tree:               Onelevel tree:
  66  * Playlist                     Playlist
  67  *  - Dir                         - item1
  68  *    - Subdir                    - item2
  69  *      - item1
  70  *      - item2
  71  *\endverbatim
  72  * The top-level items of both tree are the same, and they are reproduced
  73  * in the left-part of the playlist GUIs, they are the "sources" from the
  74  * source selectors. Top-level items include: playlist, media library, SAP,
  75  * Shoutcast, devices, ...
  76  *
  77  * It is envisioned that a third tree will appear: VLM, but it's not done yet
  78  *
  79  * The playlist also stores, for utility purposes, an array of all input
  80  * items, an array of all playlist items and an array of all playlist items
  81  * and nodes (both are represented by the same structure).
  82  *
  83  * So, here is an example:
  84  * \verbatim
  85  * Inputs array
  86  *  - input 1 -> name = foo 1 uri = ...
  87  *  - input 2 -> name = foo 2 uri = ...
  88  *
  89  * Category tree                        Onelevel tree
  90  * - playlist (id 1)                    - playlist (id 3)
  91  *    - category 1 (id 2)                - foo 2 (id 8 - input 2)
  92  *      - foo 2 (id 6 - input 2)       - media library (id 4)
  93  * - media library (id 2)                - foo 1 (id6 - input 1)
  94  *    - foo 1 (id 5 - input 1)
  95  * \endverbatim
  96  * Sometimes, an item must be transformed to a node. This happens for the
  97  * directory access for example. In that case, the item is removed from
  98  * the onelevel tree, as it is not a real item anymore.
  99  *
 100  * For "standard" item addition, you can use playlist_Add, playlist_AddExt
 101  * (more options) or playlist_AddInput if you already created your input
 102  * item. This will add the item at the root of "Playlist" or of "Media library"
 103  * in each of the two trees.
 104  *
 105  * If you want more control (like, adding the item as the child of a given
 106  * node in the category tree, use playlist_BothAddInput. You'll have to provide
 107  * the node in the category tree. The item will be added as a child of
 108  * this node in the category tree, and as a child of the matching top-level
 109  * node in the onelevel tree. (Nodes are created with playlist_NodeCreate)
 110  *
 111  * Generally speaking, playlist_NodeAddInput should not be used in newer code, it
 112  * will maybe become useful again when we merge VLM;
 113  *
 114  * To delete an item, use playlist_DeleteFromInput( p_item ) which will
 115  * remove all occurrences of the input in both trees
 116  *
 117  *
 118  * The playlist defines the following event variables:
 119  *
 120  * - "item-change": It will contains the input_item_t->i_id of a changed input
 121  * item monitored by the playlist.
 122  * * - "item-current": It will contains a input_item_t->i_id of the current
 123  * item being played.
 124  *
 125  * - "playlist-item-append": It will contains a pointer to a playlist_add_t.
 126  * - "playlist-item-deleted": It will contains the playlist_item_t->i_id of a deleted
 127  * playlist_item_t.
 128  *
 129  * XXX Be really carefull, playlist_item_t->i_id and input_item_t->i_id are not
 130  * the same. Yes, the situation is pretty bad.
 131  *
 132  * @{
 133  */
 134
 135 /** Helper structure to export to file part of the playlist */
 136 typedef struct playlist_export_t
 137 {
 138     VLC_COMMON_MEMBERS
 139     const char *psz_filename;
 140     FILE *p_file;
 141     playlist_item_t *p_root;
 142 } playlist_export_t;
 143
 144 /** playlist item / node */
 145 struct playlist_item_t
 146 {
 147     input_item_t           *p_input;    /**< Linked input item */
 148     /** Number of children, -1 if not a node */
 149     int                    i_children;
 150     playlist_item_t      **pp_children; /**< Children nodes/items */
 151     playlist_item_t       *p_parent;    /**< Item parent */
 152
 153     int                    i_id;        /**< Playlist item specific id */
 154     uint8_t                i_flags;     /**< Flags */
 155     playlist_t            *p_playlist;  /**< Parent playlist */
 156 };
 157
 158 #define PLAYLIST_SAVE_FLAG      0x0001    /**< Must it be saved */
 159 #define PLAYLIST_SKIP_FLAG      0x0002    /**< Must playlist skip after it ? */
 160 #define PLAYLIST_DBL_FLAG       0x0004    /**< Is it disabled ? */
 161 #define PLAYLIST_RO_FLAG        0x0008    /**< Write-enabled ? */
 162 #define PLAYLIST_REMOVE_FLAG    0x0010    /**< Remove this item at the end */
 163 #define PLAYLIST_EXPANDED_FLAG  0x0020    /**< Expanded node */
 164 #define PLAYLIST_SUBITEM_STOP_FLAG 0x0040 /**< Must playlist stop if the item gets subitems ?*/
 165
 166 /** Playlist status */
 167 typedef enum
 168 { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
 169
 170 /** Structure containing information about the playlist */
 171 struct playlist_t
 172 {
 173     VLC_COMMON_MEMBERS
 174
 175     playlist_item_array_t items; /**< Arrays of items */
 176     playlist_item_array_t all_items; /**< Array of items and nodes */
 177
 178     playlist_item_array_t current; /**< Items currently being played */
 179     int                   i_current_index; /**< Index in current array */
 180
 181     /* Predefined items */
 182     playlist_item_t *     p_root;
 183     playlist_item_t *     p_playing;
 184     playlist_item_t *     p_media_library;
 185
 186     //Phony ones, point to those above;
 187     playlist_item_t *     p_root_category; /**< Root of category tree */
 188     playlist_item_t *     p_root_onelevel; /**< Root of onelevel tree */
 189     playlist_item_t *     p_local_category; /** < "Playlist" in CATEGORY view */
 190     playlist_item_t *     p_ml_category; /** < "Library" in CATEGORY view */
 191     playlist_item_t *     p_local_onelevel; /** < "Playlist" in ONELEVEL view */
 192     playlist_item_t *     p_ml_onelevel; /** < "Library" in ONELEVEL view */
 193 };
 194
 195 /** Helper to add an item */
 196 struct playlist_add_t
 197 {
 198     int i_node; /**< Playist id of the parent node */
 199     int i_item; /**< Playist id of the playlist_item_t */
 200 };
 201
 202 /* A bit of macro magic to generate an enum out of the following list,
 203  * and later, to generate a list of static functions out of the same list.
 204  * There is also SORT_RANDOM, which is always last and handled specially.
 205  */
 206 #define VLC_DEFINE_SORT_FUNCTIONS \
 207     DEF( SORT_ID )\
 208     DEF( SORT_TITLE )\
 209     DEF( SORT_TITLE_NODES_FIRST )\
 210     DEF( SORT_ARTIST )\
 211     DEF( SORT_GENRE )\
 212     DEF( SORT_DURATION )\
 213     DEF( SORT_TITLE_NUMERIC )\
 214     DEF( SORT_ALBUM )\
 215     DEF( SORT_TRACK_NUMBER )\
 216     DEF( SORT_DESCRIPTION )\
 217     DEF( SORT_RATING )\
 218     DEF( SORT_URI )
 219
 220 #define DEF( s ) s,
 221 enum
 222 {
 223     VLC_DEFINE_SORT_FUNCTIONS
 224     SORT_RANDOM,
 225     NUM_SORT_FNS=SORT_RANDOM
 226 };
 227 #undef  DEF
 228 #ifndef VLC_INTERNAL_PLAYLIST_SORT_FUNCTIONS
 229 #undef  VLC_DEFINE_SORT_FUNCTIONS
 230 #endif
 231
 232 enum
 233 {
 234     ORDER_NORMAL = 0,
 235     ORDER_REVERSE = 1,
 236 };
 237
 238 /* Used by playlist_Import */
 239 #define PLAYLIST_INSERT          0x0001
 240 #define PLAYLIST_APPEND          0x0002
 241 #define PLAYLIST_GO              0x0004
 242 #define PLAYLIST_PREPARSE        0x0008
 243 #define PLAYLIST_SPREPARSE       0x0010
 244 #define PLAYLIST_NO_REBUILD      0x0020
 245
 246 #define PLAYLIST_END           -666
 247
 248 enum pl_locked_state
 249 {
 250     pl_Locked = true,
 251     pl_Unlocked = false
 252 };
 253
 254 /*****************************************************************************
 255  * Prototypes
 256  *****************************************************************************/
 257
 258 /* Helpers */
 259 #define PL_LOCK playlist_Lock( p_playlist )
 260 #define PL_UNLOCK playlist_Unlock( p_playlist )
 261 #define PL_ASSERT_LOCKED playlist_AssertLocked( p_playlist )
 262
 263 VLC_EXPORT( playlist_t *, pl_Get, ( vlc_object_t * ) );
 264 #define pl_Get( a ) pl_Get( VLC_OBJECT(a) )
 265
 266 /* Playlist control */
 267 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
 268 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
 269 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
 270 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
 271 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
 272 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked,  (i) )
 273
 274 VLC_EXPORT( void, playlist_Lock, ( playlist_t * ) );
 275 VLC_EXPORT( void, playlist_Unlock, ( playlist_t * ) );
 276 VLC_EXPORT( void, playlist_AssertLocked, ( playlist_t * ) );
 277
 278 /**
 279  * Do a playlist action.
 280  * If there is something in the playlist then you can do playlist actions.
 281  * Possible queries are listed in vlc_common.h
 282  * \param p_playlist the playlist to do the command on
 283  * \param i_query the command to do
 284  * \param b_locked TRUE if playlist is locked when entering this function
 285  * \param variable number of arguments
 286  * \return VLC_SUCCESS or an error
 287  */
 288 VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, bool b_locked, ...  ) );
 289
 290 /** Get current playing input. The object is retained.
 291  */
 292 VLC_EXPORT( input_thread_t *, playlist_CurrentInput, ( playlist_t *p_playlist ) );
 293
 294 /** Clear the playlist
 295  * \param b_locked TRUE if playlist is locked when entering this function
 296  */
 297 VLC_EXPORT( void,  playlist_Clear, ( playlist_t *, bool ) );
 298
 299 /** Enqueue an input item for preparsing */
 300 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t * ) );
 301
 302 /** Request the art for an input item to be fetched */
 303 VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t * ) );
 304
 305 /* Playlist sorting */
 306 VLC_EXPORT( int,  playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
 307 VLC_EXPORT( int,  playlist_TreeMoveMany, ( playlist_t *, int, playlist_item_t **, playlist_item_t *, int ) );
 308 VLC_EXPORT( int,  playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
 309
 310 VLC_EXPORT( playlist_item_t *,  playlist_CurrentPlayingItem, ( playlist_t * ) );
 311 VLC_EXPORT( int,   playlist_Status, ( playlist_t * ) );
 312
 313 /**
 314  * Export a node of the playlist to a certain type of playlistfile
 315  * \param p_playlist the playlist to export
 316  * \param psz_filename the location where the exported file will be saved
 317  * \param p_export_root the root node to export
 318  * \param psz_type the type of playlist file to create (m3u, pls, ..)
 319  * \return VLC_SUCCESS on success
 320  */
 321 VLC_EXPORT( int,  playlist_Export, ( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type ) );
 322
 323 /**
 324  * Open a playlist file, add its content to the current playlist
 325  */
 326 VLC_EXPORT( int, playlist_Import, ( playlist_t *p_playlist, const char *psz_file ) );
 327
 328 /********************** Services discovery ***********************/
 329
 330 /** Add a list of comma-separated service discovery modules */
 331 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
 332 /** Remove a services discovery module by name */
 333 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
 334 /** Check whether a given SD is loaded */
 335 VLC_EXPORT( bool, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
 336
 337
 338
 339 /********************************************************
 340  * Item management
 341  ********************************************************/
 342
 343 /*************************** Item deletion **************************/
 344 VLC_EXPORT( int,  playlist_DeleteFromInput, ( playlist_t *, input_item_t *, bool ) );
 345
 346 /******************** Item addition ********************/
 347 VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int, bool, bool ) );
 348 VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, int, const char *const *, unsigned, bool, bool ) );
 349 VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, bool, bool ) );
 350 VLC_EXPORT( playlist_item_t *, playlist_NodeAddInput, ( playlist_t *, input_item_t *, playlist_item_t *, int, int, bool ) );
 351
 352 /********************************** Item search *************************/
 353 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int ) );
 354 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) );
 355
 356 VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *, bool ) );
 357
 358 /********************************************************
 359  * Tree management
 360  ********************************************************/
 361 /* Node management */
 362 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_flags, input_item_t * ) );
 363 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) );
 364 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) );
 365 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
 366 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
 367 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, bool , bool ) );
 368
 369 VLC_EXPORT( playlist_item_t *, playlist_GetNextLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, bool b_ena, bool b_unplayed ) );
 370 VLC_EXPORT( playlist_item_t *, playlist_GetPrevLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, bool b_ena, bool b_unplayed ) );
 371
 372 /***********************************************************************
 373  * Inline functions
 374  ***********************************************************************/
 375 /** Small helper tp get current playing input or NULL. Release the input after use. */
 376 #define pl_CurrentInput(a) __pl_CurrentInput( VLC_OBJECT(a) )
 377 static  inline input_thread_t * __pl_CurrentInput( vlc_object_t * p_this )
 378 {
 379     return playlist_CurrentInput( pl_Get( p_this ) );
 380 }
 381
 382 /** Tell if the playlist is empty */
 383 static inline bool playlist_IsEmpty( playlist_t *p_playlist )
 384 {
 385     PL_ASSERT_LOCKED;
 386     return p_playlist->items.i_size == 0;
 387 }
 388
 389 /** Tell the number of items in the current playing context */
 390 static inline int playlist_CurrentSize( playlist_t *p_playlist )
 391 {
 392     PL_ASSERT_LOCKED;
 393     return p_playlist->current.i_size;
 394 }
 395
 396 /** @} */
 397 # ifdef __cplusplus
 398 }
 399 # endif
 400
 401 #endif