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 <vlc_modules.h>
34 #include "playlist_internal.h"
35 #include "../libvlc.h"
44 int vlc_sd_probe_Add (vlc_probe_t *probe, const char *name,
45 const char *longname, int category)
47 vlc_sd_probe_t names = { strdup(name), strdup(longname), category };
49 if (unlikely (names.name == NULL || names.longname == NULL
50 || vlc_probe_add (probe, &names, sizeof (names))))
53 free (names.longname);
56 return VLC_PROBE_CONTINUE;
59 #undef vlc_sd_GetNames
62 * Gets the list of available services discovery plugins.
64 char **vlc_sd_GetNames (vlc_object_t *obj, char ***pppsz_longnames, int **pp_categories)
67 vlc_sd_probe_t *tab = vlc_probe (obj, "services probe", &count);
75 char **names = malloc (sizeof(char *) * (count + 1));
76 char **longnames = malloc (sizeof(char *) * (count + 1));
77 int *categories = malloc(sizeof(int) * (count + 1));
79 if (unlikely (names == NULL || longnames == NULL || categories == NULL))
81 for( size_t i = 0; i < count; i++ )
83 names[i] = tab[i].name;
84 longnames[i] = tab[i].longname;
85 categories[i] = tab[i].category;
88 names[count] = longnames[count] = NULL;
89 categories[count] = 0;
90 *pppsz_longnames = longnames;
91 if( pp_categories ) *pp_categories = categories;
92 else free( categories );
97 static void services_discovery_Destructor ( vlc_object_t *p_obj );
101 * Basically you just listen to Service discovery event through the
102 * sd's event manager.
103 * That's how the playlist get's Service Discovery information
106 /*******************************************************************//**
107 * Create a Service discovery
108 ***********************************************************************/
109 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 ), "services discovery" );
117 free(config_ChainCreate( &p_sd->psz_name, &p_sd->p_cfg, cfg ));
119 vlc_event_manager_t *em = &p_sd->event_manager;
120 vlc_event_manager_init( em, p_sd );
121 vlc_event_manager_register_event_type(em, vlc_ServicesDiscoveryItemAdded);
122 vlc_event_manager_register_event_type(em, vlc_ServicesDiscoveryItemRemoved);
123 vlc_event_manager_register_event_type(em, vlc_ServicesDiscoveryStarted);
124 vlc_event_manager_register_event_type(em, vlc_ServicesDiscoveryEnded);
126 vlc_object_set_destructor( p_sd, services_discovery_Destructor );
130 /*******************************************************************//**
131 * Start a Service Discovery
132 ***********************************************************************/
133 bool vlc_sd_Start ( services_discovery_t * p_sd )
135 assert(!p_sd->p_module);
137 p_sd->p_module = module_need( p_sd, "services_discovery",
138 p_sd->psz_name, true );
139 if( p_sd->p_module == NULL )
141 msg_Err( p_sd, "no suitable services discovery module" );
145 vlc_event_t event = {
146 .type = vlc_ServicesDiscoveryStarted
148 vlc_event_send( &p_sd->event_manager, &event );
152 /*******************************************************************//**
153 * Stop a Service Discovery
154 ***********************************************************************/
155 void vlc_sd_Stop ( services_discovery_t * p_sd )
157 vlc_event_t event = {
158 .type = vlc_ServicesDiscoveryEnded
161 vlc_event_send( &p_sd->event_manager, &event );
163 module_unneed( p_sd, p_sd->p_module );
164 p_sd->p_module = NULL;
167 /*******************************************************************//**
168 * Destroy a Service Discovery
169 ***********************************************************************/
170 void vlc_sd_Destroy( services_discovery_t *p_sd )
172 config_ChainDestroy( p_sd->p_cfg );
173 free( p_sd->psz_name );
174 vlc_object_release( p_sd );
177 /*******************************************************************//**
178 * Destructor of the Service Discovery
179 ***********************************************************************/
180 static void services_discovery_Destructor ( vlc_object_t *p_obj )
182 services_discovery_t * p_sd = (services_discovery_t *)p_obj;
183 assert(!p_sd->p_module); /* Forgot to call Stop */
184 vlc_event_manager_fini( &p_sd->event_manager );
187 /*******************************************************************//**
188 * Get the Localized Name
190 * This is useful for interfaces and libVLC
191 ***********************************************************************/
193 services_discovery_GetLocalizedName ( services_discovery_t * p_sd )
195 return strdup( module_get_name( p_sd->p_module, true ) );
198 /*******************************************************************//**
199 * Getter for the EventManager
201 * You can receive event notification
202 * This is the preferred way to get new items
203 ***********************************************************************/
204 vlc_event_manager_t *
205 services_discovery_EventManager ( services_discovery_t * p_sd )
207 return &p_sd->event_manager;
210 /*******************************************************************//**
211 * Add an item to the Service Discovery listing
212 ***********************************************************************/
214 services_discovery_AddItem ( services_discovery_t * p_sd, input_item_t * p_item,
215 const char * psz_category )
218 event.type = vlc_ServicesDiscoveryItemAdded;
219 event.u.services_discovery_item_added.p_new_item = p_item;
220 event.u.services_discovery_item_added.psz_category = psz_category;
222 vlc_event_send( &p_sd->event_manager, &event );
225 /*******************************************************************//**
226 * Remove an item from the Service Discovery listing
227 ***********************************************************************/
229 services_discovery_RemoveItem ( services_discovery_t * p_sd, input_item_t * p_item )
232 event.type = vlc_ServicesDiscoveryItemRemoved;
233 event.u.services_discovery_item_removed.p_item = p_item;
235 vlc_event_send( &p_sd->event_manager, &event );
239 * Playlist - Services discovery bridge
242 struct vlc_sd_internal_t
244 /* the playlist items for category and onelevel */
245 playlist_item_t *p_node;
246 services_discovery_t *p_sd; /**< Loaded service discovery modules */
250 /* A new item has been added to a certain sd */
251 static void playlist_sd_item_added( const vlc_event_t * p_event, void * user_data )
253 input_item_t * p_input = p_event->u.services_discovery_item_added.p_new_item;
254 const char * psz_cat = p_event->u.services_discovery_item_added.psz_category;
255 playlist_item_t * p_parent = user_data;
256 playlist_t * p_playlist = p_parent->p_playlist;
258 msg_Dbg( p_playlist, "Adding %s in %s",
259 p_input->psz_name ? p_input->psz_name : "(null)",
260 psz_cat ? psz_cat : "(null)" );
263 /* If p_parent is in root category (this is clearly a hack) and we have a cat */
264 if( !EMPTY_STR(psz_cat) )
267 playlist_item_t * p_cat;
268 p_cat = playlist_ChildSearchName( p_parent, psz_cat );
271 p_cat = playlist_NodeCreate( p_playlist, psz_cat,
272 p_parent, PLAYLIST_END, 0, NULL );
273 p_cat->i_flags &= ~PLAYLIST_SKIP_FLAG;
278 playlist_NodeAddInput( p_playlist, p_input, p_parent,
279 PLAYLIST_APPEND, PLAYLIST_END,
284 /* A new item has been removed from a certain sd */
285 static void playlist_sd_item_removed( const vlc_event_t * p_event, void * user_data )
287 input_item_t * p_input = p_event->u.services_discovery_item_removed.p_item;
288 playlist_item_t * p_sd_node = user_data;
289 playlist_t *p_playlist = p_sd_node->p_playlist;
292 playlist_item_t *p_item =
293 playlist_ItemFindFromInputAndRoot( p_playlist, p_input,
299 playlist_item_t *p_parent = p_item->p_parent;
300 /* if the item was added under a category and the category node
301 becomes empty, delete that node as well */
302 if( p_parent->i_children > 1 || p_parent == p_sd_node )
303 playlist_DeleteItem( p_playlist, p_item, true );
305 playlist_NodeDelete( p_playlist, p_parent, true, true );
309 int playlist_ServicesDiscoveryAdd( playlist_t *p_playlist,
310 const char *psz_name )
312 /* Perform the addition */
313 services_discovery_t *p_sd;
315 msg_Dbg( p_playlist, "adding services_discovery %s...", psz_name );
316 p_sd = vlc_sd_Create( VLC_OBJECT(p_playlist), psz_name );
320 /* Free in playlist_ServicesDiscoveryRemove */
321 vlc_sd_internal_t * p_sds = malloc( sizeof(*p_sds) );
324 vlc_sd_Destroy( p_sd );
328 playlist_item_t *p_node;
330 /* Look for configuration chain "longname" */
331 const char *psz_longname = "?";
334 config_chain_t *cfg = p_sd->p_cfg;
337 if( cfg->psz_name && !strcmp( cfg->psz_name, "longname" ) )
339 psz_longname = cfg->psz_value;
347 p_node = playlist_NodeCreate( p_playlist, psz_longname,
348 p_playlist->p_root, PLAYLIST_END, 0, NULL );
351 vlc_event_manager_t *em = services_discovery_EventManager( p_sd );
352 vlc_event_attach( em, vlc_ServicesDiscoveryItemAdded,
353 playlist_sd_item_added, p_node );
355 vlc_event_attach( em, vlc_ServicesDiscoveryItemRemoved,
356 playlist_sd_item_removed, p_node );
358 if( !vlc_sd_Start( p_sd ) )
360 vlc_sd_Destroy( p_sd );
366 p_sds->p_node = p_node;
367 p_sds->psz_name = strdup( psz_name );
370 TAB_APPEND( pl_priv(p_playlist)->i_sds, pl_priv(p_playlist)->pp_sds, p_sds );
376 int playlist_ServicesDiscoveryRemove( playlist_t * p_playlist,
377 const char *psz_name )
379 playlist_private_t *priv = pl_priv( p_playlist );
380 vlc_sd_internal_t * p_sds = NULL;
383 for( int i = 0; i < priv->i_sds; i++ )
385 if( !strcmp( psz_name, priv->pp_sds[i]->psz_name ) )
387 p_sds = priv->pp_sds[i];
388 REMOVE_ELEM( priv->pp_sds, priv->i_sds, i );
396 msg_Warn( p_playlist, "discovery %s is not loaded", psz_name );
400 services_discovery_t *p_sd = p_sds->p_sd;
405 vlc_event_detach( services_discovery_EventManager( p_sd ),
406 vlc_ServicesDiscoveryItemAdded,
407 playlist_sd_item_added,
410 vlc_event_detach( services_discovery_EventManager( p_sd ),
411 vlc_ServicesDiscoveryItemRemoved,
412 playlist_sd_item_removed,
415 /* Remove the sd playlist node if it exists */
417 playlist_NodeDelete( p_playlist, p_sds->p_node, true, false );
420 vlc_sd_Destroy( p_sd );
421 free( p_sds->psz_name );
427 bool playlist_IsServicesDiscoveryLoaded( playlist_t * p_playlist,
428 const char *psz_name )
430 playlist_private_t *priv = pl_priv( p_playlist );
434 for( int i = 0; i < priv->i_sds; i++ )
436 vlc_sd_internal_t *sd = priv->pp_sds[i];
438 if( sd->psz_name && !strcmp( psz_name, sd->psz_name ) )
448 int playlist_ServicesDiscoveryControl( playlist_t *p_playlist, const char *psz_name, int i_control, ... )
450 playlist_private_t *priv = pl_priv( p_playlist );
451 int i_ret = VLC_EGENERIC;
455 for( i = 0; i < priv->i_sds; i++ )
457 vlc_sd_internal_t *sd = priv->pp_sds[i];
458 if( sd->psz_name && !strcmp( psz_name, sd->psz_name ) )
461 va_start( args, i_control );
462 i_ret = vlc_sd_control( sd->p_sd, i_control, args );
468 assert( i != priv->i_sds );
474 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist )
476 playlist_private_t *priv = pl_priv( p_playlist );
478 while( priv->i_sds > 0 )
479 playlist_ServicesDiscoveryRemove( p_playlist,
480 priv->pp_sds[0]->psz_name );