include/vlc_modules.h

   1 /*****************************************************************************
   2  * modules.h : Module descriptor and load 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( __LIBVLC__ )
  25   #error You are not libvlc or one of its plugins. You cannot include this file
  26 #endif
  27
  28 #define MODULE_SHORTCUT_MAX 50
  29
  30 /* The module handle type. */
  31 #if defined(HAVE_DL_DYLD)
  32 #   if defined (HAVE_MACH_O_DYLD_H)
  33 #       include <mach-o/dyld.h>
  34 #   endif
  35 typedef NSModule module_handle_t;
  36 #elif defined(HAVE_IMAGE_H)
  37 typedef int module_handle_t;
  38 #elif defined(WIN32) || defined(UNDER_CE)
  39 typedef void * module_handle_t;
  40 #elif defined(HAVE_DL_DLOPEN)
  41 typedef void * module_handle_t;
  42 #elif defined(HAVE_DL_SHL_LOAD)
  43 typedef shl_t module_handle_t;
  44 #endif
  45
  46 /**
  47  * Module descriptor
  48  */
  49 #ifndef __PLUGIN__FIXME___
  50 /* FIXME: scheduled for privatization */
  51 struct module_t
  52 {
  53     VLC_COMMON_MEMBERS
  54
  55     /*
  56      * Variables set by the module to identify itself
  57      */
  58     const char *psz_shortname;                              /**< Module name */
  59     const char *psz_longname;                   /**< Module descriptive name */
  60     const char *psz_help;        /**< Long help string for "special" modules */
  61
  62     /*
  63      * Variables set by the module to tell us what it can do
  64      */
  65     const char *psz_program; /**< Program name which will activate the module */
  66
  67     /** Shortcuts to the module */
  68     const char *pp_shortcuts[ MODULE_SHORTCUT_MAX ];
  69
  70     char    *psz_capability;                                 /**< Capability */
  71     int      i_score;                          /**< Score for the capability */
  72     uint32_t i_cpu;                           /**< Required CPU capabilities */
  73
  74     vlc_bool_t b_unloadable;                        /**< Can we be dlclosed? */
  75     vlc_bool_t b_reentrant;                           /**< Are we reentrant? */
  76     vlc_bool_t b_submodule;                        /**< Is this a submodule? */
  77
  78     /* Callbacks */
  79     int  ( * pf_activate )   ( vlc_object_t * );
  80     void ( * pf_deactivate ) ( vlc_object_t * );
  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
  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
 101
 102 /*****************************************************************************
 103  * Exported functions.
 104  *****************************************************************************/
 105 #define module_Need(a,b,c,d) __module_Need(VLC_OBJECT(a),b,c,d)
 106 VLC_EXPORT( module_t *, __module_Need, ( vlc_object_t *, const char *, const char *, vlc_bool_t ) );
 107 #define module_Unneed(a,b) __module_Unneed(VLC_OBJECT(a),b)
 108 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 /* Use only if you know what you're doing... */
 113 #define module_FindName(a,b) __module_FindName(VLC_OBJECT(a),b)
 114 VLC_EXPORT( module_t *, __module_FindName, ( vlc_object_t *, const char * ) );
 115
 116 /* Return a NULL terminated array with the names of the modules that have a
 117  * certain capability.
 118  * Free after uses both the string and the table. */
 119  #define module_GetModulesNamesForCapability(a,b) \
 120                     __module_GetModulesNamesForCapability(VLC_OBJECT(a),b)
 121 VLC_EXPORT(char **, __module_GetModulesNamesForCapability,
 122                     ( vlc_object_t *p_this, const char * psz_capability ) );
 123
 124 VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
 125 VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
 126 VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, void *value) );
 127
 128 enum vlc_module_properties
 129 {
 130     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
 131      * Append new items at the end ONLY. */
 132     VLC_MODULE_CPU_REQUIREMENT,
 133     VLC_MODULE_SHORTCUT,
 134     VLC_MODULE_SHORTNAME,
 135     VLC_MODULE_DESCRIPTION,
 136     VLC_MODULE_HELP,
 137     VLC_MODULE_CAPABILITY,
 138     VLC_MODULE_SCORE,
 139     VLC_MODULE_PROGRAM,
 140     VLC_MODULE_CB_OPEN,
 141     VLC_MODULE_CB_CLOSE,
 142     VLC_MODULE_UNLOADABLE,
 143     VLC_MODULE_NAME
 144 };
 145
 146 VLC_EXPORT( vlc_bool_t, module_IsCapable, ( const module_t *m, const char *cap ) );
 147 VLC_EXPORT( const char *, module_GetObjName, ( const module_t *m ) );
 148 VLC_EXPORT( const char *, module_GetName, ( const module_t *m, vlc_bool_t long_name ) );
 149 #define module_GetLongName( m ) module_GetName( m, VLC_TRUE )
 150 VLC_EXPORT( const char *, module_GetHelp, ( const module_t *m ) );