use clap_sys::events::{clap_input_events, clap_output_events}; use clap_sys::ext::params::{ clap_param_info, clap_plugin_params, CLAP_EXT_PARAMS, CLAP_PARAM_IS_BYPASS, CLAP_PARAM_IS_STEPPED, }; use clap_sys::host::clap_host; use clap_sys::id::clap_id; use clap_sys::plugin::clap_plugin; use clap_sys::process::{clap_process, clap_process_status}; use crossbeam::atomic::AtomicCell; use crossbeam::queue::ArrayQueue; use lazy_static::lazy_static; use parking_lot::RwLock; use std::collections::{HashMap, VecDeque}; use std::ffi::{c_void, CStr}; use std::os::raw::c_char; use std::ptr; use std::sync::atomic::{AtomicBool, AtomicU32, Ordering}; use std::thread::{self, ThreadId}; use super::context::WrapperProcessContext; use super::descriptor::PluginDescriptor; use super::util::ClapPtr; use crate::event_loop::{EventLoop, MainThreadExecutor, TASK_QUEUE_CAPACITY}; use crate::param::internals::ParamPtr; use crate::plugin::{BufferConfig, BusConfig, ClapPlugin}; use crate::wrapper::util::{hash_param_id, strlcpy}; use crate::NoteEvent; /// Right now the wrapper adds its own bypass parameter. /// /// TODO: Actually use this parameter. pub const BYPASS_PARAM_ID: &str = "bypass"; lazy_static! { pub static ref BYPASS_PARAM_HASH: u32 = hash_param_id(BYPASS_PARAM_ID); } #[repr(C)] pub struct Wrapper { // Keep the vtable as the first field so we can do a simple pointer cast pub clap_plugin: clap_plugin, /// The wrapped plugin instance. plugin: RwLock

, /// The current IO configuration, modified through the `clap_plugin_audio_ports_config` /// extension. current_bus_config: AtomicCell, /// The current buffer configuration, containing the sample rate and the maximum block size. /// Will be set in `clap_plugin::activate()`. current_buffer_config: AtomicCell>, /// Whether the plugin is currently bypassed. This is not yet integrated with the `Plugin` /// trait. bypass_state: AtomicBool, /// The incoming events for the plugin, if `P::ACCEPTS_MIDI` is set. /// /// TODO: Maybe load these lazily at some point instead of needing to spool them all to this /// queue first /// TODO: Read these in the process call. input_events: RwLock>, /// The current latency in samples, as set by the plugin through the [ProcessContext]. uses the /// latency extnesion /// /// TODO: Implement the latency extension. pub current_latency: AtomicU32, host_callback: ClapPtr, /// Needs to be boxed because the plugin object is supposed to contain a static reference to /// this. plugin_descriptor: Box>, clap_plugin_params: clap_plugin_params, // These fiels are exactly the same as their VST3 wrapper counterparts. // /// The keys from `param_map` in a stable order. param_hashes: Vec, /// A mapping from parameter ID hashes (obtained from the string parameter IDs) to pointers to /// parameters belonging to the plugin. As long as `plugin` does not get recreated, these /// addresses will remain stable, as they are obtained from a pinned object. param_by_hash: HashMap, /// The default normalized parameter value for every parameter in `param_ids`. We need to store /// this in case the host requeries the parmaeter later. This is also indexed by the hash so we /// can retrieve them later for the UI if needed. param_defaults_normalized: HashMap, /// Mappings from string parameter indentifiers to parameter hashes. Useful for debug logging /// and when storing and restorign plugin state. param_id_to_hash: HashMap<&'static str, u32>, /// The inverse mapping from [Self::param_by_hash]. This is needed to be able to have an /// ergonomic parameter setting API that uses references to the parameters instead of having to /// add a setter function to the parameter (or even worse, have it be completely untyped). param_ptr_to_hash: HashMap, /// A queue of tasks that still need to be performed. Because CLAP lets the plugin request a /// host callback directly, we don't need to use the OsEventLoop we use in our other plugin /// implementations. Instead, we'll post tasks to this queue, ask the host to call /// [Self::on_main_thread] on the main thread, and then continue to pop tasks off this queue /// there until it is empty. tasks: ArrayQueue, /// The ID of the main thread. In practice this is the ID of the thread that created this /// object. /// /// TODO: If the host supports the ThreadCheck extension, we should use that instead. main_thread_id: ThreadId, } /// Tasks that can be sent from the plugin to be executed on the main thread in a non-blocking /// realtime safe way. Instead of using a random thread or the OS' event loop like in the Linux /// implementation, this uses [clap_host::request_callback()] instead. #[derive(Debug, Clone)] pub enum Task { /// Inform the host that the latency has changed. LatencyChanged, } /// Because CLAP has this [clap_host::request_host_callback()] function, we don't need to use /// `OsEventLoop` and can instead just request a main thread callback directly. impl EventLoop> for Wrapper

