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 #ifndef LIBVLC_MODULES_H
  25 # define LIBVLC_MODULES_H 1
  26
  27 typedef struct module_cache_t module_cache_t;
  28
  29 /*****************************************************************************
  30  * Module cache description structure
  31  *****************************************************************************/
  32 struct module_cache_t
  33 {
  34     /* Mandatory cache entry header */
  35     char  *path;
  36     time_t mtime;
  37     off_t  size;
  38
  39     /* Optional extra data */
  40     module_t *p_module;
  41 };
  42
  43
  44 #define MODULE_SHORTCUT_MAX 20
  45
  46 /** The module handle type */
  47 typedef void *module_handle_t;
  48
  49 typedef module_t *(*vlc_plugin_cb) (void);
  50
  51 /**
  52  * Internal module descriptor
  53  */
  54 struct module_t
  55 {
  56     module_t   *next;
  57     module_t   *parent;
  58     module_t   *submodule;
  59     unsigned    submodule_count;
  60
  61     /** Shortcuts to the module */
  62     unsigned    i_shortcuts;
  63     char        **pp_shortcuts;
  64
  65     /*
  66      * Variables set by the module to identify itself
  67      */
  68     char *psz_shortname;                              /**< Module name */
  69     char *psz_longname;                   /**< Module descriptive name */
  70     char *psz_help;        /**< Long help string for "special" modules */
  71
  72     char    *psz_capability;                                 /**< Capability */
  73     int      i_score;                          /**< Score for the capability */
  74
  75     bool          b_loaded;        /* Set to true if the dll is loaded */
  76     bool b_unloadable;                        /**< Can we be dlclosed? */
  77
  78     /* Callbacks */
  79     void *pf_activate;
  80     void *pf_deactivate;
  81
  82     /*
  83      * Variables set by the module to store its config options
  84      */
  85     module_config_t *p_config;             /* Module configuration structure */
  86     size_t           confsize;            /* Number of module_config_t items */
  87     unsigned int     i_config_items;        /* number of configuration items */
  88     unsigned int     i_bool_items;            /* number of bool config items */
  89
  90     /*
  91      * Variables used internally by the module manager
  92      */
  93     /* Plugin-specific stuff */
  94     module_handle_t     handle;                             /* Unique handle */
  95     char *              psz_filename;                     /* Module filename */
  96     char *              domain;                            /* gettext domain */
  97 };
  98
  99 module_t *vlc_module_create (module_t *);
 100 void vlc_module_destroy (module_t *);
 101
 102 void module_InitBank (void);
 103 void module_LoadPlugins( vlc_object_t * );
 104 #define module_LoadPlugins(a) module_LoadPlugins(VLC_OBJECT(a))
 105 void module_EndBank (bool);
 106 int module_Map (vlc_object_t *, module_t *);
 107
 108 int vlc_bindtextdomain (const char *);
 109
 110 /* Low-level OS-dependent handler */
 111 int module_Load (vlc_object_t *, const char *, module_handle_t *, bool);
 112 void *module_Lookup (module_handle_t, const char *);
 113 void module_Unload (module_handle_t);
 114
 115 /* Plugins cache */
 116 void   CacheMerge (vlc_object_t *, module_t *, module_t *);
 117 void   CacheDelete(vlc_object_t *, const char *);
 118 size_t CacheLoad  (vlc_object_t *, const char *, module_cache_t **);
 119 int CacheAdd (module_cache_t **, size_t *,
 120               const char *, const struct stat *, module_t *);
 121 void CacheSave  (vlc_object_t *, const char *, module_cache_t *, size_t);
 122 module_t *CacheFind (module_cache_t *, size_t,
 123                      const char *, const struct stat *);
 124
 125 #endif /* !LIBVLC_MODULES_H */