rsynth 0.1.2

//! Wrapper for the VST backend.
//!
//! Support is only enabled if you compile with the "backend-vst" feature, see
//! [the cargo reference] for more information on setting cargo features.
//!
//! For an example, see `vst_synth.rs` in the `examples` folder.
//! `examples/test_synth.rs` contains the code that is shared for all backends and
//! `examples/vst_synth.rs` contains the jack-specific code.
//!
//! # Usage
//! See also the documentation of the [`vst_init`] macro.
//!
//! [`vst_init`]: ../../macro.vst_init.html
//! [the cargo reference]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section
use crate::backend::HostInterface;
use crate::buffer::AudioBufferInOut;
use crate::event::{ContextualEventHandler, RawMidiEvent, SysExEvent, Timed};
use crate::{
    AudioHandler, AudioHandlerMeta, CommonAudioPortMeta, CommonPluginMeta, ContextualAudioRenderer,
};
use core::cmp;
use vecstorage::VecStorage;

/// Re-exports from the [`rust-vst`](https://github.com/RustAudio/vst-rs) crate.
pub mod vst {
    pub use vst::*;
}

use self::vst::{
    api::Events,
    buffer::AudioBuffer,
    channels::ChannelInfo,
    event::{Event as VstEvent, MidiEvent as VstMidiEvent, SysExEvent as VstSysExEvent},
    plugin::{Category, HostCallback, Info},
};

/// A VST plugin should implement this trait in addition to some other traits.
// TODO: document which other traits.
pub trait VstPluginMeta: CommonPluginMeta + AudioHandlerMeta {
    fn plugin_id(&self) -> i32;
    fn category(&self) -> Category;
}

/// A struct used internally by the `vst_init` macro. Normally, plugin's do not need to use this.
pub struct VstPluginWrapper<P> {
    plugin: P,
    host: HostCallback,
    inputs_f32: VecStorage<&'static [f32]>,
    outputs_f32: VecStorage<&'static [f32]>,
    inputs_f64: VecStorage<&'static [f64]>,
    outputs_f64: VecStorage<&'static [f64]>,
}

