All files / metadata/src/utilities/metadataProvider compressedFrameData.ts

49.27% Statements 34/69
36.66% Branches 22/60
60% Functions 6/10
49.27% Lines 34/69

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            128x                     128x               4170x 28650x 28650x           90x     4080x                                                         90x 90x                                       90x 90x     90x 90x                                                                                                               4170x       4170x 4170x 4080x     90x 90x       90x 90x   90x     90x 90x                       90x       90x               128x               128x           4170x 4170x 4170x 90x   4080x                 384x    
import { MetadataModules } from '../../enums';
import { addTypedProvider } from '../../metaData';
import type { TypedProvider } from '../../metaData';
import type { CompressedFrameDataMetadata } from '../../types';
 
/** Known natural keys and hex tags for pixel data (standard and float/paramap). */
const PIXEL_DATA_KEYS = [
  'PixelData',
  'FramePixelData',
  'FloatPixelData',
  '7FE00010',
  '7fe00010',
  '7FE00008',
  '7fe00008',
];
 
/** Keys that indicate paramap-type (parametric map) images for single-buffer frame slicing. */
const PARAMAP_PIXEL_DATA_KEYS = ['FloatPixelData', '7FE00008', '7fe00008'];
 
/**
 * Resolves the pixel data array from natural (frames as array of buffers or array of buffer arrays).
 */
function getPixelDataFromNatural(
  natural: Record<string, unknown>
): unknown[] | undefined {
  for (const key of PIXEL_DATA_KEYS) {
    const val = natural[key];
    if (
      val !== undefined &&
      val !== null &&
      Array.isArray(val) &&
      val.length > 0
    ) {
      return val as unknown[];
    }
  }
  return undefined;
}
 
/**
 * Returns which pixel data key was used in natural, or undefined if none.
 */
function getPixelDataKeyFromNatural(
  natural: Record<string, unknown>
): string | undefined {
  for (const key of PIXEL_DATA_KEYS) {
    const val = natural[key];
    if (
      val !== undefined &&
      val !== null &&
      Array.isArray(val) &&
      val.length > 0
    ) {
      return key;
    }
  }
  return undefined;
}
 
function isParamapType(natural: Record<string, unknown>): boolean {
  const key = getPixelDataKeyFromNatural(natural);
  return key !== undefined && PARAMAP_PIXEL_DATA_KEYS.includes(key);
}
 
function asView(buf: ArrayBuffer | ArrayBufferView): ArrayBufferView {
  Eif (buf instanceof ArrayBuffer) {
    return new Uint8Array(buf);
  }
  return buf as ArrayBufferView;
}
 
function byteLength(buf: ArrayBuffer | ArrayBufferView): number {
  if (buf instanceof ArrayBuffer) {
    return buf.byteLength;
  }
  return (buf as ArrayBufferView).byteLength;
}
 
/**
 * Returns the pixel data for the given frame as ArrayBufferView(s) for CompressedFrameDataMetadata.
 * Supports: [ [buf] ] (multiframe), [ [buf1, buf2] ] (single frame, fragments), [ buf ] (single frame, one buffer).
 */
function getFramePixelData(
  pixelDataTag: unknown[],
  frameIndex: number
): CompressedFrameDataMetadata['pixelData'] | undefined {
  const frame = pixelDataTag[frameIndex];
  Iif (frame === undefined || frame === null) {
    return undefined;
  }
  Eif (Array.isArray(frame)) {
    return (frame as (ArrayBuffer | ArrayBufferView)[]).map(asView);
  }
  return asView(frame as ArrayBuffer | ArrayBufferView);
}
 
/**
 * When pixelDataTag has one buffer and natural has multiple frames, slice one frame for paramap-type images.
 * Returns undefined if not applicable or split is not even.
 */
