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  * The top-level items are the main media sources and include:
  60  * playlist, media library, SAP, Shoutcast, devices, ...
  61  *
  62  * It is envisioned that a third tree will appear: VLM, but it's not done yet
  63  *
  64  * The playlist also stores, for utility purposes, an array of all input
  65  * items, an array of all playlist items and an array of all playlist items
  66  * and nodes (both are represented by the same structure).
  67  *
  68  * So, here is an example:
  69  * \verbatim
  70  * Inputs array
  71  *  - input 1 -> name = foo 1 uri = ...
  72  *  - input 2 -> name = foo 2 uri = ...
  73  *
  74  * Playlist items tree
  75  * - playlist (id 1)
  76  *    - category 1 (id 2)
  77  *      - foo 2 (id 6 - input 2)
  78  * - media library (id 2)
  79  *    - foo 1 (id 5 - input 1)
  80  * \endverbatim
  81  *
  82  * Sometimes, an item creates subitems. This happens for the directory access
  83  * for example. In that case, if the item is under the "playlist" top-level item
  84  * and playlist is configured to be flat then the item will be deleted and
  85  * replaced with new subitems. If the item is under another top-level item, it
  86  * will be transformed to a node and removed from the list of all items without
  87  * nodes.
  88  *
  89  * For "standard" item addition, you can use playlist_Add, playlist_AddExt
  90  * (more options) or playlist_AddInput if you already created your input
  91  * item. This will add the item at the root of "Playlist" or of "Media library"
  92  * in each of the two trees.
  93  *
  94  * You can create nodes with playlist_NodeCreate and can create items from
  95  * existing input items to be placed under any node with playlist_NodeAddInput.
  96  *
  97  * To delete an item, use playlist_DeleteFromInput( p_item ) which will
  98  * remove all occurrences of the input.
  99  *
 100  *
 101  * The playlist defines the following event variables:
 102  *
 103  * - "item-change": It will contain the input_item_t->i_id of a changed input
 104  * item monitored by the playlist.
 105  * - "item-current": It will contain a input_item_t->i_id of the current
 106  * item being played.
 107  *
 108  * - "playlist-item-append": It will contain a pointer to a playlist_add_t.
 109  * - "playlist-item-deleted": It will contain the playlist_item_t->i_id of a
 110  * deleted playlist_item_t.
 111  *
 112  * - "leaf-to-parent": Set when an item gets subitems and is transformed to a
 113  * node. It will contain a pointer to the input_item_t bound to the transformed
 114  * playlist item.
 115  *
 116  * The playlist contains rate-variable which is propagated to current input if available
 117  * also rate-slower/rate-faster is in use
 118  *
 119  * XXX Be really carefull, playlist_item_t->i_id and input_item_t->i_id are not
 120  * the same. Yes, the situation is pretty bad.
 121  *
 122  * @{
 123  */
 124
 125 /** Helper structure to export to file part of the playlist */
 126 typedef struct playlist_export_t
 127 {
 128     VLC_COMMON_MEMBERS
 129     const char *psz_filename;
 130     FILE *p_file;
 131     playlist_item_t *p_root;
 132 } playlist_export_t;
 133
 134 /** playlist item / node */
 135 struct playlist_item_t
 136 {
 137     input_item_t           *p_input;    /**< Linked input item */
 138     /** Number of children, -1 if not a node */
 139     playlist_item_t      **pp_children; /**< Children nodes/items */
 140     playlist_item_t       *p_parent;    /**< Item parent */
 141     int                    i_children;
 142
 143     int                    i_id;        /**< Playlist item specific id */
 144     uint8_t                i_flags;     /**< Flags */
 145     playlist_t            *p_playlist;  /**< Parent playlist */
 146 };
 147
 148 #define PLAYLIST_SAVE_FLAG      0x0001    /**< Must it be saved */
 149 #define PLAYLIST_SKIP_FLAG      0x0002    /**< Must playlist skip after it ? */
 150 #define PLAYLIST_DBL_FLAG       0x0004    /**< Is it disabled ? */
 151 #define PLAYLIST_RO_FLAG        0x0008    /**< Write-enabled ? */
 152 #define PLAYLIST_REMOVE_FLAG    0x0010    /**< Remove this item at the end */
 153 #define PLAYLIST_EXPANDED_FLAG  0x0020    /**< Expanded node */
 154 #define PLAYLIST_SUBITEM_STOP_FLAG 0x0040 /**< Must playlist stop if the item gets subitems ?*/
 155
 156 /** Playlist status */
 157 typedef enum
 158 { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
 159
 160 /** Structure containing information about the playlist */
 161 struct playlist_t
 162 {
 163     VLC_COMMON_MEMBERS
 164
 165     playlist_item_array_t items; /**< Arrays of items */
 166     playlist_item_array_t all_items; /**< Array of items and nodes */
 167
 168     playlist_item_array_t current; /**< Items currently being played */
 169     int                   i_current_index; /**< Index in current array */
 170
 171     /* Predefined items */
 172     playlist_item_t *     p_root;
 173     playlist_item_t *     p_playing;
 174     playlist_item_t *     p_media_library;
 175
 176     //Phony ones, point to those above;
 177     playlist_item_t *     p_root_category; /**< Root of category tree */
 178     playlist_item_t *     p_root_onelevel; /**< Root of onelevel tree */
 179     playlist_item_t *     p_local_category; /** < "Playlist" in CATEGORY view */
 180     playlist_item_t *     p_ml_category; /** < "Library" in CATEGORY view */
 181     playlist_item_t *     p_local_onelevel; /** < "Playlist" in ONELEVEL view */
 182     playlist_item_t *     p_ml_onelevel; /** < "Library" in ONELEVEL view */
 183 };
 184
 185 /** Helper to add an item */
 186 struct playlist_add_t
 187 {
 188     int i_node; /**< Playist id of the parent node */
 189     int i_item; /**< Playist id of the playlist_item_t */
 190 };
 191
 192 /* A bit of macro magic to generate an enum out of the following list,
 193  * and later, to generate a list of static functions out of the same list.
 194  * There is also SORT_RANDOM, which is always last and handled specially.
 195  */
 196 #define VLC_DEFINE_SORT_FUNCTIONS \
 197     DEF( SORT_ID )\
 198     DEF( SORT_TITLE )\
 199     DEF( SORT_TITLE_NODES_FIRST )\
 200     DEF( SORT_ARTIST )\
 201     DEF( SORT_GENRE )\
 202     DEF( SORT_DURATION )\
 203     DEF( SORT_TITLE_NUMERIC )\
 204     DEF( SORT_ALBUM )\
 205     DEF( SORT_TRACK_NUMBER )\
 206     DEF( SORT_DESCRIPTION )\
 207     DEF( SORT_RATING )\
 208     DEF( SORT_URI )
 209
 210 #define DEF( s ) s,
 211 enum
 212 {
 213     VLC_DEFINE_SORT_FUNCTIONS
 214     SORT_RANDOM,
 215     NUM_SORT_FNS=SORT_RANDOM
 216 };
 217 #undef  DEF
 218 #ifndef VLC_INTERNAL_PLAYLIST_SORT_FUNCTIONS
 219 #undef  VLC_DEFINE_SORT_FUNCTIONS
 220 #endif
 221
 222 enum
 223 {
 224     ORDER_NORMAL = 0,
 225     ORDER_REVERSE = 1,
 226 };
 227
 228 /* Used by playlist_Import */
 229 #define PLAYLIST_INSERT          0x0001
 230 #define PLAYLIST_APPEND          0x0002
 231 #define PLAYLIST_GO              0x0004
 232 #define PLAYLIST_PREPARSE        0x0008
 233 #define PLAYLIST_SPREPARSE       0x0010
 234 #define PLAYLIST_NO_REBUILD      0x0020
 235
 236 #define PLAYLIST_END           -666
 237
 238 enum pl_locked_state
 239 {
 240     pl_Locked = true,
 241     pl_Unlocked = false
 242 };
 243
 244 /*****************************************************************************
 245  * Prototypes
 246  *****************************************************************************/
 247
 248 /* Helpers */
 249 #define PL_LOCK playlist_Lock( p_playlist )
 250 #define PL_UNLOCK playlist_Unlock( p_playlist )
 251 #define PL_ASSERT_LOCKED playlist_AssertLocked( p_playlist )
 252
 253 VLC_EXPORT( playlist_t *, pl_Get, ( vlc_object_t * ) LIBVLC_USED );
 254 #define pl_Get( a ) pl_Get( VLC_OBJECT(a) )
 255
 256 /* Playlist control */
 257 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
 258 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
 259 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
 260 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
 261 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
 262 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked,  (i) )
 263
 264 VLC_EXPORT( void, playlist_Lock, ( playlist_t * ) );
 265 VLC_EXPORT( void, playlist_Unlock, ( playlist_t * ) );
 266 VLC_EXPORT( void, playlist_AssertLocked, ( playlist_t * ) );
 267
 268 /**
 269  * Do a playlist action.
 270  * If there is something in the playlist then you can do playlist actions.
 271  * Possible queries are listed in vlc_common.h
 272  * \param p_playlist the playlist to do the command on
 273  * \param i_query the command to do
 274  * \param b_locked TRUE if playlist is locked when entering this function
 275  * \param variable number of arguments
 276  * \return VLC_SUCCESS or an error
 277  */
 278 VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, bool b_locked, ...  ) );
 279
 280 /** Get current playing input. The object is retained.
 281  */
 282 VLC_EXPORT( input_thread_t *, playlist_CurrentInput, ( playlist_t *p_playlist ) LIBVLC_USED );
 283
 284 /** Clear the playlist
 285  * \param b_locked TRUE if playlist is locked when entering this function
 286  */
 287 VLC_EXPORT( void,  playlist_Clear, ( playlist_t *, bool ) );
 288
 289 /** Enqueue an input item for preparsing */
 290 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t * ) );
 291
 292 /** Request the art for an input item to be fetched */
 293 VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t * ) );
 294
 295 /* Playlist sorting */
 296 VLC_EXPORT( int,  playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
 297 VLC_EXPORT( int,  playlist_TreeMoveMany, ( playlist_t *, int, playlist_item_t **, playlist_item_t *, int ) );
 298 VLC_EXPORT( int,  playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
 299
 300 VLC_EXPORT( playlist_item_t *,  playlist_CurrentPlayingItem, ( playlist_t * ) LIBVLC_USED );
 301 VLC_EXPORT( int,   playlist_Status, ( playlist_t * ) );
 302
 303 /**
 304  * Export a node of the playlist to a certain type of playlistfile
 305  * \param p_playlist the playlist to export
 306  * \param psz_filename the location where the exported file will be saved
 307  * \param p_export_root the root node to export
 308  * \param psz_type the type of playlist file to create (m3u, pls, ..)
 309  * \return VLC_SUCCESS on success
 310  */
 311 VLC_EXPORT( int,  playlist_Export, ( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type ) );
 312
 313 /**
 314  * Open a playlist file, add its content to the current playlist
 315  */
 316 VLC_EXPORT( int, playlist_Import, ( playlist_t *p_playlist, const char *psz_file ) );
 317
 318 /********************** Services discovery ***********************/
 319
 320 /** Add a list of comma-separated service discovery modules */
 321 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
 322 /** Remove a services discovery module by name */
 323 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
 324 /** Check whether a given SD is loaded */
 325 VLC_EXPORT( bool, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
 326 /** Query a services discovery */
 327 VLC_EXPORT( int, playlist_ServicesDiscoveryControl, ( playlist_t *, const char *, int, ... ) );
 328
 329
 330
 331 /********************************************************
 332  * Item management
 333  ********************************************************/
 334
 335 /*************************** Item deletion **************************/
 336 VLC_EXPORT( int,  playlist_DeleteFromInput, ( playlist_t *, input_item_t *, bool ) );
 337
 338 /******************** Item addition ********************/
 339 VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int, bool, bool ) );
 340 VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, int, const char *const *, unsigned, bool, bool ) );
 341 VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, bool, bool ) );
 342 VLC_EXPORT( playlist_item_t *, playlist_NodeAddInput, ( playlist_t *, input_item_t *, playlist_item_t *, int, int, bool ) );
 343 VLC_EXPORT( int, playlist_NodeAddCopy, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
 344
 345 /********************************** Item search *************************/
 346 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int ) LIBVLC_USED );
 347 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) LIBVLC_USED );
 348
 349 VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *, bool ) );
 350
 351 /********************************************************
 352  * Tree management
 353  ********************************************************/
 354 /* Node management */
 355 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_pos, int i_flags, input_item_t * ) );
 356 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) );
 357 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) );
 358 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
 359 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) LIBVLC_USED );
 360 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, bool , bool ) );
 361
 362 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 ) LIBVLC_USED );
 363 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 ) LIBVLC_USED );
 364
 365 /***********************************************************************
 366  * Inline functions
 367  ***********************************************************************/
 368 /** Small helper tp get current playing input or NULL. Release the input after use. */
 369 #define pl_CurrentInput(a) __pl_CurrentInput( VLC_OBJECT(a) )
 370 static  inline input_thread_t * __pl_CurrentInput( vlc_object_t * p_this )
 371 {
 372     return playlist_CurrentInput( pl_Get( p_this ) );
 373 }
 374
 375 /** Tell if the playlist is empty */
 376 static inline bool playlist_IsEmpty( playlist_t *p_playlist )
 377 {
 378     PL_ASSERT_LOCKED;
 379     return p_playlist->items.i_size == 0;
 380 }
 381
 382 /** Tell the number of items in the current playing context */
 383 static inline int playlist_CurrentSize( playlist_t *p_playlist )
 384 {
 385     PL_ASSERT_LOCKED;
 386     return p_playlist->current.i_size;
 387 }
 388
 389 /** @} */
 390 # ifdef __cplusplus
 391 }
 392 # endif
 393
 394 #endif