init

extensions/dicom-video/.webpack/webpack.dev.js

@@ -0,0 +1,12 @@
+const path = require('path');
+const webpackCommon = require('./../../../.webpack/webpack.base.js');
+const SRC_DIR = path.join(__dirname, '../src');
+const DIST_DIR = path.join(__dirname, '../dist');
+
+const ENTRY = {
+  app: `${SRC_DIR}/index.tsx`,
+};
+
+module.exports = (env, argv) => {
+  return webpackCommon(env, argv, { SRC_DIR, ENTRY, DIST_DIR });
+};

extensions/dicom-video/.webpack/webpack.prod.js

@@ -0,0 +1,48 @@
+const webpack = require('webpack');
+const { merge } = require('webpack-merge');
+const path = require('path');
+const webpackCommon = require('./../../../.webpack/webpack.base.js');
+const pkg = require('./../package.json');
+const BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin;
+
+const ROOT_DIR = path.join(__dirname, './..');
+const SRC_DIR = path.join(__dirname, '../src');
+const DIST_DIR = path.join(__dirname, '../dist');
+const ENTRY = {
+  app: `${SRC_DIR}/index.tsx`,
+};
+
+module.exports = (env, argv) => {
+  const commonConfig = webpackCommon(env, argv, { SRC_DIR, ENTRY, DIST_DIR });
+
+  return merge(commonConfig, {
+    stats: {
+      colors: true,
+      hash: true,
+      timings: true,
+      assets: true,
+      chunks: false,
+      chunkModules: false,
+      modules: false,
+      children: false,
+      warnings: true,
+    },
+    optimization: {
+      minimize: true,
+      sideEffects: false,
+    },
+    output: {
+      path: ROOT_DIR,
+      library: 'ohif-extension-dicom-video',
+      libraryTarget: 'umd',
+      filename: pkg.main,
+    },
+    externals: [/\b(vtk.js)/, /\b(dcmjs)/, /\b(gl-matrix)/, /^@ohif/, /^@cornerstonejs/],
+    plugins: [
+      new webpack.optimize.LimitChunkCountPlugin({
+        maxChunks: 1,
+      }),
+      // new BundleAnalyzerPlugin(),
+    ],
+  });
+};

extensions/dicom-video/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Open Health Imaging Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

extensions/dicom-video/README.md

@@ -0,0 +1,15 @@
+# DICOM Video
+This extension adds support for displaying DICOM video objects in a script tag.
+The video data must currently be available as video/mp4 on the BulkDataURI that
+is provided in the DICOMweb metadata response, and the video must have one of the
+specified SOP Class UID's in order to be recognized by the SOP class handler.
+
+Those are:
+* Video Microscop Image Storage
+* Video Photographic Image Storage
+* Video Endoscopic Image Storage
+* Secondary Capture Image Storage
+* Multiframe True Color Secondary Capture Image Storage
+
+The extension is a "standard" extension in that it is installed and available
+by default.

extensions/dicom-video/babel.config.js

@@ -0,0 +1 @@
+module.exports = require('../../babel.config.js');

extensions/dicom-video/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@ohif/extension-dicom-video",
+  "version": "3.9.1",
+  "description": "OHIF extension for video display",
+  "author": "OHIF",
+  "license": "MIT",
+  "repository": "OHIF/Viewers",
+  "main": "dist/ohif-extension-dicom-video.umd.js",
+  "module": "src/index.tsx",
+  "engines": {
+    "node": ">=14",
+    "npm": ">=6",
+    "yarn": ">=1.16.0"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "shx rm -rf dist",
+    "clean:deep": "yarn run clean && shx rm -rf node_modules",
+    "dev": "cross-env NODE_ENV=development webpack --config .webpack/webpack.dev.js --watch --output-pathinfo",
+    "build": "cross-env NODE_ENV=production webpack --config .webpack/webpack.prod.js",
+    "build:package-1": "yarn run build",
+    "start": "yarn run dev",
+    "test:unit": "jest --watchAll",
+    "test:unit:ci": "jest --ci --runInBand --collectCoverage --passWithNoTests"
+  },
+  "peerDependencies": {
+    "@ohif/core": "3.9.1",
+    "@ohif/ui": "3.9.1",
+    "dcmjs": "*",
+    "dicom-parser": "^1.8.9",
+    "hammerjs": "^2.0.8",
+    "prop-types": "^15.6.2",
+    "react": "^18.3.1"
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.20.13",
+    "classnames": "^2.3.2"
+  }
+}

extensions/dicom-video/src/getSopClassHandlerModule.js

