carla_native_plugin.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2019-2023 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#include "zrythm-config.h"
 
#ifndef __PLUGINS_CARLA_NATIVE_PLUGIN_H__
#  define __PLUGINS_CARLA_NATIVE_PLUGIN_H__
 
#  ifdef HAVE_CARLA
#    include <CarlaNativePlugin.h>
#    include <CarlaUtils.h>
#  endif
 
typedef struct PluginDescriptor PluginDescriptor;
typedef void *                  CarlaPluginHandle;
 
#  define CARLA_STATE_FILENAME "state.carla"
 
typedef enum CarlaPluginType
{
  CARLA_PLUGIN_NONE,
  CARLA_PLUGIN_RACK,
  CARLA_PLUGIN_PATCHBAY,
  CARLA_PLUGIN_PATCHBAY16,
  CARLA_PLUGIN_PATCHBAY32,
  CARLA_PLUGIN_PATCHBAY64,
} CarlaPluginType;
 
typedef struct CarlaPatchbayPortInfo
{
  unsigned int plugin_id;
  unsigned int port_hints;
  unsigned int port_id;
  char *       port_name;
} CarlaPatchbayPortInfo;
 
typedef struct CarlaNativePlugin
{
#  ifdef HAVE_CARLA
  NativePluginHandle             native_plugin_handle;
  NativeHostDescriptor           native_host_descriptor;
  const NativePluginDescriptor * native_plugin_descriptor;
 
  CarlaHostHandle host_handle;
 
  // uint32_t                 num_midi_events;
  // NativeMidiEvent          midi_events[200];
  NativeTimeInfo time_info;
#  endif
 
  Plugin * plugin;
 
  unsigned int carla_plugin_id;
 
  bool ports_created;
 
  bool loading_state;
 
  unsigned int audio_input_port_id;
  unsigned int audio_output_port_id;
 
  unsigned int cv_input_port_id;
  unsigned int cv_output_port_id;
 
  unsigned int midi_input_port_id;
  unsigned int midi_output_port_id;
 
  GPtrArray * patchbay_port_info;
 
  guint tick_cb;
 
  float ** zero_inbufs;
  float ** zero_outbufs;
  float ** inbufs;
  float ** outbufs;
 
  unsigned int max_variant_audio_ins;
  unsigned int max_variant_audio_outs;
  unsigned int max_variant_cv_ins;
  unsigned int max_variant_cv_outs;
  unsigned int max_variant_midi_ins;
  unsigned int max_variant_midi_outs;
 
} CarlaNativePlugin;
 
#  ifdef HAVE_CARLA
 
NONNULL void
carla_native_plugin_init_loaded (CarlaNativePlugin * self);
 
NONNULL_ARGS (1)
int carla_native_plugin_new_from_setting (Plugin * plugin, GError ** error);
 
NONNULL PluginDescriptor *
carla_native_plugin_get_descriptor_from_cached (
  const CarlaCachedPluginInfo * info,
  PluginType                    type);
 
WARN_UNUSED_RESULT bool
carla_native_plugin_save_state (
  CarlaNativePlugin * self,
  bool                is_backup,
  const char *        abs_state_dir,
  GError **           error);
 
bool
carla_native_plugin_load_state (
  CarlaNativePlugin * self,
  const char *        abs_path,
  GError **           error);
 
NONNULL void
carla_native_plugin_populate_banks (CarlaNativePlugin * self);
 
NONNULL void
carla_native_plugin_update_buffer_size_and_sample_rate (
  CarlaNativePlugin * self);
 
NONNULL_ARGS (1)
int carla_native_plugin_instantiate (
  CarlaNativePlugin * self,
  bool                loading,
  bool                use_state_file,
  GError **           error);
 
#    if 0
NONNULL
MALLOC
char *
carla_native_plugin_get_abs_state_file_path (
  const CarlaNativePlugin * self,
  const bool                is_backup);
#    endif
 
HOT NONNULL OPTIMIZE_O3 void
carla_native_plugin_process (
  CarlaNativePlugin *                 self,
  const EngineProcessTimeInfo * const time_nfo);
 
NONNULL void
carla_native_plugin_open_ui (CarlaNativePlugin * self, bool show);
 
NONNULL Port *
carla_native_plugin_get_port_from_param_id (
  CarlaNativePlugin * self,
  const uint32_t      id);
 
NONNULL Port *
carla_native_plugin_get_midi_out_port (CarlaNativePlugin * self);
 
NONNULL float
carla_native_plugin_get_param_value (CarlaNativePlugin * self, const uint32_t id);
 
NONNULL void
carla_native_plugin_set_param_value (
  CarlaNativePlugin * self,
  const uint32_t      id,
  float               val);
 
NONNULL int
carla_native_plugin_activate (CarlaNativePlugin * self, bool activate);
 
NONNULL void
carla_native_plugin_close (CarlaNativePlugin * self);
 
bool
carla_native_plugin_has_custom_ui (const PluginDescriptor * descr);
 
NONNULL nframes_t
carla_native_plugin_get_latency (CarlaNativePlugin * self);
 
int
carla_native_plugin_add_internal_plugin_from_descr (
  CarlaNativePlugin *      self,
  const PluginDescriptor * descr);
 
NONNULL void
carla_native_plugin_free (CarlaNativePlugin * self);
 
#  endif /* HAVE_CARLA */
 
#endif