Port TFruityPlug->Idle_Public to Rust (#66)

examples/simple.rs

@@ -10,7 +10,7 @@ use simplelog::{ConfigBuilder, WriteLogger};
 
 use fpsdk::host::{Event, GetName, Host, HostMessage};
 use fpsdk::plugin::{Plugin, PluginTag};
-use fpsdk::{create_plugin, AsRawPtr, AudioBuffer, Info, InfoBuilder, ProcessParamFlags, ValuePtr};
+use fpsdk::{create_plugin, AsRawPtr, Info, InfoBuilder, ProcessParamFlags, ValuePtr};
 
 static ONCE: Once = Once::new();
 const LOG_PATH: &str = "simple.log";
@@ -74,6 +74,10 @@ impl Plugin for Test {
         trace!("{} receive new tick", self.tag);
     }
 
+    fn idle(&mut self) {
+        trace!("{} idle", self.tag);
+    }
+
     fn process_param(
         &mut self,
         index: usize,

src/cxx/wrapper.cpp

@@ -121,7 +121,7 @@ int _stdcall PluginWrapper::ProcessParam(int Index, int Value, int RECFlags) {
 }
 
 void _stdcall PluginWrapper::Idle_Public() {
-    // if (_editor) _editor->doIdleStuff();
+    plugin_idle(adapter);
 }
 
 void _stdcall PluginWrapper::Eff_Render(PWAV32FS SourceBuffer,

src/cxx/wrapper.h

@@ -68,6 +68,7 @@ TimeSignature time_sig_from_raw(intptr_t raw_time_sig);
 extern "C" intptr_t plugin_dispatcher(PluginAdapter *adapter, Message message);
 extern "C" intptr_t plugin_process_event(PluginAdapter *adapter, Message event);
 extern "C" intptr_t plugin_process_param(PluginAdapter *adapter, Message event);
+extern "C" void plugin_idle(PluginAdapter *adapter);
 extern "C" void plugin_tick(PluginAdapter *adapter);
 extern "C" void plugin_midi_tick(PluginAdapter *adapter);
 extern "C" void plugin_eff_render(PluginAdapter *adapter,

src/host.rs

@@ -362,16 +362,10 @@ impl From<ffi::Message> for Event {
         debug!("Event::from {:?}", message);
 
         let result = match message.id {
-            0 => Event::Tempo(
-                f32::from_raw_ptr(message.index),
-                message.value as u32,
-            ),
+            0 => Event::Tempo(f32::from_raw_ptr(message.index), message.value as u32),
             1 => Event::MaxPoly(message.index as i32),
             2 => Event::MidiPan(message.index as u8, message.value as i8),
-            3 => Event::MidiVol(
-                message.index as u8,
-                f32::from_raw_ptr(message.value),
-            ),
+            3 => Event::MidiVol(message.index as u8, f32::from_raw_ptr(message.value)),
             4 => Event::MidiPitch(message.index as i32),
             _ => Event::Unknown,
         };

src/lib.rs

@@ -224,6 +224,19 @@ pub unsafe extern "C" fn plugin_process_param(
         .as_raw_ptr()
 }
 
+/// [`Plugin::idle`](plugin/trait.Plugin.html#method.idle) FFI.
+///
+/// It supposed to be used internally. Don't use it.
+///
+/// # Safety
+///
+/// Unsafe
+#[doc(hidden)]
+#[no_mangle]
+pub unsafe extern "C" fn plugin_idle(adapter: *mut PluginAdapter) {
+    (*adapter).0.idle();
+}
+
 /// [`Plugin::tick`](plugin/trait.Plugin.html#tymethod.tick) FFI.
 ///
 /// It supposed to be used internally. Don't use it.

src/plugin.rs

@@ -71,6 +71,12 @@ pub trait Plugin: std::fmt::Debug + RefUnwindSafe + Send + Sync + 'static {
     ) -> Box<dyn AsRawPtr> {
         Box::new(0)
     }
+    /// This function is called continuously. It allows the plugin to perform certain tasks that
+    /// are not time-critical and which do not take up a lot of time either. For example, in this
+    /// function you may show a hint message when the mouse moves over a control in the editor.
+    /// 
+    /// Called from GUI thread.
+    fn idle(&mut self) {}
     /// The processing function. The input buffer is empty for generator plugins.
     ///
     /// The buffers are in interlaced 32Bit float stereo format.