OHIF-27: PlayClipController
This commit is contained in:
Leonardo Campos committed
1 parent
ec333118d3
commit
72c08147d4
9 files changed
+489
-68
No files matched your search
@@ -0,0 +1,306 @@
|
||||
import { $ } from 'meteor/jquery';
|
||||
import { Tracker } from 'meteor/tracker';
|
||||
import { Session } from 'meteor/session';
|
||||
import { OHIF } from 'meteor/ohif:core';
|
||||
|
||||
class PlayClipController {
|
||||
constructor(element, displaySet) {
|
||||
this._isPlaying = false;
|
||||
this.element = element;
|
||||
this.displaySet = displaySet;
|
||||
this._playComputation = null;
|
||||
}
|
||||
|
||||
_getStackProgress() {
|
||||
return Session.get('StackProgress:' + this.displaySet.displaySetInstanceUid);
|
||||
}
|
||||
|
||||
_getToolState(toolType) {
|
||||
const toolState = cornerstoneTools.getToolState(this.element, toolType);
|
||||
if (toolState && toolState.data) {
|
||||
return toolState.data[0];
|
||||
}
|
||||
}
|
||||
|
||||
_countFramesByStatus(stackProgress, startIndex, endIndex, status) {
|
||||
const framesStatus = stackProgress.framesStatus;
|
||||
const framesCount = framesStatus.length;
|
||||
let currentIndex = startIndex;
|
||||
let count = 0;
|
||||
|
||||
do {
|
||||
if (framesStatus[currentIndex] === status) {
|
||||
count++;
|
||||
}
|
||||
|
||||
if(currentIndex === endIndex) {
|
||||
break;
|
||||
}
|
||||
|
||||
currentIndex = (currentIndex + 1) % framesCount;
|
||||
} while (true)
|
||||
|
||||
return count;
|
||||
}
|
||||
|
||||
_isLoopEnabled() {
|
||||
const playClipToolState = this._getToolState('playClip');
|
||||
return playClipToolState && playClipToolState.loop;
|
||||
}
|
||||
|
||||
_getCurrentIndex() {
|
||||
const stackToolState = this._getToolState('stack');
|
||||
return stackToolState.currentImageIdIndex || 0;
|
||||
}
|
||||
|
||||
_isLastFrame() {
|
||||
const stackToolState = this._getToolState('stack');
|
||||
const currentIndex = (stackToolState && stackToolState.currentImageIdIndex) || 0;
|
||||
const imagesCount = stackToolState ? stackToolState.imageIds.length : 0;
|
||||
|
||||
return (imagesCount === 0) || (currentIndex === imagesCount - 1);
|
||||
}
|
||||
|
||||
_getFrameDistance(startIndex, endIndex) {
|
||||
const framesCount = this.displaySet.numImageFrames;
|
||||
return startIndex <= endIndex ? endIndex - startIndex : framesCount - (startIndex - endIndex);
|
||||
}
|
||||
|
||||
_getLastRelativeFrame(startFrame) {
|
||||
const numImageFrames = this.displaySet.numImageFrames;
|
||||
|
||||
if (this._isLoopEnabled()) {
|
||||
// Easiest way to get the previous index without having to check if it's negative
|
||||
return (startFrame + numImageFrames - 1) % numImageFrames;
|
||||
}
|
||||
|
||||
// Return the last index of the array
|
||||
return numImageFrames - 1;
|
||||
}
|
||||
|
||||
isPlaying() {
|
||||
return this._isPlaying;
|
||||
}
|
||||
|
||||
play() {
|
||||
if (this._isPlaying) {
|
||||
return;
|
||||
}
|
||||
|
||||
this._isPlaying = true;
|
||||
|
||||
const playClipToolState = this._getToolState('playClip');
|
||||
const startIndex = this._getCurrentIndex();
|
||||
const endIndex = this._getLastRelativeFrame(startIndex);
|
||||
const framesToPlay = this._getFrameDistance(startIndex, endIndex);
|
||||
const playTimeRemaining = framesToPlay / playClipToolState.framesPerSecond;
|
||||
|
||||
const play = playComputation => {
|
||||
playComputation.stop();
|
||||
|
||||
try {
|
||||
cornerstoneTools.playClip(this.element);
|
||||
} catch(e) {
|
||||
console.log(e);
|
||||
}
|
||||
}
|
||||
|
||||
this._playComputation = Tracker.autorun(playComputation => {
|
||||
const stackProgress = this._getStackProgress();
|
||||
|
||||
if (!stackProgress) {
|
||||
return;
|
||||
} else if (!stackProgress.multiFrame) {
|
||||
play(playComputation);
|
||||
return;
|
||||
}
|
||||
|
||||
const framesToLoad = this._countFramesByStatus(stackProgress, startIndex, endIndex, false);
|
||||
const loadTimeRemaining = framesToLoad / stackProgress.framesPerSecond;
|
||||
|
||||
if ((stackProgress.percentComplete === 100) ||
|
||||
(loadTimeRemaining < playTimeRemaining)) {
|
||||
play(playComputation);
|
||||
this._attachNewImageListener();
|
||||
}
|
||||
});
|
||||
|
||||
// Update the UpdateCINE session property
|
||||
Session.set('UpdateCINE', Random.id());
|
||||
}
|
||||
|
||||
stop() {
|
||||
if (!this._isPlaying) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (this._playComputation) {
|
||||
this._playComputation.stop();
|
||||
this._playComputation = null;
|
||||
}
|
||||
|
||||
try {
|
||||
cornerstoneTools.stopClip(this.element);
|
||||
} catch(e) {
|
||||
console.log(e);
|
||||
}
|
||||
|
||||
this._isPlaying = false;
|
||||
this._detachNewImageListener();
|
||||
|
||||
// Update the UpdateCINE session property
|
||||
Session.set('UpdateCINE', Random.id());
|
||||
}
|
||||
|
||||
togglePlay() {
|
||||
if(this._isPlaying) {
|
||||
this.stop();
|
||||
} else {
|
||||
this.play();
|
||||
}
|
||||
}
|
||||
|
||||
_isNextFrameLoaded() {
|
||||
const stackProgress = this._getStackProgress();
|
||||
|
||||
if (!stackProgress || !stackProgress.framesStatus) {
|
||||
return;
|
||||
}
|
||||
|
||||
const stackToolState = this._getToolState('stack');
|
||||
const currentImageIdIndex = stackToolState.currentImageIdIndex || 0;
|
||||
const isLoopEnabled = this._isLoopEnabled();
|
||||
|
||||
let nextImageIndex = currentImageIdIndex + 1;
|
||||
|
||||
if ((nextImageIndex >= stackToolState.imageIds.length) && isLoopEnabled) {
|
||||
nextImageIndex = 0;
|
||||
}
|
||||
|
||||
return stackProgress.framesStatus && stackProgress.framesStatus[nextImageIndex];
|
||||
}
|
||||
|
||||
_newImageEventHandler(e, eventData) {
|
||||
if (this._isLastFrame() && !this._isLoopEnabled()) {
|
||||
return this.stop();
|
||||
} else if (!this._isNextFrameLoaded()) {
|
||||
// Stop the clip and play it again in order to wait for the next frames (buffer)
|
||||
this.stop();
|
||||
this.play();
|
||||
}
|
||||
}
|
||||
|
||||
_attachNewImageListener() {
|
||||
this._detachNewImageListener();
|
||||
$(this.element).on('CornerstoneNewImage.PlayClipManager', this._newImageEventHandler.bind(this));
|
||||
}
|
||||
|
||||
_detachNewImageListener() {
|
||||
$(this.element).off('CornerstoneNewImage.PlayClipManager');
|
||||
}
|
||||
|
||||
destroy() {
|
||||
this.stop();
|
||||
}
|
||||
}
|
||||
|
||||
class PlayClipManager {
|
||||
constructor() {
|
||||
this.elementControllers = [];
|
||||
}
|
||||
|
||||
add(element, displaySet) {
|
||||
const playClipController = new PlayClipController(element, displaySet);
|
||||
|
||||
// Remove any other PlayClipController for this `element`
|
||||
this.remove(element);
|
||||
|
||||
// Add the new PlayClipController for this `element`
|
||||
this.elementControllers.push({
|
||||
element,
|
||||
playClipController
|
||||
});
|
||||
|
||||
return playClipController;
|
||||
}
|
||||
|
||||
remove (element) {
|
||||
const index = this._indexOf(element);
|
||||
|
||||
if (index === -1) {
|
||||
return;
|
||||
}
|
||||
|
||||
const elementController = this.elementControllers[index];
|
||||
const playClipController = elementController.playClipController;
|
||||
|
||||
playClipController.destroy();
|
||||
this.elementControllers.splice(index, 1);
|
||||
}
|
||||
|
||||
get (element) {
|
||||
const index = this._indexOf(element);
|
||||
|
||||
if (index >= 0) {
|
||||
const elementController = this.elementControllers[index];
|
||||
return elementController.playClipController;
|
||||
}
|
||||
}
|
||||
|
||||
_indexOf(element) {
|
||||
const elementControllers = this.elementControllers;
|
||||
const length = elementControllers.length;
|
||||
|
||||
for(let i = 0; i < length; i++) {
|
||||
if (elementControllers[i].element === element) {
|
||||
return i;
|
||||
}
|
||||
}
|
||||
|
||||
return -1;
|
||||
}
|
||||
|
||||
_forEach(callback) {
|
||||
const elementControllers = this.elementControllers;
|
||||
const length = elementControllers.length;
|
||||
|
||||
for (let i = 0; i < length; i++) {
|
||||
const elementControllers = this.elementControllers[i];
|
||||
const element = elementControllers.element;
|
||||
const playClipController = elementControllers.playClipController;
|
||||
|
||||
callback(element, playClipController);
|
||||
}
|
||||
}
|
||||
|
||||
playAll() {
|
||||
this._forEach((element, playClipController) => {
|
||||
playClipController.play();
|
||||
});
|
||||
}
|
||||
|
||||
stopAll() {
|
||||
this._forEach((element, playClipController) => {
|
||||
playClipController.stop();
|
||||
});
|
||||
}
|
||||
|
||||
clear() {
|
||||
this._forEach((element, playClipController) => {
|
||||
playClipController.destroy();
|
||||
});
|
||||
|
||||
this.elementControllers = [];
|
||||
}
|
||||
|
||||
// Singleton
|
||||
static getInstance() {
|
||||
if (!PlayClipManager._instance) {
|
||||
PlayClipManager._instance = new PlayClipManager();
|
||||
}
|
||||
|
||||
return PlayClipManager._instance;
|
||||
}
|
||||
}
|
||||
|
||||
export { PlayClipManager };
|
||||
@@ -0,0 +1,364 @@
|
||||
import { $ } from 'meteor/jquery';
|
||||
import { Session } from 'meteor/session';
|
||||
|
||||
class BaseLoadingListener {
|
||||
constructor(stack, options) {
|
||||
options = options || {};
|
||||
|
||||
this.id = BaseLoadingListener.getNewId();
|
||||
this.stack = stack;
|
||||
this.startListening();
|
||||
this.statsItemsLimit = options.statsItemsLimit || 2;
|
||||
this.stats = {
|
||||
items: [],
|
||||
total: 0,
|
||||
elapsedTime: 0,
|
||||
speed: 0
|
||||
};
|
||||
|
||||
// Register the start point to make it possible to calculate
|
||||
// bytes/s or frames/s when the first byte or frame is received
|
||||
this._addStatsData(0);
|
||||
|
||||
// Update the progress before starting the download
|
||||
// to make it possible to update the UI
|
||||
this._updateProgress();
|
||||
}
|
||||
|
||||
_addStatsData(value) {
|
||||
const date = new Date();
|
||||
const stats = this.stats;
|
||||
const items = stats.items;
|
||||
const newItem = {
|
||||
value,
|
||||
date
|
||||
};
|
||||
|
||||
items.push(newItem);
|
||||
stats.total += newItem.value;
|
||||
|
||||
// Remove items until it gets below the limit
|
||||
while (items.length > this.statsItemsLimit) {
|
||||
const item = items.shift();
|
||||
stats.total -= item.value;
|
||||
}
|
||||
|
||||
// Update the elapsedTime (seconds) based on first and last
|
||||
// elements and recalculate the speed (bytes/s or frames/s)
|
||||
if (items.length > 1) {
|
||||
const oldestItem = items[0];
|
||||
stats.elapsedTime = (newItem.date.getTime() - oldestItem.date.getTime()) / 1000;
|
||||
stats.speed = (stats.total - oldestItem.value) / stats.elapsedTime;
|
||||
}
|
||||
}
|
||||
|
||||
_getProgressSessionId() {
|
||||
const displaySetInstanceUid = this.stack.displaySetInstanceUid;
|
||||
return 'StackProgress:' + displaySetInstanceUid;
|
||||
}
|
||||
|
||||
_clearSession() {
|
||||
const progressSessionId = this._getProgressSessionId();
|
||||
Session.set(progressSessionId, undefined);
|
||||
delete Session.keys.progressSessionId;
|
||||
}
|
||||
|
||||
startListening() {
|
||||
throw new Error('`startListening` must be implemented by child clases');
|
||||
}
|
||||
|
||||
stopListening() {
|
||||
throw new Error('`stopListening` must be implemented by child clases');
|
||||
}
|
||||
|
||||
destroy() {
|
||||
this.stopListening();
|
||||
this._clearSession();
|
||||
}
|
||||
|
||||
static getNewId() {
|
||||
const timeSlice = (new Date()).getTime().toString().slice(-8);
|
||||
const randomNumber = parseInt(Math.random() * 1000000000);
|
||||
|
||||
return timeSlice.toString() + randomNumber.toString();
|
||||
}
|
||||
}
|
||||
|
||||
class DICOMFileLoadingListener extends BaseLoadingListener {
|
||||
constructor(stack) {
|
||||
super(stack);
|
||||
this.dataSetUrls = this._getDataSetUrls(stack);
|
||||
this._lastLoaded = 0;
|
||||
}
|
||||
|
||||
_getImageLoadProgressEventName() {
|
||||
return 'CornerstoneImageLoadProgress.' + this.id;
|
||||
}
|
||||
|
||||
startListening() {
|
||||
const imageLoadProgressEventName = this._getImageLoadProgressEventName();
|
||||
const imageLoadProgressEventHandle = this._imageLoadProgressEventHandle.bind(this);
|
||||
|
||||
this.stopListening();
|
||||
|
||||
$(cornerstone).on(imageLoadProgressEventName, imageLoadProgressEventHandle);
|
||||
}
|
||||
|
||||
stopListening() {
|
||||
const imageLoadProgressEventName = this._getImageLoadProgressEventName();
|
||||
$(cornerstone).off(imageLoadProgressEventName);
|
||||
}
|
||||
|
||||
_imageLoadProgressEventHandle(e, eventData) {
|
||||
const dataSetUrl = this._getDataSetUrl(eventData.imageId);
|
||||
const bytesDiff = eventData.loaded - this._lastLoaded;
|
||||
|
||||
if (!this.dataSetUrls.has(dataSetUrl)) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Add the bytes downloaded to the stats
|
||||
this._addStatsData(bytesDiff);
|
||||
|
||||
// Update the download progress
|
||||
this._updateProgress(eventData);
|
||||
|
||||
// Cache the last eventData.loaded value
|
||||
this._lastLoaded = eventData.loaded;
|
||||
}
|
||||
|
||||
_updateProgress(eventData) {
|
||||
const progressSessionId = this._getProgressSessionId();
|
||||
eventData = eventData || {};
|
||||
|
||||
Session.set(progressSessionId, {
|
||||
multiFrame: false,
|
||||
percentComplete: eventData.percentComplete,
|
||||
bytesLoaded: eventData.loaded,
|
||||
bytesTotal: eventData.total,
|
||||
bytesPerSecond: this.stats.speed
|
||||
});
|
||||
}
|
||||
|
||||
_getDataSetUrl(imageId) {
|
||||
// Remove "frame=999&" from the imageId
|
||||
imageId = imageId.replace(/frame=\d+&?/i, '');
|
||||
|
||||
// Remove the last "&" like in "dicomweb:...&serverId=GQGpJcb4CnYDdu53q&"
|
||||
imageId = imageId.replace(/&$/, '');
|
||||
|
||||
return imageId;
|
||||
}
|
||||
|
||||
_getDataSetUrls(stack) {
|
||||
const dataSetUrls = new Set();
|
||||
const imageIds = stack.imageIds;
|
||||
const length = stack.imageIds.length;
|
||||
|
||||
for (let i = 0; i < length; i++) {
|
||||
const dataSetUrl = this._getDataSetUrl(imageIds[i]);
|
||||
dataSetUrls.add(dataSetUrl);
|
||||
}
|
||||
|
||||
return dataSetUrls;
|
||||
}
|
||||
}
|
||||
|
||||
class StackLoadingListener extends BaseLoadingListener {
|
||||
constructor(stack) {
|
||||
super(stack, { statsItemsLimit: 20 });
|
||||
this.imageDataMap = this._convertImageIdsArrayToMap(stack.imageIds);
|
||||
this.framesStatus = this._createArray(stack.imageIds.length, false);
|
||||
this.loadedCount = 0;
|
||||
}
|
||||
|
||||
_convertImageIdsArrayToMap(imageIds) {
|
||||
const imageIdsMap = new Map();
|
||||
|
||||
for (let i = 0; i < imageIds.length; i++) {
|
||||
imageIdsMap.set(imageIds[i], {
|
||||
index: i,
|
||||
loaded: false
|
||||
});
|
||||
}
|
||||
|
||||
return imageIdsMap;
|
||||
}
|
||||
|
||||
_createArray(length, defaultValue) {
|
||||
// `new Array(length)` is an anti-pattern in javascript because its
|
||||
// funny API. Otherwise I would go for `new Array(length).fill(false)`
|
||||
const array = new Array();
|
||||
|
||||
for(let i = 0; i < length; i++) {
|
||||
array[i] = defaultValue;
|
||||
}
|
||||
|
||||
return array;
|
||||
}
|
||||
|
||||
_getImageLoadedEventName() {
|
||||
return 'CornerstoneImageLoaded.' + this.id;
|
||||
}
|
||||
|
||||
_getImageCachePromiseRemoveEventName() {
|
||||
return 'CornerstoneImageCachePromiseRemoved.' + this.id;
|
||||
}
|
||||
|
||||
startListening() {
|
||||
const imageLoadedEventName = this._getImageLoadedEventName();
|
||||
const imageCachePromiseRemovedEventName = this._getImageCachePromiseRemoveEventName();
|
||||
const imageLoadedEventHandle = this._imageLoadedEventHandle.bind(this);
|
||||
const imageCachePromiseRemovedEventHandle = this._imageCachePromiseRemovedEventHandle.bind(this);
|
||||
|
||||
this.stopListening();
|
||||
|
||||
$(cornerstone).on(imageLoadedEventName, imageLoadedEventHandle);
|
||||
$(cornerstone).on(imageCachePromiseRemovedEventName, imageCachePromiseRemovedEventHandle);
|
||||
}
|
||||
|
||||
stopListening() {
|
||||
const imageLoadedEventName = this._getImageLoadedEventName();
|
||||
const imageCachePromiseRemovedEventName = this._getImageCachePromiseRemoveEventName();
|
||||
|
||||
$(cornerstone).off(imageLoadedEventName);
|
||||
$(cornerstone).off(imageCachePromiseRemovedEventName);
|
||||
}
|
||||
|
||||
_updateImageStatus(imageId, loaded) {
|
||||
const imageData = this.imageDataMap.get(imageId);
|
||||
|
||||
if (!imageData || (imageData.loaded === loaded)) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Add one more frame to the stats
|
||||
if(loaded) {
|
||||
this._addStatsData(1);
|
||||
}
|
||||
|
||||
imageData.loaded = loaded;
|
||||
this.framesStatus[imageData.index] = loaded;
|
||||
this.loadedCount += loaded ? 1 : -1;
|
||||
this._updateProgress();
|
||||
}
|
||||
|
||||
_imageLoadedEventHandle(e, eventData) {
|
||||
const imageId = eventData.image.imageId;
|
||||
this._updateImageStatus(imageId, true);
|
||||
}
|
||||
|
||||
_imageCachePromiseRemovedEventHandle(e, eventData) {
|
||||
const imageId = eventData.imageId;
|
||||
this._updateImageStatus(imageId, false);
|
||||
}
|
||||
|
||||
_updateProgress() {
|
||||
const totalFramesCount = this.stack.imageIds.length;
|
||||
const loadedFramesCount = this.loadedCount;
|
||||
const loadingFramesCount = totalFramesCount - loadedFramesCount;
|
||||
const percentComplete = Math.round(loadedFramesCount / totalFramesCount * 100);
|
||||
const progressSessionId = this._getProgressSessionId();
|
||||
|
||||
Session.set(progressSessionId, {
|
||||
multiFrame: true,
|
||||
totalFramesCount,
|
||||
loadedFramesCount,
|
||||
loadingFramesCount,
|
||||
percentComplete,
|
||||
framesPerSecond: this.stats.speed,
|
||||
framesStatus: this.framesStatus
|
||||
});
|
||||
}
|
||||
|
||||
_logProgress() {
|
||||
const totalFramesCount = this.stack.imageIds.length;
|
||||
const displaySetInstanceUid = this.stack.displaySetInstanceUid;
|
||||
let progressBar = '[';
|
||||
|
||||
for(let i = 0; i < totalFramesCount; i++) {
|
||||
const ch = this.framesStatus[i] ? '|' : '.';
|
||||
progressBar += `${ch}`;
|
||||
}
|
||||
|
||||
progressBar += ']';
|
||||
console.log(`${displaySetInstanceUid}: ${progressBar}`);
|
||||
}
|
||||
}
|
||||
|
||||
class StudyLoadingListener {
|
||||
constructor() {
|
||||
this.listeners = {};
|
||||
}
|
||||
|
||||
addStack(stack, options) {
|
||||
const displaySetInstanceUid = stack.displaySetInstanceUid;
|
||||
|
||||
if (!this.listeners[displaySetInstanceUid]) {
|
||||
listener = this._createListener(stack, options);
|
||||
if (listener) {
|
||||
this.listeners[displaySetInstanceUid] = listener;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
addStudy(study) {
|
||||
study.displaySets.forEach(displaySet => {
|
||||
const stack = OHIF.viewerbase.stackManager.findOrCreateStack(study, displaySet);
|
||||
this.addStack(stack, {
|
||||
isMultiFrame: displaySet.isMultiFrame
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
addStudies(studies) {
|
||||
if (!studies || !studies.length) {
|
||||
return;
|
||||
}
|
||||
|
||||
for (let i = 0; i < studies.length; i++) {
|
||||
this.addStudy(studies[i]);
|
||||
}
|
||||
}
|
||||
|
||||
clear() {
|
||||
const displaySetInstanceUids = Object.keys(this.listeners);
|
||||
const length = displaySetInstanceUids.length;
|
||||
|
||||
for (let i = 0; i < length; i++) {
|
||||
const displaySetInstanceUid = displaySetInstanceUids[i];
|
||||
const displaySet = this.listeners[displaySetInstanceUid];
|
||||
|
||||
displaySet.destroy();
|
||||
}
|
||||
|
||||
this.listeners = {};
|
||||
}
|
||||
|
||||
_createListener(stack, options) {
|
||||
const schema = this._getSchema(stack);
|
||||
|
||||
if ((schema === 'wadors') || !options.isMultiFrame) {
|
||||
return new StackLoadingListener(stack);
|
||||
} else if ((schema === 'dicomweb') || (schema === 'wadouri')) {
|
||||
return new DICOMFileLoadingListener(stack);
|
||||
}
|
||||
}
|
||||
|
||||
_getSchema(stack) {
|
||||
const imageId = stack.imageIds[0];
|
||||
const colonIndex = imageId.indexOf(':');
|
||||
return imageId.substring(0, colonIndex);
|
||||
}
|
||||
|
||||
// Singleton
|
||||
static getInstance() {
|
||||
if(!StudyLoadingListener._instance) {
|
||||
StudyLoadingListener._instance = new StudyLoadingListener();
|
||||
}
|
||||
|
||||
return StudyLoadingListener._instance;
|
||||
}
|
||||
}
|
||||
|
||||
export { StudyLoadingListener };
|
||||
Reference in new issue
Block a user