]> git.sesse.net Git - vlc/blob - src/playlist/services_discovery.c
service_discovery: Remove an uneeded hack.
[vlc] / src / playlist / services_discovery.c
1 /*****************************************************************************
2  * services_discovery.c : Manage playlist services_discovery modules
3  *****************************************************************************
4  * Copyright (C) 1999-2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23 #ifdef HAVE_CONFIG_H
24 # include "config.h"
25 #endif
26 #include <assert.h>
27
28 #include <vlc_common.h>
29 #include "vlc_playlist.h"
30 #include "vlc_events.h"
31 #include "playlist_internal.h"
32 #include "../libvlc.h"
33
34 static void RunSD( services_discovery_t *p_sd );
35
36 /*
37  * Services discovery
38  * Basically you just listen to Service discovery event through the
39  * sd's event manager.
40  * That's how the playlist get's Service Discovery information
41  */
42
43 /***********************************************************************
44  * GetServicesNames
45  ***********************************************************************/
46 char ** __services_discovery_GetServicesNames( vlc_object_t * p_super,
47                                                char ***pppsz_longnames )
48 {
49     return module_GetModulesNamesForCapability( p_super, "services_discovery",
50                                                 pppsz_longnames );
51 }
52
53 /***********************************************************************
54  * Create
55  ***********************************************************************/
56 services_discovery_t *
57 services_discovery_Create ( vlc_object_t * p_super, const char * psz_module_name )
58 {
59     services_discovery_t *p_sd;
60     p_sd = vlc_custom_create( p_super, sizeof( *p_sd ), VLC_OBJECT_GENERIC,
61                               "services discovery" );
62     if( !p_sd )
63         return NULL;
64
65     p_sd->pf_run = NULL;
66     p_sd->psz_localized_name = NULL;
67
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 );
77
78     p_sd->p_module = module_Need( p_sd, "services_discovery", psz_module_name, true );
79
80     if( p_sd->p_module == NULL )
81     {
82         msg_Err( p_super, "no suitable services discovery module" );
83         vlc_object_release( p_sd );
84         return NULL;
85     }
86     p_sd->psz_module = strdup( psz_module_name );
87     p_sd->b_die = false; /* FIXME */
88
89     vlc_object_attach( p_sd, p_super );
90     return p_sd;
91 }
92
93 /***********************************************************************
94  * Destroy
95  ***********************************************************************/
96 void services_discovery_Destroy ( services_discovery_t * p_sd )
97 {
98     vlc_event_manager_fini( &p_sd->event_manager );
99
100     free( p_sd->psz_module );
101     free( p_sd->psz_localized_name );
102
103     vlc_object_detach( p_sd );
104     vlc_object_release( p_sd );
105 }
106
107 /***********************************************************************
108  * Start
109  ***********************************************************************/
110 int services_discovery_Start ( services_discovery_t * p_sd )
111 {
112     if ((p_sd->pf_run != NULL)
113         && vlc_thread_create( p_sd, "services_discovery", RunSD,
114                               VLC_THREAD_PRIORITY_LOW, false))
115     {
116         msg_Err( p_sd, "cannot create services discovery thread" );
117         vlc_object_release( p_sd );
118         return VLC_EGENERIC;
119     }
120     return VLC_SUCCESS;
121 }
122
123 /***********************************************************************
124  * Stop
125  ***********************************************************************/
126 void services_discovery_Stop ( services_discovery_t * p_sd )
127 {
128     vlc_object_kill( p_sd );
129     if( p_sd->pf_run ) vlc_thread_join( p_sd );
130
131     module_Unneed( p_sd, p_sd->p_module );
132 }
133
134 /***********************************************************************
135  * GetLocalizedName
136  ***********************************************************************/
137 char *
138 services_discovery_GetLocalizedName ( services_discovery_t * p_sd )
139 {
140     return p_sd->psz_localized_name ? strdup( p_sd->psz_localized_name ) : NULL;
141 }
142
143 /***********************************************************************
144  * SetLocalizedName
145  ***********************************************************************/
146 void
147 services_discovery_SetLocalizedName ( services_discovery_t * p_sd, const char *psz )
148 {
149     free( p_sd->psz_localized_name );
150     p_sd->psz_localized_name = strdup(psz);
151 }
152
153 /***********************************************************************
154  * EventManager
155  ***********************************************************************/
156 vlc_event_manager_t *
157 services_discovery_EventManager ( services_discovery_t * p_sd )
158 {
159     return &p_sd->event_manager;
160 }
161
162 /***********************************************************************
163  * AddItem
164  ***********************************************************************/
165 void
166 services_discovery_AddItem ( services_discovery_t * p_sd, input_item_t * p_item,
167                              const char * psz_category )
168 {
169     vlc_event_t event;
170     event.type = vlc_ServicesDiscoveryItemAdded;
171     event.u.services_discovery_item_added.p_new_item = p_item;
172     event.u.services_discovery_item_added.psz_category = psz_category;
173
174     vlc_event_send( &p_sd->event_manager, &event );
175 }
176
177 /***********************************************************************
178  * RemoveItem
179  ***********************************************************************/
180 void
181 services_discovery_RemoveItem ( services_discovery_t * p_sd, input_item_t * p_item )
182 {
183     vlc_event_t event;
184     event.type = vlc_ServicesDiscoveryItemRemoved;
185     event.u.services_discovery_item_removed.p_item = p_item;
186
187     vlc_event_send( &p_sd->event_manager, &event );
188 }
189
190 /***********************************************************************
191  * RunSD (Private)
192  ***********************************************************************/
193 static void RunSD( services_discovery_t *p_sd )
194 {
195     vlc_event_t event;
196
197     event.type = vlc_ServicesDiscoveryStarted;
198     vlc_event_send( &p_sd->event_manager, &event );
199
200     p_sd->pf_run( p_sd );
201
202     event.type = vlc_ServicesDiscoveryEnded;
203     vlc_event_send( &p_sd->event_manager, &event );
204     return;
205 }
206
207 /*
208  * Playlist - Services discovery bridge
209  */
210
211  /* A new item has been added to a certain sd */
212 static void playlist_sd_item_added( const vlc_event_t * p_event, void * user_data )
213 {
214     input_item_t * p_input = p_event->u.services_discovery_item_added.p_new_item;
215     const char * psz_cat = p_event->u.services_discovery_item_added.psz_category;
216     playlist_item_t *p_new_item, * p_parent = user_data;
217
218     msg_Dbg( p_parent->p_playlist, "Adding %s in %s",
219                 p_input->psz_name ? p_input->psz_name : "(null)",
220                 psz_cat ? psz_cat : "(null)" );
221
222     p_new_item = playlist_NodeAddInput( p_parent->p_playlist, p_input, p_parent,
223                                         PLAYLIST_APPEND, PLAYLIST_END, false );
224     if( p_new_item )
225     {
226         p_new_item->i_flags &= ~PLAYLIST_SKIP_FLAG;
227         p_new_item->i_flags &= ~PLAYLIST_SAVE_FLAG;
228     }
229 }
230
231  /* A new item has been removed from a certain sd */
232 static void playlist_sd_item_removed( const vlc_event_t * p_event, void * user_data )
233 {
234     input_item_t * p_input = p_event->u.services_discovery_item_removed.p_item;
235     playlist_item_t * p_parent = user_data;
236     playlist_item_t * p_pl_item;
237
238     /* First make sure that if item is a node it will be deleted.
239      * XXX: Why don't we have a function to ensure that in the playlist code ? */
240     vlc_object_lock( p_parent->p_playlist );
241     p_pl_item = playlist_ItemFindFromInputAndRoot( p_parent->p_playlist,
242             p_input->i_id, p_parent, false );
243
244     if( p_pl_item && p_pl_item->i_children > -1 )
245     {
246         playlist_NodeDelete( p_parent->p_playlist, p_pl_item, true, false );
247         vlc_object_unlock( p_parent->p_playlist );
248         return;
249     }
250     vlc_object_unlock( p_parent->p_playlist );
251
252     /* Delete the non-node item normally */
253     playlist_DeleteInputInParent( p_parent->p_playlist, p_input->i_id,
254                                   p_parent, false );
255 }
256
257 int playlist_ServicesDiscoveryAdd( playlist_t *p_playlist,  const char *psz_modules )
258 {
259     const char *psz_parser = psz_modules ?: "";
260     int retval = VLC_SUCCESS;
261
262     for (;;)
263     {
264         struct playlist_services_discovery_support_t * p_sds;
265         playlist_item_t * p_cat;
266         playlist_item_t * p_one;
267
268         while( *psz_parser == ' ' || *psz_parser == ':' || *psz_parser == ',' )
269             psz_parser++;
270
271         if( *psz_parser == '\0' )
272             break;
273
274         const char *psz_next = strchr( psz_parser, ':' );
275         if( psz_next == NULL )
276             psz_next = psz_parser + strlen( psz_parser );
277
278         char psz_plugin[psz_next - psz_parser + 1];
279         memcpy (psz_plugin, psz_parser, sizeof (psz_plugin) - 1);
280         psz_plugin[sizeof (psz_plugin) - 1] = '\0';
281         psz_parser = psz_next;
282
283         /* Perform the addition */
284         msg_Dbg( p_playlist, "Add services_discovery %s", psz_plugin );
285         services_discovery_t *p_sd;
286
287         p_sd = services_discovery_Create( (vlc_object_t*)p_playlist, psz_plugin );
288         if( !p_sd )
289             continue;
290
291         char * psz = services_discovery_GetLocalizedName( p_sd );
292         assert( psz );
293         playlist_NodesPairCreate( p_playlist, psz,
294                 &p_cat, &p_one, false );
295         free( psz );
296
297         vlc_event_attach( services_discovery_EventManager( p_sd ),
298                           vlc_ServicesDiscoveryItemAdded,
299                           playlist_sd_item_added,
300                           p_one );
301
302         vlc_event_attach( services_discovery_EventManager( p_sd ),
303                           vlc_ServicesDiscoveryItemAdded,
304                           playlist_sd_item_added,
305                           p_cat );
306
307         vlc_event_attach( services_discovery_EventManager( p_sd ),
308                           vlc_ServicesDiscoveryItemRemoved,
309                           playlist_sd_item_removed,
310                           p_one );
311
312         vlc_event_attach( services_discovery_EventManager( p_sd ),
313                           vlc_ServicesDiscoveryItemRemoved,
314                           playlist_sd_item_removed,
315                           p_cat );
316
317         services_discovery_Start( p_sd );
318
319         /* Free in playlist_ServicesDiscoveryRemove */
320         p_sds = malloc( sizeof(struct playlist_services_discovery_support_t) );
321         if( !p_sds )
322         {
323             msg_Err( p_playlist, "No more memory" );
324             return VLC_ENOMEM;
325         }
326         p_sds->p_sd = p_sd;
327         p_sds->p_one = p_one;
328         p_sds->p_cat = p_cat;
329
330         PL_LOCK;
331         TAB_APPEND( p_playlist->i_sds, p_playlist->pp_sds, p_sds );
332         PL_UNLOCK;
333     }
334
335     return retval;
336 }
337
338 int playlist_ServicesDiscoveryRemove( playlist_t * p_playlist,
339                                        const char *psz_module )
340 {
341     struct playlist_services_discovery_support_t * p_sds = NULL;
342     int i;
343
344     PL_LOCK;
345     for( i = 0 ; i< p_playlist->i_sds ; i ++ )
346     {
347         if( !strcmp( psz_module, p_playlist->pp_sds[i]->p_sd->psz_module ) )
348         {
349             p_sds = p_playlist->pp_sds[i];
350             REMOVE_ELEM( p_playlist->pp_sds, p_playlist->i_sds, i );
351             break;
352         }
353     }
354     PL_UNLOCK;
355
356     if( !p_sds || !p_sds->p_sd )
357     {
358         msg_Warn( p_playlist, "module %s is not loaded", psz_module );
359         return VLC_EGENERIC;
360     }
361
362     services_discovery_Stop( p_sds->p_sd );
363
364     vlc_event_detach( services_discovery_EventManager( p_sds->p_sd ),
365                         vlc_ServicesDiscoveryItemAdded,
366                         playlist_sd_item_added,
367                         p_sds->p_one );
368
369     vlc_event_detach( services_discovery_EventManager( p_sds->p_sd ),
370                         vlc_ServicesDiscoveryItemAdded,
371                         playlist_sd_item_added,
372                         p_sds->p_cat );
373
374     vlc_event_detach( services_discovery_EventManager( p_sds->p_sd ),
375                         vlc_ServicesDiscoveryItemRemoved,
376                         playlist_sd_item_removed,
377                         p_sds->p_one );
378
379     vlc_event_detach( services_discovery_EventManager( p_sds->p_sd ),
380                         vlc_ServicesDiscoveryItemRemoved,
381                         playlist_sd_item_removed,
382                         p_sds->p_cat );
383
384     /* Remove the sd playlist node if it exists */
385     PL_LOCK;
386     if( p_sds->p_cat != p_playlist->p_root_category &&
387         p_sds->p_one != p_playlist->p_root_onelevel )
388     {
389         playlist_NodeDelete( p_playlist, p_sds->p_cat, true, false );
390         playlist_NodeDelete( p_playlist, p_sds->p_one, true, false );
391     }
392     PL_UNLOCK;
393
394     services_discovery_Destroy( p_sds->p_sd );
395
396     return VLC_SUCCESS;
397 }
398
399 bool playlist_IsServicesDiscoveryLoaded( playlist_t * p_playlist,
400                                               const char *psz_module )
401 {
402     int i;
403     PL_LOCK;
404
405     for( i = 0 ; i< p_playlist->i_sds ; i ++ )
406     {
407         if( !strcmp( psz_module, p_playlist->pp_sds[i]->p_sd->psz_module ) )
408         {
409             PL_UNLOCK;
410             return true;
411         }
412     }
413     PL_UNLOCK;
414     return false;
415 }
416