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