@@ -0,0 +1,114 @@
+import { SOPClassHandlerId } from './id';
+import { utils } from '@ohif/core';
+import { utilities as csUtils, Enums as csEnums } from '@cornerstonejs/core';
+
+const SOP_CLASS_UIDS = {
+  VIDEO_MICROSCOPIC_IMAGE_STORAGE: '1.2.840.10008.5.1.4.1.1.77.1.2.1',
+  VIDEO_PHOTOGRAPHIC_IMAGE_STORAGE: '1.2.840.10008.5.1.4.1.1.77.1.4.1',
+  VIDEO_ENDOSCOPIC_IMAGE_STORAGE: '1.2.840.10008.5.1.4.1.1.77.1.1.1',
+  /** Need to use fallback, could be video or image */
+  SECONDARY_CAPTURE_IMAGE_STORAGE: '1.2.840.10008.5.1.4.1.1.7',
+  MULTIFRAME_TRUE_COLOR_SECONDARY_CAPTURE_IMAGE_STORAGE: '1.2.840.10008.5.1.4.1.1.7.4',
+};
+
+const sopClassUids = Object.values(SOP_CLASS_UIDS);
+const secondaryCaptureSopClassUids = [
+  SOP_CLASS_UIDS.SECONDARY_CAPTURE_IMAGE_STORAGE,
+  SOP_CLASS_UIDS.MULTIFRAME_TRUE_COLOR_SECONDARY_CAPTURE_IMAGE_STORAGE,
+];
+
+const SupportedTransferSyntaxes = {
+  MPEG4_AVC_264_HIGH_PROFILE: '1.2.840.10008.1.2.4.102',
+  MPEG4_AVC_264_BD_COMPATIBLE_HIGH_PROFILE: '1.2.840.10008.1.2.4.103',
+  MPEG4_AVC_264_HIGH_PROFILE_FOR_2D_VIDEO: '1.2.840.10008.1.2.4.104',
+  MPEG4_AVC_264_HIGH_PROFILE_FOR_3D_VIDEO: '1.2.840.10008.1.2.4.105',
+  MPEG4_AVC_264_STEREO_HIGH_PROFILE: '1.2.840.10008.1.2.4.106',
+  HEVC_265_MAIN_PROFILE: '1.2.840.10008.1.2.4.107',
+  HEVC_265_MAIN_10_PROFILE: '1.2.840.10008.1.2.4.108',
+};
+
+const supportedTransferSyntaxUIDs = Object.values(SupportedTransferSyntaxes);
+
+const _getDisplaySetsFromSeries = (instances, servicesManager, extensionManager) => {
+  const dataSource = extensionManager.getActiveDataSource()[0];
+  return instances
+    .filter(metadata => {
+      const tsuid =
+        metadata.AvailableTransferSyntaxUID || metadata.TransferSyntaxUID || metadata['00083002'];
+
+      if (supportedTransferSyntaxUIDs.includes(tsuid)) {
+        return true;
+      }
+
+      if (metadata.SOPClassUID === SOP_CLASS_UIDS.VIDEO_PHOTOGRAPHIC_IMAGE_STORAGE) {
+        return true;
+      }
+
+      // Assume that an instance with one of the secondary capture SOPClassUIDs and
+      // with at least 90 frames (i.e. typically 3 seconds of video) is indeed a video.
+      return (
+        secondaryCaptureSopClassUids.includes(metadata.SOPClassUID) && metadata.NumberOfFrames >= 90
+      );
+    })
+    .map(instance => {
+      const { Modality, SOPInstanceUID, SeriesDescription = 'VIDEO', imageId } = instance;
+      const { SeriesNumber, SeriesDate, SeriesInstanceUID, StudyInstanceUID, NumberOfFrames, url } =
+        instance;
+      const videoUrl = dataSource.retrieve.directURL({
+        instance,
+        singlepart: 'video',
+        tag: 'PixelData',
+        url,
+      });
+      const displaySet = {
+        //plugin: id,
+        Modality,
+        displaySetInstanceUID: utils.guid(),
+        SeriesDescription,
+        SeriesNumber,
+        SeriesDate,
+        SOPInstanceUID,
+        SeriesInstanceUID,
+        StudyInstanceUID,
+        SOPClassHandlerId,
+        referencedImages: null,
+        measurements: null,
+        viewportType: csEnums.ViewportType.VIDEO,
+        // The videoUrl is deprecated, the preferred URL is renderedUrl
+        videoUrl,
+        renderedUrl: videoUrl,
+        instances: [instance],
+        thumbnailSrc: dataSource.retrieve.directURL({
+          instance,
+          defaultPath: '/thumbnail',
+          defaultType: 'image/jpeg',
+          tag: 'Absent',
+        }),
+        imageIds: [imageId],
+        isDerivedDisplaySet: true,
+        isLoaded: false,
+        sopClassUids,
+        numImageFrames: NumberOfFrames,
+        instance,
+      };
+      csUtils.genericMetadataProvider.add(imageId, {
+        type: 'imageUrlModule',
+        metadata: { rendered: videoUrl },
+      });
+      return displaySet;
+    });
+};
+
+export default function getSopClassHandlerModule({ servicesManager, extensionManager }) {
+  const getDisplaySetsFromSeries = instances => {
+    return _getDisplaySetsFromSeries(instances, servicesManager, extensionManager);
+  };
+
+  return [
+    {
+      name: 'dicom-video',
+      sopClassUids,
+      getDisplaySetsFromSeries,
+    },
+  ];
+}

