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 "playlist_internal.h"
32 #include "../libvlc.h"
34 static void* RunSD( vlc_object_t *p_this );
38 * Basically you just listen to Service discovery event through the
40 * That's how the playlist get's Service Discovery information
43 /***********************************************************************
45 ***********************************************************************/
46 char ** __services_discovery_GetServicesNames( vlc_object_t * p_super,
47 char ***pppsz_longnames )
49 return module_GetModulesNamesForCapability( p_super, "services_discovery",
53 /***********************************************************************
55 ***********************************************************************/
56 services_discovery_t *
57 services_discovery_Create ( vlc_object_t * p_super, const char * psz_module_name )
59 services_discovery_t *p_sd;
60 p_sd = vlc_custom_create( p_super, sizeof( *p_sd ), VLC_OBJECT_GENERIC,
61 "services discovery" );
66 p_sd->psz_localized_name = NULL;
68 vlc_event_manager_init( &p_sd->event_manager, p_sd, (vlc_object_t *)p_sd );
69 vlc_event_manager_register_event_type( &p_sd->event_manager,
70 vlc_ServicesDiscoveryItemAdded );
71 vlc_event_manager_register_event_type( &p_sd->event_manager,
72 vlc_ServicesDiscoveryItemRemoved );
73 vlc_event_manager_register_event_type( &p_sd->event_manager,
74 vlc_ServicesDiscoveryStarted );
75 vlc_event_manager_register_event_type( &p_sd->event_manager,
76 vlc_ServicesDiscoveryEnded );
78 p_sd->p_module = module_Need( p_sd, "services_discovery", psz_module_name, true );
80 if( p_sd->p_module == NULL )
82 msg_Err( p_super, "no suitable services discovery module" );
83 vlc_object_release( p_sd );
86 p_sd->psz_module = strdup( psz_module_name );
87 p_sd->b_die = false; /* FIXME */
89 vlc_object_attach( p_sd, p_super );
93 /***********************************************************************
95 ***********************************************************************/
96 void services_discovery_Destroy ( services_discovery_t * p_sd )
98 vlc_event_manager_fini( &p_sd->event_manager );
100 free( p_sd->psz_module );
101 free( p_sd->psz_localized_name );
103 vlc_object_detach( p_sd );
104 vlc_object_release( p_sd );
107 /***********************************************************************
109 ***********************************************************************/
110 int services_discovery_Start ( services_discovery_t * p_sd )
112 vlc_event_t event = {
113 .type = vlc_ServicesDiscoveryStarted
115 vlc_event_send( &p_sd->event_manager, &event );
117 if ((p_sd->pf_run != NULL)
118 && vlc_thread_create( p_sd, "services_discovery", RunSD,
119 VLC_THREAD_PRIORITY_LOW, false))
121 msg_Err( p_sd, "cannot create services discovery thread" );
122 vlc_object_release( p_sd );
128 /***********************************************************************
130 ***********************************************************************/
131 static void ObjectKillChildrens( vlc_object_t *p_obj )
135 vlc_object_kill( p_obj );
137 p_list = vlc_list_children( p_obj );
138 for( i = 0; i < p_list->i_count; i++ )
139 ObjectKillChildrens( p_list->p_values[i].p_object );
140 vlc_list_release( p_list );
143 void services_discovery_Stop ( services_discovery_t * p_sd )
145 vlc_event_t event = {
146 .type = vlc_ServicesDiscoveryEnded
149 ObjectKillChildrens( VLC_OBJECT(p_sd) );
150 if( p_sd->pf_run ) vlc_thread_join( p_sd );
152 vlc_event_send( &p_sd->event_manager, &event );
153 module_Unneed( p_sd, p_sd->p_module );
156 /***********************************************************************
158 ***********************************************************************/
160 services_discovery_GetLocalizedName ( services_discovery_t * p_sd )
162 return p_sd->psz_localized_name ? strdup( p_sd->psz_localized_name ) : NULL;
165 /***********************************************************************
167 ***********************************************************************/
169 services_discovery_SetLocalizedName ( services_discovery_t * p_sd, const char *psz )
171 free( p_sd->psz_localized_name );
172 p_sd->psz_localized_name = strdup(psz);
175 /***********************************************************************
177 ***********************************************************************/
178 vlc_event_manager_t *
179 services_discovery_EventManager ( services_discovery_t * p_sd )
181 return &p_sd->event_manager;
184 /***********************************************************************
186 ***********************************************************************/
188 services_discovery_AddItem ( services_discovery_t * p_sd, input_item_t * p_item,
189 const char * psz_category )
192 event.type = vlc_ServicesDiscoveryItemAdded;
193 event.u.services_discovery_item_added.p_new_item = p_item;
194 event.u.services_discovery_item_added.psz_category = psz_category;
196 vlc_event_send( &p_sd->event_manager, &event );
199 /***********************************************************************
201 ***********************************************************************/
203 services_discovery_RemoveItem ( services_discovery_t * p_sd, input_item_t * p_item )
206 event.type = vlc_ServicesDiscoveryItemRemoved;
207 event.u.services_discovery_item_removed.p_item = p_item;
209 vlc_event_send( &p_sd->event_manager, &event );
212 /***********************************************************************
214 ***********************************************************************/
215 static void* RunSD( vlc_object_t *p_this )
217 services_discovery_t *p_sd = (services_discovery_t *)p_this;
218 p_sd->pf_run( p_sd );
223 * Playlist - Services discovery bridge
226 /* A new item has been added to a certain sd */
227 static void playlist_sd_item_added( const vlc_event_t * p_event, void * user_data )
229 input_item_t * p_input = p_event->u.services_discovery_item_added.p_new_item;
230 const char * psz_cat = p_event->u.services_discovery_item_added.psz_category;
231 playlist_item_t *p_new_item, * p_parent = user_data;
232 playlist_t * p_playlist = p_parent->p_playlist;
234 msg_Dbg( p_playlist, "Adding %s in %s",
235 p_input->psz_name ? p_input->psz_name : "(null)",
236 psz_cat ? psz_cat : "(null)" );
239 /* If p_parent is in root category (this is clearly a hack) and we have a cat */
240 if( !EMPTY_STR(psz_cat) &&
241 p_parent->p_parent == p_playlist->p_root_category )
244 playlist_item_t * p_cat;
245 p_cat = playlist_ChildSearchName( p_parent, psz_cat );
248 p_cat = playlist_NodeCreate( p_playlist, psz_cat,
250 p_cat->i_flags &= ~PLAYLIST_SKIP_FLAG;
255 p_new_item = playlist_NodeAddInput( p_playlist, p_input, p_parent,
256 PLAYLIST_APPEND, PLAYLIST_END, pl_Locked );
259 p_new_item->i_flags &= ~PLAYLIST_SKIP_FLAG;
260 p_new_item->i_flags &= ~PLAYLIST_SAVE_FLAG;
265 /* A new item has been removed from a certain sd */
266 static void playlist_sd_item_removed( const vlc_event_t * p_event, void * user_data )
268 input_item_t * p_input = p_event->u.services_discovery_item_removed.p_item;
269 playlist_item_t * p_parent = user_data;
270 playlist_item_t * p_pl_item;
272 /* First make sure that if item is a node it will be deleted.
273 * XXX: Why don't we have a function to ensure that in the playlist code ? */
274 vlc_object_lock( p_parent->p_playlist );
275 p_pl_item = playlist_ItemFindFromInputAndRoot( p_parent->p_playlist,
276 p_input->i_id, p_parent, false );
278 if( p_pl_item && p_pl_item->i_children > -1 )
280 playlist_NodeDelete( p_parent->p_playlist, p_pl_item, true, false );
281 vlc_object_unlock( p_parent->p_playlist );
285 /* Delete the non-node item normally */
286 playlist_DeleteFromInputInParent( p_parent->p_playlist, p_input->i_id,
287 p_parent, pl_Locked );
289 vlc_object_unlock( p_parent->p_playlist );
292 int playlist_ServicesDiscoveryAdd( playlist_t *p_playlist, const char *psz_modules )
294 const char *psz_parser = psz_modules ?: "";
295 int retval = VLC_SUCCESS;
299 struct playlist_services_discovery_support_t * p_sds;
300 playlist_item_t * p_cat;
301 playlist_item_t * p_one;
303 while( *psz_parser == ' ' || *psz_parser == ':' || *psz_parser == ',' )
306 if( *psz_parser == '\0' )
309 const char *psz_next = strchr( psz_parser, ':' );
310 if( psz_next == NULL )
311 psz_next = psz_parser + strlen( psz_parser );
313 char psz_plugin[psz_next - psz_parser + 1];
314 memcpy (psz_plugin, psz_parser, sizeof (psz_plugin) - 1);
315 psz_plugin[sizeof (psz_plugin) - 1] = '\0';
316 psz_parser = psz_next;
318 /* Perform the addition */
319 msg_Dbg( p_playlist, "Add services_discovery %s", psz_plugin );
320 services_discovery_t *p_sd;
322 p_sd = services_discovery_Create( (vlc_object_t*)p_playlist, psz_plugin );
326 char * psz = services_discovery_GetLocalizedName( p_sd );
329 playlist_NodesPairCreate( p_playlist, psz,
330 &p_cat, &p_one, false );
334 vlc_event_attach( services_discovery_EventManager( p_sd ),
335 vlc_ServicesDiscoveryItemAdded,
336 playlist_sd_item_added,
339 vlc_event_attach( services_discovery_EventManager( p_sd ),
340 vlc_ServicesDiscoveryItemAdded,
341 playlist_sd_item_added,
344 vlc_event_attach( services_discovery_EventManager( p_sd ),
345 vlc_ServicesDiscoveryItemRemoved,
346 playlist_sd_item_removed,
349 vlc_event_attach( services_discovery_EventManager( p_sd ),
350 vlc_ServicesDiscoveryItemRemoved,
351 playlist_sd_item_removed,
354 services_discovery_Start( p_sd );
356 /* Free in playlist_ServicesDiscoveryRemove */
357 p_sds = malloc( sizeof(struct playlist_services_discovery_support_t) );
361 /* We want tree-view for service directory */
362 p_one->p_input->b_prefers_tree = true;
364 p_sds->p_one = p_one;
365 p_sds->p_cat = p_cat;
368 TAB_APPEND( p_playlist->i_sds, p_playlist->pp_sds, p_sds );
375 int playlist_ServicesDiscoveryRemove( playlist_t * p_playlist,
376 const char *psz_module )
378 struct playlist_services_discovery_support_t * p_sds = NULL;
382 for( i = 0 ; i< p_playlist->i_sds ; i ++ )
384 if( !strcmp( psz_module, p_playlist->pp_sds[i]->p_sd->psz_module ) )
386 p_sds = p_playlist->pp_sds[i];
387 REMOVE_ELEM( p_playlist->pp_sds, p_playlist->i_sds, i );
393 if( !p_sds || !p_sds->p_sd )
395 msg_Warn( p_playlist, "module %s is not loaded", psz_module );
399 services_discovery_Stop( p_sds->p_sd );
401 vlc_event_detach( services_discovery_EventManager( p_sds->p_sd ),
402 vlc_ServicesDiscoveryItemAdded,
403 playlist_sd_item_added,
406 vlc_event_detach( services_discovery_EventManager( p_sds->p_sd ),
407 vlc_ServicesDiscoveryItemAdded,
408 playlist_sd_item_added,
411 vlc_event_detach( services_discovery_EventManager( p_sds->p_sd ),
412 vlc_ServicesDiscoveryItemRemoved,
413 playlist_sd_item_removed,
416 vlc_event_detach( services_discovery_EventManager( p_sds->p_sd ),
417 vlc_ServicesDiscoveryItemRemoved,
418 playlist_sd_item_removed,
421 /* Remove the sd playlist node if it exists */
423 if( p_sds->p_cat != p_playlist->p_root_category &&
424 p_sds->p_one != p_playlist->p_root_onelevel )
426 playlist_NodeDelete( p_playlist, p_sds->p_cat, true, false );
427 playlist_NodeDelete( p_playlist, p_sds->p_one, true, false );
431 services_discovery_Destroy( p_sds->p_sd );
437 bool playlist_IsServicesDiscoveryLoaded( playlist_t * p_playlist,
438 const char *psz_module )
443 for( i = 0 ; i< p_playlist->i_sds ; i ++ )
445 if( !strcmp( psz_module, p_playlist->pp_sds[i]->p_sd->psz_module ) )
455 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist )
457 while( p_playlist->i_sds > 0 )
458 playlist_ServicesDiscoveryRemove( p_playlist,
459 p_playlist->pp_sds[0]->p_sd->psz_module );