media_discoverer.c 12.1 KB
Newer Older
1 2 3
/*****************************************************************************
 * media_discoverer.c: libvlc new API media discoverer functions
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 2007 VLC authors and VideoLAN
5 6 7 8
 * $Id$
 *
 * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
9 10 11
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
12 13 14 15
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
18
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
19 20 21
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23
 *****************************************************************************/

24 25 26 27
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

28
#include <assert.h>
29 30 31 32 33 34 35 36 37 38 39

#include <vlc/libvlc.h>
#include <vlc/libvlc_media.h>
#include <vlc/libvlc_media_list.h>
#include <vlc/libvlc_media_discoverer.h>
#include <vlc/libvlc_events.h>

#include <vlc_services_discovery.h>

#include "libvlc_internal.h"
#include "media_internal.h" // libvlc_media_new_from_input_item()
40
#include "media_list_internal.h" // libvlc_media_list_internal_add_media()
41 42 43 44 45 46 47

struct libvlc_media_discoverer_t
{
    libvlc_instance_t *      p_libvlc_instance;
    services_discovery_t *   p_sd;
    libvlc_media_list_t *    p_mlist;
    vlc_dictionary_t         catname_to_submedialist;
48
    char                     name[];
49
};
50 51 52 53

/*
 * Private functions
 */
54

55 56 57 58
/**************************************************************************
 *       services_discovery_item_added (Private) (VLC event callback)
 **************************************************************************/

59
static void services_discovery_item_added( services_discovery_t *sd,
60
                                           input_item_t *parent,
61 62
                                           input_item_t *p_item,
                                           const char *psz_cat )
63
{
64
    libvlc_media_t * p_md;
65
    libvlc_media_discoverer_t *p_mdis = sd->owner.sys;
66
    libvlc_media_list_t * p_mlist = p_mdis->p_mlist;
67

68 69
    p_md = libvlc_media_new_from_input_item( p_mdis->p_libvlc_instance,
                                             p_item );
70

71 72 73 74 75
    if( parent != NULL )
    {
        /* Flatten items list for now. TODO: tree support. */
    }
    else
76 77 78 79 80
    /* If we have a category, that mean we have to group the items having
     * that category in a media_list. */
    if( psz_cat )
    {
        p_mlist = vlc_dictionary_value_for_key( &p_mdis->catname_to_submedialist, psz_cat );
81

82 83
        if( p_mlist == kVLCDictionaryNotFound )
        {
84
            libvlc_media_t * p_catmd;
85
            p_catmd = libvlc_media_new_as_node( p_mdis->p_libvlc_instance, psz_cat );
86
            p_mlist = libvlc_media_subitems( p_catmd );
87
            p_mlist->b_read_only = true;
88

89
            /* Insert the newly created mlist in our dictionary */
90
            vlc_dictionary_insert( &p_mdis->catname_to_submedialist, psz_cat, p_mlist );
91

92
            /* Insert the md into the root list */
93
            libvlc_media_list_lock( p_mdis->p_mlist );
94
            libvlc_media_list_internal_add_media( p_mdis->p_mlist, p_catmd );
95
            libvlc_media_list_unlock( p_mdis->p_mlist );
96 97 98

            /* We don't release the mlist cause the dictionary
             * doesn't retain the object. But we release the md. */
99
            libvlc_media_release( p_catmd );
100 101
        }
    }
102 103

    libvlc_media_list_lock( p_mlist );
104
    libvlc_media_list_internal_add_media( p_mlist, p_md );
105
    libvlc_media_list_unlock( p_mlist );
106 107

    libvlc_media_release( p_md );
108 109 110 111 112 113
}

/**************************************************************************
 *       services_discovery_item_removed (Private) (VLC event callback)
 **************************************************************************/

114 115
static void services_discovery_item_removed( services_discovery_t *sd,
                                             input_item_t *p_item )
116
{
117
    libvlc_media_t * p_md;
118
    libvlc_media_discoverer_t *p_mdis = sd->owner.sys;
119

120
    int i, count = libvlc_media_list_count( p_mdis->p_mlist );
121 122 123
    libvlc_media_list_lock( p_mdis->p_mlist );
    for( i = 0; i < count; i++ )
    {
124
        p_md = libvlc_media_list_item_at_index( p_mdis->p_mlist, i );
125
        assert(p_md != NULL);
126 127
        if( p_md->p_input_item == p_item )
        {
128
            libvlc_media_list_internal_remove_index( p_mdis->p_mlist, i );
129
            libvlc_media_release( p_md );
130 131
            break;
        }
132
        libvlc_media_release( p_md );
133 134 135 136
    }
    libvlc_media_list_unlock( p_mdis->p_mlist );
}

