1 /*****************************************************************************
2 * services_discovery.c : Manage playlist services_discovery modules
3 *****************************************************************************
4 * Copyright (C) 1999-2004 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
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.
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.
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 *****************************************************************************/
28 #include <vlc_common.h>
29 #include "vlc_playlist.h"
30 #include "vlc_events.h"
31 #include <vlc_services_discovery.h>
32 #include <vlc_probe.h>
33 #include "playlist_internal.h"
34 #include "../libvlc.h"
42 int vlc_sd_probe_Add (vlc_probe_t *probe, const char *name,
45 vlc_sd_probe_t names = { strdup(name), strdup(longname) };
47 if (unlikely (names.name == NULL || names.longname == NULL
48 || vlc_probe_add (probe, &names, sizeof (names))))
51 free (names.longname);
54 return VLC_PROBE_CONTINUE;
57 #undef vlc_sd_GetNames
60 * Gets the list of available services discovery plugins.
62 char **vlc_sd_GetNames (vlc_object_t *obj, char ***pppsz_longnames)
65 vlc_sd_probe_t *tab = vlc_probe (obj, "services probe", &count);
73 char **names = malloc (sizeof(char *) * (count + 1));
74 char **longnames = malloc (sizeof(char *) * (count + 1));
76 if (unlikely (names == NULL || longnames == NULL))
78 for( size_t i = 0; i < count; i++ )
80 names[i] = tab[i].name;
81 longnames[i] = tab[i].longname;
84 names[count] = longnames[count] = NULL;
85 *pppsz_longnames = longnames;
90 struct vlc_sd_internal_t
92 /* the playlist items for category and onelevel */
93 playlist_item_t *p_node;
94 services_discovery_t *p_sd; /**< Loaded service discovery modules */
98 static void services_discovery_Destructor ( vlc_object_t *p_obj );
102 * Basically you just listen to Service discovery event through the
103 * sd's event manager.
104 * That's how the playlist get's Service Discovery information
107 /***********************************************************************
109 ***********************************************************************/
110 services_discovery_t *vlc_sd_Create( vlc_object_t *p_super,
113 services_discovery_t *p_sd;
115 p_sd = vlc_custom_create( p_super, sizeof( *p_sd ), VLC_OBJECT_GENERIC,
116 "services discovery" );
119 free(config_ChainCreate( &p_sd->psz_name, &p_sd->p_cfg, cfg ));
121 vlc_event_manager_init( &p_sd->event_manager, p_sd, (vlc_object_t *)p_sd );
122 vlc_event_manager_register_event_type( &p_sd->event_manager,
123 vlc_ServicesDiscoveryItemAdded );
124 vlc_event_manager_register_event_type( &p_sd->event_manager,
125 vlc_ServicesDiscoveryItemRemoved );
126 vlc_event_manager_register_event_type( &p_sd->event_manager,
127 vlc_ServicesDiscoveryStarted );
128 vlc_event_manager_register_event_type( &p_sd->event_manager,
129 vlc_ServicesDiscoveryEnded );
131 vlc_object_set_destructor( p_sd, services_discovery_Destructor );
132 vlc_object_attach( p_sd, p_super );
137 /***********************************************************************
139 ***********************************************************************/
140 bool vlc_sd_Start ( services_discovery_t * p_sd )
142 assert(!p_sd->p_module);
144 p_sd->p_module = module_need( p_sd, "services_discovery",
145 p_sd->psz_name, true );
146 if( p_sd->p_module == NULL )
148 msg_Err( p_sd, "no suitable services discovery module" );
152 vlc_event_t event = {
153 .type = vlc_ServicesDiscoveryStarted
155 vlc_event_send( &p_sd->event_manager, &event );
159 /***********************************************************************
161 ***********************************************************************/
162 void vlc_sd_Stop ( services_discovery_t * p_sd )
164 vlc_event_t event = {
165 .type = vlc_ServicesDiscoveryEnded
168 vlc_event_send( &p_sd->event_manager, &event );
170 module_unneed( p_sd, p_sd->p_module );
171 p_sd->p_module = NULL;
174 void vlc_sd_Destroy( services_discovery_t *p_sd )
176 config_ChainDestroy( p_sd->p_cfg );
177 free( p_sd->psz_name );
178 vlc_object_release( p_sd );
181 /***********************************************************************
183 ***********************************************************************/
184 static void services_discovery_Destructor ( vlc_object_t *p_obj )
186 services_discovery_t * p_sd = (services_discovery_t *)p_obj;
187 assert(!p_sd->p_module); /* Forgot to call Stop */
188 vlc_event_manager_fini( &p_sd->event_manager );
191 /***********************************************************************
193 ***********************************************************************/
195 services_discovery_GetLocalizedName ( services_discovery_t * p_sd )
197 return strdup( module_get_name( p_sd->p_module, true ) );
200 /***********************************************************************
202 ***********************************************************************/
203 vlc_event_manager_t *
204 services_discovery_EventManager ( services_discovery_t * p_sd )
206 return &p_sd->event_manager;
209 /***********************************************************************
211 ***********************************************************************/
213 services_discovery_AddItem ( services_discovery_t * p_sd, input_item_t * p_item,
214 const char * psz_category )
217 event.type = vlc_ServicesDiscoveryItemAdded;
218 event.u.services_discovery_item_added.p_new_item = p_item;
219 event.u.services_discovery_item_added.psz_category = psz_category;
221 vlc_event_send( &p_sd->event_manager, &event );
224 /***********************************************************************
226 ***********************************************************************/
228 services_discovery_RemoveItem ( services_discovery_t * p_sd, input_item_t * p_item )
231 event.type = vlc_ServicesDiscoveryItemRemoved;
232 event.u.services_discovery_item_removed.p_item = p_item;
234 vlc_event_send( &p_sd->event_manager, &event );
238 * Playlist - Services discovery bridge
241 /* A new item has been added to a certain sd */
242 static void playlist_sd_item_added( const vlc_event_t * p_event, void * user_data )
244 input_item_t * p_input = p_event->u.services_discovery_item_added.p_new_item;
245 const char * psz_cat = p_event->u.services_discovery_item_added.psz_category;
246 playlist_item_t * p_parent = user_data;
247 playlist_t * p_playlist = p_parent->p_playlist;
249 msg_Dbg( p_playlist, "Adding %s in %s",
250 p_input->psz_name ? p_input->psz_name : "(null)",
251 psz_cat ? psz_cat : "(null)" );
254 /* If p_parent is in root category (this is clearly a hack) and we have a cat */
255 if( !EMPTY_STR(psz_cat) )
258 playlist_item_t * p_cat;
259 p_cat = playlist_ChildSearchName( p_parent, psz_cat );
262 p_cat = playlist_NodeCreate( p_playlist, psz_cat,
264 p_cat->i_flags &= ~PLAYLIST_SKIP_FLAG;
269 playlist_NodeAddInput( p_playlist, p_input, p_parent,
270 PLAYLIST_APPEND, PLAYLIST_END,
275 /* A new item has been removed from a certain sd */
276 static void playlist_sd_item_removed( const vlc_event_t * p_event, void * user_data )
278 input_item_t * p_input = p_event->u.services_discovery_item_removed.p_item;
279 playlist_item_t * p_parent = user_data;
280 playlist_DeleteFromInput( p_parent->p_playlist, p_input, false );
283 int playlist_ServicesDiscoveryAdd( playlist_t *p_playlist,
284 const char *psz_name )
286 /* Perform the addition */
287 services_discovery_t *p_sd;
289 msg_Dbg( p_playlist, "adding services_discovery %s...", psz_name );
290 p_sd = vlc_sd_Create( VLC_OBJECT(p_playlist), psz_name );
294 /* Free in playlist_ServicesDiscoveryRemove */
295 vlc_sd_internal_t * p_sds = malloc( sizeof(*p_sds) );
298 vlc_sd_Destroy( p_sd );
302 playlist_item_t *p_node;
304 /* Look for configuration chain "longname" */
305 const char *psz_longname = "?";
308 config_chain_t *cfg = p_sd->p_cfg;
311 if( cfg->psz_name && !strcmp( cfg->psz_name, "longname" ) )
313 psz_longname = cfg->psz_value;
321 p_node = playlist_NodeCreate( p_playlist, psz_longname,
322 p_playlist->p_root, 0, NULL );
325 vlc_event_attach( services_discovery_EventManager( p_sd ),
326 vlc_ServicesDiscoveryItemAdded,
327 playlist_sd_item_added, p_node );
329 vlc_event_attach( services_discovery_EventManager( p_sd ),
330 vlc_ServicesDiscoveryItemRemoved,
331 playlist_sd_item_removed, p_node );
333 if( !vlc_sd_Start( p_sd ) )
335 vlc_sd_Destroy( p_sd );
340 /* We want tree-view for service directory */
341 p_node->p_input->b_prefers_tree = true;
343 p_sds->p_node = p_node;
344 p_sds->psz_name = strdup( psz_name );
347 TAB_APPEND( pl_priv(p_playlist)->i_sds, pl_priv(p_playlist)->pp_sds, p_sds );
353 int playlist_ServicesDiscoveryRemove( playlist_t * p_playlist,
354 const char *psz_name )
356 playlist_private_t *priv = pl_priv( p_playlist );
357 vlc_sd_internal_t * p_sds = NULL;
360 for( int i = 0; i < priv->i_sds; i++ )
362 if( !strcmp( psz_name, priv->pp_sds[i]->psz_name ) )
364 p_sds = priv->pp_sds[i];
365 REMOVE_ELEM( priv->pp_sds, priv->i_sds, i );
373 msg_Warn( p_playlist, "discovery %s is not loaded", psz_name );
377 services_discovery_t *p_sd = p_sds->p_sd;
382 vlc_event_detach( services_discovery_EventManager( p_sd ),
383 vlc_ServicesDiscoveryItemAdded,
384 playlist_sd_item_added,
387 vlc_event_detach( services_discovery_EventManager( p_sd ),
388 vlc_ServicesDiscoveryItemRemoved,
389 playlist_sd_item_removed,
392 /* Remove the sd playlist node if it exists */
394 playlist_NodeDelete( p_playlist, p_sds->p_node, true, false );
397 vlc_sd_Destroy( p_sd );
398 free( p_sds->psz_name );
404 bool playlist_IsServicesDiscoveryLoaded( playlist_t * p_playlist,
405 const char *psz_name )
407 playlist_private_t *priv = pl_priv( p_playlist );
411 for( int i = 0; i < priv->i_sds; i++ )
413 vlc_sd_internal_t *sd = priv->pp_sds[i];
415 if( sd->psz_name && !strcmp( psz_name, sd->psz_name ) )
425 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist )
427 playlist_private_t *priv = pl_priv( p_playlist );
429 while( priv->i_sds > 0 )
430 playlist_ServicesDiscoveryRemove( p_playlist,
431 priv->pp_sds[0]->psz_name );