Skip to content

Commit 31fa523

Browse files
vanceingallsclaude
andauthored
feat: offer the job, not the machine — the range IS the module (#3185)
* fix(studio): close the typecheck and fallow gaps wa-18b-reschedule opened useAutomationLanes.ts's write() assumed gesture-scoped coalescing and a preview-only commit that useDomEditAttributeCommits.ts never grew — backported that option support from its own later commit so the two sides of the API agree. The paste path and its tests were missing the box selection's v0/v1 bounds a sibling commit added to AutomationSelection. The FX panel's carve controls still edited the six mechanism numbers (maxCutDb, bands, intelligibilityBias) after carveProfile() collapsed authoring to one Strength knob, so those fields no longer existed on HfCarveSettings; UI now edits strength, and analyseCarveBands is called with carveProfile(strength). Also closes fallow's complexity, dead-code and duplication findings on this PR's diff: extracted automationLaneDragMath.ts (pure group/point-move math) and useAutomationRangeDrag.ts (the marquee-select gesture) out of useAutomationLaneGestures.ts, pulled a couple of render-loop ternaries and a resolver into named functions, dropped an export nothing outside its file used, and shared a step-simplifier between audioCarve's two envelope builders. The edge-stretch vs. box-select priority test in TimelineAutomationLane.test was still pinning the pre-box-select rule (edge wins over a point sitting on it) that a sibling commit deliberately reversed — a point inside the box is now selected content, so grabbing it drags the group instead. Updated the test to the shipped rule instead of the old one. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * fix(core): cap the via conic's weight so an edge-clamped via point can't NaN A via point pulled out past the segment (viaX: 5, viaY: -3) clamps to (0.999, 0.001) — exactly on the steady region's edge, where edge - viaX is 0. viaConic divided by that zero to get an infinite weight, and shapeVia turned Infinity into NaN a few steps later (Infinity - Infinity in the quadratic coefficient). NaN reaching setValueCurveAtTime silences the automated parameter for the rest of the render. Capped the weight at 1e6 instead of leaving it unbounded — past that point the arc already reads as touching the via point, so nothing visible is lost. Also hardened shapeVia's existing denominator guard (`<= 0`) to `!(> 0)`, since NaN fails the original comparison and fell through it. Review by Miga (PR #3208). * fix(studio-server): fingerprint the proactive waveform cache key too The route already keys the waveform cache on the asset's size and mtime as well as its path, so a rebuilt-in-place file gets fresh peaks instead of stale ones. generateWaveformCache — the proactive path that runs on upload — still called buildWaveformCacheKey with the path alone, so it wrote to a different key than the route reads from (making the pre-generated cache never found) and kept the exact collision bug this fingerprint exists to fix on its own path. Review by Miga (PR #3211). * style(docs): run oxfmt on the /hyperframes-audio skill docs Table column widths had drifted out of alignment with oxfmt's own rules, failing format:check and blocking the Preflight gate every downstream branch inherits. Whitespace only, no content change. * fix(core): stop \b from missing underscore-separated names, guard clipsOverlap's negative duration \b treats `_` as a word character, so \bbed\b never matched bed_01, music_bed_loop, or theme_song, and \bvo\b/\bvox\b/\btts\b had the same gap — an underscore-separated bed classified as "unknown" and could end up offered as its own carve source. Replaced the short hints with a boundary that actually excludes letters and digits on both sides. clipsOverlap computed end = start + duration without guarding sign, so a negative duration put end before start — an interval that does not describe anything, and one specific case showed it silently dropping a real overlap (a shorter, earlier broken end rejected a clip that genuinely contained the point). Duration clamps to zero instead: a clip cannot un-play time, and a zero-length clip at its start is the sane reading of "duration nobody wrote down as positive." Review by Miga (PR #3212). * fix(studio): widen PropertyPanel's resetModules render timeout again The 20s margin (already once widened for the same reason) is timing out in CI's full-monorepo Test run — the resetModules()+fresh-import render this test needs is uncached and competes with every other package's test suite for the same worker pool, and the same test passes in well under 2s standalone. Went to 45s rather than re-tuning to whatever number happens to clear the current CI load, since that number moves every time CI gains a package. * fix(studio): stop the single-candidate auto-apply carve firing twice Two auto-apply effects both fire when sourceOptions.length === 1: the multi-candidate effect only guards length === 0, so a single candidate passes it too, and the single-candidate effect passes its own guard right after — both compute the same sources list and both call setCarve, so the common case (one narrator, one bed) triggered two decodes, two FFT runs, and two concurrent attribute writes for one decision. The multi-candidate effect now defers to its sibling for exactly one candidate, which already has its own detailed handling for that case. Review by Miga (PR #3213). * feat(core): carve against every voice over a bed, always (#3212) * feat(core): carve against every voice over a bed, always dynamically A bed usually runs under a whole sequence — a narrator, an interview answer, a second presenter — and carving against one of them left the others fighting it. `source` becomes `sources`, and `mixCarveSources` sums every voice onto the BED's clock before anything is measured. That is what keeps one analysis sufficient: the chain is fixed, so there is no per-voice filter to switch between, and bands drawn from all the speech there is with envelopes that rise wherever any of it happens answer the actual question — where and when is speech masking this bed. Summed rather than averaged: two people talking at once mask more than either alone. Audio before the bed starts is dropped rather than folded in at zero, since it plays over nothing and shifting it would put a cut where there is no voice. `dynamic` is gone. A fixed depth thins the bed through every pause, and once both have been heard there is no reason to want it, so every carve follows the speech. Two helpers the panel and the headless script now share instead of each carrying a copy — two definitions of "what does this name suggest" drift, and then the two disagree about which track is the voice: - `classifyAudioName` reads a track's kind from its id and filename together. `unknown` is deliberately common: treating an unrecognised name as "not a voice" would hide the one track somebody needs to pick. - `clipsOverlap` keeps out a voice that never plays while the bed does. An unwritten duration counts as unbounded, not zero — refusing a clip whose length the composition leaves to the media would drop the commonest case there is. Files written before this still load: a single `source` reads as a one-voice list, a stored `dynamic` is ignored, and an absent attribute means the defaults whole. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * fix(core): stop \b from missing underscore-separated names, guard clipsOverlap's negative duration \b treats `_` as a word character, so \bbed\b never matched bed_01, music_bed_loop, or theme_song, and \bvo\b/\bvox\b/\btts\b had the same gap — an underscore-separated bed classified as "unknown" and could end up offered as its own carve source. Replaced the short hints with a boundary that actually excludes letters and digits on both sides. clipsOverlap computed end = start + duration without guarding sign, so a negative duration put end before start — an interval that does not describe anything, and one specific case showed it silently dropping a real overlap (a shorter, earlier broken end rejected a clip that genuinely contained the point). Duration clamps to zero instead: a clip cannot un-play time, and a zero-length clip at its start is the sane reading of "duration nobody wrote down as positive." Review by Miga (PR #3212). --------- Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com> * fix(studio): port the carve UI off the removed source/dynamic fields #3212 (accidentally squash-merged into this branch instead of main) changed HfCarveSettings from a single `source` + `dynamic` toggle to a `sources` list with dynamic mode removed outright — the multi-voice UI consumer that goes with that shape lands in the very next PR, so this branch was left with a type that no longer matched its own code. Minimal port, not the multi-voice redesign that PR does properly: the "Listen to" picker and analyse() treat sources[0] as the one voice this UI still understands, and every dynamic-mode branch (the automated envelope lanes, the toggle, the checkbox) is gone along with the field — a carve is now always the static value the analysis computes, matching what the type change made permanent. Test suite trimmed the same way: the automation-lane and toggle tests covered behavior that no longer exists. --------- Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent 0e4da52 commit 31fa523

7 files changed

Lines changed: 327 additions & 10 deletions

File tree

packages/core/package-subpaths.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,12 @@
104104
"types": "./dist/audioFxCopy.d.ts",
105105
"environments": ["browser", "bun", "node"]
106106
},
107+
"./audio-fx-jobs": {
108+
"source": "./src/audioFxJobs.ts",
109+
"runtime": "./dist/audioFxJobs.js",
110+
"types": "./dist/audioFxJobs.d.ts",
111+
"environments": ["browser", "bun", "node"]
112+
},
107113
"./audio-fx-eq": {
108114
"source": "./src/audioFxEq.ts",
109115
"runtime": "./dist/audioFxEq.js",

packages/core/package.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,12 @@
118118
"import": "./src/audioFxCopy.ts",
119119
"types": "./src/audioFxCopy.ts"
120120
},
121+
"./audio-fx-jobs": {
122+
"bun": "./src/audioFxJobs.ts",
123+
"node": "./dist/audioFxJobs.js",
124+
"import": "./src/audioFxJobs.ts",
125+
"types": "./src/audioFxJobs.ts"
126+
},
121127
"./audio-fx-eq": {
122128
"bun": "./src/audioFxEq.ts",
123129
"node": "./dist/audioFxEq.js",
@@ -430,6 +436,10 @@
430436
"import": "./dist/audioFxCopy.js",
431437
"types": "./dist/audioFxCopy.d.ts"
432438
},
439+
"./audio-fx-jobs": {
440+
"import": "./dist/audioFxJobs.js",
441+
"types": "./dist/audioFxJobs.d.ts"
442+
},
433443
"./audio-fx-eq": {
434444
"import": "./dist/audioFxEq.js",
435445
"types": "./dist/audioFxEq.d.ts"
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
import { describe, expect, it } from "vitest";
2+
import { getAudioFxDef } from "./audioFx.js";
3+
import { HF_AUDIO_FX_PRESETS } from "./audioFxPresets.js";
4+
import { audioFxJobNode, getAudioFxJob, HF_AUDIO_FX_JOBS } from "./audioFxJobs.js";
5+
6+
const EMPTY = { version: 1 as const, nodes: [] };
7+
8+
describe("named jobs", () => {
9+
it("makes an ordinary effect node, named for the work", () => {
10+
const job = getAudioFxJob("reduce-mud");
11+
if (!job) throw new Error("no such job");
12+
const node = audioFxJobNode(job, EMPTY);
13+
// Ordinary underneath: the author can open it and find the filter they could
14+
// have added by hand, at the frequency the job picked for them.
15+
expect(node.type).toBe("peaking");
16+
expect(node.params?.frequency).toBe(250);
17+
expect(node.label).toBe("Reduce Mud");
18+
expect(node.enabled).toBe(true);
19+
expect(node.id).toBeTruthy();
20+
});
21+
22+
it("gives every job a value for every parameter its effect declares", () => {
23+
// A job names a range and leaves the rest alone, so the omitted parameters
24+
// have to come from the registry — a node missing `q` renders at whatever
25+
// the graph builder falls back to rather than what the panel shows.
26+
for (const job of HF_AUDIO_FX_JOBS) {
27+
const def = getAudioFxDef(job.type);
28+
expect(def, `${job.id} names an effect that does not exist`).toBeDefined();
29+
const node = audioFxJobNode(job, EMPTY);
30+
for (const param of def?.params ?? []) {
31+
expect(node.params?.[param.key], `${job.id} has no ${param.key}`).toBeDefined();
32+
}
33+
}
34+
});
35+
36+
it("mints an id that does not collide with what is already there", () => {
37+
const job = getAudioFxJob("add-clarity");
38+
if (!job) throw new Error("no such job");
39+
const first = audioFxJobNode(job, EMPTY);
40+
const second = audioFxJobNode(job, { version: 1, nodes: [first] });
41+
// Two of the same job is a real thing to want, and a shared id would give
42+
// them each other's automation lanes.
43+
expect(second.id).not.toBe(first.id);
44+
});
45+
46+
it("names jobs the preset catalogue already ships", () => {
47+
// The point of the list is to name the vocabulary the presets were written
48+
// in, not to invent a second one beside it. A job nobody's preset uses is a
49+
// guess about what authors want; one a preset uses has already been chosen.
50+
const shipped = new Set(
51+
HF_AUDIO_FX_PRESETS.flatMap((preset) => preset.nodes.map((node) => node.label)),
52+
);
53+
for (const job of HF_AUDIO_FX_JOBS) {
54+
expect(shipped, `${job.label} is not a job any preset does`).toContain(job.label);
55+
}
56+
});
57+
58+
it("has an id for every job and no duplicates", () => {
59+
const ids = HF_AUDIO_FX_JOBS.map((job) => job.id);
60+
expect(new Set(ids).size).toBe(ids.length);
61+
for (const id of ids) expect(getAudioFxJob(id)?.id).toBe(id);
62+
});
63+
});

packages/core/src/audioFxJobs.ts

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
/**
2+
* Named jobs: the range IS the module.
3+
*
4+
* "Shape One Range" has three controls — where, how much, how wide — and no
5+
* honest way to nominate one of them as the knob that matters. Nominating *how
6+
* much* is incoherent, because boosting an unspecified frequency means nothing:
7+
* the range is the first decision, not the second.
8+
*
9+
* So the menu offers the decision instead of the machine. Each job is a peaking
10+
* filter with its frequency already chosen — Reduce Mud, Add Clarity, Soften
11+
* Harshness — and picking the module IS picking the range, which makes one knob
12+
* honest rather than a simplification hiding the real choice. It also dissolves
13+
* the duplicate-name problem at the root: a preset that cuts mud and then lifts
14+
* clarity used to read "Shape One Range" twice with nothing to tell them apart.
15+
*
16+
* Every job here is one the preset catalogue already ships, at the settings it
17+
* ships them with, so this names the vocabulary the presets were written in
18+
* rather than inventing a second one. Reasoning in
19+
* `plans/audio-fx-ux/README.md` §"The hole in the single-knob rule".
20+
*
21+
* The frequency is a starting point, not a cage — it is an ordinary peaking node
22+
* underneath, and Details opens on the same three controls it always had.
23+
*/
24+
25+
import {
26+
defaultAudioFxParams,
27+
mintAudioFxNodeId,
28+
normalizeAudioFxParams,
29+
type HfAudioFxChain,
30+
type HfAudioFxNode,
31+
type HfAudioFxParamValues,
32+
} from "./audioFx.js";
33+
34+
export interface HfAudioFxJob {
35+
id: string;
36+
/** What the rack calls the node this makes. */
37+
label: string;
38+
/** The complaint that leads here, in the author's words. */
39+
does: string;
40+
/** The registry effect underneath. */
41+
type: string;
42+
/** Where it acts, and how hard — the decision the author is spared. */
43+
params: HfAudioFxParamValues;
44+
}
45+
46+
/**
47+
* Ordered low to high, which is the order an author hears them in: weight and
48+
* mud at the bottom, clarity and harshness at the top.
49+
*/
50+
export const HF_AUDIO_FX_JOBS: readonly HfAudioFxJob[] = [
51+
{
52+
id: "tame-boominess",
53+
label: "Tame Boominess",
54+
does: "Too much chest — it booms.",
55+
type: "peaking",
56+
params: { frequency: 200, gain: -4, q: 1.4 },
57+
},
58+
{
59+
id: "reduce-mud",
60+
label: "Reduce Mud",
61+
does: "Muffled, like it is behind cardboard.",
62+
type: "peaking",
63+
params: { frequency: 250, gain: -3, q: 1.2 },
64+
},
65+
{
66+
id: "reduce-boxiness",
67+
label: "Reduce Boxiness",
68+
does: "Sounds like a small room, or a box.",
69+
type: "peaking",
70+
params: { frequency: 400, gain: -3, q: 1.4 },
71+
},
72+
{
73+
id: "add-clarity",
74+
label: "Add Clarity",
75+
does: "Words are hard to make out.",
76+
type: "peaking",
77+
params: { frequency: 3000, gain: 2.5, q: 1 },
78+
},
79+
{
80+
id: "soften-harshness",
81+
label: "Soften Harshness",
82+
does: "Harsh and tiring to listen to.",
83+
type: "peaking",
84+
params: { frequency: 3200, gain: -3, q: 1.6 },
85+
},
86+
];
87+
88+
export function getAudioFxJob(id: string): HfAudioFxJob | undefined {
89+
return HF_AUDIO_FX_JOBS.find((job) => job.id === id);
90+
}
91+
92+
/** Effect ids the job list covers, which the add menu offers as jobs instead. */
93+
export const HF_AUDIO_FX_JOB_TYPES: ReadonlySet<string> = new Set(
94+
HF_AUDIO_FX_JOBS.map((job) => job.type),
95+
);
96+
97+
/**
98+
* The node a job adds: an ordinary effect carrying the job's name.
99+
*
100+
* `label` is the field a preset already uses to name a node for the work it
101+
* does, so a job needs nothing new — and a job node and a preset node are
102+
* indistinguishable afterwards, which is right. They are the same idea.
103+
*/
104+
export function audioFxJobNode(job: HfAudioFxJob, chain: HfAudioFxChain): HfAudioFxNode {
105+
return {
106+
type: job.type,
107+
id: mintAudioFxNodeId(chain),
108+
enabled: true,
109+
label: job.label,
110+
// Through the registry, so a job cannot ship a value the effect would clamp
111+
// or a key it does not have.
112+
params: normalizeAudioFxParams(job.type, {
113+
...defaultAudioFxParams(job.type),
114+
...job.params,
115+
}),
116+
};
117+
}

packages/studio/src/components/editor/propertyPanelAudioFxGroup.test.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,9 @@ describe("AudioFxGroup dynamic carve", () => {
456456
act(() => byTextButton(host, "Even Out Levels")?.focus());
457457
// Straight to a neighbour, without ever leaving the shelf.
458458
act(() =>
459-
byTextButton(host, "Reverb")?.dispatchEvent(new MouseEvent("mouseover", { bubbles: true })),
459+
byTextButton(host, EFFECT_COPY.reverb?.title ?? "")?.dispatchEvent(
460+
new MouseEvent("mouseover", { bubbles: true }),
461+
),
460462
);
461463
await settleDecode(release, decoded);
462464

packages/studio/src/components/editor/propertyPanelFxSection.test.tsx

Lines changed: 57 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import {
99
} from "@hyperframes/core/audio-fx";
1010
import { DEFAULT_CARVE } from "@hyperframes/core/audio-carve";
1111
import { EFFECT_COPY, PRESET_PROBLEM } from "@hyperframes/core/audio-fx-copy";
12+
import { HF_AUDIO_FX_JOBS, HF_AUDIO_FX_JOB_TYPES } from "@hyperframes/core/audio-fx-jobs";
1213
import { getAudioFxPreset } from "@hyperframes/core/audio-fx-presets";
1314

1415
/**
@@ -152,14 +153,65 @@ describe("FxSection chain", () => {
152153
// change to the panel.
153154
const { host } = mount();
154155
const items = openAddMenuItems(host);
155-
expect(items).toHaveLength(HF_AUDIO_FX.length);
156-
for (const def of HF_AUDIO_FX) expect(items).toContain(def.label);
156+
// Every effect is reachable, but not every one under its own name: the jobs
157+
// stand in for the effect they are made of, because picking `peaking` is
158+
// picking a machine and leaving the real decision for afterwards.
159+
const standIns = HF_AUDIO_FX.filter((d) => HF_AUDIO_FX_JOB_TYPES.has(d.id));
160+
expect(items).toHaveLength(HF_AUDIO_FX.length - standIns.length + HF_AUDIO_FX_JOBS.length);
161+
for (const def of HF_AUDIO_FX) {
162+
if (HF_AUDIO_FX_JOB_TYPES.has(def.id)) {
163+
// Not offered as itself, and it must not be — two doors to the same
164+
// effect, one of them the incoherent one, is worse than either alone.
165+
expect(items).not.toContain(EFFECT_COPY[def.id]?.title);
166+
continue;
167+
}
168+
// By the name the RACK will use, not the registry's — picking "High-pass"
169+
// and getting a module called "Remove Rumble" is the inconsistency this
170+
// whole layer exists to remove.
171+
expect(items).toContain(EFFECT_COPY[def.id]?.title);
172+
}
173+
for (const job of HF_AUDIO_FX_JOBS) expect(items).toContain(job.label);
174+
});
175+
176+
it("adds a job as an ordinary effect, already named and already aimed", () => {
177+
// The range IS the module: one knob is honest here because the decision the
178+
// knob depends on has already been made.
179+
const { host, onChainChange } = mount({ chain: { version: 1, nodes: [] } });
180+
click(host.querySelector(".hf-fx-add"));
181+
click(byText(host, ".hf-fx-add-item", "Reduce Mud"));
182+
183+
const next = onChainChange.mock.calls[0]?.[0] as HfAudioFxChain;
184+
expect(next.nodes).toHaveLength(1);
185+
expect(next.nodes[0]?.type).toBe("peaking");
186+
expect(next.nodes[0]?.label).toBe("Reduce Mud");
187+
expect(next.nodes[0]?.params?.frequency).toBe(250);
188+
});
189+
190+
it("shows two jobs over the same effect as the different things they are", () => {
191+
// The whole point. Read down the rack, "Shape One Range" twice was two rows
192+
// an author could not tell apart — and one of them was cutting while the
193+
// other was boosting.
194+
const { host } = mount({
195+
chain: {
196+
version: 1,
197+
nodes: [
198+
{ type: "peaking", label: "Reduce Mud", params: { frequency: 250, gain: -3, q: 1.2 } },
199+
{ type: "peaking", label: "Add Clarity", params: { frequency: 3000, gain: 2.5, q: 1 } },
200+
],
201+
} as unknown as HfAudioFxChain,
202+
});
203+
const names = Array.from(host.querySelectorAll(".hf-fx-node-name")).map((e) =>
204+
e.textContent?.trim(),
205+
);
206+
expect(names).toContain("Reduce Mud");
207+
expect(names).toContain("Add Clarity");
208+
expect(names).not.toContain(EFFECT_COPY.peaking?.title);
157209
});
158210

159211
it("adds an effect seeded with its declared defaults", () => {
160212
const { host, onChainChange } = mount();
161213
click(host.querySelector(".hf-fx-add"));
162-
click(byText(host, ".hf-fx-add-item", "Compressor"));
214+
click(byText(host, ".hf-fx-add-item", EFFECT_COPY.compressor?.title ?? ""));
163215
expect(onChainChange).toHaveBeenCalledTimes(1);
164216
const next = onChainChange.mock.calls[0]![0] as HfAudioFxChain;
165217
expect(next.nodes).toHaveLength(1);
@@ -393,7 +445,7 @@ describe("FxSection chain", () => {
393445
it("auditions an effect the add menu is offering", () => {
394446
const { host, onChainPreview, onChainChange } = mount({ chain: chainOf("peaking") });
395447
click(byText(host, "button", "Add effect"));
396-
enter(byText(host, "button", "Reverb"));
448+
enter(byText(host, "button", EFFECT_COPY.reverb?.title ?? ""));
397449

398450
const heard = onChainPreview.mock.calls.at(-1)?.[0] as HfAudioFxChain;
399451
expect(heard.nodes.map((n) => n.type)).toEqual(["peaking", "reverb"]);
@@ -1045,7 +1097,7 @@ describe("automation in the panel", () => {
10451097
const add = host.querySelector(".hf-fx-add") as HTMLButtonElement;
10461098
act(() => add.click());
10471099
const item = Array.from(host.querySelectorAll<HTMLButtonElement>(".hf-fx-add-item")).find(
1048-
(b) => b.textContent === "Low-pass",
1100+
(b) => b.textContent === EFFECT_COPY.lowpass?.title,
10491101
)!;
10501102
act(() => item.click());
10511103
expect(onChainChange.mock.calls[0][0].nodes[0].id).toBe("n1");

0 commit comments

Comments
 (0)