X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_playlist.h;h=c139ccb58a40cc1f49e00fbb990ef473d3fd34ad;hb=1ae081bee36ca43ae68e814494800764ff8eaae8;hp=78fa63e3923a9074343350d4163d22b9d7393de9;hpb=767819540a2998ab640b9efb40e2c60af48b5a1d;p=vlc diff --git a/include/vlc_playlist.h b/include/vlc_playlist.h index 78fa63e392..c139ccb58a 100644 --- a/include/vlc_playlist.h +++ b/include/vlc_playlist.h @@ -1,8 +1,8 @@ /***************************************************************************** * vlc_playlist.h : Playlist functions ***************************************************************************** - * Copyright (C) 1999-2004 VideoLAN - * $Id: vlc_playlist.h,v 1.23 2004/01/10 14:24:33 hartman Exp $ + * Copyright (C) 1999-2004 the VideoLAN team + * $Id$ * * Authors: Samuel Hocevar * @@ -18,232 +18,428 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ -/** - * \file - * This file contain structures and function prototypes related - * to the playlist in vlc - */ +#if !defined( __LIBVLC__ ) + #error You are not libvlc or one of its plugins. You cannot include this file +#endif -/** - * \defgroup vlc_playlist Playlist - * Brief description. Longer description - * @{ - */ +#ifndef _VLC_PLAYLIST_H_ +#define _VLC_PLAYLIST_H_ -/** - * Playlist info item - * \see playlist_item_t - */ +# ifdef __cplusplus +extern "C" { +# endif -struct item_info_t -{ - char * psz_name; /**< Name of this info */ - char * psz_value; /**< Value of the info */ -}; +#include +#include +#include +#include + +TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t); +TYPEDEF_ARRAY(input_item_t*, input_item_array_t); /** - * playlist item info category - * \see playlist_item_t - * \see item_info_t + * \file + * This file contain structures and function prototypes related + * to the playlist in vlc + * + * \defgroup vlc_playlist Playlist + * + * The VLC playlist system has a tree structure. This allows advanced + * categorization, like for SAP streams (which are grouped by "sap groups"). + * + * The base structure for all playlist operations is the input_item_t. This + * contains all information needed to play a stream and get info, ie, mostly, + * mrl and metadata. This structure contains a unique i_id field. ids are + * not recycled when an item is destroyed. + * + * Input items are not used directly, but through playlist items. + * The playlist items are themselves in a tree structure. They only contain + * a link to the input item, a unique id and a few flags. the playlist + * item id is NOT the same as the input item id. + * Several playlist items can be attached to a single input item. The input + * item is refcounted and is automatically destroyed when it is not used + * anymore. + * + * In the playlist itself, there are two trees, that should always be kept + * in sync. The "category" tree contains the whole tree structure with + * several levels, while the onelevel tree contains only one level :), ie + * it only contains "real" items, not nodes + * For example, if you open a directory, you will have + *\verbatim + * Category tree: Onevelel tree: + * Playlist Playlist + * - Dir - item1 + * - Subdir - item2 + * - item1 + * - item2 + *\endverbatim + * The top-level items of both tree are the same, and they are reproduced + * in the left-part of the playlist GUIs, they are the "sources" from the + * source selectors. Top-level items include: playlist, media library, SAP, + * Shoutcast, devices, ... + * + * It is envisioned that a third tree will appear: VLM, but it's not done yet + * + * The playlist also stores, for utility purposes, an array of all input + * items, an array of all playlist items and an array of all playlist items + * and nodes (both are represented by the same structure). + * + * So, here is an example: + * \verbatim + * Inputs array + * - input 1 -> name = foo 1 uri = ... + * - input 2 -> name = foo 2 uri = ... + * + * Category tree Onlevel tree + * - playlist (id 1) - playlist (id 3) + * - category 1 (id 2) - foo 2 (id 8 - input 2) + * - foo 2 (id 6 - input 2) - media library (id 4) + * - media library (id 2) - foo 1 (id6 - input 1) + * - foo 1 (id 5 - input 1) + * \endverbatim + * Sometimes, an item must be transformed to a node. This happens for the + * directory access for example. In that case, the item is removed from + * the onelevel tree, as it is not a real item anymore. + * + * For "standard" item addition, you can use playlist_Add, playlist_AddExt + * (more options) or playlist_AddInput if you already created your input + * item. This will add the item at the root of "Playlist" or of "Media library" + * in each of the two trees. + * + * If you want more control (like, adding the item as the child of a given + * node in the category tree, use playlist_BothAddInput. You'll have to provide + * the node in the category tree. The item will be added as a child of + * this node in the category tree, and as a child of the matching top-level + * node in the onelevel tree. (Nodes are created with playlist_NodeCreate) + * + * Generally speaking, playlist_NodeAddInput should not be used in newer code, it + * will maybe become useful again when we merge VLM; + * + * To delete an item, use playlist_DeleteFromInput( input_id ) which will + * remove all occurences of the input in both trees + * + * @{ */ -struct item_info_category_t + +/** Helper structure to export to file part of the playlist */ +struct playlist_export_t { - char * psz_name; /**< Name of this category */ - int i_infos; /**< Number of infos in the category */ - item_info_t **pp_infos; /**< Pointer to an array of infos */ + char *psz_filename; + FILE *p_file; + playlist_item_t *p_root; }; -/** - * playlist item - * \see playlist_t - */ +/** playlist item / node */ struct playlist_item_t { - char * psz_name; /**< text describing this item */ - char * psz_uri; /**< mrl of this item */ - mtime_t i_duration; /**< A hint about the duration of this - * item, in milliseconds*/ - int i_categories; /**< Number of info categories */ - item_info_category_t **pp_categories; - /**< Pointer to the first info category */ - int i_status; /**< unused yet */ - int i_nb_played; /**< How many times was this item played ? */ - 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 */ - int i_group; /**< Which group does this item belongs to ? */ - int i_id; /**< Unique id to track this item */ + input_item_t *p_input; /**< Linked input item */ + /** Number of children, -1 if not a node */ + int i_children; + playlist_item_t **pp_children; /**< Children nodes/items */ + playlist_item_t *p_parent; /**< Item parent */ + + int i_id; /**< Playlist item specific id */ + uint8_t i_flags; /**< Flags */ }; -/** - * playlist group - * \see playlist_t - */ -struct playlist_group_t +#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; + + +struct services_discovery_t { - char * psz_name; /**< name of the group */ - int i_id; /**< Identifier for the group */ -}; + VLC_COMMON_MEMBERS + char *psz_module; -/** - * Playlist status - */ -typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t; + module_t *p_module; -/** - * Structure containing information about the playlist - */ + services_discovery_sys_t *p_sys; + void (*pf_run) ( services_discovery_t *); +}; + +/** Structure containing information about the playlist */ struct playlist_t { VLC_COMMON_MEMBERS -/** - \name playlist_t - These members are uniq to playlist_t -*/ -/*@{*/ - int i_index; /**< current index into the playlist */ - playlist_status_t i_status; /**< current status of playlist */ - int i_size; /**< total size of the list */ int i_enabled; /**< How many items are enabled ? */ - playlist_item_t ** pp_items; /**< array of pointers to the - * playlist items */ - int i_groups; /**< How many groups are in the playlist */ - playlist_group_t ** pp_groups;/**< array of pointers to the playlist - * groups */ - int i_last_group; /**< Maximal group id given */ - input_thread_t * p_input; /**< the input thread ascosiated + + playlist_item_array_t items; /**< Arrays of items */ + playlist_item_array_t all_items; /**< Array of items and nodes */ + + input_item_array_t input_items; /**< Array of input items */ + + playlist_item_array_t current; /**< Items currently being played */ + int i_current_index; /**< Index in current array */ + /** Reset current item array */ + vlc_bool_t b_reset_currently_playing; + mtime_t last_rebuild_date; + + int i_last_playlist_id; /**< Last id to an item */ + int i_last_input_id ; /**< Last id on an input */ + + services_discovery_t **pp_sds; /**< Loaded service discovery modules */ + int i_sds; /**< Number of service discovery modules */ + + /* Predefined items */ + playlist_item_t * p_root_category; /**< Root of category tree */ + playlist_item_t * p_root_onelevel; /**< Root of onelevel tree */ + 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 */ + + 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 */ + vlc_bool_t b_auto_preparse; + + /* Runtime */ + input_thread_t * p_input; /**< the input thread associated * with the current item */ - 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 */ - /*@}*/ + mtime_t gc_date; + vlc_bool_t b_cant_sleep; + playlist_preparse_t *p_preparse; /**< Preparser object */ + playlist_fetcher_t *p_fetcher;/**< Meta and art fetcher object */ + + vlc_mutex_t gc_lock; /**< Lock to protect the garbage collection */ + + struct { + /* Current status. These fields are readonly, only the playlist + * main loop can touch it*/ + playlist_status_t i_status; /**< Current status of playlist */ + playlist_item_t * p_item; /**< Currently playing/active item */ + playlist_item_t * p_node; /**< Current node to play from */ + } status; + + struct { + /* 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 */ + + 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-unrelated fields + interaction_t *p_interaction; /**< Interaction manager */ + input_thread_t *p_stats_computer; /**< Input thread computing stats */ + global_stats_t *p_stats; /**< Global statistics */ +}; + +/** Helper to add an item */ +struct playlist_add_t +{ + int i_node; + int i_item; + int i_position; }; #define SORT_ID 0 #define SORT_TITLE 1 -#define SORT_AUTHOR 2 -#define SORT_GROUP 3 -#define SORT_RANDOM 4 +#define SORT_TITLE_NODES_FIRST 2 +#define SORT_ARTIST 3 +#define SORT_GENRE 4 +#define SORT_RANDOM 5 +#define SORT_DURATION 6 +#define SORT_TITLE_NUMERIC 7 +#define SORT_ALBUM 8 #define ORDER_NORMAL 0 #define ORDER_REVERSE 1 -#define PLAYLIST_TYPE_MANUAL 1 -#define PLAYLIST_TYPE_SAP 2 - /***************************************************************************** * Prototypes *****************************************************************************/ -#define playlist_Create(a) __playlist_Create(VLC_OBJECT(a)) -playlist_t * __playlist_Create ( vlc_object_t * ); -void playlist_Destroy ( playlist_t * ); - -#define playlist_Play(p) playlist_Command(p,PLAYLIST_PLAY,0) -#define playlist_Pause(p) playlist_Command(p,PLAYLIST_PAUSE,0) -#define playlist_Stop(p) playlist_Command(p,PLAYLIST_STOP,0) -#define playlist_Next(p) playlist_Command(p,PLAYLIST_SKIP,1) -#define playlist_Prev(p) playlist_Command(p,PLAYLIST_SKIP,-1) -#define playlist_Skip(p,i) playlist_Command(p,PLAYLIST_SKIP,i) -#define playlist_Goto(p,i) playlist_Command(p,PLAYLIST_GOTO,i) - -VLC_EXPORT( void, playlist_Command, ( playlist_t *, playlist_command_t, int ) ); - - -/* Item functions */ -VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, int, int ) ); -VLC_EXPORT( int, playlist_AddWDuration, ( playlist_t *, const char *, const char *, int, int, mtime_t ) ); -/* For internal use. Do not use this one anymore */ -VLC_EXPORT( int, playlist_AddItem, ( playlist_t *, playlist_item_t *, int, int ) ); -VLC_EXPORT( int, playlist_Clear, ( playlist_t * ) ); -VLC_EXPORT( int, playlist_Delete, ( playlist_t *, int ) ); -VLC_EXPORT( int, playlist_Disable, ( playlist_t *, int ) ); -VLC_EXPORT( int, playlist_Enable, ( playlist_t *, int ) ); -VLC_EXPORT( int, playlist_DisableGroup, ( playlist_t *, int ) ); -VLC_EXPORT( int, playlist_EnableGroup, ( playlist_t *, int ) ); - -/* Basic item informations accessors */ -VLC_EXPORT( int, playlist_SetGroup, (playlist_t *, int, int ) ); -VLC_EXPORT( int, playlist_SetName, (playlist_t *, int, char * ) ); -VLC_EXPORT( int, playlist_SetDuration, (playlist_t *, int, mtime_t ) ); - -/* Item search functions */ -VLC_EXPORT( int, playlist_GetPositionById, (playlist_t *, int) ); -VLC_EXPORT( playlist_item_t *, playlist_GetItemById, (playlist_t *, int) ); - - -/* Group management functions */ -VLC_EXPORT( playlist_group_t *, playlist_CreateGroup, (playlist_t *, char* ) ); -VLC_EXPORT( int, playlist_DeleteGroup, (playlist_t *, int ) ); -VLC_EXPORT( char *, playlist_FindGroup, (playlist_t *, int ) ); -VLC_EXPORT( int, playlist_GroupToId, (playlist_t *, char * ) ); - -/* Info functions */ -VLC_EXPORT( char * , playlist_GetInfo, ( playlist_t * , int, const char *, const char *) ); -VLC_EXPORT( char * , playlist_GetItemInfo, ( playlist_item_t * , const char *, const char *) ); - -VLC_EXPORT( item_info_category_t*, playlist_GetCategory, ( playlist_t *, int, const char *) ); -VLC_EXPORT( item_info_category_t*, playlist_GetItemCategory, ( playlist_item_t *, const char *) ); - -VLC_EXPORT( item_info_category_t*, playlist_CreateCategory, ( playlist_t *, int, const char *) ); -VLC_EXPORT( item_info_category_t*, playlist_CreateItemCategory, ( playlist_item_t *, const char *) ); - -VLC_EXPORT( int, playlist_AddInfo, (playlist_t *, int, const char * , const char *, const char *, ...) ); -VLC_EXPORT( int, playlist_AddItemInfo, (playlist_item_t *, const char * , const char *, const char *, ...) ); - -/* Option functions */ -VLC_EXPORT( int, playlist_AddOption, (playlist_t *, int, const char *, ...) ); -VLC_EXPORT( int, playlist_AddItemOption, (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_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 ) ); +/* Helpers */ +#define PL_LOCK vlc_mutex_lock( &p_playlist->object_lock ); +#define PL_UNLOCK vlc_mutex_unlock( &p_playlist->object_lock ); -/* Load/Save */ -VLC_EXPORT( int, playlist_LoadFile, ( playlist_t *, const char * ) ); -VLC_EXPORT( int, playlist_SaveFile, ( playlist_t *, const char * ) ); +#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_Control(p,PLAYLIST_PLAY, VLC_FALSE ) +#define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, VLC_FALSE ) +#define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, VLC_FALSE ) +#define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, VLC_FALSE, 1) +#define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, VLC_FALSE, -1) +#define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, VLC_FALSE, i) /** - * tell if a playlist is currently playing. - * \param p_playlist the playlist to check - * \return true if playlist is playing, false otherwise + * Do a playlist action. + * If there is something in the playlist then you can do playlist actions. + * Possible queries are listed in vlc_common.h + * \param p_playlist the playlist to do the command on + * \param i_query the command to do + * \param b_locked TRUE if playlist is locked when entering this function + * \param variable number of arguments + * \return VLC_SUCCESS or an error */ -static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist ) -{ - vlc_bool_t b_playing; +VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, vlc_bool_t b_locked, ... ) ); - vlc_mutex_lock( &p_playlist->object_lock ); - b_playing = p_playlist->i_status == PLAYLIST_RUNNING; - vlc_mutex_unlock( &p_playlist->object_lock ); +/** Clear the playlist + * \param b_locked TRUE if playlist is locked when entering this function + */ +VLC_EXPORT( void, playlist_Clear, ( playlist_t *, vlc_bool_t ) ); - return( b_playing ); -} +/** Enqueue an input item for preparsing */ +VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) ); + +/** Enqueue a playlist item and all of its children if any for preparsing */ +VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) ); +/** Request the art for an input item to be fetched */ +VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *) ); + +/********************** Services discovery ***********************/ + +/** Add a list of comma-separated service discovery modules */ +VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *)); +/** Remove a services discovery module by name */ +VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *)); +/** Check whether a given SD is loaded */ +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_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) ); /** - * tell if a playlist is currently empty - * \param p_playlist the playlist to check - * \return true if the playlist is empty, false otherwise + * Export a node of the playlist to a certain type of playlistfile + * \param p_playlist the playlist to export + * \param psz_filename the location where the exported file will be saved + * \param p_export_root the root node to export + * \param psz_type the type of playlist file to create (m3u, pls, ..) + * \return VLC_SUCCESS on success */ -static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist ) -{ - vlc_bool_t b_empty; +VLC_EXPORT( int, playlist_Export, ( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type ) ); - vlc_mutex_lock( &p_playlist->object_lock ); - b_empty = p_playlist->i_size == 0; - vlc_mutex_unlock( &p_playlist->object_lock ); +/******************************************************** + * Item management + ********************************************************/ - return( b_empty ); -} +/*************************** Item creation **************************/ -/** - * @} +VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int , const char *const *, int, 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 */ +#define playlist_ItemNew( a , b, c ) \ + playlist_ItemNewWithType( VLC_OBJECT(a) , b , c, 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_DeleteFromInput, ( playlist_t *, int, vlc_bool_t ) ); + +/*************************** Item fields accessors **************************/ +VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, const char * ) ); + +/******************** 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 *const *,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( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int* ) ); + +/********************** Misc item operations **********************/ +VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *, vlc_bool_t) ); + +playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist, + int i_input_id, playlist_item_t *p_root, + vlc_bool_t ); + +/********************************** Item search *************************/ +VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int, vlc_bool_t ) ); +VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t *, vlc_bool_t ) ); +VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInputId, (playlist_t *, int, playlist_item_t *) ); + +VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, 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 *, const char *, playlist_item_t * p_parent, int i_flags ) ); +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 *, const 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 + ***********************************************************************/ +/** Open a playlist file, add its content to the current playlist */ +static inline int playlist_Import( playlist_t *p_playlist, const char *psz_file){ + char psz_uri[256+10]; + input_item_t *p_input; + snprintf( psz_uri, 256+9, "file/://%s", psz_file ); + p_input = input_ItemNewExt( p_playlist, psz_uri, psz_file, 0, NULL, -1 ); + playlist_AddInput( p_playlist, p_input, PLAYLIST_APPEND, PLAYLIST_END, + VLC_TRUE ); + input_Read( p_playlist, p_input, VLC_TRUE ); + return VLC_SUCCESS; +} + +/** Tell if the playlist is currently running */ +#define playlist_IsPlaying( pl ) ( pl->status.i_status == PLAYLIST_RUNNING ) + +/** Tell if the playlist is empty */ +#define playlist_IsEmpty( pl ) ( pl->items.i_size == 0 ) + +/** Tell the number of items in the current playing context */ +#define playlist_CurrentSize( obj ) obj->p_libvlc->p_playlist->current.i_size + +/** Ask the playlist to do some work */ +static inline void playlist_Signal( playlist_t *p_playlist ) +{ + PL_LOCK; + vlc_cond_signal( &p_playlist->object_wait ); + PL_UNLOCK; +} + +/** @} */ +# ifdef __cplusplus +} +# endif + +#endif