136 lines
4.5 KiB
C
136 lines
4.5 KiB
C
/*
|
|
plugin.h - Plugin loader
|
|
|
|
Copyright (C) CinelerraCV
|
|
2007, Christian Thaeter <ct@pipapo.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., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
*/
|
|
#ifndef CINELERRA_PLUGIN_H
|
|
#define CINELERRA_PLUGIN_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#elif 0
|
|
} /*eek, fixes emacs indenting for now*/
|
|
#endif
|
|
|
|
#include <stdlib.h>
|
|
#include <nobug.h>
|
|
|
|
#include "error.h"
|
|
|
|
/**
|
|
* @file Plugin loader, header.
|
|
*/
|
|
|
|
|
|
NOBUG_DECLARE_FLAG (cinelerra_plugin);
|
|
|
|
/* tool macros*/
|
|
#define CINELERRA_INTERFACE_TYPE(name, version) struct cinelerra_interface_##name##_##version
|
|
#define CINELERRA_INTERFACE_CAST(name, version) (CINELERRA_INTERFACE_TYPE(name, version)*)
|
|
|
|
/* Interface definition */
|
|
#define CINELERRA_INTERFACE(name, version, ...) \
|
|
CINELERRA_INTERFACE_TYPE(name, version) \
|
|
{ \
|
|
struct cinelerra_interface interface_header_; \
|
|
__VA_ARGS__ \
|
|
}
|
|
|
|
#define CINELERRA_INTERFACE_PROTO(ret, name, params) ret (*name) params;
|
|
|
|
/* Interface instantiation */
|
|
#define CINELERRA_INTERFACE_IMPLEMENT(iname, version, name, open, close, ...) \
|
|
CINELERRA_INTERFACE_TYPE(iname, version) name##_##version = \
|
|
{ \
|
|
{ \
|
|
version, \
|
|
sizeof(CINELERRA_INTERFACE_TYPE(iname, version)), \
|
|
NULL, \
|
|
0, \
|
|
open, \
|
|
close \
|
|
}, \
|
|
__VA_ARGS__ \
|
|
}
|
|
|
|
|
|
|
|
/* internally used */
|
|
struct cinelerra_plugin;
|
|
|
|
/**
|
|
* This is the header for any interface exported by plugins.
|
|
* Real interfaces append their functions at the end. There are few standard functions on each Interface
|
|
* Every function is required to be implemnted.
|
|
*/
|
|
struct cinelerra_interface
|
|
{
|
|
/// interface version number
|
|
unsigned version;
|
|
/// size of the full structure is used to determine the revision (adding a new function increments the size)
|
|
size_t size;
|
|
/// back reference to plugin
|
|
struct cinelerra_plugin* plugin;
|
|
/// incremented for each user of this interface and decremented when closed
|
|
unsigned use_count;
|
|
|
|
/// called for each open of this interface
|
|
int (*open)(void);
|
|
/// called for each close of this interface
|
|
int (*close)(void);
|
|
};
|
|
|
|
void
|
|
cinelerra_init_plugin (void);
|
|
|
|
|
|
struct cinelerra_interface*
|
|
cinelerra_interface_open (const char* plugin, const char* name, size_t min_revision);
|
|
|
|
|
|
void
|
|
cinelerra_interface_close (void* self);
|
|
|
|
/**
|
|
* Tries to unload a plugin.
|
|
* When the Plugin is unused, then all resources associated with it are freed and it will be removed from memory
|
|
* @param plugin name of the plugin to be unloaded.
|
|
* @return 0 on success, else the number if users which keeping the plugin loaded
|
|
*/
|
|
int
|
|
cinelerra_plugin_unload (const char* plugin);
|
|
|
|
/**
|
|
* Tries to unload plugins which are not in use.
|
|
* Calls cinelerra_plugin_unload() for each Plugin which is not used for more than age seconds.
|
|
* This function might be infrequently called by the scheduler to remove things which are not needed.
|
|
* @param age timeout in seconds when to unload plugins
|
|
*/
|
|
void
|
|
cinelerra_plugin_expire (time_t age);
|
|
|
|
CINELERRA_ERROR_DECLARE(PLUGIN_DLOPEN);
|
|
CINELERRA_ERROR_DECLARE(PLUGIN_HOOK);
|
|
CINELERRA_ERROR_DECLARE(PLUGIN_NFILE);
|
|
CINELERRA_ERROR_DECLARE(PLUGIN_NIFACE);
|
|
CINELERRA_ERROR_DECLARE(PLUGIN_REVISION);
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
#endif /* CINELERRA_PLUGIN_H */
|