plugin_manager.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2018-2024 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __PLUGINS_PLUGIN_MANAGER_H__
#define __PLUGINS_PLUGIN_MANAGER_H__
 
#include "plugins/plugin_descriptor.h"
#include "utils/symap.h"
#include "utils/types.h"
 
#include "zix/sem.h"
 
TYPEDEF_STRUCT (CachedPluginDescriptors);
TYPEDEF_STRUCT (PluginCollections);
TYPEDEF_STRUCT (ZCarlaDiscovery);
 
#define PLUGIN_MANAGER (ZRYTHM->plugin_manager)
 
typedef struct PluginDescriptor PluginDescriptor;
 
typedef struct PluginManager
{
  GPtrArray * plugin_descriptors;
 
  char * plugin_categories[500];
  int    num_plugin_categories;
 
  char * plugin_authors[6000];
  int    num_plugin_authors;
 
  CachedPluginDescriptors * cached_plugin_descriptors;
 
  PluginCollections * collections;
 
  ZCarlaDiscovery * carla_discovery;
 
  GenericCallback scan_done_cb;
  void *          scan_done_cb_data;
 
  bool setup;
 
  int num_new_plugins;
 
} PluginManager;
 
PluginManager *
plugin_manager_new (void);
 
char **
plugin_manager_get_paths_for_protocol (
  const PluginManager * self,
  const ZPluginProtocol protocol);
 
char *
plugin_manager_get_paths_for_protocol_separated (
  const PluginManager * self,
  const ZPluginProtocol protocol);
 
char *
plugin_manager_find_plugin_from_rel_path (
  const PluginManager * self,
  const ZPluginProtocol protocol,
  const char *          rel_path);
 
void
plugin_manager_begin_scan (
  PluginManager * self,
  const double    max_progress,
  double *        progress,
  GenericCallback cb,
  void *          user_data);
 
void
plugin_manager_add_descriptor (PluginManager * self, PluginDescriptor * descr);
 
void
plugin_manager_set_currently_scanning_plugin (
  PluginManager * self,
  const char *    filename,
  const char *    sha1);
 
PluginDescriptor *
plugin_manager_find_plugin_from_uri (PluginManager * self, const char * uri);
 
PluginDescriptor *
plugin_manager_find_from_descriptor (
  PluginManager *          self,
  const PluginDescriptor * src_descr);
 
bool
plugin_manager_supports_protocol (PluginManager * self, ZPluginProtocol protocol);
 
PluginDescriptor *
plugin_manager_pick_instrument (PluginManager * self);
 
void
plugin_manager_clear_plugins (PluginManager * self);
 
void
plugin_manager_free (PluginManager * self);
 
#endif