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