vlc_services_discovery.h 4.56 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*****************************************************************************
 * vlc_services_discovery.h : Services Discover functions
 *****************************************************************************
 * Copyright (C) 1999-2004 the VideoLAN team
 * $Id$
 *
 * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (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
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU 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.
 *****************************************************************************/

24 25
#ifndef VLC_SERVICES_DISCOVERY_H_
#define VLC_SERVICES_DISCOVERY_H_
26

27 28 29 30
#include <vlc_input.h>
#include <vlc_events.h>
#include <vlc_probe.h>

31 32 33 34 35
/**
 * \file
 * This file functions and structures for service discovery in vlc
 */

36 37 38 39 40 41 42 43 44 45 46
# ifdef __cplusplus
extern "C" {
# endif

/*
 * @{
 */

struct services_discovery_t
{
    VLC_COMMON_MEMBERS
47 48 49 50 51 52 53
    module_t *          p_module;

    vlc_event_manager_t event_manager;      /* Accessed through Setters for non class function */

    char *psz_name;
    config_chain_t *p_cfg;

54 55
    int ( *pf_search ) ( services_discovery_t *, const char * );

56 57 58
    services_discovery_sys_t *p_sys;
};

59 60 61 62 63 64 65 66
enum services_discovery_category_e
{
    SD_CAT_DEVICES = 1,
    SD_CAT_LAN,
    SD_CAT_INTERNET,
    SD_CAT_MYCOMPUTER
};

67 68 69 70
/***********************************************************************
 * Service Discovery
 ***********************************************************************/

71 72 73 74 75 76 77 78 79 80 81 82 83 84
/**
 * Ask for a research in the SD
 * @param p_sd: the Service Discovery
 * @param psz_query: the query
 * @return VLC_SUCCESS in case of success, the error code overwise
 */
static inline int vlc_sd_search( services_discovery_t *p_sd, const char *psz_query )
{
    if( p_sd->pf_search )
        return p_sd->pf_search( p_sd, psz_query );
    else
        return VLC_EGENERIC;
}

85 86
/* Get the services discovery modules names to use in Create(), in a null
 * terminated string array. Array and string must be freed after use. */
87
VLC_EXPORT( char **, vlc_sd_GetNames, ( vlc_object_t *, char ***, int ** ) LIBVLC_USED );
88 89
#define vlc_sd_GetNames(obj, pln, pcat ) \
        vlc_sd_GetNames(VLC_OBJECT(obj), pln, pcat)
90 91

/* Creation of a service_discovery object */
92
VLC_EXPORT( services_discovery_t *, vlc_sd_Create, ( vlc_object_t *, const char * ) LIBVLC_USED );
93
VLC_EXPORT( bool, vlc_sd_Start, ( services_discovery_t * ) );
94
VLC_EXPORT( void, vlc_sd_Stop, ( services_discovery_t * ) );
95
VLC_EXPORT( void, vlc_sd_Destroy, ( services_discovery_t * ) );
96 97 98 99 100

static inline void vlc_sd_StopAndDestroy( services_discovery_t * p_this )
{
    vlc_sd_Stop( p_this );
    vlc_sd_Destroy( p_this );
101
}
102 103

/* Read info from discovery object */
104
VLC_EXPORT( char *,                 services_discovery_GetLocalizedName, ( services_discovery_t * p_this ) LIBVLC_USED );
105

Sam Hocevar's avatar
Sam Hocevar committed
106
/* Receive event notification (preferred way to get new items) */
107
VLC_EXPORT( vlc_event_manager_t *,  services_discovery_EventManager, ( services_discovery_t * p_this ) LIBVLC_USED );
108 109 110 111 112 113 114

/* Used by services_discovery to post update about their items */
    /* About the psz_category, it is a legacy way to add info to the item,
     * for more options, directly set the (meta) data on the input item */
VLC_EXPORT( void,                   services_discovery_AddItem, ( services_discovery_t * p_this, input_item_t * p_item, const char * psz_category ) );
VLC_EXPORT( void,                   services_discovery_RemoveItem, ( services_discovery_t * p_this, input_item_t * p_item ) );

115 116 117

/* SD probing */

118
VLC_EXPORT(int, vlc_sd_probe_Add, (vlc_probe_t *, const char *, const char *, int category));
119 120 121 122 123 124

#define VLC_SD_PROBE_SUBMODULE \
    add_submodule() \
        set_capability( "services probe", 100 ) \
        set_callbacks( vlc_sd_probe_Open, NULL )

125
#define VLC_SD_PROBE_HELPER(name, longname, cat) \
126 127
static int vlc_sd_probe_Open (vlc_object_t *obj) \
{ \
128
    return vlc_sd_probe_Add ((struct vlc_probe_t *)obj, \
129 130
                             name "{longname=\"" longname "\"}", \
                             longname, cat); \
131 132
}

133 134 135 136 137 138
/** @} */
# ifdef __cplusplus
}
# endif

#endif