X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_services_discovery.h;h=69c3d96bd52d8cdad8b04b690ffd7f46052ad4d9;hb=2bd534c96de40f7c4be90ebbb8bb170c206e60a7;hp=df8b32a9863324c766ba9ec9c570d2366bc3c39f;hpb=acbd355a0bc946f82235ddce81a7b50d92f1b094;p=vlc diff --git a/include/vlc_services_discovery.h b/include/vlc_services_discovery.h index df8b32a986..69c3d96bd5 100644 --- a/include/vlc_services_discovery.h +++ b/include/vlc_services_discovery.h @@ -21,69 +21,160 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ -#if !defined( __LIBVLC__ ) - #error You are not libvlc or one of its plugins. You cannot include this file -#endif +#ifndef VLC_SERVICES_DISCOVERY_H_ +#define VLC_SERVICES_DISCOVERY_H_ -#ifndef _VLC_SERVICES_DISCOVERY_H_ -#define _VLC_SERVICES_DISCOVERY_H_ +#include +#include +#include + +/** + * \file + * This file lists functions and structures for service discovery (SD) in vlc + */ # ifdef __cplusplus extern "C" { # endif -/* +/** * @{ */ -#include -#include -#include -#include -#include - +/** + * Main service discovery structure to build a SD module + */ struct services_discovery_t { VLC_COMMON_MEMBERS - char * psz_module; - module_t * p_module; + module_t * p_module; /**< Loaded module */ + + /**< Event manager + * You should access it through setters, outside of the core */ + vlc_event_manager_t event_manager; - char * psz_localized_name; /* Accessed through Setters for non class function */ - vlc_event_manager_t event_manager; /* Accessed through Setters for non class function */ + char *psz_name; /**< Main name of the SD */ + config_chain_t *p_cfg; /**< Configuration for the SD */ + + /** Control function + * \see services_discovery_command_e + */ + int ( *pf_control ) ( services_discovery_t *, int, va_list ); + + services_discovery_sys_t *p_sys; /**< Custom private data */ +}; + +/** + * Service discovery categories + * \see vlc_sd_probe_Add + */ +enum services_discovery_category_e +{ + SD_CAT_DEVICES = 1, /**< Devices, like portable music players */ + SD_CAT_LAN, /**< LAN/WAN services, like Upnp or SAP */ + SD_CAT_INTERNET, /**< Internet or Website channels services */ + SD_CAT_MYCOMPUTER /**< Computer services, like Discs or Apps */ +}; + +/** + * Service discovery control commands + */ +enum services_discovery_command_e +{ + SD_CMD_SEARCH = 1, /**< arg1 = query */ + SD_CMD_DESCRIPTOR /**< arg1 = services_discovery_descriptor_t* */ +}; - services_discovery_sys_t *p_sys; - void (*pf_run) ( services_discovery_t *); +/** + * Service discovery capabilities + */ +enum services_discovery_capability_e +{ + SD_CAP_SEARCH = 1 /**< One can search in the SD */ }; +/** + * Service discovery descriptor + * \see services_discovery_command_e + */ +typedef struct +{ + char *psz_short_desc; /**< The short description, human-readable */ + char *psz_icon_url; /**< URL to the icon that represents it */ + char *psz_url; /**< URL for the service */ + int i_capabilities; /**< \see services_discovery_capability_e */ +} services_discovery_descriptor_t; + /*********************************************************************** * Service Discovery ***********************************************************************/ +/** + * Ask for a research in the SD + * @param p_sd: the Service Discovery + * @param i_control: the command to issue + * @param args: the argument list + * @return VLC_SUCCESS in case of success, the error code overwise + */ +static inline int vlc_sd_control( services_discovery_t *p_sd, int i_control, va_list args ) +{ + if( p_sd->pf_control ) + return p_sd->pf_control( p_sd, i_control, args ); + else + return VLC_EGENERIC; +} + /* Get the services discovery modules names to use in Create(), in a null * terminated string array. Array and string must be freed after use. */ -VLC_EXPORT( char **, __services_discovery_GetServicesNames, ( vlc_object_t * p_super, char ***pppsz_longnames ) ); -#define services_discovery_GetServicesNames(a,b) \ - __services_discovery_GetServicesNames(VLC_OBJECT(a),b) - -/* Creation of a service_discovery object */ -VLC_EXPORT( services_discovery_t *, services_discovery_Create, ( vlc_object_t * p_super, const char * psz_service_name ) ); -VLC_EXPORT( void, services_discovery_Destroy, ( services_discovery_t * p_this ) ); -VLC_EXPORT( int, services_discovery_Start, ( services_discovery_t * p_this ) ); -VLC_EXPORT( void, services_discovery_Stop, ( services_discovery_t * p_this ) ); +VLC_API char ** vlc_sd_GetNames( vlc_object_t *, char ***, int ** ) VLC_USED; +#define vlc_sd_GetNames(obj, pln, pcat ) \ + vlc_sd_GetNames(VLC_OBJECT(obj), pln, pcat) + +/* Creation of a services_discovery object */ +VLC_API services_discovery_t * vlc_sd_Create( vlc_object_t *, const char * ) VLC_USED; +VLC_API bool vlc_sd_Start( services_discovery_t * ); +VLC_API void vlc_sd_Stop( services_discovery_t * ); +VLC_API void vlc_sd_Destroy( services_discovery_t * ); + +/** + * Helper to stop and destroy the Service Discovery + */ +static inline void vlc_sd_StopAndDestroy( services_discovery_t * p_this ) +{ + vlc_sd_Stop( p_this ); + vlc_sd_Destroy( p_this ); +} /* Read info from discovery object */ -VLC_EXPORT( char *, services_discovery_GetLocalizedName, ( services_discovery_t * p_this ) ); +VLC_API char * services_discovery_GetLocalizedName( services_discovery_t * p_this ) VLC_USED; -/* Receive event notification (prefered way to get new items) */ -VLC_EXPORT( vlc_event_manager_t *, services_discovery_EventManager, ( services_discovery_t * p_this ) ); +/* Receive event notification (preferred way to get new items) */ +VLC_API vlc_event_manager_t * services_discovery_EventManager( services_discovery_t * p_this ) VLC_USED; /* Used by services_discovery to post update about their items */ -VLC_EXPORT( void, services_discovery_SetLocalizedName, ( services_discovery_t * p_this, const char * ) ); /* About the psz_category, it is a legacy way to add info to the item, * for more options, directly set the (meta) data on the input item */ -VLC_EXPORT( void, services_discovery_AddItem, ( services_discovery_t * p_this, input_item_t * p_item, const char * psz_category ) ); -VLC_EXPORT( void, services_discovery_RemoveItem, ( services_discovery_t * p_this, input_item_t * p_item ) ); +VLC_API void services_discovery_AddItem( services_discovery_t * p_this, input_item_t * p_item, const char * psz_category ); +VLC_API void services_discovery_RemoveItem( services_discovery_t * p_this, input_item_t * p_item ); + + +/* SD probing */ + +VLC_API int vlc_sd_probe_Add(vlc_probe_t *, const char *, const char *, int category); + +#define VLC_SD_PROBE_SUBMODULE \ + add_submodule() \ + set_capability( "services probe", 100 ) \ + set_callbacks( vlc_sd_probe_Open, NULL ) + +#define VLC_SD_PROBE_HELPER(name, longname, cat) \ +static int vlc_sd_probe_Open (vlc_object_t *obj) \ +{ \ + return vlc_sd_probe_Add ((struct vlc_probe_t *)obj, \ + name "{longname=\"" longname "\"}", \ + longname, cat); \ +} /** @} */ # ifdef __cplusplus