epiphany/crates/epiphany-engrave/DECISIONS.md

26 KiB
Raw Blame History

epiphany-engrave — decisions and Pass 12 candidates

This file records (a) the implementation decisions the Phase-2 QUICKSTART asked Agent I to make once and document, and (b) ambiguities discovered while building the crate, batched as Pass 12 candidates (spec/PASS12_BATCH.md) rather than improvised in code.

Scope and phase status

epiphany-engrave is the production-side constraint solver (Chapter 9): it turns a ConstrainedLayoutIR into a ResolvedLayoutIR with real geometry. It is a separate crate from epiphany-layout-ir deliberately — layout-ir is the interface layer (the graph↔renderer contract); the actual constraint-solving is on the product side of the spec's core/product boundary, so replacing the StubSolver inside layout-ir would blur it (spec/PHASE2_QUICKSTART.md, crate topology).

Phase 2 shipped the renderer-against-stub slice (QUICKSTART, Agent I, "Development pattern": build the renderer against the stub solver first, then grow the real solver): a genuine deterministic horizontal spacing pass — the first axis of the planned two-pass spring layout — later joined by real hard-constraint evaluation (which earned the Minimal tier).

Phase 3's layout track adds CASTING-OFF (see "Casting-off (2026-07)" below): greedy system breaking at measure boundaries, vertical system stacking, page assignment, a populated ResolvedPage/ResolvedSystem tree, and full break- constraint evaluation. Still deferred: the vertical soft-spring solve within a system, per-system justification/stretch, and optimal break search.

Honest tier

By the same rule layout-ir's StubSolver follows, a solver that does not evaluate the declared hard constraints and computes no quality metrics MUST report SolverTier::Stub, never Minimal (Chapter 9 §"Conformance Tiers"). Engraver::tier() reported Stub until real hard-constraint satisfaction landed and now reports Minimal — which it fully earns after casting-off: the break constraint family is genuinely supported (spec §"Conformance Tiers", Minimal row), and Minimal makes no optimality claim, so greedy first-fit casting-off is legitimate. Since the Quality Metric Catalog companion's ratification, the solve also reports a real quality-metric vector — accurate metric vectors are part of the Minimal claim — computed per the catalog's formulas (see "Quality metrics (2026-07)" below). The all-worst placeholder (QualityMetricVector::unmeasured) remains only for malformed inputs the solver cannot measure.

Implementation decisions (QUICKSTART "Decisions you'll need to make")

  1. Spelling algorithm — N/A (Agent H, epiphany-core).
  2. Solver architecture for engraving — two-pass spring layout (horizontal then vertical), constraint graph derived from the existing ConstrainedLayoutIR. This is the QUICKSTART's recommendation: it matches the IR's spring-slot / vertical-band shape, and the spec's deterministic-output requirement makes a global optimization solver expensive to validate (hard to make bit-reproducible) and a rule-based fallback brittle. The horizontal pass implemented here (spacing::slot_positions) is that architecture's first axis. Global optimization and rule-based fallback are rejected.
  3. Renderer SVG dialect — N/A here (see epiphany-render-svg/DECISIONS.md).
  4. Catalog versioning / 5. Binary Format versioning — N/A (Agents K, J).

Local decisions

  • #![forbid(unsafe_code)]; sync only; MSRV = workspace 1.77. Same as every implementation crate.
  • Solver version 1 (ENGRAVER_VERSION), distinct from the stub's 0. Chapter 9: within a fixed version, identical input produces identical output. The horizontal pass is a pure function of the slot sequence and preferred widths, so this holds; a determinism test asserts byte-identical canonical_bytes() across solves.
  • Well-formedness gate mirrors the stub. An invalid structure, an unknown glyph, a forged catalog identity, or an explicit hard constraint this scaffold cannot yet evaluate yields SolveStatus::InternalError (diagnostic-only), never a panic and never a false Solved. When constraints are present the scaffold additionally attaches a SolverWarning naming the limitation, rather than silently ignoring them.
  • Horizontal spacing preserves provenance, glyph identity, bounds, style, and layer; it changes only position. It assigns each glyph the x of its spring slot and keeps its baseline y (the vertical pass is future work).