impl<P> VstPluginWrapper<P>
where
    P: CommonAudioPortMeta
        + VstPluginMeta
        + AudioHandler
        + ContextualEventHandler<Timed<RawMidiEvent>, HostCallback>
        + ContextualAudioRenderer<f32, HostCallback>
        + ContextualAudioRenderer<f64, HostCallback>,
    for<'a> P: ContextualEventHandler<Timed<SysExEvent<'a>>, HostCallback>,
{
    pub fn get_info(&self) -> Info {
        trace!("get_info");
        Info {
            name: self.plugin.name().to_string(),
            inputs: self.plugin.max_number_of_audio_inputs() as i32,
            outputs: self.plugin.max_number_of_audio_outputs() as i32,
            unique_id: self.plugin.plugin_id(),
            category: self.plugin.category(),
            ..Info::default()
        }
    }

    pub fn new(plugin: P, host: HostCallback) -> Self {
        Self {
            inputs_f32: VecStorage::with_capacity(plugin.max_number_of_audio_inputs()),
            outputs_f32: VecStorage::with_capacity(plugin.max_number_of_audio_outputs()),
            inputs_f64: VecStorage::with_capacity(plugin.max_number_of_audio_inputs()),
            outputs_f64: VecStorage::with_capacity(plugin.max_number_of_audio_outputs()),
            plugin,
            host,
        }
    }

    pub fn host(&self) -> &HostCallback {
        &self.host
    }

    pub fn process<'b>(&mut self, buffer: &mut AudioBuffer<'b, f32>) {
        let number_of_frames = buffer.samples();
        let (input_buffers, mut output_buffers) = buffer.split();

        let mut inputs = self.inputs_f32.vec_guard();
        for i in 0..cmp::min(inputs.capacity(), input_buffers.len()) {
            inputs.push(input_buffers.get(i));
        }

        let mut outputs = self.outputs_f32.vec_guard();
        for i in 0..cmp::min(outputs.capacity(), output_buffers.len()) {
            // We will need another way to do this
            // when https://github.com/rust-dsp/rust-vst/issues/73 is closed.
            outputs.push(output_buffers.get_mut(i));
        }

        let mut audio_buffer =
            AudioBufferInOut::new(inputs.as_slice(), outputs.as_mut_slice(), number_of_frames);
        self.plugin.render_buffer(&mut audio_buffer, &mut self.host);
    }

    pub fn process_f64<'b>(&mut self, buffer: &mut AudioBuffer<'b, f64>) {
        let number_of_frames = buffer.samples();
        let (input_buffers, mut output_buffers) = buffer.split();

        let mut inputs = self.inputs_f64.vec_guard();
        for i in 0..cmp::min(inputs.capacity(), input_buffers.len()) {
            inputs.push(input_buffers.get(i));
        }

        let mut outputs = self.outputs_f64.vec_guard();
        for i in 0..cmp::min(outputs.capacity(), output_buffers.len()) {
            // We will need another way to do this
            // when https://github.com/rust-dsp/rust-vst/issues/73 is closed.
            outputs.push(output_buffers.get_mut(i));
        }

        let mut audio_buffer =
            AudioBufferInOut::new(inputs.as_slice(), outputs.as_mut_slice(), number_of_frames);
        self.plugin.render_buffer(&mut audio_buffer, &mut self.host);
    }

    pub fn get_input_info(&self, input_index: i32) -> ChannelInfo {
        trace!("get_input_info({})", input_index);
        ChannelInfo::new(
            self.plugin.audio_input_name(input_index as usize),
            None,
            true,
            None,
        )
    }

    pub fn get_output_info(&self, output_index: i32) -> ChannelInfo {
        trace!("get_output_info({})", output_index);
        ChannelInfo::new(
            self.plugin.audio_output_name(output_index as usize),
            None,
            true,
            None,
        )
    }

    pub fn process_events(&mut self, events: &Events) {
        trace!("process_events");
        for e in events.events() {
            match e {
                VstEvent::SysEx(VstSysExEvent {
                    payload,
                    delta_frames,
                    ..
                }) => {
                    let event = Timed {
                        time_in_frames: delta_frames as u32,
                        event: SysExEvent::new(payload),
                    };
                    self.plugin.handle_event(event, &mut self.host);
                }
                VstEvent::Midi(VstMidiEvent {
                    data, delta_frames, ..
                }) => {
                    let event = Timed {
                        time_in_frames: delta_frames as u32,
                        event: RawMidiEvent::new(&data),
                    };
                    self.plugin.handle_event(event, &mut self.host);
                }
                _ => (),
            }
        }
    }

    pub fn set_sample_rate(&mut self, sample_rate: f64) {
        trace!("sample_rate: {}", sample_rate);
        self.plugin.set_sample_rate(sample_rate);
    }
}

impl HostInterface for HostCallback {
    fn output_initialized(&self) -> bool {
        // TODO: Some hosts do initialize the output to zero.
        // TODO: Return true for these hosts.
        false
    }
}

