X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_playlist.h;h=beebba4f8aaa0d68f5f9e9e5f8eb597a5e199e6a;hb=62dd14548820fb0966e6b90d586183f74a427e4b;hp=272e0f3ec7dcdc45e5da495830ef502fc471b8d3;hpb=4bdf68b034c871c37d27e9274da2d8068be5a5ad;p=vlc diff --git a/include/vlc_playlist.h b/include/vlc_playlist.h index 272e0f3ec7..beebba4f8a 100644 --- a/include/vlc_playlist.h +++ b/include/vlc_playlist.h @@ -24,13 +24,18 @@ #ifndef _VLC_PLAYLIST_H_ #define _VLC_PLAYLIST_H_ -#include +# ifdef __cplusplus +extern "C" { +# endif + #include +#include +#include #include #include TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t); -TYPEDEF_ARRAY(input_item_t*, input_item_array_t); + /** * \file * This file contain structures and function prototypes related @@ -60,7 +65,7 @@ TYPEDEF_ARRAY(input_item_t*, input_item_array_t); * it only contains "real" items, not nodes * For example, if you open a directory, you will have *\verbatim - * Category tree: Onevelel tree: + * Category tree: Onelevel tree: * Playlist Playlist * - Dir - item1 * - Subdir - item2 @@ -84,7 +89,7 @@ TYPEDEF_ARRAY(input_item_t*, input_item_array_t); * - input 1 -> name = foo 1 uri = ... * - input 2 -> name = foo 2 uri = ... * - * Category tree Onlevel tree + * Category tree Onelevel 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) @@ -110,7 +115,7 @@ TYPEDEF_ARRAY(input_item_t*, input_item_array_t); * 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 + * remove all occurrences of the input in both trees * * @{ */ @@ -126,17 +131,15 @@ struct playlist_export_t /** playlist item / node */ struct playlist_item_t { - input_item_t *p_input; /**< input item descriptor */ - - /* Tree specific fields */ - int i_children; /**< Number of children - -1 if not a node */ + 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_t *p_playlist; /**< Parent playlist */ }; #define PLAYLIST_SAVE_FLAG 0x0001 /**< Must it be saved */ @@ -150,40 +153,31 @@ struct playlist_item_t typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t; - -struct services_discovery_t -{ - VLC_COMMON_MEMBERS - char *psz_module; - - module_t *p_module; - - services_discovery_sys_t *p_sys; - void (*pf_run) ( services_discovery_t *); -}; - /** Structure containing information about the playlist */ struct playlist_t { VLC_COMMON_MEMBERS - int i_enabled; /**< How many items are enabled ? */ + + struct playlist_services_discovery_support_t { + /* the playlist items for category and onelevel */ + playlist_item_t* p_cat; + playlist_item_t* p_one; + services_discovery_t * p_sd; /**< Loaded service discovery modules */ + } ** pp_sds; + int i_sds; /**< Number of service discovery modules */ 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 items_to_delete; /**< Array of items and nodes to + delete... At the very end. This sucks. */ 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; + bool 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 */ @@ -191,14 +185,13 @@ struct playlist_t 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_ml_onelevel; /** < "Library" in ONELEVEL view */ - vlc_bool_t b_always_tree;/**< Always display as tree */ - vlc_bool_t b_never_tree;/**< Never display as tree */ + bool b_tree; /**< Display as a tree */ - vlc_bool_t b_doing_ml; /**< Doing media library stuff, */ - /*get quicker */ - vlc_bool_t b_auto_preparse; + bool b_doing_ml; /**< Doing media library stuff, + * get quicker */ + bool b_auto_preparse; /* Runtime */ input_thread_t * p_input; /**< the input thread associated @@ -206,12 +199,10 @@ struct playlist_t 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; + bool 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*/ @@ -228,16 +219,11 @@ struct playlist_t int i_skip; /**< Number of items to skip */ - vlc_bool_t b_request;/**< Set to true by the requester + bool 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 */ @@ -257,63 +243,102 @@ struct playlist_add_t #define SORT_DURATION 6 #define SORT_TITLE_NUMERIC 7 #define SORT_ALBUM 8 +#define SORT_TRACK_NUMBER 9 +#define SORT_DESCRIPTION 10 +#define SORT_RATING 11 #define ORDER_NORMAL 0 #define ORDER_REVERSE 1 +/* Used by playlist_Import */ +#define PLAYLIST_INSERT 0x0001 +#define PLAYLIST_APPEND 0x0002 +#define PLAYLIST_GO 0x0004 +#define PLAYLIST_PREPARSE 0x0008 +#define PLAYLIST_SPREPARSE 0x0010 +#define PLAYLIST_NO_REBUILD 0x0020 + +#define PLAYLIST_END -666 + +enum pl_locked_state +{ + pl_Locked = true, + pl_Unlocked = false +}; + /***************************************************************************** * Prototypes *****************************************************************************/ -/* 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_LOCK vlc_object_lock( p_playlist ) +#define PL_UNLOCK vlc_object_unlock( p_playlist ) -#define pl_Get( a ) a->p_libvlc->p_playlist +VLC_EXPORT( playlist_t *, __pl_Yield, ( vlc_object_t * ) ); #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 ); + +VLC_EXPORT( void, __pl_Release, ( vlc_object_t * ) ); +#define pl_Release(a) __pl_Release( VLC_OBJECT(a) ) /* 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) +#define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked ) +#define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked ) +#define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked ) +#define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1) +#define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1) +#define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, i) + +/** + * 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 + */ +VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, bool b_locked, ... ) ); -VLC_EXPORT( int, playlist_Control, ( playlist_t *, int, vlc_bool_t, ... ) ); +/** Get current playing input. The object is retained. + */ +VLC_EXPORT( input_thread_t *, playlist_CurrentInput, ( playlist_t *p_playlist ) ); -VLC_EXPORT( void, playlist_Clear, ( playlist_t *, vlc_bool_t ) ); +/** Clear the playlist + * \param b_locked TRUE if playlist is locked when entering this function + */ +VLC_EXPORT( void, playlist_Clear, ( playlist_t *, bool ) ); +/** 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 */ +/********************** 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 *)); -VLC_EXPORT( int, playlist_AddSDModules, (playlist_t *, char *)); -VLC_EXPORT( vlc_bool_t, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *)); +/** Check whether a given SD is loaded */ +VLC_EXPORT( bool, 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 ) ); -/* Save a playlist file */ -VLC_EXPORT( int, playlist_Export, ( playlist_t *, const char *, playlist_item_t *, const char * ) ); +/** + * 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 + */ +VLC_EXPORT( int, playlist_Export, ( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type ) ); /******************************************************** * Item management @@ -321,101 +346,110 @@ VLC_EXPORT( int, playlist_Export, ( playlist_t *, const char *, playlist_item_t /*************************** Item creation **************************/ -VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int , const char *const *, int, int) ); +VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( playlist_t *,const char *,const char *, int , const char *const *, int, int) ); -#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); -} +#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_ItemDelete, ( playlist_item_t * ) ); -VLC_EXPORT( int, playlist_DeleteFromInput, ( playlist_t *, int, vlc_bool_t ) ); +VLC_EXPORT( int, playlist_DeleteFromInput, ( playlist_t *, int, bool ) ); /*************************** 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* ) ); +VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, int, int, bool, bool ) ); +VLC_EXPORT( int, playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char *const *,int, bool, bool ) ); +VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, bool, bool ) ); +VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int*, bool ) ); /********************** 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 ); +VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *, bool) ); /********************************** 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_ItemGetById, (playlist_t *, int, bool ) ); +VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t *, bool ) ); +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 ) ); +VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_flags, input_item_t * ) ); 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( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, bool , bool ) ); +VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, bool ) ); +VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, const char *, playlist_item_t **, playlist_item_t **, bool ) ); VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) ); +VLC_EXPORT( playlist_item_t *, playlist_GetNextLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, bool b_ena, bool b_unplayed ) ); +VLC_EXPORT( playlist_item_t *, playlist_GetPrevLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, bool b_ena, bool b_unplayed ) ); +VLC_EXPORT( playlist_item_t *, playlist_GetLastLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root ) ); /*********************************************************************** * 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){ +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 ); + const char *const psz_option = "meta-file"; + p_input = input_ItemNewExt( p_playlist, psz_uri, psz_file, + 1, &psz_option, -1 ); playlist_AddInput( p_playlist, p_input, PLAYLIST_APPEND, PLAYLIST_END, - VLC_TRUE ); - input_Read( p_playlist, p_input, VLC_TRUE ); + true, false ); + input_Read( p_playlist, p_input, true ); return VLC_SUCCESS; } +/** Small helper tp get current playing input or NULL. Release the input after use. */ +#define pl_CurrentInput(a) __pl_CurrentInput( VLC_OBJECT(a) ) +static inline input_thread_t * __pl_CurrentInput( vlc_object_t * p_this ) +{ + playlist_t * p_playlist = pl_Yield( p_this ); + if( !p_playlist ) return NULL; + input_thread_t * p_input = playlist_CurrentInput( p_playlist ); + pl_Release( p_this ); + return p_input; +} + /** Tell if the playlist is currently running */ -#define playlist_IsPlaying( pl ) ( pl->status.i_status == PLAYLIST_RUNNING ) +#define playlist_IsPlaying( pl ) ( pl->status.i_status == PLAYLIST_RUNNING && \ + !(pl->request.b_request && pl->request.i_status == PLAYLIST_STOPPED) ) + +#define playlist_IsStopped( pl ) ( pl->status.i_status == PLAYLIST_STOPPED || \ + (pl->request.b_request && pl->request.i_status == PLAYLIST_STOPPED) ) /** 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 +#define playlist_CurrentSize( pl ) pl->current.i_size + +/** Tell the current item id in current playing context */ +#define playlist_CurrentId( pl ) pl->status.p_item->i_id /** 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; -} +#define playlist_Signal( p_playlist ) vlc_object_signal( p_playlist ) /** @} */ +# ifdef __cplusplus +} +# endif #endif