@file-viewer/renderer-dicom 3.0.0

package/dist/inspect.js

@@ -0,0 +1,95 @@
+import * as dicomParser from 'dicom-parser';
+const MEBIBYTE = 1024 * 1024;
+export const DEFAULT_DICOM_LIMITS = Object.freeze({
+    maxSourceBytes: 64 * MEBIBYTE,
+    maxFrames: 256,
+    maxFramePixels: 16000000,
+    maxTotalPixels: 48000000,
+});
+/** Transfer syntaxes accepted by this tested MVP (intentionally narrower than the loader). */
+export const SUPPORTED_DICOM_TRANSFER_SYNTAXES = new Set([
+    '1.2.840.10008.1.2',
+    '1.2.840.10008.1.2.1',
+    '1.2.840.10008.1.2.4.70',
+    '1.2.840.10008.1.2.4.80',
+    '1.2.840.10008.1.2.4.90',
+]);
+const finitePositiveInteger = (value, label) => {
+    const number = typeof value === 'number' ? value : Number.parseInt(String(value || ''), 10);
+    if (!Number.isSafeInteger(number) || number < 1) {
+        throw new Error(`DICOM ${label} must be a positive integer.`);
+    }
+    return number;
+};
+const finiteNumber = (value, fallback) => {
+    const number = typeof value === 'number' ? value : Number.parseFloat(String(value || ''));
+    return Number.isFinite(number) ? number : fallback;
+};
+const resolveLimits = (limits) => {
+    const resolved = { ...DEFAULT_DICOM_LIMITS };
+    for (const key of Object.keys(DEFAULT_DICOM_LIMITS)) {
+        if ((limits === null || limits === void 0 ? void 0 : limits[key]) === undefined)
+            continue;
+        resolved[key] = finitePositiveInteger(limits[key], key);
+    }
+    return resolved;
+};
+const hasPart10Signature = (buffer) => {
+    if (buffer.byteLength < 132)
+        return false;
+    const bytes = new Uint8Array(buffer, 128, 4);
+    return bytes[0] === 0x44 && bytes[1] === 0x49 && bytes[2] === 0x43 && bytes[3] === 0x4d;
+};
+export const inspectDicomPart10 = (buffer, limitsInput) => {
+    const limits = resolveLimits(limitsInput);
+    if (buffer.byteLength < 132 || buffer.byteLength > limits.maxSourceBytes) {
+        throw new Error(`DICOM source size must be between 132 bytes and ${limits.maxSourceBytes} bytes.`);
+    }
+    if (!hasPart10Signature(buffer)) {
+        throw new Error('The selected file is not a DICOM Part 10 file (missing DICM signature).');
+    }
+    let dataSet;
+    try {
+        dataSet = dicomParser.parseDicom(new Uint8Array(buffer), { untilTag: 'x7fe00010' });
+    }
+    catch {
+        throw new Error('Unable to parse the DICOM Part 10 header.');
+    }
+    const transferSyntax = String(dataSet.string('x00020010') || '').trim();
+    if (!SUPPORTED_DICOM_TRANSFER_SYNTAXES.has(transferSyntax)) {
+        throw new Error(`DICOM transfer syntax ${transferSyntax || '(missing)'} is not supported by this preview renderer.`);
+    }
+    if (!dataSet.elements.x7fe00010) {
+        throw new Error('The DICOM file has no pixel data element.');
+    }
+    const rows = finitePositiveInteger(dataSet.uint16('x00280010'), 'rows');
+    const columns = finitePositiveInteger(dataSet.uint16('x00280011'), 'columns');
+    const samplesPerPixel = finitePositiveInteger(dataSet.uint16('x00280002') || 1, 'samples per pixel');
+    const frameCount = finitePositiveInteger(dataSet.intString('x00280008') || 1, 'frame count');
+    if (frameCount > limits.maxFrames) {
+        throw new Error(`DICOM frame count ${frameCount} exceeds the configured limit ${limits.maxFrames}.`);
+    }
+    if (rows > limits.maxFramePixels / columns / samplesPerPixel) {
+        throw new Error(`DICOM frame dimensions exceed the configured ${limits.maxFramePixels}-pixel limit.`);
+    }
+    const framePixels = rows * columns * samplesPerPixel;
+    if (framePixels > limits.maxTotalPixels / frameCount) {
+        throw new Error(`DICOM decoded pixels exceed the configured ${limits.maxTotalPixels}-pixel total limit.`);
+    }
+    const bitsAllocated = finitePositiveInteger(dataSet.uint16('x00280100'), 'bits allocated');
+    if (![1, 8, 16, 32].includes(bitsAllocated)) {
+        throw new Error(`DICOM Bits Allocated value ${bitsAllocated} is not supported.`);
+    }
+    return {
+        bitsAllocated,
+        columns,
+        frameCount,
+        modality: String(dataSet.string('x00080060') || 'OT').trim().slice(0, 16),
+        photometricInterpretation: String(dataSet.string('x00280004') || '').trim().slice(0, 32),
+        rows,
+        samplesPerPixel,
+        transferSyntax,
+        windowCenter: finiteNumber(dataSet.floatString('x00281050', 0), (2 ** bitsAllocated) / 2),
+        windowWidth: Math.max(1, finiteNumber(dataSet.floatString('x00281051', 0), 2 ** bitsAllocated)),
+    };
+};

