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 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 | 428x 428x 428x 428x 428x 428x 428x 428x 428x 58x 58x 58x 174x 174x 1102x 1102x 58x 428x 428x 13992x 13992x 2394145x 1884047x 510098x 13992x 13992x 27994x 27976x 27976x 428x 428x 428x 428x 13984x 13984x 13984x 13972x 13972x 13972x 13972x 13972x 13972x 13972x 13972x 13972x 13972x 13972x 13972x 4138x 13972x 13972x 9634x 9634x 9634x 9634x 9634x 9634x 9634x 9634x 9458x 9458x 4514x 4514x 4514x 4514x 4514x 4514x 25732x 25732x 25732x 19364x 6368x 6368x 2138x 2138x 1036x 1102x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 36x 36x 36x 272x 36x 36x 246x 246x 246x 246x 12438x 12438x 4444x 246x 246x 132x 132x 132x 132x 132x 132x 114x 114x 114x 114x 114x 114x 114x 114x 114x 428x 498x 498x 498x 114x 384x 384x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 428x 428x 356x 356x 356x 12x 344x 344x 428x 428x 428x 12x 428x 428x 428x 325830314x 325830314x 325830314x 342x 325829972x 325829972x 325829972x 1815x 1815x 1815x 1815x 6084x 6084x 428x 27610x 27610x 27610x 50x 27560x 27560x 428x 428x 428x 428x 428x 13972x 428x 428x 428x | import type {
ICache,
IImage,
IGeometry,
IImageLoadObject,
IVolumeLoadObject,
IGeometryLoadObject,
ICachedImage,
ICachedVolume,
ICachedGeometry,
EventTypes,
IImageVolume,
} from '../types';
import triggerEvent from '../utilities/triggerEvent';
import imageIdToURI from '../utilities/imageIdToURI';
import eventTarget from '../eventTarget';
import Events from '../enums/Events';
import { ImageQualityStatus } from '../enums';
import fnv1aHash from '../utilities/fnv1aHash';
const ONE_GB = 1073741824;
/**
* Stores images, volumes and geometry.
* There are two sizes - the max cache size, that controls the overall maximum
* size, and the instance size, which controls how big any single object can
* be. Defaults are 3 GB and 2 GB - 8 bytes (just enough to allow allocating it
* without crashing).
* The 3 gb is tuned to the chromium garbage collection cycle to allow image volumes
* to be used/discarded.
*/
class Cache {
// used to store image data (2d)
private readonly _imageCache = new Map<string, ICachedImage>();
// used to store volume data (3d)
private readonly _volumeCache = new Map<string, ICachedVolume>();
// used to store the reverse lookup from imageIds to volumeId
private readonly _imageIdsToVolumeIdCache = new Map<string, string>();
// used to store the reverse lookup from referencedImageIds to imageIds
private readonly _referencedImageIdToImageIdCache = new Map<string, string>();
// Todo: contour for now, but will be used for surface, etc.
private readonly _geometryCache = new Map<string, ICachedGeometry>();
private _imageCacheSize = 0;
private _maxCacheSize = 3 * ONE_GB;
private _geometryCacheSize = 0;
/**
* Generates a deterministic volume ID from a list of image IDs
* @param imageIds - Array of image IDs
* @returns A deterministic volume ID
*/
public generateVolumeId(imageIds: string[]): string {
const imageURIs = imageIds.map(imageIdToURI).sort();
let combinedHash = 0x811c9dc5;
for (const id of imageURIs) {
const idHash = fnv1aHash(id);
for (let i = 0; i < idHash.length; i++) {
combinedHash ^= idHash.charCodeAt(i);
combinedHash +=
(combinedHash << 1) +
(combinedHash << 4) +
(combinedHash << 7) +
(combinedHash << 8) +
(combinedHash << 24);
}
}
return `volume-${(combinedHash >>> 0).toString(36)}`;
}
public getImageIdsForVolumeId(volumeId: string): string[] {
return Array.from(this._imageIdsToVolumeIdCache.entries())
.filter(([_, id]) => id === volumeId)
.map(([key]) => key);
}
/**
* Set the maximum cache Size
*
* Maximum cache size should be set before adding the data. If set after,
* and it is smaller than the current size, will cause issues.
*
* @param newMaxCacheSize - new maximum cache size
*
*/
public setMaxCacheSize = (newMaxCacheSize: number): void => {
if (!newMaxCacheSize || typeof newMaxCacheSize !== 'number') {
const errorMessage = `New max cacheSize ${this._maxCacheSize} should be defined and should be a number.`;
throw new Error(errorMessage);
}
this._maxCacheSize = newMaxCacheSize;
};
/**
* Determines if the cache can accommodate the requested byte size.
*
* This method calculates the available space by considering both unallocated space
* and the potential space that can be freed by purging non-shared images.
* It returns true if this available space exceeds the requested byteLength.
*
* @param byteLength - The number of bytes to be cached.
* @returns {boolean} True if the cache can accommodate the requested size, false otherwise.
*/
public isCacheable = (byteLength) => {
const bytesAvailable = this.getBytesAvailable();
const purgableImageBytes = Array.from(this._imageCache.values()).reduce(
(total, image) => {
if (!image.sharedCacheKey) {
return total + image.sizeInBytes;
}
return total;
},
0
);
const availableSpaceWithoutSharedCacheKey =
bytesAvailable + purgableImageBytes;
return availableSpaceWithoutSharedCacheKey >= byteLength;
};
/**
* Returns maximum CacheSize allowed
*
* @returns maximum allowed cache size
*/
public getMaxCacheSize = (): number => this._maxCacheSize;
/**
* Returns current size of the cache
*
* @returns current size of the cache
*/
public getCacheSize = (): number => this._imageCacheSize;
/**
* Returns the unallocated size of the cache
*
*/
public getBytesAvailable(): number {
return this.getMaxCacheSize() - this.getCacheSize();
}
/**
* Deletes the imageId from the image cache
*
* @param imageId - imageId
*
* @throws Error if the image is part of a shared cache key
*/
private _decacheImage = (imageId: string, force = false) => {
const cachedImage = this._imageCache.get(imageId);
if (!cachedImage) {
return;
}
if (cachedImage.sharedCacheKey && !force) {
throw new Error(
'Cannot decache an image with a shared cache key. You need to manually decache the volume first.'
);
}
const { imageLoadObject } = cachedImage;
// Remove from referencedImageId map if needed
if (cachedImage.image?.referencedImageId) {
this._referencedImageIdToImageIdCache.delete(
cachedImage.image.referencedImageId
);
}
// Cancel any in-progress loading
if (imageLoadObject?.cancelFn) {
imageLoadObject.cancelFn();
}
if (imageLoadObject?.decache) {
imageLoadObject.decache();
}
this._imageCache.delete(imageId);
};
/**
* Deletes the volumeId from the volume cache and removes shared cache keys for its images
*
* @param volumeId - volumeId
*
*/
private _decacheVolume = (volumeId: string) => {
const cachedVolume = this._volumeCache.get(volumeId);
if (!cachedVolume) {
return;
}
const { volumeLoadObject, volume } = cachedVolume;
if (!volume) {
return;
}
if (volume.cancelLoading) {
volume.cancelLoading();
}
if (volume.imageData) {
volume.imageData.delete();
}
if (volumeLoadObject.cancelFn) {
// Cancel any in-progress loading
volumeLoadObject.cancelFn();
}
// Remove shared cache keys for the volume's images
if (volume.imageIds) {
volume.imageIds.forEach((imageId) => {
const cachedImage = this._imageCache.get(imageId);
if (cachedImage && cachedImage.sharedCacheKey === volumeId) {
cachedImage.sharedCacheKey = undefined;
}
});
}
this._volumeCache.delete(volumeId);
};
/**
* Deletes all the images and volumes in the cache
*
* Relevant events are fired for each decached image (IMAGE_CACHE_IMAGE_REMOVED) and
* the decached volume (VOLUME_CACHE_VOLUME_REMOVED).
*
*
*/
public purgeCache = (): void => {
const imageIterator = this._imageCache.keys();
// need to purge volume cache first to avoid issues with image cache
// shared cache keys
this.purgeVolumeCache();
// eslint-disable-next-line no-constant-condition
while (true) {
const { value: imageId, done } = imageIterator.next();
if (done) {
break;
}
this.removeImageLoadObject(imageId, { force: true });
triggerEvent(eventTarget, Events.IMAGE_CACHE_IMAGE_REMOVED, { imageId });
}
};
/**
* Deletes all the volumes in the cache
*/
public purgeVolumeCache = (): void => {
const volumeIterator = this._volumeCache.keys();
// eslint-disable-next-line no-constant-condition
while (true) {
const { value: volumeId, done } = volumeIterator.next();
if (done) {
break;
}
this.removeVolumeLoadObject(volumeId);
triggerEvent(eventTarget, Events.VOLUME_CACHE_VOLUME_REMOVED, {
volumeId,
});
}
};
/**
* Purges the cache if necessary based on the requested number of bytes
*
* 1) it sorts the volatile (image) cache based on the most recent used images
* and starts purging from the oldest ones.
* Note: for a volume, if the volume-related image Ids is provided, it starts
* by purging the none-related image Ids (those that are not related to the
* current volume)
* 2) For a volume, if we purge all images that won't be included in this volume and still
* don't have enough unallocated space, purge images that will be included
* in this volume until we have enough space. These will need to be
* re-fetched, but we must do this not to straddle over the given memory
* limit, even for a short time, as this may crash the application.
*
* fires Events.IMAGE_CACHE_IMAGE_REMOVED
*
* @param numBytes - Number of bytes for the image/volume that is
* going to be stored inside the cache
* @param volumeImageIds - list of imageIds that correspond to the
* volume whose numberOfBytes we want to store in the cache.
* @returns bytesAvailable or undefined in purging cache
* does not successfully make enough space for the requested number of bytes
*/
public decacheIfNecessaryUntilBytesAvailable(
numBytes: number,
volumeImageIds?: string[]
): number | undefined {
let bytesAvailable = this.getBytesAvailable();
// If max cache size has not been exceeded, do nothing
Eif (bytesAvailable >= numBytes) {
return bytesAvailable;
}
const cachedImages = Array.from(this._imageCache.values()).filter(
(cachedImage) => !cachedImage.sharedCacheKey
);
// Cache size has been exceeded, create list of images sorted by timeStamp
// So we can purge the least recently used image
function compare(a, b) {
if (a.timeStamp > b.timeStamp) {
return 1;
}
if (a.timeStamp < b.timeStamp) {
return -1;
}
return 0;
}
cachedImages.sort(compare);
const cachedImageIds = cachedImages.map((im) => im.imageId);
let imageIdsToPurge = cachedImageIds;
// if we are making space for a volume, we start by purging the imageIds
// that are not related to the volume
if (volumeImageIds) {
imageIdsToPurge = cachedImageIds.filter(
(id) => !volumeImageIds.includes(id)
);
}
// Remove images (that are not related to the volume) from volatile cache
// until the requested number of bytes become available
for (const imageId of imageIdsToPurge) {
this.removeImageLoadObject(imageId);
triggerEvent(eventTarget, Events.IMAGE_CACHE_IMAGE_REMOVED, { imageId });
bytesAvailable = this.getBytesAvailable();
if (bytesAvailable >= numBytes) {
return bytesAvailable;
}
}
// Remove the imageIds (both volume related and not related)
// Remove volume-image Ids from volatile cache until the requested number of bytes
// become available
for (const imageId of cachedImageIds) {
this.removeImageLoadObject(imageId);
triggerEvent(eventTarget, Events.IMAGE_CACHE_IMAGE_REMOVED, { imageId });
bytesAvailable = this.getBytesAvailable();
if (bytesAvailable >= numBytes) {
return bytesAvailable;
}
}
// Technically we should not reach here, since isCacheable will throw an
// error if unallocated + volatile (image) cache cannot fit the upcoming
// number of bytes
}
/**
* Common logic for putting an image into the cache
*
* @param imageId - ImageId for the image
* @param image - The loaded image
* @param cachedImage - The CachedImage object
*/
private _putImageCommon(
imageId: string,
image: IImage,
cachedImage: ICachedImage
): void {
Iif (!this._imageCache.has(imageId)) {
console.warn(
'The image was purged from the cache before it completed loading.'
);
return;
}
Iif (!image) {
console.warn('Image is undefined');
return;
}
Iif (image.sizeInBytes === undefined || Number.isNaN(image.sizeInBytes)) {
throw new Error(
'_putImageCommon: image.sizeInBytes must not be undefined'
);
}
Iif (image.sizeInBytes.toFixed === undefined) {
throw new Error('_putImageCommon: image.sizeInBytes is not a number');
}
// check if there is enough space in unallocated + image Cache
Iif (!this.isCacheable(image.sizeInBytes)) {
throw new Error(Events.CACHE_SIZE_EXCEEDED);
}
// if there is, decache if necessary
this.decacheIfNecessaryUntilBytesAvailable(image.sizeInBytes);
cachedImage.loaded = true;
cachedImage.image = image;
cachedImage.sizeInBytes = image.sizeInBytes;
this.incrementImageCacheSize(cachedImage.sizeInBytes);
const eventDetails: EventTypes.ImageCacheImageAddedEventDetail = {
image: cachedImage,
};
// Add to referencedImageId map if it exists
if (image.referencedImageId) {
this._referencedImageIdToImageIdCache.set(
image.referencedImageId,
imageId
);
}
triggerEvent(eventTarget, Events.IMAGE_CACHE_IMAGE_ADDED, eventDetails);
cachedImage.sharedCacheKey = image.sharedCacheKey;
}
/**
* Puts a new image load object into the cache
*
* First, it creates a CachedImage object and put it inside the imageCache for
* the imageId. After the imageLoadObject promise resolves to an image,
* it: 1) adds the image into the correct CachedImage object 2) increments the
* cache size, 3) triggers IMAGE_CACHE_IMAGE_ADDED 4) Purge the cache if
* necessary -- if the cache size is greater than the maximum cache size, it
* iterates over the imageCache and decache them one by one until the cache
* size becomes less than the maximum allowed cache size
*
* fires Events.IMAGE_CACHE_IMAGE_ADDED
* fires Events.CACHE_SIZE_EXCEEDED if the cache size exceeds the maximum
*
* @param imageId - ImageId for the image
* @param imageLoadObject - The object that is loading or loaded the image
*/
public async putImageLoadObject(
imageId: string,
imageLoadObject: IImageLoadObject
): Promise<void> {
Iif (imageId === undefined) {
console.error('putImageLoadObject: imageId must not be undefined');
throw new Error('putImageLoadObject: imageId must not be undefined');
}
Iif (imageLoadObject.promise === undefined) {
console.error(
'putImageLoadObject: imageLoadObject.promise must not be undefined'
);
throw new Error(
'putImageLoadObject: imageLoadObject.promise must not be undefined'
);
}
const alreadyCached = this._imageCache.get(imageId);
Iif (alreadyCached?.imageLoadObject) {
console.warn(`putImageLoadObject: imageId ${imageId} already in cache`);
throw new Error('putImageLoadObject: imageId already in cache');
}
Iif (
imageLoadObject.cancelFn &&
typeof imageLoadObject.cancelFn !== 'function'
) {
console.error(
'putImageLoadObject: imageLoadObject.cancel must be a function'
);
throw new Error(
'putImageLoadObject: imageLoadObject.cancel must be a function'
);
}
// Starts with an existing cached image and extend it with information
// about being loaded.
const cachedImage: ICachedImage = {
...alreadyCached,
loaded: false,
imageId,
sharedCacheKey: undefined,
imageLoadObject,
timeStamp: Date.now(),
sizeInBytes: 0,
};
// For some reason we need to put it here after the rework of volumes
this._imageCache.set(imageId, cachedImage);
return imageLoadObject.promise
.then((image: IImage) => {
try {
this._putImageCommon(imageId, image, cachedImage);
} catch (error) {
console.debug(
`Error in _putImageCommon for image ${imageId}:`,
error
);
throw error; // Re-throw the error to be caught in the .catch block
}
})
.catch((error) => {
console.debug(`Error caching image ${imageId}:`, error);
this._imageCache.delete(imageId);
throw error; // Re-throw the error to be caught by the caller
});
}
/**
* Puts a new image directly into the cache (synchronous version)
*
* @param imageId - ImageId for the image
* @param image - The loaded image
*/
public putImageSync(imageId: string, image: IImage): void {
Iif (imageId === undefined) {
throw new Error('putImageSync: imageId must not be undefined');
}
Iif (this._imageCache.has(imageId)) {
throw new Error('putImageSync: imageId already in cache');
}
const cachedImage: ICachedImage = {
loaded: false,
imageId,
sharedCacheKey: undefined,
imageLoadObject: {
promise: Promise.resolve(image),
},
timeStamp: Date.now(),
sizeInBytes: 0,
};
this._imageCache.set(imageId, cachedImage);
try {
this._putImageCommon(imageId, image, cachedImage);
} catch (error) {
this._imageCache.delete(imageId);
throw error;
}
}
/**
* Returns the object that is loading a given imageId
*
* @param imageId - Image ID
* @returns IImageLoadObject
*/
public getImageLoadObject(imageId: string): IImageLoadObject | undefined {
Iif (imageId === undefined) {
throw new Error('getImageLoadObject: imageId must not be undefined');
}
const cachedImage = this._imageCache.get(imageId);
if (!cachedImage) {
return;
}
// Bump time stamp for cached image
cachedImage.timeStamp = Date.now();
return cachedImage.imageLoadObject;
}
/**
* It checks the imageCache for the provided imageId, and returns true
* if the image is loaded, false otherwise. Note, this only checks the imageCache
* and does not check the volume cache.
* @param imageId - image Id to check
* @returns boolean
*/
public isLoaded(imageId: string): boolean {
const cachedImage = this._imageCache.get(imageId);
if (!cachedImage) {
return false;
}
return cachedImage.loaded;
}
/**
* Returns the volume that contains the requested imageId. It will check the
* imageIds inside the volume to find a match.
*
* @param imageId - ImageId
* @returns - Volume object
*/
public getVolumeContainingImageId(imageId: string):
| {
volume: IImageVolume;
imageIdIndex: number;
}
| undefined {
const volumeIds = Array.from(this._volumeCache.keys());
const imageIdToUse = imageIdToURI(imageId);
for (const volumeId of volumeIds) {
const cachedVolume = this._volumeCache.get(volumeId);
Iif (!cachedVolume) {
return;
}
const { volume } = cachedVolume;
Iif (!volume.imageIds.length) {
return;
}
const imageIdIndex = volume.getImageURIIndex(imageIdToUse);
Eif (imageIdIndex > -1) {
return { volume, imageIdIndex };
}
}
}
/**
* Returns the cached image from the imageCache for the requested imageId.
* It first strips the imageId to remove the data loading scheme.
*
* @param imageId - Image ID
* @returns cached image
*/
public getCachedImageBasedOnImageURI(
imageId: string
): ICachedImage | undefined {
const imageURIToUse = imageIdToURI(imageId);
const cachedImageIds = Array.from(this._imageCache.keys());
const foundImageId = cachedImageIds.find((imageId) => {
return imageIdToURI(imageId) === imageURIToUse;
});
Iif (!foundImageId) {
return;
}
return this._imageCache.get(foundImageId);
}
/**
* Common logic for putting a volume into the cache
*
* @param volumeId - VolumeId for the volume
* @param volume - The loaded volume
* @param cachedVolume - The CachedVolume object
*/
private _putVolumeCommon(
volumeId: string,
volume: IImageVolume,
cachedVolume: ICachedVolume
): void {
Iif (!this._volumeCache.get(volumeId)) {
console.warn(
'The volume was purged from the cache before it completed loading.'
);
return;
}
cachedVolume.loaded = true;
cachedVolume.volume = volume;
// If the volume has image IDs, we need to make sure that they are not getting
// deleted automatically. Mark the imageIds somehow so that they are discernable from the others.
volume.imageIds?.forEach((imageId) => {
const image = this._imageCache.get(imageId);
if (image) {
image.sharedCacheKey = volumeId;
}
});
const eventDetails: EventTypes.VolumeCacheVolumeAddedEventDetail = {
volume: cachedVolume,
};
triggerEvent(eventTarget, Events.VOLUME_CACHE_VOLUME_ADDED, eventDetails);
}
/**
* Puts a new volume directly into the cache (synchronous version)
*
* @param volumeId - VolumeId for the volume
* @param volume - The loaded volume
*/
public putVolumeSync(volumeId: string, volume: IImageVolume): void {
Iif (volumeId === undefined) {
throw new Error('putVolumeSync: volumeId must not be undefined');
}
Iif (this._volumeCache.has(volumeId)) {
throw new Error('putVolumeSync: volumeId already in cache');
}
const cachedVolume: ICachedVolume = {
loaded: false,
volumeId,
volumeLoadObject: {
promise: Promise.resolve(volume),
},
timeStamp: Date.now(),
sizeInBytes: 0,
};
this._volumeCache.set(volumeId, cachedVolume);
try {
this._putVolumeCommon(volumeId, volume, cachedVolume);
} catch (error) {
this._volumeCache.delete(volumeId);
throw error;
}
}
/**
* Puts a new image load object into the cache
*
* First, it creates a CachedVolume object and put it inside the volumeCache for
* the volumeId. After the volumeLoadObject promise resolves to a volume,
* it: 1) adds the volume into the correct CachedVolume object inside volumeCache
* 2) increments the cache size, 3) triggers VOLUME_CACHE_VOLUME_ADDED 4) Purge
* the cache if necessary -- if the cache size is greater than the maximum cache size, it
* iterates over the imageCache (not volumeCache) and decache them one by one
* until the cache size becomes less than the maximum allowed cache size
*
* fires Events.VOLUME_CACHE_VOLUME_ADDED
*
* @param volumeId - volumeId of the volume
* @param volumeLoadObject - The object that is loading or loaded the volume
*/
public async putVolumeLoadObject(
volumeId: string,
volumeLoadObject: IVolumeLoadObject
): Promise<void> {
Iif (volumeId === undefined) {
throw new Error('putVolumeLoadObject: volumeId must not be undefined');
}
Iif (volumeLoadObject.promise === undefined) {
throw new Error(
'putVolumeLoadObject: volumeLoadObject.promise must not be undefined'
);
}
Iif (this._volumeCache.has(volumeId)) {
throw new Error(
`putVolumeLoadObject: volumeId:${volumeId} already in cache`
);
}
Iif (
volumeLoadObject.cancelFn &&
typeof volumeLoadObject.cancelFn !== 'function'
) {
throw new Error(
'putVolumeLoadObject: volumeLoadObject.cancel must be a function'
);
}
const cachedVolume: ICachedVolume = {
loaded: false,
volumeId,
volumeLoadObject,
timeStamp: Date.now(),
sizeInBytes: 0,
};
this._volumeCache.set(volumeId, cachedVolume);
return volumeLoadObject.promise
.then((volume: IImageVolume) => {
try {
this._putVolumeCommon(volumeId, volume, cachedVolume);
} catch (error) {
console.error(
`Error in _putVolumeCommon for volume ${volumeId}:`,
error
);
this._volumeCache.delete(volumeId); // Clean up the cache if an error occurs
throw error;
}
})
.catch((error) => {
this._volumeCache.delete(volumeId);
throw error;
});
}
/**
* Returns the object that is loading a given volumeId
*
* @param volumeId - Volume ID
* @returns IVolumeLoadObject
*/
public getVolumeLoadObject = (
volumeId: string
): IVolumeLoadObject | undefined => {
Iif (volumeId === undefined) {
throw new Error('getVolumeLoadObject: volumeId must not be undefined');
}
const cachedVolume = this._volumeCache.get(volumeId);
if (!cachedVolume) {
return;
}
// Bump time stamp for cached volume (not used for anything for now)
cachedVolume.timeStamp = Date.now();
return cachedVolume.volumeLoadObject;
};
/**
* Common logic for putting a geometry into the cache
*
* @param geometryId - GeometryId for the geometry
* @param geometry - The loaded geometry
* @param cachedGeometry - The CachedGeometry object
*/
private _putGeometryCommon(
geometryId: string,
geometry: IGeometry,
cachedGeometry: ICachedGeometry
): void {
Iif (!this._geometryCache.get(geometryId)) {
console.warn(
'The geometry was purged from the cache before it completed loading.'
);
return;
}
Iif (!geometry) {
console.warn('Geometry is undefined');
return;
}
Iif (
geometry.sizeInBytes === undefined ||
Number.isNaN(geometry.sizeInBytes)
) {
throw new Error(
'_putGeometryCommon: geometry.sizeInBytes must not be undefined'
);
}
Iif (geometry.sizeInBytes.toFixed === undefined) {
throw new Error(
'_putGeometryCommon: geometry.sizeInBytes is not a number'
);
}
// check if there is enough space in unallocated + geometry Cache
Iif (!this.isCacheable(geometry.sizeInBytes)) {
throw new Error(Events.CACHE_SIZE_EXCEEDED);
}
// if there is, decache if necessary
this.decacheIfNecessaryUntilBytesAvailable(geometry.sizeInBytes);
cachedGeometry.loaded = true;
cachedGeometry.geometry = geometry;
cachedGeometry.sizeInBytes = geometry.sizeInBytes;
this.incrementGeometryCacheSize(cachedGeometry.sizeInBytes);
const eventDetails = {
geometry: cachedGeometry,
};
triggerEvent(
eventTarget,
Events.GEOMETRY_CACHE_GEOMETRY_ADDED,
eventDetails
);
}
/**
* Puts a new geometry directly into the cache (synchronous version)
*
* @param geometryId - GeometryId for the geometry
* @param geometry - The loaded geometry
*/
public putGeometrySync(geometryId: string, geometry: IGeometry): void {
Iif (geometryId === undefined) {
throw new Error('putGeometrySync: geometryId must not be undefined');
}
Iif (this._geometryCache.has(geometryId)) {
throw new Error('putGeometrySync: geometryId already in cache');
}
const cachedGeometry: ICachedGeometry = {
loaded: false,
geometryId,
geometryLoadObject: {
promise: Promise.resolve(geometry),
},
timeStamp: Date.now(),
sizeInBytes: 0,
};
this._geometryCache.set(geometryId, cachedGeometry);
try {
this._putGeometryCommon(geometryId, geometry, cachedGeometry);
} catch (error) {
this._geometryCache.delete(geometryId);
throw error;
}
}
public putGeometryLoadObject = (
geometryId: string,
geometryLoadObject: IGeometryLoadObject
): Promise<void> => {
if (geometryId === undefined) {
throw new Error(
'putGeometryLoadObject: geometryId must not be undefined'
);
}
if (geometryLoadObject.promise === undefined) {
throw new Error(
'putGeometryLoadObject: geometryLoadObject.promise must not be undefined'
);
}
if (this._geometryCache.has(geometryId)) {
throw new Error(
'putGeometryLoadObject: geometryId already present in geometryCache'
);
}
if (
geometryLoadObject.cancelFn &&
typeof geometryLoadObject.cancelFn !== 'function'
) {
throw new Error(
'putGeometryLoadObject: geometryLoadObject.cancel must be a function'
);
}
const cachedGeometry: ICachedGeometry = {
loaded: false,
geometryId,
geometryLoadObject,
timeStamp: Date.now(),
sizeInBytes: 0,
};
this._geometryCache.set(geometryId, cachedGeometry);
return geometryLoadObject.promise
.then((geometry: IGeometry) => {
try {
this._putGeometryCommon(geometryId, geometry, cachedGeometry);
} catch (error) {
console.debug(
`Error in _putGeometryCommon for geometry ${geometryId}:`,
error
);
throw error;
}
})
.catch((error) => {
console.debug(`Error caching geometry ${geometryId}:`, error);
this._geometryCache.delete(geometryId);
throw error;
});
};
/**
* Returns the geometry associated with the geometryId
*
* @param geometryId - Geometry ID
* @returns Geometry
*/
public getGeometry = (geometryId: string): IGeometry | undefined => {
Iif (geometryId === undefined) {
throw new Error('getGeometry: geometryId must not be undefined');
}
const cachedGeometry = this._geometryCache.get(geometryId);
if (!cachedGeometry) {
return;
}
// Bump time stamp for cached geometry
cachedGeometry.timeStamp = Date.now();
return cachedGeometry.geometry;
};
/**
* Removes the geometry loader associated with a given Id from the cache
*
* It increases the cache size after removing the geometry.
*
* fires Events.GEOMETRY_CACHE_GEOMETRY_REMOVED
*
* @param geometryId - Geometry ID
*/
public removeGeometryLoadObject = (geometryId: string): void => {
if (geometryId === undefined) {
throw new Error(
'removeGeometryLoadObject: geometryId must not be undefined'
);
}
const cachedGeometry = this._geometryCache.get(geometryId);
if (!cachedGeometry) {
throw new Error(
'removeGeometryLoadObject: geometryId was not present in geometryCache'
);
}
this.decrementGeometryCacheSize(cachedGeometry.sizeInBytes);
const eventDetails = {
geometry: cachedGeometry,
geometryId,
};
triggerEvent(
eventTarget,
Events.GEOMETRY_CACHE_GEOMETRY_REMOVED,
eventDetails
);
this._decacheGeometry(geometryId);
};
/**
* Deletes the geometryId from the geometry cache
*
* @param geometryId - geometryId
*/
private _decacheGeometry = (geometryId: string) => {
const cachedGeometry = this._geometryCache.get(geometryId);
if (!cachedGeometry) {
return;
}
const { geometryLoadObject } = cachedGeometry;
// Cancel any in-progress loading
if (geometryLoadObject.cancelFn) {
geometryLoadObject.cancelFn();
}
if (geometryLoadObject.decache) {
geometryLoadObject.decache();
}
this._geometryCache.delete(geometryId);
};
/**
* Increases the geometry cache size with the provided increment
*
* @param increment - bytes length
*/
public incrementGeometryCacheSize = (increment: number) => {
this._geometryCacheSize += increment;
};
/**
* Decreases the geometry cache size with the provided decrement
*
* @param decrement - bytes length
*/
public decrementGeometryCacheSize = (decrement: number) => {
this._geometryCacheSize -= decrement;
};
/**
* Find the image that has the referenced ImageId
*/
public getImageByReferencedImageId = (
referencedImageId: string
): IImage | undefined => {
const imageId =
this._referencedImageIdToImageIdCache.get(referencedImageId);
if (imageId) {
return this._imageCache.get(imageId)?.image;
}
return undefined;
};
/**
* Returns the image associated with the imageId
*
* @param imageId - image ID
* @param minQuality - the minimum image quality to fetch
* @returns Image
*/
public getImage = (
imageId: string,
minQuality = ImageQualityStatus.FAR_REPLICATE
): IImage | undefined => {
Iif (imageId === undefined) {
throw new Error('getImage: imageId must not be undefined');
}
const cachedImage = this._imageCache.get(imageId);
if (!cachedImage) {
return;
}
// Bump time stamp for cached volume (not used for anything for now)
cachedImage.timeStamp = Date.now();
Iif (cachedImage.image?.imageQualityStatus < minQuality) {
return;
}
return cachedImage.image;
};
/**
* Sets a partial image qualty to use, allowing another load to occur.
* If the partialImage is not defined, will use any current image defined.
* This will ONLY replace the current image if the quality is at least as
* good.
* This will not cancel any in flight requests, but will remove any partial
* loaded requests.
*
* @param imageId - image ID
* @param partialImage - partial image to use
*/
public setPartialImage(imageId: string, partialImage?: IImage) {
const cachedImage = this._imageCache.get(imageId);
Iif (!cachedImage) {
if (partialImage) {
this._imageCache.set(imageId, {
image: partialImage,
imageId,
loaded: false,
timeStamp: Date.now(),
sizeInBytes: 0,
});
}
return;
}
Iif (cachedImage.loaded) {
cachedImage.loaded = false;
cachedImage.imageLoadObject = null;
this.incrementImageCacheSize(-cachedImage.sizeInBytes);
cachedImage.sizeInBytes = 0;
cachedImage.image = partialImage || cachedImage.image;
} else {
cachedImage.image = partialImage || cachedImage.image;
}
}
/** Gets the current image quality for the given image id */
public getImageQuality(imageId: string) {
const image = this._imageCache.get(imageId)?.image;
return image
? image.imageQualityStatus || ImageQualityStatus.FULL_RESOLUTION
: undefined;
}
/**
* Returns the volume associated with the volumeId
*
* @param volumeId - Volume ID
* @param allowPartialMatch - If true, the volumeId can be a partial match
* @returns Volume
*/
public getVolume = (
volumeId: string,
allowPartialMatch = false
): IImageVolume | undefined => {
Iif (volumeId === undefined) {
throw new Error('getVolume: volumeId must not be undefined');
}
const cachedVolume = this._volumeCache.get(volumeId);
if (!cachedVolume) {
return allowPartialMatch
? [...this._volumeCache.values()].find((cv) =>
cv.volumeId.includes(volumeId)
)?.volume
: undefined;
}
cachedVolume.timeStamp = Date.now();
return cachedVolume.volume;
};
/**
* Retrieves an array of image volumes from the cache.
* @returns An array of image volumes.
*/
public getVolumes = (): IImageVolume[] => {
const cachedVolumes = Array.from(this._volumeCache.values());
return cachedVolumes.map((cachedVolume) => cachedVolume.volume);
};
/**
* Filters the cached volumes by the specified reference volume ID.
* @param volumeId - The ID of the reference volume.
* @returns An array of image volumes that have the specified reference volume ID.
*/
public filterVolumesByReferenceId = (volumeId: string): IImageVolume[] => {
const cachedVolumes = this.getVolumes();
return cachedVolumes.filter((volume) => {
return volume.referencedVolumeId === volumeId;
});
};
/**
* Removes the image loader associated with a given Id from the cache
*
* It increases the cache size after removing the image.
*
* fires Events.IMAGE_CACHE_IMAGE_REMOVED
*
* @param imageId - Image ID
*/
public removeImageLoadObject = (
imageId: string,
{ force = false }: { force?: boolean } = {}
): void => {
if (imageId === undefined) {
throw new Error('removeImageLoadObject: imageId must not be undefined');
}
const cachedImage = this._imageCache.get(imageId);
if (!cachedImage) {
throw new Error(
'removeImageLoadObject: imageId was not present in imageCache'
);
}
this._decacheImage(imageId, force);
this.incrementImageCacheSize(-cachedImage.sizeInBytes);
const eventDetails = {
image: cachedImage,
imageId,
};
triggerEvent(eventTarget, Events.IMAGE_CACHE_IMAGE_REMOVED, eventDetails);
};
/**
* Removes the volume loader associated with a given Id from the cache
*
* It increases the cache size after removing the image.
*
* fires Events.VOLUME_CACHE_VOLUME_REMOVED
*
* @param imageId - ImageId
*/
public removeVolumeLoadObject = (volumeId: string): void => {
if (volumeId === undefined) {
throw new Error('removeVolumeLoadObject: volumeId must not be undefined');
}
const cachedVolume = this._volumeCache.get(volumeId);
if (!cachedVolume) {
throw new Error(
'removeVolumeLoadObject: volumeId was not present in volumeCache'
);
}
const eventDetails = {
volume: cachedVolume,
volumeId,
};
triggerEvent(eventTarget, Events.VOLUME_CACHE_VOLUME_REMOVED, eventDetails);
this._decacheVolume(volumeId);
};
/**
* Increases the image cache size with the provided increment
*
* @param increment - bytes length
*/
public incrementImageCacheSize = (increment: number) => {
this._imageCacheSize += increment;
};
/**
* Decreases the image cache size with the provided decrement
*
* @param decrement - bytes length
*/
public decrementImageCacheSize = (decrement: number) => {
this._imageCacheSize -= decrement;
};
public getGeometryLoadObject = (
geometryId: string
): IGeometryLoadObject | undefined => {
if (geometryId === undefined) {
throw new Error(
'getGeometryLoadObject: geometryId must not be undefined'
);
}
const cachedGeometry = this._geometryCache.get(geometryId);
if (!cachedGeometry) {
return;
}
cachedGeometry.timeStamp = Date.now();
return cachedGeometry.geometryLoadObject;
};
}
/**
* This module deals with Caching of images and volumes
* The cache has two main components: a volatile portion for images and a
* non-volatile portion for volumes. Individual 2D images are volatile and
* will be replaced by new images hitting the cache. When you allocate volumes,
* these are non-volatile and reserve a block of memory from the cache.
* Volumes must be released manually.
* We will have a shared block of memory allocated for the entire cache, e.g. 1GB
* which will be shared for images and volumes.
*
* **When a new image is added:**
* We check if there is enough unallocated + volatile space for the single image
*
* if so
* - We allocate the image in image cache, and if necessary oldest images
* are decached to match the maximumCacheSize criteria
* - If a volume contains that imageId, copy it over using TypedArray's set method.
* If no volumes contain the imageId, the image is fetched by image loaders
*
* If not (cache is mostly/completely full with volumes)
* - throw that the cache does not have enough working space to allocate the image
*
*
* **When a new volume is added:**
* Check if there is enough unallocated + volatile space to allocate the volume:
*
* If so:
* - Decache oldest images which won't be included in this volume until
* we have enough free space for the volume
* - If not enough space from previous space, decache images that will be included
* in the volume until we have enough free space (These will need to be re-fetched,
* but we must do this not to straddle over the given memory limit, even for a
* short time, as this may crash the app)
* - At this point, if any of the frames (indexed by imageId) are present in the volatile
* image cache, copy these over to the volume now
*
* If not (cache is mostly/completely full with volumes),
* - throw that the cache does not have enough working space to allocate the volume.
*
*/
const cache = new Cache();
export default cache;
export { Cache, cache }; // for documentation
|