137 138 139 140 141 142 143 144
/*
 * Public libvlc functions
 */

/**************************************************************************
 *       new (Public)
 **************************************************************************/
libvlc_media_discoverer_t *
145
libvlc_media_discoverer_new( libvlc_instance_t * p_inst, const char * psz_name )
146
{
147 148 149
    /* podcast SD is a hack and only works with custom playlist callbacks. */
    if( !strncasecmp( psz_name, "podcast", 7 ) )
        return NULL;
150

151 152 153 154
    libvlc_media_discoverer_t *p_mdis;

    p_mdis = malloc(sizeof(*p_mdis) + strlen(psz_name) + 1);
    if( unlikely(p_mdis == NULL) )
155
    {
156
        libvlc_printerr( "Not enough memory" );
157 158 159 160
        return NULL;
    }

    p_mdis->p_libvlc_instance = p_inst;
161
    p_mdis->p_mlist = libvlc_media_list_new( p_inst );
162
    p_mdis->p_mlist->b_read_only = true;
163
    p_mdis->p_sd = NULL;
164

165
    vlc_dictionary_init( &p_mdis->catname_to_submedialist, 0 );
166

167
    libvlc_retain( p_inst );
168
    strcpy( p_mdis->name, psz_name );
169 170 171
    return p_mdis;
}

172 173 174 175 176
static const struct services_discovery_callbacks sd_cbs = {
    .item_added = services_discovery_item_added,
    .item_removed = services_discovery_item_removed,
};

177 178 179 180 181 182
/**************************************************************************
 *       start (Public)
 **************************************************************************/
LIBVLC_API int
libvlc_media_discoverer_start( libvlc_media_discoverer_t * p_mdis )
{
183
    struct services_discovery_owner_t owner = {
184
        &sd_cbs,
185 186 187
        p_mdis,
    };

188
    /* Here we go */
189 190 191 192 193
    p_mdis->p_sd = vlc_sd_Create( (vlc_object_t *)p_mdis->p_libvlc_instance->p_libvlc_int,
                                  p_mdis->name, &owner );
    if( p_mdis->p_sd == NULL )
    {
        libvlc_printerr( "%s: no such discovery module found", p_mdis->name );
194
        return -1;
195
    }
196 197

    return 0;
198 199 200 201 202 203 204 205
}

/**************************************************************************
 *       stop (Public)
 **************************************************************************/
LIBVLC_API void
libvlc_media_discoverer_stop( libvlc_media_discoverer_t * p_mdis )
{
206 207 208 209 210
    libvlc_media_list_t * p_mlist = p_mdis->p_mlist;
    libvlc_media_list_lock( p_mlist );
    libvlc_media_list_internal_end_reached( p_mlist );
    libvlc_media_list_unlock( p_mlist );

211 212
    vlc_sd_Destroy( p_mdis->p_sd );
    p_mdis->p_sd = NULL;
213 214
}

215 216 217
/**************************************************************************
 * release (Public)
 **************************************************************************/
218 219 220 221 222 223 224
static void
MediaListDictValueRelease( void* mlist, void* obj )
{
    libvlc_media_list_release( mlist );
    (void)obj;
}

225 226 227
void
libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis )
{
228
    if( p_mdis->p_sd != NULL )
229
        libvlc_media_discoverer_stop( p_mdis );
230

231 232
    libvlc_media_list_release( p_mdis->p_mlist );

233 234
    vlc_dictionary_clear( &p_mdis->catname_to_submedialist,
        MediaListDictValueRelease, NULL );
235

236
    libvlc_release( p_mdis->p_libvlc_instance );
237

238 239 240 241 242 243 244 245 246
    free( p_mdis );
}

/**************************************************************************
 * media_list (Public)
 **************************************************************************/
libvlc_media_list_t *
libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis )
{
247 248
    libvlc_media_list_retain( p_mdis->p_mlist );
    return p_mdis->p_mlist;
249 250
}

