Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 | 1x | import { vec3 } from 'gl-matrix';
import {
Events as EVENTS,
VideoEnums as VideoViewportEnum,
MetadataModules,
} from '../enums';
import type {
IVideoViewport,
VideoViewportProperties,
Point3,
Point2,
ICamera,
InternalVideoCamera,
VideoViewportInput,
VOIRange,
ICanvasActor,
IImage,
ViewReferenceSpecifier,
ViewReference,
ReferenceCompatibleOptions,
} from '../types';
import * as metaData from '../metaData';
import { Transform } from './helpers/cpuFallback/rendering/transform';
import { triggerEvent } from '../utilities';
import Viewport from './Viewport';
import { getOrCreateCanvas } from './helpers';
import CanvasActor from './CanvasActor';
import cache from '../cache';
/**
* A data type for the scalar data for video data.
*/
export type CanvasScalarData = Uint8ClampedArray & {
frameNumber?: number;
getRange?: () => [number, number];
};
/**
* An object representing a single stack viewport, which is a camera
* looking into an internal scene, and an associated target output `canvas`.
*/
class VideoViewport extends Viewport implements IVideoViewport {
public static frameRangeExtractor = /(\/frames\/|[&?]frameNumber=)([^/&?]*)/i;
public modality;
// Viewport Data
protected imageId: string;
readonly uid;
readonly renderingEngineId: string;
readonly canvasContext: CanvasRenderingContext2D;
private videoElement?: HTMLVideoElement;
private videoWidth = 0;
private videoHeight = 0;
private loop = true;
private mute = true;
private isPlaying = false;
private scrollSpeed = 1;
private playbackRate = 1;
private scalarData: CanvasScalarData;
/**
* This is used to pause initially so that we get at least one render to allow
* navigating frames. Otherwise the viewport is blank initially until the user
* hits play manually.
*/
private initialRender: () => void;
/**
* The range is the set of frames to play
*/
private frameRange: [number, number] = [0, 0];
protected metadata;
/**
* The fps, frames per second is used to calculate time/frame mapping values.
* It is provided by the CINE Module in the metadata, defaulting to 30 if not
* provided.
*/
private fps = 30;
/** The number of frames in the video */
private numberOfFrames = 0;
private videoCamera: InternalVideoCamera = {
panWorld: [0, 0],
parallelScale: 1,
};
/**
* feFilter is an inline string value for the CSS filter on the video
* CSS filters can reference SVG filters, so for the typical use case here
* the CSS filter is actually an link link to a SVG filter.
*/
private feFilter: string;
/**
* An average white point value, used to color balance the image so that
* the given white is mapped to [255,255,255] via multiplication per channel.
*/
private averageWhite: [number, number, number];
/**
* The VOI Range is used to apply contrast/brightness adjustments to the image.
*/
private voiRange: VOIRange = {
lower: 0,
upper: 255,
};
constructor(props: VideoViewportInput) {
super({
...props,
canvas: props.canvas || getOrCreateCanvas(props.element),
});
this.canvasContext = this.canvas.getContext('2d');
this.renderingEngineId = props.renderingEngineId;
this.element.setAttribute('data-viewport-uid', this.id);
this.element.setAttribute(
'data-rendering-engine-uid',
this.renderingEngineId
);
this.videoElement = document.createElement('video');
this.videoElement.muted = this.mute;
this.videoElement.loop = this.loop;
this.videoElement.autoplay = true;
this.videoElement.crossOrigin = 'anonymous';
this.addEventListeners();
this.resize();
}
public static get useCustomRenderingPipeline() {
return true;
}
private addEventListeners() {
this.canvas.addEventListener(
EVENTS.ELEMENT_DISABLED,
this.elementDisabledHandler
);
}
private removeEventListeners() {
this.canvas.removeEventListener(
EVENTS.ELEMENT_DISABLED,
this.elementDisabledHandler
);
}
private elementDisabledHandler() {
this.removeEventListeners();
this.videoElement.remove();
}
public getImageDataMetadata(image: IImage | string) {
const imageId = typeof image === 'string' ? image : image.imageId;
const imagePlaneModule = metaData.get(MetadataModules.IMAGE_PLANE, imageId);
let rowCosines = <Point3>imagePlaneModule.rowCosines;
let columnCosines = <Point3>imagePlaneModule.columnCosines;
// if null or undefined
if (rowCosines == null || columnCosines == null) {
rowCosines = <Point3>[1, 0, 0];
columnCosines = <Point3>[0, 1, 0];
}
const rowCosineVec = vec3.fromValues(
rowCosines[0],
rowCosines[1],
rowCosines[2]
);
const colCosineVec = vec3.fromValues(
columnCosines[0],
columnCosines[1],
columnCosines[2]
);
const { rows, columns } = imagePlaneModule;
const scanAxisNormal = vec3.create();
vec3.cross(scanAxisNormal, rowCosineVec, colCosineVec);
let origin = imagePlaneModule.imagePositionPatient;
// if null or undefined
if (origin == null) {
origin = [0, 0, 0];
}
const xSpacing = imagePlaneModule.columnPixelSpacing || 1;
const ySpacing = imagePlaneModule.rowPixelSpacing || 1;
const xVoxels = imagePlaneModule.columns;
const yVoxels = imagePlaneModule.rows;
const zSpacing = 1;
const zVoxels = 1;
this.hasPixelSpacing = !!imagePlaneModule.columnPixelSpacing;
return {
bitsAllocated: 8,
numComps: 3,
origin,
rows,
columns,
direction: [...rowCosineVec, ...colCosineVec, ...scanAxisNormal],
dimensions: [xVoxels, yVoxels, zVoxels],
spacing: [xSpacing, ySpacing, zSpacing],
hasPixelSpacing: this.hasPixelSpacing,
numVoxels: xVoxels * yVoxels * zVoxels,
imagePlaneModule,
};
}
/**
* Sets the video image id to show and hte frame number.
* Requirements are to have the imageUrlModule in the metadata
* with the rendered endpoint being the raw video in video/mp4 format.
*/
public setVideo(imageId: string, frameNumber?: number): Promise<unknown> {
this.imageId = Array.isArray(imageId) ? imageId[0] : imageId;
const { rendered } = metaData.get(MetadataModules.IMAGE_URL, imageId);
const generalSeries = metaData.get(MetadataModules.GENERAL_SERIES, imageId);
this.modality = generalSeries?.Modality;
this.metadata = this.getImageDataMetadata(imageId);
return this.setVideoURL(rendered).then(() => {
let { cineRate, numberOfFrames } = metaData.get(
MetadataModules.CINE,
imageId
);
if (!numberOfFrames) {
numberOfFrames = Math.round(
this.videoElement.duration * (cineRate || 30)
);
}
if (!cineRate) {
cineRate = Math.round(numberOfFrames / this.videoElement.duration);
}
this.fps = cineRate;
this.numberOfFrames = numberOfFrames;
// 1 based range setting
this.setFrameRange([1, numberOfFrames]);
// The initial render allows us to set the frame position - rendering needs
// to start already playing
this.initialRender = () => {
this.initialRender = null;
this.pause();
this.setFrameNumber(frameNumber || 1);
};
// This is ugly, but without it, the video often fails to render initially
// so having a play, followed by a pause fixes things.
// 25 ms is a tested value that seems to work to prevent exceptions
return new Promise((resolve) => {
window.setTimeout(() => {
this.setFrameNumber(frameNumber || 1);
resolve(this);
}, 25);
});
});
}
public async setVideoURL(videoURL: string) {
return new Promise((resolve) => {
this.videoElement.src = videoURL;
this.videoElement.preload = 'auto';
const loadedMetadataEventHandler = () => {
this.videoWidth = this.videoElement.videoWidth;
this.videoHeight = this.videoElement.videoHeight;
this.videoElement.removeEventListener(
'loadedmetadata',
loadedMetadataEventHandler
);
this.refreshRenderValues();
resolve(true);
};
this.videoElement.addEventListener(
'loadedmetadata',
loadedMetadataEventHandler
);
});
}
/**
* Gets all the image ids associated with this video element. This will
* have # of frames elements.
*/
public getImageIds(): string[] {
const imageIds = new Array<string>(this.numberOfFrames);
const baseImageId = this.imageId.replace(/[0-9]+$/, '');
for (let i = 0; i < this.numberOfFrames; i++) {
imageIds[i] = `${baseImageId}${i + 1}`;
}
return imageIds;
}
public togglePlayPause(): boolean {
if (this.isPlaying) {
this.pause();
return false;
} else {
this.play();
return true;
}
}
public async play() {
try {
if (!this.isPlaying) {
// Play returns a promise that is true when playing completes.
await this.videoElement.play();
this.isPlaying = true;
this.renderWhilstPlaying();
}
} catch (e) {
// No-op, an exception sometimes gets thrown on the initial play, not
// quite sure why. Catching it prevents displaying an error
}
}
public async pause() {
try {
await this.videoElement.pause();
this.isPlaying = false;
} catch (e) {
// No-op - sometimes this happens on startup
}
}
public async scroll(delta = 1) {
await this.pause();
const videoElement = this.videoElement;
const renderFrame = this.renderFrame;
const currentTime = videoElement.currentTime;
const newTime = currentTime + (delta * this.scrollSpeed) / this.fps;
videoElement.currentTime = newTime;
// Need to wait for seek update
const seekEventListener = (evt) => {
renderFrame();
videoElement.removeEventListener('seeked', seekEventListener);
};
videoElement.addEventListener('seeked', seekEventListener);
}
public async start() {
const videoElement = this.videoElement;
const renderFrame = this.renderFrame;
videoElement.currentTime = 0;
if (videoElement.paused) {
// Need to wait for seek update
const seekEventListener = (evt) => {
renderFrame();
videoElement.removeEventListener('seeked', seekEventListener);
};
videoElement.addEventListener('seeked', seekEventListener);
}
}
public async end() {
const videoElement = this.videoElement;
const renderFrame = this.renderFrame;
videoElement.currentTime = videoElement.duration;
if (videoElement.paused) {
// Need to wait for seek update
const seekEventListener = (evt) => {
renderFrame();
videoElement.removeEventListener('seeked', seekEventListener);
};
videoElement.addEventListener('seeked', seekEventListener);
}
}
public async setTime(timeInSeconds: number) {
const videoElement = this.videoElement;
const renderFrame = this.renderFrame;
videoElement.currentTime = timeInSeconds;
if (videoElement.paused) {
// Need to wait for seek update
const seekEventListener = (evt) => {
renderFrame();
videoElement.removeEventListener('seeked', seekEventListener);
};
videoElement.addEventListener('seeked', seekEventListener);
}
}
// Sets the frame number - note according to DICOM, this is 1 based
public async setFrameNumber(frame: number) {
this.setTime((frame - 1) / this.fps);
}
/**
* Sets the playback frame range. The video will play over the given set
* of frames (assuming it is playing).
* @param frameRange - the minimum to maximum (inclusive) frames to play over
* @returns
*/
public setFrameRange(frameRange: number[]) {
if (!frameRange) {
this.frameRange = [1, this.numberOfFrames];
return;
}
if (frameRange.length !== 2 || frameRange[0] === frameRange[1]) {
return;
}
this.frameRange = [frameRange[0], frameRange[1]];
}
public getFrameRange(): [number, number] {
return this.frameRange;
}
public setProperties(props: VideoViewportProperties) {
if (props.loop !== undefined) {
this.videoElement.loop = props.loop;
}
if (props.muted !== undefined) {
this.videoElement.muted = props.muted;
}
if (props.playbackRate !== undefined) {
this.setPlaybackRate(props.playbackRate);
}
if (props.scrollSpeed !== undefined) {
this.setScrollSpeed(props.scrollSpeed);
}
if (props.voiRange) {
this.setVOI(props.voiRange);
}
}
public setPlaybackRate(rate = 1) {
this.playbackRate = rate;
// Minimum playback speed in chrome is 0.0625 compared to normal
if (rate < 0.0625) {
this.pause();
return;
}
if (!this.videoElement) {
return;
}
this.videoElement.playbackRate = rate;
this.play();
}
public setScrollSpeed(
scrollSpeed = 1,
unit = VideoViewportEnum.SpeedUnit.FRAME
) {
this.scrollSpeed =
unit === VideoViewportEnum.SpeedUnit.SECOND
? scrollSpeed * this.fps
: scrollSpeed;
}
public getProperties = (): VideoViewportProperties => {
return {
loop: this.videoElement.loop,
muted: this.videoElement.muted,
playbackRate: this.playbackRate,
scrollSpeed: this.scrollSpeed,
voiRange: { ...this.voiRange },
};
};
public resetProperties() {
this.setProperties({
loop: false,
muted: true,
});
}
protected getScalarData(): CanvasScalarData {
if (this.scalarData?.frameNumber === this.getFrameNumber()) {
return this.scalarData;
}
const canvas = document.createElement('canvas');
canvas.width = this.videoWidth;
canvas.height = this.videoHeight;
const context = canvas.getContext('2d');
context.drawImage(this.videoElement, 0, 0);
const canvasData = context.getImageData(
0,
0,
this.videoWidth,
this.videoHeight
);
const scalarData = canvasData.data as CanvasScalarData;
scalarData.getRange = () => [0, 255];
scalarData.frameNumber = this.getFrameNumber();
this.scalarData = scalarData;
return scalarData;
}
public getImageData() {
const { metadata } = this;
const spacing = metadata.spacing;
const imageData = {
dimensions: metadata.dimensions,
spacing,
origin: metadata.origin,
direction: metadata.direction,
metadata: { Modality: this.modality },
getScalarData: () => this.getScalarData(),
imageData: {
getDirection: () => metadata.direction,
getDimensions: () => metadata.dimensions,
getRange: () => [0, 255],
getScalarData: () => this.getScalarData(),
getSpacing: () => metadata.spacing,
worldToIndex: (point: Point3) => {
const canvasPoint = this.worldToCanvas(point);
const pixelCoord = this.canvasToIndex(canvasPoint);
return [pixelCoord[0], pixelCoord[1], 0];
},
indexToWorld: (point: Point2, destPoint?: Point3) => {
const canvasPoint = this.indexToCanvas([point[0], point[1]]);
return this.canvasToWorld(canvasPoint, destPoint);
},
},
hasPixelSpacing: this.hasPixelSpacing,
calibration: this.calibration,
preScale: {
scaled: false,
},
};
Object.defineProperty(imageData, 'scalarData', {
get: () => this.getScalarData(),
enumerable: true,
});
return imageData;
}
/**
* Checks to see if the imageURI is currently being displayed. The imageURI
* may contain frame numbers according to the DICOM standard format, which
* will be stripped to compare the base image URI, and then the values used
* to check if that frame is currently being displayed.
*
* The DICOM standard allows for comma separated values as well, however,
* this is not supported here, with only a single range or single value
* being tested.
*
* For a single value, the time range +/- 5 frames is permitted to allow
* the detection to actually succeed when nearby without requiring an exact
* time frame to be matched.
*
* @param imageURI - containing frame number or range.
* @returns
*/
public hasImageURI(imageURI: string) {
// TODO - move annotationFrameRange into core so it can be used here.
const framesMatch = imageURI.match(VideoViewport.frameRangeExtractor);
const testURI = framesMatch
? imageURI.substring(0, framesMatch.index)
: imageURI;
return this.imageId.indexOf(testURI) !== -1;
}
public setVOI(voiRange: VOIRange): void {
this.voiRange = voiRange;
this.setColorTransform();
}
public setWindowLevel(windowWidth = 256, windowCenter = 128) {
const lower = windowCenter - windowWidth / 2;
const upper = windowCenter + windowWidth / 2 - 1;
this.setVOI({ lower, upper });
this.setColorTransform();
}
public setAverageWhite(averageWhite: [number, number, number]) {
this.averageWhite = averageWhite;
this.setColorTransform();
}
protected setColorTransform() {
if (!this.voiRange && !this.averageWhite) {
this.feFilter = null;
return;
}
const white = this.averageWhite || [255, 255, 255];
const maxWhite = Math.max(...white);
const scaleWhite = white.map((c) => maxWhite / c);
const { lower = 0, upper = 255 } = this.voiRange || {};
const wlScale = (upper - lower + 1) / 255;
const wlDelta = lower / 255;
this.feFilter = `url('data:image/svg+xml,\
<svg xmlns="http://www.w3.org/2000/svg">\
<filter id="colour" color-interpolation-filters="linearRGB">\
<feColorMatrix type="matrix" \
values="\
${scaleWhite[0] * wlScale} 0 0 0 ${wlDelta} \
0 ${scaleWhite[1] * wlScale} 0 0 ${wlDelta} \
0 0 ${scaleWhite[2] * wlScale} 0 ${wlDelta} \
0 0 0 1 0" />\
</filter>\
</svg>#colour')`;
this.canvas.style.filter = this.feFilter;
}
public setCamera(camera: ICamera): void {
const { parallelScale, focalPoint } = camera;
// NOTE: the parallel scale should be done first
// because it affects the focal point later
if (parallelScale) {
this.videoCamera.parallelScale =
this.element.clientHeight / 2 / parallelScale;
}
if (focalPoint !== undefined) {
const focalPointCanvas = this.worldToCanvas(focalPoint);
const canvasCenter: Point2 = [
this.element.clientWidth / 2,
this.element.clientHeight / 2,
];
const panWorldDelta: Point2 = [
(focalPointCanvas[0] - canvasCenter[0]) /
this.videoCamera.parallelScale,
(focalPointCanvas[1] - canvasCenter[1]) /
this.videoCamera.parallelScale,
];
this.videoCamera.panWorld = [
this.videoCamera.panWorld[0] - panWorldDelta[0],
this.videoCamera.panWorld[1] - panWorldDelta[1],
];
}
this.canvasContext.fillStyle = 'rgba(0,0,0,1)';
this.canvasContext.fillRect(0, 0, this.canvas.width, this.canvas.height);
if (this.isPlaying === false) {
this.renderFrame();
}
}
/**
* This function returns the imageID associated with either the current
* frame being displayed, or the range of frames being played. This may not
* correspond to any particular imageId that has imageId metadata, as the
* format is one of:
* `<DICOMweb URI>/frames/<Start Frame>(-<End Frame>)?`
* or
* `<Other URI>[?&]frameNumber=<Start Frame>(-<EndFrame>)?`
* for a URL parameter.
*
* @returns an imageID for video
*/
public getCurrentImageId() {
const current = this.imageId.replace(
'/frames/1',
this.isPlaying
? `/frames/${this.frameRange[0]}-${this.frameRange[1]}`
: `/frames/${this.getFrameNumber()}`
);
return current;
}
/**
* Gets a target id that can be used to specify how to show this
*/
public getReferenceId(specifier: ViewReferenceSpecifier = {}): string {
const { sliceIndex: sliceIndex } = specifier;
if (sliceIndex === undefined) {
return `videoId:${this.getCurrentImageId()}`;
}
if (Array.isArray(sliceIndex)) {
// Just remove the 1 from the end of the base URL - TODO, handle other types
return `videoId:${this.imageId.substring(0, this.imageId.length - 1)}${
sliceIndex[0] + 1
}-${sliceIndex[1] + 1}`;
}
const baseTarget = this.imageId.replace(
'/frames/1',
`/frames/${1 + sliceIndex}`
);
return `videoId:${baseTarget}`;
}
/**
* Figure out if a given view can be shown in the current viewport.
*/
public isReferenceViewable(
viewRef: ViewReference,
options: ReferenceCompatibleOptions = {}
): boolean {
let { imageURI } = options;
const { referencedImageId, sliceIndex: sliceIndex } = viewRef;
if (!super.isReferenceViewable(viewRef)) {
return false;
}
const imageId = this.getCurrentImageId();
if (!imageURI) {
// Remove the dataLoader scheme and frame number
// TODO - handle more imageURI types.
const colonIndex = imageId.indexOf(':');
imageURI = imageId.substring(colonIndex + 1, imageId.length - 1);
}
if (options.withNavigation) {
return true;
}
const currentIndex = this.getCurrentImageIdIndex();
if (Array.isArray(sliceIndex)) {
return currentIndex >= sliceIndex[0] && currentIndex <= sliceIndex[1];
}
if (sliceIndex !== undefined) {
return currentIndex === sliceIndex;
}
if (!referencedImageId) {
return false;
}
const match = referencedImageId.match(VideoViewport.frameRangeExtractor);
if (!match || !match[2]) {
return true;
}
const range = match[2].split('-').map((it) => Number(it));
const frame = currentIndex + 1;
return range[0] <= frame && frame <= (range[1] ?? range[0]);
}
/**
* Gets a view target that species what type of view is required to show
* the current view, or the one specified in the forTarget modifiers.
*/
public getViewReference(
viewRefSpecifier?: ViewReferenceSpecifier
): ViewReference {
let sliceIndex = viewRefSpecifier?.sliceIndex;
if (!sliceIndex) {
sliceIndex = this.isPlaying
? [this.frameRange[0] - 1, this.frameRange[1] - 1]
: this.getCurrentImageIdIndex();
}
return {
...super.getViewReference(viewRefSpecifier),
referencedImageId: this.getReferenceId(viewRefSpecifier),
sliceIndex: sliceIndex,
};
}
/**
* Gets the 1 based frame number (ala DICOM value), eg `1+ currentImageIdIndex`
*/
public getFrameNumber() {
// Need to round this as the fps/time isn't exact
return 1 + this.getCurrentImageIdIndex();
}
public getCurrentImageIdIndex() {
return Math.round(this.videoElement.currentTime * this.fps);
}
public getCamera(): ICamera {
const { parallelScale } = this.videoCamera;
const canvasCenter: Point2 = [
this.element.clientWidth / 2,
this.element.clientHeight / 2,
];
// All other viewports have the focal point in canvas coordinates in the center
// of the canvas, so to make tools work the same, we need to do the same here
// and convert to the world coordinate system since focal point is in world coordinates.
const canvasCenterWorld = this.canvasToWorld(canvasCenter);
return {
parallelProjection: true,
focalPoint: canvasCenterWorld,
position: [0, 0, 0],
viewUp: [0, -1, 0],
parallelScale: this.element.clientHeight / 2 / parallelScale, // Reverse zoom direction back
viewPlaneNormal: [0, 0, 1],
};
}
public resetCamera = (): boolean => {
this.refreshRenderValues();
this.canvasContext.fillRect(0, 0, this.canvas.width, this.canvas.height);
if (this.isPlaying === false) {
// If its not replaying, just re-render the frame on move.
this.renderFrame();
}
return true;
};
public getNumberOfSlices = (): number => {
return Math.round(
(this.videoElement.duration * this.fps) / this.scrollSpeed
);
};
public getFrameOfReferenceUID = (): string => {
// The video itself is the frame of reference.
return this.videoElement.src;
};
public resize = (): void => {
const canvas = this.canvas;
const { clientWidth, clientHeight } = canvas;
// Set the canvas to be same resolution as the client.
if (canvas.width !== clientWidth || canvas.height !== clientHeight) {
canvas.width = clientWidth;
canvas.height = clientHeight;
}
this.refreshRenderValues();
if (this.isPlaying === false) {
// If its not playing, just re-render on resize.
this.renderFrame();
}
};
/**
* Converts a VideoViewport canvas coordinate to a video coordinate.
*
* @param canvasPos - to convert to world
* @returns World position
*/
public canvasToWorld = (
canvasPos: Point2,
destPos: Point3 = [0, 0, 0]
): Point3 => {
const pan: Point2 = this.videoCamera.panWorld; // In world coordinates
const worldToCanvasRatio: number = this.getWorldToCanvasRatio();
const panOffsetCanvas: Point2 = [
pan[0] * worldToCanvasRatio,
pan[1] * worldToCanvasRatio,
];
const subCanvasPos: Point2 = [
canvasPos[0] - panOffsetCanvas[0],
canvasPos[1] - panOffsetCanvas[1],
];
// Replace the x,y values only in place in the world position
// as the z is unchanging for video display
destPos.splice(
0,
2,
subCanvasPos[0] / worldToCanvasRatio,
subCanvasPos[1] / worldToCanvasRatio
);
return destPos;
};
/**
* Converts `[x, y, 0]` world video coordinate to canvas CSS coordinates.
*
* @param worldPos - world coord to convert to canvas
* @returns Canvas position
*/
public worldToCanvas = (worldPos: Point3): Point2 => {
const pan: Point2 = this.videoCamera.panWorld;
const worldToCanvasRatio: number = this.getWorldToCanvasRatio();
const canvasPos: Point2 = [
(worldPos[0] + pan[0]) * worldToCanvasRatio,
(worldPos[1] + pan[1]) * worldToCanvasRatio,
];
return canvasPos;
};
public getPan(): Point2 {
const panWorld = this.videoCamera.panWorld;
return [panWorld[0], panWorld[1]];
}
public getRotation = () => 0;
/**
* Uses the transform to convert canvas coordinates into index coordinates.
*/
protected canvasToIndex = (canvasPos: Point2): Point2 => {
const transform = this.getTransform();
transform.invert();
return transform.transformPoint(
<Point2>canvasPos.map((it) => it * devicePixelRatio)
);
};
protected indexToCanvas = (indexPos: Point2): Point2 => {
const transform = this.getTransform();
return <Point2>(
transform.transformPoint(indexPos).map((it) => it / devicePixelRatio)
);
};
/**
* Sets initial video camera to center the image area. The values
* are set in canvas CSS pixel units and NOT in canvas index units.
*/
private refreshRenderValues() {
// this means that each unit (pixel) in the world (video) would be
// represented by n pixels in the canvas, measured in css pixels
let worldToCanvasRatio = this.canvas.offsetWidth / this.videoWidth;
if (this.videoHeight * worldToCanvasRatio > this.canvas.height) {
// If by fitting the width, we exceed the height of the viewport, then we need to decrease the
// size of the viewport further by considering its verticality.
worldToCanvasRatio = this.canvas.offsetHeight / this.videoHeight;
}
// Set the width as big as possible, this is the portion of the canvas
// that the video will occupy.
const drawWidth = Math.floor(this.videoWidth * worldToCanvasRatio);
const drawHeight = Math.floor(this.videoHeight * worldToCanvasRatio);
// calculate x and y offset in order to center the image
const xOffsetCanvas = (this.canvas.offsetWidth - drawWidth) / 2;
const yOffsetCanvas = (this.canvas.offsetHeight - drawHeight) / 2;
const xOffsetWorld = xOffsetCanvas / worldToCanvasRatio;
const yOffsetWorld = yOffsetCanvas / worldToCanvasRatio;
this.videoCamera.panWorld = [xOffsetWorld, yOffsetWorld];
this.videoCamera.parallelScale = worldToCanvasRatio;
}
private getWorldToCanvasRatio() {
return this.videoCamera.parallelScale;
}
private getCanvasToWorldRatio() {
return 1.0 / this.videoCamera.parallelScale;
}
public customRenderViewportToCanvas = () => {
this.renderFrame();
};
/**
* Creates a transform from video index coordinates to canvas coordinates.
*/
protected getTransform() {
const panWorld: Point2 = this.videoCamera.panWorld;
const devicePixelRatio = window.devicePixelRatio || 1;
const worldToCanvasRatio: number = this.getWorldToCanvasRatio();
const canvasToWorldRatio: number = this.getCanvasToWorldRatio();
const halfCanvas = [
this.canvas.offsetWidth / 2,
this.canvas.offsetHeight / 2,
];
const halfCanvasWorldCoordinates = [
halfCanvas[0] * canvasToWorldRatio,
halfCanvas[1] * canvasToWorldRatio,
];
const transform = new Transform();
// Start by converting into canvas index coordinates FROM canvas css pixel coordinates
transform.scale(devicePixelRatio, devicePixelRatio);
// Translate to the center of the canvas (move origin of the transform
// to the center of the canvas)
transform.translate(halfCanvas[0], halfCanvas[1]);
// Scale
transform.scale(worldToCanvasRatio, worldToCanvasRatio);
// Apply the translation
transform.translate(panWorld[0], panWorld[1]);
// Translate back
transform.translate(
-halfCanvasWorldCoordinates[0],
-halfCanvasWorldCoordinates[1]
);
return transform;
}
/**
* Nothing to do for the clipping planes for video as they don't exist.
*/
public updateCameraClippingPlanesAndRange() {
// No-op
}
public addImages(stackInputs: Array<any>) {
const actors = this.getActors();
stackInputs.forEach((stackInput) => {
const image = cache.getImage(stackInput.imageId);
const imageActor = this.createActorMapper(image);
if (imageActor) {
actors.push({ uid: stackInput.actorUID, actor: imageActor });
if (stackInput.callback) {
stackInput.callback({ imageActor, imageId: stackInput.imageId });
}
}
});
this.setActors(actors);
}
protected createActorMapper(image) {
return new CanvasActor(this, image);
}
/**
* Renders the video frame to the viewport.
*/
private renderFrame = () => {
const transform = this.getTransform();
const transformationMatrix: number[] = transform.getMatrix();
const ctx = this.canvasContext;
ctx.resetTransform();
// Need to correct the transform for device pixel ratio scaling.
ctx.transform(
transformationMatrix[0],
transformationMatrix[1],
transformationMatrix[2],
transformationMatrix[3],
transformationMatrix[4],
transformationMatrix[5]
);
ctx.drawImage(this.videoElement, 0, 0, this.videoWidth, this.videoHeight);
for (const actor of this.getActors()) {
(actor.actor as ICanvasActor).render(this, this.canvasContext);
}
this.canvasContext.resetTransform();
// This is stack new image to agree with stack/non-volume viewports
triggerEvent(this.element, EVENTS.STACK_NEW_IMAGE, {
element: this.element,
viewportId: this.id,
viewport: this,
renderingEngineId: this.renderingEngineId,
time: this.videoElement.currentTime,
duration: this.videoElement.duration,
});
triggerEvent(this.element, EVENTS.IMAGE_RENDERED, {
element: this.element,
viewportId: this.id,
viewport: this,
renderingEngineId: this.renderingEngineId,
time: this.videoElement.currentTime,
duration: this.videoElement.duration,
});
this.initialRender?.();
const frame = this.getFrameNumber();
if (this.isPlaying) {
if (frame < this.frameRange[0]) {
this.setFrameNumber(this.frameRange[0]);
} else if (frame > this.frameRange[1]) {
if (this.loop) {
this.setFrameNumber(this.frameRange[0]);
} else {
this.pause();
}
}
}
};
private renderWhilstPlaying = () => {
this.renderFrame();
//wait approximately 16ms and run again
if (this.isPlaying) {
requestAnimationFrame(this.renderWhilstPlaying);
}
};
}
export default VideoViewport;
|