linked-rolls 0.56.0 → 0.58.0

package/lib/schema.json

@@ -1221,7 +1221,7 @@
                                 "$ref": "#/definitions/AnyFeature"
                             },
                             "type": "array",
-                            "ontology": "crm:P108 has produced"
+                            "ontology": "reo:produced"
                         },
                         "purpose": {
                             "$ref": "#/definitions/ModificationPurpose",
@@ -1566,22 +1566,6 @@
                             "description": "The type discriminator for this object.",
                             "type": "string",
                             "ontology": "rdf:type"
-                        },
-                        "bears": {
-                            "type": "array",
-                            "items": {
-                                "type": "object",
-                                "properties": {
-                                    "@id": {
-                                        "type": "string"
-                                    }
-                                },
-                                "required": [
-                                    "@id"
-                                ]
-                            },
-                            "description": "The features the patch bears. Derived on export.",
-                            "ontology": "crm:P56 bears feature"
                         }
                     },
                     "required": [
@@ -1682,17 +1666,10 @@
                             "description": "A free-text description of the condition, providing details beyond the type classification.",
                             "type": "string",
                             "ontology": "crm:P3 has note"
-                        },
-                        "@type": {
-                            "const": "ConditionState",
-                            "description": "The type discriminator for this object.",
-                            "type": "string",
-                            "ontology": "rdf:type"
                         }
                     },
                     "required": [
-                        "conditionType",
-                        "@type"
+                        "conditionType"
                     ],
                     "type": "object"
                 },
@@ -1732,18 +1709,11 @@
                             "description": "The stretch factor, e.g. 1.02 means the paper has stretched by 2% compared to its original dimensions.",
                             "type": "number",
                             "ontology": "rdf:value"
-                        },
-                        "@type": {
-                            "const": "ConditionState",
-                            "description": "The type discriminator for this object.",
-                            "type": "string",
-                            "ontology": "rdf:type"
                         }
                     },
                     "required": [
                         "conditionType",
-                        "factor",
-                        "@type"
+                        "factor"
                     ],
                     "type": "object"
                 }
@@ -1986,17 +1956,10 @@
                     "description": "A free-text description of the condition, providing details beyond the type classification.",
                     "type": "string",
                     "ontology": "crm:P3 has note"
-                },
-                "@type": {
-                    "const": "ConditionState",
-                    "description": "The type discriminator for this object.",
-                    "type": "string",
-                    "ontology": "rdf:type"
                 }
             },
             "required": [
-                "conditionType",
-                "@type"
+                "conditionType"
             ],
             "type": "object"
         },
@@ -2035,17 +1998,10 @@
                     "description": "A free-text description of the condition, providing details beyond the type classification.",
                     "type": "string",
                     "ontology": "crm:P3 has note"
-                },
-                "@type": {
-                    "const": "ConditionState",
-                    "description": "The type discriminator for this object.",
-                    "type": "string",
-                    "ontology": "rdf:type"
                 }
             },
             "required": [
-                "conditionType",
-                "@type"
+                "conditionType"
             ],
             "type": "object"
         },
@@ -2081,17 +2037,10 @@
                     "description": "A free-text description of the condition, providing details beyond the type classification.",
                     "type": "string",
                     "ontology": "crm:P3 has note"
-                },
-                "@type": {
-                    "const": "ConditionState",
-                    "description": "The type discriminator for this object.",
-                    "type": "string",
-                    "ontology": "rdf:type"
                 }
             },
             "required": [
-                "conditionType",
-                "@type"
+                "conditionType"
             ],
             "type": "object"
         },
@@ -2127,17 +2076,10 @@
                     "description": "A free-text description of the condition, providing details beyond the type classification.",
                     "type": "string",
                     "ontology": "crm:P3 has note"
-                },
-                "@type": {
-                    "const": "ConditionState",
-                    "description": "The type discriminator for this object.",
-                    "type": "string",
-                    "ontology": "rdf:type"
                 }
             },
             "required": [
-                "conditionType",
-                "@type"
+                "conditionType"
             ],
             "type": "object"
         },