251 252 253
/**************************************************************************
 * running (Public)
 **************************************************************************/
254
int
255 256
libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis )
{
257
    return p_mdis->p_sd != NULL;
258
}
259 260

void
261
libvlc_media_discoverer_list_release( libvlc_media_discoverer_description_t **pp_services,
262
                                      size_t i_count )
263 264 265
{
    if( i_count > 0 )
    {
266
        for( size_t i = 0; i < i_count; ++i )
267 268 269 270 271 272 273 274 275
        {
            free( pp_services[i]->psz_name );
            free( pp_services[i]->psz_longname );
        }
        free( *pp_services );
        free( pp_services );
    }
}

276
size_t
277
libvlc_media_discoverer_list_get( libvlc_instance_t *p_inst,
278 279
                                  libvlc_media_discoverer_category_t i_cat,
                                  libvlc_media_discoverer_description_t ***ppp_services )
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
{
    assert( p_inst != NULL && ppp_services != NULL );

    int i_core_cat;
    switch( i_cat )
    {
    case libvlc_media_discoverer_devices:
        i_core_cat = SD_CAT_DEVICES;
        break;
    case libvlc_media_discoverer_lan:
        i_core_cat = SD_CAT_LAN;
        break;
    case libvlc_media_discoverer_podcasts:
        i_core_cat = SD_CAT_INTERNET;
        break;
    case libvlc_media_discoverer_localdirs:
        i_core_cat = SD_CAT_MYCOMPUTER;
        break;
    default:
        vlc_assert_unreachable();
        *ppp_services = NULL;
301
        return 0;
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
    }

    /* Fetch all sd names, longnames and categories */
    char **ppsz_names, **ppsz_longnames;
    int *p_categories;
    ppsz_names = vlc_sd_GetNames( p_inst->p_libvlc_int, &ppsz_longnames,
                                  &p_categories );

    if( ppsz_names == NULL )
    {
        *ppp_services = NULL;
        return 0;
    }

    /* Count the number of sd matching our category (i_cat/i_core_cat) */
317
    size_t i_nb_services = 0;
318 319 320 321 322 323 324 325
    char **ppsz_name = ppsz_names;
    int *p_category = p_categories;
    for( ; *ppsz_name != NULL; ppsz_name++, p_category++ )
    {
        if( *p_category == i_core_cat )
            i_nb_services++;
    }

326
    libvlc_media_discoverer_description_t **pp_services = NULL, *p_services = NULL;
327 328 329 330 331 332 333
    if( i_nb_services > 0 )
    {
        /* Double alloc here, so that the caller iterates through pointers of
         * struct instead of structs. This allows us to modify the struct
         * without breaking the API. */

        pp_services = malloc( i_nb_services
334
                              * sizeof(libvlc_media_discoverer_description_t *) );
335
        p_services = malloc( i_nb_services
336
                             * sizeof(libvlc_media_discoverer_description_t) );
337 338 339 340 341 342
        if( pp_services == NULL || p_services == NULL )
        {
            free( pp_services );
            free( p_services );
            pp_services = NULL;
            p_services = NULL;
343
            i_nb_services = 0;
344 345 346 347 348 349 350 351 352 353
            /* Even if alloc fails, the next loop must be run in order to free
             * names returned by vlc_sd_GetNames */
        }
    }

    /* Fill output pp_services or free unused name, longname */
    char **ppsz_longname = ppsz_longnames;
    ppsz_name = ppsz_names;
    p_category = p_categories;
    unsigned int i_service_idx = 0;
354
    libvlc_media_discoverer_description_t *p_service = p_services;
355
    for( ; *ppsz_name != NULL; ppsz_name++, ppsz_longname++, p_category++ )
356 357 358 359 360 361
    {
        if( pp_services != NULL && *p_category == i_core_cat )
        {
            p_service->psz_name = *ppsz_name;
            p_service->psz_longname = *ppsz_longname;
            p_service->i_cat = i_cat;
362
            pp_services[i_service_idx++] = p_service++;
363 364 365 366 367 368 369 370 371 372 373 374 375 376
        }
        else
        {
            free( *ppsz_name );
            free( *ppsz_longname );
        }
    }
    free( ppsz_names );
    free( ppsz_longnames );
    free( p_categories );

    *ppp_services = pp_services;
    return i_nb_services;
}