package/file-viewer.capability.json

@@ -0,0 +1,94 @@
+{
+  "$schema": "../../../ecosystem/capability-manifest.schema.json",
+  "schemaVersion": 1,
+  "id": "dicom",
+  "packageName": "@file-viewer/renderer-dicom",
+  "activation": {
+    "kind": "renderer-export",
+    "import": "@file-viewer/renderer-dicom",
+    "export": "dicomRenderer"
+  },
+  "rendererIds": [
+    "dicom"
+  ],
+  "formats": [
+    "dcm",
+    "dicom"
+  ],
+  "assets": {
+    "rendererIds": []
+  },
+  "license": {
+    "spdx": "Apache-2.0",
+    "policy": "permissive",
+    "notices": [
+      {
+        "packageName": "@cornerstonejs/core",
+        "spdx": "MIT",
+        "notice": "Pinned at 5.8.2; full closure and packaged license filenames are recorded in THIRD_PARTY_LICENSES.json."
+      },
+      {
+        "packageName": "@cornerstonejs/dicom-image-loader",
+        "spdx": "MIT",
+        "notice": "Pinned at 5.8.2. JavaScript codec wrapper terms and the separately tracked native libraries statically linked into their WebAssembly are recorded in THIRD_PARTY_LICENSES.json."
+      },
+      {
+        "packageName": "CharLS native codec",
+        "spdx": "BSD-3-Clause",
+        "notice": "Source 38d95d00671f4cddfa61f3f51eaf81b8bac34543; linked target charls; exact license is packaged under third-party/native-codecs/charls."
+      },
+      {
+        "packageName": "libjpeg-turbo native codec",
+        "spdx": "IJG AND BSD-3-Clause AND Zlib",
+        "notice": "Source dc4a93fab38b42d29b89a533409e012570180e28; linked target turbojpeg-static. This software is based in part on the work of the Independent JPEG Group. LICENSE.md and README.ijg are packaged unmodified."
+      },
+      {
+        "packageName": "OpenJPEG native codec",
+        "spdx": "BSD-2-Clause",
+        "notice": "Source 2d606701e8b7aa83f657d113c3367508e99bd12b; linked target openjp2; exact license is packaged under third-party/native-codecs/openjpeg."
+      },
+      {
+        "packageName": "OpenJPH native codec",
+        "spdx": "BSD-2-Clause",
+        "notice": "Source e01c7b7f9e7ecbb15cf13bb45661c9a41ab7fec6; linked target openjphsimd; exact license is packaged under third-party/native-codecs/openjph."
+      },
+      {
+        "packageName": "@cornerstonejs/metadata",
+        "spdx": "MIT",
+        "notice": "Pinned at 5.8.2; used for owner-specific DICOM metadata cleanup."
+      },
+      {
+        "packageName": "dicom-parser",
+        "spdx": "MIT",
+        "notice": "Pinned at 1.8.21; used for bounded Part 10 header inspection before runtime initialization."
+      },
+      {
+        "packageName": "@kitware/vtk.js",
+        "spdx": "BSD-3-Clause",
+        "notice": "Transitive Cornerstone runtime dependency pinned at 36.4.1."
+      },
+      {
+        "packageName": "caniuse-lite",
+        "spdx": "CC-BY-4.0",
+        "notice": "Version 1.0.30001810 data by Ben Briggs and contributors; source https://github.com/browserslist/caniuse-lite; unmodified by this renderer."
+      },
+      {
+        "packageName": "pako",
+        "spdx": "(MIT AND Zlib)",
+        "notice": "Versions 1.0.11 and 2.1.0 contain zlib-derived code by Jean-loup Gailly and Mark Adler."
+      },
+      {
+        "packageName": "argparse",
+        "spdx": "Python-2.0",
+        "notice": "Version 2.0.1 retains the Python Software Foundation license in its installed LICENSE file."
+      },
+      {
+        "packageName": "spark-md5",
+        "spdx": "(WTFPL OR MIT)",
+        "notice": "Version 3.0.2 retains its upstream license file."
+      }
+    ]
+  },
+  "weight": "heavy",
+  "profiles": []
+}

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@file-viewer/renderer-dicom",
+  "version": "3.0.0",
+  "private": false,
+  "type": "module",
+  "sideEffects": false,
+  "description": "Opt-in local DICOM Part 10 renderer plugin for File Viewer, powered by modular Cornerstone3D packages.",
+  "keywords": [
+    "file-viewer",
+    "renderer",
+    "dicom",
+    "medical-imaging",
+    "cornerstone",
+    "document-preview",
+    "self-hosted"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "author": {
+    "name": "Yu Wang",
+    "email": "admin@flyfish.dev"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/flyfish-dev/file-viewer.git",
+    "directory": "packages/renderers/dicom"
+  },
+  "homepage": "https://doc.file-viewer.app/guide/on-demand-renderers",
+  "bugs": {
+    "url": "https://github.com/flyfish-dev/file-viewer/issues"
+  },
+  "funding": {
+    "type": "individual",
+    "url": "https://dev.flyfish.group/donate?source=npm"
+  },
+  "fileViewer": {
+    "capabilityManifest": "file-viewer.capability.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./inspect": {
+      "types": "./dist/inspect.d.ts",
+      "import": "./dist/inspect.js",
+      "default": "./dist/inspect.js"
+    },
+    "./capability": "./file-viewer.capability.json",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "README.en.md",
+    "file-viewer.capability.json",
+    "THIRD_PARTY_NOTICES.md",
+    "THIRD_PARTY_LICENSES.json",
+    "third-party/native-codecs",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@cornerstonejs/core": "5.8.2",
+    "@cornerstonejs/dicom-image-loader": "5.8.2",
+    "@cornerstonejs/metadata": "5.8.2",
+    "@file-viewer/core": "3.0.0",
+    "dicom-parser": "1.8.21"
+  },
+  "devDependencies": {
+    "typescript": "^6.0.3"
+  },
+  "license": "Apache-2.0",
+  "scripts": {
+    "build": "tsc -b tsconfig.json",
+    "type-check": "tsc -b tsconfig.json"
+  }
+}

