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_internal_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_internal_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_internal_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_internal_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     VLC_UNUSED(p_event);
 138     libvlc_media_discoverer_t * p_mdis = user_data;
 139
 140     libvlc_media_list_lock( p_mdis->p_mlist );
 141     for( int i = 0; i < libvlc_media_list_count( p_mdis->p_mlist ); i++ )
 142     {
 143         libvlc_media_list_internal_remove_index( p_mdis->p_mlist, i );
 144     }
 145     libvlc_media_list_unlock( p_mdis->p_mlist );
 146 }
 147
 148 /**************************************************************************
 149  *       services_discovery_started (Private) (VLC event callback)
 150  **************************************************************************/
 151
 152 static void services_discovery_started( const vlc_event_t * p_event,
 153                                         void * user_data )
 154 {
 155     VLC_UNUSED(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 );
 161 }
 162
 163 /**************************************************************************
 164  *       services_discovery_ended (Private) (VLC event callback)
 165  **************************************************************************/
 166
 167 static void services_discovery_ended( const vlc_event_t * p_event,
 168                                       void * user_data )
 169 {
 170     VLC_UNUSED(p_event);
 171     libvlc_media_discoverer_t * p_mdis = user_data;
 172     libvlc_media_list_t * p_mlist = p_mdis->p_mlist;
 173     libvlc_event_t event;
 174
 175     p_mdis->running = false;
 176
 177     libvlc_media_list_lock( p_mlist );
 178     libvlc_media_list_internal_end_reached( p_mlist );
 179     libvlc_media_list_unlock( p_mlist );
 180
 181     event.type = libvlc_MediaDiscovererEnded;
 182     libvlc_event_send( p_mdis->p_event_manager, &event );
 183 }
 184
 185 /*
 186  * Public libvlc functions
 187  */
 188
 189 /**************************************************************************
 190  *       new (Public)
 191  **************************************************************************/
 192 libvlc_media_discoverer_t *
 193 libvlc_media_discoverer_new( libvlc_instance_t * p_inst, const char * psz_name )
 194 {
 195     /* podcast SD is a hack and only works with custom playlist callbacks. */
 196     if( !strncasecmp( psz_name, "podcast", 7 ) )
 197         return NULL;
 198
 199     libvlc_media_discoverer_t *p_mdis = malloc(sizeof(*p_mdis));
 200     if( unlikely(!p_mdis) )
 201     {
 202         libvlc_printerr( "Not enough memory" );
 203         return NULL;
 204     }
 205
 206     p_mdis->p_libvlc_instance = p_inst;
 207     p_mdis->p_mlist = libvlc_media_list_new( p_inst );
 208     p_mdis->p_mlist->b_read_only = true;
 209     p_mdis->running = false;
 210
 211     vlc_dictionary_init( &p_mdis->catname_to_submedialist, 0 );
 212
 213     p_mdis->p_event_manager = libvlc_event_manager_new( p_mdis, p_inst );
 214     if( unlikely(p_mdis->p_event_manager == NULL) )
 215     {
 216         free( p_mdis );
 217         return NULL;
 218     }
 219
 220     libvlc_event_manager_register_event_type( p_mdis->p_event_manager,
 221             libvlc_MediaDiscovererStarted );
 222     libvlc_event_manager_register_event_type( p_mdis->p_event_manager,
 223             libvlc_MediaDiscovererEnded );
 224
 225     p_mdis->p_sd = vlc_sd_Create( (vlc_object_t*)p_inst->p_libvlc_int,
 226                                   psz_name );
 227     if( unlikely(p_mdis->p_sd == NULL) )
 228     {
 229         libvlc_printerr( "%s: no such discovery module found", psz_name );
 230         libvlc_media_list_release( p_mdis->p_mlist );
 231         libvlc_event_manager_release( p_mdis->p_event_manager );
 232         free( p_mdis );
 233         return NULL;
 234     }
 235
 236     vlc_event_attach( services_discovery_EventManager( p_mdis->p_sd ),
 237                       vlc_ServicesDiscoveryItemAdded,
 238                       services_discovery_item_added,
 239                       p_mdis );
 240     vlc_event_attach( services_discovery_EventManager( p_mdis->p_sd ),
 241                       vlc_ServicesDiscoveryItemRemoved,
 242                       services_discovery_item_removed,
 243                       p_mdis );
 244     vlc_event_attach( services_discovery_EventManager( p_mdis->p_sd ),
 245                       vlc_ServicesDiscoveryStarted,
 246                       services_discovery_started,
 247                       p_mdis );
 248     vlc_event_attach( services_discovery_EventManager( p_mdis->p_sd ),
 249                       vlc_ServicesDiscoveryEnded,
 250                       services_discovery_ended,
 251                       p_mdis );
 252     vlc_event_attach( services_discovery_EventManager( p_mdis->p_sd ),
 253                       vlc_ServicesDiscoveryItemRemoveAll,
 254                       services_discovery_removeall,
 255                       p_mdis );
 256
 257     return p_mdis;
 258 }
 259
 260 /**************************************************************************
 261  *       start (Public)
 262  **************************************************************************/
 263 LIBVLC_API int
 264 libvlc_media_discoverer_start( libvlc_media_discoverer_t * p_mdis )
 265 {
 266     /* Here we go */
 267     return vlc_sd_Start( p_mdis->p_sd ) ? 0 : -1;
 268 }
 269
 270 /**************************************************************************
 271  *       stop (Public)
 272  **************************************************************************/
 273 LIBVLC_API void
 274 libvlc_media_discoverer_stop( libvlc_media_discoverer_t * p_mdis )
 275 {
 276     return vlc_sd_Stop( p_mdis->p_sd );
 277 }
 278
 279 /**************************************************************************
 280  *       new_from_name (Public)
 281  *
 282  * \deprecated Use libvlc_media_discoverer_new and libvlc_media_discoverer_start
 283  **************************************************************************/
 284 libvlc_media_discoverer_t *
 285 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
 286                                        const char * psz_name )
 287 {
 288     libvlc_media_discoverer_t *p_mdis = libvlc_media_discoverer_new( p_inst, psz_name );
 289
 290     if( !p_mdis )
 291         return NULL;
 292
 293     if( libvlc_media_discoverer_start( p_mdis ) != 0)
 294     {
 295         libvlc_media_discoverer_release( p_mdis );
 296         return NULL;
 297     }
 298
 299     return p_mdis;
 300 }
 301
 302 /**************************************************************************
 303  * release (Public)
 304  **************************************************************************/
 305 void
 306 libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis )
 307 {
 308     int i;
 309
 310     vlc_event_detach( services_discovery_EventManager( p_mdis->p_sd ),
 311                      vlc_ServicesDiscoveryItemAdded,
 312                      services_discovery_item_added,
 313                      p_mdis );
 314     vlc_event_detach( services_discovery_EventManager( p_mdis->p_sd ),
 315                      vlc_ServicesDiscoveryItemRemoved,
 316                      services_discovery_item_removed,
 317                      p_mdis );
 318     vlc_event_detach( services_discovery_EventManager( p_mdis->p_sd ),
 319                      vlc_ServicesDiscoveryStarted,
 320                      services_discovery_started,
 321                      p_mdis );
 322     vlc_event_detach( services_discovery_EventManager( p_mdis->p_sd ),
 323                      vlc_ServicesDiscoveryEnded,
 324                      services_discovery_ended,
 325                      p_mdis );
 326     vlc_event_detach( services_discovery_EventManager( p_mdis->p_sd ),
 327                      vlc_ServicesDiscoveryItemRemoveAll,
 328                      services_discovery_removeall,
 329                      p_mdis );
 330
 331     libvlc_media_list_release( p_mdis->p_mlist );
 332
 333     if( p_mdis->running )
 334         vlc_sd_Stop( p_mdis->p_sd );
 335
 336     vlc_sd_Destroy( p_mdis->p_sd );
 337
 338     /* Free catname_to_submedialist and all the mlist */
 339     char ** all_keys = vlc_dictionary_all_keys( &p_mdis->catname_to_submedialist );
 340     for( i = 0; all_keys[i]; i++ )
 341     {
 342         libvlc_media_list_t * p_catmlist = vlc_dictionary_value_for_key( &p_mdis->catname_to_submedialist, all_keys[i] );
 343         libvlc_media_list_release( p_catmlist );
 344         free( all_keys[i] );
 345     }
 346     free( all_keys );
 347
 348     vlc_dictionary_clear( &p_mdis->catname_to_submedialist, NULL, NULL );
 349     libvlc_event_manager_release( p_mdis->p_event_manager );
 350
 351     free( p_mdis );
 352 }
 353
 354 /**************************************************************************
 355  * localized_name (Public)
 356  **************************************************************************/
 357 char *
 358 libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis )
 359 {
 360     return services_discovery_GetLocalizedName( p_mdis->p_sd );
 361 }
 362
 363 /**************************************************************************
 364  * media_list (Public)
 365  **************************************************************************/
 366 libvlc_media_list_t *
 367 libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis )
 368 {
 369     libvlc_media_list_retain( p_mdis->p_mlist );
 370     return p_mdis->p_mlist;
 371 }
 372
 373 /**************************************************************************
 374  * event_manager (Public)
 375  **************************************************************************/
 376 libvlc_event_manager_t *
 377 libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis )
 378 {
 379     return p_mdis->p_event_manager;
 380 }
 381
 382
 383 /**************************************************************************
 384  * running (Public)
 385  **************************************************************************/
 386 int
 387 libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis )
 388 {
 389     return p_mdis->running;
 390 }