include/vlc_playlist_legacy.h

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