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