tuxmain/HexoDSP
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

added commented example on how to use HexoDSP

Browse source
This commit is contained in:
Weird Constructor 2021-05-18 19:03:15 +02:00
parent 951a771d88
commit 82976026e0
4 changed files with 17 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Cargo.toml
View file

@ -25,5 +25,6 @@ hound = "3.4.0"
jack = "0.6.6" jack = "0.6.6"
[lib] [lib]
path = "src/lib.rs"
name = "hexodsp" name = "hexodsp"
crate-type = ["lib"] crate-type = ["lib"]

10
README.md
View file

@ -1,3 +1,4 @@
# HexoDSP - Comprehensive DSP graph and synthesis library for developing a modular synthesizer in Rust, such as HexoSynth. # 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 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: Here a short list of features:
* Runtime changeable DSP graph * Runtime changeable DSP graph
* Serialization and loading of the DSP graph and the parameters
* Full monitoring and feedback introspection into the running DSP graph * Full monitoring and feedback introspection into the running DSP graph
* Provides a wide variety of modules * Provides a wide variety of modules
* Extensible framework for quickly developing new nodes at compile time * Extensible framework for quickly developing new nodes at compile time
@ -25,8 +27,9 @@ Here a short list of features:
### Documentation ### Documentation
The development documentation can be found separately hosted: The development documentation with all private fields and functions can be
[HexoDSP API Documentation](http://m8geil.de/hexodsp_doc/hexodsp/). found separately hosted:
[HexoDSP API Developer Documentation](http://m8geil.de/hexodsp_doc/hexodsp/).
### Raw `NodeConfigurator` API ### 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 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 parts of the project I wrote. If the project contains GPL code from other
projects and authors, I can't relicense it. projects and authors, I can't relicense it.
License: AGPL-3.0-or-later

2
examples/jack_demo.rs → examples/jack_demo_node_api.rs
View file

@ -126,7 +126,7 @@ fn main() {
println!("set gain={:4.2}", new_gain); println!("set gain={:4.2}", new_gain);
node_conf.set_param(amp_gain_param, new_gain.into()); 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));
} }
}); });
} }

7
src/lib.rs
View file

@ -22,6 +22,7 @@ single nodes to get the current output value of all nodes.
Here a short list of features: Here a short list of features:
* Runtime changeable DSP graph * Runtime changeable DSP graph
* Serialization and loading of the DSP graph and the parameters
* Full monitoring and feedback introspection into the running DSP graph * Full monitoring and feedback introspection into the running DSP graph
* Provides a wide variety of modules * Provides a wide variety of modules
* Extensible framework for quickly developing new nodes at compile time * Extensible framework for quickly developing new nodes at compile time
@ -29,6 +30,12 @@ Here a short list of features:
## API Examples ## 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 ### Raw `NodeConfigurator` API
This API is the most low level API provided by HexoDSP. This API is the most low level API provided by HexoDSP.