aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHarald Eilertsen <haraldei@anduin.net>2018-12-20 16:29:48 +0100
committerHarald Eilertsen <haraldei@anduin.net>2018-12-20 16:29:48 +0100
commit8bba906bc14f615223f0f9705465d8c74bd81315 (patch)
tree86f36f9fac452b68f0a097f335488d08a31b3e7c
parent5722e047c488529bfa50fa63ff02672aa3ca3088 (diff)
downloadtrriggy-8bba906bc14f615223f0f9705465d8c74bd81315.tar.gz
trriggy-8bba906bc14f615223f0f9705465d8c74bd81315.tar.bz2
trriggy-8bba906bc14f615223f0f9705465d8c74bd81315.zip
Update readmeHEADmaster
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index faee310..6b4d235 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,26 @@
A naive trigger/drum replacer in Rust.
+By naive, I mean there no attempt at using anything resembling proper signal processing here. We're simply calculating the average amplitute of the samples as we go along, and when we find a sample with significantly higher amplitude than the average, the trigger strikes. To avoid retrigs we wait until the average has dropped below a certain threshold before allowing triggers to fire again.
+
+I've tested this by replacing the bass drum on one of the tracks by one of my bands, a technical thrash metal band with fairly fast double bass drums. (I'll put up some samples later.)
+
+I'll be very happy to hear your experience if you've given it a ride.
+
+## Usage
+
+ # Replace the kick drum in recorded-kick.wav with the cool-kick.wav
+ # and store the result in replaced-kick.wav
+ trriggy --sample cool-kick.wav --output replaced-kick.wav recorded-kick.wav
+
+Trriggy only handles 16bit wave files for now.
+
+## Contributing
+
+The code is a mess, I hope to clean it up and turn it into a library later. This was mostly a test to see what it would take to replace the clicky midi bass drum on our recording with something more juicy.
+
+If you do want to contribute, I'm always happy to take patches by email or a publicly accessible git branch somewhere. I'm also available as `@harald@hub.volse.no` on the social web (Mastodon/Hubzilla/Diaspora etc.)
+
## License
Copyright (C) 2018 [Harald Eilertsen](mailto:haraldei@anduin.net)