5d9ee36204ef40500c5d8173bfd84bb224315986
[vlc.git] / 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 #include <vlc/vlc.h>
24 #include "vlc_playlist.h"
25 #include "vlc_events.h"
26 #include "playlist_internal.h"
27
28 static void RunSD( services_discovery_t *p_sd );
29
30 /*
31  * Services discovery
32  * Basically you just listen to Service discovery event through the
33  * sd's event manager.
34  * That's how the playlist get's Service Discovery information
35  */
36  
37 /***********************************************************************
38  * Create
39  ***********************************************************************/
40 services_discovery_t *
41 services_discovery_Create ( vlc_object_t * p_super, const char * psz_module_name )
42 {
43     services_discovery_t *p_sd = vlc_object_create( p_super, VLC_OBJECT_SD );
44     if( !p_sd )
45         return NULL;
46     
47     p_sd->pf_run = NULL;
48     p_sd->psz_localized_name = NULL;
49
50     vlc_event_manager_init( &p_sd->event_manager, p_sd, (vlc_object_t *)p_sd );
51     vlc_event_manager_register_event_type( &p_sd->event_manager, 
52             vlc_ServicesDiscoveryItemAdded );
53     vlc_event_manager_register_event_type( &p_sd->event_manager, 
54             vlc_ServicesDiscoveryItemRemoved );
55
56     p_sd->p_module = module_Need( p_sd, "services_discovery", psz_module_name, 0 );
57     
58     if( p_sd->p_module == NULL )
59     {
60         msg_Err( p_super, "no suitable services discovery module" );
61         vlc_object_destroy( p_sd );
62         return NULL;
63     }
64     p_sd->psz_module = strdup( psz_module_name );
65     p_sd->b_die = VLC_FALSE; /* FIXME */
66
67     return p_sd;
68 }
69
70 /***********************************************************************
71  * Destroy
72  ***********************************************************************/
73 void services_discovery_Destroy ( services_discovery_t * p_sd )
74 {
75     vlc_object_kill( p_sd );
76     if( p_sd->pf_run ) vlc_thread_join( p_sd );
77
78     free( p_sd->psz_module );
79     module_Unneed( p_sd, p_sd->p_module );
80
81     vlc_event_manager_fini( &p_sd->event_manager );
82     free( p_sd->psz_localized_name );
83
84     vlc_object_destroy( p_sd );
85 }
86
87 /***********************************************************************
88  * Start
89  ***********************************************************************/
90 int services_discovery_Start ( services_discovery_t * p_sd )
91 {
92     if ((p_sd->pf_run != NULL)
93         && vlc_thread_create( p_sd, "services_discovery", RunSD,
94                               VLC_THREAD_PRIORITY_LOW, VLC_FALSE))
95     {
96         msg_Err( p_sd, "cannot create services discovery thread" );
97         vlc_object_destroy( p_sd );
98         return VLC_EGENERIC;
99     }
100     return VLC_SUCCESS;
101 }
102
103 /***********************************************************************
104  * GetLocalizedName
105  ***********************************************************************/
106 const char *
107 services_discovery_GetLocalizedName ( services_discovery_t * p_sd )
108 {
109     return p_sd->psz_localized_name ? strdup( p_sd->psz_localized_name ) : NULL;
110 }
111
112 /***********************************************************************
113  * SetLocalizedName
114  ***********************************************************************/
115 void
116 services_discovery_SetLocalizedName ( services_discovery_t * p_sd, const char *psz )
117 {
118     if(p_sd->psz_localized_name) free( p_sd->psz_localized_name );
119     p_sd->psz_localized_name = strdup(psz);
120 }
121
122 /***********************************************************************
123  * EventManager
124  ***********************************************************************/
125 vlc_event_manager_t *
126 services_discovery_EventManager ( services_discovery_t * p_sd )
127 {
128     return &p_sd->event_manager;
129 }
130
131 /***********************************************************************
132  * AddItem
133  ***********************************************************************/
134 void
135 services_discovery_AddItem ( services_discovery_t * p_sd, input_item_t * p_item,
136                              const char * psz_category )
137 {
138     vlc_event_t event;
139     event.type = vlc_ServicesDiscoveryItemAdded;
140     event.u.services_discovery_item_added.p_new_item = p_item;
141     event.u.services_discovery_item_added.psz_category = psz_category;
142
143     vlc_event_send( &p_sd->event_manager, &event );
144 }
145
146 /***********************************************************************
147  * RemoveItem
148  ***********************************************************************/
149 void
150 services_discovery_RemoveItem ( services_discovery_t * p_sd, input_item_t * p_item )
151 {
152     vlc_event_t event;
153     event.type = vlc_ServicesDiscoveryItemRemoved;
154     event.u.services_discovery_item_removed.p_item = p_item;
155
156     vlc_event_send( &p_sd->event_manager, &event );
157 }
158
159 /***********************************************************************
160  * RunSD (Private)
161  ***********************************************************************/
162 static void RunSD( services_discovery_t *p_sd )
163 {
164     p_sd->pf_run( p_sd );
165     return;
166 }
167
168 /*
169  * Playlist - Services discovery bridge
170  */
171  
172  /* A new item has been added to a certain sd */
173 static void playlist_sd_item_added( const vlc_event_t * p_event, void * user_data )
174 {
175     input_item_t * p_input = p_event->u.services_discovery_item_added.p_new_item;
176     const char * psz_cat = p_event->u.services_discovery_item_added.psz_category;
177     playlist_item_t *p_new_item, * p_parent = user_data;
178
179     msg_Dbg( p_parent->p_playlist, "Adding %s in %s", p_input->psz_name, psz_cat );
180
181     /* If p_child is in root category (this is clearly a hack) and we have a cat*/
182     if( !EMPTY_STR(psz_cat) &&
183         p_parent == playlist_ItemToNode( p_parent->p_playlist, p_parent, VLC_FALSE ) )
184     {
185         /* */
186         playlist_item_t * p_cat;
187         p_cat = playlist_ChildSearchName( p_parent, psz_cat );
188         if( !p_cat )
189         {
190             p_cat = playlist_NodeCreate( p_parent->p_playlist, psz_cat,
191                                          p_parent, 0 );
192             p_cat->i_flags &= ~PLAYLIST_SKIP_FLAG;
193         }
194         p_parent = p_cat;
195     }
196         
197     p_new_item = playlist_NodeAddInput( p_parent->p_playlist, p_input, p_parent,
198                                         PLAYLIST_APPEND, PLAYLIST_END, VLC_FALSE );
199     p_new_item->i_flags &= ~PLAYLIST_SKIP_FLAG;
200     p_new_item->i_flags &= ~PLAYLIST_SAVE_FLAG;
201 }
202
203  /* A new item has been removed from a certain sd */
204 static void playlist_sd_item_removed( const vlc_event_t * p_event, void * user_data )
205 {
206     playlist_item_t * p_child = user_data;
207
208     msg_Err( p_child->p_playlist, "Service Discovery item deletion not handled" );
209 }
210
211 int playlist_ServicesDiscoveryAdd( playlist_t *p_playlist,  const char *psz_modules )
212 {
213     const char *psz_parser = psz_modules ?: "";
214     int retval = VLC_SUCCESS;
215
216     for (;;)
217     {
218         playlist_item_t * p_cat, * p_one;
219         while( *psz_parser == ' ' || *psz_parser == ':' || *psz_parser == ',' )
220             psz_parser++;
221
222         if( *psz_parser == '\0' )
223             break;
224
225         const char *psz_next = strchr( psz_parser, ':' );
226         if( psz_next == NULL )
227             psz_next = psz_parser + strlen( psz_parser );
228
229         char psz_plugin[psz_next - psz_parser + 1];
230         memcpy (psz_plugin, psz_parser, sizeof (psz_plugin) - 1);
231         psz_plugin[sizeof (psz_plugin) - 1] = '\0';
232         psz_parser = psz_next;
233
234         /* Perform the addition */
235         msg_Dbg( p_playlist, "Add services_discovery %s", psz_plugin );
236         services_discovery_t *p_sd;
237
238         p_sd = services_discovery_Create( (vlc_object_t*)p_playlist, psz_plugin );
239         if( !p_sd )
240             continue;
241
242         char * psz = services_discovery_GetLocalizedName( p_sd );
243         if( psz )
244         {
245             playlist_NodesPairCreate( p_playlist, psz,
246                     &p_cat, &p_one, VLC_FALSE );
247             free( psz );
248         }
249         else
250         {
251             /* No name, just add at the top of the playlist */
252             p_cat = p_playlist->p_root_category;
253             p_one = p_playlist->p_root_onelevel;
254         }
255
256         vlc_event_attach( services_discovery_EventManager( p_sd ),
257                           vlc_ServicesDiscoveryItemAdded,
258                           playlist_sd_item_added,
259                           p_one );
260
261         vlc_event_attach( services_discovery_EventManager( p_sd ),
262                           vlc_ServicesDiscoveryItemAdded,
263                           playlist_sd_item_added,
264                           p_cat );
265
266         vlc_event_attach( services_discovery_EventManager( p_sd ),
267                           vlc_ServicesDiscoveryItemRemoved,
268                           playlist_sd_item_removed,
269                           p_one );
270
271         vlc_event_attach( services_discovery_EventManager( p_sd ),
272                           vlc_ServicesDiscoveryItemRemoved,
273                           playlist_sd_item_removed,
274                           p_cat );
275
276         services_discovery_Start( p_sd );
277
278         PL_LOCK;
279         TAB_APPEND( p_playlist->i_sds, p_playlist->pp_sds, p_sd );
280         PL_UNLOCK;
281     }
282
283     return retval;
284 }
285
286 int playlist_ServicesDiscoveryRemove( playlist_t * p_playlist,
287                                        const char *psz_module )
288 {
289     int i;
290     services_discovery_t *p_sd = NULL;
291
292     PL_LOCK;
293     for( i = 0 ; i< p_playlist->i_sds ; i ++ )
294     {
295         if( !strcmp( psz_module, p_playlist->pp_sds[i]->psz_module ) )
296         {
297             p_sd = p_playlist->pp_sds[i];
298             REMOVE_ELEM( p_playlist->pp_sds, p_playlist->i_sds, i );
299             break;
300         }
301     }
302     PL_UNLOCK;
303
304     if( p_sd )
305     {
306         services_discovery_Destroy( p_sd );
307     }
308     else
309     {
310         msg_Warn( p_playlist, "module %s is not loaded", psz_module );
311         return VLC_EGENERIC;
312     }
313     return VLC_SUCCESS;
314 }
315
316 vlc_bool_t playlist_IsServicesDiscoveryLoaded( playlist_t * p_playlist,
317                                               const char *psz_module )
318 {
319     int i;
320     PL_LOCK;
321
322     for( i = 0 ; i< p_playlist->i_sds ; i ++ )
323     {
324         if( !strcmp( psz_module, p_playlist->pp_sds[i]->psz_module ) )
325         {
326             PL_UNLOCK;
327             return VLC_TRUE;
328         }
329     }
330     PL_UNLOCK;
331     return VLC_FALSE;
332 }
333