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 functions and structures for service discovery in vlc
  34  */
  35
  36 # ifdef __cplusplus
  37 extern "C" {
  38 # endif
  39
  40 /*
  41  * @{
  42  */
  43
  44 struct services_discovery_t
  45 {
  46     VLC_COMMON_MEMBERS
  47     module_t *          p_module;
  48
  49     vlc_event_manager_t event_manager;      /* Accessed through Setters for non class function */
  50
  51     char *psz_name;
  52     config_chain_t *p_cfg;
  53
  54     int ( *pf_control ) ( services_discovery_t *, int, va_list );
  55
  56     services_discovery_sys_t *p_sys;
  57 };
  58
  59 /**
  60  * Service discovery categories
  61  */
  62 enum services_discovery_category_e
  63 {
  64     SD_CAT_DEVICES = 1,
  65     SD_CAT_LAN,
  66     SD_CAT_INTERNET,
  67     SD_CAT_MYCOMPUTER
  68 };
  69
  70 /**
  71  * Service discovery control commands
  72  */
  73 enum services_discovery_command_e
  74 {
  75     SD_CMD_SEARCH = 1,          /**< arg1 = query */
  76     SD_CMD_DESCRIPTOR           /**< arg1 = services_discovery_descriptor_t* */
  77 };
  78
  79 /**
  80  * Service discovery capabilities
  81  */
  82 enum services_discovery_capability_e
  83 {
  84     SD_CAP_SEARCH = 1
  85 };
  86
  87 /**
  88  * Service discovery descriptor
  89  */
  90 typedef struct
  91 {
  92     char *psz_short_desc;
  93     char *psz_icon_url;
  94     char *psz_url;
  95     int   i_capabilities;
  96 } services_discovery_descriptor_t;
  97
  98 /***********************************************************************
  99  * Service Discovery
 100  ***********************************************************************/
 101
 102 /**
 103  * Ask for a research in the SD
 104  * @param p_sd: the Service Discovery
 105  * @param i_control: the command to issue
 106  * @param args: the argument list
 107  * @return VLC_SUCCESS in case of success, the error code overwise
 108  */
 109 static inline int vlc_sd_control( services_discovery_t *p_sd, int i_control, va_list args )
 110 {
 111     if( p_sd->pf_control )
 112         return p_sd->pf_control( p_sd, i_control, args );
 113     else
 114         return VLC_EGENERIC;
 115 }
 116
 117 /* Get the services discovery modules names to use in Create(), in a null
 118  * terminated string array. Array and string must be freed after use. */
 119 VLC_EXPORT( char **, vlc_sd_GetNames, ( vlc_object_t *, char ***, int ** ) LIBVLC_USED );
 120 #define vlc_sd_GetNames(obj, pln, pcat ) \
 121         vlc_sd_GetNames(VLC_OBJECT(obj), pln, pcat)
 122
 123 /* Creation of a services_discovery object */
 124 VLC_EXPORT( services_discovery_t *, vlc_sd_Create, ( vlc_object_t *, const char * ) LIBVLC_USED );
 125 VLC_EXPORT( bool, vlc_sd_Start, ( services_discovery_t * ) );
 126 VLC_EXPORT( void, vlc_sd_Stop, ( services_discovery_t * ) );
 127 VLC_EXPORT( void, vlc_sd_Destroy, ( services_discovery_t * ) );
 128
 129 static inline void vlc_sd_StopAndDestroy( services_discovery_t * p_this )
 130 {
 131     vlc_sd_Stop( p_this );
 132     vlc_sd_Destroy( p_this );
 133 }
 134
 135 /* Read info from discovery object */
 136 VLC_EXPORT( char *,                 services_discovery_GetLocalizedName, ( services_discovery_t * p_this ) LIBVLC_USED );
 137
 138 /* Receive event notification (preferred way to get new items) */
 139 VLC_EXPORT( vlc_event_manager_t *,  services_discovery_EventManager, ( services_discovery_t * p_this ) LIBVLC_USED );
 140
 141 /* Used by services_discovery to post update about their items */
 142     /* About the psz_category, it is a legacy way to add info to the item,
 143      * for more options, directly set the (meta) data on the input item */
 144 VLC_EXPORT( void,                   services_discovery_AddItem, ( services_discovery_t * p_this, input_item_t * p_item, const char * psz_category ) );
 145 VLC_EXPORT( void,                   services_discovery_RemoveItem, ( services_discovery_t * p_this, input_item_t * p_item ) );
 146
 147
 148 /* SD probing */
 149
 150 VLC_EXPORT(int, vlc_sd_probe_Add, (vlc_probe_t *, const char *, const char *, int category));
 151
 152 #define VLC_SD_PROBE_SUBMODULE \
 153     add_submodule() \
 154         set_capability( "services probe", 100 ) \
 155         set_callbacks( vlc_sd_probe_Open, NULL )
 156
 157 #define VLC_SD_PROBE_HELPER(name, longname, cat) \
 158 static int vlc_sd_probe_Open (vlc_object_t *obj) \
 159 { \
 160     return vlc_sd_probe_Add ((struct vlc_probe_t *)obj, \
 161                              name "{longname=\"" longname "\"}", \
 162                              longname, cat); \
 163 }
 164
 165 /** @} */
 166 # ifdef __cplusplus
 167 }
 168 # endif
 169
 170 #endif