X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_playlist.h;h=0c79e48853db66059853eb968c43dc071a02e88e;hb=560105460d6436d8fb7270a30c53167d7b10bd6e;hp=5c387676f2735a8087932413b627e60397ff61e8;hpb=6fbe51edaa14e1b5bab4f3de5fbfc296f54cacd2;p=vlc diff --git a/include/vlc_playlist.h b/include/vlc_playlist.h index 5c387676f2..0c79e48853 100644 --- a/include/vlc_playlist.h +++ b/include/vlc_playlist.h @@ -21,6 +21,11 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ +#ifndef _VLC_PLAYLIST_H_ +#define _VLC_PLAYLIST_H_ + +#include + /** * \file * This file contain structures and function prototypes related @@ -29,7 +34,6 @@ /** * \defgroup vlc_playlist Playlist - * Brief description. Longer description * @{ */ @@ -40,12 +44,7 @@ struct playlist_export_t { char *psz_filename; FILE *p_file; -}; - -struct item_parent_t -{ - int i_view; - playlist_item_t *p_parent; + playlist_item_t *p_root; }; /** @@ -54,70 +53,31 @@ struct item_parent_t */ struct playlist_item_t { - input_item_t input; /**< input item descriptor */ + input_item_t *p_input; /**< input item descriptor */ /* Tree specific fields */ int i_children; /**< Number of children -1 if not a node */ playlist_item_t **pp_children; /**< Children nodes/items */ - int i_parents; /**< Number of parents */ - struct item_parent_t **pp_parents; /**< Parents */ - int i_serial; /**< Has this node been updated ? */ - - uint8_t i_flags; /**< Flags */ - + playlist_item_t *p_parent; /**< Item parent */ - int i_nb_played; /**< How many times was this item played ? */ + int i_id; /**< Playlist item specific id */ - /* LEGACY FIELDS */ - vlc_bool_t b_autodeletion; /**< Indicates whther this item is to - * be deleted after playback. True mean - * that this item is to be deleted - * after playback, false otherwise */ - vlc_bool_t b_enabled; /**< Indicates whether this item is to be - * played or skipped */ - /* END LEGACY FIELDS */ -}; - -#define PLAYLIST_SAVE_FLAG 0x01 /**< Must it be saved */ -#define PLAYLIST_SKIP_FLAG 0x02 /**< Must playlist skip after it ? */ -#define PLAYLIST_ENA_FLAG 0x04 /**< Is it enabled ? */ -#define PLAYLIST_DEL_FLAG 0x08 /**< Autodelete ? */ -#define PLAYLIST_RO_FLAG 0x10 /**< Write-enabled ? */ -#define PLAYLIST_REMOVE_FLAG 0x20 /**< Remove this item at the end */ - -/** - * playlist view - * \see playlist_t -*/ -struct playlist_view_t -{ - char * psz_name; /**< View name */ - int i_id; /**< Identifier for the view */ - playlist_item_t * p_root; /**< Root node */ + uint8_t i_flags; /**< Flags */ }; - -/** - * predefined views - * - */ -#define VIEW_CATEGORY 1 -#define VIEW_SIMPLE 2 -#define VIEW_ALL 3 -#define VIEW_FIRST_SORTED 4 -#define VIEW_S_AUTHOR 4 -#define VIEW_S_GENRE 5 -#define VIEW_S_ALBUM 6 - -#define VIEW_LAST_SORTED 10 - -#define VIEW_FIRST_CUSTOM 100 +#define PLAYLIST_SAVE_FLAG 0x0001 /**< Must it be saved */ +#define PLAYLIST_SKIP_FLAG 0x0002 /**< Must playlist skip after it ? */ +#define PLAYLIST_DBL_FLAG 0x0004 /**< Is it disabled ? */ +#define PLAYLIST_RO_FLAG 0x0008 /**< Write-enabled ? */ +#define PLAYLIST_REMOVE_FLAG 0x0010 /**< Remove this item at the end */ +#define PLAYLIST_EXPANDED_FLAG 0x0020 /**< Expanded node */ /** * Playlist status */ -typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t; +typedef enum +{ PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t; struct services_discovery_t @@ -131,18 +91,7 @@ struct services_discovery_t void (*pf_run) ( services_discovery_t *); }; -struct playlist_preparse_t -{ - VLC_COMMON_MEMBERS - vlc_mutex_t lock; - int i_waiting; - int *pi_waiting; -}; - - -/** - * Structure containing information about the playlist - */ +/** Structure containing information about the playlist */ struct playlist_t { VLC_COMMON_MEMBERS @@ -151,73 +100,80 @@ struct playlist_t These members are uniq to playlist_t */ /*@{*/ - int i_index; /**< current index into the playlist */ int i_enabled; /**< How many items are enabled ? */ + /* Arrays of items */ int i_size; /**< total size of the list */ playlist_item_t ** pp_items; /**< array of pointers to the * playlist items */ int i_all_size; /**< size of list of items and nodes */ playlist_item_t ** pp_all_items; /**< array of pointers to the * playlist items and nodes */ + int i_input_items; + input_item_t ** pp_input_items; - int i_views; /**< Number of views */ - playlist_view_t ** pp_views; /**< array of pointers to the - * playlist views */ + int i_random; /**< Number of candidates for random */ + playlist_item_t ** pp_random; /**< Random candidate items */ + int i_random_index; /**< Current random item */ + vlc_bool_t b_reset_random; /**< Recreate random array ?*/ - input_thread_t * p_input; /**< the input thread ascosiated - * with the current item */ + int i_last_playlist_id; /**< Last id to an item */ + int i_last_input_id ; /**< Last id on an input */ - mtime_t request_date; /**< Used for profiling */ + services_discovery_t **pp_sds; + int i_sds; - int i_last_id; /**< Last id to an item */ - int i_sort; /**< Last sorting applied to the playlist */ - int i_order; /**< Last ordering applied to the playlist */ + /* Predefined items */ + playlist_item_t * p_root_category; + playlist_item_t * p_root_onelevel; + playlist_item_t * p_local_category; /** < "Playlist" in CATEGORY view */ + playlist_item_t * p_ml_category; /** < "Library" in CATEGORY view */ + playlist_item_t * p_local_onelevel; /** < "Playlist" in ONELEVEL view */ + playlist_item_t * p_ml_onelevel; /** < "Library" in ONELEVEL iew */ - playlist_item_t * p_general; /**< Keep a pointer on the "general" - category */ + vlc_bool_t b_always_tree;/**< Always display as tree */ + vlc_bool_t b_never_tree;/**< Never display as tree */ - services_discovery_t **pp_sds; - int i_sds; + vlc_bool_t b_doing_ml; /**< Doing media library stuff, */ + /*get quicker */ + + /* Runtime */ + input_thread_t * p_input; /**< the input thread associated + * with the current item */ + int i_sort; /**< Last sorting applied to the playlist */ + int i_order; /**< Last ordering applied to the playlist */ + mtime_t i_vout_destroyed_date; + mtime_t i_sout_destroyed_date; + playlist_preparse_t *p_preparse; /**< Preparser object */ + playlist_preparse_t *p_secondary_preparse; /**< Preparser object */ - vlc_bool_t b_go_next; /*< Go further than the parent node ? */ + vlc_mutex_t gc_lock; /**< Lock to protect the garbage collection */ struct { - /* Current status */ + /* Current status. These fields are readonly, only the playlist + * main loop can touch it*/ playlist_status_t i_status; /**< Current status of playlist */ - - /* R/O fields, don't touch if you aren't the playlist thread */ - /* Use a request */ playlist_item_t * p_item; /**< Currently playing/active item */ - playlist_item_t * p_node; /**< Current node to play from */ - int i_view; /**< Current view */ + playlist_item_t * p_node; /**< Current node to play from */ } status; struct { - /* Request */ - /* Playlist thread uses this info to calculate the next position */ - int i_view; /**< requested view id */ + /* Request. Use this to give orders to the playlist main loop */ + int i_status; /**< requested playlist status */ playlist_item_t * p_node; /**< requested node to play from */ playlist_item_t * p_item; /**< requested item to play in the node */ int i_skip; /**< Number of items to skip */ - int i_goto; /**< Direct index to go to (non-view)*/ - vlc_bool_t b_request; /**< Set to true by the requester - The playlist sets it back to false - when processing the request */ - vlc_mutex_t lock; /**< Lock to protect request */ + vlc_bool_t b_request;/**< Set to true by the requester + The playlist sets it back to false + when processing the request */ + vlc_mutex_t lock; /**< Lock to protect request */ } request; - playlist_preparse_t *p_preparse; - - vlc_mutex_t gc_lock; /**< Lock to protect the garbage collection */ - - // The following members are about user interaction - // The playlist manages the user interaction to avoid creating another - // thread - interaction_t *p_interaction; - + // Playlist-unrelated fields + interaction_t *p_interaction; /**< Interaction manager */ + global_stats_t *p_stats; /**< Global statistics */ /*@}*/ }; @@ -226,14 +182,13 @@ struct playlist_add_t { int i_node; int i_item; - int i_view; int i_position; }; #define SORT_ID 0 #define SORT_TITLE 1 #define SORT_TITLE_NODES_FIRST 2 -#define SORT_AUTHOR 3 +#define SORT_ARTIST 3 #define SORT_GENRE 4 #define SORT_RANDOM 5 #define SORT_DURATION 6 @@ -247,10 +202,24 @@ struct playlist_add_t * Prototypes *****************************************************************************/ -/* Creation/Deletion */ -#define playlist_Create(a) __playlist_Create(VLC_OBJECT(a)) -playlist_t * __playlist_Create ( vlc_object_t * ); -int playlist_Destroy ( playlist_t * ); +/* Global thread */ +#define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a)) +void __playlist_ThreadCreate ( vlc_object_t * ); +int playlist_ThreadDestroy ( playlist_t * ); + +/* Helpers */ +#define PL_LOCK vlc_mutex_lock( &p_playlist->object_lock ); +#define PL_UNLOCK vlc_mutex_unlock( &p_playlist->object_lock ); + +#define pl_Get( a ) a->p_libvlc->p_playlist +#define pl_Yield( a ) __pl_Yield( VLC_OBJECT(a) ) +static inline playlist_t *__pl_Yield( vlc_object_t *p_this ) +{ + assert( p_this->p_libvlc->p_playlist ); + vlc_object_yield( p_this->p_libvlc->p_playlist ); + return p_this->p_libvlc->p_playlist; +} +#define pl_Release(a) vlc_object_release( a->p_libvlc->p_playlist ); /* Playlist control */ #define playlist_Play(p) playlist_LockControl(p,PLAYLIST_PLAY ) @@ -259,13 +228,12 @@ int playlist_Destroy ( playlist_t * ); #define playlist_Next(p) playlist_LockControl(p,PLAYLIST_SKIP, 1) #define playlist_Prev(p) playlist_LockControl(p,PLAYLIST_SKIP, -1) #define playlist_Skip(p,i) playlist_LockControl(p,PLAYLIST_SKIP, i) -#define playlist_Goto(p,i) playlist_LockControl(p,PLAYLIST_GOTO, i) VLC_EXPORT( int, playlist_Control, ( playlist_t *, int, ... ) ); VLC_EXPORT( int, playlist_LockControl, ( playlist_t *, int, ... ) ); -VLC_EXPORT( int, playlist_Clear, ( playlist_t * ) ); -VLC_EXPORT( int, playlist_LockClear, ( playlist_t * ) ); +VLC_EXPORT( void, playlist_Clear, ( playlist_t * ) ); +VLC_EXPORT( void, playlist_LockClear, ( playlist_t * ) ); VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) ); VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) ); @@ -277,138 +245,197 @@ VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *)) VLC_EXPORT( int, playlist_AddSDModules, (playlist_t *, char *)); VLC_EXPORT( vlc_bool_t, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *)); +/* Playlist sorting */ +VLC_EXPORT( int, playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) ); +VLC_EXPORT( int, playlist_NodeSort, ( playlist_t *, playlist_item_t *,int, int ) ); +VLC_EXPORT( int, playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) ); + +/* Load/Save */ +VLC_EXPORT( int, playlist_Import, ( playlist_t *, const char *, playlist_item_t *, vlc_bool_t ) ); +VLC_EXPORT( int, playlist_Export, ( playlist_t *, const char *, playlist_item_t *, const char * ) ); + +/******************************************************** + * Item management + ********************************************************/ + +/*************************** Item creation **************************/ + +VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int , const char **, int, int) ); -/* Item management functions (act on items) */ -#define playlist_AddItem(p,pi,i1,i2) playlist_ItemAdd(p,pi,i1,i2) #define playlist_ItemNew( a , b, c ) __playlist_ItemNew(VLC_OBJECT(a) , b , c ) -#define playlist_ItemCopy( a, b ) __playlist_ItemCopy(VLC_OBJECT(a), b ) -VLC_EXPORT( playlist_item_t* , __playlist_ItemNew, ( vlc_object_t *,const char *,const char * ) ); -VLC_EXPORT( playlist_item_t* , __playlist_ItemCopy, ( vlc_object_t *,playlist_item_t* ) ); -VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int ) ); +/** Create a new item, without adding it to the playlist + * \param p_obj a vlc object (anyone will do) + * \param psz_uri the mrl of the item + * \param psz_name a text giving a name or description of the item + * \return the new item or NULL on failure + */ +static inline playlist_item_t * __playlist_ItemNew( vlc_object_t *p_obj, + const char *psz_uri, const char *psz_name ) +{ + /* 0 = ITEM_TYPE_UNKNOWN */ + return playlist_ItemNewWithType( p_obj, psz_uri, psz_name, 0, NULL, -1,0); +} + +#define playlist_ItemNewFromInput(a,b) __playlist_ItemNewFromInput(VLC_OBJECT(a),b) +VLC_EXPORT( playlist_item_t *, __playlist_ItemNewFromInput, ( vlc_object_t *p_obj,input_item_t *p_input ) ); + +/*************************** Item deletion **************************/ VLC_EXPORT( int, playlist_ItemDelete, ( playlist_item_t * ) ); -VLC_EXPORT( int, playlist_ItemAddParent, ( playlist_item_t *, int,playlist_item_t *) ); -VLC_EXPORT( int, playlist_CopyParents, ( playlist_item_t *,playlist_item_t *) ); -/* Item informations accessors */ +VLC_EXPORT( int, playlist_DeleteAllFromInput, ( playlist_t *, int ) ); +VLC_EXPORT( int, playlist_DeleteFromInput, ( playlist_t *, int, playlist_item_t *, vlc_bool_t ) ); +VLC_EXPORT( int, playlist_DeleteFromItemId, ( playlist_t *, int ) ); +VLC_EXPORT( int, playlist_LockDelete, ( playlist_t *, int ) ); +VLC_EXPORT( int, playlist_LockDeleteAllFromInput, ( playlist_t *, int ) ); + +/*************************** Item fields accessors **************************/ VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, char * ) ); -VLC_EXPORT( int, playlist_ItemSetDuration, (playlist_item_t *, mtime_t ) ); +/******************** Item addition ********************/ +VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, int, int, vlc_bool_t ) ); +VLC_EXPORT( int, playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int, vlc_bool_t ) ); +VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *,int , int, vlc_bool_t ) ); +VLC_EXPORT( playlist_item_t *, playlist_NodeAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int ) ); +VLC_EXPORT( void, playlist_NodeAddItem, ( playlist_t *, playlist_item_t *, playlist_item_t *,int , int ) ); +VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int ) ); +VLC_EXPORT( void, playlist_AddWhereverNeeded, (playlist_t* , input_item_t*, playlist_item_t*,playlist_item_t*,vlc_bool_t, int ) ); + +/** Add a MRL into the playlist. + * \see playlist_Add + */ +static inline int playlist_PlaylistAdd( playlist_t *p_playlist, + const char *psz_uri, const char *psz_name, + int i_mode, int i_pos ) +{ + return playlist_Add( p_playlist, psz_uri, psz_name, i_mode, i_pos, + VLC_TRUE); +} -/* View management functions */ -VLC_EXPORT( int, playlist_ViewInsert, (playlist_t *, int, char * ) ); -VLC_EXPORT( int, playlist_ViewDelete, (playlist_t *,playlist_view_t* ) ); -VLC_EXPORT( playlist_view_t *, playlist_ViewFind, (playlist_t *, int ) ); -VLC_EXPORT( int, playlist_ViewUpdate, (playlist_t *, int ) ); -VLC_EXPORT( int, playlist_ViewDump, (playlist_t *, playlist_view_t * ) ); -VLC_EXPORT( int, playlist_ViewEmpty, (playlist_t *, int, vlc_bool_t ) ); +/** Add a MRL to the media library + * \see playlist_Add + */ +static inline int playlist_MLAdd( playlist_t *p_playlist, const char *psz_uri, + const char *psz_name, int i_mode, int i_pos ) +{ + return playlist_Add( p_playlist, psz_uri, psz_name, i_mode, i_pos, + VLC_FALSE ); +} -/* Node management */ -VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *,int,char *, playlist_item_t * p_parent ) ); -VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,int,playlist_item_t*,playlist_item_t *) ); -VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,int,playlist_item_t*,playlist_item_t *, int) ); -VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) ); -VLC_EXPORT( int, playlist_NodeRemoveParent, (playlist_t *,playlist_item_t*,playlist_item_t *) ); -VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) ); -VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) ); -VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, vlc_bool_t , vlc_bool_t ) ); -VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, vlc_bool_t ) ); +/** Add a MRL to the playlist, with duration and options given + * \see playlist_AddExt + */ +static inline int playlist_PlaylistAddExt( playlist_t *p_playlist, + const char * psz_uri, const char *psz_name, int i_mode, int i_pos, + mtime_t i_duration, const char **ppsz_options, int i_options ) +{ + return playlist_AddExt( p_playlist, psz_uri, psz_name, i_mode, i_pos, + i_duration, ppsz_options, i_options, VLC_TRUE ); +} -/* Tree walking */ -playlist_item_t *playlist_FindNextFromParent( playlist_t *p_playlist, - int i_view, - playlist_item_t *p_root, - playlist_item_t *p_node, - playlist_item_t *p_item ); -playlist_item_t *playlist_FindPrevFromParent( playlist_t *p_playlist, - int i_view, - playlist_item_t *p_root, - playlist_item_t *p_node, - playlist_item_t *p_item ); - - -/* Simple add/remove functions */ -/* These functions add the item to the "simple" view (+all & category )*/ -VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, int, int ) ); -VLC_EXPORT( int, playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int ) ); -VLC_EXPORT( int, playlist_ItemAdd, ( playlist_t *, playlist_item_t *, int, int ) ); -VLC_EXPORT(int, playlist_NodeAddItem, ( playlist_t *, playlist_item_t *,int,playlist_item_t *,int , int ) ); - -/* Misc item operations (act on item+playlist) */ -VLC_EXPORT( int, playlist_Delete, ( playlist_t *, int ) ); -VLC_EXPORT( int, playlist_LockDelete, ( playlist_t *, int ) ); -VLC_EXPORT( int, playlist_Disable, ( playlist_t *, playlist_item_t * ) ); -VLC_EXPORT( int, playlist_Enable, ( playlist_t *, playlist_item_t * ) ); -VLC_EXPORT( int, playlist_ItemToNode, (playlist_t *,playlist_item_t *) ); -VLC_EXPORT( int, playlist_LockItemToNode, (playlist_t *,playlist_item_t *) ); -VLC_EXPORT( int, playlist_Replace, (playlist_t *,playlist_item_t *, input_item_t*) ); -VLC_EXPORT( int, playlist_LockReplace, (playlist_t *,playlist_item_t *, input_item_t*) ); +/** Add a MRL to the media library, with duration and options given + * \see playlist_AddExt + */ +static inline int playlist_MLAddExt( playlist_t *p_playlist, + const char * psz_uri, const char *psz_name, int i_mode, int i_pos, + mtime_t i_duration, const char **ppsz_options, int i_options ) +{ + return playlist_AddExt( p_playlist, psz_uri, psz_name, i_mode, i_pos, + i_duration, ppsz_options, i_options, VLC_FALSE ); +} +/** Add an input item to the playlist node + * \see playlist_AddInput + */ +static inline int playlist_PlaylistAddInput( playlist_t* p_playlist, + input_item_t *p_input, int i_mode, int i_pos ) +{ + return playlist_AddInput( p_playlist, p_input, i_mode, i_pos, VLC_TRUE ); +} -/* Item search functions */ +/** Add an input item to the media library + * \see playlist_AddInput + */ +static inline int playlist_MLAddInput( playlist_t* p_playlist, + input_item_t *p_input, int i_mode, int i_pos ) +{ + return playlist_AddInput( p_playlist, p_input, i_mode, i_pos, VLC_FALSE ); +} + +/********************** Misc item operations **********************/ +VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *) ); +VLC_EXPORT( playlist_item_t*, playlist_LockItemToNode, (playlist_t *,playlist_item_t *) ); + +playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist, + int i_input_id, playlist_item_t *p_root ); + +/********************************** Item search *************************/ VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) ); -VLC_EXPORT( playlist_item_t *, playlist_LockItemGetById, (playlist_t *, int) ); -VLC_EXPORT( playlist_item_t *, playlist_ItemGetByPos, (playlist_t *, int) ); -VLC_EXPORT( playlist_item_t *, playlist_LockItemGetByPos, (playlist_t *, int) ); VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) ); -VLC_EXPORT( playlist_item_t *, playlist_LockItemGetByInput, (playlist_t *,input_item_t * ) ); -VLC_EXPORT( int, playlist_GetPositionById, (playlist_t *,int ) ); -VLC_EXPORT( int, playlist_ItemAddOption, (playlist_item_t *, const char *) ); +static inline playlist_item_t *playlist_LockItemGetById( playlist_t *p_playlist, + int i_id) +{ + playlist_item_t *p_ret; + vlc_mutex_lock( &p_playlist->object_lock ); + p_ret = playlist_ItemGetById( p_playlist, i_id ); + vlc_mutex_unlock( &p_playlist->object_lock ); + return p_ret; +} + +static inline playlist_item_t *playlist_LockItemGetByInput( + playlist_t *p_playlist, input_item_t *p_item ) +{ + playlist_item_t *p_ret; + vlc_mutex_lock( &p_playlist->object_lock ); + p_ret = playlist_ItemGetByInput( p_playlist, p_item ); + vlc_mutex_unlock( &p_playlist->object_lock ); + return p_ret; +} -/* Playlist sorting */ -#define playlist_SortID(p, i) playlist_Sort( p, SORT_ID, i) -#define playlist_SortTitle(p, i) playlist_Sort( p, SORT_TITLE, i) -#define playlist_SortAuthor(p, i) playlist_Sort( p, SORT_AUTHOR, i) -#define playlist_SortAlbum(p, i) playlist_Sort( p, SORT_ALBUM, i) -#define playlist_SortGroup(p, i) playlist_Sort( p, SORT_GROUP, i) -VLC_EXPORT( int, playlist_Sort, ( playlist_t *, int, int) ); -VLC_EXPORT( int, playlist_Move, ( playlist_t *, int, int ) ); -VLC_EXPORT( int, playlist_NodeGroup, ( playlist_t *, int,playlist_item_t *,playlist_item_t **,int, int, int ) ); -VLC_EXPORT( int, playlist_NodeSort, ( playlist_t *, playlist_item_t *,int, int ) ); -VLC_EXPORT( int, playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) ); +VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) ); -/* Load/Save */ -VLC_EXPORT( int, playlist_Import, ( playlist_t *, const char * ) ); -VLC_EXPORT( int, playlist_Export, ( playlist_t *, const char *, const char * ) ); +/******************************************************** + * Tree management + ********************************************************/ +VLC_EXPORT(void, playlist_NodeDump, ( playlist_t *p_playlist, playlist_item_t *p_item, int i_level ) ); +VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) ); + +/* Node management */ +VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, char *, playlist_item_t * p_parent ) ); +VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) ); +VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) ); +VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) ); +VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) ); +VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, vlc_bool_t , vlc_bool_t ) ); +VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, vlc_bool_t ) ); +VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, char *, playlist_item_t **, playlist_item_t **, vlc_bool_t ) ); +VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) ); /*********************************************************************** * Inline functions ***********************************************************************/ - -/** - * tell if a playlist is currently playing. - * \param p_playlist the playlist to check - * \return true if playlist is playing, false otherwise - */ +/** Tell if the playlist is currently running */ static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist ) { vlc_bool_t b_playing; - vlc_mutex_lock( &p_playlist->object_lock ); b_playing = p_playlist->status.i_status == PLAYLIST_RUNNING; vlc_mutex_unlock( &p_playlist->object_lock ); - return( b_playing ); } -/** - * tell if a playlist is currently empty - * \param p_playlist the playlist to check - * \return true if the playlist is empty, false otherwise - */ +/** Tell if the playlist is empty */ static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist ) { vlc_bool_t b_empty; - vlc_mutex_lock( &p_playlist->object_lock ); b_empty = p_playlist->i_size == 0; vlc_mutex_unlock( &p_playlist->object_lock ); - return( b_empty ); } - - /** * @} */ + +#endif