@cornerstonejs/tools 1.80.0 → 1.80.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "1.80.0",
+  "version": "1.80.2",
   "description": "Cornerstone3D Tools",
   "main": "src/index.ts",
   "types": "dist/types/index.d.ts",
@@ -29,7 +29,7 @@
     "webpack:watch": "webpack --mode development --progress --watch  --config ./.webpack/webpack.dev.js"
   },
   "dependencies": {
-    "@cornerstonejs/core": "^1.80.0",
+    "@cornerstonejs/core": "^1.80.2",
     "@icr/polyseg-wasm": "0.4.0",
     "@types/offscreencanvas": "2019.7.3",
     "comlink": "^4.4.1",
@@ -59,5 +59,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "76a9f8014ec175f94193989b02a9be792bc9d41f"
+  "gitHead": "ec105a93611d3cbcdba011bb4681ae3dd501f0f0"
 }

package/src/types/CINETypes.ts

@@ -33,6 +33,9 @@ type CinePlayContext = {
   // the next image.
   waitForRenderedCount?: number;
   scroll(delta: number): void;
+  // An alternate implementation for video viewports or others that have
+  // native play functionality
+  play?(fps?: number): number;
 };
 
 export type { PlayClipOptions, ToolData, CinePlayContext };

package/src/utilities/cine/playClip.ts

