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 *****************************************************************************/
29 #include "vlc_playlist.h"
30 #include "vlc_events.h"
31 #include "playlist_internal.h"
33 static void RunSD( services_discovery_t *p_sd );
37 * Basically you just listen to Service discovery event through the
39 * That's how the playlist get's Service Discovery information
42 /***********************************************************************
44 ***********************************************************************/
45 char ** __services_discovery_GetServicesNames( vlc_object_t * p_super,
46 char ***pppsz_longnames )
48 return module_GetModulesNamesForCapability( p_super, "services_discovery",
52 /***********************************************************************
54 ***********************************************************************/
55 services_discovery_t *
56 services_discovery_Create ( vlc_object_t * p_super, const char * psz_module_name )
58 services_discovery_t *p_sd = vlc_object_create( p_super, VLC_OBJECT_SD );
63 p_sd->psz_localized_name = NULL;
65 vlc_event_manager_init( &p_sd->event_manager, p_sd, (vlc_object_t *)p_sd );
66 vlc_event_manager_register_event_type( &p_sd->event_manager,
67 vlc_ServicesDiscoveryItemAdded );
68 vlc_event_manager_register_event_type( &p_sd->event_manager,
69 vlc_ServicesDiscoveryItemRemoved );
70 vlc_event_manager_register_event_type( &p_sd->event_manager,
71 vlc_ServicesDiscoveryStarted );
72 vlc_event_manager_register_event_type( &p_sd->event_manager,
73 vlc_ServicesDiscoveryEnded );
75 p_sd->p_module = module_Need( p_sd, "services_discovery", psz_module_name, VLC_TRUE );
77 if( p_sd->p_module == NULL )
79 msg_Err( p_super, "no suitable services discovery module" );
80 vlc_object_release( p_sd );
83 p_sd->psz_module = strdup( psz_module_name );
84 p_sd->b_die = VLC_FALSE; /* FIXME */
86 vlc_object_attach( p_sd, p_super );
90 /***********************************************************************
92 ***********************************************************************/
93 void services_discovery_Destroy ( services_discovery_t * p_sd )
95 vlc_event_manager_fini( &p_sd->event_manager );
97 free( p_sd->psz_module );
98 free( p_sd->psz_localized_name );
100 vlc_object_detach( p_sd );
101 vlc_object_release( p_sd );
104 /***********************************************************************
106 ***********************************************************************/
107 int services_discovery_Start ( services_discovery_t * p_sd )
109 if ((p_sd->pf_run != NULL)
110 && vlc_thread_create( p_sd, "services_discovery", RunSD,
111 VLC_THREAD_PRIORITY_LOW, VLC_FALSE))
113 msg_Err( p_sd, "cannot create services discovery thread" );
114 vlc_object_release( p_sd );
120 /***********************************************************************
122 ***********************************************************************/
123 void services_discovery_Stop ( services_discovery_t * p_sd )
125 vlc_object_kill( p_sd );
126 if( p_sd->pf_run ) vlc_thread_join( p_sd );
128 module_Unneed( p_sd, p_sd->p_module );
131 /***********************************************************************
133 ***********************************************************************/
135 services_discovery_GetLocalizedName ( services_discovery_t * p_sd )
137 return p_sd->psz_localized_name ? strdup( p_sd->psz_localized_name ) : NULL;
140 /***********************************************************************
142 ***********************************************************************/
144 services_discovery_SetLocalizedName ( services_discovery_t * p_sd, const char *psz )
146 if(p_sd->psz_localized_name) free( p_sd->psz_localized_name );
147 p_sd->psz_localized_name = strdup(psz);
150 /***********************************************************************
152 ***********************************************************************/
153 vlc_event_manager_t *
154 services_discovery_EventManager ( services_discovery_t * p_sd )
156 return &p_sd->event_manager;
159 /***********************************************************************
161 ***********************************************************************/
163 services_discovery_AddItem ( services_discovery_t * p_sd, input_item_t * p_item,
164 const char * psz_category )
167 event.type = vlc_ServicesDiscoveryItemAdded;
168 event.u.services_discovery_item_added.p_new_item = p_item;
169 event.u.services_discovery_item_added.psz_category = psz_category;
171 vlc_event_send( &p_sd->event_manager, &event );
174 /***********************************************************************
176 ***********************************************************************/
178 services_discovery_RemoveItem ( services_discovery_t * p_sd, input_item_t * p_item )
181 event.type = vlc_ServicesDiscoveryItemRemoved;
182 event.u.services_discovery_item_removed.p_item = p_item;
184 vlc_event_send( &p_sd->event_manager, &event );
187 /***********************************************************************
189 ***********************************************************************/
190 static void RunSD( services_discovery_t *p_sd )
194 event.type = vlc_ServicesDiscoveryStarted;
195 vlc_event_send( &p_sd->event_manager, &event );
197 p_sd->pf_run( p_sd );
199 event.type = vlc_ServicesDiscoveryEnded;
200 vlc_event_send( &p_sd->event_manager, &event );
205 * Playlist - Services discovery bridge
208 /* A new item has been added to a certain sd */
209 static void playlist_sd_item_added( const vlc_event_t * p_event, void * user_data )
211 input_item_t * p_input = p_event->u.services_discovery_item_added.p_new_item;
212 const char * psz_cat = p_event->u.services_discovery_item_added.psz_category;
213 playlist_item_t *p_new_item, * p_parent = user_data;
215 msg_Dbg( p_parent->p_playlist, "Adding %s in %s",
216 p_input->psz_name ? p_input->psz_name : "(null)",
217 psz_cat ? psz_cat : "(null)" );
219 /* If p_parent is in root category (this is clearly a hack) and we have a cat */
220 if( !EMPTY_STR(psz_cat) &&
221 p_parent->p_parent == p_parent->p_playlist->p_root_category )
224 playlist_item_t * p_cat;
225 p_cat = playlist_ChildSearchName( p_parent, psz_cat );
228 p_cat = playlist_NodeCreate( p_parent->p_playlist, psz_cat,
230 p_cat->i_flags &= ~PLAYLIST_SKIP_FLAG;
235 p_new_item = playlist_NodeAddInput( p_parent->p_playlist, p_input, p_parent,
236 PLAYLIST_APPEND, PLAYLIST_END, VLC_FALSE );
239 p_new_item->i_flags &= ~PLAYLIST_SKIP_FLAG;
240 p_new_item->i_flags &= ~PLAYLIST_SAVE_FLAG;
244 /* A new item has been removed from a certain sd */
245 static void playlist_sd_item_removed( const vlc_event_t * p_event, void * user_data )
247 input_item_t * p_input = p_event->u.services_discovery_item_removed.p_item;
248 playlist_item_t * p_parent = user_data;
249 playlist_item_t * p_pl_item;
251 /* First make sure that if item is a node it will be deleted.
252 * XXX: Why don't we have a function to ensure that in the playlist code ? */
253 vlc_object_lock( p_parent->p_playlist );
254 p_pl_item = playlist_ItemFindFromInputAndRoot( p_parent->p_playlist,
255 p_input->i_id, p_parent, VLC_FALSE );
257 if( p_pl_item && p_pl_item->i_children > -1 )
259 playlist_NodeDelete( p_parent->p_playlist, p_pl_item, VLC_TRUE, VLC_FALSE );
260 vlc_object_unlock( p_parent->p_playlist );
263 vlc_object_unlock( p_parent->p_playlist );
265 /* Delete the non-node item normally */
266 playlist_DeleteInputInParent( p_parent->p_playlist, p_input->i_id,
267 p_parent, VLC_FALSE );
270 int playlist_ServicesDiscoveryAdd( playlist_t *p_playlist, const char *psz_modules )
272 const char *psz_parser = psz_modules ?: "";
273 int retval = VLC_SUCCESS;
277 struct playlist_services_discovery_support_t * p_sds;
278 playlist_item_t * p_cat;
279 playlist_item_t * p_one;
281 while( *psz_parser == ' ' || *psz_parser == ':' || *psz_parser == ',' )
284 if( *psz_parser == '\0' )
287 const char *psz_next = strchr( psz_parser, ':' );
288 if( psz_next == NULL )
289 psz_next = psz_parser + strlen( psz_parser );
291 char psz_plugin[psz_next - psz_parser + 1];
292 memcpy (psz_plugin, psz_parser, sizeof (psz_plugin) - 1);
293 psz_plugin[sizeof (psz_plugin) - 1] = '\0';
294 psz_parser = psz_next;
296 /* Perform the addition */
297 msg_Dbg( p_playlist, "Add services_discovery %s", psz_plugin );
298 services_discovery_t *p_sd;
300 p_sd = services_discovery_Create( (vlc_object_t*)p_playlist, psz_plugin );
304 char * psz = services_discovery_GetLocalizedName( p_sd );
306 playlist_NodesPairCreate( p_playlist, psz,
307 &p_cat, &p_one, VLC_FALSE );
310 vlc_event_attach( services_discovery_EventManager( p_sd ),
311 vlc_ServicesDiscoveryItemAdded,
312 playlist_sd_item_added,
315 vlc_event_attach( services_discovery_EventManager( p_sd ),
316 vlc_ServicesDiscoveryItemAdded,
317 playlist_sd_item_added,
320 vlc_event_attach( services_discovery_EventManager( p_sd ),
321 vlc_ServicesDiscoveryItemRemoved,
322 playlist_sd_item_removed,
325 vlc_event_attach( services_discovery_EventManager( p_sd ),
326 vlc_ServicesDiscoveryItemRemoved,
327 playlist_sd_item_removed,
330 services_discovery_Start( p_sd );
332 /* Free in playlist_ServicesDiscoveryRemove */
333 p_sds = malloc( sizeof(struct playlist_services_discovery_support_t) );
336 msg_Err( p_playlist, "No more memory" );
340 p_sds->p_one = p_one;
341 p_sds->p_cat = p_cat;
344 TAB_APPEND( p_playlist->i_sds, p_playlist->pp_sds, p_sds );
351 int playlist_ServicesDiscoveryRemove( playlist_t * p_playlist,
352 const char *psz_module )
354 struct playlist_services_discovery_support_t * p_sds = NULL;
358 for( i = 0 ; i< p_playlist->i_sds ; i ++ )
360 if( !strcmp( psz_module, p_playlist->pp_sds[i]->p_sd->psz_module ) )
362 p_sds = p_playlist->pp_sds[i];
363 REMOVE_ELEM( p_playlist->pp_sds, p_playlist->i_sds, i );
369 if( !p_sds || !p_sds->p_sd )
371 msg_Warn( p_playlist, "module %s is not loaded", psz_module );
375 services_discovery_Stop( p_sds->p_sd );
377 vlc_event_detach( services_discovery_EventManager( p_sds->p_sd ),
378 vlc_ServicesDiscoveryItemAdded,
379 playlist_sd_item_added,
382 vlc_event_detach( services_discovery_EventManager( p_sds->p_sd ),
383 vlc_ServicesDiscoveryItemAdded,
384 playlist_sd_item_added,
387 vlc_event_detach( services_discovery_EventManager( p_sds->p_sd ),
388 vlc_ServicesDiscoveryItemRemoved,
389 playlist_sd_item_removed,
392 vlc_event_detach( services_discovery_EventManager( p_sds->p_sd ),
393 vlc_ServicesDiscoveryItemRemoved,
394 playlist_sd_item_removed,
397 /* Remove the sd playlist node if it exists */
399 if( p_sds->p_cat != p_playlist->p_root_category &&
400 p_sds->p_one != p_playlist->p_root_onelevel )
402 playlist_NodeDelete( p_playlist, p_sds->p_cat, VLC_TRUE, VLC_FALSE );
403 playlist_NodeDelete( p_playlist, p_sds->p_one, VLC_TRUE, VLC_FALSE );
407 services_discovery_Destroy( p_sds->p_sd );
412 vlc_bool_t playlist_IsServicesDiscoveryLoaded( playlist_t * p_playlist,
413 const char *psz_module )
418 for( i = 0 ; i< p_playlist->i_sds ; i ++ )
420 if( !strcmp( psz_module, p_playlist->pp_sds[i]->p_sd->psz_module ) )