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