Eyevinn / go-608 / 30569972428

84%

main: 84%

Build Type

Pull #67

github

Committed by tobbee

Commit Message

feat(generate)!: make a unit's number and start time independent inputs

BREAKING: BuildUnitCues takes a Unit{Nr, StartMS, Frames} instead of loose
unitFrames/unitStartMS arguments, CueContentFunc receives that Unit, and
WithFlipAtCueStart names the next Unit outright.

A unit's start was effectively assumed to be Nr x duration. Under
WithFlipAtCueStart the next unit's start was computed as this unit's end:

    nextCue := cfg.next(0, wallAt(unitFrames))

That is wrong for a variable-duration timeline, for a timeline with a gap, and
for any numbering epoch that does not begin at t=0. The unit then preloaded a
caption built for the wrong time while the following unit flipped it anyway, so
the screen showed a stale guess. The derivation was not even load-bearing --
go-608 never used the timestamp it passed, only forwarded it so the caller
could format text.

Nothing now derives one field from the other: StartMS is the only timing input,
Nr is passed through untouched. Because the unit arrives as an argument rather
than being closed over, one content function serves every unit, including the
next unit's first cue -- which also removes the old hazard that the
hand-incremented closure and the derived time could silently disagree.

TestBuildUnitCuesNonContiguousUnits pins it: two 2 s units 5 s apart, where the
build carried in unit A's tail must name unit B's real start. Restoring the old
derivation makes it fail with 14:23:46.000 instead of 14:23:49.000.

Docs: README per-unit-cues section, SPEC.md 4.4 (which had never listed the
per-unit API at all), and a CHANGELOG entry with a migration snippet.

Pull Request Pull Request #67: generate: make a unit's number and start time independent inputs

Coverage Stats

8 of 9 new or added lines in 1 file covered. (88.89%)

1 existing line in 1 file now uncovered.

3377 of 4010 relevant lines covered (84.21%)

0.97 hits per line