1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
use atomic_float::AtomicF32;
use parking_lot::{Mutex, RwLock};
use raw_window_handle::RawWindowHandle;
use std::any::Any;
use std::ffi::{c_void, CStr};
use std::mem;
use std::sync::atomic::Ordering;
use std::sync::Arc;
use vst3_sys::base::{kInvalidArgument, kResultFalse, kResultOk, tresult, TBool};
use vst3_sys::gui::{IPlugFrame, IPlugView, IPlugViewContentScaleSupport, ViewRect};
use vst3_sys::utils::SharedVstPtr;
use vst3_sys::VST3;
use super::inner::{Task, WrapperInner};
use super::util::{ObjectPtr, VstPtr};
use crate::plugin::vst3::Vst3Plugin;
use crate::prelude::{Editor, ParentWindowHandle};
// Alias needed for the VST3 attribute macro
use vst3_sys as vst3_com;
// Thanks for putting this behind a platform-specific ifdef...
// NOTE: This should also be used on the BSDs, but vst3-sys exposes these interfaces only for Linux
#[cfg(target_os = "linux")]
use {
crate::event_loop::{EventLoop, MainThreadExecutor, TASK_QUEUE_CAPACITY},
crossbeam::queue::ArrayQueue,
libc,
vst3_sys::gui::linux::{FileDescriptor, IEventHandler, IRunLoop},
};
// Window handle type constants missing from vst3-sys
#[allow(unused)]
const VST3_PLATFORM_HWND: &str = "HWND";
#[allow(unused)]
const VST3_PLATFORM_HIVIEW: &str = "HIView";
#[allow(unused)]
const VST3_PLATFORM_NSVIEW: &str = "NSView";
#[allow(unused)]
const VST3_PLATFORM_UIVIEW: &str = "UIView";
#[allow(unused)]
const VST3_PLATFORM_X11_WINDOW: &str = "X11EmbedWindowID";
/// FIXME: vst3-sys does not allow you to conditionally define fields with #[cfg()], so this is a
/// workaround to define the field outside of the struct
#[cfg(target_os = "linux")]
struct RunLoopEventHandlerWrapper<P: Vst3Plugin>(RwLock<Option<Box<RunLoopEventHandler<P>>>>);
#[cfg(not(target_os = "linux"))]
struct RunLoopEventHandlerWrapper<P: Vst3Plugin>(std::marker::PhantomData<P>);
/// The plugin's [`IPlugView`] instance created in [`IEditController::create_view()`] if `P` has an
/// editor. This is managed separately so the lifetime bounds match up.
#[VST3(implements(IPlugView, IPlugViewContentScaleSupport))]
pub(crate) struct WrapperView<P: Vst3Plugin> {
inner: Arc<WrapperInner<P>>,
editor: Arc<Mutex<Box<dyn Editor>>>,
editor_handle: RwLock<Option<Box<dyn Any>>>,
/// The `IPlugFrame` instance passed by the host during [IPlugView::set_frame()].
plug_frame: RwLock<Option<VstPtr<dyn IPlugFrame>>>,
/// Allows handling events events on the host's GUI thread when using Linux. Needed because
/// otherwise REAPER doesn't like us very much. The event handler could be implemented directly
/// on this object but vst3-sys does not let us conditionally implement interfaces.
run_loop_event_handler: RunLoopEventHandlerWrapper<P>,
/// The DPI scaling factor as passed to the [IPlugViewContentScaleSupport::set_scale_factor()]
/// function. Defaults to 1.0, and will be kept there on macOS. When reporting and handling size
/// the sizes communicated to and from the DAW should be scaled by this factor since NIH-plug's
/// APIs only deal in logical pixels.
scaling_factor: AtomicF32,
}
/// Allow handling tasks on the host's GUI thread on Linux. This doesn't need to be a separate
/// struct, but vst3-sys does not let us implement interfaces conditionally and the interface is
/// only exposed when compiling on Linux. The struct will register itself when calling
/// [`RunLoopEventHandler::new()`] and it will unregister itself when it gets dropped.
#[cfg(target_os = "linux")]
#[VST3(implements(IEventHandler))]
struct RunLoopEventHandler<P: Vst3Plugin> {
/// We need access to the inner wrapper so we that we can post any outstanding tasks there when
/// this object gets dropped so no work is lost.
inner: Arc<WrapperInner<P>>,
/// The host's run loop interface. This lets us run tasks on the same thread as the host's UI.
run_loop: VstPtr<dyn IRunLoop>,
/// We need a Unix domain socket the host can poll to know that we have an event to handle. In
/// theory eventfd would be much better suited for this, but Ardour doesn't respond to fds that
/// aren't sockets. So instead, we will write a single byte here for every message we should
/// handle.
socket_read_fd: i32,
socket_write_fd: i32,
/// 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
/// [`on_main_thread()`][Self::on_main_thread()] on the main thread, and then continue to pop
/// tasks off this queue there until it is empty.
tasks: ArrayQueue<Task<P>>,
}
impl<P: Vst3Plugin> WrapperView<P> {
pub fn new(inner: Arc<WrapperInner<P>>, editor: Arc<Mutex<Box<dyn Editor>>>) -> Box<Self> {
Self::allocate(
inner,
editor,
RwLock::new(None),
RwLock::new(None),
#[cfg(target_os = "linux")]
RunLoopEventHandlerWrapper(RwLock::new(None)),
#[cfg(not(target_os = "linux"))]
RunLoopEventHandlerWrapper(Default::default()),
AtomicF32::new(1.0),
)
}
/// Ask the host to resize the view to the size specified by [Editor::size()]. Will return false
/// if the host doesn't like you. This **needs** to be run from the GUI thread.
///
/// # Safety
///
/// May cause memory corruption in Linux REAPER when called from outside of the `IRunLoop`.
#[must_use]
pub unsafe fn request_resize(&self) -> bool {
// Don't do anything if the editor is not open, because that would be strange
if self
.editor_handle
.try_read()
.map(|e| e.is_none())
.unwrap_or(true)
{
return false;
}
match &*self.plug_frame.read() {
Some(plug_frame) => {
let (unscaled_width, unscaled_height) = self.editor.lock().size();
let scaling_factor = self.scaling_factor.load(Ordering::Relaxed);
let mut size = ViewRect {
right: (unscaled_width as f32 * scaling_factor).round() as i32,
bottom: (unscaled_height as f32 * scaling_factor).round() as i32,
..Default::default()
};
// The argument types are a bit wonky here because you can't construct a
// `SharedVstPtr`. This _should_ work however.
let plug_view: SharedVstPtr<dyn IPlugView> =
mem::transmute(&self.__iplugviewvptr as *const *const _);
let result = plug_frame.resize_view(plug_view, &mut size);
debug_assert_eq!(
result, kResultOk,
"The host denied the resize, we currently don't handle this for VST3 plugins"
);
result == kResultOk
}
None => false,
}
}
/// If the host supports `IRunLoop`, then this will post the task to a task queue that will be
/// run on the host's UI thread. If not, then this will return an `Err` value containing the
/// task so it can be run elsewhere.
#[cfg(target_os = "linux")]
pub fn do_maybe_in_run_loop(&self, task: Task<P>) -> Result<(), Task<P>> {
match &*self.run_loop_event_handler.0.read() {
Some(run_loop) => run_loop.post_task(task),
None => Err(task),
}
}
/// If the host supports `IRunLoop`, then this will post the task to a task queue that will be
/// run on the host's UI thread. If not, then this will return an `Err` value containing the
/// task so it can be run elsewhere.
#[cfg(not(target_os = "linux"))]
pub fn do_maybe_in_run_loop(&self, task: Task<P>) -> Result<(), Task<P>> {
Err(task)
}
}
#[cfg(target_os = "linux")]
impl<P: Vst3Plugin> RunLoopEventHandler<P> {
pub fn new(inner: Arc<WrapperInner<P>>, run_loop: VstPtr<dyn IRunLoop>) -> Box<Self> {
let mut sockets = [0i32; 2];
assert_eq!(
unsafe {
libc::socketpair(
libc::AF_UNIX,
libc::SOCK_STREAM | libc::SOCK_CLOEXEC | libc::SOCK_NONBLOCK,
0,
sockets.as_mut_ptr(),
)
},
0
);
let [socket_read_fd, socket_write_fd] = sockets;
let handler = RunLoopEventHandler::allocate(
inner,
run_loop,
socket_read_fd,
socket_write_fd,
ArrayQueue::new(TASK_QUEUE_CAPACITY),
);
// vst3-sys provides no way to convert to a SharedVstPtr, so, uh, yeah. These are pointers
// to vtable poitners.
let event_handler: SharedVstPtr<dyn IEventHandler> =
unsafe { mem::transmute(&handler.__ieventhandlervptr as *const *const _) };
assert_eq!(
unsafe {
handler
.run_loop
.register_event_handler(event_handler, handler.socket_read_fd)
},
kResultOk
);
handler
}
/// Post a task to the tasks queue so it will be run on the host's GUI thread later. Returns the
/// task if the queue is full and the task could not be posted.
pub fn post_task(&self, task: Task<P>) -> Result<(), Task<P>> {
self.tasks.push(task)?;
// We need to use a Unix domain socket to let the host know to call our event handler. In
// theory eventfd would be more suitable here, but Ardour does not support that.
// XXX: This can technically lead to a race condition if the host is currently calling
// `on_fd_is_set()` on another thread and the task has already been popped and executed
// and this value has not yet been written to the socket. Doing it the other way around
// gets you the other situation where the event handler could be run without the task
// being posted yet. In practice this won't cause any issues however.
let notify_value = 1i8;
const NOTIFY_VALUE_SIZE: usize = std::mem::size_of::<i8>();
assert_eq!(
unsafe {
libc::write(
self.socket_write_fd,
¬ify_value as *const _ as *const c_void,
NOTIFY_VALUE_SIZE,
)
},
NOTIFY_VALUE_SIZE as isize
);
Ok(())
}
}
impl<P: Vst3Plugin> IPlugView for WrapperView<P> {
#[cfg(all(target_family = "unix", not(target_os = "macos")))]
unsafe fn is_platform_type_supported(&self, type_: vst3_sys::base::FIDString) -> tresult {
let type_ = CStr::from_ptr(type_);
match type_.to_str() {
Ok(type_) if type_ == VST3_PLATFORM_X11_WINDOW => kResultOk,
_ => {
nih_debug_assert_failure!("Invalid window handle type: {:?}", type_);
kResultFalse
}
}
}
#[cfg(target_os = "macos")]
unsafe fn is_platform_type_supported(&self, type_: vst3_sys::base::FIDString) -> tresult {
let type_ = CStr::from_ptr(type_);
match type_.to_str() {
Ok(type_) if type_ == VST3_PLATFORM_NSVIEW => kResultOk,
_ => {
nih_debug_assert_failure!("Invalid window handle type: {:?}", type_);
kResultFalse
}
}
}
#[cfg(target_os = "windows")]
unsafe fn is_platform_type_supported(&self, type_: vst3_sys::base::FIDString) -> tresult {
let type_ = CStr::from_ptr(type_);
match type_.to_str() {
Ok(type_) if type_ == VST3_PLATFORM_HWND => kResultOk,
_ => {
nih_debug_assert_failure!("Invalid window handle type: {:?}", type_);
kResultFalse
}
}
}
unsafe fn attached(&self, parent: *mut c_void, type_: vst3_sys::base::FIDString) -> tresult {
let mut editor_handle = self.editor_handle.write();
if editor_handle.is_none() {
let type_ = CStr::from_ptr(type_);
let handle = match type_.to_str() {
#[cfg(all(target_family = "unix", not(target_os = "macos")))]
Ok(type_) if type_ == VST3_PLATFORM_X11_WINDOW => {
let mut handle = raw_window_handle::XcbHandle::empty();
handle.window = parent as usize as u32;
RawWindowHandle::Xcb(handle)
}
#[cfg(target_os = "macos")]
Ok(type_) if type_ == VST3_PLATFORM_NSVIEW => {
let mut handle = raw_window_handle::AppKitHandle::empty();
handle.ns_view = parent;
RawWindowHandle::AppKit(handle)
}
#[cfg(target_os = "windows")]
Ok(type_) if type_ == VST3_PLATFORM_HWND => {
let mut handle = raw_window_handle::Win32Handle::empty();
handle.hwnd = parent;
RawWindowHandle::Win32(handle)
}
_ => {
nih_debug_assert_failure!("Unknown window handle type: {:?}", type_);
return kInvalidArgument;
}
};
*editor_handle = Some(self.editor.lock().spawn(
ParentWindowHandle { handle },
self.inner.clone().make_gui_context(),
));
*self.inner.plug_view.write() = Some(ObjectPtr::from(self));
kResultOk
} else {
nih_debug_assert_failure!(
"Host tried to attach editor while the editor is already attached"
);
kResultFalse
}
}
unsafe fn removed(&self) -> tresult {
let mut editor_handle = self.editor_handle.write();
if editor_handle.is_some() {
*self.inner.plug_view.write() = None;
*editor_handle = None;
kResultOk
} else {
nih_debug_assert_failure!("Host tried to remove the editor without an active editor");
kResultFalse
}
}
unsafe fn on_wheel(&self, _distance: f32) -> tresult {
// We'll let the plugin use the OS' input mechanisms because not all DAWs (or very few
// actually) implement these functions
kResultOk
}
unsafe fn on_key_down(
&self,
_key: vst3_sys::base::char16,
_key_code: i16,
_modifiers: i16,
) -> tresult {
kResultOk
}
unsafe fn on_key_up(
&self,
_key: vst3_sys::base::char16,
_key_code: i16,
_modifiers: i16,
) -> tresult {
kResultOk
}
unsafe fn get_size(&self, size: *mut ViewRect) -> tresult {
check_null_ptr!(size);
*size = mem::zeroed();
// TODO: This is technically incorrect during resizing, this should still report the old
// size until `.on_size()` has been called. We should probably only bother fixing this
// if it turns out to be an issue.
let (unscaled_width, unscaled_height) = self.editor.lock().size();
let scaling_factor = self.scaling_factor.load(Ordering::Relaxed);
let size = &mut *size;
size.left = 0;
size.right = (unscaled_width as f32 * scaling_factor).round() as i32;
size.top = 0;
size.bottom = (unscaled_height as f32 * scaling_factor).round() as i32;
kResultOk
}
unsafe fn on_size(&self, new_size: *mut ViewRect) -> tresult {
check_null_ptr!(new_size);
// TODO: Implement Host->Plugin resizing
let (unscaled_width, unscaled_height) = self.editor.lock().size();
let scaling_factor = self.scaling_factor.load(Ordering::Relaxed);
let (editor_width, editor_height) = (
(unscaled_width as f32 * scaling_factor).round() as i32,
(unscaled_height as f32 * scaling_factor).round() as i32,
);
let width = (*new_size).right - (*new_size).left;
let height = (*new_size).bottom - (*new_size).top;
if width == editor_width && height == editor_height {
kResultOk
} else {
kResultFalse
}
}
unsafe fn on_focus(&self, _state: TBool) -> tresult {
kResultOk
}
unsafe fn set_frame(&self, frame: *mut c_void) -> tresult {
// The correct argument type is missing from the bindings
let frame: SharedVstPtr<dyn IPlugFrame> = mem::transmute(frame);
match frame.upgrade() {
Some(frame) => {
// On Linux the host will expose another interface that lets us run code on the
// host's GUI thread. REAPER will segfault when we don't do this for resizes.
#[cfg(target_os = "linux")]
{
*self.run_loop_event_handler.0.write() = frame.cast().map(|run_loop| {
RunLoopEventHandler::new(self.inner.clone(), VstPtr::from(run_loop))
});
}
*self.plug_frame.write() = Some(VstPtr::from(frame));
}
None => {
#[cfg(target_os = "linux")]
{
*self.run_loop_event_handler.0.write() = None;
}
*self.plug_frame.write() = None;
}
}
kResultOk
}
unsafe fn can_resize(&self) -> tresult {
// TODO: Implement Host->Plugin resizing
kResultFalse
}
unsafe fn check_size_constraint(&self, rect: *mut ViewRect) -> tresult {
check_null_ptr!(rect);
// TODO: Implement Host->Plugin resizing
if (*rect).right - (*rect).left > 0 && (*rect).bottom - (*rect).top > 0 {
kResultOk
} else {
kResultFalse
}
}
}
impl<P: Vst3Plugin> IPlugViewContentScaleSupport for WrapperView<P> {
unsafe fn set_scale_factor(&self, factor: f32) -> tresult {
// TODO: So apparently Ableton Live doesn't call this function. Right now we'll hardcode the
// default scale to 1.0 on Linux and Windows since we can't easily get the scale from
// baseview. A better alternative would be to do the fallback DPI scale detection
// within NIH-plug itself. Then we can still only use baseview's system scale policy
// on macOS and both the editor implementation and the wrappers would know about the
// correct scale.
// On macOS scaling is done by the OS, and all window sizes are in logical pixels
if cfg!(target_os = "macos") {
nih_debug_assert_failure!("Ignoring host request to set explicit DPI scaling factor");
return kResultFalse;
}
if self.editor.lock().set_scale_factor(factor) {
self.scaling_factor.store(factor, Ordering::Relaxed);
kResultOk
} else {
kResultFalse
}
}
}
#[cfg(target_os = "linux")]
impl<P: Vst3Plugin> IEventHandler for RunLoopEventHandler<P> {
unsafe fn on_fd_is_set(&self, _fd: FileDescriptor) {
// This gets called from the host's UI thread because we wrote some bytes to the Unix domain
// socket. We'll read that data from the socket again just to make REAPER happy.
while let Some(task) = self.tasks.pop() {
self.inner.execute(task, true);
let mut notify_value = 1i8;
const NOTIFY_VALUE_SIZE: usize = std::mem::size_of::<i8>();
assert_eq!(
libc::read(
self.socket_read_fd,
&mut notify_value as *mut _ as *mut c_void,
NOTIFY_VALUE_SIZE
),
NOTIFY_VALUE_SIZE as isize
);
}
}
}
#[cfg(target_os = "linux")]
impl<P: Vst3Plugin> Drop for RunLoopEventHandler<P> {
fn drop(&mut self) {
// When this object gets dropped and there are still unprocessed tasks left, then we'll
// handle those in the regular event loop so no work gets lost
let mut posting_failed = false;
while let Some(task) = self.tasks.pop() {
posting_failed |= !self
.inner
.event_loop
.borrow()
.as_ref()
.unwrap()
.schedule_gui(task);
}
if posting_failed {
nih_debug_assert_failure!(
"Outstanding tasks have been dropped when closing the editor as the task queue \
was full"
);
}
unsafe {
libc::close(self.socket_read_fd);
libc::close(self.socket_write_fd);
}
let event_handler: SharedVstPtr<dyn IEventHandler> =
unsafe { mem::transmute(&self.__ieventhandlervptr as *const _) };
unsafe { self.run_loop.unregister_event_handler(event_handler) };
}
}