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_search ) ( services_discovery_t *, const char * );
  55
  56     services_discovery_sys_t *p_sys;
  57 };
  58
  59 enum services_discovery_category_e
  60 {
  61     SD_CAT_DEVICES = 1,
  62     SD_CAT_LAN,
  63     SD_CAT_INTERNET,
  64     SD_CAT_MYCOMPUTER
  65 };
  66
  67 /***********************************************************************
  68  * Service Discovery
  69  ***********************************************************************/
  70
  71 /**
  72  * Ask for a research in the SD
  73  * @param p_sd: the Service Discovery
  74  * @param psz_query: the query
  75  * @return VLC_SUCCESS in case of success, the error code overwise
  76  */
  77 static inline int vlc_sd_search( services_discovery_t *p_sd, const char *psz_query )
  78 {
  79     if( p_sd->pf_search )
  80         return p_sd->pf_search( p_sd, psz_query );
  81     else
  82         return VLC_EGENERIC;
  83 }
  84
  85 /* Get the services discovery modules names to use in Create(), in a null
  86  * terminated string array. Array and string must be freed after use. */
  87 VLC_EXPORT( char **, vlc_sd_GetNames, ( vlc_object_t *, char ***, int ** ) LIBVLC_USED );
  88 #define vlc_sd_GetNames(obj, pln, pcat ) \
  89         vlc_sd_GetNames(VLC_OBJECT(obj), pln, pcat)
  90
  91 /* Creation of a service_discovery object */
  92 VLC_EXPORT( services_discovery_t *, vlc_sd_Create, ( vlc_object_t *, const char * ) LIBVLC_USED );
  93 VLC_EXPORT( bool, vlc_sd_Start, ( services_discovery_t * ) );
  94 VLC_EXPORT( void, vlc_sd_Stop, ( services_discovery_t * ) );
  95 VLC_EXPORT( void, vlc_sd_Destroy, ( services_discovery_t * ) );
  96
  97 static inline void vlc_sd_StopAndDestroy( services_discovery_t * p_this )
  98 {
  99     vlc_sd_Stop( p_this );
 100     vlc_sd_Destroy( p_this );
 101 }
 102
 103 /* Read info from discovery object */
 104 VLC_EXPORT( char *,                 services_discovery_GetLocalizedName, ( services_discovery_t * p_this ) LIBVLC_USED );
 105
 106 /* Receive event notification (preferred way to get new items) */
 107 VLC_EXPORT( vlc_event_manager_t *,  services_discovery_EventManager, ( services_discovery_t * p_this ) LIBVLC_USED );
 108
 109 /* Used by services_discovery to post update about their items */
 110     /* About the psz_category, it is a legacy way to add info to the item,
 111      * for more options, directly set the (meta) data on the input item */
 112 VLC_EXPORT( void,                   services_discovery_AddItem, ( services_discovery_t * p_this, input_item_t * p_item, const char * psz_category ) );
 113 VLC_EXPORT( void,                   services_discovery_RemoveItem, ( services_discovery_t * p_this, input_item_t * p_item ) );
 114
 115
 116 /* SD probing */
 117
 118 VLC_EXPORT(int, vlc_sd_probe_Add, (vlc_probe_t *, const char *, const char *, int category));
 119
 120 #define VLC_SD_PROBE_SUBMODULE \
 121     add_submodule() \
 122         set_capability( "services probe", 100 ) \
 123         set_callbacks( vlc_sd_probe_Open, NULL )
 124
 125 #define VLC_SD_PROBE_HELPER(name, longname, cat) \
 126 static int vlc_sd_probe_Open (vlc_object_t *obj) \
 127 { \
 128     return vlc_sd_probe_Add ((struct vlc_probe_t *)obj, \
 129                              name "{longname=\"" longname "\"}", \
 130                              longname, cat); \
 131 }
 132
 133 /** @} */
 134 # ifdef __cplusplus
 135 }
 136 # endif
 137
 138 #endif