@@ -2176,17 +2118,10 @@
                     "description": "A free-text description of the condition, providing details beyond the type classification.",
                     "type": "string",
                     "ontology": "crm:P3 has note"
-                },
-                "@type": {
-                    "const": "ConditionState",
-                    "description": "The type discriminator for this object.",
-                    "type": "string",
-                    "ontology": "rdf:type"
                 }
             },
             "required": [
-                "conditionType",
-                "@type"
+                "conditionType"
             ],
             "type": "object"
         },
@@ -2650,22 +2585,6 @@
                     "description": "The type discriminator for this object.",
                     "type": "string",
                     "ontology": "rdf:type"
-                },
-                "bears": {
-                    "type": "array",
-                    "items": {
-                        "type": "object",
-                        "properties": {
-                            "@id": {
-                                "type": "string"
-                            }
-                        },
-                        "required": [
-                            "@id"
-                        ]
-                    },
-                    "description": "The features the patch bears. Derived on export.",
-                    "ontology": "crm:P56 bears feature"
                 }
             },
             "required": [
@@ -2734,17 +2653,10 @@
                     "$ref": "#/definitions/ObjectAssumption%3CMeasure%3C%22mm%22%3E%3E",
                     "description": "The diameter of the round punch. Taken across the roll, it is the one value of the setting that neither the scale along the roll nor the shrinkage of the paper enters.",
                     "ontology": "reo:punchDiameter"
-                },
-                "@type": {
-                    "const": "ConditionState",
-                    "description": "The type discriminator for this object.",
-                    "type": "string",
-                    "ontology": "rdf:type"
                 }
             },
             "required": [
-                "conditionType",
-                "@type"
+                "conditionType"
             ],
             "type": "object",
             "ontology": "crm:E3 Condition State"
@@ -2813,7 +2725,7 @@
                         "$ref": "#/definitions/AnyFeature"
                     },
                     "type": "array",
-                    "ontology": "crm:P108 has produced"
+                    "ontology": "reo:produced"
                 },
                 "speed": {
                     "$ref": "#/definitions/ObjectAssumption%3CPaperSpeed%3E",
@@ -3111,18 +3023,6 @@
                     "type": "array",
                     "ontology": "crm:P31i was modified by"
                 },
-                "ops": {
-                    "description": "A list of operations that have been applied to this copy's features (e.g. 'shifted', 'stretched') to normalize measurements for comparison with other copies. Not exported to RDF.",
-                    "items": {
-                        "enum": [
-                            "shifted",
-                            "stretched",
-                            "shortened"
-                        ],
-                        "type": "string"
-                    },
-                    "type": "array"
-                },
                 "production": {
                     "$ref": "#/definitions/ProductionEvent",
                     "description": "The production event that created this roll copy.",
@@ -3152,38 +3052,6 @@
                     "description": "The type discriminator for this object.",
                     "type": "string",
                     "ontology": "rdf:type"
-                },
-                "bears": {
-                    "type": "array",
-                    "items": {
-                        "type": "object",
-                        "properties": {
-                            "@id": {
-                                "type": "string"
-                            }
-                        },
-                        "required": [
-                            "@id"
-                        ]
-                    },
-                    "description": "The features the copy bears, whichever of its acts brought them about. Derived on export.",
-                    "ontology": "crm:P56 bears feature"
-                },
-                "composedOf": {
-                    "type": "array",
-                    "items": {
-                        "type": "object",
-                        "properties": {
-                            "@id": {
-                                "type": "string"
-                            }
-                        },
-                        "required": [
-                            "@id"
-                        ]
-                    },
-                    "description": "The patches glued onto the copy. A patch is an object rather than a feature, so it is stated as a part. Derived on export.",
-                    "ontology": "crm:P46 is composed of"
                 }
             },
             "required": [
@@ -3191,7 +3059,6 @@
                 "@id",
                 "measurements",
                 "modifications",
-                "ops",
                 "@type"
             ],
             "type": "object",
