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