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