Crate nice_plug_core 

Re-exports

pub use log;

Modules

audio_setup

Types and definitions surrounding a plugin’s audio IO setup.

buffer

Adapters and utilities for working with audio buffers.

context

Different contexts the plugin can use to make callbacks to the host in different…contexts.

debug

Macros for logging and debug assertions. nice_dbg!(), nice_trace!(), and the nice_debug_assert_*!() macros are compiled out during release builds, so they can be used for asserting adiditonal invariants in debug builds. Check the nice_log!() macro for more information on nice-plug’s logger. None of the logging functions are realtime-safe, and you should avoid using them during release builds in any of the functions that may be called from an audio thread.

editor

Traits for working with plugin editors.

formatters

Convenience functions for formatting and parsing parameter values in various common formats.

midi

Constants and definitions surrounding MIDI support.

params

nice-plug can handle floating point, integer, boolean, and enum parameters. Parameters are managed by creating a struct deriving the Params trait containing fields for those parameter types, and then returning a reference to that object from your Plugin::params() method. See the Params trait for more information.

plugin

Traits and structs describing plugins and editors. This includes extension structs for features that are specific to one or more plugin-APIs.

util

General conversion functions and utilities.

Macros

nice_dbg

Analogues to the dbg!() macro, but respecting the NICE_LOG environment variable and with all of the same logging features as the other nice_*!() macros. Like the nice_debug_assert*!() macros, this is only shown when compiling in debug mode, but the macro will still return the value in non-debug modes.

nice_debug_assert

A debug_assert!() analogue that prints the error with line number information instead of panicking. During tests this is upgraded to a regular panicking debug_assert!().

nice_debug_assert_eq

A debug_assert_eq!() analogue that prints the error with line number information instead of panicking. See nice_debug_assert!() for more information.

nice_debug_assert_failure

An unconditional debug assertion failure, for if the condition has already been checked elsewhere. See nice_debug_assert!() for more information.

nice_debug_assert_ne

A debug_assert_ne!() analogue that prints the error with line number information instead of panicking. See nice_debug_assert!() for more information.

nice_error

Similar to nice_log!(), but more scream-y. Used for printing fatal errors.

nice_log

Write something to the logger. This defaults to STDERR unless the user is running Windows and a debugger has been attached, in which case OutputDebugString() will be used instead.

nice_trace

The same as nice_log!(), but with source and thread information. Like the nice_debug_assert*!() macros, this is only shown when compiling in debug mode.

nice_warn

Similar to nice_log!(), but less subtle. Used for printing warnings.