git.sesse.net Git - vlc/blob - include/vlc_playlist.h

   1 /*****************************************************************************
   2  * vlc_playlist.h : Playlist functions
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 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 General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #if !defined( __LIBVLC__ )
  25   #error You are not libvlc or one of its plugins. You cannot include this file
  26 #endif
  27
  28 #ifndef _VLC_PLAYLIST_H_
  29 #define _VLC_PLAYLIST_H_
  30
  31 # ifdef __cplusplus
  32 extern "C" {
  33 # endif
  34
  35 #include <vlc_input.h>
  36 #include <vlc_events.h>
  37 #include <vlc_services_discovery.h>
  38 #include <stdio.h>
  39 #include <stdlib.h>
  40
  41 TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t);
  42
  43 /**
  44  * \file
  45  * This file contain structures and function prototypes related
  46  * to the playlist in vlc
  47  *
  48  * \defgroup vlc_playlist Playlist
  49  *
  50  * The VLC playlist system has a tree structure. This allows advanced
  51  * categorization, like for SAP streams (which are grouped by "sap groups").
  52  *
  53  * The base structure for all playlist operations is the input_item_t. This
  54  * contains all information needed to play a stream and get info, ie, mostly,
  55  * mrl and metadata. This structure contains a unique i_id field. ids are
  56  * not recycled when an item is destroyed.
  57  *
  58  * Input items are not used directly, but through playlist items.
  59  * The playlist items are themselves in a tree structure. They only contain
  60  * a link to the input item, a unique id and a few flags. the playlist
  61  * item id is NOT the same as the input item id.
  62  * Several playlist items can be attached to a single input item. The input
  63  * item is refcounted and is automatically destroyed when it is not used
  64  * anymore.
  65  *
  66  * In the playlist itself, there are two trees, that should always be kept
  67  * in sync. The "category" tree contains the whole tree structure with
  68  * several levels, while the onelevel tree contains only one level :), ie
  69  * it only contains "real" items, not nodes
  70  * For example, if you open a directory, you will have
  71  *\verbatim
  72  * Category tree:               Onelevel tree:
  73  * Playlist                     Playlist
  74  *  - Dir                         - item1
  75  *    - Subdir                    - item2
  76  *      - item1
  77  *      - item2
  78  *\endverbatim
  79  * The top-level items of both tree are the same, and they are reproduced
  80  * in the left-part of the playlist GUIs, they are the "sources" from the
  81  * source selectors. Top-level items include: playlist, media library, SAP,
  82  * Shoutcast, devices, ...
  83  *
  84  * It is envisioned that a third tree will appear: VLM, but it's not done yet
  85  *
  86  * The playlist also stores, for utility purposes, an array of all input
  87  * items, an array of all playlist items and an array of all playlist items
  88  * and nodes (both are represented by the same structure).
  89  *
  90  * So, here is an example:
  91  * \verbatim
  92  * Inputs array
  93  *  - input 1 -> name = foo 1 uri = ...
  94  *  - input 2 -> name = foo 2 uri = ...
  95  *
  96  * Category tree                        Onelevel tree
  97  * - playlist (id 1)                    - playlist (id 3)
  98  *    - category 1 (id 2)                - foo 2 (id 8 - input 2)
  99  *      - foo 2 (id 6 - input 2)       - media library (id 4)
 100  * - media library (id 2)                - foo 1 (id6 - input 1)
 101  *    - foo 1 (id 5 - input 1)
 102  * \endverbatim
 103  * Sometimes, an item must be transformed to a node. This happens for the
 104  * directory access for example. In that case, the item is removed from
 105  * the onelevel tree, as it is not a real item anymore.
 106  *
 107  * For "standard" item addition, you can use playlist_Add, playlist_AddExt
 108  * (more options) or playlist_AddInput if you already created your input
 109  * item. This will add the item at the root of "Playlist" or of "Media library"
 110  * in each of the two trees.
 111  *
 112  * If you want more control (like, adding the item as the child of a given
 113  * node in the category tree, use playlist_BothAddInput. You'll have to provide
 114  * the node in the category tree. The item will be added as a child of
 115  * this node in the category tree, and as a child of the matching top-level
 116  * node in the onelevel tree. (Nodes are created with playlist_NodeCreate)
 117  *
 118  * Generally speaking, playlist_NodeAddInput should not be used in newer code, it
 119  * will maybe become useful again when we merge VLM;
 120  *
 121  * To delete an item, use playlist_DeleteFromInput( input_id ) which will
 122  * remove all occurrences of the input in both trees
 123  *
 124  * @{
 125  */
 126
 127 /** Helper structure to export to file part of the playlist */
 128 struct playlist_export_t
 129 {
 130     char *psz_filename;
 131     FILE *p_file;
 132     playlist_item_t *p_root;
 133 };
 134
 135 /** playlist item / node */
 136 struct playlist_item_t
 137 {
 138     input_item_t           *p_input;    /**< Linked input item */
 139     /** Number of children, -1 if not a node */
 140     int                    i_children;
 141     playlist_item_t      **pp_children; /**< Children nodes/items */
 142     playlist_item_t       *p_parent;    /**< Item parent */
 143
 144     int                    i_id;        /**< Playlist item specific id */
 145     uint8_t                i_flags;     /**< Flags */
 146     playlist_t            *p_playlist;  /**< Parent playlist */
 147 };
 148
 149 #define PLAYLIST_SAVE_FLAG      0x0001    /**< Must it be saved */
 150 #define PLAYLIST_SKIP_FLAG      0x0002    /**< Must playlist skip after it ? */
 151 #define PLAYLIST_DBL_FLAG       0x0004    /**< Is it disabled ? */
 152 #define PLAYLIST_RO_FLAG        0x0008    /**< Write-enabled ? */
 153 #define PLAYLIST_REMOVE_FLAG    0x0010    /**< Remove this item at the end */
 154 #define PLAYLIST_EXPANDED_FLAG  0x0020    /**< Expanded node */
 155
 156 /** Playlist status */
 157 typedef enum
 158 { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
 159
 160 /** Structure containing information about the playlist */
 161 struct playlist_t
 162 {
 163     VLC_COMMON_MEMBERS
 164
 165     struct playlist_services_discovery_support_t {
 166         /* the playlist items for category and onelevel */
 167         playlist_item_t*    p_cat;
 168         playlist_item_t*    p_one;
 169         services_discovery_t * p_sd; /**< Loaded service discovery modules */
 170     } ** pp_sds;
 171     int                   i_sds;   /**< Number of service discovery modules */
 172
 173     playlist_item_array_t items; /**< Arrays of items */
 174     playlist_item_array_t all_items; /**< Array of items and nodes */
 175
 176     playlist_item_array_t current; /**< Items currently being played */
 177     int                   i_current_index; /**< Index in current array */
 178     /** Reset current item array */
 179     bool            b_reset_currently_playing;
 180     mtime_t               last_rebuild_date;
 181
 182     int                   i_last_playlist_id; /**< Last id to an item */
 183
 184     /* Predefined items */
 185     playlist_item_t *     p_root_category; /**< Root of category tree */
 186     playlist_item_t *     p_root_onelevel; /**< Root of onelevel tree */
 187     playlist_item_t *     p_local_category; /** < "Playlist" in CATEGORY view */
 188     playlist_item_t *     p_ml_category; /** < "Library" in CATEGORY view */
 189     playlist_item_t *     p_local_onelevel; /** < "Playlist" in ONELEVEL view */
 190     playlist_item_t *     p_ml_onelevel; /** < "Library" in ONELEVEL view */
 191
 192     bool                  b_tree; /**< Display as a tree */
 193
 194     bool            b_doing_ml; /**< Doing media library stuff,
 195                                        * get quicker */
 196     bool            b_auto_preparse;
 197
 198     /* Runtime */
 199     input_thread_t *      p_input;  /**< the input thread associated
 200                                      * with the current item */
 201     int                   i_sort; /**< Last sorting applied to the playlist */
 202     int                   i_order; /**< Last ordering applied to the playlist */
 203     mtime_t               gc_date;
 204     bool            b_cant_sleep;
 205     playlist_preparse_t  *p_preparse; /**< Preparser object */
 206     playlist_fetcher_t   *p_fetcher;/**< Meta and art fetcher object */
 207
 208     vlc_mutex_t gc_lock;         /**< Lock to protect the garbage collection */
 209
 210     struct {
 211         /* Current status. These fields are readonly, only the playlist
 212          * main loop can touch it*/
 213         playlist_status_t   i_status;  /**< Current status of playlist */
 214         playlist_item_t *   p_item; /**< Currently playing/active item */
 215         playlist_item_t *   p_node; /**< Current node to play from */
 216     } status;
 217
 218     struct {
 219         /* Request. Use this to give orders to the playlist main loop  */
 220         int                 i_status; /**< requested playlist status */
 221         playlist_item_t *   p_node;   /**< requested node to play from */
 222         playlist_item_t *   p_item;   /**< requested item to play in the node */
 223
 224         int                 i_skip;   /**< Number of items to skip */
 225
 226         bool          b_request;/**< Set to true by the requester
 227                                            The playlist sets it back to false
 228                                            when processing the request */
 229         vlc_mutex_t         lock;     /**< Lock to protect request */
 230     } request;
 231 };
 232
 233 /** Helper to add an item */
 234 struct playlist_add_t
 235 {
 236     int i_node;
 237     int i_item;
 238     int i_position;
 239 };
 240
 241 #define SORT_ID 0
 242 #define SORT_TITLE 1
 243 #define SORT_TITLE_NODES_FIRST 2
 244 #define SORT_ARTIST 3
 245 #define SORT_GENRE 4
 246 #define SORT_RANDOM 5
 247 #define SORT_DURATION 6
 248 #define SORT_TITLE_NUMERIC 7
 249 #define SORT_ALBUM 8
 250 #define SORT_TRACK_NUMBER 9
 251 #define SORT_DESCRIPTION 10
 252 #define SORT_RATING 11
 253
 254 #define ORDER_NORMAL 0
 255 #define ORDER_REVERSE 1
 256
 257 /*****************************************************************************
 258  * Prototypes
 259  *****************************************************************************/
 260
 261 /* Helpers */
 262 #define PL_LOCK vlc_object_lock( p_playlist )
 263 #define PL_UNLOCK vlc_object_unlock( p_playlist )
 264
 265 VLC_EXPORT( playlist_t *, __pl_Yield, ( vlc_object_t * ) );
 266 #define pl_Yield( a ) __pl_Yield( VLC_OBJECT(a) )
 267
 268 VLC_EXPORT( void, __pl_Release, ( vlc_object_t * ) );
 269 #define pl_Release(a) __pl_Release( VLC_OBJECT(a) )
 270
 271 /* Playlist control */
 272 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, false )
 273 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, false )
 274 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, false )
 275 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, false, 1)
 276 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, false, -1)
 277 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, false,  i)
 278
 279 /**
 280  * Do a playlist action.
 281  * If there is something in the playlist then you can do playlist actions.
 282  * Possible queries are listed in vlc_common.h
 283  * \param p_playlist the playlist to do the command on
 284  * \param i_query the command to do
 285  * \param b_locked TRUE if playlist is locked when entering this function
 286  * \param variable number of arguments
 287  * \return VLC_SUCCESS or an error
 288  */
 289 VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, bool b_locked, ...  ) );
 290
 291 /** Clear the playlist
 292  * \param b_locked TRUE if playlist is locked when entering this function
 293  */
 294 VLC_EXPORT( void,  playlist_Clear, ( playlist_t *, bool ) );
 295
 296 /** Enqueue an input item for preparsing */
 297 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
 298
 299 /** Enqueue a playlist item and all of its children if any for preparsing */
 300 VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) );
 301 /** Request the art for an input item to be fetched */
 302 VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *) );
 303
 304 /********************** Services discovery ***********************/
 305
 306 /** Add a list of comma-separated service discovery modules */
 307 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
 308 /** Remove a services discovery module by name */
 309 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
 310 /** Check whether a given SD is loaded */
 311 VLC_EXPORT( bool, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
 312
 313 /* Playlist sorting */
 314 VLC_EXPORT( int,  playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
 315 VLC_EXPORT( int,  playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
 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_EXPORT( int,  playlist_Export, ( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type ) );
 326
 327 /********************************************************
 328  * Item management
 329  ********************************************************/
 330
 331 /*************************** Item creation **************************/
 332
 333 VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int , const char *const *, int, int) );
 334
 335 /** Create a new item, without adding it to the playlist
 336  * \param p_obj a vlc object (anyone will do)
 337  * \param psz_uri the mrl of the item
 338  * \param psz_name a text giving a name or description of the item
 339  * \return the new item or NULL on failure
 340  */
 341 #define playlist_ItemNew( a , b, c ) \
 342     playlist_ItemNewWithType( VLC_OBJECT(a) , b , c, 0, NULL, -1, 0 )
 343
 344 #define playlist_ItemNewFromInput(a,b) __playlist_ItemNewFromInput(VLC_OBJECT(a),b)
 345 VLC_EXPORT( playlist_item_t *, __playlist_ItemNewFromInput, ( vlc_object_t *p_obj,input_item_t *p_input ) );
 346
 347 /*************************** Item deletion **************************/
 348 VLC_EXPORT( int,  playlist_DeleteFromInput, ( playlist_t *, int, bool ) );
 349 VLC_EXPORT( int,  playlist_DeleteInputInParent, ( playlist_t *, int, playlist_item_t *, bool ) );
 350
 351 /*************************** Item fields accessors **************************/
 352 VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, const char * ) );
 353
 354 /******************** Item addition ********************/
 355 VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int, bool, bool ) );
 356 VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char *const *,int, bool, bool ) );
 357 VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, bool, bool ) );
 358 VLC_EXPORT( playlist_item_t *, playlist_NodeAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, bool ) );
 359 VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int*, bool ) );
 360
 361 /********************** Misc item operations **********************/
 362 VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *, bool) );
 363
 364 /********************************** Item search *************************/
 365 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int, bool ) );
 366 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t *, bool ) );
 367 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInputId, (playlist_t *, int, playlist_item_t *) );
 368
 369 VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) );
 370
 371 /********************************************************
 372  * Tree management
 373  ********************************************************/
 374 VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
 375
 376 /* Node management */
 377 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_flags, input_item_t * ) );
 378 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) );
 379 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) );
 380 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
 381 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
 382 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, bool , bool ) );
 383 VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, bool ) );
 384 VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, const char *, playlist_item_t **, playlist_item_t **, bool ) );
 385 VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) );
 386 VLC_EXPORT( 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 ) );
 387 VLC_EXPORT( 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 ) );
 388 VLC_EXPORT( playlist_item_t *, playlist_GetLastLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root ) );
 389
 390 /***********************************************************************
 391  * Inline functions
 392  ***********************************************************************/
 393 /** Open a playlist file, add its content to the current playlist */
 394 static inline int playlist_Import( playlist_t *p_playlist, const char *psz_file)
 395 {
 396     char psz_uri[256+10];
 397     input_item_t *p_input;
 398     snprintf( psz_uri, 256+9, "file/://%s", psz_file );
 399     const char *const psz_option = "meta-file";
 400     p_input = input_ItemNewExt( p_playlist, psz_uri, psz_file,
 401                                 1, &psz_option, -1 );
 402     playlist_AddInput( p_playlist, p_input, PLAYLIST_APPEND, PLAYLIST_END,
 403                        true, false );
 404     input_Read( p_playlist, p_input, true );
 405     return VLC_SUCCESS;
 406 }
 407
 408 /** Tell if the playlist is currently running */
 409 #define playlist_IsPlaying( pl ) ( pl->status.i_status == PLAYLIST_RUNNING )
 410
 411 /** Tell if the playlist is empty */
 412 #define playlist_IsEmpty( pl ) ( pl->items.i_size == 0 )
 413
 414 /** Tell the number of items in the current playing context */
 415 #define playlist_CurrentSize( pl ) pl->current.i_size
 416
 417 /** Ask the playlist to do some work */
 418 #define playlist_Signal( p_playlist ) vlc_object_signal( p_playlist )
 419
 420 /** @} */
 421 # ifdef __cplusplus
 422 }
 423 # endif
 424
 425 #endif