extensions/dicom-video/src/id.js

@@ -0,0 +1,6 @@
+import packageJson from '../package.json';
+
+const id = packageJson.name;
+const SOPClassHandlerId = `${id}.sopClassHandlerModule.dicom-video`;
+
+export { SOPClassHandlerId, id };

extensions/dicom-video/src/index.tsx

@@ -0,0 +1,60 @@
+import React from 'react';
+import getSopClassHandlerModule from './getSopClassHandlerModule';
+import { id } from './id';
+
+const Component = React.lazy(() => {
+  return import(/* webpackPrefetch: true */ './viewports/OHIFCornerstoneVideoViewport');
+});
+
+const OHIFCornerstoneVideoViewport = props => {
+  return (
+    <React.Suspense fallback={<div>Loading...</div>}>
+      <Component {...props} />
+    </React.Suspense>
+  );
+};
+
+/**
+ *
+ */
+const dicomVideoExtension = {
+  /**
+   * Only required property. Should be a unique value across all extensions.
+   */
+  id,
+
+  /**
+   *
+   *
+   * @param {object} [configuration={}]
+   * @param {object|array} [configuration.csToolsConfig] - Passed directly to `initCornerstoneTools`
+   */
+  getViewportModule({ servicesManager, extensionManager }) {
+    const ExtendedOHIFCornerstoneVideoViewport = props => {
+      return (
+        <OHIFCornerstoneVideoViewport
+          servicesManager={servicesManager}
+          extensionManager={extensionManager}
+          {...props}
+        />
+      );
+    };
+
+    return [{ name: 'dicom-video', component: ExtendedOHIFCornerstoneVideoViewport }];
+  },
+  getSopClassHandlerModule,
+};
+
+function _getToolAlias(toolName) {
+  let toolAlias = toolName;
+
+  switch (toolName) {
+    case 'EllipticalRoi':
+      toolAlias = 'SREllipticalRoi';
+      break;
+  }
+
+  return toolAlias;
+}
+
+export default dicomVideoExtension;

extensions/dicom-video/src/viewports/OHIFCornerstoneVideoViewport.tsx

@@ -0,0 +1,55 @@
+import React, { useEffect, useState } from 'react';
+import PropTypes from 'prop-types';
+
+function OHIFCornerstoneVideoViewport({ displaySets }) {
+  if (displaySets && displaySets.length > 1) {
+    throw new Error(
+      'OHIFCornerstoneVideoViewport: only one display set is supported for dicom video right now'
+    );
+  }
+
+  const { videoUrl } = displaySets[0];
+  const mimeType = 'video/mp4';
+  const [url, setUrl] = useState(null);
+
+  useEffect(() => {
+    const load = async () => {
+      setUrl(await videoUrl);
+    };
+
+    load();
+  }, [videoUrl]);
+
+  // Need to copies of the source to fix a firefox bug
+  return (
+    <div className="bg-primary-black h-full w-full">
+      <video
+        src={url}
+        controls
+        controlsList="nodownload"
+        preload="auto"
+        className="h-full w-full"
+        crossOrigin="anonymous"
+      >
+        <source
+          src={url}
+          type={mimeType}
+        />
+        <source
+          src={url}
+          type={mimeType}
+        />
+        Video src/type not supported:{' '}
+        <a href={url}>
+          {url} of type {mimeType}
+        </a>
+      </video>
+    </div>
+  );
+}
+
+OHIFCornerstoneVideoViewport.propTypes = {
+  displaySets: PropTypes.arrayOf(PropTypes.object).isRequired,
+};
+
+export default OHIFCornerstoneVideoViewport;