From 82976026e02f30a8156d878d9ee15da08dfe467e Mon Sep 17 00:00:00 2001 From: Weird Constructor Date: Tue, 18 May 2021 19:03:15 +0200 Subject: [PATCH] added commented example on how to use HexoDSP --- Cargo.toml | 1 + README.md | 10 ++++++++-- examples/{jack_demo.rs => jack_demo_node_api.rs} | 2 +- src/lib.rs | 7 +++++++ 4 files changed, 17 insertions(+), 3 deletions(-) rename examples/{jack_demo.rs => jack_demo_node_api.rs} (99%) diff --git a/Cargo.toml b/Cargo.toml index 545df8e..5da9376 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -25,5 +25,6 @@ hound = "3.4.0" jack = "0.6.6" [lib] +path = "src/lib.rs" name = "hexodsp" crate-type = ["lib"] diff --git a/README.md b/README.md index 97caa31..4b7096d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + # HexoDSP - Comprehensive DSP graph and synthesis library for developing a modular synthesizer in Rust, such as HexoSynth. This project contains the complete DSP backend of the modular @@ -16,6 +17,7 @@ single nodes to get the current output value of all nodes. Here a short list of features: * Runtime changeable DSP graph +* Serialization and loading of the DSP graph and the parameters * Full monitoring and feedback introspection into the running DSP graph * Provides a wide variety of modules * Extensible framework for quickly developing new nodes at compile time @@ -25,8 +27,9 @@ Here a short list of features: ### Documentation -The development documentation can be found separately hosted: -[HexoDSP API Documentation](http://m8geil.de/hexodsp_doc/hexodsp/). +The development documentation with all private fields and functions can be +found separately hosted: +[HexoDSP API Developer Documentation](http://m8geil.de/hexodsp_doc/hexodsp/). ### Raw `NodeConfigurator` API @@ -230,3 +233,6 @@ We can discuss relicensing of my code or project if you are interested in using it in a closed source project. Bear in mind, that I can only relicense the parts of the project I wrote. If the project contains GPL code from other projects and authors, I can't relicense it. + + +License: AGPL-3.0-or-later diff --git a/examples/jack_demo.rs b/examples/jack_demo_node_api.rs similarity index 99% rename from examples/jack_demo.rs rename to examples/jack_demo_node_api.rs index d633d8e..0e415d7 100644 --- a/examples/jack_demo.rs +++ b/examples/jack_demo_node_api.rs @@ -126,7 +126,7 @@ fn main() { println!("set gain={:4.2}", new_gain); node_conf.set_param(amp_gain_param, new_gain.into()); - std::thread::sleep(std::time::Duration::from_millis(500)); + std::thread::sleep(std::time::Duration::from_millis(300)); } }); } diff --git a/src/lib.rs b/src/lib.rs index b7320d5..966127f 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -22,6 +22,7 @@ single nodes to get the current output value of all nodes. Here a short list of features: * Runtime changeable DSP graph +* Serialization and loading of the DSP graph and the parameters * Full monitoring and feedback introspection into the running DSP graph * Provides a wide variety of modules * Extensible framework for quickly developing new nodes at compile time @@ -29,6 +30,12 @@ Here a short list of features: ## API Examples +### Documentation + +The development documentation with all private fields and functions can be +found separately hosted: +[HexoDSP API Developer Documentation](http://m8geil.de/hexodsp_doc/hexodsp/). + ### Raw `NodeConfigurator` API This API is the most low level API provided by HexoDSP.