package/third-party/native-codecs/charls/LICENSE.md

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2007, Jan de Vaan and Victor Derks
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/third-party/native-codecs/libjpeg-turbo/LICENSE.md

@@ -0,0 +1,132 @@
+libjpeg-turbo Licenses
+======================
+
+libjpeg-turbo is covered by three compatible BSD-style open source licenses:
+
+- The IJG (Independent JPEG Group) License, which is listed in
+  [README.ijg](README.ijg)
+
+  This license applies to the libjpeg API library and associated programs
+  (any code inherited from libjpeg, and any modifications to that code.)
+
+- The Modified (3-clause) BSD License, which is listed below
+
+  This license covers the TurboJPEG API library and associated programs, as
+  well as the build system.
+
+- The [zlib License](https://opensource.org/licenses/Zlib)
+
+  This license is a subset of the other two, and it covers the libjpeg-turbo
+  SIMD extensions.
+
+
+Complying with the libjpeg-turbo Licenses
+=========================================
+
+This section provides a roll-up of the libjpeg-turbo licensing terms, to the
+best of our understanding.
+
+1.  If you are distributing a modified version of the libjpeg-turbo source,
+    then:
+
+    1.  You cannot alter or remove any existing copyright or license notices
+        from the source.
+
+        **Origin**
+        - Clause 1 of the IJG License
+        - Clause 1 of the Modified BSD License
+        - Clauses 1 and 3 of the zlib License
+
+    2.  You must add your own copyright notice to the header of each source
+        file you modified, so others can tell that you modified that file (if
+        there is not an existing copyright header in that file, then you can
+        simply add a notice stating that you modified the file.)
+
+        **Origin**
+        - Clause 1 of the IJG License
+        - Clause 2 of the zlib License
+
+    3.  You must include the IJG README file, and you must not alter any of the
+        copyright or license text in that file.
+
+        **Origin**
+        - Clause 1 of the IJG License
+
+2.  If you are distributing only libjpeg-turbo binaries without the source, or
+    if you are distributing an application that statically links with
+    libjpeg-turbo, then:
+
+    1.  Your product documentation must include a message stating:
+
+        This software is based in part on the work of the Independent JPEG
+        Group.
+
+        **Origin**
+        - Clause 2 of the IJG license
+
+    2.  If your binary distribution includes or uses the TurboJPEG API, then
+        your product documentation must include the text of the Modified BSD
+        License (see below.)
+
+        **Origin**
+        - Clause 2 of the Modified BSD License
+
+3.  You cannot use the name of the IJG or The libjpeg-turbo Project or the
+    contributors thereof in advertising, publicity, etc.
+
+    **Origin**
+    - IJG License
+    - Clause 3 of the Modified BSD License
+
+4.  The IJG and The libjpeg-turbo Project do not warrant libjpeg-turbo to be
+    free of defects, nor do we accept any liability for undesirable
+    consequences resulting from your use of the software.
+
+    **Origin**
+    - IJG License
+    - Modified BSD License
+    - zlib License
+
+
+The Modified (3-clause) BSD License
+===================================
+
+Copyright (C)2009-2022 D. R. Commander.  All Rights Reserved.<br>
+Copyright (C)2015 Viktor Szathmáry.  All Rights Reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+- Neither the name of the libjpeg-turbo Project nor the names of its
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS",
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+
+Why Three Licenses?
+===================
+
+The zlib License could have been used instead of the Modified (3-clause) BSD
+License, and since the IJG License effectively subsumes the distribution
+conditions of the zlib License, this would have effectively placed
+libjpeg-turbo binary distributions under the IJG License.  However, the IJG
+License specifically refers to the Independent JPEG Group and does not extend
+attribution and endorsement protections to other entities.  Thus, it was
+desirable to choose a license that granted us the same protections for new code
+that were granted to the IJG for code derived from their software.