git.sesse.net Git - vlc/blob - src/modules/modules.h

   1 /*****************************************************************************
   2  * modules.h : Module management functions.
   3  *****************************************************************************
   4  * Copyright (C) 2001 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 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 General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
  25 # error This header file can only be included from LibVLC.
  26 #endif
  27
  28 #ifndef LIBVLC_MODULES_H
  29 # define LIBVLC_MODULES_H 1
  30
  31
  32 /* Number of tries before we unload an unused module */
  33 #define MODULE_HIDE_DELAY 50
  34
  35 /*****************************************************************************
  36  * module_bank_t: the module bank
  37  *****************************************************************************
  38  * This variable is accessed by any function using modules.
  39  *****************************************************************************/
  40 struct module_bank_t
  41 {
  42     unsigned         i_usage;
  43
  44     /* Plugins cache */
  45     bool             b_cache;
  46     bool             b_cache_dirty;
  47
  48     int            i_cache;
  49     module_cache_t **pp_cache;
  50
  51     int            i_loaded_cache;
  52     module_cache_t **pp_loaded_cache;
  53
  54     module_t       *head;
  55 };
  56
  57 /*****************************************************************************
  58  * Module cache description structure
  59  *****************************************************************************/
  60 struct module_cache_t
  61 {
  62     /* Mandatory cache entry header */
  63     char       *psz_file;
  64     int64_t    i_time;
  65     int64_t    i_size;
  66
  67     /* Optional extra data */
  68     module_t *p_module;
  69 };
  70
  71
  72 #define MODULE_SHORTCUT_MAX 20
  73
  74 /* The module handle type. */
  75 #if defined(HAVE_DL_DYLD) && !defined(__x86_64__)
  76 #   if defined (HAVE_MACH_O_DYLD_H)
  77 #       include <mach-o/dyld.h>
  78 #   endif
  79 typedef NSModule module_handle_t;
  80 #elif defined(HAVE_IMAGE_H)
  81 typedef int module_handle_t;
  82 #elif defined(WIN32) || defined(UNDER_CE)
  83 typedef void * module_handle_t;
  84 #elif defined(HAVE_DL_DLOPEN)
  85 typedef void * module_handle_t;
  86 #elif defined(HAVE_DL_SHL_LOAD)
  87 typedef shl_t module_handle_t;
  88 #endif
  89
  90 /**
  91  * Internal module descriptor
  92  */
  93 struct module_t
  94 {
  95     char       *psz_object_name;
  96     module_t   *next;
  97     module_t   *submodule;
  98     module_t   *parent;
  99     unsigned    submodule_count;
 100     gc_object_t vlc_gc_data;
 101
 102     /*
 103      * Variables set by the module to identify itself
 104      */
 105     char *psz_shortname;                              /**< Module name */
 106     char *psz_longname;                   /**< Module descriptive name */
 107     char *psz_help;        /**< Long help string for "special" modules */
 108
 109     /** Shortcuts to the module */
 110     char *pp_shortcuts[ MODULE_SHORTCUT_MAX ];
 111
 112     char    *psz_capability;                                 /**< Capability */
 113     int      i_score;                          /**< Score for the capability */
 114
 115     bool b_unloadable;                        /**< Can we be dlclosed? */
 116     bool b_submodule;                        /**< Is this a submodule? */
 117
 118     /* Callbacks */
 119     int  ( * pf_activate )   ( vlc_object_t * );
 120     void ( * pf_deactivate ) ( vlc_object_t * );
 121
 122     /*
 123      * Variables set by the module to store its config options
 124      */
 125     module_config_t *p_config;             /* Module configuration structure */
 126     size_t           confsize;            /* Number of module_config_t items */
 127     unsigned int     i_config_items;        /* number of configuration items */
 128     unsigned int     i_bool_items;            /* number of bool config items */
 129
 130     /*
 131      * Variables used internally by the module manager
 132      */
 133     /* Plugin-specific stuff */
 134     module_handle_t     handle;                             /* Unique handle */
 135     char *              psz_filename;                     /* Module filename */
 136     char *              domain;                            /* gettext domain */
 137
 138     bool          b_builtin;  /* Set to true if the module is built in */
 139     bool          b_loaded;        /* Set to true if the dll is loaded */
 140 };
 141
 142 module_t *vlc_module_create (vlc_object_t *);
 143 module_t *vlc_submodule_create (module_t *module);
 144
 145 void  module_InitBank( vlc_object_t * );
 146 #define module_InitBank(a) module_InitBank(VLC_OBJECT(a))
 147 void module_LoadPlugins( vlc_object_t * );
 148 #define module_LoadPlugins(a) module_LoadPlugins(VLC_OBJECT(a))
 149 void module_EndBank( vlc_object_t *, bool );
 150 #define module_EndBank(a,b) module_EndBank(VLC_OBJECT(a), b)
 151
 152 int vlc_bindtextdomain (const char *);
 153
 154 /* Low-level OS-dependent handler */
 155 int  module_Load   (vlc_object_t *, const char *, module_handle_t *);
 156 int  module_Call   (vlc_object_t *obj, module_t *);
 157 void module_Unload (module_handle_t);
 158
 159 /* Plugins cache */
 160 void   CacheMerge (vlc_object_t *, module_t *, module_t *);
 161 void   CacheDelete(vlc_object_t *, const char *);
 162 void   CacheLoad  (vlc_object_t *, module_bank_t *, const char *);
 163 void   CacheSave  (vlc_object_t *, const char *, module_cache_t *const *, size_t);
 164 module_cache_t * CacheFind (module_bank_t *, const char *, int64_t, int64_t);
 165
 166 #endif /* !LIBVLC_MODULES_H */