@@ -3361,19 +3228,12 @@
                 "@id": {
                     "description": "A unique identifier for this object.",
                     "type": "string"
-                },
-                "@type": {
-                    "const": "Version",
-                    "description": "The type discriminator for this object.",
-                    "type": "string",
-                    "ontology": "rdf:type"
                 }
             },
             "required": [
                 "@id",
                 "motivations",
-                "system",
-                "@type"
+                "system"
             ],
             "type": "object",
             "ontology": "lrmoo:F2 Expression"

package/lib/spec/context.json

@@ -11,8 +11,6 @@
         "crminf": "http://www.cidoc-crm.org/extensions/crminf/",
         "lrmoo": "http://iflastandards.info/ns/lrm/lrmoo/",
         "reo": "https://w3id.org/reo/",
-        "Edition": "lrmoo:F2_Expression",
-        "Version": "lrmoo:F2_Expression",
         "RollCopy": "reo:RollCopy",
         "HoleChain": "reo:HoleChain",
         "Mark": "reo:Mark",
@@ -22,7 +20,6 @@
         "Removal": "crm:E80_Part_Removal",
         "Alteration": "crm:E12_Production",
         "Perforator": "crm:E22_Human-Made_Object",
-        "ConditionState": "crm:E3_Condition_State",
         "note": "reo:Note",
         "expression": "reo:Expression",
         "text": {
@@ -92,6 +89,7 @@
             "@type": "xsd:date"
         },
         "collationTolerance": null,
+        "formatVersion": null,
         "annotation": null,
         "roll": "lrmoo:R3i_realises",
         "catalogueNumber": "dcterms:identifier",
@@ -280,7 +278,7 @@
             }
         },
         "actor": "crm:P14_carried_out_by",
-        "produced": "crm:P108_has_produced",
+        "produced": "reo:produced",
         "added": "crm:P111_added",
         "removed": {
             "@id": "crm:P113_removed",
@@ -291,14 +289,6 @@
             "@type": "@vocab",
             "@context": { "@vocab": "https://w3id.org/reo/type/" }
         },
