minpf_plugin.h

Go to the documentation of this file.

/*
 *    Copyright (C) 2016-2026 Grok Image Compression Inc.
 *
 *    This source code is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    This source code 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 Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#pragma once
#include <stdint.h>
#include "grok.h"
#include "Logger.h"
 
namespace gpup
{
// Forward-declare the plugin's ILogger (no virtual dtor, 3 methods)
// so we can pass a compatible pointer across the shared-library boundary.
struct ILogger
{
  virtual void info(const char* fmt, ...) = 0;
  virtual void warn(const char* fmt, ...) = 0;
  virtual void error(const char* fmt, ...) = 0;
};
} // namespace gpup
 
namespace grk
{
 
// Adapter: wraps grk::ILogger (virtual dtor + 5 methods) in a gpup::ILogger
// (no virtual dtor, 3 methods) so the vtable layout matches what the plugin expects.
struct GpupLoggerAdapter : public gpup::ILogger
{
  grk::ILogger* grk_logger;
  GpupLoggerAdapter(grk::ILogger* l) : grk_logger(l) {}
  void info(const char* fmt, ...) override
  {
    va_list args;
    va_start(args, fmt);
    char buf[1024];
    vsnprintf(buf, sizeof(buf), fmt, args);
    va_end(args);
    grk_logger->info("%s", buf);
  }
  void warn(const char* fmt, ...) override
  {
    va_list args;
    va_start(args, fmt);
    char buf[1024];
    vsnprintf(buf, sizeof(buf), fmt, args);
    va_end(args);
    grk_logger->warn("%s", buf);
  }
  void error(const char* fmt, ...) override
  {
    va_list args;
    va_start(args, fmt);
    char buf[1024];
    vsnprintf(buf, sizeof(buf), fmt, args);
    va_end(args);
    grk_logger->error("%s", buf);
  }
};
 
struct minpf_platform_services;
 
typedef struct minpf_object_params
{
  const char* id;
  const struct minpf_platform_services* platformServices;
} minpf_object_params;
 
typedef struct minpf_plugin_api_version
{
  int32_t major;
  int32_t minor;
} minpf_plugin_api_version;
 
typedef void* (*minpf_create_func)(minpf_object_params*);
typedef int32_t (*minpf_destroy_func)(void*);
 
typedef struct minpf_register_params
{
  minpf_plugin_api_version version;
} minpf_register_params;
 
typedef int32_t (*minpf_register_func)(const char* nodeType, const minpf_register_params* params);
typedef int32_t (*minpf_invoke_service_func)(const char* serviceName, void* serviceParams);
 
typedef struct minpf_platform_services
{
  minpf_plugin_api_version version;
  minpf_register_func registerObject;
  minpf_invoke_service_func invokeService;
 
  const char* pluginPath;
  bool verbose;
  gpup::ILogger* logger;
} minpf_platform_services;
 
typedef int32_t (*minpf_exit_func)();
 
typedef minpf_exit_func (*minpf_post_load_func)(const minpf_platform_services*);
 
#if defined(GRK_STATIC) || !defined(_WIN32)
/* http://gcc.gnu.org/wiki/Visibility */
#if __GNUC__ >= 4
#if defined(GRK_STATIC) /* static library uses "hidden" */
#define PLUGIN_API __attribute__((visibility("hidden")))
#else
#define PLUGIN_API __attribute__((visibility("default")))
#endif
#define PLUGIN_LOCAL __attribute__((visibility("hidden")))
#else
#define PLUGIN_API
#define PLUGIN_LOCAL
#endif
#else
#ifdef GRK_EXPORTS
#define PLUGIN_API __declspec(dllexport)
#else
#define PLUGIN_API __declspec(dllimport)
#endif /* GRK_EXPORTS */
#endif /* !GRK_STATIC || !_WIN32 */
 
extern "C" PLUGIN_API minpf_exit_func minpf_init_plugin(const char* pluginPath,
                                                        const minpf_platform_services* params);
 
} // namespace grk