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

   1 /*****************************************************************************
   2  * vlc_playlist.h : Playlist functions
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 VideoLAN
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 /**
  25  *  \file
  26  *  This file contain structures and function prototypes related
  27  *  to the playlist in vlc
  28  */
  29
  30 /**
  31  * \defgroup vlc_playlist Playlist
  32  * Brief description. Longer description
  33  * @{
  34  */
  35
  36 /**
  37  * playlist export helper structure
  38  */
  39 struct playlist_export_t
  40 {
  41     char *psz_filename;
  42     FILE *p_file;
  43 };
  44
  45 struct item_parent_t
  46 {
  47     int i_view;
  48     playlist_item_t *p_parent;
  49 };
  50
  51 /**
  52  * playlist item / node
  53  * \see playlist_t
  54  */
  55 struct playlist_item_t
  56 {
  57     input_item_t           input;       /**< input item descriptor */
  58
  59     /* Tree specific fields */
  60     int                    i_children;  /**< Number of children
  61                                              -1 if not a node */
  62     playlist_item_t      **pp_children; /**< Children nodes/items */
  63     int                    i_parents;   /**< Number of parents */
  64     struct item_parent_t **pp_parents;  /**< Parents */
  65     int                    i_serial;    /**< Has this node been updated ? */
  66
  67     uint8_t                i_flags;     /**< Flags */
  68
  69
  70     int        i_nb_played;       /**< How many times was this item played ? */
  71
  72     /* LEGACY FIELDS */
  73     vlc_bool_t b_autodeletion;    /**< Indicates whther this item is to
  74                                    * be deleted after playback. True mean
  75                                    * that this item is to be deleted
  76                                    * after playback, false otherwise */
  77     vlc_bool_t b_enabled;         /**< Indicates whether this item is to be
  78                                    * played or skipped */
  79     /* END LEGACY FIELDS */
  80 };
  81
  82 #define PLAYLIST_SAVE_FLAG      0x01     /**< Must it be saved */
  83 #define PLAYLIST_SKIP_FLAG      0x02     /**< Must playlist skip after it ? */
  84 #define PLAYLIST_ENA_FLAG       0x04     /**< Is it enabled ? */
  85 #define PLAYLIST_DEL_FLAG       0x08     /**< Autodelete ? */
  86 #define PLAYLIST_RO_FLAG        0x10    /**< Write-enabled ? */
  87
  88 /**
  89  * playlist view
  90  * \see playlist_t
  91 */
  92 struct playlist_view_t
  93 {
  94     char            *   psz_name;        /**< View name */
  95     int                 i_id;            /**< Identifier for the view */
  96     playlist_item_t *   p_root;          /**< Root node */
  97 };
  98
  99
 100 /**
 101  * predefined views
 102  *
 103  */
 104 #define VIEW_CATEGORY 1
 105 #define VIEW_SIMPLE   2
 106 #define VIEW_ALL      3
 107 #define VIEW_FIRST_SORTED  4
 108 #define VIEW_S_AUTHOR 4
 109
 110 #define VIEW_LAST_SORTED  4
 111
 112 #define VIEW_FIRST_CUSTOM 100
 113
 114 /**
 115  * Playlist status
 116  */
 117 typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
 118
 119
 120 struct services_discovery_t
 121 {
 122     VLC_COMMON_MEMBERS
 123     const char *psz_module;
 124
 125     module_t *p_module;
 126
 127     services_discovery_sys_t *p_sys;
 128     void (*pf_run) ( services_discovery_t *);
 129 };
 130
 131 struct playlist_preparse_t
 132 {
 133     VLC_COMMON_MEMBERS
 134     vlc_mutex_t     lock;
 135     int             i_waiting;
 136     input_item_t  **pp_waiting;
 137 };
 138
 139
 140 /**
 141  * Structure containing information about the playlist
 142  */
 143 struct playlist_t
 144 {
 145     VLC_COMMON_MEMBERS
 146 /**
 147    \name playlist_t
 148    These members are uniq to playlist_t
 149 */
 150 /*@{*/
 151     int                   i_index;  /**< current index into the playlist */
 152     int                   i_enabled; /**< How many items are enabled ? */
 153
 154     int                   i_size;   /**< total size of the list */
 155     playlist_item_t **    pp_items; /**< array of pointers to the
 156                                      * playlist items */
 157
 158     int                   i_views; /**< Number of views */
 159     playlist_view_t **    pp_views; /**< array of pointers to the
 160                                      * playlist views */
 161
 162     input_thread_t *      p_input;  /**< the input thread ascosiated
 163                                      * with the current item */
 164
 165     mtime_t               request_date; /**< Used for profiling */
 166
 167     int                   i_last_id; /**< Last id to an item */
 168     int                   i_sort; /**< Last sorting applied to the playlist */
 169     int                   i_order; /**< Last ordering applied to the playlist */
 170
 171     playlist_item_t *    p_general; /**< Keep a pointer on the "general"
 172                                         category */
 173
 174     services_discovery_t **pp_sds;
 175     int                   i_sds;
 176
 177     vlc_bool_t          b_go_next; /*< Go further than the parent node ? */
 178
 179     struct {
 180         /* Current status */
 181         playlist_status_t   i_status;  /**< Current status of playlist */
 182
 183         /* R/O fields, don't touch if you aren't the playlist thread */
 184         /* Use a request */
 185         playlist_item_t *   p_item; /**< Currently playing/active item */
 186         playlist_item_t *   p_node;   /**< Current node to play from */
 187         int                 i_view;    /**< Current view */
 188     } status;
 189
 190     struct {
 191         /* Request */
 192         /* Playlist thread uses this info to calculate the next position */
 193         int                 i_view;   /**< requested view id */
 194         playlist_item_t *   p_node;   /**< requested node to play from */
 195         playlist_item_t *   p_item;   /**< requested item to play in the node */
 196
 197         int                 i_skip;   /**< Number of items to skip */
 198         int                 i_goto;   /**< Direct index to go to (non-view)*/
 199
 200         vlc_bool_t          b_request; /**< Set to true by the requester
 201                                             The playlist sets it back to false
 202                                             when processing the request */
 203         vlc_mutex_t         lock;      /**< Lock to protect request */
 204     } request;
 205
 206     playlist_preparse_t     *p_preparse;
 207
 208     /*@}*/
 209 };
 210
 211 /* Helper to add an item */
 212 struct playlist_add_t
 213 {
 214     playlist_item_t *p_node;
 215     playlist_item_t *p_item;
 216     int i_view;
 217     int i_position;
 218 };
 219
 220 #define SORT_ID 0
 221 #define SORT_TITLE 1
 222 #define SORT_TITLE_NODES_FIRST 2
 223 #define SORT_AUTHOR 3
 224 #define SORT_RANDOM 4
 225 #define SORT_DURATION 5
 226
 227 #define ORDER_NORMAL 0
 228 #define ORDER_REVERSE 1
 229
 230 /*****************************************************************************
 231  * Prototypes
 232  *****************************************************************************/
 233
 234 /* Creation/Deletion */
 235 #define playlist_Create(a) __playlist_Create(VLC_OBJECT(a))
 236 playlist_t * __playlist_Create   ( vlc_object_t * );
 237 int            playlist_Destroy  ( playlist_t * );
 238
 239 /* Playlist control */
 240 #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY )
 241 #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE )
 242 #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP )
 243 #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP , 1)
 244 #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP , -1)
 245 #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP,i)
 246 #define playlist_Goto(p,i) playlist_Control(p,PLAYLIST_GOTO,i)
 247
 248 VLC_EXPORT( int, playlist_Control, ( playlist_t *, int, ...  ) );
 249
 250 VLC_EXPORT( int,  playlist_Clear, ( playlist_t * ) );
 251 VLC_EXPORT( int,  playlist_LockClear, ( playlist_t * ) );
 252
 253 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
 254
 255 /* Services discovery */
 256
 257 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
 258 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
 259 VLC_EXPORT( int, playlist_AddSDModules, (playlist_t *, char *));
 260 VLC_EXPORT( vlc_bool_t, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
 261
 262
 263 /* Item management functions (act on items) */
 264 #define playlist_AddItem(p,pi,i1,i2) playlist_ItemAdd(p,pi,i1,i2)
 265 #define playlist_ItemNew( a , b, c ) __playlist_ItemNew(VLC_OBJECT(a) , b , c )
 266 VLC_EXPORT( playlist_item_t* , __playlist_ItemNew, ( vlc_object_t *,const char *,const char * ) );
 267 VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int ) );
 268 VLC_EXPORT( int, playlist_ItemDelete, ( playlist_item_t * ) );
 269 VLC_EXPORT( int, playlist_ItemAddParent, ( playlist_item_t *, int,playlist_item_t *) );
 270 VLC_EXPORT( int, playlist_CopyParents, ( playlist_item_t *,playlist_item_t *) );
 271 /* Item informations accessors */
 272 VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *,  char * ) );
 273 VLC_EXPORT( int, playlist_ItemSetDuration, (playlist_item_t *, mtime_t ) );
 274
 275
 276 /* View management functions */
 277 VLC_EXPORT( int, playlist_ViewInsert, (playlist_t *, int, char * ) );
 278 VLC_EXPORT( int, playlist_ViewDelete, (playlist_t *,playlist_view_t* ) );
 279 VLC_EXPORT( playlist_view_t *, playlist_ViewFind, (playlist_t *, int ) );
 280 VLC_EXPORT( int, playlist_ViewUpdate, (playlist_t *, int ) );
 281 VLC_EXPORT( int, playlist_ViewDump, (playlist_t *, playlist_view_t * ) );
 282 VLC_EXPORT( int, playlist_ViewEmpty, (playlist_t *, int, vlc_bool_t ) );
 283
 284 /* Node management */
 285 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *,int,char *, playlist_item_t * p_parent ) );
 286 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,int,playlist_item_t*,playlist_item_t *) );
 287 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,int,playlist_item_t*,playlist_item_t *, int) );
 288 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
 289 VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
 290 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
 291 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, vlc_bool_t , vlc_bool_t ) );
 292 VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, vlc_bool_t ) );
 293
 294 /* Tree walking */
 295 playlist_item_t *playlist_FindNextFromParent( playlist_t *p_playlist,
 296                 int i_view,
 297                 playlist_item_t *p_root,
 298                 playlist_item_t *p_node,
 299                 playlist_item_t *p_item );
 300 playlist_item_t *playlist_FindPrevFromParent( playlist_t *p_playlist,
 301                 int i_view,
 302                 playlist_item_t *p_root,
 303                 playlist_item_t *p_node,
 304                 playlist_item_t *p_item );
 305
 306
 307 /* Simple add/remove functions */
 308 /* These functions add the item to the "simple" view (+all & category )*/
 309 VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int ) );
 310 VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int ) );
 311 VLC_EXPORT( int,  playlist_ItemAdd, ( playlist_t *, playlist_item_t *, int, int ) );
 312 VLC_EXPORT(int, playlist_NodeAddItem, ( playlist_t *, playlist_item_t *,int,playlist_item_t *,int , int ) );
 313
 314 /* Misc item operations (act on item+playlist) */
 315 VLC_EXPORT( int,  playlist_Delete, ( playlist_t *, int ) );
 316 VLC_EXPORT( int,  playlist_LockDelete, ( playlist_t *, int ) );
 317 VLC_EXPORT( int,  playlist_Disable, ( playlist_t *, playlist_item_t * ) );
 318 VLC_EXPORT( int,  playlist_Enable, ( playlist_t *, playlist_item_t * ) );
 319 VLC_EXPORT( int, playlist_ItemToNode, (playlist_t *,playlist_item_t *) );
 320 VLC_EXPORT( int, playlist_LockItemToNode, (playlist_t *,playlist_item_t *) );
 321 VLC_EXPORT( int, playlist_Replace, (playlist_t *,playlist_item_t *, input_item_t*) );
 322 VLC_EXPORT( int, playlist_LockReplace, (playlist_t *,playlist_item_t *, input_item_t*) );
 323
 324
 325 /* Item search functions */
 326 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
 327 VLC_EXPORT( playlist_item_t *, playlist_LockItemGetById, (playlist_t *, int) );
 328 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByPos, (playlist_t *, int) );
 329 VLC_EXPORT( playlist_item_t *, playlist_LockItemGetByPos, (playlist_t *, int) );
 330 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) );
 331 VLC_EXPORT( playlist_item_t *, playlist_LockItemGetByInput, (playlist_t *,input_item_t * ) );
 332 VLC_EXPORT( int, playlist_GetPositionById, (playlist_t *,int ) );
 333
 334 VLC_EXPORT( int, playlist_ItemAddOption, (playlist_item_t *, const char *) );
 335
 336 /* Playlist sorting */
 337 #define playlist_SortID(p, i) playlist_Sort( p, SORT_ID, i)
 338 #define playlist_SortTitle(p, i) playlist_Sort( p, SORT_TITLE, i)
 339 #define playlist_SortAuthor(p, i) playlist_Sort( p, SORT_AUTHOR, i)
 340 #define playlist_SortGroup(p, i) playlist_Sort( p, SORT_GROUP, i)
 341 VLC_EXPORT( int,  playlist_Sort, ( playlist_t *, int, int) );
 342 VLC_EXPORT( int,  playlist_Move, ( playlist_t *, int, int ) );
 343 VLC_EXPORT( int,  playlist_NodeGroup, ( playlist_t *, int,playlist_item_t *,playlist_item_t **,int, int, int ) );
 344 VLC_EXPORT( int,  playlist_NodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
 345 VLC_EXPORT( int,  playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
 346
 347 /* Load/Save */
 348 VLC_EXPORT( int,  playlist_Import, ( playlist_t *, const char * ) );
 349 VLC_EXPORT( int,  playlist_Export, ( playlist_t *, const char *, const char * ) );
 350
 351 /***********************************************************************
 352  * Inline functions
 353  ***********************************************************************/
 354
 355
 356 /**
 357  *  tell if a playlist is currently playing.
 358  *  \param p_playlist the playlist to check
 359  *  \return true if playlist is playing, false otherwise
 360  */
 361 static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
 362 {
 363     vlc_bool_t b_playing;
 364
 365     vlc_mutex_lock( &p_playlist->object_lock );
 366     b_playing = p_playlist->status.i_status == PLAYLIST_RUNNING;
 367     vlc_mutex_unlock( &p_playlist->object_lock );
 368
 369     return( b_playing );
 370 }
 371
 372 /**
 373  *  tell if a playlist is currently empty
 374  *  \param p_playlist the playlist to check
 375  *  \return true if the playlist is empty, false otherwise
 376  */
 377 static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
 378 {
 379     vlc_bool_t b_empty;
 380
 381     vlc_mutex_lock( &p_playlist->object_lock );
 382     b_empty = p_playlist->i_size == 0;
 383     vlc_mutex_unlock( &p_playlist->object_lock );
 384
 385     return( b_empty );
 386 }
 387
 388
 389
 390 /**
 391  * @}
 392  */