include/vlc_playlist.h

   1 /*****************************************************************************
   2  * vlc_playlist.h : Playlist functions
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 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 being played.
 106  *
 107  * - "playlist-item-append": It will contain a pointer to a playlist_add_t.
 108  * - "playlist-item-deleted": It will contain the playlist_item_t->i_id of a
 109  * deleted playlist_item_t.
 110  *
 111  * - "leaf-to-parent": It will contain the playlist_item_t->i_id of an item that is transformed
 112  *   into a node.
 113  *
 114  * The playlist contains rate-variable which is propagated to current input if available
 115  * also rate-slower/rate-faster is in use
 116  *
 117  * XXX Be really carefull, playlist_item_t->i_id and input_item_t->i_id are not
 118  * the same. Yes, the situation is pretty bad.
 119  *
 120  * @{
 121  */
 122
 123 /** Helper structure to export to file part of the playlist */
 124 typedef struct playlist_export_t
 125 {
 126     VLC_COMMON_MEMBERS
 127     const char *psz_filename;
 128     FILE *p_file;
 129     playlist_item_t *p_root;
 130 } playlist_export_t;
 131
 132 /** playlist item / node */
 133 struct playlist_item_t
 134 {
 135     input_item_t           *p_input;    /**< Linked input item */
 136
 137     playlist_item_t      **pp_children; /**< Children nodes/items */
 138     playlist_item_t       *p_parent;    /**< Item parent */
 139     int                    i_children;  /**< Number of children, -1 if not a node */
 140
 141     int                    i_id;        /**< Playlist item specific id */
 142     uint8_t                i_flags;     /**< Flags \see playlist_item_flags_e */
 143
 144     playlist_t            *p_playlist;  /**< Parent playlist */
 145 };
 146
 147 typedef enum {
 148     PLAYLIST_SAVE_FLAG         = 0x0001,  /**< Must it be saved */
 149     PLAYLIST_SKIP_FLAG         = 0x0002,  /**< Must playlist skip after it ? */
 150     PLAYLIST_DBL_FLAG          = 0x0004,  /**< Is it disabled ? */
 151     PLAYLIST_RO_FLAG           = 0x0008,  /**< Write-enabled ? */
 152     PLAYLIST_REMOVE_FLAG       = 0x0010,  /**< Remove this item at the end */
 153     PLAYLIST_EXPANDED_FLAG     = 0x0020,  /**< Expanded node */
 154     PLAYLIST_SUBITEM_STOP_FLAG = 0x0040,  /**< Must playlist stop if the item gets subitems ?*/
 155 } playlist_item_flags_e;
 156
 157 /** Playlist status */
 158 typedef enum
 159 { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
 160
 161 /** Structure containing information about the playlist */
 162 struct playlist_t
 163 {
 164     VLC_COMMON_MEMBERS
 165
 166     playlist_item_array_t items; /**< Arrays of items */
 167     playlist_item_array_t all_items; /**< Array of items and nodes */
 168
 169     playlist_item_array_t current; /**< Items currently being played */
 170     int                   i_current_index; /**< Index in current array */
 171
 172     /* Predefined items */
 173     playlist_item_t *     p_root;
 174     playlist_item_t *     p_playing;
 175     playlist_item_t *     p_media_library;
 176
 177     //Phony ones, point to those above;
 178     playlist_item_t *     p_root_category; /**< Root of category tree */
 179     playlist_item_t *     p_root_onelevel; /**< Root of onelevel tree */
 180     playlist_item_t *     p_local_category; /** < "Playlist" in CATEGORY view */
 181     playlist_item_t *     p_ml_category; /** < "Library" in CATEGORY view */
 182     playlist_item_t *     p_local_onelevel; /** < "Playlist" in ONELEVEL view */
 183     playlist_item_t *     p_ml_onelevel; /** < "Library" in ONELEVEL view */
 184 };
 185
 186 /** Helper to add an item */
 187 struct playlist_add_t
 188 {
 189     int i_node; /**< Playist id of the parent node */
 190     int i_item; /**< Playist id of the playlist_item_t */
 191 };
 192
 193 /* A bit of macro magic to generate an enum out of the following list,
 194  * and later, to generate a list of static functions out of the same list.
 195  * There is also SORT_RANDOM, which is always last and handled specially.
 196  */
 197 #define VLC_DEFINE_SORT_FUNCTIONS \
 198     DEF( SORT_ID )\
 199     DEF( SORT_TITLE )\
 200     DEF( SORT_TITLE_NODES_FIRST )\
 201     DEF( SORT_ARTIST )\
 202     DEF( SORT_GENRE )\
 203     DEF( SORT_DURATION )\
 204     DEF( SORT_TITLE_NUMERIC )\
 205     DEF( SORT_ALBUM )\
 206     DEF( SORT_TRACK_NUMBER )\
 207     DEF( SORT_DESCRIPTION )\
 208     DEF( SORT_RATING )\
 209     DEF( SORT_URI )
 210
 211 #define DEF( s ) s,
 212 enum
 213 {
 214     VLC_DEFINE_SORT_FUNCTIONS
 215     SORT_RANDOM,
 216     NUM_SORT_FNS=SORT_RANDOM
 217 };
 218 #undef  DEF
 219 #ifndef VLC_INTERNAL_PLAYLIST_SORT_FUNCTIONS
 220 #undef  VLC_DEFINE_SORT_FUNCTIONS
 221 #endif
 222
 223 enum
 224 {
 225     ORDER_NORMAL = 0,
 226     ORDER_REVERSE = 1,
 227 };
 228
 229 /* Used by playlist_Import */
 230 #define PLAYLIST_INSERT          0x0001
 231 #define PLAYLIST_APPEND          0x0002
 232 #define PLAYLIST_GO              0x0004
 233 #define PLAYLIST_PREPARSE        0x0008
 234 #define PLAYLIST_SPREPARSE       0x0010
 235 #define PLAYLIST_NO_REBUILD      0x0020
 236
 237 #define PLAYLIST_END           -666
 238
 239 enum pl_locked_state
 240 {
 241     pl_Locked = true,
 242     pl_Unlocked = false
 243 };
 244
 245 /*****************************************************************************
 246  * Prototypes
 247  *****************************************************************************/
 248
 249 /* Helpers */
 250 #define PL_LOCK playlist_Lock( p_playlist )
 251 #define PL_UNLOCK playlist_Unlock( p_playlist )
 252 #define PL_ASSERT_LOCKED playlist_AssertLocked( p_playlist )
 253
 254 VLC_API playlist_t * pl_Get( vlc_object_t * );
 255 #define pl_Get( a ) pl_Get( VLC_OBJECT(a) )
 256
 257 /* Playlist control */
 258 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
 259 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
 260 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
 261 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
 262 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
 263 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked,  (i) )
 264
 265 VLC_API void playlist_Lock( playlist_t * );
 266 VLC_API void playlist_Unlock( playlist_t * );
 267 VLC_API void playlist_AssertLocked( playlist_t * );
 268 VLC_API void playlist_Deactivate( playlist_t * );
 269
 270 /**
 271  * Do a playlist action.
 272  * If there is something in the playlist then you can do playlist actions.
 273  * Possible queries are listed in vlc_common.h
 274  * \param p_playlist the playlist to do the command on
 275  * \param i_query the command to do
 276  * \param b_locked TRUE if playlist is locked when entering this function
 277  * \param variable number of arguments
 278  * \return VLC_SUCCESS or an error
 279  */
 280 VLC_API int playlist_Control( playlist_t *p_playlist, int i_query, bool b_locked, ...  );
 281
 282 /** Get current playing input. The object is retained.
 283  */
 284 VLC_API input_thread_t * playlist_CurrentInput( playlist_t *p_playlist ) VLC_USED;
 285
 286 /** Get the duration of all items in a node.
 287  */
 288 VLC_API mtime_t playlist_GetNodeDuration( playlist_item_t * );
 289
 290 /** Clear the playlist
 291  * \param b_locked TRUE if playlist is locked when entering this function
 292  */
 293 VLC_API void playlist_Clear( playlist_t *, bool );
 294
 295 /** Enqueue an input item for preparsing */
 296 VLC_API int playlist_PreparseEnqueue(playlist_t *, input_item_t * );
 297
 298 /** Request the art for an input item to be fetched */
 299 VLC_API int playlist_AskForArtEnqueue(playlist_t *, input_item_t * );
 300
 301 /* Playlist sorting */
 302 VLC_API int playlist_TreeMove( playlist_t *, playlist_item_t *, playlist_item_t *, int );
 303 VLC_API int playlist_TreeMoveMany( playlist_t *, int, playlist_item_t **, playlist_item_t *, int );
 304 VLC_API int playlist_RecursiveNodeSort( playlist_t *, playlist_item_t *,int, int );
 305
 306 VLC_API playlist_item_t * playlist_CurrentPlayingItem( playlist_t * ) VLC_USED;
 307 VLC_API int playlist_Status( playlist_t * );
 308
 309 /**
 310  * Export a node of the playlist to a certain type of playlistfile
 311  * \param p_playlist the playlist to export
 312  * \param psz_filename the location where the exported file will be saved
 313  * \param p_export_root the root node to export
 314  * \param psz_type the type of playlist file to create (m3u, pls, ..)
 315  * \return VLC_SUCCESS on success
 316  */
 317 VLC_API int playlist_Export( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type );
 318
 319 /**
 320  * Open a playlist file, add its content to the current playlist
 321  */
 322 VLC_API int playlist_Import( playlist_t *p_playlist, const char *psz_file );
 323
 324 /********************** Services discovery ***********************/
 325
 326 /** Add a list of comma-separated service discovery modules */
 327 VLC_API int playlist_ServicesDiscoveryAdd(playlist_t *, const char *);
 328 /** Remove a services discovery module by name */
 329 VLC_API int playlist_ServicesDiscoveryRemove(playlist_t *, const char *);
 330 /** Check whether a given SD is loaded */
 331 VLC_API bool playlist_IsServicesDiscoveryLoaded( playlist_t *,const char *) VLC_DEPRECATED;
 332 /** Query a services discovery */
 333 VLC_API int playlist_ServicesDiscoveryControl( playlist_t *, const char *, int, ... );
 334
 335
 336
 337 /********************************************************
 338  * Item management
 339  ********************************************************/
 340
 341 /*************************** Item deletion **************************/
 342 VLC_API int playlist_DeleteFromInput( playlist_t *, input_item_t *, bool );
 343
 344 /******************** Item addition ********************/
 345 VLC_API int playlist_Add( playlist_t *, const char *, const char *, int, int, bool, bool );
 346 VLC_API int playlist_AddExt( playlist_t *, const char *, const char *, int, int, mtime_t, int, const char *const *, unsigned, bool, bool );
 347 VLC_API int playlist_AddInput( playlist_t *, input_item_t *, int, int, bool, bool );
 348 VLC_API playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *, playlist_item_t *, int, int, bool );
 349 VLC_API int playlist_NodeAddCopy( playlist_t *, playlist_item_t *, playlist_item_t *, int );
 350
 351 /********************************** Item search *************************/
 352 VLC_API playlist_item_t * playlist_ItemGetById(playlist_t *, int ) VLC_USED;
 353 VLC_API playlist_item_t * playlist_ItemGetByInput(playlist_t *,input_item_t * ) VLC_USED;
 354
 355 VLC_API int playlist_LiveSearchUpdate(playlist_t *, playlist_item_t *, const char *, bool );
 356
 357 /********************************************************
 358  * Tree management
 359  ********************************************************/
 360 /* Node management */
 361 VLC_API playlist_item_t * playlist_NodeCreate( playlist_t *, const char *, playlist_item_t * p_parent, int i_pos, int i_flags, input_item_t * );
 362 VLC_API int playlist_NodeAppend(playlist_t *,playlist_item_t*,playlist_item_t *);
 363 VLC_API int playlist_NodeInsert(playlist_t *,playlist_item_t*,playlist_item_t *, int);
 364 VLC_API int playlist_NodeRemoveItem(playlist_t *,playlist_item_t*,playlist_item_t *);
 365 VLC_API playlist_item_t * playlist_ChildSearchName(playlist_item_t*, const char* ) VLC_USED;
 366 VLC_API int playlist_NodeDelete( playlist_t *, playlist_item_t *, bool , bool );
 367
 368 VLC_API 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 ) VLC_USED;
 369 VLC_API 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 ) VLC_USED;
 370
 371 /**************************
 372  * Audio output management
 373  **************************/
 374
 375 VLC_API audio_output_t *playlist_GetAout( playlist_t * );
 376
 377 #define AOUT_VOLUME_DEFAULT             256
 378 #define AOUT_VOLUME_MAX                 512
 379
 380 VLC_API float playlist_VolumeGet( playlist_t * );
 381 VLC_API int playlist_VolumeSet( playlist_t *, float );
 382 VLC_API int playlist_VolumeUp( playlist_t *, int, float * );
 383 #define playlist_VolumeDown(a, b, c) playlist_VolumeUp(a, -(b), c)
 384 VLC_API int playlist_MuteSet( playlist_t *, bool );
 385 VLC_API int playlist_MuteGet( playlist_t * );
 386
 387 static inline int playlist_MuteToggle( playlist_t *pl )
 388 {
 389     int val = playlist_MuteGet( pl );
 390     if (val >= 0)
 391         val = playlist_MuteSet( pl, !val );
 392     return val;
 393 }
 394
 395 VLC_API void playlist_EnableAudioFilter( playlist_t *, const char *, bool );
 396
 397 /***********************************************************************
 398  * Inline functions
 399  ***********************************************************************/
 400 /** Small helper tp get current playing input or NULL. Release the input after use. */
 401 #define pl_CurrentInput(a) __pl_CurrentInput( VLC_OBJECT(a) )
 402 static  inline input_thread_t * __pl_CurrentInput( vlc_object_t * p_this )
 403 {
 404     return playlist_CurrentInput( pl_Get( p_this ) );
 405 }
 406
 407 /** Tell if the playlist is empty */
 408 static inline bool playlist_IsEmpty( playlist_t *p_playlist )
 409 {
 410     PL_ASSERT_LOCKED;
 411     return p_playlist->items.i_size == 0;
 412 }
 413
 414 /** Tell the number of items in the current playing context */
 415 static inline int playlist_CurrentSize( playlist_t *p_playlist )
 416 {
 417     PL_ASSERT_LOCKED;
 418     return p_playlist->current.i_size;
 419 }
 420
 421 /** @} */
 422 # ifdef __cplusplus
 423 }
 424 # endif
 425
 426 #endif