-        "bears": {
-            "@id": "crm:P56_bears_feature",
-            "@type": "@id"
-        },
-        "composedOf": {
-            "@id": "crm:P46_is_composed_of",
-            "@type": "@id"
-        },
         "augmented": {
             "@id": "crm:P110_augmented",
             "@type": "@id"

package/lib/{ReproducingSystem.d.ts → systems/ReproducingSystem.d.ts}

@@ -1,7 +1,7 @@
-import { HoleChain } from "./Feature.js";
-import { Expression, Note } from "./Symbol.js";
+import { HoleChain } from "../model/Feature.js";
+import { Expression, Note } from "../model/Symbol.js";
 import { TrackerBar } from "./TrackerBar.js";
-import { Millimeters, Quantity, Seconds } from "./Quantity.js";
+import { Millimeters, Quantity, Seconds } from "../model/Quantity.js";
 export type SpeedUnit = 'ft/min' | 'm/min';
 /**
  * The playback tempo of the roll as a paper speed, stated at the

package/lib/{TrackerBar.d.ts → systems/TrackerBar.d.ts}

@@ -1,6 +1,6 @@
-import type { Concept } from "./Agent.js";
-import { Expression, Note } from "./Symbol.js";
-import { Millimeters, SpeedMeasure, Track } from "./Quantity.js";
+import type { Concept } from "../model/Agent.js";
+import { Expression, Note } from "../model/Symbol.js";
+import { Millimeters, SpeedMeasure, Track } from "../model/Quantity.js";
 /**
  * What a tracker bar position does: sound a note, or operate one of
  * the expression valves on the bass or the treble side.
@@ -15,6 +15,27 @@ export interface TrackArea {
     readonly from: Track;
     readonly to: Track;
 }
+/**
+ * How a scale words a function: as a command that turns it on, one that
+ * cancels it, or one that holds it for as long as it lasts.
+ */
+export type Spelling = 'on' | 'off' | 'held';
+/**
+ * What a word of a scale operates, rather than the word itself, so that
+ * two scales can be compared at all.
+ */
+export interface Operation {
+    /** The function operated, named the same wherever a scale has it. */
+    operates: string;
+    spelling: Spelling;
+    /**
+     * Whether the half of the keyboard the valve serves is part of the
+     * function operated. The dynamics are per half; the pedals are not,
+     * and the two Welte scales put them on opposite edges of the paper,
+     * so a rule that compared sides would leave every pedal unpaired.
+     */
+    sided: boolean;
+}
 export type NoteMeaning = Pick<Note, 'type' | 'pitch'>;
 export type ExpressionMeaning = Pick<Expression, 'type' | 'expressionType' | 'scope'>;
 export type TrackMeaning = NoteMeaning | ExpressionMeaning;
@@ -44,6 +65,12 @@ export interface TrackerBar {
     readonly areas: readonly TrackArea[];
     /** The expression types the bar reads, each a term of the system. */
     readonly expressionTypes: readonly string[];
+    /**
+     * How the system spells a single added accent, each spelling a
+     * sequence of its expression types: a latched system turns a valve on
+     * and off again, a held one holds one perforation for the accent.
+     */
+    readonly accents: readonly (readonly string[])[];
     /**
      * The position carrying the rewind perforation, which runs at
      * the very end of a roll and is the usual landmark for calibrating
@@ -90,6 +117,11 @@ export interface TrackerBar {
     positionOf(meaning: TrackMeaning): Track | undefined;
     /** `undefined` for a position the bar does not read; snapped as `meaningOf` is. */
     roleOf(position: Track): TrackRole | undefined;
+    /**
+     * What the expression type operates, or `undefined` for one the bar
+     * does not read or whose function has no counterpart in another scale.
+     */
+    operationOf(expressionType: string): Operation | undefined;
     /** The positions a feature lies across, snapped to the grid. */
     positionsIn(span: OnBar): readonly Track[];
 }
@@ -105,11 +137,6 @@ export declare const systemOf: (bar: TrackerBar) => Concept;
 export declare const systemIdIn: (id: string | undefined) => string | undefined;
 /** The identifier of a system the type vocabulary knows, from its concept. */
 export declare const systemIdOf: (system: Concept | undefined) => string | undefined;
-/**
- * A tracker bar as written down, with its positions as plain numbers
- * in the bar's own 1-based numbering; `describeTrackerBar` gives them
- * their type.
- */
 /**
  * Where a roll's own content ends, as far as its perforations say.
  *
@@ -141,6 +168,11 @@ export type OnBar = {
     readonly from: Track;
     readonly to?: Track;
 };
+/**
+ * A tracker bar as written down, with its positions as plain numbers
+ * in the bar's own 1-based numbering; `describeTrackerBar` gives them
+ * their type.
+ */
 export interface TrackerBarSpec {
     id: string;
     name: string;
@@ -170,6 +202,14 @@ export interface TrackerBarSpec {
      * its own needs no threshold, since anything there is the rewind.
      */
     rewindHold?: Millimeters;
+    /**
+     * What each expression type operates, keyed by type. A type left out
+     * operates a function no other scale has a word for, and a transfer
+     * leaves it a plain deletion.
+     */
+    operations?: Readonly<Record<string, Operation>>;
+    /** How the system spells a single added accent; see `TrackerBar.accents`. */
+    accents?: readonly (readonly string[])[];
 }
 export declare const describeTrackerBar: (spec: TrackerBarSpec) => TrackerBar;
 /**

package/lib/{TrackerBar.js → systems/TrackerBar.js}

@@ -1,4 +1,4 @@
-import { mm, track } from "./Quantity.js";
+import { mm, track } from "../model/Quantity.js";
 /**
  * What a position says, as a key. Two bars read the same thing exactly
  * where their keys agree, which is what lets a symbol cross from one
@@ -66,6 +66,13 @@ export const describeTrackerBar = (spec) => {
     if (rewind === undefined) {
         throw new Error(`${spec.name} declares no rewind track`);
     }
+    const expressionTypes = [...new Set(spec.expressions.values())];
+    const operations = spec.operations ?? {};
+    const accents = spec.accents ?? [];
+    const unread = [...Object.keys(operations), ...accents.flat()].filter(type => !expressionTypes.includes(type));
+    if (unread.length > 0) {
+        throw new Error(`${spec.name} names expression types its bar does not read: ${[...new Set(unread)].join(', ')}`);
+    }
     // A rewind on a line of its own is unambiguous; one sharing a line is only
     // the rewind when it is far longer than that line's usual command.
     const shared = spec.rewindTrack !== undefined;
@@ -84,13 +91,15 @@ export const describeTrackerBar = (spec) => {
         trackCount: spec.trackCount,
         endsAt,
         areas,
-        expressionTypes: [...new Set(spec.expressions.values())],
+        expressionTypes,
+        accents,
         rewindTrack: track(rewind),
         ...(spec.paperSpeed && { paperSpeed: spec.paperSpeed }),
         meaningOf,
         meaningsOf,
         positionOf: meaning => positions.get(keyOf(meaning)),
         roleOf,
+        operationOf: expressionType => Object.hasOwn(operations, expressionType) ? operations[expressionType] : undefined,
         positionsIn: positionsBetween
     };
 };

package/lib/systems/index.d.ts

@@ -1,6 +1,12 @@
-import { Concept } from "../Agent.js";
-import { TrackerBar } from "../TrackerBar.js";
+import { Concept } from "../model/Agent.js";
+import { TrackerBar } from "./TrackerBar.js";
 /** The tracker bars the library knows, the T-100 first as the usual one. */
 export declare const trackerBars: readonly TrackerBar[];
 /** The bar of a system the type vocabulary knows, from its concept. */
 export declare const trackerBarOf: (system: Concept | undefined) => TrackerBar | undefined;
+/**
+ * The bar a copy is read by where it names no system of its own: every
+ * copy was read by the T-100's before the systems were told apart, and
+ * `reservationsAbout` reports a copy that still relies on this.
+ */
+export declare const defaultTrackerBar: TrackerBar;

package/lib/systems/index.js

@@ -1,4 +1,4 @@
-import { systemIdOf } from "../TrackerBar.js";
+import { systemIdOf } from "./TrackerBar.js";
 import { welteT100 } from "./welteT100/bar.js";
 import { welteLicensee } from "./welteLicensee/bar.js";
 import { welteT98 } from "./welteT98/bar.js";
@@ -9,3 +9,9 @@ export const trackerBarOf = (system) => {
     const id = systemIdOf(system);
     return trackerBars.find(bar => bar.id === id);
 };
+/**
+ * The bar a copy is read by where it names no system of its own: every
+ * copy was read by the T-100's before the systems were told apart, and
+ * `reservationsAbout` reports a copy that still relies on this.
+ */
+export const defaultTrackerBar = welteT100;

package/lib/systems/welte.d.ts

@@ -0,0 +1,100 @@
+import { Grid, Half, Model, ModelInput, Parameters, PedalInput, PedalMode, PedalTravel, PortGeometry, Spool } from "welte-mignon-emulator";
+import { Expression } from "../model/Symbol.js";
+import { NegotiatedEvent, Performance, RollProperties } from "./ReproducingSystem.js";
+import { Millimeters, Seconds, Track } from "../model/Quantity.js";
+import { type VelocityMap } from "./velocity.js";
+/**
+ * What the Welte systems share downstream of the relay. Hagmann has the
+ * nuancing unit built the same for both tracker scales (p. 96) and the valves
+ * and bellows that move the pedals the same in both (p. 106), so the way a
+ * performance is read off the emulator is one; what differs is in front of it,
+ * and each system says that in the `Mechanism` it hands to `performWelte`.
+ */
+/** The options every Welte system takes. */
+export type WelteOptions = {
+    /**
+     * The take-up spool, which sets the time axis: it is held at a constant
+     * rate of revolution, so the paper runs faster as the spool fills.
+     */
+    spool: Spool;
+    /** Constants of the nuancing mechanism, one set for each half of the keyboard. */
+    nuance: Record<Half, Parameters>;
+    /** Constants of the two pedal actions, one of `pedalPresets` or a set of one's own. */
+    pedals: Parameters;
+    velocity: VelocityMap;
+    /**
+     * How the pedals go out: as a continuous controller carrying the travel
+     * of the bellows, or thresholded to the two values a switching renderer
+     * understands.
+     */
+    pedalMode: PedalMode;
+    /** Diameter of the tracker-bar bore. */
+    trackerBore: Millimeters;
+    /** Punch diameter for an edition whose copies record none. */
+    punchDiameter: Millimeters;
+    /**
+     * The track at which the keyboard is divided, so that notes from here
+     * upwards follow the treble expression and the ones below it the bass.
+     * Which side an expression perforation itself belongs to is not decided
+     * here but read off the tracker bar.
+     */
+    division: Track;
+};
+/** Whether two sets of constants are the same, value for value. */
+export declare const sameParameters: (a: Parameters, b: Parameters) => boolean;
+/**
+ * Between the edition's shared place axis and this version's own paper.
+ * `toOwnPaper` is 1 for a version on the axis it was measured on, and about
+ * 0.775 for a green version whose places are in the red axis; see
+ * `RollProperties`.
+ *
+ * Rows are rows of the version's own paper, so the spool is asked in
+ * `paperOfRow` and never in `placeOfRow`: one is the paper that passes the
+ * tracker bar, the other is the coordinate the edition states.
+ */
+export type Paper = {
+    readonly rowOf: (place: Millimeters) => number;
+    readonly placeOfRow: (row: number) => Millimeters;
+    readonly paperOfRow: (row: number) => Millimeters;
+};
+/** When the spool brings a place on the roll to the tracker bar. */
+export declare const secondsAt: (spool: Spool, place: Millimeters) => Seconds;
+/** A perforation as the emulator reads it: the control it operates and the rows it spans. */
+export type WeltePunch = {
+    readonly half: Half;
+    readonly control: string;
+    readonly rowOn: number;
+    readonly rowOff: number;
+};
+export type Ports = ModelInput['ports'];
+/**
+ * What a Welte system puts in front of the shared nuancing unit and pedals:
+ * how it reads a perforation, how it opens the ports, which pneumatic model
+ * drives the bellows, and which the pedals.
+ */
+export type Mechanism<P extends WeltePunch> = {
+    /** The punch the expression is read as, or nothing for one the mechanism does not read. */
+    readonly punchOf: (event: NegotiatedEvent & Expression, rows: {
+        rowOn: number;
+        rowOff: number;
+    }) => P | undefined;
+    readonly portsOf: (grid: Grid, punches: readonly P[], geometry: PortGeometry) => Ports;
+    readonly model: Model;
+    readonly runPedals: (input: PedalInput, params: Parameters) => PedalTravel;
+    /** The name of the instrument the curves say they came from. */
+    readonly instrument: string;
+};
+/** A performance, with the grid and ports it was read off, for a system that has more to ask of them. */
+export type WeltePerformance = Performance & {
+    readonly grid: Grid;
+    readonly ports: Ports;
+};
+/**
+ * Plays the events on a Welte mechanism: notes at the velocity of their half's
+ * bellows, and the two pedals as the travel of theirs.
+ *
+ * The edition's tempo adjustment is left aside: it is stated as a paper
+ * speed, and what the spool holds constant is its rate of revolution, so
+ * the two are not the same quantity. The spool in the options sets the speed.
+ */
+export declare const performWelte: <P extends WeltePunch>(events: readonly NegotiatedEvent[], options: WelteOptions, roll: RollProperties, mechanism: Mechanism<P>) => WeltePerformance;