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 )
112 services_discovery_t *p_sd;
114 p_sd = vlc_custom_create( p_super, sizeof( *p_sd ), VLC_OBJECT_GENERIC,
115 "services discovery" );
119 vlc_event_manager_init( &p_sd->event_manager, p_sd, (vlc_object_t *)p_sd );
120 vlc_event_manager_register_event_type( &p_sd->event_manager,
121 vlc_ServicesDiscoveryItemAdded );
122 vlc_event_manager_register_event_type( &p_sd->event_manager,
123 vlc_ServicesDiscoveryItemRemoved );
124 vlc_event_manager_register_event_type( &p_sd->event_manager,
125 vlc_ServicesDiscoveryStarted );
126 vlc_event_manager_register_event_type( &p_sd->event_manager,
127 vlc_ServicesDiscoveryEnded );
129 vlc_object_set_destructor( p_sd, services_discovery_Destructor );
130 vlc_object_attach( p_sd, p_super );
135 /***********************************************************************
137 ***********************************************************************/
138 bool vlc_sd_Start ( services_discovery_t * p_sd, const char *module )
140 assert(!p_sd->p_module);
142 p_sd->p_module = module_need( p_sd, "services_discovery", module, true );
144 if( p_sd->p_module == NULL )
146 msg_Err( p_sd, "no suitable services discovery module" );
150 vlc_event_t event = {
151 .type = vlc_ServicesDiscoveryStarted
153 vlc_event_send( &p_sd->event_manager, &event );
157 /***********************************************************************
159 ***********************************************************************/
160 void vlc_sd_Stop ( services_discovery_t * p_sd )
162 vlc_event_t event = {
163 .type = vlc_ServicesDiscoveryEnded
166 vlc_event_send( &p_sd->event_manager, &event );
168 module_unneed( p_sd, p_sd->p_module );
169 p_sd->p_module = NULL;
172 /***********************************************************************
174 ***********************************************************************/
175 static void services_discovery_Destructor ( vlc_object_t *p_obj )
177 services_discovery_t * p_sd = (services_discovery_t *)p_obj;
178 assert(!p_sd->p_module); /* Forgot to call Stop */
179 vlc_event_manager_fini( &p_sd->event_manager );
182 /***********************************************************************
184 ***********************************************************************/
186 services_discovery_GetLocalizedName ( services_discovery_t * p_sd )
188 return strdup( module_get_name( p_sd->p_module, true ) );
191 /***********************************************************************
193 ***********************************************************************/
194 vlc_event_manager_t *
195 services_discovery_EventManager ( services_discovery_t * p_sd )
197 return &p_sd->event_manager;
200 /***********************************************************************
202 ***********************************************************************/
204 services_discovery_AddItem ( services_discovery_t * p_sd, input_item_t * p_item,
205 const char * psz_category )
208 event.type = vlc_ServicesDiscoveryItemAdded;
209 event.u.services_discovery_item_added.p_new_item = p_item;
210 event.u.services_discovery_item_added.psz_category = psz_category;
212 vlc_event_send( &p_sd->event_manager, &event );
215 /***********************************************************************
217 ***********************************************************************/
219 services_discovery_RemoveItem ( services_discovery_t * p_sd, input_item_t * p_item )
222 event.type = vlc_ServicesDiscoveryItemRemoved;
223 event.u.services_discovery_item_removed.p_item = p_item;
225 vlc_event_send( &p_sd->event_manager, &event );
229 * Playlist - Services discovery bridge
232 /* A new item has been added to a certain sd */
233 static void playlist_sd_item_added( const vlc_event_t * p_event, void * user_data )
235 input_item_t * p_input = p_event->u.services_discovery_item_added.p_new_item;
236 const char * psz_cat = p_event->u.services_discovery_item_added.psz_category;
237 playlist_item_t * p_parent = user_data;
238 playlist_t * p_playlist = p_parent->p_playlist;
240 msg_Dbg( p_playlist, "Adding %s in %s",
241 p_input->psz_name ? p_input->psz_name : "(null)",
242 psz_cat ? psz_cat : "(null)" );
245 /* If p_parent is in root category (this is clearly a hack) and we have a cat */
246 if( !EMPTY_STR(psz_cat) )
249 playlist_item_t * p_cat;
250 p_cat = playlist_ChildSearchName( p_parent, psz_cat );
253 p_cat = playlist_NodeCreate( p_playlist, psz_cat,
255 p_cat->i_flags &= ~PLAYLIST_SKIP_FLAG;
260 playlist_NodeAddInput( p_playlist, p_input, p_parent,
261 PLAYLIST_APPEND, PLAYLIST_END,
266 /* A new item has been removed from a certain sd */
267 static void playlist_sd_item_removed( const vlc_event_t * p_event, void * user_data )
269 input_item_t * p_input = p_event->u.services_discovery_item_removed.p_item;
270 playlist_item_t * p_parent = user_data;
271 playlist_DeleteFromInput( p_parent->p_playlist, p_input, false );
274 int playlist_ServicesDiscoveryAdd( playlist_t *p_playlist, const char *psz_module )
276 /* Perform the addition */
277 msg_Dbg( p_playlist, "adding services_discovery %s...", psz_module );
279 services_discovery_t *p_sd = vlc_sd_Create( VLC_OBJECT(p_playlist) );
283 char *psz_name = NULL;
284 config_ChainCreate( &psz_name, &p_sd->p_cfg, psz_module );
286 module_t *m = module_find_by_shortcut( psz_name );
289 msg_Err( p_playlist, "No such module: %s", psz_name );
290 vlc_sd_Destroy( p_sd );
294 /* Free in playlist_ServicesDiscoveryRemove */
295 vlc_sd_internal_t * p_sds = malloc( sizeof(*p_sds) );
298 vlc_sd_Destroy( p_sd );
303 playlist_item_t *p_node;
306 p_node = playlist_NodeCreate( p_playlist, psz_module,
307 p_playlist->p_root, 0, NULL );
311 vlc_event_attach( services_discovery_EventManager( p_sd ),
312 vlc_ServicesDiscoveryItemAdded,
313 playlist_sd_item_added, p_node );
315 vlc_event_attach( services_discovery_EventManager( p_sd ),
316 vlc_ServicesDiscoveryItemRemoved,
317 playlist_sd_item_removed, p_node );
319 if( !vlc_sd_Start( p_sd, psz_name ) )
321 vlc_sd_Destroy( p_sd );
326 /* We want tree-view for service directory */
327 p_node->p_input->b_prefers_tree = true;
329 p_sds->p_node = p_node;
330 p_sds->psz_name = strdup( psz_module );
333 TAB_APPEND( pl_priv(p_playlist)->i_sds, pl_priv(p_playlist)->pp_sds, p_sds );
339 int playlist_ServicesDiscoveryRemove( playlist_t * p_playlist,
340 const char *psz_name )
342 playlist_private_t *priv = pl_priv( p_playlist );
343 vlc_sd_internal_t * p_sds = NULL;
346 for( int i = 0; i < priv->i_sds; i++ )
348 if( !strcmp( psz_name, priv->pp_sds[i]->psz_name ) )
350 p_sds = priv->pp_sds[i];
351 REMOVE_ELEM( priv->pp_sds, priv->i_sds, i );
359 msg_Warn( p_playlist, "discovery %s is not loaded", psz_name );
363 services_discovery_t *p_sd = p_sds->p_sd;
368 vlc_event_detach( services_discovery_EventManager( p_sd ),
369 vlc_ServicesDiscoveryItemAdded,
370 playlist_sd_item_added,
373 vlc_event_detach( services_discovery_EventManager( p_sd ),
374 vlc_ServicesDiscoveryItemRemoved,
375 playlist_sd_item_removed,
378 /* Remove the sd playlist node if it exists */
380 playlist_NodeDelete( p_playlist, p_sds->p_node, true, false );
383 vlc_sd_Destroy( p_sd );
384 free( p_sds->psz_name );
390 bool playlist_IsServicesDiscoveryLoaded( playlist_t * p_playlist,
391 const char *psz_name )
393 playlist_private_t *priv = pl_priv( p_playlist );
397 for( int i = 0; i < priv->i_sds; i++ )
399 vlc_sd_internal_t *sd = priv->pp_sds[i];
401 if( sd->psz_name && !strcmp( psz_name, sd->psz_name ) )
411 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist )
413 playlist_private_t *priv = pl_priv( p_playlist );
415 while( priv->i_sds > 0 )
416 playlist_ServicesDiscoveryRemove( p_playlist,
417 priv->pp_sds[0]->psz_name );