linked-rolls 0.5.1 → 0.7.0

package/README.md

@@ -47,12 +47,17 @@ The first system is the red Welte, `linked-rolls/welte-t100`, built on
 [welte-t100-emulator](https://github.com/pfefferniels/welte-t100): the
 take-up spool sets the time axis, the Nuancierbälge fill through their
 conduits and are arrested by the Mezzoforte pin, and the two pedals travel
-rather than switch. The constants are those fitted against the hand-drawn
-nuance lines of roll 3309, with the terms that describe the drawing
-apparatus switched off. What the emulator does not determine is how
-bellows travel maps onto MIDI velocity; `WelteT100Options.velocity`
-anchors that map at the open rail, the Mezzoforte pin and the closed rail,
-and its defaults are midi2exp's.
+rather than switch. The nuancing constants come as `instruments`: the
+consensus fitted across the hand-drawn nuance lines of six rolls, which
+is the default, and the setting that drew each of those rolls, named by
+its Welte number, all with the terms that describe the drawing apparatus
+switched off. The pedals leave no drawn line, so their constants
+come as two readings, `pedalPresets.damping`, under which every lift the
+rolls punch damps, and `pedalPresets.brushing`, under which the quick runs
+of latch changes brush the strings without damping. What the emulator does
+not determine is how bellows travel maps onto MIDI velocity;
+`WelteT100Options.velocity` anchors that map at the open rail, the
+Mezzoforte pin and the closed rail, and its defaults are midi2exp's.
 
 ```ts
 import { Emulation } from 'linked-rolls'

package/lib/Feature.d.ts

@@ -116,6 +116,8 @@ export declare const writingMethods: readonly ["Print", "Handwriting", "Stamp"];
  * printed, handwritten, or stamped.
  */
 export type WritingMethod = typeof writingMethods[number];
+/** The text a writing carries. It names no carriers of its own, the writing being its carrier. */
+export type Transcription = Omit<Text, 'carriers'>;
 /**
  * A piece of writing found on the roll, such as a label,
  * catalogue number, or annotation. Writings have a method
@@ -135,7 +137,7 @@ export interface Writing extends Trace<'Writing'> {
      * can be annotated with a belief about its correctness.
      * @see crm:P128 carries
      */
-    transcription: ObjectAssumption<Omit<Text, 'carriers'>>;
+    transcription: ObjectAssumption<Transcription>;
 }
 /**
  * A visible mark on the roll, such as a pencil mark,

package/lib/schema.json

@@ -1189,7 +1189,7 @@
             ],
             "type": "object"
         },
-        "ObjectAssumption<alias-731470504-73739-73887-731470504-0-217694<def-interface-src_Symbol.ts-5758-6122-src_Symbol.ts-0-6378400334313,\"carriers\">>": {
+        "ObjectAssumption<Transcription>": {
             "description": "An object assumption wraps a complex object with an optional annotation. Used for structured values (e.g. persons, conditions) whose properties may be uncertain.",
             "properties": {
                 "@annotation": {
@@ -1760,7 +1760,7 @@
                     "description": "The method by which this writing was produced (e.g. through print, handwriting, or stamping). [ontology: crm:P2 has type]"
                 },
                 "transcription": {
-                    "$ref": "#/definitions/ObjectAssumption%3Calias-731470504-73739-73887-731470504-0-217694%3Cdef-interface-src_Symbol.ts-5758-6122-src_Symbol.ts-0-6378400334313%2C%22carriers%22%3E%3E",
+                    "$ref": "#/definitions/ObjectAssumption%3CTranscription%3E",
                     "description": "A transcription of the text content of the writing. This is an object assumption so that the transcription can be annotated with a belief about its correctness. [ontology: crm:P128 carries]"
                 },
                 "vertical": {

package/lib/systems/welteT100/system.d.ts

@@ -1,4 +1,4 @@
-import { Half, Parameters, PedalMode, Spool } from "welte-t100-emulator";
+import { Half, Instrument, Parameters, PedalMode, RollNumber, Spool } from "welte-t100-emulator";
 import { ReproducingSystem } from "../../ReproducingSystem";
 /**
  * MIDI velocity at the open rail of the Nuancierbalg, at the Mezzoforte pin,
@@ -12,15 +12,45 @@ export type VelocityMap = {
     mezzoforte: number;
     forte: number;
 };
+export type { Instrument } from "welte-t100-emulator";
+export type InstrumentName = 'consensus' | RollNumber;
+/**
+ * The instruments the emulator was fitted as: the consensus over the six
+ * rolls with drawn nuance lines, and the setting that drew each of them,
+ * named by the roll's Welte number. The provenance beside each says what
+ * it was fitted to and how well.
+ */
+export declare const instruments: Readonly<Record<InstrumentName, Instrument>>;
+/** The instruments by name, the consensus first. */
+export declare const instrumentNames: readonly InstrumentName[];
+/** The nuancing constants of an instrument, one set for each half of the keyboard. */
+export declare const nuanceOf: (instrument: Instrument) => Record<Half, Parameters>;
+/** The instrument a pair of nuancing constants belongs to, if it is one. */
+export declare const instrumentNameOf: (nuance: Record<Half, Parameters>) => InstrumentName | undefined;
+/**
+ * The two readings of the pedal mechanism the emulator offers, by name.
+ * Under `damping` the dampers reach the strings within the shortest lift
+ * the rolls punch, so every lift damps. Under `brushing` their fall is
+ * slowed until the quick runs of latch changes in the SUPRA corpus dip
+ * without damping, at the price that lifts shorter than about 265 ms brush
+ * as well.
+ */
+export declare const pedalPresets: {
+    damping: Readonly<Record<string, number>>;
+    brushing: Readonly<Record<string, number>>;
+};
+export type PedalPreset = keyof typeof pedalPresets;
+/** The preset a set of pedal constants is, if it is one. */
+export declare const pedalPresetOf: (pedals: Parameters) => PedalPreset | undefined;
 export type WelteT100Options = {
     /**
      * 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. */
+    /** Constants of the nuancing mechanism, one set for each half of the keyboard: `nuanceOf` an instrument, or a set of one's own. */
     nuance: Record<Half, Parameters>;
-    /** Constants of the two pedal actions. */
+    /** Constants of the two pedal actions, one of `pedalPresets` or a set of one's own. */
     pedals: Parameters;
     velocity: VelocityMap;
     /**
@@ -48,8 +78,8 @@ export declare const secondsAt: (spool: Spool, mm: number) => number;
  * The red Welte, as welte-t100-emulator models it: the take-up spool sets
  * the time axis, the Nuancierbälge fill through their conduits and are
  * arrested by the Mezzoforte pin, and the two pedals travel rather than
- * switch. The constants are those fitted against the hand-drawn nuance
- * lines of roll 3309, with the terms that describe the drawing apparatus
- * switched off.
+ * switch. The constants are the consensus fitted across the hand-drawn
+ * nuance lines of six rolls, with the terms that describe the drawing
+ * apparatus switched off; `instruments` offers each roll's own setting.
  */
 export declare const welteT100System: ReproducingSystem<WelteT100Options>;

package/lib/systems/welteT100/system.js

@@ -1,12 +1,38 @@
-import { aperturePorts, DEFAULT_PUNCH_MM, geometryInMm, Grid, levelChanges, mezzoforteTravel, paperSeconds, pedalDefaults, playbackParameters, pneumaticModel, ROWS_PER_MM, runPedals, TRACKER_BORE_MM, travelBetweenRails, WELTE_SPOOL, } from "welte-t100-emulator";
+import { aperturePorts, CONSENSUS, DEFAULT_PUNCH_MM, geometryInMm, Grid, levelChanges, mezzoforteTravel, paperSeconds, pedalBrushing, pedalDefaults, pneumaticModel, PRESETS, ROWS_PER_MM, runPedals, TRACKER_BORE_MM, travelBetweenRails, WELTE_SPOOL, } from "welte-t100-emulator";
 import { welteT100 } from "./bar";
+/**
+ * The instruments the emulator was fitted as: the consensus over the six
+ * rolls with drawn nuance lines, and the setting that drew each of them,
+ * named by the roll's Welte number. The provenance beside each says what
+ * it was fitted to and how well.
+ */
+export const instruments = { consensus: CONSENSUS, ...PRESETS };
+/** The instruments by name, the consensus first. */
+export const instrumentNames = ['consensus', ...Object.keys(PRESETS)];
+const sameParameters = (a, b) => Object.keys(a).length === Object.keys(b).length
+    && Object.entries(a).every(([name, value]) => b[name] === value);
+/** The nuancing constants of an instrument, one set for each half of the keyboard. */
+export const nuanceOf = (instrument) => ({ bass: instrument.bass, treble: instrument.treble });
+/** The instrument a pair of nuancing constants belongs to, if it is one. */
+export const instrumentNameOf = (nuance) => instrumentNames.find(name => sameParameters(instruments[name].bass, nuance.bass) && sameParameters(instruments[name].treble, nuance.treble));
+/**
+ * The two readings of the pedal mechanism the emulator offers, by name.
+ * Under `damping` the dampers reach the strings within the shortest lift
+ * the rolls punch, so every lift damps. Under `brushing` their fall is
+ * slowed until the quick runs of latch changes in the SUPRA corpus dip
+ * without damping, at the price that lifts shorter than about 265 ms brush
+ * as well.
+ */
+export const pedalPresets = {
+    damping: pedalDefaults,
+    brushing: pedalBrushing
+};
+/** The preset a set of pedal constants is, if it is one. */
+export const pedalPresetOf = (pedals) => Object.keys(pedalPresets).find(name => sameParameters(pedalPresets[name], pedals));
 export const defaultWelteT100Options = {
     spool: WELTE_SPOOL,
-    nuance: {
-        bass: playbackParameters('bass'),
-        treble: playbackParameters('treble')
-    },
-    pedals: pedalDefaults,
+    nuance: nuanceOf(instruments.consensus),
+    pedals: pedalPresets.damping,
     velocity: { piano: 35, mezzoforte: 60, forte: 90 },
     pedalMode: 'continuous',
     trackerBore: TRACKER_BORE_MM,
@@ -172,9 +198,9 @@ const perform = (events, options, roll) => {
  * The red Welte, as welte-t100-emulator models it: the take-up spool sets
  * the time axis, the Nuancierbälge fill through their conduits and are
  * arrested by the Mezzoforte pin, and the two pedals travel rather than
- * switch. The constants are those fitted against the hand-drawn nuance
- * lines of roll 3309, with the terms that describe the drawing apparatus
- * switched off.
+ * switch. The constants are the consensus fitted across the hand-drawn
+ * nuance lines of six rolls, with the terms that describe the drawing
+ * apparatus switched off; `instruments` offers each roll's own setting.
  */
 export const welteT100System = {
     name: 'Welte-Mignon T100',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "linked-rolls",
-  "version": "0.5.1",
+  "version": "0.7.0",
   "description": "Digital editions of piano rolls: import, collation, editorial assumptions, JSON-LD export, and emulation through a reproducing system",
   "license": "MIT",
   "repository": {
@@ -41,7 +41,7 @@
     "welte-t100-emulator": "file:../welte-t100"
   },
   "peerDependencies": {
-    "welte-t100-emulator": "^0.3.0"
+    "welte-t100-emulator": "^0.4.0"
   },
   "peerDependenciesMeta": {
     "welte-t100-emulator": {