@glissade/sfx 0.5.0-pre.2
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.
- package/LICENSE +202 -0
- package/dist/index.d.ts +122 -0
- package/dist/index.js +293 -0
- package/package.json +29 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
import { AudioClip } from "@glissade/core";
|
|
2
|
+
|
|
3
|
+
//#region src/index.d.ts
|
|
4
|
+
|
|
5
|
+
declare class SfxError extends Error {
|
|
6
|
+
constructor(message: string);
|
|
7
|
+
}
|
|
8
|
+
type SfxWaveform = 'square' | 'saw' | 'sine' | 'noise';
|
|
9
|
+
/** The synth's knob set. Times are seconds; frequencies Hz; levels 0..1. */
|
|
10
|
+
interface SfxrParams {
|
|
11
|
+
waveform: SfxWaveform;
|
|
12
|
+
/** linear fade-in */
|
|
13
|
+
attack: number;
|
|
14
|
+
/** flat hold at full level */
|
|
15
|
+
sustain: number;
|
|
16
|
+
/** linear fade-out to silence */
|
|
17
|
+
decay: number;
|
|
18
|
+
/** pitch at t=0 */
|
|
19
|
+
startFreq: number;
|
|
20
|
+
/** linear pitch glide, Hz per second (may be negative) */
|
|
21
|
+
slide?: number;
|
|
22
|
+
/** square-wave duty cycle, 0..1; ignored by other waveforms. Default 0.5 */
|
|
23
|
+
duty?: number;
|
|
24
|
+
/** output level, 0..1. Default 1 */
|
|
25
|
+
volume?: number;
|
|
26
|
+
/** one-shot arpeggio: after `arpTime` s, multiply the base pitch by this */
|
|
27
|
+
arpMul?: number;
|
|
28
|
+
arpTime?: number;
|
|
29
|
+
/** deterministic seed for the noise waveform. Default a fixed constant. */
|
|
30
|
+
noiseSeed?: number;
|
|
31
|
+
/** render sample rate. Default 44100 */
|
|
32
|
+
sampleRate?: number;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Render params to mono Int16 PCM. Pure and platform-stable: only IEEE-754
|
|
36
|
+
* float math + the seeded RNG, quantized to Int16 last (the determinism
|
|
37
|
+
* boundary), so the same params yield byte-identical samples everywhere.
|
|
38
|
+
*/
|
|
39
|
+
declare function renderSfxr(params: SfxrParams): Int16Array;
|
|
40
|
+
/** Standard 44-byte mono 16-bit PCM WAV. Deterministic byte-for-byte. */
|
|
41
|
+
declare function encodeWavMono(samples: Int16Array, sampleRate?: number): Uint8Array;
|
|
42
|
+
type SfxPreset = 'click' | 'tap' | 'pop' | 'whoosh' | 'success' | 'error' | 'type' | 'select' | 'coin' | 'blip';
|
|
43
|
+
/** The ten built-in voices. Frozen so a render is a pure function of the id. */
|
|
44
|
+
declare const PRESETS: Readonly<Record<SfxPreset, Readonly<SfxrParams>>>;
|
|
45
|
+
/** Every preset id, in declaration order. */
|
|
46
|
+
declare const SFX_PRESETS: readonly SfxPreset[];
|
|
47
|
+
interface SfxVoiceRef {
|
|
48
|
+
id: string;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* A renderable bank of effect voices. `version()` feeds the prepare-step cache
|
|
52
|
+
* key (bump to invalidate committed WAVs); `render()` returns committable audio
|
|
53
|
+
* bytes for one voice. Bring your own (a different synth, a studio-rendered
|
|
54
|
+
* pack) by implementing these three members.
|
|
55
|
+
*/
|
|
56
|
+
interface SfxSource {
|
|
57
|
+
readonly id: string;
|
|
58
|
+
version(): string;
|
|
59
|
+
voices(): SfxVoiceRef[];
|
|
60
|
+
/** committable audio bytes (WAV) for one voice id */
|
|
61
|
+
render(voiceId: string): Uint8Array;
|
|
62
|
+
}
|
|
63
|
+
/** The clean-room procedural source over the ten built-in presets. */
|
|
64
|
+
declare function sfxrSource(opts?: {
|
|
65
|
+
sampleRate?: number;
|
|
66
|
+
}): SfxSource;
|
|
67
|
+
/** A sample pack: pre-rendered audio with MANDATORY license + provenance. */
|
|
68
|
+
interface SfxSamplePack {
|
|
69
|
+
id: string;
|
|
70
|
+
/** SPDX id or license name — REQUIRED so nothing unlicensed ships silently */
|
|
71
|
+
license: string;
|
|
72
|
+
/** where the samples came from — REQUIRED provenance */
|
|
73
|
+
source: string;
|
|
74
|
+
/** voice id → audio bytes (WAV) */
|
|
75
|
+
samples: Record<string, Uint8Array>;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* A source backed by committed sample files. License + source are mandatory and
|
|
79
|
+
* validated at construction (a hard throw, like validateMusicTiming) — the
|
|
80
|
+
* SuperDirt/lessac lesson: unlicensed audio must never ship by omission.
|
|
81
|
+
*/
|
|
82
|
+
declare function samplePackSource(pack: SfxSamplePack): SfxSource;
|
|
83
|
+
/** FNV-1a 32-bit — a stable, deterministic string hash for voice seeding. */
|
|
84
|
+
declare function hashStr(s: string): number;
|
|
85
|
+
/** The committed WAV filename for a (source, voice) pair — used by both the
|
|
86
|
+
* prepare step and the clip URLs, so they match by construction. */
|
|
87
|
+
declare function sfxFileName(sourceId: string, voiceId: string): string;
|
|
88
|
+
/**
|
|
89
|
+
* Render every referenced voice once (deduped) — the prepare step's output, a
|
|
90
|
+
* map of committed filename → WAV bytes.
|
|
91
|
+
*/
|
|
92
|
+
declare function renderSfxAssets(source: SfxSource, voiceIds: Iterable<string>): Record<string, Uint8Array>;
|
|
93
|
+
/** One placed effect: a voice at a timeline second, with an optional gain. */
|
|
94
|
+
interface SfxHit {
|
|
95
|
+
voice: string;
|
|
96
|
+
/** timeline seconds — e.g. beats.at('beat', 0.2) */
|
|
97
|
+
at: number;
|
|
98
|
+
/** per-hit linear gain; default 1 */
|
|
99
|
+
gain?: number;
|
|
100
|
+
}
|
|
101
|
+
interface SfxClipOptions {
|
|
102
|
+
/** base url prefixing each committed WAV; default '.' */
|
|
103
|
+
baseUrl?: string;
|
|
104
|
+
/** scene seed for the index-seeded variation; default 0 */
|
|
105
|
+
seed?: number;
|
|
106
|
+
/** ± playbackRate jitter fraction (0 = off); e.g. 0.06 = ±6% pitch */
|
|
107
|
+
jitterRate?: number;
|
|
108
|
+
/** ± gain jitter fraction (0 = off) */
|
|
109
|
+
jitterGain?: number;
|
|
110
|
+
/** overall gain applied on top of each hit's gain; default 1 */
|
|
111
|
+
gain?: number;
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* Place hits as AudioClips for the timeline's `audio` array — one clip per hit
|
|
115
|
+
* at `at`, referencing the committed WAV. Per-hit pitch/gain variation is
|
|
116
|
+
* INDEX-SEEDED from core's `random` (seed ^ hash(source/voice) ^ index), so it
|
|
117
|
+
* is a pure function of position: identical inputs → identical clip, and
|
|
118
|
+
* re-evaluation out of order never drifts. Mirrors buildNarrationClips.
|
|
119
|
+
*/
|
|
120
|
+
declare function buildSfxClips(hits: readonly SfxHit[], source: SfxSource, opts?: SfxClipOptions): AudioClip[];
|
|
121
|
+
//#endregion
|
|
122
|
+
export { PRESETS, SFX_PRESETS, SfxClipOptions, SfxError, SfxHit, SfxPreset, SfxSamplePack, SfxSource, SfxVoiceRef, SfxWaveform, SfxrParams, buildSfxClips, encodeWavMono, hashStr, renderSfxAssets, renderSfxr, samplePackSource, sfxFileName, sfxrSource };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,293 @@
|
|
|
1
|
+
import { random } from "@glissade/core";
|
|
2
|
+
//#region src/index.ts
|
|
3
|
+
/**
|
|
4
|
+
* @glissade/sfx — sound effects, the determinism-safe way. A clean-room
|
|
5
|
+
* procedural synth (sfxr-style: waveform + envelope + pitch slide + one-shot
|
|
6
|
+
* arpeggio) renders byte-identical Int16 WAVs from a fixed param set — no
|
|
7
|
+
* Math.random (the noise voice draws from core's seeded `random`), no
|
|
8
|
+
* third-party synth code, so bundled effects are unambiguously license-clean.
|
|
9
|
+
* Sample packs are supported too, but only with mandatory license + provenance.
|
|
10
|
+
*
|
|
11
|
+
* The render contract mirrors narration/music: effects are committed WAVs the
|
|
12
|
+
* offline FFmpeg mix consumes. `buildSfxClips` places one AudioClip per hit,
|
|
13
|
+
* with deterministic INDEX-SEEDED variation (pitch/gain) so repeated hits don't
|
|
14
|
+
* sound machine-gun identical while staying a pure function of (seed, voice,
|
|
15
|
+
* index) — re-evaluation never drifts.
|
|
16
|
+
*/
|
|
17
|
+
var SfxError = class extends Error {
|
|
18
|
+
constructor(message) {
|
|
19
|
+
super(message);
|
|
20
|
+
this.name = "SfxError";
|
|
21
|
+
}
|
|
22
|
+
};
|
|
23
|
+
const DEFAULT_SAMPLE_RATE = 44100;
|
|
24
|
+
const clamp = (v, lo, hi) => v < lo ? lo : v > hi ? hi : v;
|
|
25
|
+
/**
|
|
26
|
+
* Render params to mono Int16 PCM. Pure and platform-stable: only IEEE-754
|
|
27
|
+
* float math + the seeded RNG, quantized to Int16 last (the determinism
|
|
28
|
+
* boundary), so the same params yield byte-identical samples everywhere.
|
|
29
|
+
*/
|
|
30
|
+
function renderSfxr(params) {
|
|
31
|
+
const sr = params.sampleRate ?? DEFAULT_SAMPLE_RATE;
|
|
32
|
+
const attack = Math.max(0, params.attack);
|
|
33
|
+
const sustain = Math.max(0, params.sustain);
|
|
34
|
+
const decay = Math.max(0, params.decay);
|
|
35
|
+
const total = attack + sustain + decay;
|
|
36
|
+
const n = Math.max(1, Math.round(total * sr));
|
|
37
|
+
const out = new Int16Array(n);
|
|
38
|
+
const slide = params.slide ?? 0;
|
|
39
|
+
const duty = clamp(params.duty ?? .5, 0, 1);
|
|
40
|
+
const volume = clamp(params.volume ?? 1, 0, 1);
|
|
41
|
+
const noise = random((params.noiseSeed ?? 1831565813) >>> 0);
|
|
42
|
+
let phase = 0;
|
|
43
|
+
for (let i = 0; i < n; i++) {
|
|
44
|
+
const t = i / sr;
|
|
45
|
+
let base = params.startFreq;
|
|
46
|
+
if (params.arpTime !== void 0 && params.arpMul !== void 0 && t >= params.arpTime) base *= params.arpMul;
|
|
47
|
+
const freq = clamp(base + slide * t, 1, sr / 2);
|
|
48
|
+
phase += freq / sr;
|
|
49
|
+
phase -= Math.floor(phase);
|
|
50
|
+
let s;
|
|
51
|
+
switch (params.waveform) {
|
|
52
|
+
case "square":
|
|
53
|
+
s = phase < duty ? 1 : -1;
|
|
54
|
+
break;
|
|
55
|
+
case "saw":
|
|
56
|
+
s = 2 * phase - 1;
|
|
57
|
+
break;
|
|
58
|
+
case "sine":
|
|
59
|
+
s = Math.sin(2 * Math.PI * phase);
|
|
60
|
+
break;
|
|
61
|
+
case "noise":
|
|
62
|
+
s = noise() * 2 - 1;
|
|
63
|
+
break;
|
|
64
|
+
}
|
|
65
|
+
let amp;
|
|
66
|
+
if (t < attack) amp = attack > 0 ? t / attack : 1;
|
|
67
|
+
else if (t < attack + sustain) amp = 1;
|
|
68
|
+
else amp = decay > 0 ? 1 - (t - attack - sustain) / decay : 0;
|
|
69
|
+
amp = clamp(amp, 0, 1);
|
|
70
|
+
const v = s * amp * volume;
|
|
71
|
+
out[i] = clamp(Math.round(v * 32767), -32768, 32767);
|
|
72
|
+
}
|
|
73
|
+
return out;
|
|
74
|
+
}
|
|
75
|
+
/** Standard 44-byte mono 16-bit PCM WAV. Deterministic byte-for-byte. */
|
|
76
|
+
function encodeWavMono(samples, sampleRate = DEFAULT_SAMPLE_RATE) {
|
|
77
|
+
const dataLen = samples.length * 2;
|
|
78
|
+
const buf = new ArrayBuffer(44 + dataLen);
|
|
79
|
+
const dv = new DataView(buf);
|
|
80
|
+
const str = (off, s) => {
|
|
81
|
+
for (let i = 0; i < s.length; i++) dv.setUint8(off + i, s.charCodeAt(i));
|
|
82
|
+
};
|
|
83
|
+
str(0, "RIFF");
|
|
84
|
+
dv.setUint32(4, 36 + dataLen, true);
|
|
85
|
+
str(8, "WAVE");
|
|
86
|
+
str(12, "fmt ");
|
|
87
|
+
dv.setUint32(16, 16, true);
|
|
88
|
+
dv.setUint16(20, 1, true);
|
|
89
|
+
dv.setUint16(22, 1, true);
|
|
90
|
+
dv.setUint32(24, sampleRate, true);
|
|
91
|
+
dv.setUint32(28, sampleRate * 2, true);
|
|
92
|
+
dv.setUint16(32, 2, true);
|
|
93
|
+
dv.setUint16(34, 16, true);
|
|
94
|
+
str(36, "data");
|
|
95
|
+
dv.setUint32(40, dataLen, true);
|
|
96
|
+
for (let i = 0; i < samples.length; i++) dv.setInt16(44 + i * 2, samples[i], true);
|
|
97
|
+
return new Uint8Array(buf);
|
|
98
|
+
}
|
|
99
|
+
/** The ten built-in voices. Frozen so a render is a pure function of the id. */
|
|
100
|
+
const PRESETS = Object.freeze({
|
|
101
|
+
click: {
|
|
102
|
+
waveform: "square",
|
|
103
|
+
attack: .001,
|
|
104
|
+
sustain: .004,
|
|
105
|
+
decay: .03,
|
|
106
|
+
startFreq: 1e3,
|
|
107
|
+
slide: -1600,
|
|
108
|
+
duty: .5,
|
|
109
|
+
volume: .7
|
|
110
|
+
},
|
|
111
|
+
tap: {
|
|
112
|
+
waveform: "sine",
|
|
113
|
+
attack: .001,
|
|
114
|
+
sustain: .004,
|
|
115
|
+
decay: .05,
|
|
116
|
+
startFreq: 560,
|
|
117
|
+
slide: -700,
|
|
118
|
+
volume: .6
|
|
119
|
+
},
|
|
120
|
+
pop: {
|
|
121
|
+
waveform: "sine",
|
|
122
|
+
attack: .001,
|
|
123
|
+
sustain: .002,
|
|
124
|
+
decay: .06,
|
|
125
|
+
startFreq: 420,
|
|
126
|
+
slide: 2600,
|
|
127
|
+
volume: .7
|
|
128
|
+
},
|
|
129
|
+
whoosh: {
|
|
130
|
+
waveform: "noise",
|
|
131
|
+
attack: .04,
|
|
132
|
+
sustain: .02,
|
|
133
|
+
decay: .26,
|
|
134
|
+
startFreq: 1,
|
|
135
|
+
volume: .45
|
|
136
|
+
},
|
|
137
|
+
success: {
|
|
138
|
+
waveform: "square",
|
|
139
|
+
attack: .002,
|
|
140
|
+
sustain: .05,
|
|
141
|
+
decay: .18,
|
|
142
|
+
startFreq: 660,
|
|
143
|
+
arpMul: 1.5,
|
|
144
|
+
arpTime: .09,
|
|
145
|
+
duty: .5,
|
|
146
|
+
volume: .55
|
|
147
|
+
},
|
|
148
|
+
error: {
|
|
149
|
+
waveform: "saw",
|
|
150
|
+
attack: .004,
|
|
151
|
+
sustain: .06,
|
|
152
|
+
decay: .22,
|
|
153
|
+
startFreq: 320,
|
|
154
|
+
slide: -260,
|
|
155
|
+
volume: .5
|
|
156
|
+
},
|
|
157
|
+
type: {
|
|
158
|
+
waveform: "square",
|
|
159
|
+
attack: 5e-4,
|
|
160
|
+
sustain: .003,
|
|
161
|
+
decay: .018,
|
|
162
|
+
startFreq: 1200,
|
|
163
|
+
slide: -900,
|
|
164
|
+
duty: .4,
|
|
165
|
+
volume: .5
|
|
166
|
+
},
|
|
167
|
+
select: {
|
|
168
|
+
waveform: "sine",
|
|
169
|
+
attack: .001,
|
|
170
|
+
sustain: .01,
|
|
171
|
+
decay: .05,
|
|
172
|
+
startFreq: 760,
|
|
173
|
+
slide: 900,
|
|
174
|
+
volume: .6
|
|
175
|
+
},
|
|
176
|
+
coin: {
|
|
177
|
+
waveform: "square",
|
|
178
|
+
attack: .001,
|
|
179
|
+
sustain: .02,
|
|
180
|
+
decay: .16,
|
|
181
|
+
startFreq: 900,
|
|
182
|
+
arpMul: 1.6,
|
|
183
|
+
arpTime: .045,
|
|
184
|
+
duty: .5,
|
|
185
|
+
volume: .55
|
|
186
|
+
},
|
|
187
|
+
blip: {
|
|
188
|
+
waveform: "square",
|
|
189
|
+
attack: .001,
|
|
190
|
+
sustain: .012,
|
|
191
|
+
decay: .05,
|
|
192
|
+
startFreq: 880,
|
|
193
|
+
duty: .5,
|
|
194
|
+
volume: .6
|
|
195
|
+
}
|
|
196
|
+
});
|
|
197
|
+
/** Every preset id, in declaration order. */
|
|
198
|
+
const SFX_PRESETS = Object.freeze(Object.keys(PRESETS));
|
|
199
|
+
/** The clean-room procedural source over the ten built-in presets. */
|
|
200
|
+
function sfxrSource(opts = {}) {
|
|
201
|
+
const sr = opts.sampleRate ?? DEFAULT_SAMPLE_RATE;
|
|
202
|
+
return {
|
|
203
|
+
id: "sfxr",
|
|
204
|
+
version: () => `sfxr-1/${sr}`,
|
|
205
|
+
voices: () => SFX_PRESETS.map((id) => ({ id })),
|
|
206
|
+
render: (voiceId) => {
|
|
207
|
+
const preset = PRESETS[voiceId];
|
|
208
|
+
if (!preset) throw new SfxError(`unknown sfx preset '${voiceId}' (have: ${SFX_PRESETS.join(", ")})`);
|
|
209
|
+
return encodeWavMono(renderSfxr({
|
|
210
|
+
...preset,
|
|
211
|
+
sampleRate: sr
|
|
212
|
+
}), sr);
|
|
213
|
+
}
|
|
214
|
+
};
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* A source backed by committed sample files. License + source are mandatory and
|
|
218
|
+
* validated at construction (a hard throw, like validateMusicTiming) — the
|
|
219
|
+
* SuperDirt/lessac lesson: unlicensed audio must never ship by omission.
|
|
220
|
+
*/
|
|
221
|
+
function samplePackSource(pack) {
|
|
222
|
+
if (!pack.license) throw new SfxError(`sfx sample pack '${pack.id}' is missing a license (required)`);
|
|
223
|
+
if (!pack.source) throw new SfxError(`sfx sample pack '${pack.id}' is missing a source/provenance (required)`);
|
|
224
|
+
return {
|
|
225
|
+
id: `pack-${pack.id}`,
|
|
226
|
+
version: () => `${pack.id}@${pack.license}`,
|
|
227
|
+
voices: () => Object.keys(pack.samples).map((id) => ({ id })),
|
|
228
|
+
render: (voiceId) => {
|
|
229
|
+
const data = pack.samples[voiceId];
|
|
230
|
+
if (!data) throw new SfxError(`sfx sample pack '${pack.id}' has no sample '${voiceId}'`);
|
|
231
|
+
return data;
|
|
232
|
+
}
|
|
233
|
+
};
|
|
234
|
+
}
|
|
235
|
+
/** FNV-1a 32-bit — a stable, deterministic string hash for voice seeding. */
|
|
236
|
+
function hashStr(s) {
|
|
237
|
+
let h = 2166136261;
|
|
238
|
+
for (let i = 0; i < s.length; i++) {
|
|
239
|
+
h ^= s.charCodeAt(i);
|
|
240
|
+
h = Math.imul(h, 16777619);
|
|
241
|
+
}
|
|
242
|
+
return h >>> 0;
|
|
243
|
+
}
|
|
244
|
+
/** The committed WAV filename for a (source, voice) pair — used by both the
|
|
245
|
+
* prepare step and the clip URLs, so they match by construction. */
|
|
246
|
+
function sfxFileName(sourceId, voiceId) {
|
|
247
|
+
const safe = (s) => s.replace(/[^a-zA-Z0-9_-]/g, "-");
|
|
248
|
+
return `${safe(sourceId)}-${safe(voiceId)}.wav`;
|
|
249
|
+
}
|
|
250
|
+
/**
|
|
251
|
+
* Render every referenced voice once (deduped) — the prepare step's output, a
|
|
252
|
+
* map of committed filename → WAV bytes.
|
|
253
|
+
*/
|
|
254
|
+
function renderSfxAssets(source, voiceIds) {
|
|
255
|
+
const out = {};
|
|
256
|
+
for (const v of new Set(voiceIds)) out[sfxFileName(source.id, v)] = source.render(v);
|
|
257
|
+
return out;
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* Place hits as AudioClips for the timeline's `audio` array — one clip per hit
|
|
261
|
+
* at `at`, referencing the committed WAV. Per-hit pitch/gain variation is
|
|
262
|
+
* INDEX-SEEDED from core's `random` (seed ^ hash(source/voice) ^ index), so it
|
|
263
|
+
* is a pure function of position: identical inputs → identical clip, and
|
|
264
|
+
* re-evaluation out of order never drifts. Mirrors buildNarrationClips.
|
|
265
|
+
*/
|
|
266
|
+
function buildSfxClips(hits, source, opts = {}) {
|
|
267
|
+
const baseUrl = opts.baseUrl ?? ".";
|
|
268
|
+
const seed = opts.seed ?? 0;
|
|
269
|
+
const jitterRate = opts.jitterRate ?? 0;
|
|
270
|
+
const jitterGain = opts.jitterGain ?? 0;
|
|
271
|
+
const masterGain = opts.gain ?? 1;
|
|
272
|
+
return hits.map((hit, index) => {
|
|
273
|
+
const rng = random((seed ^ hashStr(`${source.id}/${hit.voice}`) ^ Math.imul(index + 1, 2654435769)) >>> 0);
|
|
274
|
+
const rate = 1 + (rng() * 2 - 1) * jitterRate;
|
|
275
|
+
const gainScale = 1 + (rng() * 2 - 1) * jitterGain;
|
|
276
|
+
const gain = (hit.gain ?? 1) * masterGain * gainScale;
|
|
277
|
+
const clip = {
|
|
278
|
+
asset: {
|
|
279
|
+
kind: "audio",
|
|
280
|
+
url: `${baseUrl}/${sfxFileName(source.id, hit.voice)}`
|
|
281
|
+
},
|
|
282
|
+
at: hit.at
|
|
283
|
+
};
|
|
284
|
+
if (jitterRate !== 0) clip.playbackRate = rate;
|
|
285
|
+
if (gain !== 1) clip.gain = { keys: [{
|
|
286
|
+
t: 0,
|
|
287
|
+
value: gain
|
|
288
|
+
}] };
|
|
289
|
+
return clip;
|
|
290
|
+
});
|
|
291
|
+
}
|
|
292
|
+
//#endregion
|
|
293
|
+
export { PRESETS, SFX_PRESETS, SfxError, buildSfxClips, encodeWavMono, hashStr, renderSfxAssets, renderSfxr, samplePackSource, sfxFileName, sfxrSource };
|
package/package.json
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@glissade/sfx",
|
|
3
|
+
"version": "0.5.0-pre.2",
|
|
4
|
+
"description": "glissade sound effects: a clean-room procedural (sfxr-style) synth, license-checked sample packs, and deterministic index-seeded variation — committed WAVs feed the same offline FFmpeg mix as narration and music.",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"sideEffects": false,
|
|
8
|
+
"exports": {
|
|
9
|
+
".": {
|
|
10
|
+
"types": "./dist/index.d.ts",
|
|
11
|
+
"default": "./dist/index.js"
|
|
12
|
+
}
|
|
13
|
+
},
|
|
14
|
+
"files": [
|
|
15
|
+
"dist"
|
|
16
|
+
],
|
|
17
|
+
"dependencies": {
|
|
18
|
+
"@glissade/core": "0.5.0-pre.2"
|
|
19
|
+
},
|
|
20
|
+
"repository": {
|
|
21
|
+
"type": "git",
|
|
22
|
+
"url": "git+https://github.com/tyevco/glissade.git",
|
|
23
|
+
"directory": "packages/sfx"
|
|
24
|
+
},
|
|
25
|
+
"scripts": {
|
|
26
|
+
"build": "tsdown",
|
|
27
|
+
"typecheck": "tsc --noEmit"
|
|
28
|
+
}
|
|
29
|
+
}
|