cinderwave 0.1.0__py3-none-win_amd64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,111 @@
1
+ Metadata-Version: 2.1
2
+ Name: cinderwave
3
+ Version: 0.1.0
4
+ Summary: Host renderer for the Cinderwave acid groovebox: bakes patterns to WAV through the same zero-dependency C++17 DSP core that runs on the RP2040 hardware.
5
+ Keywords: synthesizer,audio,dsp,acid,groovebox,rp2040,cli
6
+ Author: Makeph
7
+ License: MIT
8
+ Classifier: Environment :: Console
9
+ Classifier: License :: OSI Approved :: MIT License
10
+ Classifier: Programming Language :: C++
11
+ Classifier: Topic :: Multimedia :: Sound/Audio :: Sound Synthesis
12
+ Project-URL: Homepage, https://github.com/Makeph/cinderwave
13
+ Project-URL: Repository, https://github.com/Makeph/cinderwave
14
+ Project-URL: Issues, https://github.com/Makeph/cinderwave/issues
15
+ Requires-Python: >=3.8
16
+ Description-Content-Type: text/markdown
17
+
18
+ # Cinderwave
19
+
20
+ **An open-hardware acid groovebox that fits on a $4 microcontroller.**
21
+
22
+ Cinderwave is a monophonic synth voice and 16-step sequencer in the TB-303
23
+ idiom — band-limited oscillators, a resonant zero-delay-feedback filter,
24
+ per-step accent and slide — running on a Raspberry Pi Pico (RP2040). The entire
25
+ DSP core is platform-independent C++17 with **no dynamic allocation, no
26
+ exceptions, and no dependencies**, so the *exact same code* that drives the
27
+ hardware also renders a `.wav` on your desktop.
28
+
29
+ ```
30
+ ┌───────────┐ ┌──────────┐ ┌──────────────┐ ┌─────────┐
31
+ │ 16-step │──▶│ Oscillator│──▶│ SVF filter │──▶│ VCA │──▶ out
32
+ │ sequencer │ │ saw/sqr/ │ │ (cutoff env │ │ (amp │
33
+ │ note/gate/│ │ tri/sine │ │ + resonance)│ │ env) │
34
+ │ accent/ │ │ PolyBLEP │ └──────▲───────┘ └────▲────┘
35
+ │ slide │ └───────────┘ filter env amp env
36
+ └───────────┘
37
+ ```
38
+
39
+ ## Why it's fun
40
+
41
+ - **Band-limited oscillators** — PolyBLEP saw and square, so the high notes
42
+ don't alias into mush on a cheap DAC.
43
+ - **Cytomic TPT state-variable filter** — the *good* resonant filter, stable and
44
+ self-oscillating across the whole cutoff range.
45
+ - **Real acid behavior** — accent boosts amplitude *and* opens the filter;
46
+ slide portamentos between steps without retriggering the envelope.
47
+ - **One codebase, two worlds** — flash it to a Pico, or `cmake && ctest` it on
48
+ your laptop and bake the demo pattern to audio.
49
+
50
+ ## Quick start (no hardware needed)
51
+
52
+ ```sh
53
+ cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
54
+ cmake --build build -j
55
+ ctest --test-dir build --output-on-failure # DSP unit tests
56
+ ./build/cinderwave_render out.wav # bake the demo acid line to WAV
57
+ ```
58
+
59
+ `cinderwave_render` writes ~8 seconds of the built-in demo pattern (a driving
60
+ 130 BPM bassline with accents and slides) to a 16-bit mono WAV.
61
+
62
+ ## Build the hardware
63
+
64
+ Full bill of materials, GPIO pin map, and two audio-output options (a budget
65
+ PWM + RC filter, or a PCM5102A I2S DAC) live in
66
+ **[hardware/BUILD.md](hardware/BUILD.md)**.
67
+
68
+ Minimum viable Cinderwave:
69
+
70
+ | Part | Qty | Notes |
71
+ |-----------------------------|-----|----------------------------------------|
72
+ | Raspberry Pi Pico (RP2040) | 1 | the whole synth |
73
+ | 10 kΩ linear potentiometer | 3 | cutoff, resonance, tempo |
74
+ | Tactile button | 1 | play / stop |
75
+ | 1.8 kΩ resistor + 10 nF cap | 1 | RC reconstruction filter (~16 kHz) |
76
+ | 10 µF cap + 3.5 mm jack | 1 | DC-blocked line out |
77
+
78
+ ## Flash the firmware
79
+
80
+ ```sh
81
+ cd firmware/rp2040
82
+ export PICO_SDK_PATH=/path/to/pico-sdk
83
+ cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
84
+ cmake --build build -j
85
+ ```
86
+
87
+ Hold **BOOTSEL** while plugging in the Pico, then drop
88
+ `build/cinderwave_firmware.uf2` onto the `RPI-RP2` drive. It boots straight into
89
+ the demo pattern; the three pots take over cutoff, resonance, and tempo, and the
90
+ button toggles playback.
91
+
92
+ ## Layout
93
+
94
+ ```
95
+ include/cinderwave/ Public API — the frozen DSP contract (headers only)
96
+ src/ DSP core: oscillator, envelope, filter, voice, sequencer, synth
97
+ host/ Desktop WAV renderer (uses the identical core)
98
+ firmware/rp2040/ Pico SDK target: PWM audio + pot/button controls
99
+ tests/ Dependency-free unit tests (built and run in CI)
100
+ hardware/ Build guide, BOM, wiring, pin map
101
+ ```
102
+
103
+ ## Continuous integration
104
+
105
+ Every push builds the core, runs the unit tests, renders the demo WAV, and
106
+ cross-compiles the RP2040 `.uf2` — both artifacts are uploaded from the run. See
107
+ [.github/workflows/ci.yml](.github/workflows/ci.yml).
108
+
109
+ ## License
110
+
111
+ MIT — see [LICENSE](LICENSE).
@@ -0,0 +1,5 @@
1
+ cinderwave-0.1.0.data/scripts/cinderwave_render.exe,sha256=mY1NWxBTh33vAB_wWAzULtcYEZzToI9riNb0JRqjkTI,20480
2
+ cinderwave-0.1.0.dist-info/METADATA,sha256=YcuLDnf0HGPi_S-WPH81n7qW18wwslnplDiwUDVm-MY,4847
3
+ cinderwave-0.1.0.dist-info/WHEEL,sha256=k8ugwGhXAI0--PEoWE0F6sXc-nX2zbZqyTgxRg_imsk,102
4
+ cinderwave-0.1.0.dist-info/licenses/LICENSE,sha256=IUndY_RiaPQ92csPAYBrSc92SQB6wQW2qcQjY_m6O98,1063
5
+ cinderwave-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: scikit-build-core 1.0.3
3
+ Root-Is-Purelib: false
4
+ Tag: py3-none-win_amd64
5
+
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Makeph
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.