include/vlc_renderer_discovery.h

   1 /*****************************************************************************
   2  * vlc_renderer_discovery.h : Renderer Discovery functions
   3  *****************************************************************************
   4  * Copyright (C) 2016 VLC authors and VideoLAN
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU Lesser General Public License as published by
   8  * the Free Software Foundation; either version 2.1 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  19  *****************************************************************************/
  20
  21 #ifndef VLC_RENDERER_DISCOVERY_H
  22 #define VLC_RENDERER_DISCOVERY_H 1
  23
  24 #include <vlc_input.h>
  25 #include <vlc_events.h>
  26 #include <vlc_probe.h>
  27 #include <vlc_url.h>
  28
  29 /**
  30  * @defgroup vlc_renderer VLC renderer discovery
  31  * @{
  32  *
  33  * @file
  34  * This file declares VLC renderer discvoery structures and functions
  35  *
  36  * @defgroup vlc_renderer_item VLC renderer items returned by the discovery
  37  * @{
  38  */
  39
  40 typedef struct vlc_renderer_item vlc_renderer_item;
  41
  42 #define VLC_RENDERER_CAN_AUDIO 0x0001
  43 #define VLC_RENDERER_CAN_VIDEO 0x0002
  44
  45 /**
  46  * Create a new renderer item
  47  *
  48  * @param psz_name name of the item
  49  * @param psz_uri uri of the renderer item, must contains a valid protocol and
  50  * a valid host
  51  * @param psz_extra_sout extra sout options
  52  * @param psz_icon_uri icon uri of the renderer item
  53  * @param i_flags flags for the item
  54  * @return a renderer item or NULL in case of error
  55  */
  56 VLC_API vlc_renderer_item *
  57 vlc_renderer_item_new(const char *psz_name, const char *psz_uri,
  58                       const char *psz_extra_sout, const char *psz_icon_uri,
  59                       int i_flags) VLC_USED;
  60
  61 /**
  62  * Hold a renderer item, i.e. creates a new reference
  63  */
  64 VLC_API vlc_renderer_item *
  65 vlc_renderer_item_hold(vlc_renderer_item *p_item);
  66
  67 /**
  68  * Releases a renderer item, i.e. decrements its reference counter
  69  */
  70 VLC_API void
  71 vlc_renderer_item_release(vlc_renderer_item *p_item);
  72
  73 /**
  74  * Get the human readable name of a renderer item
  75  */
  76 VLC_API const char *
  77 vlc_renderer_item_name(const vlc_renderer_item *p_item);
  78
  79 /**
  80  * Get the sout command of a renderer item
  81  */
  82 VLC_API const char *
  83 vlc_renderer_item_sout(const vlc_renderer_item *p_item);
  84
  85 /**
  86  * Get the icon uri of a renderer item
  87  */
  88 VLC_API const char *
  89 vlc_renderer_item_icon_uri(const vlc_renderer_item *p_item);
  90
  91 /**
  92  * Get the flags of a renderer item
  93  */
  94 VLC_API int
  95 vlc_renderer_item_flags(const vlc_renderer_item *p_item);
  96
  97 /**
  98  * Set an opaque context
  99  */
 100 VLC_API void
 101 vlc_renderer_item_set_ctx(vlc_renderer_item *p_item, void *p_ctx);
 102
 103 /**
 104  * Get the opaque context previously set
 105  */
 106 VLC_API void*
 107 vlc_renderer_item_ctx(const vlc_renderer_item *p_item);
 108
 109 /**
 110  * @}
 111  * @defgroup vlc_renderer_discovery VLC renderer discovery interface
 112  * @{
 113  */
 114
 115 typedef struct vlc_renderer_discovery vlc_renderer_discovery;
 116 typedef struct vlc_renderer_discovery_sys vlc_renderer_discovery_sys;
 117
 118 /**
 119  * Return a list of renderer discovery modules
 120  *
 121  * @param pppsz_names a pointer to a list of module name, NULL terminated
 122  * @param pppsz_longnames a pointer to a list of module longname, NULL
 123  * terminated
 124  *
 125  * @return VLC_SUCCESS on success, or VLC_EGENERIC on error
 126  */
 127 VLC_API int
 128 vlc_rd_get_names(vlc_object_t *p_obj, char ***pppsz_names,
 129                  char ***pppsz_longnames) VLC_USED;
 130 #define vlc_rd_get_names(a, b, c) \
 131         vlc_rd_get_names(VLC_OBJECT(a), b, c)
 132
 133 /**
 134  * Create a new renderer discovery module
 135  *
 136  * @param psz_name name of the module to load, see vlc_rd_get_names() to get
 137  * the list of names
 138  *
 139  * @return a valid vlc_renderer_discovery, need to be released with
 140  * vlc_rd_release()
 141  */
 142 VLC_API vlc_renderer_discovery *
 143 vlc_rd_new(vlc_object_t *p_obj, const char *psz_name) VLC_USED;
 144
 145 #define vlc_rd_release(p_rd) vlc_object_release(p_rd)
 146
 147 /**
 148  * Get the event manager of the renderer discovery module
 149  *
 150  * @see vlc_RendererDiscoveryItemAdded
 151  * @see vlc_RendererDiscoveryItemRemoved
 152  */
 153 VLC_API vlc_event_manager_t *
 154 vlc_rd_event_manager(vlc_renderer_discovery *p_rd);
 155
 156 /**
 157  * Start the renderer discovery module
 158  *
 159  * Once started, the module can send new vlc_renderer_item via the
 160  * vlc_RendererDiscoveryItemAdded event.
 161  */
 162 VLC_API int
 163 vlc_rd_start(vlc_renderer_discovery *p_rd);
 164
 165 /**
 166  * Stop the renderer discovery module
 167  */
 168 VLC_API void
 169 vlc_rd_stop(vlc_renderer_discovery *p_rd);
 170
 171 /**
 172  * @}
 173  * @defgroup vlc_renderer_discovery_module VLC renderer module
 174  * @{
 175  */
 176
 177 struct vlc_renderer_discovery
 178 {
 179     VLC_COMMON_MEMBERS
 180     module_t *          p_module;
 181
 182     vlc_event_manager_t event_manager;
 183
 184     char *              psz_name;
 185     config_chain_t *    p_cfg;
 186
 187     vlc_renderer_discovery_sys *p_sys;
 188 };
 189
 190 /**
 191  * Add a new renderer item
 192  *
 193  * This will send the vlc_RendererDiscoveryItemAdded event
 194  */
 195 VLC_API void
 196 vlc_rd_add_item(vlc_renderer_discovery * p_rd, vlc_renderer_item * p_item);
 197
 198 /**
 199  * Add a new renderer item
 200  *
 201  * This will send the vlc_RendererDiscoveryItemRemoved event
 202  */
 203 VLC_API void
 204 vlc_rd_remove_item(vlc_renderer_discovery * p_rd, vlc_renderer_item * p_item);
 205
 206 /**
 207  * Renderer Discovery proble helpers
 208  */
 209 VLC_API int
 210 vlc_rd_probe_add(vlc_probe_t *p_probe, const char *psz_name,
 211                  const char *psz_longname);
 212
 213 #define VLC_RD_PROBE_HELPER(name, longname) \
 214 static int vlc_rd_probe_open(vlc_object_t *obj) \
 215 { \
 216     return vlc_rd_probe_add((struct vlc_probe_t *)obj, name, longname); \
 217 }
 218
 219 #define VLC_RD_PROBE_SUBMODULE \
 220     add_submodule() \
 221         set_capability("renderer probe", 100) \
 222         set_callbacks(vlc_rd_probe_open, NULL)
 223
 224 /** @} @} */
 225
 226 #endif