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