linked-rolls 0.1.0 → 0.1.1

package/lib/RollCopy.d.ts

@@ -284,8 +284,14 @@ export interface StanfordAtonOptions {
      */
     trackShift?: number;
     bar?: TrackerBar;
+    /**
+     * Where the scan the analysis was made from can be seen. Stanford's
+     * files name their scan by DRUID, so this is only needed for an
+     * analysis of a scan hosted elsewhere.
+     */
+    scan?: string;
 }
-export declare function readFromStanfordAton(atonString: string, { trackShift, bar }?: StanfordAtonOptions): RollCopy;
+export declare function readFromStanfordAton(atonString: string, { trackShift, bar, scan }?: StanfordAtonOptions): RollCopy;
 /**
  * How a MIDI key number in one of Spencer Chase's roll files names a
  * tracker bar track.

package/lib/RollCopy.js

@@ -100,6 +100,21 @@ export const calibrationOf = (copy) => {
 };
 /** Values in these files carry their unit as a suffix, e.g. "37.7646px". */
 const px = (value) => parseFloat(value);
+/** The parser writes one record as an object and several as an array. */
+const listOf = (value) => value === undefined ? [] : Array.isArray(value) ? value : [value];
+/**
+ * Holes the parser set aside as suspicious after it had already chained
+ * them into a note: the head of such a chain is usually a punch that
+ * came out a little short, and leaving it out would lose the whole
+ * chain. They carry no track number of their own, so the column says
+ * which track they sit on.
+ */
+const chainedBadHoles = (holes, calibration) => holes
+    .filter(hole => hole.NOTE_ATTACK && hole.OFF_TIME)
+    .map(hole => ({
+    ...hole,
+    TRACKER_HOLE: `${Math.round((px(hole.CENTROID_COL) - calibration.offset) / calibration.separation)}`
+}));
 const millimeters = (pixels, dpi) => pixels / dpi * 25.4;
 const median = (values) => {
     const sorted = [...values].sort((a, b) => a - b);
@@ -139,13 +154,37 @@ const punchDiameterOf = (holes, dpi) => {
         return undefined;
     return circular.reduce((sum, diameter) => sum + diameter, 0) / circular.length;
 };
-export function readFromStanfordAton(atonString, { trackShift, bar = welteT100 } = {}) {
+/**
+ * The image service Stanford keeps for a scan, and a crop of a
+ * feature from it.
+ */
+const stanfordScan = (druid) => ({
+    scan: `https://stacks.stanford.edu/image/iiif/${druid}%2F${druid}_0001/`,
+    depictionOf: (column, row, width, height) => `https://stacks.stanford.edu/image/iiif/${druid}/${druid}_0001/${column},${row},${width},${height}/128,/270/default.jpg`
+});
+/**
+ * The software behind an analysis and when it was run, as the
+ * analysis file states them.
+ */
+const measuredByOf = (rollinfo) => {
+    const date = new Date(rollinfo.ANALYSIS_DATE);
+    if (!rollinfo.HOLE_SOFTWARE || isNaN(date.getTime()))
+        return undefined;
+    return {
+        software: rollinfo.HOLE_SOFTWARE,
+        version: rollinfo.SOFTWARE_DATE ?? '',
+        date
+    };
+};
+export function readFromStanfordAton(atonString, { trackShift, bar = welteT100, scan } = {}) {
     const parser = new AtonParser();
     const json = parser.parse(atonString);
     const holes = json.ROLLINFO.HOLES.HOLE;
     const druid = json.ROLLINFO.DRUID;
+    const stanford = druid ? stanfordScan(druid) : undefined;
     const separation = px(json.ROLLINFO.HOLE_SEPARATION);
     const dpi = parseFloat(json.ROLLINFO.LENGTH_DPI);
+    const measuredBy = measuredByOf(json.ROLLINFO);
     const rewindTrack = rewindTrackIn(holes);
     const shift = trackShift
         ?? (rewindTrack === undefined ? 0 : bar.rewindTrack - rewindTrack);
@@ -156,8 +195,10 @@ export function readFromStanfordAton(atonString, { trackShift, bar = welteT100 }
         shift
     };
     const punchDiameter = punchDiameterOf(holes, dpi);
-    const features = holes
+    const chains = [...holes, ...chainedBadHoles(listOf(json.ROLLINFO.BADHOLES?.HOLE), calibration)]
         .filter(hole => hole.NOTE_ATTACK && hole.OFF_TIME)
+        .sort((a, b) => px(a.NOTE_ATTACK) - px(b.NOTE_ATTACK));
+    const features = chains
         .map((hole) => {
         const attack = px(hole.NOTE_ATTACK);
         const release = px(hole.OFF_TIME);
@@ -166,7 +207,9 @@ export function readFromStanfordAton(atonString, { trackShift, bar = welteT100 }
         return {
             type: 'Hole',
             id: v4(),
-            depiction: `https://stacks.stanford.edu/image/iiif/${druid}/${druid}_0001/${column},${attack},${columnWidth},${release - attack}/128,/270/default.jpg`,
+            ...(stanford && {
+                depiction: stanford.depictionOf(column, attack, columnWidth, release - attack)
+            }),
             vertical: {
                 from: +hole.TRACKER_HOLE + shift,
                 unit: 'track'
@@ -185,7 +228,7 @@ export function readFromStanfordAton(atonString, { trackShift, bar = welteT100 }
         conditions: [],
         location: '',
         modifications: [],
-        scan: `https://stacks.stanford.edu/image/iiif/${druid}%2F${druid}_0001/`,
+        ...((scan ?? stanford) && { scan: scan ?? stanford?.scan }),
         measurements: {
             dimensions: {
                 width: millimeters(px(json.ROLLINFO.ROLL_WIDTH), dpi),
@@ -204,7 +247,8 @@ export function readFromStanfordAton(atonString, { trackShift, bar = welteT100 }
                 bass: px(json.ROLLINFO.HARD_MARGIN_BASS),
                 unit: 'px'
             },
-            trackCalibration: calibration
+            trackCalibration: calibration,
+            ...(measuredBy && { measuredBy })
         },
         features
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "linked-rolls",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Digital editions of piano rolls: import, collation, editorial assumptions, JSON-LD export, and emulation through a reproducing system",
   "repository": {
     "type": "git",