mirror of
https://code.videolan.org/videolan/vlc
synced 2024-09-04 09:11:33 +02:00
241 lines
7.6 KiB
C
241 lines
7.6 KiB
C
/*****************************************************************************
|
|
* vlc_services_discovery.h : Services Discover functions
|
|
*****************************************************************************
|
|
* Copyright (C) 1999-2004 VLC authors and VideoLAN
|
|
*
|
|
* Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation; either version 2.1 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
|
|
*****************************************************************************/
|
|
|
|
#ifndef VLC_SERVICES_DISCOVERY_H_
|
|
#define VLC_SERVICES_DISCOVERY_H_
|
|
|
|
#include <vlc_input.h>
|
|
#include <vlc_probe.h>
|
|
|
|
/**
|
|
* \file
|
|
* This file lists functions and structures for service discovery (SD) in vlc
|
|
*/
|
|
|
|
# ifdef __cplusplus
|
|
extern "C" {
|
|
# endif
|
|
|
|
/**
|
|
* @{
|
|
*/
|
|
|
|
struct services_discovery_callbacks
|
|
{
|
|
void (*item_added)(struct services_discovery_t *sd, input_item_t *parent,
|
|
input_item_t *item, const char *category);
|
|
void (*item_removed)(struct services_discovery_t *sd, input_item_t *item);
|
|
};
|
|
|
|
struct services_discovery_owner_t
|
|
{
|
|
const struct services_discovery_callbacks *cbs;
|
|
void *sys; /**< Private data for the owner callbacks */
|
|
};
|
|
|
|
/**
|
|
* Main service discovery structure to build a SD module
|
|
*/
|
|
struct services_discovery_t
|
|
{
|
|
struct vlc_object_t obj;
|
|
module_t * p_module; /**< Loaded module */
|
|
|
|
char *psz_name; /**< Main name of the SD */
|
|
config_chain_t *p_cfg; /**< Configuration for the SD */
|
|
|
|
const char *description; /**< Human-readable name */
|
|
|
|
/** Control function
|
|
* \see services_discovery_command_e
|
|
*/
|
|
int ( *pf_control ) ( services_discovery_t *, int, va_list );
|
|
|
|
void *p_sys; /**< Custom private data */
|
|
|
|
struct services_discovery_owner_t owner; /**< Owner callbacks */
|
|
};
|
|
|
|
/**
|
|
* 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* */
|
|
};
|
|
|
|
/**
|
|
* 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_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)
|
|
|
|
/**
|
|
* Creates a services discoverer.
|
|
*/
|
|
VLC_API services_discovery_t *vlc_sd_Create(vlc_object_t *parent,
|
|
const char *chain, const struct services_discovery_owner_t *owner)
|
|
VLC_USED;
|
|
#define vlc_sd_Create( obj, a, b ) \
|
|
vlc_sd_Create( VLC_OBJECT( obj ), a, b )
|
|
|
|
VLC_API void vlc_sd_Destroy( services_discovery_t * );
|
|
|
|
/**
|
|
* Added top-level service callback.
|
|
*
|
|
* This is a convenience wrapper for services_discovery_AddSubItem().
|
|
* It covers the most comomn case wherby the added item is a top-level service,
|
|
* i.e. it has no parent node.
|
|
*/
|
|
static inline void services_discovery_AddItem(services_discovery_t *sd,
|
|
input_item_t *item)
|
|
{
|
|
sd->owner.cbs->item_added(sd, NULL, item, NULL);
|
|
}
|
|
|
|
/**
|
|
* Added service callback.
|
|
*
|
|
* A services discovery module invokes this function when it "discovers" a new
|
|
* service, i.e. a new input item.
|
|
*
|
|
* @note This callback does not take ownership of the input item; it might
|
|
* however (and most probably will) add one of more references to the item.
|
|
*
|
|
* The caller is responsible for releasing its own reference(s) eventually.
|
|
* Keeping a reference is necessary to call services_discovery_RemoveItem() or
|
|
* to alter the item later. However, if the caller will never remove nor alter
|
|
* the item, it can drop its reference(s) immediately.
|
|
*
|
|
* @param sd services discoverer / services discovery module instance
|
|
* @param item input item to add
|
|
*/
|
|
static inline void services_discovery_AddSubItem(services_discovery_t *sd,
|
|
input_item_t *parent,
|
|
input_item_t *item)
|
|
{
|
|
sd->owner.cbs->item_added(sd, parent, item, NULL);
|
|
}
|
|
|
|
/**
|
|
* Added service backward compatibility callback.
|
|
*
|
|
* @param category Optional name of a group that the item belongs in
|
|
* (for backward compatibility with legacy modules)
|
|
*/
|
|
VLC_DEPRECATED
|
|
static inline void services_discovery_AddItemCat(services_discovery_t *sd,
|
|
input_item_t *item,
|
|
const char *category)
|
|
{
|
|
sd->owner.cbs->item_added(sd, NULL, item, category);
|
|
}
|
|
|
|
/**
|
|
* Removed service callback.
|
|
*
|
|
* A services discovery module invokes this function when it senses that a
|
|
* service is no longer available.
|
|
*/
|
|
static inline void services_discovery_RemoveItem(services_discovery_t *sd,
|
|
input_item_t *item)
|
|
{
|
|
sd->owner.cbs->item_removed(sd, 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, cat); \
|
|
}
|
|
|
|
/** @} */
|
|
# ifdef __cplusplus
|
|
}
|
|
# endif
|
|
|
|
#endif
|