mirror of
https://github.com/videolan/vlc.git
synced 2025-01-25 09:06:20 +08:00
113 lines
4.4 KiB
C
113 lines
4.4 KiB
C
/*****************************************************************************
|
|
* modules.h : Module descriptor and load functions
|
|
*****************************************************************************
|
|
* Copyright (C) 2001 the VideoLAN team
|
|
* $Id$
|
|
*
|
|
* 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.
|
|
*
|
|
* 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
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
|
|
*****************************************************************************/
|
|
|
|
#if !defined( __LIBVLC__ )
|
|
#error You are not libvlc or one of its plugins. You cannot include this file
|
|
#endif
|
|
|
|
#define MODULE_SHORTCUT_MAX 50
|
|
|
|
/* The module handle type. */
|
|
#if defined(HAVE_DL_DYLD)
|
|
# if defined (HAVE_MACH_O_DYLD_H)
|
|
# include <mach-o/dyld.h>
|
|
# endif
|
|
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;
|
|
#endif
|
|
|
|
/**
|
|
* Module descriptor
|
|
*/
|
|
struct module_t
|
|
{
|
|
VLC_COMMON_MEMBERS
|
|
|
|
/*
|
|
* Variables set by the module to identify itself
|
|
*/
|
|
const char *psz_shortname; /**< Module name */
|
|
const char *psz_longname; /**< Module descriptive name */
|
|
const char *psz_help; /**< Long help string for "special" modules */
|
|
|
|
/*
|
|
* Variables set by the module to tell us what it can do
|
|
*/
|
|
const char *psz_program; /**< Program name which will activate the module */
|
|
|
|
/** Shortcuts to the module */
|
|
const char *pp_shortcuts[ MODULE_SHORTCUT_MAX ];
|
|
|
|
const char *psz_capability; /**< Capability */
|
|
int i_score; /**< Score for the capability */
|
|
uint32_t i_cpu; /**< Required CPU capabilities */
|
|
|
|
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? */
|
|
|
|
/* Callbacks */
|
|
int ( * pf_activate ) ( vlc_object_t * );
|
|
void ( * pf_deactivate ) ( vlc_object_t * );
|
|
|
|
/*
|
|
* Variables set by the module to store its config options
|
|
*/
|
|
module_config_t *p_config; /* Module configuration structure */
|
|
size_t confsize; /* Number of module_config_t items */
|
|
unsigned int i_config_items; /* number of configuration items */
|
|
unsigned int i_bool_items; /* number of bool config items */
|
|
|
|
/*
|
|
* Variables used internally by the module manager
|
|
*/
|
|
/* Plugin-specific stuff */
|
|
module_handle_t handle; /* Unique handle */
|
|
char * psz_filename; /* Module filename */
|
|
|
|
vlc_bool_t b_builtin; /* Set to true if the module is built in */
|
|
vlc_bool_t b_loaded; /* Set to true if the dll is loaded */
|
|
|
|
/*
|
|
* Symbol table we send to the module so that it can access vlc symbols
|
|
*/
|
|
module_symbols_t *p_symbols;
|
|
};
|
|
|
|
/*****************************************************************************
|
|
* Exported functions.
|
|
*****************************************************************************/
|
|
#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 ) );
|
|
#define module_Unneed(a,b) __module_Unneed(VLC_OBJECT(a),b)
|
|
VLC_EXPORT( void, __module_Unneed, ( vlc_object_t *, module_t * ) );
|
|
#define module_Exist(a,b) __module_Exists(VLC_OBJECT(a),b)
|
|
VLC_EXPORT( vlc_bool_t, __module_Exists, ( vlc_object_t *, const char * ) );
|