alex/nih-plug
1
0
Fork 0
Code Activity

Document the FTZ flags in the process function

Browse source
This commit is contained in:
Robbert van der Helm 2022-02-03 16:22:32 +01:00
parent e642fb5ff8
commit 82dfee9313
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
src/plugin.rs
View file

@ -74,7 +74,8 @@ pub trait Plugin: Default + Send + Sync {
/// Initialize the plugin for the given bus and buffer configurations. If the plugin is being /// Initialize the plugin for the given bus and buffer configurations. If the plugin is being
/// restored from an old state, then that state will have already been restored at this point. /// restored from an old state, then that state will have already been restored at this point.
/// If based on those parameters (or for any reason whatsoever) the plugin needs to introduce /// If based on those parameters (or for any reason whatsoever) the plugin needs to introduce
/// latency, then you can do so here using the process context. /// latency, then you can do so here using the process context. Depending on how the host
/// restores plugin state, this function may also be called twice in rapid succession.
/// ///
/// Before this point, the plugin should not have done any expensive initialization. Please /// Before this point, the plugin should not have done any expensive initialization. Please
/// don't be that plugin that takes twenty seconds to scan. /// don't be that plugin that takes twenty seconds to scan.
@ -85,11 +86,12 @@ pub trait Plugin: Default + Send + Sync {
context: &dyn ProcessContext, context: &dyn ProcessContext,
) -> bool; ) -> bool;
/// Process audio. To not have to worry about aliasing, the host's input buffer have already /// Process audio. The host's input buffers have already been copied to the output buffers if
/// been copied to the output buffers if they are not handling buffers in place (most hosts do /// they are not processing audio in place (most hosts do however). All channels are also
/// however). All channels are also guarenteed to contain the same number of samples. Depending /// guarenteed to contain the same number of samples. Lastly, denormals have already been taken
/// on how the host restores plugin state, this function may also be called twice in rapid /// case of by NIH-plug, and you can optionally enable the `assert_process_allocs` feature to
/// succession. /// abort the program when any allocation accurs in the process function while running in debug
/// mode.
/// ///
/// TODO: Provide a way to access auxiliary input channels if the IO configuration is /// TODO: Provide a way to access auxiliary input channels if the IO configuration is
/// assymetric /// assymetric