first.

.gitignore

@@ -0,0 +1,15 @@
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+

Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "estripe"
+version = "0.1.0"
+authors = ["Pificária <[email protected]>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+jack = "0.8"
+rosc = "~0.5"
+structopt = "0.3"
+parking_lot = "0.11"
+packed_simd = { version = "0.3.6", package = "packed_simd_2" }
+tokio = { version = "1", features = ["full"] }

README.md

@@ -1,2 +1,21 @@
-# estripe
+# About
 Stereo 3-band parametric equalizer for jack with fader and mono controls.
+
+# Usage
+Estripe runs an OSC server at port 5510, and can receive messages at the
+following paths:
+
+| Path | Msg Type | Parameter |
+| ---- | -------- | ---------- |
+| /fader | _float_ | volume in dB |
+| /mono | _int_ | 0 for stereo, 1 for mono |
+| /fil/k/type | _string_ | filter type |
+| /fil/k/freq | _float_ | frequency in Hz |
+| /fil/k/gain | _float_ | gain in dB |
+| /fil/k/q | _float_ | Q value |
+
+Where _k_ ranges from 1 to 3 and specifies which of the three filters you are
+changing the parameter for. The 'filter type' message can be _off_ to disable
+the filter, or _lowshelf_, _lowpass_, _peak_, _hishelf_ and _hipass_. The filter
+coefficients are from [RBJ's filter
+cookbook](https://shepazu.github.io/Audio-EQ-Cookbook/audio-eq-cookbook.html).