lv_plugin.h

/* Libvisual - The audio visualisation framework.
 *
 * Copyright (C) 2012      Libvisual team
 *               2004-2006 Dennis Smit
 *
 * Authors: Dennis Smit <ds@nerds-incorporated.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1
 * 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#ifndef _LV_PLUGIN_H
#define _LV_PLUGIN_H

#include <libvisual/lvconfig.h>
#include <libvisual/lv_event.h>
#include <libvisual/lv_param.h>
#include <libvisual/lv_random.h>

#define VISUAL_PLUGIN_API_VERSION   3005

#define VISUAL_PLUGIN_LICENSE_GPLv1 "GPLv1"
#define VISUAL_PLUGIN_LICENSE_GPL   "GPLv2"
#define VISUAL_PLUGIN_LICENSE_GPLv3 "GPLv3"
#define VISUAL_PLUGIN_LICENSE_LGPL  "LGPL"
#define VISUAL_PLUGIN_LICENSE_BSD   "BSD"

#define VISUAL_PLUGIN_VERSION_TAG   "__lv_plugin_libvisual_api_version"
#define VISUAL_PLUGIN_API_VERSION_VALIDATOR \
    LV_C_LINKAGE LV_PLUGIN_EXPORT const int __lv_plugin_libvisual_api_version = VISUAL_PLUGIN_API_VERSION; \
    LV_C_LINKAGE LV_PLUGIN_EXPORT const VisPluginInfo* get_plugin_info (void);

typedef enum {
    VISUAL_PLUGIN_FLAG_NONE      = 0,   
    VISUAL_PLUGIN_FLAG_REENTRANT = 1    
} VisPluginFlags;

typedef enum {
    VISUAL_PLUGIN_TYPE_ACTOR,
    VISUAL_PLUGIN_TYPE_INPUT,
    VISUAL_PLUGIN_TYPE_MORPH
} VisPluginType;

#ifdef __cplusplus

namespace LV {

  class LV_API PluginData;

} // LV namespace

typedef LV::PluginData VisPluginData;

#else

typedef struct _VisPluginData VisPluginData;
struct _VisPluginData;

#endif

typedef struct _VisPluginRef VisPluginRef;
typedef struct _VisPluginInfo VisPluginInfo;

typedef int (*VisPluginInitFunc)(VisPluginData *plugin);

typedef void (*VisPluginCleanupFunc)(VisPluginData *plugin);

typedef int (*VisPluginEventsFunc)(VisPluginData *plugin, VisEventQueue *events);

struct _VisPluginInfo {
    VisPluginType  type;     
    const char    *plugname; 
    const char    *name;     
    const char    *author;   
    const char    *version;  
    const char    *about;    
    const char    *help;     
    const char    *license;  
    const char    *url;      
    VisPluginInitFunc    init;     
    VisPluginCleanupFunc cleanup;  
    VisPluginEventsFunc  events;   
    int flags;            
    void *plugin;         
};

LV_BEGIN_DECLS

LV_API int visual_plugin_get_api_version (void);

LV_API VisEventQueue *visual_plugin_get_event_queue (VisPluginData *plugin);

LV_API void visual_plugin_events_pump (VisPluginData *plugin);

LV_API const VisPluginInfo *visual_plugin_get_info (VisPluginData *plugin);

LV_API void *visual_plugin_get_specific (VisPluginData *plugin);

LV_API VisParamList *visual_plugin_get_params (VisPluginData *plugin);

LV_API VisRandomContext *visual_plugin_get_random_context (VisPluginData *plugin);

LV_API void visual_plugin_set_private (VisPluginData *plugin, void *priv);

LV_API void *visual_plugin_get_private (VisPluginData *plugin);

LV_API VisPluginData *visual_plugin_load (VisPluginType type, const char *name);

LV_API void visual_plugin_unload (VisPluginData *plugin);

LV_API int visual_plugin_realize (VisPluginData *plugin);

LV_API int visual_plugin_is_realized (VisPluginData *plugin);


LV_END_DECLS

#ifdef __cplusplus

#include <libvisual/lv_module.hpp>
#include <vector>
#include <string>

namespace LV {

  struct PluginRef
  {
      std::string          file;
      VisPluginInfo const* info;
      ModulePtr            module;
  };

  typedef std::vector<PluginRef> PluginList;

  LV_API char const* plugin_get_next_by_name (PluginList const& list, char const* name);

  LV_API char const* plugin_get_prev_by_name (PluginList const& list, char const* name);

} // LV namespace

#endif /* __cplusplus */

#endif /* _LV_PLUGIN_H */