#ifndef _VLC_PLAYLIST_H_
#define _VLC_PLAYLIST_H_
+#include <assert.h>
+
/**
* \file
* This file contain structures and function prototypes related
/**
* \defgroup vlc_playlist Playlist
- * Brief description. Longer description
* @{
*/
uint8_t i_flags; /**< Flags */
};
-#define PLAYLIST_SAVE_FLAG 0x01 /**< Must it be saved */
-#define PLAYLIST_SKIP_FLAG 0x02 /**< Must playlist skip after it ? */
-#define PLAYLIST_DBL_FLAG 0x04 /**< Is it disabled ? */
-#define PLAYLIST_RO_FLAG 0x10 /**< Write-enabled ? */
-#define PLAYLIST_REMOVE_FLAG 0x20 /**< Remove this item at the end */
-#define PLAYLIST_EXPANDED_FLAG 0x40 /**< Expanded node */
+#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
void (*pf_run) ( services_discovery_t *);
};
-struct playlist_preparse_t
-{
- VLC_COMMON_MEMBERS
- vlc_mutex_t lock;
- int i_waiting;
- input_item_t **pp_waiting;
-};
-
-
-/**
- * Structure containing information about the playlist
- */
+/** Structure containing information about the playlist */
struct playlist_t
{
VLC_COMMON_MEMBERS
/*@{*/
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_last_playlist_id; /**< Last id to an item */
-
int i_input_items;
- input_item_t ** pp_input_items;
+ input_item_t ** pp_input_items;
- int i_last_input_id ;
+ 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 associated
- * with the current item */
+ int i_last_playlist_id; /**< Last id to an item */
+ int i_last_input_id ; /**< Last id on an input */
- int i_sort; /**< Last sorting applied to the playlist */
- int i_order; /**< Last ordering applied to the playlist */
+ services_discovery_t **pp_sds;
+ int i_sds;
+ /* 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 */
- services_discovery_t **pp_sds;
- int i_sds;
+ vlc_bool_t b_always_tree;/**< Always display as tree */
+ vlc_bool_t b_never_tree;/**< Never display as tree */
+
+ 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_mutex_t gc_lock; /**< Lock to protect the garbage collection */
struct {
/* Current status. These fields are readonly, only the playlist
vlc_mutex_t lock; /**< Lock to protect request */
} request;
- playlist_preparse_t *p_preparse; /**< Preparser object */
-
- vlc_mutex_t gc_lock; /**< Lock to protect the garbage collection */
-
// Playlist-unrelated fields
- interaction_t *p_interaction; /**< Interaction manager */
- global_stats_t *p_stats; /**< Global statistics */
-
+ interaction_t *p_interaction; /**< Interaction manager */
+ global_stats_t *p_stats; /**< Global statistics */
/*@}*/
};
{
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
/* Global thread */
#define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
-playlist_t *__playlist_ThreadCreate ( vlc_object_t * );
+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 );
-/* Creation/Deletion */
-playlist_t *playlist_Create ( vlc_object_t * );
-void playlist_Destroy ( playlist_t * );
-
-/* Engine */
-void playlist_MainLoop( playlist_t * );
-void playlist_LastLoop( playlist_t * );
-void playlist_PreparseLoop( playlist_preparse_t * );
-
-/* Control */
-playlist_item_t * playlist_NextItem ( playlist_t * );
-int playlist_PlayItem ( playlist_t *, playlist_item_t * );
+#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 )
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 ) );
-/* Item management functions (act on items) */
-#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 , const char **, int, int) );
-#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 ) );
+/* 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
+ ********************************************************/
-VLC_EXPORT( int, playlist_ItemDelete, ( playlist_item_t * ) );
+/*************************** Item creation **************************/
-/* Item informations accessors */
-VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, char * ) );
-VLC_EXPORT( int, playlist_ItemSetDuration, (playlist_item_t *, mtime_t ) );
+VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int , const char **, int, int) );
-VLC_EXPORT( void, playlist_ItemAddOption, (playlist_item_t *, const char *) );
+#define playlist_ItemNew( a , b, c ) __playlist_ItemNew(VLC_OBJECT(a) , b , c )
+/** 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);
+}
-VLC_EXPORT(void, playlist_NodeDump, ( playlist_t *p_playlist, playlist_item_t *p_item, int i_level ) );
+#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 ) );
-/** Counts the items of a view */
-VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
+/*************************** Item deletion **************************/
+VLC_EXPORT( int, playlist_ItemDelete, ( playlist_item_t * ) );
+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 ) );
-/* 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 ) );
+/*************************** Item fields accessors **************************/
+VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, char * ) );
-/* Tree walking - These functions are only for playlist, not plugins */
-playlist_item_t *playlist_GetNextLeaf( playlist_t *p_playlist,
- playlist_item_t *p_root,
- playlist_item_t *p_item );
-playlist_item_t *playlist_GetNextEnabledLeaf( playlist_t *p_playlist,
- playlist_item_t *p_root,
- playlist_item_t *p_item );
-playlist_item_t *playlist_GetPrevLeaf( playlist_t *p_playlist,
- playlist_item_t *p_root,
- playlist_item_t *p_item );
-playlist_item_t *playlist_GetLastLeaf( playlist_t *p_playlist,
- playlist_item_t *p_root );
-
-
-/* Simple add/remove functions */
-VLC_EXPORT( int, playlist_PlaylistAdd, ( playlist_t *, const char *, const char *, int, int ) );
-VLC_EXPORT( int, playlist_PlaylistAddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int ) );
-VLC_EXPORT( int, playlist_PlaylistAddInput, ( playlist_t *, input_item_t *,int , int ) );
+/******************** 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 ) );
-void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id, int i_node_id );
+/** 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);
+}
-/* Misc item operations (act on item+playlist) */
-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 ) );
+/** 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 );
+}
+
+/** 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 );
+}
+
+/** 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 );
+}
+
+/** 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 functions */
+/********************************** Item search *************************/
VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) );
VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) );
-/* 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_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
-VLC_EXPORT( int, playlist_NodeGroup, ( playlist_t *, 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 ) );
+/********************************************************
+ * 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* ) );
-/* Load/Save */
-VLC_EXPORT( int, playlist_Import, ( playlist_t *, const char * ) );
-VLC_EXPORT( int, playlist_Export, ( playlist_t *, const char *, playlist_item_t *, const char * ) );
+/* 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
projects / vlc / blobdiff