linked-rolls 0.1.0 → 0.2.0

package/lib/spec/context.json

@@ -1,173 +1,243 @@
 {
     "@context": {
+        "@version": 1.1,
         "xsd": "http://www.w3.org/2001/XMLSchema#",
+        "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
         "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
         "owl": "http://www.w3.org/2002/07/owl#",
         "dcterms": "http://purl.org/dc/terms/",
         "crm": "http://www.cidoc-crm.org/cidoc-crm/",
-        "crmdig": "http://www.ics.forth.gr/isl/CRMdig/",
-        "crminf": "http://www.cidoc-crm.org/cidoc-crm/CRMinf/",
+        "crmdig": "http://www.cidoc-crm.org/extensions/crmdig/",
+        "crminf": "http://www.cidoc-crm.org/extensions/crminf/",
         "lrmoo": "http://iflastandards.info/ns/lrm/lrmoo/",
-        "reo": "http://linked-rolls.org/reo/",
-        "@vocab": "http://linked-rolls.org/reo/",
+        "reo": "https://w3id.org/reo/",
         "Edition": "lrmoo:F2_Expression",
-        "RollCopy": "reo:C1_Witness",
+        "Version": "lrmoo:F2_Expression",
+        "RollCopy": "lrmoo:F5_Item",
+        "Hole": "crm:E26_Physical_Feature",
+        "Mark": "crm:E25_Human-Made_Feature",
+        "Writing": "crm:E25_Human-Made_Feature",
+        "GluedOn": "crm:E22_Human-Made_Object",
         "Addition": "crm:E79_Part_Addition",
         "Removal": "crm:E80_Part_Removal",
-        "title": "crm:P102_has_title",
+        "ConditionState": "crm:E3_Condition_State",
+        "note": "reo:Note",
+        "expression": "reo:Expression",
+        "text": {
+            "@id": "crm:E33_Linguistic_Object",
+            "@context": {
+                "text": "crm:P190_has_symbolic_content"
+            }
+        },
+        "edit": {
+            "@id": "reo:Edit",
+            "@context": {
+                "editType": {
+                    "@id": "crm:P2_has_type",
+                    "@type": "@vocab",
+                    "@context": { "@vocab": "https://w3id.org/reo/type/" }
+                },
+                "motivation": {
+                    "@id": "crm:P17_was_motivated_by",
+                    "@type": "@id"
+                },
+                "insert": "reo:added",
+                "delete": {
+                    "@id": "reo:removed",
+                    "@type": "@id"
+                }
+            }
+        },
+        "motivation": {
+            "@id": "crm:E33_Linguistic_Object",
+            "@context": {
+                "note": "crm:P3_has_note"
+            }
+        },
+        "simpleArgumentation": {
+            "@id": "crminf:I1_Argumentation",
+            "@context": { "note": "crm:P3_has_note" }
+        },
+        "inference": {
+            "@id": "crminf:I5_Inference_Making",
+            "@context": { "note": "crm:P3_has_note" }
+        },
+        "beliefAdoption": {
+            "@id": "crminf:I7_Belief_Adoption",
+            "@context": { "note": "crm:P3_has_note" }
+        },
+        "meaningComprehension": {
+            "@id": "crminf:I16_Meaning_Comprehension",
+            "@context": { "note": "crm:P3_has_note" }
+        },
+        "title": "dcterms:title",
         "license": {
             "@id": "dcterms:license",
             "@type": "@id"
         },
+        "creation": "lrmoo:R17i_was_created_by",
+        "publisher": "crm:P14_carried_out_by",
+        "publicationDate": {
+            "@id": "dcterms:date",
+            "@type": "xsd:date"
+        },
+        "collationTolerance": null,
+        "roll": "lrmoo:R3i_realises",
+        "catalogueNumber": "dcterms:identifier",
+        "system": "crm:P2_has_type",
+        "recordingEvent": "lrmoo:R19i_was_realised_through",
+        "recorded": "lrmoo:R81_recorded",
+        "pianist": "crm:P14_carried_out_by",
+        "playing": {
+            "@id": "lrmoo:R80_performed",
+            "@type": "@id"
+        },
+        "place": "crm:P7_took_place_at",
+        "date": {
+            "@id": "dcterms:date",
+            "@type": "xsd:date"
+        },
+        "created": "lrmoo:R17_created",
+        "copies": "reo:witness",
+        "versions": "lrmoo:R75_incorporates",
+        "tempoAdjustment": {
+            "@id": "reo:tempo",
+            "@context": {
+                "startsWith": "reo:from",
+                "endsWith": "reo:to"
+            }
+        },
         "name": "rdfs:label",
         "sameAs": {
             "@id": "owl:sameAs",
             "@type": "@id"
         },
-        "role": "crm:P2_has_type",
-        "date": "crm:P4_has_time-span",
-        "actor": "crm:P14_carried_out_by",
+        "role": {
+            "@id": "crm:P2_has_type",
+            "@type": "@vocab",
+            "@context": { "@vocab": "https://w3id.org/reo/type/" }
+        },
+        "ops": null,
+        "measurements": {
+            "@id": "crm:P39i_was_measured_by",
+            "@context": {
+                "shift": null,
+                "trackCalibration": null,
+                "margins": null,
+                "dimensions": "reo:dimensions",
+                "width": "reo:width",
+                "height": "reo:height",
+                "punchDiameter": "reo:punchDiameter",
+                "holeSeparation": "reo:holeSeparation",
+                "value": "crm:P90_has_value",
+                "measuredBy": "crmdig:L23_used_software_or_firmware",
+                "software": "rdfs:label",
+                "version": "owl:versionInfo"
+            }
+        },
+        "production": "lrmoo:R28i_was_produced_by",
+        "company": "crm:P14_carried_out_by",
+        "paper": "crm:P126_employed",
+        "conditions": "crm:P44_has_condition",
+        "condition": "crm:P44_has_condition",
+        "conditionType": {
+            "@id": "crm:P2_has_type",
+            "@type": "@vocab",
+            "@context": { "@vocab": "https://w3id.org/reo/type/" }
+        },
         "description": "crm:P3_has_note",
+        "factor": "rdf:value",
+        "keeper": "crm:P50_has_current_keeper",
+        "features": "crm:P56_bears_feature",
+        "modifications": "crm:P31i_was_modified_by",
+        "scan": {
+            "@id": "crm:P138i_has_representation",
+            "@type": "@id"
+        },
         "depiction": {
-            "@id": "crm:P62i_is_depicted_by",
+            "@id": "crm:P138i_has_representation",
             "@type": "@id"
         },
         "horizontal": "crm:P43_has_dimension",
         "vertical": "crm:P43_has_dimension",
-        "unit": "crm:P91_has_unit",
-        "scan": {
-            "@id": "crm:P138i_has_representation",
+        "from": "reo:from",
+        "to": "reo:to",
+        "unit": {
+            "@id": "crm:P91_has_unit",
+            "@type": "@vocab",
+            "@context": { "@vocab": "https://w3id.org/reo/type/" }
+        },
+        "pattern": {
+            "@id": "reo:pattern",
+            "@type": "@vocab",
+            "@context": { "@vocab": "https://w3id.org/reo/type/" }
+        },
+        "method": {
+            "@id": "crm:P2_has_type",
+            "@type": "@vocab",
+            "@context": { "@vocab": "https://w3id.org/reo/type/" }
+        },
+        "transcription": "crm:P128_carries",
+        "material": {
+            "@id": "crm:P45_consists_of",
+            "@type": "@vocab",
+            "@context": { "@vocab": "https://w3id.org/reo/type/" }
+        },
+        "actor": "crm:P14_carried_out_by",
+        "added": {
+            "@id": "crm:P111_added",
             "@type": "@id"
         },
-        "carriers": {
-            "@id": "crm:P128i_is_carried_by",
+        "removed": {
+            "@id": "crm:P113_removed",
             "@type": "@id"
         },
-        "pitch": "reo:P5_has_pitch",
-        "scope": "reo:P6_has_scope",
-        "expressionType": "crm:P2_has_type",
-        "alignedWith": "reo:P3_aligned_with",
-        "material": "crm:P45_consists_of",
-        "condition": "crm:P44_has_condition",
-        "creation": {
-            "@id": "lrmoo:R17i_was_created_by",
-            "@context": {
-                "publisher": "crm:P14_carried_out_by",
-                "publicationDate": {
-                    "@id": "crm:P4_has_time-span",
-                    "@type": "xsd:date"
-                },
-                "collationTolerance": "crmdig:L13_used_parameters"
-            }
+        "purpose": {
+            "@id": "crm:P21_had_general_purpose",
+            "@type": "@vocab",
+            "@context": { "@vocab": "https://w3id.org/reo/type/" }
         },
-        "roll": {
-            "@id": "lrmoo:R3i_realises",
-            "@context": {
-                "catalogueNumber": "crm:P1_is_identified_by",
-                "recordingEvent": {
-                    "@id": "lrmoo:R19i_was_realised_through",
-                    "@context": {
-                        "recorded": {
-                            "@id": "lrmoo:R81_recorded",
-                            "@context": {
-                                "pianist": "crm:P14_carried_out_by",
-                                "playing": {
-                                    "@type": "@id"
-                                }
-                            }
-                        },
-                        "place": "crm:P7_took_place_at",
-                        "created": "lrmoo:R17_created"
-                    }
-                }
-            }
+        "siglum": "reo:siglum",
+        "versionType": {
+            "@id": "crm:P2_has_type",
+            "@type": "@vocab",
+            "@context": { "@vocab": "https://w3id.org/reo/type/" }
         },
-        "copies": {
-            "@id": "lrmoo:R2_is_derivative_of",
-            "@context": {
-                "location": "crm:P55_has_current_location",
-                "production": {
-                    "@id": "lrmoo:R28i_was_produced_by",
-                    "@context": {
-                        "company": "crm:P14_carried_out_by",
-                        "paper": "crm:P126_employed"
-                    }
-                },
-                "conditions": "crm:P44_has_condition",
-                "modifications": {
-                    "@id": "crm:P31i_was_modified_by",
-                    "@context": {
-                        "added": "crm:P111_added",
-                        "removed": "crm:P113_removed",
-                        "purpose": "crm:P21_had_general_purpose"
-                    }
-                },
-                "measurements": {
-                    "@id": "crm:P39i_was_measured_by",
-                    "@context": {
-                        "measuredBy": {
-                            "@context": {
-                                "software": "crmdig:L23_used_software_or_firmware"
-                            }
-                        }
-                    }
-                },
-                "features": {
-                    "@id": "crm:P56_bears_feature",
-                    "@context": {
-                        "method": "crm:P2_has_type",
-                        "transcription": "crm:P128_carries",
-                        "pattern": "crm:P2_has_type",
-                        "features": "crm:P56_bears_feature"
-                    }
-                }
-            }
+        "basedOn": "lrmoo:R76_is_derivative_of",
+        "edits": "reo:involvedEdit",
+        "motivations": "@included",
+        "carriers": "crm:P128i_is_carried_by",
+        "alignedWith": "reo:alignedWith",
+        "pairedWith": "reo:pairedWith",
+        "pitch": {
+            "@id": "reo:pitch",
+            "@type": "xsd:integer"
         },
-        "versions": {
-            "@id": "lrmoo:R76_is_derivative_of",
-            "@context": {
-                "siglum": "reo:P22_is_identified_by",
-                "basedOn": {
-                    "@id": "reo:P10i_is_based_on",
-                    "@type": "@id"
-                },
-                "motivations": "@included",
-                "edits": {
-                    "@id": "reo:P16_involved_edit",
-                    "@context": {
-                        "editType": "crm:P2_has_type",
-                        "motivation": {
-                            "@id": "crm:P17_was_motivated_by",
-                            "@type": "@id"
-                        },
-                        "insert": "reo:P7_added",
-                        "delete": {
-                            "@id": "reo:P8_removed",
-                            "@type": "@id"
-                        }
-                    }
-                }
-            }
+        "scope": {
+            "@id": "reo:scope",
+            "@type": "@vocab",
+            "@context": { "@vocab": "https://w3id.org/reo/type/" }
+        },
+        "expressionType": {
+            "@id": "crm:P2_has_type",
+            "@type": "@vocab",
+            "@context": { "@vocab": "https://w3id.org/reo/type/" }
         },
         "belief": {
-            "@id": "crminf:J4i_is_subject_to",
+            "@id": "crminf:J4i_is_subject_of",
             "@context": {
                 "belief": "crminf:I2_Belief",
                 "certainty": "crminf:J5_holds_to_be",
-                "reasons": {
-                    "@id": "crminf:J2i_was_concluded_by",
-                    "@context": {
-                        "comprehends": {
-                            "@id": "crminf:J22_interpreted_meaning_of",
-                            "@type": "@id"
-                        },
-                        "premises": {
-                            "@id": "crminf:J1_used_as_premise",
-                            "@type": "@id"
-                        }
-                    }
-                }
+                "reasons": "crminf:J2i_was_concluded_by"
             }
+        },
+        "comprehends": {
+            "@id": "crminf:J22_interpreted_meaning_of",
+            "@type": "@id"
+        },
+        "premises": {
+            "@id": "crminf:J1_used_as_premise",
+            "@type": "@id"
         }
     }
 }

package/lib/spec/welte-t100.context.json

@@ -0,0 +1,10 @@
+{
+    "@context": {
+        "@version": 1.1,
+        "expressionType": {
+            "@id": "http://www.cidoc-crm.org/cidoc-crm/P2_has_type",
+            "@type": "@vocab",
+            "@context": { "@vocab": "https://w3id.org/reo/type/welte-t100/" }
+        }
+    }
+}

package/lib/systems/welteT100.js

@@ -14,22 +14,24 @@ export const defaultWelteT100Options = {
     division: 54
 };
 /** What each expression code operates, in the emulator's terms. */
-const CODES = new Map([
-    ['MezzoforteOn', ['mezzoforte', 'on']],
-    ['MezzoforteOff', ['mezzoforte', 'off']],
-    ['SlowCrescendoOn', ['crescendo', 'on']],
-    ['SlowCrescendoOff', ['crescendo', 'off']],
-    ['ForzandoOn', ['sforzando', 'on']],
-    ['ForzandoOff', ['sforzando', 'off']],
-    ['SustainPedalOn', ['sustainPedal', 'on']],
-    ['SustainPedalOff', ['sustainPedal', 'off']],
-    ['SoftPedalOn', ['hammerRail', 'on']],
-    ['SoftPedalOff', ['hammerRail', 'off']],
-    ['MotorOn', ['windResistance', 'on']],
-    ['MotorOff', ['windResistance', 'off']],
-    ['Rewind', ['rewind', 'on']],
-    ['ElectricCutOff', ['electricCutoff', 'on']]
-]);
+const CODES = {
+    MezzoforteOn: ['mezzoforte', 'on'],
+    MezzoforteOff: ['mezzoforte', 'off'],
+    SlowCrescendoOn: ['crescendo', 'on'],
+    SlowCrescendoOff: ['crescendo', 'off'],
+    ForzandoOn: ['sforzando', 'on'],
+    ForzandoOff: ['sforzando', 'off'],
+    SustainPedalOn: ['sustainPedal', 'on'],
+    SustainPedalOff: ['sustainPedal', 'off'],
+    SoftPedalOn: ['hammerRail', 'on'],
+    SoftPedalOff: ['hammerRail', 'off'],
+    MotorOn: ['windResistance', 'on'],
+    MotorOff: ['windResistance', 'off'],
+    Rewind: ['rewind', 'on'],
+    ElectricCutOff: ['electricCutoff', 'on']
+};
+const isWelteT100ExpressionType = (type) => Object.hasOwn(CODES, type);
+const codeOf = (expressionType) => isWelteT100ExpressionType(expressionType) ? CODES[expressionType] : undefined;
 /** Paper the grid runs on past the last hole, so that a final pedal release completes. */
 const RUN_OUT_MM = 100;
 /**
@@ -51,7 +53,7 @@ const rowOf = (mm) => mm * ROWS_PER_MM;
 export const secondsAt = (spool, mm) => paperSeconds(spool, mm / 10);
 const halfOf = (note, division) => note.vertical.from >= division ? 'treble' : 'bass';
 const readingOf = (event) => {
-    const code = CODES.get(event.expressionType);
+    const code = codeOf(event.expressionType);
     const half = scopeOf(event);
     if (!code || !half)
         return undefined;

package/lib/validate.d.ts

@@ -1,3 +1,29 @@
 import { Edition } from "./Edition";
+import { EditionView } from "./EditionView";
+import { TrackerBar } from "./TrackerBar";
 declare const validate: import("ajv").ValidateFunction<Edition>;
 export { validate };
+export type ConstraintProblem = {
+    version: string;
+    symbol: string;
+    problem: 'alignment-reference-missing' | 'partner-missing' | 'paired-with-itself' | 'in-several-pairs' | 'pair-aligned-on-both-sides';
+};
+/**
+ * Where the alignments and pairings of the edition cannot hold as
+ * stated, version by version: a reference or partner absent from the
+ * version, a perforation claimed by several pairs, or a pair whose
+ * members are both aligned and so cannot keep their distance and
+ * follow their references at once.
+ */
+export declare const constraintProblems: (view: EditionView) => ConstraintProblem[];
+export type UnknownExpressionType = {
+    version: string;
+    symbol: string;
+    expressionType: string;
+};
+/**
+ * The expressions of the edition whose type the tracker bar does not
+ * read, version by version. The roll names its system; a type from
+ * another system, or a misspelt one, means nothing on it.
+ */
+export declare const unknownExpressionTypes: (view: EditionView, bar: TrackerBar) => UnknownExpressionType[];

package/lib/validate.js

@@ -1,5 +1,7 @@
 import Ajv from "ajv";
 import * as schema from "./schema.json";
+import { idOf } from "./Assumption";
+import { pairsAmong } from "./Symbol";
 const ajv = new Ajv({
     strict: false,
     formats: {
@@ -8,3 +10,47 @@ const ajv = new Ajv({
 });
 const validate = ajv.compile(schema);
 export { validate };
+const isPerforation = (symbol) => symbol.type !== 'text';
+const problemsIn = (version, perforations) => {
+    const ids = new Set(perforations.map(p => p.id));
+    const report = (symbol, problem) => ({ version, symbol, problem });
+    const missingReferences = perforations
+        .filter(p => p.alignedWith && !ids.has(idOf(p.alignedWith)))
+        .map(p => report(p.id, 'alignment-reference-missing'));
+    const missingPartners = perforations
+        .filter(p => p.pairedWith && !ids.has(idOf(p.pairedWith)))
+        .map(p => report(p.id, 'partner-missing'));
+    const selfPaired = perforations
+        .filter(p => p.pairedWith && idOf(p.pairedWith) === p.id)
+        .map(p => report(p.id, 'paired-with-itself'));
+    const pairs = pairsAmong(perforations);
+    const pairsOf = (p) => pairs.filter(pair => pair.includes(p));
+    const inSeveralPairs = perforations
+        .filter(p => pairsOf(p).length > 1)
+        .map(p => report(p.id, 'in-several-pairs'));
+    const alignedOnBothSides = pairs
+        .filter(([one, other]) => one.alignedWith && other.alignedWith)
+        .flatMap(pair => pair.map(p => report(p.id, 'pair-aligned-on-both-sides')));
+    return [...missingReferences, ...missingPartners, ...selfPaired, ...inSeveralPairs, ...alignedOnBothSides];
+};
+/**
+ * Where the alignments and pairings of the edition cannot hold as
+ * stated, version by version: a reference or partner absent from the
+ * version, a perforation claimed by several pairs, or a pair whose
+ * members are both aligned and so cannot keep their distance and
+ * follow their references at once.
+ */
+export const constraintProblems = (view) => view.edition.versions.flatMap(version => problemsIn(version.id, view.snapshot(version.id).filter(isPerforation)));
+const isExpression = (symbol) => symbol.type === 'expression';
+/**
+ * The expressions of the edition whose type the tracker bar does not
+ * read, version by version. The roll names its system; a type from
+ * another system, or a misspelt one, means nothing on it.
+ */
+export const unknownExpressionTypes = (view, bar) => {
+    const known = new Set(bar.expressionTypes);
+    return view.edition.versions.flatMap(version => view.snapshot(version.id)
+        .filter(isExpression)
+        .filter(symbol => !known.has(symbol.expressionType))
+        .map(symbol => ({ version: version.id, symbol: symbol.id, expressionType: symbol.expressionType })));
+};

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "linked-rolls",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Digital editions of piano rolls: import, collation, editorial assumptions, JSON-LD export, and emulation through a reproducing system",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/pfefferniels/linked-rolls.git"