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
  29 TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t);
  30 TYPEDEF_ARRAY(input_item_t*, input_item_array_t);
  31 /**
  32  * \file
  33  * This file contain structures and function prototypes related
  34  * to the playlist in vlc
  35  *
  36  * \defgroup vlc_playlist Playlist
  37  * @{
  38  */
  39
  40 /**
  41  * playlist export helper structure
  42  */
  43 struct playlist_export_t
  44 {
  45     char *psz_filename;
  46     FILE *p_file;
  47     playlist_item_t *p_root;
  48 };
  49
  50 /**
  51  * playlist item / node
  52  * \see playlist_t
  53  */
  54 struct playlist_item_t
  55 {
  56     input_item_t           *p_input;    /**< input item descriptor */
  57
  58     /* Tree specific fields */
  59     int                    i_children;  /**< Number of children
  60                                              -1 if not a node */
  61     playlist_item_t      **pp_children; /**< Children nodes/items */
  62     playlist_item_t       *p_parent;    /**< Item parent */
  63
  64     int                    i_id;        /**< Playlist item specific id */
  65
  66     uint8_t                i_flags;     /**< Flags */
  67 };
  68
  69 #define PLAYLIST_SAVE_FLAG      0x0001    /**< Must it be saved */
  70 #define PLAYLIST_SKIP_FLAG      0x0002    /**< Must playlist skip after it ? */
  71 #define PLAYLIST_DBL_FLAG       0x0004    /**< Is it disabled ? */
  72 #define PLAYLIST_RO_FLAG        0x0008    /**< Write-enabled ? */
  73 #define PLAYLIST_REMOVE_FLAG    0x0010    /**< Remove this item at the end */
  74 #define PLAYLIST_EXPANDED_FLAG  0x0020    /**< Expanded node */
  75
  76 /**
  77  * Playlist status
  78  */
  79 typedef enum
  80 { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
  81
  82
  83 struct services_discovery_t
  84 {
  85     VLC_COMMON_MEMBERS
  86     char *psz_module;
  87
  88     module_t *p_module;
  89
  90     services_discovery_sys_t *p_sys;
  91     void (*pf_run) ( services_discovery_t *);
  92 };
  93
  94 /** Structure containing information about the playlist */
  95 struct playlist_t
  96 {
  97     VLC_COMMON_MEMBERS
  98 /**
  99    \name playlist_t
 100    These members are uniq to playlist_t
 101 */
 102 /*@{*/
 103     int                   i_enabled; /**< How many items are enabled ? */
 104
 105     playlist_item_array_t items; /**< Arrays of items */
 106     playlist_item_array_t all_items; /**< Array of items and nodes */
 107
 108     input_item_array_t    input_items; /**< Array of input items */
 109
 110     playlist_item_array_t current; /**< Items currently being played */
 111     int                   i_current_index; /**< Index in current array */
 112     /** Reset current item ? */
 113     vlc_bool_t            b_reset_currently_playing;
 114
 115     int                   i_last_playlist_id; /**< Last id to an item */
 116     int                   i_last_input_id ; /**< Last id on an input */
 117
 118     services_discovery_t **pp_sds;
 119     int                   i_sds;
 120
 121     /* Predefined items */
 122     playlist_item_t *     p_root_category;
 123     playlist_item_t *     p_root_onelevel;
 124     playlist_item_t *     p_local_category; /** < "Playlist" in CATEGORY view */
 125     playlist_item_t *     p_ml_category; /** < "Library" in CATEGORY view */
 126     playlist_item_t *     p_local_onelevel; /** < "Playlist" in ONELEVEL view */
 127     playlist_item_t *     p_ml_onelevel; /** < "Library" in ONELEVEL iew */
 128
 129     vlc_bool_t            b_always_tree;/**< Always display as tree */
 130     vlc_bool_t            b_never_tree;/**< Never display as tree */
 131
 132     vlc_bool_t            b_doing_ml; /**< Doing media library stuff, */
 133                                       /*get quicker */
 134
 135     /* Runtime */
 136     input_thread_t *      p_input;  /**< the input thread associated
 137                                      * with the current item */
 138     int                   i_sort; /**< Last sorting applied to the playlist */
 139     int                   i_order; /**< Last ordering applied to the playlist */
 140     mtime_t               gc_date;
 141     vlc_bool_t            b_cant_sleep;
 142     playlist_preparse_t  *p_preparse; /**< Preparser object */
 143     playlist_secondary_preparse_t *p_secondary_preparse;/**< Preparser object */
 144
 145     vlc_mutex_t gc_lock;         /**< Lock to protect the garbage collection */
 146
 147     struct {
 148         /* Current status. These fields are readonly, only the playlist
 149          * main loop can touch it*/
 150         playlist_status_t   i_status;  /**< Current status of playlist */
 151         playlist_item_t *   p_item; /**< Currently playing/active item */
 152         playlist_item_t *   p_node; /**< Current node to play from */
 153     } status;
 154
 155     struct {
 156         /* Request. Use this to give orders to the playlist main loop  */
 157         int                 i_status; /**< requested playlist status */
 158         playlist_item_t *   p_node;   /**< requested node to play from */
 159         playlist_item_t *   p_item;   /**< requested item to play in the node */
 160
 161         int                 i_skip;   /**< Number of items to skip */
 162
 163         vlc_bool_t          b_request;/**< Set to true by the requester
 164                                            The playlist sets it back to false
 165                                            when processing the request */
 166         vlc_mutex_t         lock;     /**< Lock to protect request */
 167     } request;
 168
 169     // Playlist-unrelated fields
 170     interaction_t       *p_interaction;       /**< Interaction manager */
 171     /** The input thread computing stats */
 172     input_thread_t      *p_stats_computer;
 173     global_stats_t      *p_stats;             /**< Global statistics */
 174     /*@}*/
 175 };
 176
 177 /* Helper to add an item */
 178 struct playlist_add_t
 179 {
 180     int i_node;
 181     int i_item;
 182     int i_position;
 183 };
 184
 185 #define SORT_ID 0
 186 #define SORT_TITLE 1
 187 #define SORT_TITLE_NODES_FIRST 2
 188 #define SORT_ARTIST 3
 189 #define SORT_GENRE 4
 190 #define SORT_RANDOM 5
 191 #define SORT_DURATION 6
 192 #define SORT_TITLE_NUMERIC 7
 193 #define SORT_ALBUM 8
 194
 195 #define ORDER_NORMAL 0
 196 #define ORDER_REVERSE 1
 197
 198 /*****************************************************************************
 199  * Prototypes
 200  *****************************************************************************/
 201
 202 /* Global thread */
 203 #define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
 204 void        __playlist_ThreadCreate   ( vlc_object_t * );
 205 int           playlist_ThreadDestroy  ( playlist_t * );
 206
 207 /* Helpers */
 208 #define PL_LOCK vlc_mutex_lock( &p_playlist->object_lock );
 209 #define PL_UNLOCK vlc_mutex_unlock( &p_playlist->object_lock );
 210
 211 #define pl_Get( a ) a->p_libvlc->p_playlist
 212 #define pl_Yield( a ) __pl_Yield( VLC_OBJECT(a) )
 213 static inline playlist_t *__pl_Yield( vlc_object_t *p_this )
 214 {
 215     assert( p_this->p_libvlc->p_playlist );
 216     vlc_object_yield( p_this->p_libvlc->p_playlist );
 217     return p_this->p_libvlc->p_playlist;
 218 }
 219 #define pl_Release(a) vlc_object_release( a->p_libvlc->p_playlist );
 220
 221 /* Playlist control */
 222 #define playlist_Play(p) playlist_LockControl(p,PLAYLIST_PLAY )
 223 #define playlist_Pause(p) playlist_LockControl(p,PLAYLIST_PAUSE )
 224 #define playlist_Stop(p) playlist_LockControl(p,PLAYLIST_STOP )
 225 #define playlist_Next(p) playlist_LockControl(p,PLAYLIST_SKIP, 1)
 226 #define playlist_Prev(p) playlist_LockControl(p,PLAYLIST_SKIP, -1)
 227 #define playlist_Skip(p,i) playlist_LockControl(p,PLAYLIST_SKIP, i)
 228
 229 VLC_EXPORT( int, playlist_Control, ( playlist_t *, int, ...  ) );
 230 VLC_EXPORT( int, playlist_LockControl, ( playlist_t *, int, ...  ) );
 231
 232 VLC_EXPORT( void,  playlist_Clear, ( playlist_t * ) );
 233 VLC_EXPORT( void,  playlist_LockClear, ( playlist_t * ) );
 234
 235 VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
 236 VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) );
 237 VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *) );
 238
 239 /* Services discovery */
 240
 241 VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
 242 VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
 243 VLC_EXPORT( int, playlist_AddSDModules, (playlist_t *, char *));
 244 VLC_EXPORT( vlc_bool_t, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
 245
 246 /* Playlist sorting */
 247 VLC_EXPORT( int,  playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
 248 VLC_EXPORT( int,  playlist_NodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
 249 VLC_EXPORT( int,  playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
 250
 251 /* Load/Save */
 252 VLC_EXPORT( int,  playlist_Import, ( playlist_t *, const char *, playlist_item_t *, vlc_bool_t ) );
 253 VLC_EXPORT( int,  playlist_Export, ( playlist_t *, const char *, playlist_item_t *, const char * ) );
 254
 255 /********************************************************
 256  * Item management
 257  ********************************************************/
 258
 259 /*************************** Item creation **************************/
 260
 261 VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int , const char **, int, int) );
 262
 263 #define playlist_ItemNew( a , b, c ) __playlist_ItemNew(VLC_OBJECT(a) , b , c )
 264 /** Create a new item, without adding it to the playlist
 265  * \param p_obj a vlc object (anyone will do)
 266  * \param psz_uri the mrl of the item
 267  * \param psz_name a text giving a name or description of the item
 268  * \return the new item or NULL on failure
 269  */
 270 static inline playlist_item_t * __playlist_ItemNew( vlc_object_t *p_obj,
 271                                      const char *psz_uri, const char *psz_name )
 272 {
 273     /* 0 = ITEM_TYPE_UNKNOWN */
 274     return playlist_ItemNewWithType( p_obj, psz_uri,  psz_name, 0, NULL, -1,0);
 275 }
 276
 277 #define playlist_ItemNewFromInput(a,b) __playlist_ItemNewFromInput(VLC_OBJECT(a),b)
 278 VLC_EXPORT( playlist_item_t *, __playlist_ItemNewFromInput, ( vlc_object_t *p_obj,input_item_t *p_input ) );
 279
 280 /*************************** Item deletion **************************/
 281 VLC_EXPORT( int, playlist_ItemDelete, ( playlist_item_t * ) );
 282 VLC_EXPORT( int,  playlist_DeleteAllFromInput, ( playlist_t *, int ) );
 283 VLC_EXPORT( int,  playlist_DeleteFromInput, ( playlist_t *, int, playlist_item_t *, vlc_bool_t ) );
 284 VLC_EXPORT( int,  playlist_DeleteFromItemId, ( playlist_t *, int ) );
 285 VLC_EXPORT( int,  playlist_LockDelete, ( playlist_t *, int ) );
 286 VLC_EXPORT( int,  playlist_LockDeleteAllFromInput, ( playlist_t *, int ) );
 287
 288 /*************************** Item fields accessors **************************/
 289 VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *,  char * ) );
 290
 291 /******************** Item addition ********************/
 292 VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int, vlc_bool_t ) );
 293 VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int, vlc_bool_t ) );
 294 VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *,int , int, vlc_bool_t ) );
 295 VLC_EXPORT( playlist_item_t *, playlist_NodeAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int ) );
 296 VLC_EXPORT( void, playlist_NodeAddItem, ( playlist_t *, playlist_item_t *, playlist_item_t *,int , int ) );
 297 VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int ) );
 298 VLC_EXPORT( void, playlist_AddWhereverNeeded, (playlist_t* , input_item_t*, playlist_item_t*,playlist_item_t*,vlc_bool_t, int ) );
 299
 300 /** Add a MRL into the playlist.
 301  * \see playlist_Add
 302  */
 303 static inline int playlist_PlaylistAdd( playlist_t *p_playlist,
 304                           const char *psz_uri, const char *psz_name,
 305                           int i_mode, int i_pos )
 306 {
 307     return playlist_Add( p_playlist, psz_uri, psz_name, i_mode, i_pos,
 308                          VLC_TRUE);
 309 }
 310
 311 /** Add a MRL to the media library
 312  * \see playlist_Add
 313  */
 314 static inline int playlist_MLAdd( playlist_t *p_playlist, const char *psz_uri,
 315                                   const char *psz_name, int i_mode, int i_pos )
 316 {
 317     return playlist_Add( p_playlist, psz_uri, psz_name, i_mode, i_pos,
 318                          VLC_FALSE );
 319 }
 320
 321 /** Add a MRL to the playlist, with duration and options given
 322  * \see playlist_AddExt
 323  */
 324 static inline int playlist_PlaylistAddExt( playlist_t *p_playlist,
 325             const char * psz_uri, const char *psz_name, int i_mode, int i_pos,
 326             mtime_t i_duration, const char **ppsz_options, int i_options )
 327 {
 328     return playlist_AddExt( p_playlist, psz_uri, psz_name, i_mode, i_pos,
 329                             i_duration, ppsz_options, i_options, VLC_TRUE );
 330 }
 331
 332 /** Add a MRL to the media library, with duration and options given
 333  * \see playlist_AddExt
 334  */
 335 static inline int playlist_MLAddExt( playlist_t *p_playlist,
 336             const char * psz_uri, const char *psz_name, int i_mode, int i_pos,
 337             mtime_t i_duration, const char **ppsz_options, int i_options )
 338 {
 339     return playlist_AddExt( p_playlist, psz_uri, psz_name, i_mode, i_pos,
 340                             i_duration, ppsz_options, i_options, VLC_FALSE );
 341 }
 342
 343 /** Add an input item to the playlist node
 344  * \see playlist_AddInput
 345  */
 346 static inline int playlist_PlaylistAddInput( playlist_t* p_playlist,
 347                                 input_item_t *p_input, int i_mode, int i_pos )
 348 {
 349     return playlist_AddInput( p_playlist, p_input, i_mode, i_pos, VLC_TRUE );
 350 }
 351
 352 /** Add an input item to the media library
 353  * \see playlist_AddInput
 354  */
 355 static inline int playlist_MLAddInput( playlist_t* p_playlist,
 356                                 input_item_t *p_input, int i_mode, int i_pos )
 357 {
 358     return playlist_AddInput( p_playlist, p_input, i_mode, i_pos, VLC_FALSE );
 359 }
 360
 361 /********************** Misc item operations **********************/
 362 VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *) );
 363 VLC_EXPORT( playlist_item_t*, playlist_LockItemToNode, (playlist_t *,playlist_item_t *) );
 364
 365 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
 366                                    int i_input_id, playlist_item_t *p_root,
 367                                    vlc_bool_t );
 368
 369 /********************************** Item search *************************/
 370 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
 371 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) );
 372
 373 static inline playlist_item_t *playlist_LockItemGetById( playlist_t *p_playlist,
 374                                                          int i_id)
 375 {
 376     playlist_item_t *p_ret;
 377     vlc_mutex_lock( &p_playlist->object_lock );
 378     p_ret = playlist_ItemGetById( p_playlist, i_id );
 379     vlc_mutex_unlock( &p_playlist->object_lock );
 380     return p_ret;
 381 }
 382
 383 static inline playlist_item_t *playlist_LockItemGetByInput(
 384                                 playlist_t *p_playlist, input_item_t *p_item )
 385 {
 386     playlist_item_t *p_ret;
 387     vlc_mutex_lock( &p_playlist->object_lock );
 388     p_ret = playlist_ItemGetByInput( p_playlist, p_item );
 389     vlc_mutex_unlock( &p_playlist->object_lock );
 390     return p_ret;
 391 }
 392
 393 VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) );
 394
 395 /********************************************************
 396  * Tree management
 397  ********************************************************/
 398 VLC_EXPORT(void, playlist_NodeDump, ( playlist_t *p_playlist, playlist_item_t *p_item, int i_level ) );
 399 VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
 400
 401 /* Node management */
 402 VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, char *, playlist_item_t * p_parent ) );
 403 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) );
 404 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) );
 405 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
 406 VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
 407 VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, vlc_bool_t , vlc_bool_t ) );
 408 VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, vlc_bool_t ) );
 409 VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, char *, playlist_item_t **, playlist_item_t **, vlc_bool_t ) );
 410 VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) );
 411
 412 /***********************************************************************
 413  * Inline functions
 414  ***********************************************************************/
 415
 416 /** Tell if the playlist is currently running */
 417 static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
 418 {
 419     vlc_bool_t b_playing;
 420     vlc_mutex_lock( &p_playlist->object_lock );
 421     b_playing = p_playlist->status.i_status == PLAYLIST_RUNNING;
 422     vlc_mutex_unlock( &p_playlist->object_lock );
 423     return( b_playing );
 424 }
 425
 426 /** Tell if the playlist is empty */
 427 static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
 428 {
 429     vlc_bool_t b_empty;
 430     vlc_mutex_lock( &p_playlist->object_lock );
 431     b_empty = p_playlist->items.i_size == 0;
 432     vlc_mutex_unlock( &p_playlist->object_lock );
 433     return( b_empty );
 434 }
 435
 436 /** Ask the playlist to do some work */
 437 static inline void playlist_Signal( playlist_t *p_playlist )
 438 {
 439     PL_LOCK;
 440     vlc_cond_signal( &p_playlist->object_wait );
 441     PL_UNLOCK;
 442 }
 443
 444 /**
 445  * @}
 446  */
 447
 448 #endif