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., 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 #define PLAYLIST_REMOVE_FLAG    0x20    /**< Remove this item at the end */
  88
  89 /**
  90  * playlist view
  91  * \see playlist_t
  92 */
  93 struct playlist_view_t
  94 {
  95     char            *   psz_name;        /**< View name */
  96     int                 i_id;            /**< Identifier for the view */
  97     playlist_item_t *   p_root;          /**< Root node */
  98 };
  99
 100
 101 /**
 102  * predefined views
 103  *
 104  */
 105 #define VIEW_CATEGORY 1
 106 #define VIEW_SIMPLE   2
 107 #define VIEW_ALL      3
 108 #define VIEW_FIRST_SORTED  4
 109 #define VIEW_S_AUTHOR 4
 110 #define VIEW_S_GENRE 5
 111 #define VIEW_S_ALBUM  6
 112
 113 #define VIEW_LAST_SORTED  10
 114
 115 #define VIEW_FIRST_CUSTOM 100
 116
 117 /**
 118  * Playlist status
 119  */
 120 typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
 121
 122
 123 struct services_discovery_t
 124 {
 125     VLC_COMMON_MEMBERS
 126     char *psz_module;
 127
 128     module_t *p_module;
 129
 130     services_discovery_sys_t *p_sys;
 131     void (*pf_run) ( services_discovery_t *);
 132 };
 133
 134 struct playlist_preparse_t
 135 {
 136     VLC_COMMON_MEMBERS
 137     vlc_mutex_t     lock;
 138     int             i_waiting;
 139     input_item_t  **pp_waiting;
 140 };
 141
 142
 143 /**
 144  * Structure containing information about the playlist
 145  */
 146 struct playlist_t
 147 {
 148     VLC_COMMON_MEMBERS
 149 /**
 150    \name playlist_t
 151    These members are uniq to playlist_t
 152 */
 153 /*@{*/
 154     int                   i_index;  /**< current index into the playlist */
 155     int                   i_enabled; /**< How many items are enabled ? */
 156
 157     int                   i_size;   /**< total size of the list */
 158     playlist_item_t **    pp_items; /**< array of pointers to the
 159                                      * playlist items */
 160     int                   i_all_size; /**< size of list of items and nodes */
 161     playlist_item_t **    pp_all_items; /**< array of pointers to the
 162                                          * playlist items and nodes */
 163
 164     int                   i_views; /**< Number of views */
 165     playlist_view_t **    pp_views; /**< array of pointers to the
 166                                      * playlist views */
 167
 168     input_thread_t *      p_input;  /**< the input thread ascosiated
 169                                      * with the current item */
 170
 171     mtime_t               request_date; /**< Used for profiling */
 172
 173     int                   i_last_id; /**< Last id to an item */
 174     int                   i_sort; /**< Last sorting applied to the playlist */
 175     int                   i_order; /**< Last ordering applied to the playlist */
 176
 177     playlist_item_t *    p_general; /**< Keep a pointer on the "general"
 178                                         category */
 179
 180     services_discovery_t **pp_sds;
 181     int                   i_sds;
 182
 183     vlc_bool_t          b_go_next; /*< Go further than the parent node ? */
 184
 185     struct {
 186         /* Current status */
 187         playlist_status_t   i_status;  /**< Current status of playlist */
 188
 189         /* R/O fields, don't touch if you aren't the playlist thread */
 190         /* Use a request */
 191         playlist_item_t *   p_item; /**< Currently playing/active item */
 192         playlist_item_t *   p_node;   /**< Current node to play from */
 193         int                 i_view;    /**< Current view */
 194     } status;
 195
 196     struct {
 197         /* Request */
 198         /* Playlist thread uses this info to calculate the next position */
 199         int                 i_view;   /**< requested view id */
 200         playlist_item_t *   p_node;   /**< requested node to play from */
 201         playlist_item_t *   p_item;   /**< requested item to play in the node */
 202
 203         int                 i_skip;   /**< Number of items to skip */
 204         int                 i_goto;   /**< Direct index to go to (non-view)*/
 205
 206         vlc_bool_t          b_request; /**< Set to true by the requester
 207                                             The playlist sets it back to false
 208                                             when processing the request */
 209         vlc_mutex_t         lock;      /**< Lock to protect request */
 210     } request;
 211
 212     playlist_preparse_t     *p_preparse;
 213
 214     vlc_mutex_t gc_lock;         /**< Lock to protect the garbage collection */
 215
 216     // The following members are about user interaction
 217     // The playlist manages the user interaction to avoid creating another
 218     // thread
 219     interaction_t *p_interaction;
 220
 221     /*@}*/
 222 };
 223
 224 /* Helper to add an item */
 225 struct playlist_add_t
 226 {
 227     int i_node;
 228     int i_item;
 229     int i_view;
 230     int i_position;
 231 };
 232
 233 #define SORT_ID 0
 234 #define SORT_TITLE 1
 235 #define SORT_TITLE_NODES_FIRST 2
 236 #define SORT_AUTHOR 3
 237 #define SORT_GENRE 4
 238 #define SORT_RANDOM 5
 239 #define SORT_DURATION 6
 240 #define SORT_TITLE_NUMERIC 7
 241 #define SORT_ALBUM 8
 242
 243 #define ORDER_NORMAL 0
 244 #define ORDER_REVERSE 1
 245
 246 /*****************************************************************************
 247  * Prototypes
 248  *****************************************************************************/
 249
 250 /* Creation/Deletion */
 251 #define playlist_Create(a) __playlist_Create(VLC_OBJECT(a))
 252 playlist_t * __playlist_Create   ( vlc_object_t * );
 253 int            playlist_Destroy  ( playlist_t * );
 254
 255 /* Playlist control */
 256 #define playlist_Play(p) playlist_LockControl(p,PLAYLIST_PLAY )
 257 #define playlist_Pause(p) playlist_LockControl(p,PLAYLIST_PAUSE )
 258 #define playlist_Stop(p) playlist_LockControl(p,PLAYLIST_STOP )
 259 #define playlist_Next(p) playlist_LockControl(p,PLAYLIST_SKIP, 1)
 260 #define playlist_Prev(p) playlist_LockControl(p,PLAYLIST_SKIP, -1)
 261 #define playlist_Skip(p,i) playlist_LockControl(p,PLAYLIST_SKIP, i)
 262 #define playlist_Goto(p,i) playlist_LockControl(p,PLAYLIST_GOTO, i)
 263
 264 VLC_EXPORT( int, playlist_Control, ( playlist_t *, int, ...  ) );
 265 VLC_EXPORT( int, playlist_LockControl, ( playlist_t *, int, ...  ) );
 266
 267 VLC_EXPORT( int,  playlist_Clear, ( playlist_t * ) );
 268 VLC_EXPORT( int,  playlist_LockClear, ( playlist_t * ) );
 269
 270 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
 271 VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) );
 272
 273 /* Services discovery */
 274
 275 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
 276 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
 277 VLC_EXPORT( int, playlist_AddSDModules, (playlist_t *, char *));
 278 VLC_EXPORT( vlc_bool_t, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
 279
 280
 281 /* Item management functions (act on items) */
 282 #define playlist_AddItem(p,pi,i1,i2) playlist_ItemAdd(p,pi,i1,i2)
 283 #define playlist_ItemNew( a , b, c ) __playlist_ItemNew(VLC_OBJECT(a) , b , c )
 284 #define playlist_ItemCopy( a, b ) __playlist_ItemCopy(VLC_OBJECT(a), b )
 285 VLC_EXPORT( playlist_item_t* , __playlist_ItemNew, ( vlc_object_t *,const char *,const char * ) );
 286 VLC_EXPORT( playlist_item_t* , __playlist_ItemCopy, ( vlc_object_t *,playlist_item_t* ) );
 287 VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int ) );
 288 VLC_EXPORT( int, playlist_ItemDelete, ( playlist_item_t * ) );
 289 VLC_EXPORT( int, playlist_ItemAddParent, ( playlist_item_t *, int,playlist_item_t *) );
 290 VLC_EXPORT( int, playlist_CopyParents, ( playlist_item_t *,playlist_item_t *) );
 291 /* Item informations accessors */
 292 VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *,  char * ) );
 293 VLC_EXPORT( int, playlist_ItemSetDuration, (playlist_item_t *, mtime_t ) );
 294
 295
 296 /* View management functions */
 297 VLC_EXPORT( int, playlist_ViewInsert, (playlist_t *, int, char * ) );
 298 VLC_EXPORT( int, playlist_ViewDelete, (playlist_t *,playlist_view_t* ) );
 299 VLC_EXPORT( playlist_view_t *, playlist_ViewFind, (playlist_t *, int ) );
 300 VLC_EXPORT( int, playlist_ViewUpdate, (playlist_t *, int ) );
 301 VLC_EXPORT( int, playlist_ViewDump, (playlist_t *, playlist_view_t * ) );
 302 VLC_EXPORT( int, playlist_ViewEmpty, (playlist_t *, int, vlc_bool_t ) );
 303
 304 /* Node management */
 305 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *,int,char *, playlist_item_t * p_parent ) );
 306 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,int,playlist_item_t*,playlist_item_t *) );
 307 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,int,playlist_item_t*,playlist_item_t *, int) );
 308 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
 309 VLC_EXPORT( int, playlist_NodeRemoveParent, (playlist_t *,playlist_item_t*,playlist_item_t *) );
 310 VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
 311 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
 312 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, vlc_bool_t , vlc_bool_t ) );
 313 VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, vlc_bool_t ) );
 314
 315 /* Tree walking */
 316 playlist_item_t *playlist_FindNextFromParent( playlist_t *p_playlist,
 317                 int i_view,
 318                 playlist_item_t *p_root,
 319                 playlist_item_t *p_node,
 320                 playlist_item_t *p_item );
 321 playlist_item_t *playlist_FindPrevFromParent( playlist_t *p_playlist,
 322                 int i_view,
 323                 playlist_item_t *p_root,
 324                 playlist_item_t *p_node,
 325                 playlist_item_t *p_item );
 326
 327
 328 /* Simple add/remove functions */
 329 /* These functions add the item to the "simple" view (+all & category )*/
 330 VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int ) );
 331 VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int ) );
 332 VLC_EXPORT( int,  playlist_ItemAdd, ( playlist_t *, playlist_item_t *, int, int ) );
 333 VLC_EXPORT(int, playlist_NodeAddItem, ( playlist_t *, playlist_item_t *,int,playlist_item_t *,int , int ) );
 334
 335 /* Misc item operations (act on item+playlist) */
 336 VLC_EXPORT( int,  playlist_Delete, ( playlist_t *, int ) );
 337 VLC_EXPORT( int,  playlist_LockDelete, ( playlist_t *, int ) );
 338 VLC_EXPORT( int,  playlist_Disable, ( playlist_t *, playlist_item_t * ) );
 339 VLC_EXPORT( int,  playlist_Enable, ( playlist_t *, playlist_item_t * ) );
 340 VLC_EXPORT( int, playlist_ItemToNode, (playlist_t *,playlist_item_t *) );
 341 VLC_EXPORT( int, playlist_LockItemToNode, (playlist_t *,playlist_item_t *) );
 342 VLC_EXPORT( int, playlist_Replace, (playlist_t *,playlist_item_t *, input_item_t*) );
 343 VLC_EXPORT( int, playlist_LockReplace, (playlist_t *,playlist_item_t *, input_item_t*) );
 344
 345
 346 /* Item search functions */
 347 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
 348 VLC_EXPORT( playlist_item_t *, playlist_LockItemGetById, (playlist_t *, int) );
 349 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByPos, (playlist_t *, int) );
 350 VLC_EXPORT( playlist_item_t *, playlist_LockItemGetByPos, (playlist_t *, int) );
 351 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) );
 352 VLC_EXPORT( playlist_item_t *, playlist_LockItemGetByInput, (playlist_t *,input_item_t * ) );
 353 VLC_EXPORT( int, playlist_GetPositionById, (playlist_t *,int ) );
 354
 355 VLC_EXPORT( int, playlist_ItemAddOption, (playlist_item_t *, const char *) );
 356
 357 /* Playlist sorting */
 358 #define playlist_SortID(p, i) playlist_Sort( p, SORT_ID, i)
 359 #define playlist_SortTitle(p, i) playlist_Sort( p, SORT_TITLE, i)
 360 #define playlist_SortAuthor(p, i) playlist_Sort( p, SORT_AUTHOR, i)
 361 #define playlist_SortAlbum(p, i) playlist_Sort( p, SORT_ALBUM, i)
 362 #define playlist_SortGroup(p, i) playlist_Sort( p, SORT_GROUP, i)
 363 VLC_EXPORT( int,  playlist_Sort, ( playlist_t *, int, int) );
 364 VLC_EXPORT( int,  playlist_Move, ( playlist_t *, int, int ) );
 365 VLC_EXPORT( int,  playlist_NodeGroup, ( playlist_t *, int,playlist_item_t *,playlist_item_t **,int, int, int ) );
 366 VLC_EXPORT( int,  playlist_NodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
 367 VLC_EXPORT( int,  playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
 368
 369 /* Load/Save */
 370 VLC_EXPORT( int,  playlist_Import, ( playlist_t *, const char * ) );
 371 VLC_EXPORT( int,  playlist_Export, ( playlist_t *, const char *, const char * ) );
 372
 373 /***********************************************************************
 374  * Inline functions
 375  ***********************************************************************/
 376
 377
 378 /**
 379  *  tell if a playlist is currently playing.
 380  *  \param p_playlist the playlist to check
 381  *  \return true if playlist is playing, false otherwise
 382  */
 383 static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
 384 {
 385     vlc_bool_t b_playing;
 386
 387     vlc_mutex_lock( &p_playlist->object_lock );
 388     b_playing = p_playlist->status.i_status == PLAYLIST_RUNNING;
 389     vlc_mutex_unlock( &p_playlist->object_lock );
 390
 391     return( b_playing );
 392 }
 393
 394 /**
 395  *  tell if a playlist is currently empty
 396  *  \param p_playlist the playlist to check
 397  *  \return true if the playlist is empty, false otherwise
 398  */
 399 static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
 400 {
 401     vlc_bool_t b_empty;
 402
 403     vlc_mutex_lock( &p_playlist->object_lock );
 404     b_empty = p_playlist->i_size == 0;
 405     vlc_mutex_unlock( &p_playlist->object_lock );
 406
 407     return( b_empty );
 408 }
 409
 410
 411
 412 /**
 413  * @}
 414  */