modules.h
上传用户:kjfoods
上传日期:2020-07-06
资源大小:29949k
文件大小:6k
源码类别:

midi

开发平台:

Unix_Linux

  1. /*****************************************************************************
  2.  * modules.h : Module management functions.
  3.  *****************************************************************************
  4.  * Copyright (C) 2001 the VideoLAN team
  5.  * $Id: 252abe5b491faf8834a81bb569bf89a0f9d0a1cb $
  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. #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
  24. # error This header file can only be included from LibVLC.
  25. #endif
  26. #ifndef __LIBVLC_MODULES_H
  27. # define __LIBVLC_MODULES_H 1
  28. /* Number of tries before we unload an unused module */
  29. #define MODULE_HIDE_DELAY 50
  30. /*****************************************************************************
  31.  * module_bank_t: the module bank
  32.  *****************************************************************************
  33.  * This variable is accessed by any function using modules.
  34.  *****************************************************************************/
  35. struct module_bank_t
  36. {
  37.     unsigned         i_usage;
  38.     bool             b_plugins;
  39.     /* Plugins cache */
  40.     bool             b_cache;
  41.     bool             b_cache_dirty;
  42.     int            i_cache;
  43.     module_cache_t **pp_cache;
  44.     int            i_loaded_cache;
  45.     module_cache_t **pp_loaded_cache;
  46.     module_t       *head;
  47. };
  48. /*****************************************************************************
  49.  * Module cache description structure
  50.  *****************************************************************************/
  51. struct module_cache_t
  52. {
  53.     /* Mandatory cache entry header */
  54.     char       *psz_file;
  55.     int64_t    i_time;
  56.     int64_t    i_size;
  57.     bool b_junk;
  58.     /* Optional extra data */
  59.     module_t *p_module;
  60.     bool b_used;
  61. };
  62. #define MODULE_SHORTCUT_MAX 50
  63. /* The module handle type. */
  64. #if defined(HAVE_DL_DYLD) && !defined(__x86_64__)
  65. #   if defined (HAVE_MACH_O_DYLD_H)
  66. #       include <mach-o/dyld.h>
  67. #   endif
  68. typedef NSModule module_handle_t;
  69. #elif defined(HAVE_IMAGE_H)
  70. typedef int module_handle_t;
  71. #elif defined(WIN32) || defined(UNDER_CE)
  72. typedef void * module_handle_t;
  73. #elif defined(HAVE_DL_DLOPEN)
  74. typedef void * module_handle_t;
  75. #elif defined(HAVE_DL_SHL_LOAD)
  76. typedef shl_t module_handle_t;
  77. #endif
  78. /**
  79.  * Internal module descriptor
  80.  */
  81. struct module_t
  82. {
  83.     char       *psz_object_name;
  84.     module_t   *next;
  85.     module_t   *submodule;
  86.     module_t   *parent;
  87.     unsigned    submodule_count;
  88.     gc_object_t vlc_gc_data;
  89.     vlc_mutex_t lock;
  90.     /*
  91.      * Variables set by the module to identify itself
  92.      */
  93.     char *psz_shortname;                              /**< Module name */
  94.     char *psz_longname;                   /**< Module descriptive name */
  95.     char *psz_help;        /**< Long help string for "special" modules */
  96.     /** Shortcuts to the module */
  97.     char *pp_shortcuts[ MODULE_SHORTCUT_MAX ];
  98.     char    *psz_capability;                                 /**< Capability */
  99.     int      i_score;                          /**< Score for the capability */
  100.     uint32_t i_cpu;                           /**< Required CPU capabilities */
  101.     bool b_unloadable;                        /**< Can we be dlclosed? */
  102.     bool b_reentrant;                           /**< Are we reentrant? */
  103.     bool b_submodule;                        /**< Is this a submodule? */
  104.     /* Callbacks */
  105.     int  ( * pf_activate )   ( vlc_object_t * );
  106.     void ( * pf_deactivate ) ( vlc_object_t * );
  107.     /*
  108.      * Variables set by the module to store its config options
  109.      */
  110.     module_config_t *p_config;             /* Module configuration structure */
  111.     size_t           confsize;            /* Number of module_config_t items */
  112.     unsigned int     i_config_items;        /* number of configuration items */
  113.     unsigned int     i_bool_items;            /* number of bool config items */
  114.     /*
  115.      * Variables used internally by the module manager
  116.      */
  117.     /* Plugin-specific stuff */
  118.     module_handle_t     handle;                             /* Unique handle */
  119.     char *              psz_filename;                     /* Module filename */
  120.     bool          b_builtin;  /* Set to true if the module is built in */
  121.     bool          b_loaded;        /* Set to true if the dll is loaded */
  122. };
  123. module_t *vlc_module_create (vlc_object_t *);
  124. module_t *vlc_submodule_create (module_t *module);
  125. #define module_InitBank(a)     __module_InitBank(VLC_OBJECT(a))
  126. void  __module_InitBank        ( vlc_object_t * );
  127. void module_LoadPlugins( vlc_object_t *, bool );
  128. #define module_LoadPlugins(a,b) module_LoadPlugins(VLC_OBJECT(a),b)
  129. void module_EndBank( vlc_object_t *, bool );
  130. #define module_EndBank(a,b) module_EndBank(VLC_OBJECT(a), b)
  131. /* Low-level OS-dependent handler */
  132. int  module_Load   (vlc_object_t *, const char *, module_handle_t *);
  133. int  module_Call   (vlc_object_t *obj, module_t *);
  134. void module_Unload (module_handle_t);
  135. /* Plugins cache */
  136. void   CacheMerge (vlc_object_t *, module_t *, module_t *);
  137. void   CacheLoad  (vlc_object_t *, module_bank_t *, bool);
  138. void   CacheSave  (vlc_object_t *, module_bank_t *);
  139. module_cache_t * CacheFind (module_bank_t *, const char *, int64_t, int64_t);
  140. #endif /* !__LIBVLC_MODULES_H */