Casting-off (2026-07) — decisions

  1. Greedy first-fit system breaking, at measure boundaries. The casting-off walk visits each region's spaced spring-slot columns in x order and breaks before a barline column (this projection draws each measure's barline at its start column, so breaking before the barline keeps every measure intact; the region-final barline closes the region and is never a candidate) whenever the measure beginning there would overflow the page content width. Rationale: SolverTier::Minimal requires the break family supported and hard constraints satisfied, with no optimality claim (Chapter 9 §"Conformance Tiers"), so an optimal (KnuthPlass-style) search is deliberately rejected at this tier — greedy first-fit is deterministic, linear, and easy to validate. Consequences accepted and documented: a region with no measures never wraps automatically; a single measure wider than the page yields an overfull system (no mid-measure emergency break).
  2. Break-constraint semantics: "breaks at slot S" ⇔ S starts a system. A SystemBreakAt/PageBreakAt is satisfied iff the final layout starts a system/page at that slot (a region's first slot is trivially at a boundary). Hard breaks are always honoured (mid-measure if necessary — a Required constraint binds absolutely); soft breaks are honoured unless the closing system would carry no musical content (no notehead/rest column) — the pathological path: the break is skipped, the soft violation warned, and the unhonoured preference recorded as an EngravingDecision with DecisionSource::IrOverride (spec's override-resolution rule: record, never silently drop).
  3. Frame of constraint evaluation. Geometric constraints (no-collision, alignment, position-within) are evaluated against the pre-casting spaced geometry — the frame they are expressed in. Casting-off then relocates whole systems by per-system rigid motions, which cannot un-satisfy an intra-system geometric obligation; evaluating post-casting would instead make every PositionWithin (whose rect pins the region's source-frame vertical envelope) unsatisfiable for any casting-off solver, which cannot be the spec's intent. Break constraints are evaluated against the final break structure.
  4. Page geometry is an engraver parameter (PageGeometry), defaulted to A4 at an 8 mm staff. Adding a Canvas graph field is a schema-major change under the companion's frozen-layout rule, so it was staged to the data-model schema major. Schema major 1 now defines the type (CanvasLayoutDefaults { page_size: CanvasSize, margins: CanvasMargins }, staff spaces, A4/8mm default) and ratifies its wire form (core spec + Binary Format 0.3.0, Phase A); the code graph home landed in Phase C (Canvas gained the field). Wiring the engraver to read it (Phase C) is a byte-neutral follow-up deferred until a custom-geometry producer exists, so the engraver still takes the geometry as a constructor parameter (every score's layout_defaults is the A4 default today). Default arithmetic (1 staff space = staff height / 4 = 2.0 mm at an 8 mm staff): A4 210 × 297 mm → 105 × 148.5 staff spaces; 15 mm margins → 7.5 staff spaces; content area 180 × 267 mm → 90 × 133.5 staff spaces. 90 staff spaces wraps the ten-measure hand-off fixture (≈ 99 staff spaces spaced) into two systems — an honest multi-system default golden.
  5. World-frame convention: pages stacked vertically in one world. Page 1's top-left corner sits at the origin; page n's frame begins a full page height plus INTER_PAGE_GAP (8 staff spaces, a presentation constant) below page n 1's. Every glyph/stroke position is baked into this single y-up world frame (per-system rigid translation: x back to the left margin, y to the stacked position), so the SVG renderer and the hit-test map work unchanged on the flat lists — no per-page transform exists anywhere downstream. The inter-system gap is read from VerticalBand::inter_system_gap (preferred 4.0 staff spaces), so the casting-off gap and the band model cannot drift.
  6. System-spanning strokes are split; the split is provenance-honest. The five staff lines span the whole region; a break cuts them at the systems' content edges. The first segment keeps the original stroke's exact provenance (round-trip preservation); each later segment is synthesized (SynthesisKind::Registered(SYSTEM_CONTINUATION_SYNTHESIS), the codebase's convention for kinds the normative vocabulary does not name) with a continuation_instance_key(original stable id, ordinal) instance key. The round-trip contract in layout-ir was relaxed accordingly (containment + declared-synthesis additions; the stub still must add nothing).
  7. Engraved-break decisions. Every chosen system/page break appends an EngravingDecision whose target is the MUSCLOID id synthesized from the owning region's source under SynthesisKind::EngravedBreak, keyed by the breaking slot's (content-derived) identity. Source attribution: UserOverride(id) when the break constraint was projected from a user break override (the id flows through the new ConstrainedLayoutIR.break_origins), else Automatic; a skipped soft break records IrOverride. A boundary that actually opens a page records PageBreak; a later page opening at a region's own first system records PageBreak too; other boundaries record SystemBreak.
  8. Inverted tests. Two tests that pinned the single-system semantics were deliberately inverted and renamed: a_hard_break_cannot_be_honoured_by_single_system_minimala_hard_break_is_honoured_by_casting_off (Unsatisfiable → Solved with the system count increasing), and a_users_break_flows_to_a_soft_violation_not_a_failurea_users_break_is_honoured_and_recorded_with_its_override (soft-violation warning → clean Solved, break at the anchor's column, decision recorded with the user's override id). The pathological-soft path keeps the old warning semantics under a new, honest name (a_pathological_soft_break_is_skipped_and_recorded_as_ir_override).
  9. Widow rebalance (casting-off phase 2) — the honest P12-I11 fix. Greedy first-fit (decision 1) is optimal for page fill — it packs each non-final system as full as the width allows — but that leaves a region's final system whatever is left over, often a narrow stub (a "widow") the casting_off_quality axis penalizes as a global casting-off failure. A second phase (casting::rebalance_widows) evens the split: it moves whole trailing measures from a region's penultimate system into its final one, choosing the shift that minimizes the larger of the two distribution penalties the Quality Metric Catalog defines for the break family — the width imbalance (casting_off_quality, the CV of the region's system widths) and the non-final break penalty (system_break_penalty, the mean of |W w|/W over non-final systems) — each computed by the same formula as the axis it stands in for, so the rebalance optimizes the values the metric census will report, not a proxy. The two axes pull against each other (filling non-final systems worsens imbalance; equalizing widths worsens underfill) and both share the catalog's 0.5 anchor, so the raw quantities compare directly and the minimizer of their maximum is the width that best satisfies both. Scope: only a region's last boundary moves, and only when greedy placed it (an Automatic boundary with no break requirement or page force pinned to its slot); a user/IR-anchored or page-forced boundary is never disturbed, the penultimate system keeps ≥ 1 measure, and the final system never grows past its predecessor. The system count is unchanged, so decision 2's break structure, decision 5's page assignment, and every break-count test invariant hold. Result on P12-I11: RS-1 casts six/four instead of eight/two (casting_off 1.0 → 0.4463, every axis ≤ 0.90), the suite's asserted Xfail row is promoted to a plain Pass, with no Quality Metric Catalog change — the engraver improved, the 0.5 anchor and the 0.90 Minimal column stood. ENGRAVER_VERSION 2 → 3 (a wrapping score's baked geometry differs from pure greedy); the ten_measure render goldens were regenerated. Still a Minimal heuristic, not an optimality claim.
  10. Deferred refinements (named, not implied): per-system justification (stretching the soft springs so every full system ends at the right margin); the vertical spring solve (band heights are carried, not yet renegotiated; systems stack by real content extents); orphan control and optimal/lookahead casting-off quality beyond decision 9's tail-only widow rebalance — a Standard-tier concern (full-region rebalancing, and justification-aware casting-off once systems can stretch); casting-off caching / incremental re-cast (the spec's incremental-layout section names the casting-off cache; solve_incremental currently re-solves from scratch, which remains observationally equivalent); per-system clef/key restatement (cautionary signatures at system starts, SynthesisKind::Cautionary); multi-system-aware x→time inversion for editor click-to-insert (epiphany-editor-core's position_at interpolates one global x axis and is correct only within the first system of a wrapped region).

Pass 12 candidates

See spec/PASS12_BATCH.md (rows P12-I1, P12-I2, P12-I3) — all three are now resolved:

  • P12-I1 (resolved by I-1) — the v0 pipeline was a structural placeholder (one arbitrary glyph per object at y = 0). to_constrained now builds real notation (clef-relative noteheads, accidentals, key/time signatures, rests, barlines, stems) and the Engraver re-spaces it; the Ch 7 engraving boundary resolved to notation-construction-in-to_constrained, spacing-in-the-Engraver.
  • P12-I2 (resolved) — the MUSCLOID layout-object id derivation is wired (epiphany-determinism reserves the built-in tag; layout-ir provenance and the engraving-decision id route through it).
  • P12-I3 (resolved by I-4a)BRAVURA_METRICS is re-extracted from the same SHA-pinned bravura-1.392 font the outlines come from, with bboxes rounded outward to contain the drawn ink (a render-svg test proves containment).

New candidates from the casting-off slice (proposed rows; spec not edited)

  • P12 (proposed) — Canvas.layout_defaults is named but never defined. The spec references layout defaults ("paper size, margins") on the canvas, but no chapter defines the type, its units, or its defaulting rules, and the core graph does not carry it. Proposal: define CanvasLayoutDefaults { page_size: Size2D, margins: Margins } in staff spaces in the data-model chapter, staged to the data-model schema major (adding the field changes the canonical graph encoding); until then, page geometry is a solver parameter (this crate's PageGeometry) and the spec should say a solver MAY default it.
  • P12 (proposed) — break-constraint satisfaction semantics. Chapter 7 defines SystemBreakAt { slot } but not what geometric fact makes it satisfied. This crate pins: satisfied iff the final layout starts a system at that slot (page analog for PageBreakAt); a region's first slot is trivially at a boundary. The spec should ratify (or correct) this predicate, since Unsatisfiable-vs-Solved conformance hangs on it.
  • P12 (proposed) — user-override attribution across IR stages. The decision record for an honoured break must cite DecisionSource::UserOverride(id), but the normative LayoutConstraint carries no origin, so the override id has no channel from the logical stage's EngravingOverride to the solver. This implementation carries a non-canonical break_origins sidecar on ConstrainedLayoutIR; the spec should bless that channel (or widen the normalized constraint record).
  • P12 (proposed) — synthesis kind for split continuations. Casting-off splits region-spanning strokes (staff lines) at system boundaries; the segments in later systems are engraver-synthesized objects whose kind the normative SynthesisKind set does not name (EngravedBreak is the break itself, not its artefacts). Carried as Registered(SYSTEM_CONTINUATION_SYNTHESIS); the spec should either add a continuation kind or bless the registered id.

Quality metrics (2026-07) — decisions

The Quality Metric Catalog companion (v0.2.0) ratified the nine normative axes' formal definitions, anchors, thresholds, and the QualityFloorApproached trigger; Engraver::resolve now computes the real vector (the private quality module), replacing the all-worst placeholder. The catalog's normative constants (anchors, the Minimal/Standard threshold table, the 0.8 warning fraction, the tier/profile→column mappings) are transcribed once in epiphany_layout_ir::quality and consumed here and by the testkit's reference-suite harness.

  1. Where each axis's inputs come from. All nine are pure functions of the constrained input, the cast layout, and the declared page geometry — data the pipeline already had (see the quality module docs for the per-axis map). The casting pass exposes its own glyph→system assignment (CastLayout::system_of_slot, region_of_system) so the census ranges over what the solve actually did, never a reconstruction. Slot identity (the collision axis's same-column exclusion) is the glyph's horizontal_slot in the constrained input, index-parallel to the resolved glyph list. Widths/columns/densities use glyph ink boxes per the catalog's measurement domain (strokes are not glyphs); page spans use the resolved page tree's system bounding boxes.
  2. Vacuous axes. slur_shape_penalty and beam_slope_penalty are exactly 0.0: the pipeline draws no slur or beam geometry (both exist logically, not as curves/segments), so their contributing-unit sets are empty and the catalog's vacuous-geometry rule (req:qmc:vacuous) applies. The catalog's "notated-but-unrendered" open question explicitly owns this honesty edge; the axes are wired so the first slur/beam-drawing release is measured from day one.
  3. Vertical density's unit set. to_constrained declares InterStaffGap bands but no InterSystemGap bands (the casting pass reads VerticalBand::inter_system_gap directly). Implemented units: (a) the input's InterStaffGap bands, adjacency reconstructed from inter_staff_gap_id(region, g) (gap g separates the region's staves g1/g), realized separation measured between the adjacent staff bands' resolved ink extents within a common system — i.e. what the resolved geometry actually shows, since constrained y is pass-through; (b) the casting pass's realized inter-system gaps (consecutive systems on a page), measured from the resolved page tree against the same constructor's preferred height the stacking consulted. Today (b) measures realized ≡ preferred (raw 0), and (a) is empty for every single-staff-per-region score; a multi-staff region honestly measures ~1.0 because the constrained stage's fixed 12-staff-space pitch is far from the band model's preferred 2.0 gap — the metric is truthful, the vertical spring solve that would negotiate it is the deferred work.
  4. Floor warnings never change the status. Catalog req:qmc:floor-warning: the QualityFloorApproached warning "is diagnostic: emitting it does not change the solve's status". Implemented literally: status is computed before the metric census, and quality warnings are appended after — a solve with clean constraints stays Solved even when it carries quality diagnostics. (This is also load-bearing for downstream regression locks that assert Solved on fixtures whose casting-off quality honestly warns.) The applicable threshold column is the one the config's profile selects (profile_thresholds: Draft→Minimal, Standard/Publication→Standard; default profile Standard), so SolverConfig is now threaded into resolve.
  5. Malformed inputs stay unmeasured. A structurally invalid or forged-catalog input has no trustworthy geometry (the census would sweep unverified boxes), so it keeps QualityMetricVector::unmeasured() and earns no floor diagnostics. An Unsatisfiable solve of a valid problem is measured honestly — its real geometry exists.
  6. No-flip verification. Existing tests asserting Solved on healthy fixtures were re-run against the real metrics: none flipped (warnings cannot flip status, and no metric enters the status computation). Two engrave tests asserting warnings.is_empty() after an honoured break were narrowed to "no LargeSoftConstraintViolation": their micro-fixtures (two-note scores broken at the last note column) honestly cast off into wildly uneven system widths, so the casting-off axis fires its SHOULD-level floor diagnostic — the metric is telling the truth about the layout, and the tests' actual claim (an honoured break is not a soft violation) is preserved exactly.
  7. Measured reality on the reference suite (first real vectors). The six v0.1 entries now measure clean on every Minimal axis. RS-1's casting_off_quality was 1.0 under engraver v2's pure greedy first-fit (the stub last line, above the Minimal 0.90 threshold — carried as a documented xfail row in the testkit harness, P12-I11); the v3 widow-rebalance phase (casting-off decision 9) evens the split to casting_off = 0.4463, clearing the miss with no catalog change, and the xfail row is promoted to a plain Pass. The second finding (P12-I12): three short entries measured spacing_distortion 0.360.41, above the Standard 0.32 warning floor — a spurious diagnostic (never a Minimal failure). It was resolved by a catalog refinement (QMC 0.1.0 → 0.2.0), see quality decision 8: spacing_distortion is scoped to rhythmic (note/rest) columns, dropping the three to 0.2188 / 0.0819 / 0.0856 — below the floor, no code layout change.
  8. Rhythmic-column spacing (spacing_distortion scoped) — the honest P12-I12 fix. The measured false positive was that a short healthy line's wide clef-to-first-note lead advance (furniture width, not note spacing) inflated the per-system advance CV above the Standard warning floor. The catalog (QMC 0.2.0) scopes the axis to rhythmic columns — spring slots bearing a notehead or rest — excluding the clef/key/time lead and treating barlines transparently (a note-to-note advance spans them). quality::census now builds columns only from slots in the precomputed rhythmic set (is_rhythmic: a notehead*/rest* glyph anywhere in the slot); the CV and contributing-unit rule (≥ 3 rhythmic columns) are otherwise unchanged. This is the mirror of the I11 resolution — measure the right thing rather than relax the threshold — but here the defect lived in the normative metric definition, so it is a catalog change (unlike I11). Measurement-only: the resolved layout, canonical bytes, render goldens, and ENGRAVER_VERSION are untouched; only the reported spacing_distortion value changes (RS-3/5/6 drop below the floor, RS-2/RS-4 go vacuous-0.0 as their systems carry < 3 rhythmic columns — honestly "too little to measure"). The floor-column regression test was re-pointed from b-flat's spacing (which no longer warns) to RS-1's casting-off (which still sits between the Standard and Minimal floors); a new short_scores_do_not_trip_the_standard_spacing_floor locks the fix. The duration-aware optical-spacing open question stays open.

Pass 12 candidates (quality metrics)

  • P12-I11 — RESOLVED (engraver v3 widow rebalance). First measured vectors (engraver v2) cast the RS-1 fixture into glyph spans ~78.6/18.8 staff spaces → width CV 0.61 ≥ the 0.5 anchor → clamped 1.0 > the Minimal 0.90 threshold. Resolved the honest way (option (a)): casting-off decision 9's widow-rebalance phase evens the split to ~59.5/37.8 (casting_off = 0.4463), so every axis passes and the testkit Xfail row is promoted to a Pass. Option (b) (a QMC anchor/threshold revision — raise the anchor, relax Minimal, or add an RS-1 override) was deliberately not taken: the 0.5 anchor and the 0.90 Minimal column stood. ENGRAVER_VERSION 2 → 3; ten_measure render goldens regenerated.
  • P12-I12 — RESOLVED (QMC 0.2.0, rhythmic-column spacing). With uniform preferred widths, few-column systems (38 columns with a wide clef/key lead) measured spacing CV 0.360.41 — above the Standard column's 0.8 × 0.40 = 0.32 warning floor, so the default profile emitted QualityFloorApproached(Spacing) on tiny, healthy scores. Resolved the lead-aware way: the catalog scopes spacing_distortion to rhythmic (note/rest) columns, excluding the clef/key/time furniture lead and treating barlines transparently (quality decision 8). The three entries drop to 0.2188 / 0.0819 / 0.0856 (below the floor). The alternative — a duration-proportional (optical) redefinition — needs the pipeline's deferred duration-aware preferred widths and stays the catalog's open question.

Break-constraint satisfaction predicate (Pass 12 P12-I8, ratified)

The break-constraint satisfaction predicate — a SystemBreakAt/PageBreakAt at slot is satisfied iff the final ResolvedLayoutIR starts a system/page at that slot (a region-first slot trivially) — was ratified into the core spec by the schema-major-1 track's Phase F (2026-07-06; core spec req:layoutir:break-satisfaction; spec/PASS12_RATIFICATION_LOG.md, schema-major-1 tranche). Satisfaction is a predicate on the output layout, not the solver's spring state; casting-off evaluates the declared hard break constraints as part of its tier claim.