1 /*****************************************************************************
2 * media_discoverer.c: libvlc new API media discoverer functions
3 *****************************************************************************
4 * Copyright (C) 2007 VLC authors and VideoLAN
7 * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
30 #include <vlc/libvlc.h>
31 #include <vlc/libvlc_media.h>
32 #include <vlc/libvlc_media_list.h>
33 #include <vlc/libvlc_media_discoverer.h>
34 #include <vlc/libvlc_events.h>
36 #include <vlc_services_discovery.h>
38 #include "libvlc_internal.h"
39 #include "media_internal.h" // libvlc_media_new_from_input_item()
40 #include "media_list_internal.h" // libvlc_media_list_internal_add_media()
42 struct libvlc_media_discoverer_t
44 libvlc_event_manager_t * p_event_manager;
45 libvlc_instance_t * p_libvlc_instance;
46 services_discovery_t * p_sd;
47 libvlc_media_list_t * p_mlist;
49 vlc_dictionary_t catname_to_submedialist;
56 /**************************************************************************
57 * services_discovery_item_added (Private) (VLC event callback)
58 **************************************************************************/
60 static void services_discovery_item_added( const vlc_event_t * p_event,
63 input_item_t * p_item = p_event->u.services_discovery_item_added.p_new_item;
64 const char * psz_cat = p_event->u.services_discovery_item_added.psz_category;
65 libvlc_media_t * p_md;
66 libvlc_media_discoverer_t * p_mdis = user_data;
67 libvlc_media_list_t * p_mlist = p_mdis->p_mlist;
69 p_md = libvlc_media_new_from_input_item( p_mdis->p_libvlc_instance,
72 /* If we have a category, that mean we have to group the items having
73 * that category in a media_list. */
76 p_mlist = vlc_dictionary_value_for_key( &p_mdis->catname_to_submedialist, psz_cat );
78 if( p_mlist == kVLCDictionaryNotFound )
80 libvlc_media_t * p_catmd;
81 p_catmd = libvlc_media_new_as_node( p_mdis->p_libvlc_instance, psz_cat );
82 p_mlist = libvlc_media_subitems( p_catmd );
83 p_mlist->b_read_only = true;
85 /* Insert the newly created mlist in our dictionary */
86 vlc_dictionary_insert( &p_mdis->catname_to_submedialist, psz_cat, p_mlist );
88 /* Insert the md into the root list */
89 libvlc_media_list_lock( p_mdis->p_mlist );
90 libvlc_media_list_internal_add_media( p_mdis->p_mlist, p_catmd );
91 libvlc_media_list_unlock( p_mdis->p_mlist );
93 /* We don't release the mlist cause the dictionary
94 * doesn't retain the object. But we release the md. */
95 libvlc_media_release( p_catmd );
99 libvlc_media_list_lock( p_mlist );
100 libvlc_media_list_internal_add_media( p_mlist, p_md );
101 libvlc_media_list_unlock( p_mlist );
103 libvlc_media_release( p_md );
106 /**************************************************************************
107 * services_discovery_item_removed (Private) (VLC event callback)
108 **************************************************************************/
110 static void services_discovery_item_removed( const vlc_event_t * p_event,
113 input_item_t * p_item = p_event->u.services_discovery_item_added.p_new_item;
114 libvlc_media_t * p_md;
115 libvlc_media_discoverer_t * p_mdis = user_data;
117 int i, count = libvlc_media_list_count( p_mdis->p_mlist );
118 libvlc_media_list_lock( p_mdis->p_mlist );
119 for( i = 0; i < count; i++ )
121 p_md = libvlc_media_list_item_at_index( p_mdis->p_mlist, i );
122 if( p_md->p_input_item == p_item )
124 libvlc_media_list_internal_remove_index( p_mdis->p_mlist, i );
128 libvlc_media_list_unlock( p_mdis->p_mlist );
131 /**************************************************************************
132 * services_discovery_removeall (Private) (VLC event callback)
133 **************************************************************************/
134 static void services_discovery_removeall( const vlc_event_t * p_event,
138 libvlc_media_discoverer_t * p_mdis = user_data;
140 libvlc_media_list_lock( p_mdis->p_mlist );
141 for( int i = 0; i < libvlc_media_list_count( p_mdis->p_mlist ); i++ )
143 libvlc_media_list_internal_remove_index( p_mdis->p_mlist, i );
145 libvlc_media_list_unlock( p_mdis->p_mlist );
148 /**************************************************************************
149 * services_discovery_started (Private) (VLC event callback)
150 **************************************************************************/
152 static void services_discovery_started( const vlc_event_t * p_event,
156 libvlc_media_discoverer_t * p_mdis = user_data;
157 libvlc_event_t event;
158 p_mdis->running = true;
159 event.type = libvlc_MediaDiscovererStarted;
160 libvlc_event_send( p_mdis->p_event_manager, &event );
163 /**************************************************************************
164 * services_discovery_ended (Private) (VLC event callback)
165 **************************************************************************/
167 static void services_discovery_ended( const vlc_event_t * p_event,
171 libvlc_media_discoverer_t * p_mdis = user_data;
172 libvlc_event_t event;
173 p_mdis->running = false;
174 event.type = libvlc_MediaDiscovererEnded;
175 libvlc_event_send( p_mdis->p_event_manager, &event );
179 * Public libvlc functions
182 /**************************************************************************
184 **************************************************************************/
185 libvlc_media_discoverer_t *
186 libvlc_media_discoverer_new( libvlc_instance_t * p_inst, const char * psz_name )
188 /* podcast SD is a hack and only works with custom playlist callbacks. */
189 if( !strncasecmp( psz_name, "podcast", 7 ) )
192 libvlc_media_discoverer_t *p_mdis = malloc(sizeof(*p_mdis));
193 if( unlikely(!p_mdis) )
195 libvlc_printerr( "Not enough memory" );
199 p_mdis->p_libvlc_instance = p_inst;
200 p_mdis->p_mlist = libvlc_media_list_new( p_inst );
201 p_mdis->p_mlist->b_read_only = true;
202 p_mdis->running = false;
204 vlc_dictionary_init( &p_mdis->catname_to_submedialist, 0 );
206 p_mdis->p_event_manager = libvlc_event_manager_new( p_mdis, p_inst );
207 if( unlikely(p_mdis->p_event_manager == NULL) )
213 libvlc_event_manager_register_event_type( p_mdis->p_event_manager,
214 libvlc_MediaDiscovererStarted );
215 libvlc_event_manager_register_event_type( p_mdis->p_event_manager,
216 libvlc_MediaDiscovererEnded );
218 p_mdis->p_sd = vlc_sd_Create( (vlc_object_t*)p_inst->p_libvlc_int,
220 if( unlikely(p_mdis->p_sd == NULL) )
222 libvlc_printerr( "%s: no such discovery module found", psz_name );
223 libvlc_media_list_release( p_mdis->p_mlist );
224 libvlc_event_manager_release( p_mdis->p_event_manager );
229 vlc_event_attach( services_discovery_EventManager( p_mdis->p_sd ),
230 vlc_ServicesDiscoveryItemAdded,
231 services_discovery_item_added,
233 vlc_event_attach( services_discovery_EventManager( p_mdis->p_sd ),
234 vlc_ServicesDiscoveryItemRemoved,
235 services_discovery_item_removed,
237 vlc_event_attach( services_discovery_EventManager( p_mdis->p_sd ),
238 vlc_ServicesDiscoveryStarted,
239 services_discovery_started,
241 vlc_event_attach( services_discovery_EventManager( p_mdis->p_sd ),
242 vlc_ServicesDiscoveryEnded,
243 services_discovery_ended,
245 vlc_event_attach( services_discovery_EventManager( p_mdis->p_sd ),
246 vlc_ServicesDiscoveryItemRemoveAll,
247 services_discovery_removeall,
253 /**************************************************************************
255 **************************************************************************/
257 libvlc_media_discoverer_start( libvlc_media_discoverer_t * p_mdis )
260 return vlc_sd_Start( p_mdis->p_sd ) ? 0 : -1;
263 /**************************************************************************
265 **************************************************************************/
267 libvlc_media_discoverer_stop( libvlc_media_discoverer_t * p_mdis )
269 return vlc_sd_Stop( p_mdis->p_sd );
272 /**************************************************************************
273 * new_from_name (Public)
275 * \deprecated Use libvlc_media_discoverer_new and libvlc_media_discoverer_start
276 **************************************************************************/
277 libvlc_media_discoverer_t *
278 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
279 const char * psz_name )
281 libvlc_media_discoverer_t *p_mdis = libvlc_media_discoverer_new( p_inst, psz_name );
286 if( libvlc_media_discoverer_start( p_mdis ) != 0)
288 libvlc_media_discoverer_release( p_mdis );
295 /**************************************************************************
297 **************************************************************************/
299 libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis )
303 vlc_event_detach( services_discovery_EventManager( p_mdis->p_sd ),
304 vlc_ServicesDiscoveryItemAdded,
305 services_discovery_item_added,
307 vlc_event_detach( services_discovery_EventManager( p_mdis->p_sd ),
308 vlc_ServicesDiscoveryItemRemoved,
309 services_discovery_item_removed,
311 vlc_event_detach( services_discovery_EventManager( p_mdis->p_sd ),
312 vlc_ServicesDiscoveryStarted,
313 services_discovery_started,
315 vlc_event_detach( services_discovery_EventManager( p_mdis->p_sd ),
316 vlc_ServicesDiscoveryEnded,
317 services_discovery_ended,
319 vlc_event_detach( services_discovery_EventManager( p_mdis->p_sd ),
320 vlc_ServicesDiscoveryItemRemoveAll,
321 services_discovery_removeall,
324 libvlc_media_list_release( p_mdis->p_mlist );
326 if( p_mdis->running )
327 vlc_sd_Stop( p_mdis->p_sd );
329 vlc_sd_Destroy( p_mdis->p_sd );
331 /* Free catname_to_submedialist and all the mlist */
332 char ** all_keys = vlc_dictionary_all_keys( &p_mdis->catname_to_submedialist );
333 for( i = 0; all_keys[i]; i++ )
335 libvlc_media_list_t * p_catmlist = vlc_dictionary_value_for_key( &p_mdis->catname_to_submedialist, all_keys[i] );
336 libvlc_media_list_release( p_catmlist );
341 vlc_dictionary_clear( &p_mdis->catname_to_submedialist, NULL, NULL );
342 libvlc_event_manager_release( p_mdis->p_event_manager );
347 /**************************************************************************
348 * localized_name (Public)
349 **************************************************************************/
351 libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis )
353 return services_discovery_GetLocalizedName( p_mdis->p_sd );
356 /**************************************************************************
357 * media_list (Public)
358 **************************************************************************/
359 libvlc_media_list_t *
360 libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis )
362 libvlc_media_list_retain( p_mdis->p_mlist );
363 return p_mdis->p_mlist;
366 /**************************************************************************
367 * event_manager (Public)
368 **************************************************************************/
369 libvlc_event_manager_t *
370 libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis )
372 return p_mdis->p_event_manager;
376 /**************************************************************************
378 **************************************************************************/
380 libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis )
382 return p_mdis->running;