trunk/libfjme/plug-ins.h

Go to the documentation of this file.

/*
A GTK video editor Designed for Artists to do, special effects, compositing and animation.
Copyright (C) 2011  Fabio J. Gonzalez

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 3 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, see <http://www.gnu.org/licenses/>.
 */

#include "video.h"
#include "gtk/gtk.h"

#ifndef FJME_PLUG_INS_H
#define FJME_PLUG_INS_H 1

#define findPluginByName(x) \
  findPlugin( (x), NULL, NULL, NULL, NULL )

#define findPluginByIName(x) \
  findPlugin( NULL, (x), NULL, NULL, NULL )

#define findPluginByPath(x) \
  findPlugin( NULL, NULL, (x), NULL, NULL )

#define findPluginByLayer(x) \
  findPlugin( NULL, NULL, NULL, (x), NULL )

#define findPluginByType(x) \
  findPlugin( NULL, NULL, NULL, NULL, (x) )

#define PLUGIN(x) ((iPlugin*)(x))

struct iPlugin;
typedef struct iPlugin iPlugin;

typedef void (* PluginCallFunc) (iPlugin* p);

/*
Prepare to call dynamically, the functions
of the plugins and returns a new "Plugin".
 */

iPlugin* LoadPlugin(const gchar* file_name, gpointer data);

iPlugin* addPlugin(PluginCallFunc init, PluginCallFunc frame, PluginCallFunc end, gpointer data);

iPlugin* addEffect(iPlugin* p, Layer* l);

void setupEffect( iPlugin* p, Layer* l );

GList* findPlugin(gchar* name, gchar* iname, gchar* path, gchar* layer_name, gchar* type);

/*
 * The plugins have an identification
 * name used internally only.
 * Per example: Layers Window,
 * Tools Window
 */

iPlugin* findInternalPlugin(gchar* iname);

iPlugin* findPluginByWidget(GtkWidget*);

void delPlugin(iPlugin* p);

/* 
Invokes the function "config". It provides
  the user the option to allocate space
for the plugin. Adds the plugin list.
 */

iPlugin* addConfig(PluginCallFunc config, PluginCallFunc init,
        PluginCallFunc frame, PluginCallFunc end, iPlugin* p);


/*
This "struct" identifies the plugin while it is passed to the plugin.
It has all the information that the plugin requires.
 */

struct iPlugin {
    gchar *name;

    gchar *iname;

    gchar *path;

    gchar *type;

    gchar *description;

    union {
        gboolean call_me;

        gboolean active;
    };
    GModule *module;

    gboolean selected;

    gboolean central;

    Main *m;

    GdkPixbuf* pixels;

    gdouble* x;

    gdouble* y;

    gdouble* width;

    gdouble* height;

    gdouble *opacity;

    GtkWidget *widget;

    Layer *layer;

    PluginCallFunc Init;

    PluginCallFunc Frame;

    PluginCallFunc End;

    PluginCallFunc Config;

    gpointer data;

    gpointer data2;

    gpointer data3;

    gpointer data4;

    gpointer data5;

    gpointer data6;
    
    iPlugin* parent;
    GList* child;
};

#endif