{ fn new_and_spawn(_executor: std::sync::Weak) -> Self { panic!("What are you doing"); } fn do_maybe_async(&self, task: Task) -> bool { if self.is_main_thread() { unsafe { self.execute(task) }; true } else { let success = self.tasks.push(task).is_ok(); if success { // CLAP lets us use the host's event loop instead of having to implement our own let host = &self.host_callback; unsafe { (host.request_callback)(&**host) }; } success } } fn is_main_thread(&self) -> bool { // TODO: Use the `thread_check::is_main_thread` extension method if that's available thread::current().id() == self.main_thread_id } } impl MainThreadExecutor for Wrapper

{ unsafe fn execute(&self, task: Task) { todo!("Implement latency changes for CLAP") } } impl Wrapper

{ pub fn new(host_callback: *const clap_host) -> Self { let plugin_descriptor = Box::new(PluginDescriptor::default()); assert!(!host_callback.is_null()); let mut wrapper = Self { clap_plugin: clap_plugin { // This needs to live on the heap because the plugin object contains a direct // reference to the manifest as a value. We could share this between instances of // the plugin using an `Arc`, but this doesn't consume a lot of memory so it's not a // huge deal. desc: plugin_descriptor.clap_plugin_descriptor(), // We already need to use pointer casts in the factory, so might as well continue // doing that here plugin_data: ptr::null_mut(), init: Self::init, destroy: Self::destroy, activate: Self::activate, deactivate: Self::deactivate, start_processing: Self::start_processing, stop_processing: Self::stop_processing, process: Self::process, get_extension: Self::get_extension, on_main_thread: Self::on_main_thread, }, plugin: RwLock::new(P::default()), current_bus_config: AtomicCell::new(BusConfig { num_input_channels: P::DEFAULT_NUM_INPUTS, num_output_channels: P::DEFAULT_NUM_OUTPUTS, }), current_buffer_config: AtomicCell::new(None), bypass_state: AtomicBool::new(false), input_events: RwLock::new(VecDeque::with_capacity(512)), current_latency: AtomicU32::new(0), host_callback: unsafe { ClapPtr::new(host_callback) }, plugin_descriptor, clap_plugin_params: clap_plugin_params { count: Self::ext_params_count, get_info: Self::ext_params_get_info, get_value: Self::ext_params_get_value, value_to_text: Self::ext_params_value_to_text, text_to_value: Self::ext_params_text_to_value, flush: Self::ext_params_flush, }, param_hashes: Vec::new(), param_by_hash: HashMap::new(), param_defaults_normalized: HashMap::new(), param_id_to_hash: HashMap::new(), param_ptr_to_hash: HashMap::new(), tasks: ArrayQueue::new(TASK_QUEUE_CAPACITY), main_thread_id: thread::current().id(), }; // This is a mapping from the parameter IDs specified by the plugin to pointers to thsoe // parameters. Since the object returned by `params()` is pinned, these pointers are safe to // dereference as long as `wrapper.plugin` is alive let param_map = wrapper.plugin.read().params().param_map(); let param_ids = wrapper.plugin.read().params().param_ids(); nih_debug_assert!( !param_map.contains_key(BYPASS_PARAM_ID), "The wrapper already adds its own bypass parameter" ); // Only calculate these hashes once, and in the stable order defined by the plugin let param_id_hashes_ptrs: Vec<_> = param_ids .iter() .filter_map(|id| { let param_ptr = param_map.get(id)?; Some((id, hash_param_id(id), param_ptr)) }) .collect(); wrapper.param_hashes = param_id_hashes_ptrs .iter() .map(|&(_, hash, _)| hash) .collect(); wrapper.param_by_hash = param_id_hashes_ptrs .iter() .map(|&(_, hash, ptr)| (hash, *ptr)) .collect(); wrapper.param_defaults_normalized = param_id_hashes_ptrs .iter() .map(|&(_, hash, ptr)| (hash, unsafe { ptr.normalized_value() })) .collect(); wrapper.param_id_to_hash = param_id_hashes_ptrs .iter() .map(|&(id, hash, _)| (*id, hash)) .collect(); wrapper.param_ptr_to_hash = param_id_hashes_ptrs .into_iter() .map(|(_, hash, ptr)| (*ptr, hash)) .collect(); wrapper } fn make_process_context(&self) -> WrapperProcessContext<'_, P> { WrapperProcessContext { plugin: self, input_events_guard: self.input_events.write(), } } unsafe extern "C" fn init(_plugin: *const clap_plugin) -> bool { // We don't need any special initialization true } unsafe extern "C" fn destroy(plugin: *const clap_plugin) { Box::from_raw(plugin as *mut Self); } unsafe extern "C" fn activate( plugin: *const clap_plugin, sample_rate: f64, _min_frames_count: u32, max_frames_count: u32, ) -> bool { let wrapper = &*(plugin as *const Self); let bus_config = wrapper.current_bus_config.load(); let buffer_config = BufferConfig { sample_rate: sample_rate as f32, max_buffer_size: max_frames_count, }; // TODO: Reset smoothers if wrapper.plugin.write().initialize( &bus_config, &buffer_config, &mut wrapper.make_process_context(), ) { // TODO: Allocate buffer slices // Also store this for later, so we can reinitialize the plugin after restoring state wrapper.current_buffer_config.store(Some(buffer_config)); true } else { false } } unsafe extern "C" fn deactivate(_plugin: *const clap_plugin) { // We currently don't do anything here } unsafe extern "C" fn start_processing(_plugin: *const clap_plugin) -> bool { // We currently don't do anything here true } unsafe extern "C" fn stop_processing(_plugin: *const clap_plugin) { // We currently don't do anything here } unsafe extern "C" fn process( plugin: *const clap_plugin, process: *const clap_process, ) -> clap_process_status { todo!(); } unsafe extern "C" fn get_extension( plugin: *const clap_plugin, id: *const c_char, ) -> *const c_void { let wrapper = &*(plugin as *const Self); if id.is_null() { return ptr::null(); } // TODO: Implement the other useful extensions. Like uh audio inputs. let id = CStr::from_ptr(id); if id == CStr::from_ptr(CLAP_EXT_PARAMS) { &wrapper.clap_plugin_params as *const _ as *const c_void } else { ptr::null() } } unsafe extern "C" fn on_main_thread(plugin: *const clap_plugin) { let wrapper = &*(plugin as *const Self); // [Self::do_maybe_async] posts a task to the queue and asks the host to call this function // on the main thread, so once that's done we can just handle all requests here while let Some(task) = wrapper.tasks.pop() { wrapper.execute(task); } } unsafe extern "C" fn ext_params_count(plugin: *const clap_plugin) -> u32 { let wrapper = &*(plugin as *const Self); // NOTE: We add a bypass parameter ourselves on index `plugin.param_hashes.len()`, so // these indices are all off by one wrapper.param_hashes.len() as u32 + 1 } unsafe extern "C" fn ext_params_get_info( plugin: *const clap_plugin, param_index: i32, param_info: *mut clap_param_info, ) -> bool { let wrapper = &*(plugin as *const Self); // Parameter index `self.param_ids.len()` is our own bypass parameter if param_info.is_null() || param_index < 0 || param_index > wrapper.param_hashes.len() as i32 { return false; } *param_info = std::mem::zeroed(); // TODO: We don't use the cookies at this point. In theory this would be faster than the ID // hashmap lookup, but for now we'll stay consistent with the VST3 implementation. let param_info = &mut *param_info; if param_index == wrapper.param_hashes.len() as i32 { param_info.id = *BYPASS_PARAM_HASH; param_info.flags = CLAP_PARAM_IS_STEPPED | CLAP_PARAM_IS_BYPASS; param_info.cookie = ptr::null_mut(); strlcpy(&mut param_info.name, "Bypass"); strlcpy(&mut param_info.module, ""); param_info.min_value = 0.0; param_info.max_value = 1.0; param_info.default_value = 0.0; } else { let param_hash = &wrapper.param_hashes[param_index as usize]; let default_value = &wrapper.param_defaults_normalized[param_hash]; let param_ptr = &wrapper.param_by_hash[param_hash]; let step_count = param_ptr.step_count(); param_info.id = *param_hash; param_info.flags = if step_count.is_some() { CLAP_PARAM_IS_STEPPED } else { 0 }; param_info.cookie = ptr::null_mut(); strlcpy(&mut param_info.name, param_ptr.name()); strlcpy(&mut param_info.module, ""); // We don't use the actual minimum and maximum values here because that would not scale // with skewed integer ranges. Instead, just treat all parameters as `[0, 1]` normalized // paramters multiplied by the step size. param_info.min_value = 0.0; // Stepped parameters are unnormalized float parameters since there's no separate step // range option // TODO: This should probably be encapsulated in some way so we don't forget about this in one place // TODO: Like with VST3, this won't actually do the correct thing with skewed stepped parameters param_info.max_value = step_count.unwrap_or(1) as f64; param_info.default_value = *default_value as f64 * step_count.unwrap_or(1) as f64; } true } unsafe extern "C" fn ext_params_get_value( plugin: *const clap_plugin, param_id: clap_id, value: *mut f64, ) -> bool { let wrapper = &*(plugin as *const Self); if value.is_null() { return false; } if param_id == *BYPASS_PARAM_HASH { *value = if wrapper.bypass_state.load(Ordering::SeqCst) { 1.0 } else { 0.0 }; true } else if let Some(param_ptr) = wrapper.param_by_hash.get(¶m_id) { // TODO: As explained above, this may do strange things with skewed discrete parameters *value = param_ptr.normalized_value() as f64 * param_ptr.step_count().unwrap_or(1) as f64; true } else { false } } unsafe extern "C" fn ext_params_value_to_text( plugin: *const clap_plugin, param_id: clap_id, value: f64, display: *mut c_char, size: u32, ) -> bool { // TODO: Don't forget to add the unit todo!(); } unsafe extern "C" fn ext_params_text_to_value( plugin: *const clap_plugin, param_id: clap_id, display: *const c_char, value: *mut f64, ) -> bool { todo!(); } unsafe extern "C" fn ext_params_flush( plugin: *const clap_plugin, in_: *const clap_input_events, out: *const clap_output_events, ) { todo!(); } }