frei0r.h

Go to the documentation of this file.

 
#ifndef INCLUDED_FREI0R_H
#define INCLUDED_FREI0R_H
 
#include <inttypes.h>
 
/*
 * Bundle builds give every plugin a private, token-prefixed copy of the
 * frei0r entry points.  Ordinary module builds leave these names untouched.
 * CMake validates that FREI0R_BUNDLE_PLUGIN_TOKEN is a C identifier before
 * adding it to a bundle target.
 */
#ifdef FREI0R_BUNDLE_PLUGIN_TOKEN
#define F0R_BUNDLE_CONCAT_INNER(left, right) left##right
#define F0R_BUNDLE_CONCAT(left, right) F0R_BUNDLE_CONCAT_INNER(left, right)
#define F0R_BUNDLE_ENTRY(name) \
  F0R_BUNDLE_CONCAT(FREI0R_BUNDLE_PLUGIN_TOKEN, F0R_BUNDLE_CONCAT(_, name))
 
#define f0r_init F0R_BUNDLE_ENTRY(f0r_init)
#define f0r_deinit F0R_BUNDLE_ENTRY(f0r_deinit)
#define f0r_get_plugin_info F0R_BUNDLE_ENTRY(f0r_get_plugin_info)
#define f0r_get_param_info F0R_BUNDLE_ENTRY(f0r_get_param_info)
#define f0r_construct F0R_BUNDLE_ENTRY(f0r_construct)
#define f0r_destruct F0R_BUNDLE_ENTRY(f0r_destruct)
#define f0r_set_param_value F0R_BUNDLE_ENTRY(f0r_set_param_value)
#define f0r_get_param_value F0R_BUNDLE_ENTRY(f0r_get_param_value)
#define f0r_update F0R_BUNDLE_ENTRY(f0r_update)
#define f0r_update2 F0R_BUNDLE_ENTRY(f0r_update2)
 
/* Bundle objects are linked into one library, never loaded as modules. */
#undef FREI0R_PUBLIC
#if defined(_WIN32) || defined(__CYGWIN__)
#define FREI0R_PUBLIC
#elif defined(__GNUC__) && __GNUC__ >= 4
#define FREI0R_PUBLIC __attribute__((visibility("hidden")))
#else
#define FREI0R_PUBLIC
#endif
#endif
 
#ifndef FREI0R_PUBLIC
#if defined(_WIN32) || defined(__CYGWIN__)
#if defined(FREI0R_PLUGIN)
#define FREI0R_PUBLIC __declspec(dllexport)
#else
#define FREI0R_PUBLIC
#endif
#elif defined(__GNUC__) && __GNUC__ >= 4
#define FREI0R_PUBLIC __attribute__((visibility("default")))
#else
#define FREI0R_PUBLIC
#endif
#endif
 
#define FREI0R_MAJOR_VERSION 1
 
#define FREI0R_MINOR_VERSION 2
 
//---------------------------------------------------------------------------
 
FREI0R_PUBLIC int f0r_init(void);
 
FREI0R_PUBLIC void f0r_deinit(void);
 
//---------------------------------------------------------------------------
 
#define F0R_PLUGIN_TYPE_FILTER 0
#define F0R_PLUGIN_TYPE_SOURCE 1
#define F0R_PLUGIN_TYPE_MIXER2 2
#define F0R_PLUGIN_TYPE_MIXER3 3
 
//---------------------------------------------------------------------------
 
#define F0R_COLOR_MODEL_BGRA8888 0
 
#define F0R_COLOR_MODEL_RGBA8888 1
 
#define F0R_COLOR_MODEL_PACKED32 2
typedef struct f0r_plugin_info
{
  const char* name;    
  const char* author;  
  int plugin_type;    
  int color_model;     
  int frei0r_version;  
  int major_version;   
  int minor_version;   
  int num_params;      
  const char* explanation; 
} f0r_plugin_info_t;
 
 
FREI0R_PUBLIC void f0r_get_plugin_info(f0r_plugin_info_t* info);
 
//---------------------------------------------------------------------------
 
#define F0R_PARAM_BOOL      0
 
#define F0R_PARAM_DOUBLE    1
 
#define F0R_PARAM_COLOR     2
#define F0R_PARAM_POSITION  3
 
#define F0R_PARAM_STRING  4
 
typedef double f0r_param_bool;
 
typedef double f0r_param_double;
 
typedef struct f0r_param_color
{
  float r; 
  float g; 
  float b; 
} f0r_param_color_t;
 
typedef struct f0r_param_position
{
  double x; 
  double y; 
} f0r_param_position_t;
 
 
typedef char* f0r_param_string;
 
typedef struct f0r_param_info
{
  const char* name;         
  int type;                 
  const char* explanation;  
} f0r_param_info_t;
 
FREI0R_PUBLIC void f0r_get_param_info(f0r_param_info_t* info, int param_index);
 
//---------------------------------------------------------------------------
 
typedef void* f0r_instance_t;
 
FREI0R_PUBLIC f0r_instance_t f0r_construct(unsigned int width, unsigned int height);
 
FREI0R_PUBLIC void f0r_destruct(f0r_instance_t instance);
 
//---------------------------------------------------------------------------
 
typedef void* f0r_param_t;
 
FREI0R_PUBLIC void f0r_set_param_value(f0r_instance_t instance,
                               f0r_param_t param, int param_index);
 
FREI0R_PUBLIC void f0r_get_param_value(f0r_instance_t instance,
                               f0r_param_t param, int param_index);
 
//---------------------------------------------------------------------------
 
FREI0R_PUBLIC void f0r_update(f0r_instance_t instance,
                      double time, const uint32_t* inframe, uint32_t* outframe);
 
//---------------------------------------------------------------------------
 
FREI0R_PUBLIC void f0r_update2(f0r_instance_t instance,
                       double time,
                       const uint32_t* inframe1,
                       const uint32_t* inframe2,
                       const uint32_t* inframe3,
                       uint32_t* outframe);
//---------------------------------------------------------------------------
 
#endif