vlc_modules.h 5.21 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1
/*****************************************************************************
zorglub's avatar
zorglub committed
2
 * modules.h : Module descriptor and load functions
Sam Hocevar's avatar
 
Sam Hocevar committed
3
 *****************************************************************************
4
 * Copyright (C) 2001 the VideoLAN team
5
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
6
7
8
9
10
11
12
 *
 * Authors: Samuel Hocevar <sam@zoy.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.
13
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
14
15
16
17
18
19
20
 * 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
dionoea's avatar
dionoea committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
22
23
 *****************************************************************************/

zorglub's avatar
zorglub committed
24
25
26
27
#if !defined( __LIBVLC__ )
  #error You are not libvlc or one of its plugins. You cannot include this file
#endif

28
#define MODULE_SHORTCUT_MAX 50
Sam Hocevar's avatar
 
Sam Hocevar committed
29
30

/* The module handle type. */
Sam Hocevar's avatar
Sam Hocevar committed
31
#if defined(HAVE_DL_DYLD)
32
33
34
#   if defined (HAVE_MACH_O_DYLD_H)
#       include <mach-o/dyld.h>
#   endif
Sam Hocevar's avatar
Sam Hocevar committed
35
36
37
38
39
40
41
42
43
typedef NSModule module_handle_t;
#elif defined(HAVE_IMAGE_H)
typedef int module_handle_t;
#elif defined(WIN32) || defined(UNDER_CE)
typedef void * module_handle_t;
#elif defined(HAVE_DL_DLOPEN)
typedef void * module_handle_t;
#elif defined(HAVE_DL_SHL_LOAD)
typedef shl_t module_handle_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
44
45
#endif

zorglub's avatar
zorglub committed
46
47
48
/**
 * Module descriptor
 */
49
#ifndef __PLUGIN__
50
/* FIXME: scheduled for privatization */
51
struct module_t
Sam Hocevar's avatar
   
Sam Hocevar committed
52
{
53
54
    VLC_COMMON_MEMBERS

Sam Hocevar's avatar
   
Sam Hocevar committed
55
56
57
    /*
     * Variables set by the module to identify itself
     */
zorglub's avatar
zorglub committed
58
59
60
    const char *psz_shortname;                              /**< Module name */
    const char *psz_longname;                   /**< Module descriptive name */
    const char *psz_help;        /**< Long help string for "special" modules */
Sam Hocevar's avatar
   
Sam Hocevar committed
61
62
63
64

    /*
     * Variables set by the module to tell us what it can do
     */
zorglub's avatar
zorglub committed
65
    const char *psz_program; /**< Program name which will activate the module */
66

zorglub's avatar
zorglub committed
67
68
    /** Shortcuts to the module */
    const char *pp_shortcuts[ MODULE_SHORTCUT_MAX ];
69

70
    char    *psz_capability;                                 /**< Capability */
zorglub's avatar
zorglub committed
71
72
    int      i_score;                          /**< Score for the capability */
    uint32_t i_cpu;                           /**< Required CPU capabilities */
Sam Hocevar's avatar
   
Sam Hocevar committed
73

zorglub's avatar
zorglub committed
74
75
76
    vlc_bool_t b_unloadable;                        /**< Can we be dlclosed? */
    vlc_bool_t b_reentrant;                           /**< Are we reentrant? */
    vlc_bool_t b_submodule;                        /**< Is this a submodule? */
Sam Hocevar's avatar
   
Sam Hocevar committed
77

78
79
80
    /* Callbacks */
    int  ( * pf_activate )   ( vlc_object_t * );
    void ( * pf_deactivate ) ( vlc_object_t * );
gbazin's avatar
   
gbazin committed
81
82
83
84

    /*
     * Variables set by the module to store its config options
     */
85
    module_config_t *p_config;             /* Module configuration structure */
86
    size_t           confsize;            /* Number of module_config_t items */
Sam Hocevar's avatar
Sam Hocevar committed
87
88
    unsigned int     i_config_items;        /* number of configuration items */
    unsigned int     i_bool_items;            /* number of bool config items */
Sam Hocevar's avatar
   
Sam Hocevar committed
89
90
91
92

    /*
     * Variables used internally by the module manager
     */
93
94
95
    /* Plugin-specific stuff */
    module_handle_t     handle;                             /* Unique handle */
    char *              psz_filename;                     /* Module filename */
Sam Hocevar's avatar
   
Sam Hocevar committed
96

97
    vlc_bool_t          b_builtin;  /* Set to true if the module is built in */
98
    vlc_bool_t          b_loaded;        /* Set to true if the dll is loaded */
99
};
100
#endif
Sam Hocevar's avatar
   
Sam Hocevar committed
101

Sam Hocevar's avatar
 
Sam Hocevar committed
102
103
104
/*****************************************************************************
 * Exported functions.
 *****************************************************************************/
gbazin's avatar
   
gbazin committed
105
106
#define module_Need(a,b,c,d) __module_Need(VLC_OBJECT(a),b,c,d)
VLC_EXPORT( module_t *, __module_Need, ( vlc_object_t *, const char *, const char *, vlc_bool_t ) );
107
108
#define module_Unneed(a,b) __module_Unneed(VLC_OBJECT(a),b)
VLC_EXPORT( void, __module_Unneed, ( vlc_object_t *, module_t * ) );
109
#define module_Exists(a,b) __module_Exists(VLC_OBJECT(a),b)
110
VLC_EXPORT( vlc_bool_t,  __module_Exists, ( vlc_object_t *, const char * ) );
111

112
VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
113
114
115
VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, void *value) );

116
enum vlc_module_properties
117
118
119
120
121
122
123
124
125
126
127
128
129
{
    /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
     * Append new items at the end ONLY. */
    VLC_MODULE_CPU_REQUIREMENT,
    VLC_MODULE_SHORTCUT,
    VLC_MODULE_SHORTNAME,
    VLC_MODULE_DESCRIPTION,
    VLC_MODULE_HELP,
    VLC_MODULE_CAPABILITY,
    VLC_MODULE_SCORE,
    VLC_MODULE_PROGRAM,
    VLC_MODULE_CB_OPEN,
    VLC_MODULE_CB_CLOSE,
130
131
    VLC_MODULE_UNLOADABLE,
    VLC_MODULE_NAME
132
};
133

134
135
136
137
VLC_EXPORT( vlc_bool_t, module_IsCapable, ( const module_t *m, const char *cap ) );
VLC_EXPORT( const char *, module_GetObjName, ( const module_t *m ) );
VLC_EXPORT( const char *, module_GetName, ( const module_t *m, vlc_bool_t long_name ) );