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 "playlist_internal.h"
33 #include "../libvlc.h"
36 static void services_discovery_Destructor ( vlc_object_t *p_obj );
40 * Basically you just listen to Service discovery event through the
42 * That's how the playlist get's Service Discovery information
46 * Gets the list of available services discovery plugins.
48 char **vlc_sd_GetNames( char ***pppsz_longnames )
50 return module_GetModulesNamesForCapability( "services_discovery",
54 /***********************************************************************
56 ***********************************************************************/
57 services_discovery_t *vlc_sd_Create( vlc_object_t *p_super )
59 services_discovery_t *p_sd;
61 p_sd = vlc_custom_create( p_super, sizeof( *p_sd ), VLC_OBJECT_GENERIC,
62 "services discovery" );
66 vlc_event_manager_init( &p_sd->event_manager, p_sd, (vlc_object_t *)p_sd );
67 vlc_event_manager_register_event_type( &p_sd->event_manager,
68 vlc_ServicesDiscoveryItemAdded );
69 vlc_event_manager_register_event_type( &p_sd->event_manager,
70 vlc_ServicesDiscoveryItemRemoved );
71 vlc_event_manager_register_event_type( &p_sd->event_manager,
72 vlc_ServicesDiscoveryStarted );
73 vlc_event_manager_register_event_type( &p_sd->event_manager,
74 vlc_ServicesDiscoveryEnded );
76 vlc_object_set_destructor( p_sd, services_discovery_Destructor );
77 vlc_object_attach( p_sd, p_super );
82 /***********************************************************************
84 ***********************************************************************/
85 bool vlc_sd_Start ( services_discovery_t * p_sd, const char *module )
87 assert(!p_sd->p_module);
89 p_sd->p_module = module_need( p_sd, "services_discovery", module, true );
91 if( p_sd->p_module == NULL )
93 msg_Err( p_sd, "no suitable services discovery module" );
98 .type = vlc_ServicesDiscoveryStarted
100 vlc_event_send( &p_sd->event_manager, &event );
104 /***********************************************************************
106 ***********************************************************************/
107 void vlc_sd_Stop ( services_discovery_t * p_sd )
109 vlc_event_t event = {
110 .type = vlc_ServicesDiscoveryEnded
113 vlc_event_send( &p_sd->event_manager, &event );
115 module_unneed( p_sd, p_sd->p_module );
116 p_sd->p_module = NULL;
119 /***********************************************************************
121 ***********************************************************************/
122 static void services_discovery_Destructor ( vlc_object_t *p_obj )
124 services_discovery_t * p_sd = (services_discovery_t *)p_obj;
125 assert(!p_sd->p_module); /* Forgot to call Stop */
126 vlc_event_manager_fini( &p_sd->event_manager );
129 /***********************************************************************
131 ***********************************************************************/
133 services_discovery_GetLocalizedName ( services_discovery_t * p_sd )
135 return strdup( module_get_name( p_sd->p_module, true ) );
138 /***********************************************************************
140 ***********************************************************************/
141 vlc_event_manager_t *
142 services_discovery_EventManager ( services_discovery_t * p_sd )
144 return &p_sd->event_manager;
147 /***********************************************************************
149 ***********************************************************************/
151 services_discovery_AddItem ( services_discovery_t * p_sd, input_item_t * p_item,
152 const char * psz_category )
155 event.type = vlc_ServicesDiscoveryItemAdded;
156 event.u.services_discovery_item_added.p_new_item = p_item;
157 event.u.services_discovery_item_added.psz_category = psz_category;
159 vlc_event_send( &p_sd->event_manager, &event );
162 /***********************************************************************
164 ***********************************************************************/
166 services_discovery_RemoveItem ( services_discovery_t * p_sd, input_item_t * p_item )
169 event.type = vlc_ServicesDiscoveryItemRemoved;
170 event.u.services_discovery_item_removed.p_item = p_item;
172 vlc_event_send( &p_sd->event_manager, &event );
176 * Playlist - Services discovery bridge
179 /* A new item has been added to a certain sd */
180 static void playlist_sd_item_added( const vlc_event_t * p_event, void * user_data )
182 input_item_t * p_input = p_event->u.services_discovery_item_added.p_new_item;
183 const char * psz_cat = p_event->u.services_discovery_item_added.psz_category;
184 playlist_item_t *p_new_item, * p_parent = user_data;
185 playlist_t * p_playlist = p_parent->p_playlist;
187 msg_Dbg( p_playlist, "Adding %s in %s",
188 p_input->psz_name ? p_input->psz_name : "(null)",
189 psz_cat ? psz_cat : "(null)" );
192 /* If p_parent is in root category (this is clearly a hack) and we have a cat */
193 if( !EMPTY_STR(psz_cat) &&
194 p_parent->p_parent == p_playlist->p_root_category )
197 playlist_item_t * p_cat;
198 p_cat = playlist_ChildSearchName( p_parent, psz_cat );
201 p_cat = playlist_NodeCreate( p_playlist, psz_cat,
203 p_cat->i_flags &= ~PLAYLIST_SKIP_FLAG;
208 p_new_item = playlist_NodeAddInput( p_playlist, p_input, p_parent,
209 PLAYLIST_APPEND, PLAYLIST_END, pl_Locked );
212 p_new_item->i_flags &= ~PLAYLIST_SKIP_FLAG;
213 p_new_item->i_flags &= ~PLAYLIST_SAVE_FLAG;
218 /* A new item has been removed from a certain sd */
219 static void playlist_sd_item_removed( const vlc_event_t * p_event, void * user_data )
221 input_item_t * p_input = p_event->u.services_discovery_item_removed.p_item;
222 playlist_item_t * p_parent = user_data;
223 playlist_item_t * p_pl_item;
225 /* First make sure that if item is a node it will be deleted.
226 * XXX: Why don't we have a function to ensure that in the playlist code ? */
227 playlist_Lock( p_parent->p_playlist );
228 p_pl_item = playlist_ItemFindFromInputAndRoot( p_parent->p_playlist,
229 p_input, p_parent, false );
231 if( p_pl_item && p_pl_item->i_children > -1 )
232 playlist_NodeDelete( p_parent->p_playlist, p_pl_item, true, false );
234 /* Delete the non-node item normally */
235 playlist_DeleteFromInputInParent( p_parent->p_playlist, p_input,
236 p_parent, pl_Locked );
238 playlist_Unlock( p_parent->p_playlist );
241 int playlist_ServicesDiscoveryAdd( playlist_t *p_playlist, const char *psz_module )
243 /* Perform the addition */
244 msg_Dbg( p_playlist, "adding services_discovery %s...", psz_module );
246 services_discovery_t *p_sd = vlc_sd_Create( VLC_OBJECT(p_playlist) );
250 module_t *m = module_find_by_shortcut( psz_module );
253 msg_Err( p_playlist, "No such module: %s", psz_module );
254 vlc_sd_Destroy( p_sd );
258 /* Free in playlist_ServicesDiscoveryRemove */
259 struct playlist_services_discovery_support_t * p_sds;
260 p_sds = malloc( sizeof(struct playlist_services_discovery_support_t) );
263 vlc_sd_Destroy( p_sd );
268 playlist_item_t * p_cat;
269 playlist_item_t * p_one;
272 playlist_NodesPairCreate( p_playlist, module_get_name( m, true ),
273 &p_cat, &p_one, false );
277 vlc_event_attach( services_discovery_EventManager( p_sd ),
278 vlc_ServicesDiscoveryItemAdded,
279 playlist_sd_item_added, p_one );
281 vlc_event_attach( services_discovery_EventManager( p_sd ),
282 vlc_ServicesDiscoveryItemAdded,
283 playlist_sd_item_added, p_cat );
285 vlc_event_attach( services_discovery_EventManager( p_sd ),
286 vlc_ServicesDiscoveryItemRemoved,
287 playlist_sd_item_removed, p_one );
289 vlc_event_attach( services_discovery_EventManager( p_sd ),
290 vlc_ServicesDiscoveryItemRemoved,
291 playlist_sd_item_removed, p_cat );
293 if( !vlc_sd_Start( p_sd, psz_module ) )
295 vlc_sd_Destroy( p_sd );
300 /* We want tree-view for service directory */
301 p_one->p_input->b_prefers_tree = true;
303 p_sds->p_one = p_one;
304 p_sds->p_cat = p_cat;
305 p_sds->psz_name = strdup( psz_module );
308 TAB_APPEND( pl_priv(p_playlist)->i_sds, pl_priv(p_playlist)->pp_sds, p_sds );
314 int playlist_ServicesDiscoveryRemove( playlist_t * p_playlist,
315 const char *psz_name )
317 playlist_private_t *priv = pl_priv( p_playlist );
318 struct playlist_services_discovery_support_t * p_sds = NULL;
321 for( int i = 0; i < priv->i_sds; i++ )
323 if( !strcmp( psz_name, priv->pp_sds[i]->psz_name ) )
325 p_sds = priv->pp_sds[i];
326 REMOVE_ELEM( priv->pp_sds, priv->i_sds, i );
334 msg_Warn( p_playlist, "discovery %s is not loaded", psz_name );
338 services_discovery_t *p_sd = p_sds->p_sd;
343 vlc_event_detach( services_discovery_EventManager( p_sd ),
344 vlc_ServicesDiscoveryItemAdded,
345 playlist_sd_item_added,
348 vlc_event_detach( services_discovery_EventManager( p_sd ),
349 vlc_ServicesDiscoveryItemAdded,
350 playlist_sd_item_added,
353 vlc_event_detach( services_discovery_EventManager( p_sd ),
354 vlc_ServicesDiscoveryItemRemoved,
355 playlist_sd_item_removed,
358 vlc_event_detach( services_discovery_EventManager( p_sd ),
359 vlc_ServicesDiscoveryItemRemoved,
360 playlist_sd_item_removed,
363 /* Remove the sd playlist node if it exists */
365 if( p_sds->p_cat != p_playlist->p_root_category &&
366 p_sds->p_one != p_playlist->p_root_onelevel )
368 playlist_NodeDelete( p_playlist, p_sds->p_cat, true, false );
369 playlist_NodeDelete( p_playlist, p_sds->p_one, true, false );
373 vlc_sd_Destroy( p_sd );
374 free( p_sds->psz_name );
380 bool playlist_IsServicesDiscoveryLoaded( playlist_t * p_playlist,
381 const char *psz_name )
383 playlist_private_t *priv = pl_priv( p_playlist );
387 for( int i = 0; i < priv->i_sds; i++ )
389 vlc_sd_internal_t *sd = priv->pp_sds[i];
391 if( sd->psz_name && !strcmp( psz_name, sd->psz_name ) )
401 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist )
403 playlist_private_t *priv = pl_priv( p_playlist );
405 while( priv->i_sds > 0 )
406 playlist_ServicesDiscoveryRemove( p_playlist,
407 priv->pp_sds[0]->psz_name );