/// A wrapper around the `plugin_main!` macro from the `vst` crate.
/// You call this with one parameter, which is the function declaration of a function
/// that creates your plugin.
/// This function may also do some setup (e.g. initialize logging).
///
/// # Example using generic code
/// ```
/// # #[macro_use] extern crate rsynth;
/// # extern crate num_traits;
/// # extern crate asprim;
/// # #[macro_use] extern crate vst;
/// use rsynth::{
///     meta::{Meta, MetaData, Port, MidiPort, AudioPort, InOut},
///     event::{
///         ContextualEventHandler,
///         Timed,
///         RawMidiEvent,
///         SysExEvent
///     },
///     backend::{
///         HostInterface,
///         vst_backend::VstPluginMeta
///     },
///     ContextualAudioRenderer,
///     AudioHandler
/// };
///
/// struct MyPlugin {
///   meta: MetaData<&'static str, &'static str, &'static str>
///   // Define other fields here
/// }
///
/// impl Meta for MyPlugin {
///    type MetaData = MetaData<&'static str, &'static str, &'static str>;
///     fn meta(&self) -> &Self::MetaData {
///         &self.meta
///     }
/// }
///
/// // Use the re-exports from `rsynth` so that your code doesn't break when `rsynth` upgrades
/// // its dependency on `vst-rs`
/// use rsynth::backend::vst_backend::vst::plugin::Category;
/// impl VstPluginMeta for MyPlugin {
///     fn plugin_id(&self) -> i32 { 123 }
///     fn category(&self) -> Category { Category::Synth }
/// }
///
/// use asprim::AsPrim;
/// use num_traits::Float;
/// # use rsynth::buffer::AudioBufferInOut;
///
/// impl AudioHandler for MyPlugin {
///     // Implementation omitted for brevity.
/// #     fn set_sample_rate(&mut self, new_sample_rate: f64) {}
/// }
///
///
/// impl<S, H> ContextualAudioRenderer<S, H> for MyPlugin
/// where
///     S: Float + AsPrim,
///     H: HostInterface,
/// {
///     // Implementation omitted for brevity.
/// #    fn render_buffer(&mut self, buffer: &mut AudioBufferInOut<S>, context: &mut H)
/// #    {
/// #        unimplemented!()
/// #    }
/// }
///
/// impl<H> ContextualEventHandler<Timed<RawMidiEvent>, H> for MyPlugin
/// where
///     H: HostInterface,
/// {
/// #    fn handle_event(&mut self, event: Timed<RawMidiEvent>, context: &mut H) {}
///     // Implementation omitted for brevity.
/// }
///
/// impl<'a, H> ContextualEventHandler<Timed<SysExEvent<'a>>, H> for MyPlugin
/// where
///     H: HostInterface,
/// {
/// #    fn handle_event(&mut self, event: Timed<SysExEvent<'a>>, context: &mut H) {}
///     // Implementation omitted for brevity.
/// }
///
/// vst_init!(
///    fn init() -> MyPlugin {
///        MyPlugin {
///             meta: MetaData {
///                 general_meta: "my_plugin",
///                 audio_port_meta: InOut {
///                     inputs: vec!["audio in 1", "audio in 2"],
///                     outputs: vec!["audio out 1", "audio out 2"],
///                 },
///                 midi_port_meta: InOut {
///                     inputs: vec!["midi in 1"],
///                     outputs: vec![],
///                 },
///             }
///        }
///    }
/// );
/// ```
/// # Example using VST-specific code
/// ```
/// # #[macro_use] extern crate rsynth;
/// # extern crate num_traits;
/// # extern crate asprim;
/// # #[macro_use] extern crate vst;
/// use rsynth::{
///     meta::{Meta, MetaData, Port, MidiPort, AudioPort, InOut},
///     event::{
///         ContextualEventHandler,
///         Timed,
///         RawMidiEvent,
///         SysExEvent
///     },
///     backend::{
///         HostInterface,
///         vst_backend::VstPluginMeta
///     },
///     ContextualAudioRenderer,
///     AudioHandler
/// };
///
/// struct MyPlugin {
///   meta: MetaData<&'static str, &'static str, &'static str>
///   // Define other fields here
/// }
///
/// impl Meta for MyPlugin {
///    type MetaData = MetaData<&'static str, &'static str, &'static str>;
///     fn meta(&self) -> &Self::MetaData {
///         &self.meta
///     }
/// }
///
/// // Use the re-exports from `rsynth` so that your code doesn't break when `rsynth` upgrades
/// // its dependency on `vst-rs`
/// use rsynth::backend::vst_backend::vst::plugin::Category;
/// impl VstPluginMeta for MyPlugin {
///     fn plugin_id(&self) -> i32 { 123 }
///     fn category(&self) -> Category { Category::Synth }
/// }
///
/// use asprim::AsPrim;
/// use num_traits::Float;
/// # use rsynth::buffer::AudioBufferInOut;
///
/// impl AudioHandler for MyPlugin {
///     // Implementation omitted for brevity.
/// #     fn set_sample_rate(&mut self, new_sample_rate: f64) {}
/// }
///
/// // Use the re-exports from `rsynth` so that your code doesn't break when `rsynth` upgrades
/// // its dependency on `vst-rs`
/// use rsynth::backend::vst_backend::vst::plugin::HostCallback;
/// impl<S> ContextualAudioRenderer<S, HostCallback> for MyPlugin
/// where
///     S: Float + AsPrim,
/// {
///     fn render_buffer(&mut self, buffer: &mut AudioBufferInOut<S>, context: &mut HostCallback)
///     {
///          // Here you can call functions on the context if you want.
/// #        unimplemented!()
///     }
/// }
///
/// impl ContextualEventHandler<Timed<RawMidiEvent>, HostCallback> for MyPlugin
/// {
///     fn handle_event(&mut self, event: Timed<RawMidiEvent>, context: &mut HostCallback) {
///         // Here you can call functions on the context if you want.
///     }
/// }
///
/// impl<'a> ContextualEventHandler<Timed<SysExEvent<'a>>, HostCallback> for MyPlugin
/// {
///     fn handle_event(&mut self, event: Timed<SysExEvent<'a>>, context: &mut HostCallback) {
///         // Here you can call functions on the context if you want.
///     }
/// }
///
/// vst_init!(
///    fn init() -> MyPlugin {
///        MyPlugin {
///             meta: MetaData {
///                 general_meta: "my_plugin",
///                 audio_port_meta: InOut {
///                     inputs: vec!["audio in 1", "audio in 2"],
///                     outputs: vec!["audio out 1", "audio out 2"],
///                 },
///                 midi_port_meta: InOut {
///                     inputs: vec!["midi in 1"],
///                     outputs: vec![],
///                 },
///             }
///        }
///    }
/// );
/// ```
//
// We define this macro so that plugins do not have to implement th `Default` trait.
//
// We will need the return type (as type parameter for `VstWrapperWrapper`)
// and we need to call the function in the `vst::plugin::Plugin::new()` function
// to which we cannot supply an extra parameter.
// This is the reason why we use a macro instead of a normal function that gets
// a `FnOnce` or something like that.
#[macro_export]
macro_rules! vst_init {
    (fn $function_name:ident() -> $return_type:ty
        $body:block
    ) => {

        fn $function_name () -> $return_type
        $body

        struct VstWrapperWrapper {
            wrapper: $crate::backend::vst_backend::VstPluginWrapper<$return_type>
        }

        impl Default for VstWrapperWrapper {
            fn default() -> Self {
                // We only need this so that the `Plugin` trait from the vst crate
                // can have a default implementation for its `new` function,
                // it is not actually used by the `vst` crate.
                unreachable!()
            }
        }

        // This macro is expanded in the context of the plugin.
        // For this reason, we do not use any "use" statements here,
        // as this may mess up the plugin's namespaces.
        // This is why you see `vst::` namespace repeated all over in this macro.
        impl vst::plugin::Plugin for VstWrapperWrapper
        {
            fn get_info(&self) -> vst::plugin::Info {
                self.wrapper.get_info()
            }

            fn new(host: vst::plugin::HostCallback) -> Self
            where
                Self: Sized + Default
            {
                VstWrapperWrapper
                {
                    wrapper: $crate::backend::vst_backend::VstPluginWrapper::new($function_name(), host)
                }
            }

            fn init(&mut self) {
                // Get the sample rate from the host and set it in the plugin.
                let sample_rate =
                    if let Some(vst::api::TimeInfo{sample_rate: sr, ..}) =
                        vst::host::Host::get_time_info(
                            self.wrapper.host(),
                            0 // equivalent to `vst::api::TimeInfoFlags::empty().bits()`
                        )
                    {
                        Some(sr)
                    } else {
                        None
                    };
                if let Some(sr) = sample_rate {
                    self.wrapper.set_sample_rate(sr);
                }
            }

            #[inline]
            fn process<'b>(&mut self, buffer: &mut vst::buffer::AudioBuffer<'b, f32>) {
                self.wrapper.process(buffer);
            }

            #[inline]
            fn process_f64<'b>(&mut self, buffer: &mut vst::buffer::AudioBuffer<'b, f64>) {
                self.wrapper.process_f64(buffer);
            }

            fn get_input_info(&self, input_index: i32) -> vst::channels::ChannelInfo {
                self.wrapper.get_input_info(input_index)
            }

            fn get_output_info(&self, output_index: i32) -> vst::channels::ChannelInfo {
                self.wrapper.get_output_info(output_index)
            }

            #[inline]
            fn process_events(&mut self, events: &vst::api::Events) {
                self.wrapper.process_events(events)
            }
        }

        plugin_main!(VstWrapperWrapper);
    }
}