@@ -3,6 +3,7 @@ import {
   utilities as csUtils,
   getEnabledElement,
   StackViewport,
+  VideoViewport,
   VolumeViewport,
   cache,
   BaseVolumeViewport,
@@ -152,7 +153,14 @@ function playClip(
     const delta = newStepIndex - currentStepIndex;
 
     if (delta) {
-      playClipContext.scroll(delta);
+      try {
+        playClipContext.scroll(delta);
+      } catch (e) {
+        console.warn('Play clip not scrolling', e);
+        _stopClipWithData(playClipData);
+        triggerEvent(element, CINE_EVENTS.CLIP_STOPPED, eventDetail);
+        return;
+      }
     }
   };
 
@@ -160,9 +168,14 @@ function playClip(
     dynamicVolumesPlayingMap.set(volume.volumeId, element);
   }
 
-  // If playClipTimeouts array is available, not empty and its elements are NOT uniform ...
-  // ... (at least one timeout is different from the others), use alternate setTimeout implementation
-  if (
+  if (playClipContext.play) {
+    playClipData.framesPerSecond = playClipContext.play(
+      playClipOptions.framesPerSecond
+    );
+
+    // If playClipTimeouts array is available, not empty and its elements are NOT uniform ...
+    // ... (at least one timeout is different from the others), use alternate setTimeout implementation
+  } else if (
     playClipTimeouts &&
     playClipTimeouts.length > 0 &&
     playClipIsTimeVarying
@@ -213,6 +226,7 @@ function _stopClip(
   const enabledElement = getEnabledElement(element);
 
   let toolState;
+  const viewport = enabledElement?.viewport;
   if (!enabledElement) {
     if (viewportId) {
       toolState = getToolStateByViewportId(viewportId);
@@ -228,10 +242,9 @@ function _stopClip(
     _stopClipWithData(toolState);
   }
 
-  if (
-    stopDynamicCine &&
-    enabledElement?.viewport instanceof BaseVolumeViewport
-  ) {
+  if (viewport instanceof VideoViewport) {
+    viewport.pause();
+  } else if (stopDynamicCine && viewport instanceof BaseVolumeViewport) {
     _stopDynamicVolumeCine(element);
   }
 }
@@ -374,6 +387,45 @@ function _createStackViewportCinePlayContext(
   };
 }
 
+function _createVideoViewportCinePlayContext(
+  viewport: VideoViewport,
+  waitForRendered: number
+): CINETypes.CinePlayContext {
+  return {
+    get numScrollSteps(): number {
+      return viewport.getNumberOfSlices();
+    },
+    get currentStepIndex(): number {
+      return viewport.getSliceIndex();
+    },
+    get frameTimeVectorEnabled(): boolean {
+      // It is always in acquired orientation
+      return true;
+    },
+    waitForRenderedCount: 0,
+    scroll(delta: number): void {
+      if (
+        this.waitForRenderedCount <= waitForRendered &&
+        viewport.viewportStatus !== ViewportStatus.RENDERED
+      ) {
+        this.waitForRenderedCount++;
+        return;
+      }
+      this.waitForRenderedCount = 0;
+      scroll(viewport, { delta, debounceLoading: debounced });
+    },
+    play(fps?: number): number {
+      if (fps) {
+        // This is a bit of a kludge to correspond to playback rates
+        // for other viewports
+        viewport.setPlaybackRate(fps / 24);
+      }
+      viewport.play();
+      return viewport.getFrameRate();
+    },
+  };
+}
+
 function _createVolumeViewportCinePlayContext(
   viewport: VolumeViewport,
   volume: Types.IImageVolume
@@ -475,6 +527,13 @@ function _createCinePlayContext(
     return _createVolumeViewportCinePlayContext(viewport, volume);
   }
 
+  if (viewport instanceof VideoViewport) {
+    return _createVideoViewportCinePlayContext(
+      viewport,
+      playClipOptions.waitForRendered ?? 30
+    );
+  }
+
   throw new Error('Unknown viewport type');
 }
 

package/src/utilities/stackPrefetch/stackContextPrefetch.ts

@@ -64,7 +64,10 @@ const resetPrefetchDelay = 5;
 const enable = (element): void => {
   const stack = getStackData(element);
 
-  if (!stack || !stack.imageIds || stack.imageIds.length === 0) {
+  if (!stack) {
+    return;
+  }
+  if (!stack.imageIds?.length) {
     console.warn('CornerstoneTools.stackPrefetch: No images in stack.');
     return;
   }
@@ -90,6 +93,9 @@ const enable = (element): void => {
 
 function prefetch(element) {
   const stack = getStackData(element);
+  if (!stack) {
+    return;
+  }
   if (!stack?.imageIds?.length) {
     console.warn('CornerstoneTools.stackPrefetch: No images in stack.');
     return;
@@ -273,7 +279,11 @@ const signum = (x) => (x < 0 ? -1 : 1);
 
 const updateToolState = (element, usage?: number) => {
   const stack = getStackData(element);
-  if (!stack || !stack.imageIds || stack.imageIds.length === 0) {
+  if (!stack) {
+    // Other viewport type - no message
+    return;
+  }
+  if (!stack.imageIds?.length) {
     console.warn('CornerstoneTools.stackPrefetch: No images in stack.');
     return;
   }

package/src/utilities/stackPrefetch/stackPrefetchUtils.ts

@@ -1,4 +1,10 @@
-import { getEnabledElement, StackViewport, Enums } from '@cornerstonejs/core';
+import {
+  getEnabledElement,
+  StackViewport,
+  Enums,
+  VideoViewport,
+  WSIViewport,
+} from '@cornerstonejs/core';
 import { getToolState } from './state';
 
 export const requestType = Enums.RequestType.Prefetch;
@@ -54,10 +60,6 @@ export function getStackData(element) {
   if (!(viewport instanceof StackViewport)) {
     // we shouldn't throw error here, since the viewport might have
     // changed from stack to volume during prefetch
-    console.warn(
-      'stackPrefetch: element must be a StackViewport, VolumeViewport stackPrefetch not yet implemented'
-    );
-
     return null;
   }
 

package/src/utilities/viewport/jumpToSlice.ts

@@ -54,11 +54,11 @@ function _getImageSliceData(
         ? viewport.getTargetImageIdIndex()
         : viewport.getCurrentImageIdIndex(),
     };
-  } else if (viewport instanceof VolumeViewport) {
-    return csUtils.getImageSliceDataForVolumeViewport(viewport);
-  } else {
-    throw new Error('Unsupported viewport type');
   }
+  return {
+    numberOfSlices: viewport.getNumberOfSlices(),
+    imageIndex: viewport.getSliceIndex(),
+  };
 }
 
 function _getImageIndexToJump(