lib/media_discoverer.c

   1 /*****************************************************************************
   2  * media_discoverer.c: libvlc new API media discoverer functions
   3  *****************************************************************************
   4  * Copyright (C) 2007 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
   8  *
   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.
  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 Lesser General Public License for more details.
  18  *
  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  *****************************************************************************/
  23
  24 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <assert.h>
  29
  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>
  35
  36 #include <vlc_services_discovery.h>
  37
  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_add_media()
  41
  42 struct libvlc_media_discoverer_t
  43 {
  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;
  48     bool                     running;
  49     vlc_dictionary_t         catname_to_submedialist;
  50 };
  51
  52 /*
  53  * Private functions
  54  */
  55
  56 /**************************************************************************
  57  *       services_discovery_item_added (Private) (VLC event callback)
  58  **************************************************************************/
  59
  60 static void services_discovery_item_added( const vlc_event_t * p_event,
  61                                            void * user_data )
  62 {
  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;
  68
  69     p_md = libvlc_media_new_from_input_item( p_mdis->p_libvlc_instance,
  70                                              p_item );
  71
  72     /* If we have a category, that mean we have to group the items having
  73      * that category in a media_list. */
  74     if( psz_cat )
  75     {
  76         p_mlist = vlc_dictionary_value_for_key( &p_mdis->catname_to_submedialist, psz_cat );
  77
  78         if( p_mlist == kVLCDictionaryNotFound )
  79         {
  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;
  84
  85             /* Insert the newly created mlist in our dictionary */
  86             vlc_dictionary_insert( &p_mdis->catname_to_submedialist, psz_cat, p_mlist );
  87
  88             /* Insert the md into the root list */
  89             libvlc_media_list_lock( p_mdis->p_mlist );
  90             _libvlc_media_list_add_media( p_mdis->p_mlist, p_catmd );
  91             libvlc_media_list_unlock( p_mdis->p_mlist );
  92
  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 );
  96         }
  97     }
  98
  99     libvlc_media_list_lock( p_mlist );
 100     _libvlc_media_list_add_media( p_mlist, p_md );
 101     libvlc_media_list_unlock( p_mlist );
 102
 103     libvlc_media_release( p_md );
 104 }
 105
 106 /**************************************************************************
 107  *       services_discovery_item_removed (Private) (VLC event callback)
 108  **************************************************************************/
 109
 110 static void services_discovery_item_removed( const vlc_event_t * p_event,
 111                                              void * user_data )
 112 {
 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;
 116
 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++ )
 120     {
 121         p_md = libvlc_media_list_item_at_index( p_mdis->p_mlist, i );
 122         if( p_md->p_input_item == p_item )
 123         {
 124             _libvlc_media_list_remove_index( p_mdis->p_mlist, i );
 125             break;
 126         }
 127     }
 128     libvlc_media_list_unlock( p_mdis->p_mlist );
 129 }
 130
 131 /**************************************************************************
 132  *       services_discovery_removeall (Private) (VLC event callback)
 133  **************************************************************************/
 134 static void services_discovery_removeall( const vlc_event_t * p_event,
 135                                              void * user_data )
 136 {
 137     libvlc_media_discoverer_t * p_mdis = user_data;
 138
 139     libvlc_media_list_lock( p_mdis->p_mlist );
 140     for( int i = 0; i < libvlc_media_list_count( p_mdis->p_mlist ); i++ )
 141     {
 142         _libvlc_media_list_remove_index( p_mdis->p_mlist, i );
 143     }
 144     libvlc_media_list_unlock( p_mdis->p_mlist );
 145 }
 146
 147 /**************************************************************************
 148  *       services_discovery_started (Private) (VLC event callback)
 149  **************************************************************************/
 150
 151 static void services_discovery_started( const vlc_event_t * p_event,
 152                                         void * user_data )
 153 {
 154     VLC_UNUSED(p_event);
 155     libvlc_media_discoverer_t * p_mdis = user_data;
 156     libvlc_event_t event;
 157     p_mdis->running = true;
 158     event.type = libvlc_MediaDiscovererStarted;
 159     libvlc_event_send( p_mdis->p_event_manager, &event );
 160 }
 161
 162 /**************************************************************************
 163  *       services_discovery_ended (Private) (VLC event callback)
 164  **************************************************************************/
 165
 166 static void services_discovery_ended( const vlc_event_t * p_event,
 167                                       void * user_data )
 168 {
 169     VLC_UNUSED(p_event);
 170     libvlc_media_discoverer_t * p_mdis = user_data;
 171     libvlc_event_t event;
 172     p_mdis->running = false;
 173     event.type = libvlc_MediaDiscovererEnded;
 174     libvlc_event_send( p_mdis->p_event_manager, &event );
 175 }
 176
 177 /*
 178  * Public libvlc functions
 179  */
 180
 181 /**************************************************************************
 182  *       new (Public)
 183  *
 184  * Init an object.
 185  **************************************************************************/
 186 libvlc_media_discoverer_t *
 187 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
 188                                        const char * psz_name )
 189 {
 190     libvlc_media_discoverer_t * p_mdis;
 191
 192     p_mdis = malloc(sizeof(libvlc_media_discoverer_t));
 193     if( unlikely(!p_mdis) )
 194     {
 195         libvlc_printerr( "Not enough memory" );
 196         return NULL;
 197     }
 198
 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;
 203
 204     vlc_dictionary_init( &p_mdis->catname_to_submedialist, 0 );
 205
 206     p_mdis->p_event_manager = libvlc_event_manager_new( p_mdis, p_inst );
 207     if( unlikely(p_mdis->p_event_manager == NULL) )
 208     {
 209         free( p_mdis );
 210         return NULL;
 211     }
 212
 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 );
 217
 218     p_mdis->p_sd = vlc_sd_Create( (vlc_object_t*)p_inst->p_libvlc_int,
 219                                   psz_name );
 220     if( unlikely(p_mdis->p_sd == NULL) )
 221     {
 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 );
 225         free( p_mdis );
 226         return NULL;
 227     }
 228
 229     vlc_event_attach( services_discovery_EventManager( p_mdis->p_sd ),
 230                       vlc_ServicesDiscoveryItemAdded,
 231                       services_discovery_item_added,
 232                       p_mdis );
 233     vlc_event_attach( services_discovery_EventManager( p_mdis->p_sd ),
 234                       vlc_ServicesDiscoveryItemRemoved,
 235                       services_discovery_item_removed,
 236                       p_mdis );
 237     vlc_event_attach( services_discovery_EventManager( p_mdis->p_sd ),
 238                       vlc_ServicesDiscoveryStarted,
 239                       services_discovery_started,
 240                       p_mdis );
 241     vlc_event_attach( services_discovery_EventManager( p_mdis->p_sd ),
 242                       vlc_ServicesDiscoveryEnded,
 243                       services_discovery_ended,
 244                       p_mdis );
 245     vlc_event_attach( services_discovery_EventManager( p_mdis->p_sd ),
 246                       vlc_ServicesDiscoveryItemRemoveAll,
 247                       services_discovery_removeall,
 248                       p_mdis );
 249
 250     /* Here we go */
 251     if( !vlc_sd_Start( p_mdis->p_sd ) )
 252     {
 253         libvlc_printerr( "%s: internal module error",
 254                          p_mdis->p_sd->psz_name );
 255         libvlc_media_list_release( p_mdis->p_mlist );
 256         libvlc_event_manager_release( p_mdis->p_event_manager );
 257         free( p_mdis );
 258         return NULL;
 259     }
 260
 261     return p_mdis;
 262 }
 263
 264 /**************************************************************************
 265  * release (Public)
 266  **************************************************************************/
 267 void
 268 libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis )
 269 {
 270     int i;
 271
 272     vlc_event_detach( services_discovery_EventManager( p_mdis->p_sd ),
 273                      vlc_ServicesDiscoveryItemAdded,
 274                      services_discovery_item_added,
 275                      p_mdis );
 276     vlc_event_detach( services_discovery_EventManager( p_mdis->p_sd ),
 277                      vlc_ServicesDiscoveryItemRemoved,
 278                      services_discovery_item_removed,
 279                      p_mdis );
 280     vlc_event_detach( services_discovery_EventManager( p_mdis->p_sd ),
 281                      vlc_ServicesDiscoveryStarted,
 282                      services_discovery_started,
 283                      p_mdis );
 284     vlc_event_detach( services_discovery_EventManager( p_mdis->p_sd ),
 285                      vlc_ServicesDiscoveryEnded,
 286                      services_discovery_ended,
 287                      p_mdis );
 288     vlc_event_detach( services_discovery_EventManager( p_mdis->p_sd ),
 289                      vlc_ServicesDiscoveryItemRemoveAll,
 290                      services_discovery_removeall,
 291                      p_mdis );
 292
 293     libvlc_media_list_release( p_mdis->p_mlist );
 294
 295     vlc_sd_StopAndDestroy( p_mdis->p_sd );
 296
 297     /* Free catname_to_submedialist and all the mlist */
 298     char ** all_keys = vlc_dictionary_all_keys( &p_mdis->catname_to_submedialist );
 299     for( i = 0; all_keys[i]; i++ )
 300     {
 301         libvlc_media_list_t * p_catmlist = vlc_dictionary_value_for_key( &p_mdis->catname_to_submedialist, all_keys[i] );
 302         libvlc_media_list_release( p_catmlist );
 303         free( all_keys[i] );
 304     }
 305     free( all_keys );
 306
 307     vlc_dictionary_clear( &p_mdis->catname_to_submedialist, NULL, NULL );
 308     libvlc_event_manager_release( p_mdis->p_event_manager );
 309
 310     free( p_mdis );
 311 }
 312
 313 /**************************************************************************
 314  * localized_name (Public)
 315  **************************************************************************/
 316 char *
 317 libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis )
 318 {
 319     return services_discovery_GetLocalizedName( p_mdis->p_sd );
 320 }
 321
 322 /**************************************************************************
 323  * media_list (Public)
 324  **************************************************************************/
 325 libvlc_media_list_t *
 326 libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis )
 327 {
 328     libvlc_media_list_retain( p_mdis->p_mlist );
 329     return p_mdis->p_mlist;
 330 }
 331
 332 /**************************************************************************
 333  * event_manager (Public)
 334  **************************************************************************/
 335 libvlc_event_manager_t *
 336 libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis )
 337 {
 338     return p_mdis->p_event_manager;
 339 }
 340
 341
 342 /**************************************************************************
 343  * running (Public)
 344  **************************************************************************/
 345 int
 346 libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis )
 347 {
 348     return p_mdis->running;
 349 }