git.sesse.net Git - vlc/blob - include/vlc_services_discovery.h

   1 /*****************************************************************************
   2  * vlc_services_discovery.h : Services Discover functions
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef VLC_SERVICES_DISCOVERY_H_
  25 #define VLC_SERVICES_DISCOVERY_H_
  26
  27 #include <vlc_input.h>
  28 #include <vlc_events.h>
  29 #include <vlc_probe.h>
  30
  31 /**
  32  * \file
  33  * This file lists functions and structures for service discovery (SD) in vlc
  34  */
  35
  36 # ifdef __cplusplus
  37 extern "C" {
  38 # endif
  39
  40 /*
  41  * @{
  42  */
  43 struct services_discovery_t
  44 {
  45     VLC_COMMON_MEMBERS
  46     module_t *          p_module;             /**< Loaded module */
  47
  48     /**< Event manager
  49     /* You should access it through setters, outside of the core */
  50     vlc_event_manager_t event_manager;
  51
  52     char *psz_name;                           /**< Main name of the SD */
  53     config_chain_t *p_cfg;                    /**< Configuration for the SD */
  54
  55     /** Control function
  56      * \see services_discovery_command_e
  57      */
  58     int ( *pf_control ) ( services_discovery_t *, int, va_list );
  59
  60     services_discovery_sys_t *p_sys;          /**< Custom private data */
  61 };
  62
  63 /**
  64  * Service discovery categories
  65  */
  66 enum services_discovery_category_e
  67 {
  68     SD_CAT_DEVICES = 1,           /**< Devices, like portable music players */
  69     SD_CAT_LAN,                   /**< LAN/WAN services, like Upnp or SAP */
  70     SD_CAT_INTERNET,              /**< Internet or Website channels services */
  71     SD_CAT_MYCOMPUTER             /**< Computer services, like Discs or Apps */
  72 };
  73
  74 /**
  75  * Service discovery control commands
  76  */
  77 enum services_discovery_command_e
  78 {
  79     SD_CMD_SEARCH = 1,          /**< arg1 = query */
  80     SD_CMD_DESCRIPTOR           /**< arg1 = services_discovery_descriptor_t* */
  81 };
  82
  83 /**
  84  * Service discovery capabilities
  85  */
  86 enum services_discovery_capability_e
  87 {
  88     SD_CAP_SEARCH = 1           /**< One can search in the SD */
  89 };
  90
  91 /**
  92  * Service discovery descriptor
  93  */
  94 typedef struct
  95 {
  96     char *psz_short_desc;       /**< The short description, human-readable */
  97     char *psz_icon_url;         /**< URL to the icon that represents it */
  98     char *psz_url;              /**< URL for the service */
  99     int   i_capabilities;       /**< \see services_discovery_capability_e */
 100 } services_discovery_descriptor_t;
 101
 102 /***********************************************************************
 103  * Service Discovery
 104  ***********************************************************************/
 105
 106 /**
 107  * Ask for a research in the SD
 108  * @param p_sd: the Service Discovery
 109  * @param i_control: the command to issue
 110  * @param args: the argument list
 111  * @return VLC_SUCCESS in case of success, the error code overwise
 112  */
 113 static inline int vlc_sd_control( services_discovery_t *p_sd, int i_control, va_list args )
 114 {
 115     if( p_sd->pf_control )
 116         return p_sd->pf_control( p_sd, i_control, args );
 117     else
 118         return VLC_EGENERIC;
 119 }
 120
 121 /* Get the services discovery modules names to use in Create(), in a null
 122  * terminated string array. Array and string must be freed after use. */
 123 VLC_EXPORT( char **, vlc_sd_GetNames, ( vlc_object_t *, char ***, int ** ) LIBVLC_USED );
 124 #define vlc_sd_GetNames(obj, pln, pcat ) \
 125         vlc_sd_GetNames(VLC_OBJECT(obj), pln, pcat)
 126
 127 /* Creation of a services_discovery object */
 128 VLC_EXPORT( services_discovery_t *, vlc_sd_Create, ( vlc_object_t *, const char * ) LIBVLC_USED );
 129 VLC_EXPORT( bool, vlc_sd_Start, ( services_discovery_t * ) );
 130 VLC_EXPORT( void, vlc_sd_Stop, ( services_discovery_t * ) );
 131 VLC_EXPORT( void, vlc_sd_Destroy, ( services_discovery_t * ) );
 132
 133 /**
 134  * Helper to stop and destroy the Service Discovery
 135  */
 136 static inline void vlc_sd_StopAndDestroy( services_discovery_t * p_this )
 137 {
 138     vlc_sd_Stop( p_this );
 139     vlc_sd_Destroy( p_this );
 140 }
 141
 142 /* Read info from discovery object */
 143 VLC_EXPORT( char *,                 services_discovery_GetLocalizedName, ( services_discovery_t * p_this ) LIBVLC_USED );
 144
 145 /* Receive event notification (preferred way to get new items) */
 146 VLC_EXPORT( vlc_event_manager_t *,  services_discovery_EventManager, ( services_discovery_t * p_this ) LIBVLC_USED );
 147
 148 /* Used by services_discovery to post update about their items */
 149     /* About the psz_category, it is a legacy way to add info to the item,
 150      * for more options, directly set the (meta) data on the input item */
 151 VLC_EXPORT( void,                   services_discovery_AddItem, ( services_discovery_t * p_this, input_item_t * p_item, const char * psz_category ) );
 152 VLC_EXPORT( void,                   services_discovery_RemoveItem, ( services_discovery_t * p_this, input_item_t * p_item ) );
 153
 154
 155 /* SD probing */
 156
 157 VLC_EXPORT(int, vlc_sd_probe_Add, (vlc_probe_t *, const char *, const char *, int category));
 158
 159 #define VLC_SD_PROBE_SUBMODULE \
 160     add_submodule() \
 161         set_capability( "services probe", 100 ) \
 162         set_callbacks( vlc_sd_probe_Open, NULL )
 163
 164 #define VLC_SD_PROBE_HELPER(name, longname, cat) \
 165 static int vlc_sd_probe_Open (vlc_object_t *obj) \
 166 { \
 167     return vlc_sd_probe_Add ((struct vlc_probe_t *)obj, \
 168                              name "{longname=\"" longname "\"}", \
 169                              longname, cat); \
 170 }
 171
 172 /** @} */
 173 # ifdef __cplusplus
 174 }
 175 # endif
 176
 177 #endif