feat: new realm /r/demo/bytebeat #840
Conversation
github-actions
bot
added
the
🧾 package/realm
There was a problem hiding this comment.
You'll probably need to add some corresponding gno.mod files, seeing as we restructured the examples directory to have them.
Lots of comments; mostly formatting and doc requests :) I know you added the README, which I really appreciate, but I think some code comments on usage and the function parameters can be really useful to other potential users.
Sorry it took long to review this, going through a long backlog. Hopefully I'll also get to the haiku package soon enough. Thank you for your work! 🎉
| @@ -0,0 +1,57 @@ | |||
| package biquad | |||
There was a problem hiding this comment.
pkgdoc with some references to what biquad implements, for the ignorant reader (such as me?)
There was a problem hiding this comment.
Added in 3536794! Sorry I should've added more info, basically biquad is an implementation of basic digital signal processing tools (filters).
| x1_f, x2_f, y1_f, y2_f float64 | ||
| } | ||
|
|
||
| func New(fc float64, fs float64, q float64, db float64, filter_type string) (f *Filter) { |
There was a problem hiding this comment.
| func New(fc float64, fs float64, q float64, db float64, filter_type string) (f *Filter) { | |
| func New(fc float64, fs float64, q float64, db float64, filterType string) *Filter { |
(we don't used the named return parameter)
also add some doc, especially on what each parameter is?
There was a problem hiding this comment.
Thanks, didn't know about the return convention, will follow here on out. Update is here: 6939ecd
| } | ||
|
|
||
| func New(fc float64, fs float64, q float64, db float64, filter_type string) (f *Filter) { | ||
| w0 := 2 * 3.1415926535897932384626 * (fc / fs) |
There was a problem hiding this comment.
| w0 := 2 * 3.1415926535897932384626 * (fc / fs) | |
| w0 := 2 * math.Pi * (fc / fs) |
There was a problem hiding this comment.
Thanks! Added in 1ce2f76
| A := 1.0 // db = 0 | ||
| _ = A | ||
| // A := math.Pow(10, (db / 40)) |
There was a problem hiding this comment.
Those coefficients are for other types of filters (notch, shelf) which are not implemented here. I kept them in for posterity, but I'll just remove them: ba2fd7d
| alpha := sinW / (2 * q) | ||
| beta := 1 // db = 0 | ||
| // beta := A ^ 0.5/q | ||
| _ = beta | ||
| b0 := (1 - cosW) / 2 | ||
| b1 := 1 - cosW | ||
| b2 := (1 - cosW) / 2 | ||
| a0 := 1 + alpha | ||
| a1 := -2 * cosW | ||
| a2 := 1 - alpha | ||
| if filter_type == "highpass" { | ||
| b0 = (1 + cosW) / 2 | ||
| b1 = -(1 + cosW) | ||
| b2 = (1 + cosW) / 2 | ||
| } else if filter_type == "lowpass" { | ||
| // do nothing, default | ||
| } |
There was a problem hiding this comment.
black magic; can it be demystified? or at least have a reference to the implemented algorithm?
There was a problem hiding this comment.
Ha yeah! It does indeed look like black magic. Its basically ways to derive coefficients to the solution of a "biquadratic" equation, which allows you to extract multiple filter types from the same topology, just changing coefficients. I added a reference that explains it well. (c6d5413)
| // highpass filter | ||
| hpf := biquad.New(10, float64(sampleRate), 0.707, 0, "highpass") | ||
| for i := uint32(0); i < numSamples; i++ { | ||
| samples[i].Values[0] = int(math.Round(hpf.Update(float64(samples[i].Values[0])))) | ||
| } | ||
| // lowpass |
There was a problem hiding this comment.
can we have some references for these magic values? :)
There was a problem hiding this comment.
Yep, added in ee06123
| @@ -0,0 +1,70 @@ | |||
| package riff | |||
There was a problem hiding this comment.
Thanks, added in 285626a
| @@ -0,0 +1,100 @@ | |||
| package wav | |||
There was a problem hiding this comment.
I know I'm more annoying than golint, but I would also appreciate the same here :)
There was a problem hiding this comment.
No worries! I sometimes work so fast I forget about these things, added in 97081f6
| gnokey maketx addpkg --pkgpath "gno.land/r/demo/bytebeat" --pkgdir "examples/gno.land/r/demo/bytebeat" --deposit 100000000ugnot --gas-fee 1000000ugnot --gas-wanted 3000000 --broadcast --chainid dev --remote localhost:26657 <yourkey> | ||
| ``` | ||
|
|
||
| Note that adding the `gno.land/p/demo/audio/bytebeat` requires adding more to `--gas-wanted` (at least 8000000). |
There was a problem hiding this comment.
| Note that adding the `gno.land/p/demo/audio/bytebeat` requires adding more to `--gas-wanted` (at least 8000000). | |
| Note that adding the `gno.land/p/demo/audio/bytebeat` package requires adding more to `--gas-wanted` (at least 8000000). |
|
|
||
| func TestByteBeat(t *testing.T) { | ||
| s := Render("") | ||
| if len(s) != 128194 { |
There was a problem hiding this comment.
very dependent on the format, don't you think?
what about strings.Contains(s, data)?
There was a problem hiding this comment.
Yep, this is fixed now (fixed a bit ago, not sure which commit).
|
@thehowl Thanks for the review. No problem about the time :), I am happy to get started with your feedback. |
|
This package has been updated to utilize the |
This eval realm is capable of evaluating 32-bit integer expressions as they would appear in Go. For example, you can use this package (and realm) to evaluate an expression like `"(32*32+4)-1"` when presented as a string. This could have several applications. This current "eval" realm is simply demonstrating it as a 32-bit integer calculator. I would like to also add floats, but it seems `strconv.ParseFloat` is not available yet. In the future I would like to use the int32 version of this package in the bytebeat realm (#840) which could then utilize this library to generate audio directly from string expressions, instead of programmed realms - which ultimately gets closer to an audio NFT platform where expressions are uploaded if they are parsed correctly. To test, you can just add the `eval` package and realm: ``` > gnokey maketx addpkg --pkgpath "gno.land/p/demo/math_eval_int32" \ --pkgdir "examples/gno.land/p/demo/math_eval/int32" \ --deposit 100000000ugnot --gas-fee 1000000ugnot \ --gas-wanted 2000000 --broadcast --chainid dev --remote localhost:26657 \ YOURKEY > gnokey maketx addpkg --pkgpath "gno.land/r/demo/math_eval" \ --pkgdir "examples/gno.land/r/demo/math_eval" \ --deposit 100000000ugnot --gas-fee 1000000ugnot \ --gas-wanted 2000000 --broadcast --chainid dev --remote localhost:26657 \ YOURKEY ``` Then open up to `localhost:8888/r/demo/math_eval` and try expressions in the URL query, like `localhost:8888/r/demo/math_eval:1+1`.  <details><summary>Checklists...</summary> ## Contributors Checklist - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [x] Added references to related issues and PRs - [x] Provided any useful hints for running manual tests - [ ] Added new benchmarks to [generated graphs](https://gnoland.github.io/benchmarks), if any. More info [here](../.benchmarks/README.md). ## Maintainers Checklist - [ ] Checked that the author followed the guidelines in `CONTRIBUTING.md` - [ ] Checked the conventional-commit (especially PR title and verb, presence of `BREAKING CHANGE:` in the body) - [ ] Ensured that this PR is not a significant change or confirmed that the review/consideration process was appropriate for the change </details> --------- Co-authored-by: Manfred Touron <[email protected]>
Please note - this PR is dependent on merging of #965.
bytebeat realm
The intention behind this realm is to provide a proof-of-concept for generating audio through smart contracts (for possible future use with web3 audio nfts or similar).
There are several packages added to accomplish this:
examples/gno.land/p/demo/audio/riff: generatesriffheaders for.wavfilesexamples/gno.land/p/demo/audio/wav: providesWriterinterface for writing.wavfilesexamples/gno.land/p/demo/audio/biquad: implements basic 2nd-order digital biquad filter for doing low-pass and high-pass filteringexamples/gno.land/p/demo/audio/bytebeat: core library for generating 16-bit byte-beat audio that is post-processed with a DC offset filter and a high pass filter to eliminate aliasingDemo
(turn audio on)
bytebeat-realm.mp4
Caveats
Currently, there is a limitation to the number of CPU cycles available to a contract and the realm is currently limited to generating only 2 seconds of audio at 8 kHz.
Usage
To use, add the packages for the audio library and then add the realm:
Adding the
gno.land/p/demo/audio/bytebeatrequires adding more to--gas-wanted(at least 8000000).