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 #include <vlc_aout.h>
  33
  34 TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t)
  35
  36 struct intf_thread_t;
  37
  38 /**
  39  * \defgroup playlist VLC playlist
  40  * VLC playlist controls
  41  * @{
  42  * \file
  43  * VLC playlist control interface
  44  *
  45  * The VLC playlist system has a tree structure. This allows advanced
  46  * categorization, like for SAP streams (which are grouped by "sap groups").
  47  *
  48  * The base structure for all playlist operations is the playlist_item_t.
  49  * This is essentially a node within the playlist tree. Each playlist item
  50  * references an input_item_t which contains the input stream info, such as
  51  * location, name and meta-data.
  52  *
  53  * A playlist item is uniquely identified by its input item:
  54  * \ref playlist_ItemGetByInput(). A single input item cannot be used by more
  55  * than one playlist item at a time; if necessary, a copy of the input item can
  56  * be made instead.
  57  *
  58  * The same playlist tree is visible to all user interfaces. To arbitrate
  59  * access, a lock is used, see \ref playlist_Lock() and \ref playlist_Unlock().
  60  *
  61  * Under the playlist root item node, the top-level items are the main
  62  * media sources and include:
  63  * - the actual playlist,
  64  * - the media library,
  65  * - the service discovery root node, whose children are services discovery
  66  *   module instances.
  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
  84  * item 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
  96  * playlist_NodeAddInput().
  97  *
  98  * To delete an item, use playlist_NodeDelete( p_item ).
  99  *
 100  * The playlist defines the following event variables:
 101  *
 102  * - "item-change": It will contain a pointer to the input_item_t of a
 103  * changed input item monitored by the playlist.
 104  *
 105  * - "playlist-item-append": It will contain a pointer to a playlist_item_t.
 106  * - "playlist-item-deleted": It will contain a pointer to the playlist_item_t
 107  * about to be deleted.
 108  *
 109  * - "leaf-to-parent": It will contain the playlist_item_t->i_id of an item that is transformed
 110  *   into a node.
 111  *
 112  * The playlist contains rate-variable which is propagated to current input if
 113  * available also rate-slower/rate-faster is in use.
 114  */
 115
 116 /** Helper structure to export to file part of the playlist */
 117 typedef struct playlist_export_t
 118 {
 119     VLC_COMMON_MEMBERS
 120     char *base_url;
 121     FILE *p_file;
 122     playlist_item_t *p_root;
 123 } playlist_export_t;
 124
 125 /** playlist item / node */
 126 struct playlist_item_t
 127 {
 128     input_item_t           *p_input;    /**< Linked input item */
 129
 130     playlist_item_t      **pp_children; /**< Children nodes/items */
 131     playlist_item_t       *p_parent;    /**< Item parent */
 132     int                    i_children;  /**< Number of children, -1 if not a node */
 133     unsigned               i_nb_played; /**< Times played */
 134
 135     int                    i_id;        /**< Playlist item specific id */
 136     uint8_t                i_flags;     /**< Flags \see playlist_item_flags_e */
 137 };
 138
 139 typedef enum {
 140     PLAYLIST_DBL_FLAG          = 0x04,  /**< Is it disabled ? */
 141     PLAYLIST_RO_FLAG           = 0x08,  /**< Write-enabled ? */
 142     PLAYLIST_SUBITEM_STOP_FLAG = 0x40,  /**< Must playlist stop if the item gets subitems ?*/
 143     PLAYLIST_NO_INHERIT_FLAG   = 0x80,  /**< Will children inherit flags the R/O flag ? */
 144 } playlist_item_flags_e;
 145
 146 /** Playlist status */
 147 typedef enum
 148 { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
 149
 150 /** Structure containing information about the playlist */
 151 struct playlist_t
 152 {
 153     VLC_COMMON_MEMBERS
 154
 155     playlist_item_array_t items; /**< Arrays of items */
 156
 157     playlist_item_array_t current; /**< Items currently being played */
 158     int                   i_current_index; /**< Index in current array */
 159
 160     /* Predefined items */
 161     playlist_item_t  root;
 162     playlist_item_t *p_playing;
 163     playlist_item_t *p_media_library;
 164 };
 165
 166 /* A bit of macro magic to generate an enum out of the following list,
 167  * and later, to generate a list of static functions out of the same list.
 168  * There is also SORT_RANDOM, which is always last and handled specially.
 169  */
 170 #define VLC_DEFINE_SORT_FUNCTIONS \
 171     DEF( SORT_ID )\
 172     DEF( SORT_TITLE )\
 173     DEF( SORT_TITLE_NODES_FIRST )\
 174     DEF( SORT_ARTIST )\
 175     DEF( SORT_GENRE )\
 176     DEF( SORT_DURATION )\
 177     DEF( SORT_TITLE_NUMERIC )\
 178     DEF( SORT_ALBUM )\
 179     DEF( SORT_TRACK_NUMBER )\
 180     DEF( SORT_DESCRIPTION )\
 181     DEF( SORT_RATING )\
 182     DEF( SORT_URI )\
 183     DEF( SORT_DISC_NUMBER )\
 184     DEF( SORT_DATE )
 185
 186 #define DEF( s ) s,
 187 enum
 188 {
 189     VLC_DEFINE_SORT_FUNCTIONS
 190     SORT_RANDOM,
 191     NUM_SORT_FNS=SORT_RANDOM
 192 };
 193 #undef  DEF
 194 #ifndef VLC_INTERNAL_PLAYLIST_SORT_FUNCTIONS
 195 #undef  VLC_DEFINE_SORT_FUNCTIONS
 196 #endif
 197
 198 enum
 199 {
 200     ORDER_NORMAL = 0,
 201     ORDER_REVERSE = 1,
 202 };
 203
 204 #define PLAYLIST_END           -1
 205
 206 enum pl_locked_state
 207 {
 208     pl_Locked = true,
 209     pl_Unlocked = false
 210 };
 211
 212 /*****************************************************************************
 213  * Prototypes
 214  *****************************************************************************/
 215
 216 /* Helpers */
 217 #define PL_LOCK playlist_Lock( p_playlist )
 218 #define PL_UNLOCK playlist_Unlock( p_playlist )
 219 #define PL_ASSERT_LOCKED playlist_AssertLocked( p_playlist )
 220
 221 /** Playlist commands */
 222 enum {
 223     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
 224     PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
 225                         /**  arg2 = playlist_item_t*          , res=can fail */
 226     PLAYLIST_TOGGLE_PAUSE, /**< No arg                          res=can fail */
 227     PLAYLIST_STOP,      /**< No arg                             res=can fail*/
 228     PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
 229     PLAYLIST_PAUSE,     /**< No arg */
 230     PLAYLIST_RESUME,    /**< No arg */
 231 };
 232
 233 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
 234 #define playlist_TogglePause(p) \
 235         playlist_Control(p, PLAYLIST_TOGGLE_PAUSE, pl_Unlocked)
 236 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
 237 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
 238 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
 239 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked,  (i) )
 240 #define playlist_Pause(p) \
 241         playlist_Control(p, PLAYLIST_PAUSE, pl_Unlocked)
 242 #define playlist_Resume(p) \
 243         playlist_Control(p, PLAYLIST_RESUME, pl_Unlocked)
 244
 245 /**
 246  * Locks the playlist.
 247  *
 248  * This function locks the playlist. While the playlist is locked, no other
 249  * thread can modify the playlist tree layout or current playing item and node.
 250  *
 251  * Locking the playlist is necessary before accessing, either for reading or
 252  * writing, any playlist item.
 253  *
 254  * \note Because of the potential for lock inversion / deadlocks, locking the
 255  * playlist shall not be attemped while holding an input item lock. An input
 256  * item lock can be acquired while holding the playlist lock.
 257  *
 258  * While holding the playlist lock, a thread shall not attempt to:
 259  * - probe, initialize or deinitialize a module or a plugin,
 260  * - install or deinstall a variable or event callback,
 261  * - set a variable or trigger a variable callback, with the sole exception
 262  *   of the playlist core triggering add/remove/leaf item callbacks,
 263  * - invoke a module/plugin callback other than:
 264  *   - playlist export,
 265  *   - logger message callback.
 266  */
 267 VLC_API void playlist_Lock( playlist_t * );
 268
 269 /**
 270  * Unlocks the playlist.
 271  *
 272  * This function unlocks the playlist, allowing other threads to lock it. The
 273  * calling thread must have called playlist_Lock() before.
 274  *
 275  * This function invalidates all or any playlist item pointers.
 276  * There are no ways to ensure that playlist items are not modified or deleted
 277  * by another thread past this function call.
 278  *
 279  * To retain a reference to a playlist item while not holding the playlist
 280  * lock, a thread should take a reference to the input item within the
 281  * playlist item before unlocking. If this is not practical, then the thread
 282  * can store the playlist item ID (i_id) before unlocking.
 283  * Either way, this will not ensure that the playlist item is not deleted, so
 284  * the thread must be ready to handle that case later when calling
 285  * playlist_ItemGetByInput() or playlist_ItemGetById().
 286  *
 287  * Furthermore, if ID is used, then the playlist item might be deleted, and
 288  * another item could be assigned the same ID. To avoid that problem, use
 289  * the input item instead of the ID.
 290  */
 291 VLC_API void playlist_Unlock( playlist_t * );
 292
 293 VLC_API void playlist_AssertLocked( playlist_t * );
 294 VLC_API void playlist_Deactivate( playlist_t * );
 295
 296 /**
 297  * Do a playlist action.
 298  * If there is something in the playlist then you can do playlist actions.
 299  * Possible queries are listed in vlc_common.h
 300  * \param p_playlist the playlist to do the command on
 301  * \param i_query the command to do
 302  * \param b_locked TRUE if playlist is locked when entering this function
 303  * \param variable number of arguments
 304  */
 305 VLC_API void playlist_Control( playlist_t *p_playlist, int i_query, int b_locked, ...  );
 306
 307 static inline void playlist_ViewPlay(playlist_t *pl, playlist_item_t *node,
 308                                      playlist_item_t *item)
 309 {
 310     playlist_Control(pl, PLAYLIST_VIEWPLAY, pl_Locked, node, item);
 311 }
 312
 313 /** Get current playing input. The object is retained.
 314  */
 315 VLC_API input_thread_t * playlist_CurrentInput( playlist_t *p_playlist ) VLC_USED;
 316 VLC_API input_thread_t *playlist_CurrentInputLocked( playlist_t *p_playlist ) VLC_USED;
 317
 318 /** Get the duration of all items in a node.
 319  */
 320 VLC_API mtime_t playlist_GetNodeDuration( playlist_item_t * );
 321
 322 /** Clear the playlist
 323  * \param b_locked TRUE if playlist is locked when entering this function
 324  */
 325 VLC_API void playlist_Clear( playlist_t *, bool );
 326
 327 /* Playlist sorting */
 328 VLC_API int playlist_TreeMove( playlist_t *, playlist_item_t *, playlist_item_t *, int );
 329 VLC_API int playlist_TreeMoveMany( playlist_t *, int, playlist_item_t **, playlist_item_t *, int );
 330 VLC_API int playlist_RecursiveNodeSort( playlist_t *, playlist_item_t *,int, int );
 331
 332 VLC_API playlist_item_t * playlist_CurrentPlayingItem( playlist_t * ) VLC_USED;
 333 VLC_API int playlist_Status( playlist_t * );
 334
 335 /**
 336  * Export a node of the playlist to a certain type of playlistfile
 337  * \param b_playlist true for the playlist, false for the media library
 338  * \param psz_filename the location where the exported file will be saved
 339  * \param psz_type the type of playlist file to create (m3u, pls, ..)
 340  * \return VLC_SUCCESS on success
 341  */
 342 VLC_API int playlist_Export( playlist_t *p_playlist, const char *psz_name,
 343                              bool b_playlist, const char *psz_type );
 344
 345 /**
 346  * Open a playlist file, add its content to the current playlist
 347  */
 348 VLC_API int playlist_Import( playlist_t *p_playlist, const char *psz_file );
 349
 350 /********************** Services discovery ***********************/
 351
 352 /** Add a service discovery module */
 353 VLC_API int playlist_ServicesDiscoveryAdd(playlist_t *, const char *);
 354 /** Remove a services discovery module by name */
 355 VLC_API int playlist_ServicesDiscoveryRemove(playlist_t *, const char *);
 356 /** Check whether a given SD is loaded */
 357 VLC_API bool playlist_IsServicesDiscoveryLoaded( playlist_t *,const char *) VLC_DEPRECATED;
 358 /** Query a services discovery */
 359 VLC_API int playlist_ServicesDiscoveryControl( playlist_t *, const char *, int, ... );
 360
 361 /********************** Renderer ***********************/
 362 /**
 363  * Sets a renderer or remove the current one
 364  * @param p_item    The renderer item to be used, or NULL to disable the current
 365  *                  one. If a renderer is provided, its reference count will be
 366  *                  incremented.
 367  */
 368 VLC_API int playlist_SetRenderer( playlist_t* p_pl, vlc_renderer_item_t* p_item );
 369
 370
 371 /********************************************************
 372  * Item management
 373  ********************************************************/
 374
 375 /******************** Item addition ********************/
 376 VLC_API int playlist_Add( playlist_t *, const char *, bool );
 377 VLC_API int playlist_AddExt( playlist_t *, const char *, const char *, bool, int, const char *const *, unsigned, bool );
 378 VLC_API int playlist_AddInput( playlist_t *, input_item_t *, bool, bool );
 379 VLC_API playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *, playlist_item_t *, int );
 380 VLC_API int playlist_NodeAddCopy( playlist_t *, playlist_item_t *, playlist_item_t *, int );
 381
 382 /********************************** Item search *************************/
 383 VLC_API playlist_item_t * playlist_ItemGetById(playlist_t *, int ) VLC_USED;
 384 VLC_API playlist_item_t *playlist_ItemGetByInput(playlist_t *,
 385                                                  const input_item_t * )
 386 VLC_USED;
 387
 388 VLC_API int playlist_LiveSearchUpdate(playlist_t *, playlist_item_t *, const char *, bool );
 389
 390 /********************************************************
 391  * Tree management
 392  ********************************************************/
 393 /* Node management */
 394 VLC_API playlist_item_t * playlist_NodeCreate( playlist_t *, const char *, playlist_item_t * p_parent, int i_pos, int i_flags );
 395 VLC_API playlist_item_t * playlist_ChildSearchName(playlist_item_t*, const char* ) VLC_USED;
 396 VLC_API void playlist_NodeDelete( playlist_t *, playlist_item_t * );
 397
 398 /**************************
 399  * Audio output management
 400  **************************/
 401
 402 VLC_API audio_output_t *playlist_GetAout( playlist_t * );
 403
 404 VLC_API float playlist_VolumeGet( playlist_t * );
 405 VLC_API int playlist_VolumeSet( playlist_t *, float );
 406 VLC_API int playlist_VolumeUp( playlist_t *, int, float * );
 407 #define playlist_VolumeDown(a, b, c) playlist_VolumeUp(a, -(b), c)
 408 VLC_API int playlist_MuteSet( playlist_t *, bool );
 409 VLC_API int playlist_MuteGet( playlist_t * );
 410
 411 static inline int playlist_MuteToggle( playlist_t *pl )
 412 {
 413     int val = playlist_MuteGet( pl );
 414     if (val >= 0)
 415         val = playlist_MuteSet( pl, !val );
 416     return val;
 417 }
 418
 419 VLC_API void playlist_EnableAudioFilter( playlist_t *, const char *, bool );
 420
 421 /***********************************************************************
 422  * Inline functions
 423  ***********************************************************************/
 424 /** Tell if the playlist is empty */
 425 static inline bool playlist_IsEmpty( playlist_t *p_playlist )
 426 {
 427     PL_ASSERT_LOCKED;
 428     return p_playlist->items.i_size == 0;
 429 }
 430
 431 /** Tell the number of items in the current playing context */
 432 static inline int playlist_CurrentSize( playlist_t *p_playlist )
 433 {
 434     PL_ASSERT_LOCKED;
 435     return p_playlist->current.i_size;
 436 }
 437
 438 /** @} */
 439 # ifdef __cplusplus
 440 }
 441 # endif
 442
 443 #endif