function getFramePixelDataFromSingleBuffer(
  pixelDataTag: unknown[],
  frameIndex: number,
  numberOfFrames: number,
  natural: Record<string, unknown>
): CompressedFrameDataMetadata['pixelData'] | undefined {
  if (pixelDataTag.length !== 1 || !isParamapType(natural)) {
    return undefined;
  }
  const buf = pixelDataTag[0];
  if (buf === undefined || buf === null) {
    return undefined;
  }
  const view = asView(buf as ArrayBuffer | ArrayBufferView);
  const totalLength = byteLength(buf as ArrayBuffer | ArrayBufferView);
  if (numberOfFrames <= 0 || totalLength % numberOfFrames !== 0) {
    return undefined;
  }
  const frameSize = totalLength / numberOfFrames;
  const offset = frameIndex * frameSize;
  if (offset + frameSize > totalLength) {
    return undefined;
  }
  console.warn(
    '[compressedFrameData] Splitting single-buffer pixel data by numberOfFrames for paramap-type image; frameIndex=',
    frameIndex,
    ', numberOfFrames=',
    numberOfFrames,
    ', frameSize=',
    frameSize
  );
  const u8 =
    view instanceof Uint8Array
      ? view
      : new Uint8Array(view.buffer, view.byteOffset, view.byteLength);
  return [u8.subarray(offset, offset + frameSize)];
}
 
/**
 * Builds compressed frame data from a natural instance (pixel data as Value).
 * Returns undefined if natural has no pixel data or transfer syntax.
 * When array length !== numberOfFrames and image is paramap-type, slices a single buffer by frame (with warning).
 */
function compressedFrameDataFromNatural(
  natural,
  frameIndex: number
): CompressedFrameDataMetadata | undefined {
  Iif (!natural) {
    return;
  }
 
  const pixelDataTag = getPixelDataFromNatural(natural);
  if (!pixelDataTag) {
    return;
  }
 
  const { TransferSyntaxUID: transferSyntaxUid } = natural;
  Iif (!transferSyntaxUid) {
    return;
  }
 
  const frameOfInterest = frameIndex ?? 0;
  const frameNumber = frameOfInterest + 1;
  const numberOfFrames =
    natural.NumberOfFrames != null ? Number(natural.NumberOfFrames) : 1;
 
  let pixelData: CompressedFrameDataMetadata['pixelData'] | undefined;
  if (pixelDataTag.length === numberOfFrames) {
    pixelData = getFramePixelData(pixelDataTag, frameOfInterest);
  } else E{
    pixelData = getFramePixelDataFromSingleBuffer(
      pixelDataTag,
      frameOfInterest,
      numberOfFrames,
      natural
    );
    if (pixelData === undefined) {
      pixelData = getFramePixelData(pixelDataTag, frameOfInterest);
    }
  }
  Iif (pixelData === undefined) {
    return;
  }
 
  return {
    transferSyntaxUid,
    frameOfInterest,
    frameNumber,
    pixelData,
  };
}
 
const COMPRESSED_FRAME_DATA_TYPE = MetadataModules.COMPRESSED_FRAME_DATA;
 
/**
 * Typed provider for COMPRESSED_FRAME_DATA. Gets natural metadata via
 * getMetaData(MetadataModules.NATURALIZED, query); if it has pixel data as Value,
 * returns { transferSyntaxUid, frameOfInterest, frameNumber, pixelData }.
 * Otherwise calls next.
 */
const compressedFrameDataProvider: TypedProvider = (
  next: (query: string, data: unknown, options?: unknown) => unknown,
  query: string,
  natural,
  options
): CompressedFrameDataMetadata | unknown => {
  const frameIndex = options?.frameIndex ?? 0;
  const value = compressedFrameDataFromNatural(natural, frameIndex);
  if (value) {
    return value;
  }
  return next(
    query,
    natural,
 
    options
  );
};
 
export function registerCompressedFrameDataProvider(): void {
  addTypedProvider(COMPRESSED_FRAME_DATA_TYPE, compressedFrameDataProvider);
}