* craft-timeline: carry overflowing time code fields before drop-frame counting
A drop-frame time code with a field past its range (01;00;00;30) was
counted as non-drop frames. The fields now carry into the next one
first, so it reads as the frame 01;00;01;00 names. Non-drop overflow is
counted as before.
Ported from the time part of storytold/filmcraft#4096 (also in #4088).
* craft-timeline: FrameRate::frames_between counts the frames between two boundaries
At a rate whose frame is not a whole number of ticks (11, 13, 23.5 fps),
the ticks between two frame boundaries can be one fewer than the exact
length of those frames, so frame_at(end - start) reads one short.
frames_between counts frame_at(end) - frame_at(start), saturating.
Ported from the time part of storytold/filmcraft#4291.
---------
Co-authored-by: JonRC <jonarc06@gmail.com>
Co-authored-by: ItsJustChrisE <53130043+ItsJustChrisE@users.noreply.github.com>
#987 (FCPXML) was squash-merged after #1002 (OpenTimelineIO), which was stacked on it. The squash
carried #987's older copies of Cargo.toml, lib.rs, model.rs, README.md and the tests, which removed
the otio feature and module wiring that #1002 had added. This puts back #1002's merged state of
crates/timeline exactly; it already contains every FCPXML change.
* craft-timeline: a neutral timeline model and the import builder
model: a Project of bins and items (media, sequences, subclips, and items no
interchange format carries), sequences of tracks with clips, transitions,
markers and effects with keyframes. Cut down from FilmCraft's project model to
what Final Cut Pro 7 XML, FCPXML and OpenTimelineIO describe; EffectCraft
already uses that shape for its interchange. Three things stay the
application's: effects (looked up through a Catalog the caller supplies),
generators beyond the common ones (Generator::Other with an opaque payload),
and per-object extension JSON (ext) that a format can carry unread.
fx: the effect and parameter ids the formats name themselves, and Standard,
a catalog of just those.
build: FilmCraft's import Builder and shared helpers (filmcraft-interchange
common.rs at 4bec22bd) on the model, with the effect registry replaced by the
catalog, and the bounds every import ends with (Imported::bound, from lib.rs).
* craft-timeline: Final Cut Pro 7 XML (xmeml) on the neutral model
fcp7: FilmCraft's xmeml reader and writer (filmcraft-interchange fcp7.rs at
4bec22bd) moved onto craft_timeline::model, behind feature xml.
- XML is read with craft-xml, strictly: at most 256 levels of nesting (the
limit EffectCraft checked with its own depth scan before handing documents
over), 2 000 000 nodes, 256 MiB; a document type declaration with an internal
subset and entities XML does not define are refused. It is written with
craft-xml's Writer.
- Effects other than motion, opacity, time remap, audio levels and pan are
looked up through the caller's Catalog, by id and by name, and written with
the catalog's stable name and category.
- An application generator round-trips as <namespace>:<payload> in effectid
(FilmCraft wrote filmcraft:<json>); transparent video, counting leader and
bars and tone are written by name, which the reader already took.
- Finding the sequence a clip item is in is one walk of the document instead of
an ancestors() lookup per clip item.
tests/it: FilmCraft's FCP7 integration tests (the hand-written Premiere-style
document, the rich round trip, the 48-case property round trip, split mono and
stereo channels, sub-frame spans, absurd timebases and start timecodes, the
link-group bound) on the model, with a test catalog for the four application
effects they use.
* craft-timeline: FCPXML on the neutral model
fcpxml: FilmCraft's FCPXML 1.9-1.11 reader and writer (filmcraft-interchange
fcpxml.rs at 4bec22bd) moved onto craft_timeline::model, behind feature xml.
XML is read with craft-xml as fcp7 is; filters other than the transform,
blend and volume adjustments go through the caller's Catalog by name, and an
effect resource's uid is <namespace>.<effect id> (FilmCraft wrote
filmcraft.<id>). ExportOptions gains fcpxml_version.
tests/it/fcpxml.rs: FilmCraft's FCPXML integration tests on the model (the
hand-written connected-clips document, hostile lane numbers, standalone video
stills, self-referencing compound media, round trips at 1.9, 1.10 and 1.11,
the property round trip with its regression seed, percent-decoded relative
URLs). The FCP7 tests export to FCPXML again where FilmCraft's did.
* craft-timeline: a neutral timeline model and the import builder
model: a Project of bins and items (media, sequences, subclips, and items no
interchange format carries), sequences of tracks with clips, transitions,
markers and effects with keyframes. Cut down from FilmCraft's project model to
what Final Cut Pro 7 XML, FCPXML and OpenTimelineIO describe; EffectCraft
already uses that shape for its interchange. Three things stay the
application's: effects (looked up through a Catalog the caller supplies),
generators beyond the common ones (Generator::Other with an opaque payload),
and per-object extension JSON (ext) that a format can carry unread.
fx: the effect and parameter ids the formats name themselves, and Standard,
a catalog of just those.
build: FilmCraft's import Builder and shared helpers (filmcraft-interchange
common.rs at 4bec22bd) on the model, with the effect registry replaced by the
catalog, and the bounds every import ends with (Imported::bound, from lib.rs).
* craft-timeline: Final Cut Pro 7 XML (xmeml) on the neutral model
fcp7: FilmCraft's xmeml reader and writer (filmcraft-interchange fcp7.rs at
4bec22bd) moved onto craft_timeline::model, behind feature xml.
- XML is read with craft-xml, strictly: at most 256 levels of nesting (the
limit EffectCraft checked with its own depth scan before handing documents
over), 2 000 000 nodes, 256 MiB; a document type declaration with an internal
subset and entities XML does not define are refused. It is written with
craft-xml's Writer.
- Effects other than motion, opacity, time remap, audio levels and pan are
looked up through the caller's Catalog, by id and by name, and written with
the catalog's stable name and category.
- An application generator round-trips as <namespace>:<payload> in effectid
(FilmCraft wrote filmcraft:<json>); transparent video, counting leader and
bars and tone are written by name, which the reader already took.
- Finding the sequence a clip item is in is one walk of the document instead of
an ancestors() lookup per clip item.
tests/it: FilmCraft's FCP7 integration tests (the hand-written Premiere-style
document, the rich round trip, the 48-case property round trip, split mono and
stereo channels, sub-frame spans, absurd timebases and start timecodes, the
link-group bound) on the model, with a test catalog for the four application
effects they use.
* craft-timeline: FCPXML on the neutral model
fcpxml: FilmCraft's FCPXML 1.9-1.11 reader and writer (filmcraft-interchange
fcpxml.rs at 4bec22bd) moved onto craft_timeline::model, behind feature xml.
XML is read with craft-xml as fcp7 is; filters other than the transform,
blend and volume adjustments go through the caller's Catalog by name, and an
effect resource's uid is <namespace>.<effect id> (FilmCraft wrote
filmcraft.<id>). ExportOptions gains fcpxml_version.
tests/it/fcpxml.rs: FilmCraft's FCPXML integration tests on the model (the
hand-written connected-clips document, hostile lane numbers, standalone video
stills, self-referencing compound media, round trips at 1.9, 1.10 and 1.11,
the property round trip with its regression seed, percent-decoded relative
URLs). The FCP7 tests export to FCPXML again where FilmCraft's did.
* craft-timeline: OpenTimelineIO on the neutral model
otio: FilmCraft's OTIO reader and writer (filmcraft-interchange otio.rs at
4bec22bd) moved onto craft_timeline::model, behind feature otio (serde_json).
FilmCraft wrote its own serde types into metadata.filmcraft. Here the model's
fields are written as JSON by hand under metadata.<namespace>, with the same
keys and value shapes FilmCraft's serde produced (labels, settings, media
info, generators, effects with externally tagged parameter values, alignment,
marker kinds, channel layouts), so files FilmCraft wrote read back. Every key
the reader does not know comes back in the object's ext, and ext's keys are
written next to the model's: an application's palette, track volume, masks and
the like round-trip without the crate knowing them. ParamValue::Opaque and
Generator::Other carry values only the application reads.
The model's Sequence loses its ext: a sequence's is its item's, so there is
one place for it. ImportOptions gains name (for an unnamed timeline), as
FilmCraft's had.
tests: FilmCraft's OTIO integration tests on the model (the golden document,
the lossless round trip now through ext, collections and bare tracks, items at
an audio sample rate, generator labels and identity, the property round trip,
marker URLs, percent-decoded relative URLs); its palette tests stay with
FilmCraft, whose palette merge they test, and are replaced by one ext round
trip. The OTIO unit tests (exact rational times, the nested-copies limit) and
a JSON nesting test.
* craft-timeline: a neutral timeline model and the import builder
model: a Project of bins and items (media, sequences, subclips, and items no
interchange format carries), sequences of tracks with clips, transitions,
markers and effects with keyframes. Cut down from FilmCraft's project model to
what Final Cut Pro 7 XML, FCPXML and OpenTimelineIO describe; EffectCraft
already uses that shape for its interchange. Three things stay the
application's: effects (looked up through a Catalog the caller supplies),
generators beyond the common ones (Generator::Other with an opaque payload),
and per-object extension JSON (ext) that a format can carry unread.
fx: the effect and parameter ids the formats name themselves, and Standard,
a catalog of just those.
build: FilmCraft's import Builder and shared helpers (filmcraft-interchange
common.rs at 4bec22bd) on the model, with the effect registry replaced by the
catalog, and the bounds every import ends with (Imported::bound, from lib.rs).
* craft-timeline: Final Cut Pro 7 XML (xmeml) on the neutral model
fcp7: FilmCraft's xmeml reader and writer (filmcraft-interchange fcp7.rs at
4bec22bd) moved onto craft_timeline::model, behind feature xml.
- XML is read with craft-xml, strictly: at most 256 levels of nesting (the
limit EffectCraft checked with its own depth scan before handing documents
over), 2 000 000 nodes, 256 MiB; a document type declaration with an internal
subset and entities XML does not define are refused. It is written with
craft-xml's Writer.
- Effects other than motion, opacity, time remap, audio levels and pan are
looked up through the caller's Catalog, by id and by name, and written with
the catalog's stable name and category.
- An application generator round-trips as <namespace>:<payload> in effectid
(FilmCraft wrote filmcraft:<json>); transparent video, counting leader and
bars and tone are written by name, which the reader already took.
- Finding the sequence a clip item is in is one walk of the document instead of
an ancestors() lookup per clip item.
tests/it: FilmCraft's FCP7 integration tests (the hand-written Premiere-style
document, the rich round trip, the 48-case property round trip, split mono and
stereo channels, sub-frame spans, absurd timebases and start timecodes, the
link-group bound) on the model, with a test catalog for the four application
effects they use.
model: a Project of bins and items (media, sequences, subclips, and items no
interchange format carries), sequences of tracks with clips, transitions,
markers and effects with keyframes. Cut down from FilmCraft's project model to
what Final Cut Pro 7 XML, FCPXML and OpenTimelineIO describe; EffectCraft
already uses that shape for its interchange. Three things stay the
application's: effects (looked up through a Catalog the caller supplies),
generators beyond the common ones (Generator::Other with an opaque payload),
and per-object extension JSON (ext) that a format can carry unread.
fx: the effect and parameter ids the formats name themselves, and Standard,
a catalog of just those.
build: FilmCraft's import Builder and shared helpers (filmcraft-interchange
common.rs at 4bec22bd) on the model, with the effect registry replaced by the
catalog, and the bounds every import ends with (Imported::bound, from lib.rs).
* craft-timeline: exact media time, reports, media paths, ALE and CMX 3600 EDL
New crate for editorial timeline interchange (#782), moved from FilmCraft at
4bec22bd:
- time: filmcraft-time whole (Tick, FrameRate, TimeRange, SMPTE timecode,
feet+frames, typed-timecode parsing) with its tests.
- report: Report / Level / ReportEntry.
- path: file URL and path conversion, relative references joined to a folder.
- rate: timebase+ntsc and floating rates to exact rates, MAX_RATE.
- ale: AleDoc, parse, write, standard heading and columns.
- edl: the parser (events, lines, timecode fields, M2, AUD, comment extensions),
the frame-rate guess, and the line layout of the writer, on frame counts.
- Format, detect_text, decode_text.
Each format module gives the document as the format writes it. Mapping onto an
application's timeline stays in the application.
* craft-timeline: strip a UTF-8 byte order mark when parsing ALE files
An ALE saved with a BOM was refused as "not an ALE file": the mark made the
first line something other than "Heading".
Ported from storytold/filmcraft#4531.
---------
Co-authored-by: NetterSilver <133535268+Silvertree2010@users.noreply.github.com>
Dylan M. Taylor
