Merge changes from opendesigndev/psd-ts (Modified #74)

packages/psd/src/classes/Group.ts

@@ -2,7 +2,10 @@
 // Copyright 2021-present NAVER WEBTOON
 // MIT License
 
-import {GroupFrame, LayerProperties} from "../sections";
+import {BlendMode, Clipping} from "../interfaces";
+import {decodeGrayscale} from "../methods";
+import {GroupFrame, LayerProperties, MaskData} from "../sections";
+import {area} from "../utils";
 import {NodeChild, NodeParent} from "./Node";
 import {NodeBase} from "./NodeBase";
 
@@ -47,4 +50,46 @@ export class Group implements NodeBase<NodeParent, NodeChild> {
     this.children.forEach((node) => (node as NodeBase).freeze?.());
     Object.freeze(this.children);
   }
+
+  get blendMode(): BlendMode | undefined {
+    return this.layerFrame?.layerProperties.blendMode;
+  }
+
+  get isHidden(): boolean {
+    return this.layerFrame?.layerProperties.hidden ?? false;
+  }
+
+  get maskData(): MaskData | undefined {
+    return this.layerFrame?.layerProperties.maskData;
+  }
+
+  get clipping(): Clipping {
+    return this.layerFrame?.layerProperties.clippingMask ?? Clipping.Base;
+  }
+
+  get id(): number | undefined {
+    return this.layerFrame?.id;
+  }
+
+  async userMask(): Promise<Uint8Array | undefined> {
+    const userMask = this.layerFrame?.userMask;
+    const {maskData} = this;
+
+    if (!maskData || !userMask) {
+      return;
+    }
+
+    return decodeGrayscale(area(maskData), userMask);
+  }
+
+  async realUserMask(): Promise<Uint8Array | undefined> {
+    const maskData = this.maskData?.realData;
+    const userMask = this.layerFrame?.realUserMask;
+
+    if (!maskData || !userMask) {
+      return;
+    }
+
+    return decodeGrayscale(area(maskData), userMask);
+  }
 }

packages/psd/src/classes/Layer.ts

@@ -2,7 +2,7 @@
 // Copyright 2021-present NAVER WEBTOON
 // MIT License
 
-import {EngineData, ImageData} from "../interfaces";
+import {BlendMode, Clipping, EngineData, ImageData} from "../interfaces";
 import {decodeGrayscale} from "../methods";
 import {LayerFrame, MaskData, LayerProperties} from "../sections";
 import {area} from "../utils";
@@ -32,6 +32,7 @@ export class Layer
   get name(): string {
     return this.layerFrame.layerProperties.name;
   }
+
   get width(): number {
     return this.layerFrame.width;
   }
@@ -47,10 +48,16 @@ export class Layer
   get opacity(): number {
     return this.layerFrame.layerProperties.opacity;
   }
+
+  get blendMode(): BlendMode {
+    return this.layerFrame.layerProperties.blendMode;
+  }
+
   get composedOpacity(): number {
     return this.parent.composedOpacity * (this.opacity / 255);
   }
-  get maskData(): MaskData {
+
+  get maskData(): MaskData | undefined {
     return this.layerFrame.layerProperties.maskData;
   }
 
@@ -63,7 +70,7 @@ export class Layer
   }
 
   async realUserMask(): Promise<Uint8Array | undefined> {
-    const maskData = this.maskData.realData;
+    const maskData = this.maskData?.realData;
     const userMask = this.layerFrame.realUserMask;
     if (!maskData || !userMask) {
       return undefined;
@@ -104,4 +111,8 @@ export class Layer
 
     return {red, green, blue, alpha};
   }
+
+  get clipping(): Clipping {
+    return this.layerFrame.layerProperties.clippingMask;
+  }
 }

packages/psd/src/classes/Psd.ts

@@ -3,16 +3,20 @@
 // MIT License
 
 import {
+  ChannelKind,
   ColorMode,
   Depth,
+  getChannelKindOffset,
   Guide,
   ImageData,
   ParsingResult,
+  Pattern,
   ResolutionInfo,
   ResourceType,
 } from "../interfaces";
-import {parse} from "../methods";
+import {generateRgba, parse} from "../methods";
 import {AdditionalLayerProperties} from "../sections";
+import {dimensions, InvalidColorMode, MissingColorChannel} from "../utils";
 import {Group} from "./Group";
 import {Layer} from "./Layer";
 import {assertIsNodeParent, Node, NodeChild} from "./Node";
@@ -100,6 +104,7 @@ export class Psd extends Synthesizable implements NodeBase<never, NodeChild> {
 
   protected get imageData(): ImageData {
     const {compression, red, green, blue, alpha} = this.parsingResult.imageData;
+
     return {
       red: {compression, data: red},
       green: green ? {compression, data: green} : undefined,
@@ -108,6 +113,38 @@ export class Psd extends Synthesizable implements NodeBase<never, NodeChild> {
     };
   }
 
+  get patterns(): Pattern[] {
+    const {Patt, Pat2, Pat3} = this.additionalLayerProperties;
+    return [
+      ...(Patt?.data ?? []),
+      ...(Pat2?.data ?? []),
+      ...(Pat3?.data ?? []),
+    ];
+  }
+
+  public decodePattern(pattern: Pattern): Promise<Uint8ClampedArray> {
+    if (pattern.imageMode !== ColorMode.Rgb) {
+      throw new InvalidColorMode();
+    }
+
+    const channels = pattern.patternData?.channels;
+
+    const red = channels[getChannelKindOffset(ChannelKind.Red)];
+    if (!red) {
+      throw new MissingColorChannel("missing red channel");
+    }
+
+    const green =
+      channels[getChannelKindOffset(ChannelKind.Green)] || undefined;
+    const blue = channels[getChannelKindOffset(ChannelKind.Blue)] || undefined;
+    const alpha =
+      channels[getChannelKindOffset(ChannelKind.TransparencyMask)] || undefined;
+
+    const {width, height} = dimensions(pattern.patternData.rectangle);
+
+    return generateRgba(width, height, red, green, blue, alpha);
+  }
+
   protected buildTreeStructure(): void {
     const {groups, layers, orders} = this.parsingResult.layerAndMaskInfo;
     const stack: Node[] = [this];

packages/psd/src/index.ts

@@ -14,7 +14,9 @@ export {
   ResolutionUnit,
   AliKey,
   PathRecordType,
+  DescriptorValueType,
+  UnitFloatType,
 } from "./interfaces";
-export type {Guide} from "./interfaces";
+export type {Guide, AdditionalLayerInfo} from "./interfaces";
 
 export default Psd;

packages/psd/src/interfaces/AdditionalLayerInfo/AliKey.ts

@@ -13,10 +13,13 @@ export enum AliKey {
 
   VectorStrokeData = "vstk",
   ObjectBasedEffects = "lfx2",
+  MultipleObjectBasedEffects = "lmfx",
+  ObjectBasedUndocumented = "lfxs",
   GradientFillSetting = "GdFl",
   SolidColorSheetSetting = "SoCo",
   PatternFillSetting = "PtFl",
   VectorStrokeContentData = "vscg",
+  VectorOriginationData = "vogk",
   BlendOptionsCapacity = "iOpa",
   VectorMaskSetting1 = "vmsk",
   VectorMaskSetting2 = "vsms",
@@ -30,4 +33,25 @@ export enum AliKey {
   LinkedLayer = "lnkD",
   LinkedLayer2 = "lnk2",
   LinkedLayer3 = "lnk3",
+  LayerNameSourceSetting = "lnsr",
+  BrightnessAndContrast = "brit",
+  Levels = "levl",
+  Curves = "curv",
+  Exposure = "expA",
+  Vibrance = "vibA",
+  HueSaturationOld = "hue ",
+  ColorBalance = "blnc",
+  BlackAndWhite = "blwh",
+  PhotoFilter = "phfl",
+  ChannelMixer = "mixr",
+  ColorLookup = "clrL",
+  Invert = "nvrt",
+  Posterize = "post",
+  Threshold = "thrs",
+  GradientMapSettings = "grdm",
+  SelectiveColor = "selc",
+
+  Pattern1 = "Patt",
+  Pattern2 = "Pat2",
+  Pattern3 = "Pat3",
 }

packages/psd/src/interfaces/AdditionalLayerInfo/MultipleObjectBasedEffectsAliBlock.ts

@@ -0,0 +1,14 @@
+// @webtoon/psd
+// Copyright 2021-present NAVER WEBTOON
+// MIT License
+
+import {Descriptor} from "../Descriptor";
+import {KnownAliBlock} from "./AliBlockBase";
+import {AliKey} from "./AliKey";
+
+export interface MultipleObjectBasedEffectsAliBlock
+  extends KnownAliBlock<AliKey.MultipleObjectBasedEffects> {
+  version: number;
+  descriptorVersion: number;
+  descriptor: Descriptor;
+}

packages/psd/src/interfaces/AdditionalLayerInfo/ObjectBasedUndocumentedAliBlock.ts

@@ -0,0 +1,14 @@
+// @webtoon/psd
+// Copyright 2021-present NAVER WEBTOON
+// MIT License
+
+import {Descriptor} from "../Descriptor";
+import {KnownAliBlock} from "./AliBlockBase";
+import {AliKey} from "./AliKey";
+
+export interface ObjectBasedUndocumentedAliBlock
+  extends KnownAliBlock<AliKey.ObjectBasedUndocumented> {
+  version: number;
+  descriptorVersion: number;
+  descriptor: Descriptor;
+}

packages/psd/src/interfaces/AdditionalLayerInfo/PatternAliBlock.ts

@@ -0,0 +1,48 @@
+// @webtoon/psd
+// Copyright 2021-present NAVER WEBTOON
+// MIT License
+
+import {ChannelBytes} from "../ChannelBytes";
+import {KnownAliBlock} from "./AliBlockBase";
+import {AliKey} from "./AliKey";
+
+export interface PatternDataRectangle {
+  top: number;
+  left: number;
+  bottom: number;
+  right: number;
+}
+
+export interface PatternDataChannel extends ChannelBytes {
+  written: true;
+  length: number;
+  pixelDepth1: number;
+  rectangle: PatternDataRectangle;
+  pixelDepth2: number;
+}
+
+export interface PatternData {
+  version: number;
+  length: number;
+  rectangle: PatternDataRectangle;
+  numberOfChannels: number;
+  channels: (PatternDataChannel | null)[];
+}
+
+export type ColorTable = [number, number, number][];
+
+export interface Pattern {
+  version: number;
+  imageMode: number;
+  width: number;
+  height: number;
+  name: string;
+  id: string;
+  colorTable?: ColorTable;
+  patternData: PatternData;
+}
+
+export interface PatternAliBlock
+  extends KnownAliBlock<AliKey.Pattern1 | AliKey.Pattern2 | AliKey.Pattern3> {
+  data: Pattern[];
+}

packages/psd/src/interfaces/AdditionalLayerInfo/VectorOriginationDataAliBlock.ts

@@ -0,0 +1,13 @@
+// @webtoon/psd
+// Copyright 2021-present NAVER WEBTOON
+// MIT License
+
+import {VersionedDescriptor} from "../Descriptor";
+import {KnownAliBlock} from "./AliBlockBase";
+import {AliKey} from "./AliKey";
+
+export interface VectorOriginationDataAliBlock
+  extends KnownAliBlock<AliKey.VectorOriginationData> {
+  version: number;
+  data: VersionedDescriptor;
+}

packages/psd/src/interfaces/AdditionalLayerInfo/index.ts

@@ -18,8 +18,12 @@ import {SolidColorSheetSettingAliBlock} from "./SolidColorSheetSettingAliBlock";
 import {TypeToolObjectSettingAliBlock} from "./TypeToolObjectSettingAliBlock";
 import {UnicodeLayerNameAliBlock} from "./UnicodeLayerNameAliBlock";
 import {VectorMaskSettingAliBlock} from "./VectorMaskSettingAliBlock";
+import {VectorOriginationDataAliBlock} from "./VectorOriginationDataAliBlock";
 import {VectorStrokeContentDataAliBlock} from "./VectorStrokeContentDataAliBlock";
 import {VectorStrokeDataAliBlock} from "./VectorStrokeDataAliBlock";
+import {PatternAliBlock} from "./PatternAliBlock";
+import {MultipleObjectBasedEffectsAliBlock} from "./MultipleObjectBasedEffectsAliBlock";
+import {ObjectBasedUndocumentedAliBlock} from "./ObjectBasedUndocumentedAliBlock";
 
 export * from "./AliKey";
 export * from "./SectionDividerSettingAliBlock";
@@ -31,6 +35,8 @@ export * from "./HueSaturationAliBlock";
 export * from "./LayerIdAliBlock";
 export * from "./NestedSectionDividerSettingAliBlock";
 export * from "./ObjectBasedEffectsAliBlock";
+export * from "./MultipleObjectBasedEffectsAliBlock";
+export * from "./ObjectBasedUndocumentedAliBlock";
 export * from "./PatternFillSettingAliBlock";
 export * from "./SolidColorSheetSettingAliBlock";
 export * from "./VectorMaskSettingAliBlock";
@@ -39,6 +45,7 @@ export * from "./VectorStrokeDataAliBlock";
 export * from "./ArtboardDataAliBlock";
 export * from "./SmartObjectPlacedLayerDataAliBlock";
 export * from "./LinkedLayerAliBlock";
+export * from "./PatternAliBlock";
 
 /**
  * Represents a single Additional Layer Info block ("ALI block").
@@ -49,16 +56,21 @@ export type AdditionalLayerInfo =
   | UnicodeLayerNameAliBlock
   | VectorStrokeDataAliBlock
   | ObjectBasedEffectsAliBlock
+  | MultipleObjectBasedEffectsAliBlock
+  | ObjectBasedUndocumentedAliBlock
   | GradientFillSettingAliBlock
   | SolidColorSheetSettingAliBlock
   | PatternFillSettingAliBlock
   | VectorStrokeContentDataAliBlock
+  | VectorOriginationDataAliBlock
   | BlendOptionsCapacityAliBlock
   | VectorMaskSettingAliBlock
+  | PatternFillSettingAliBlock
   | HueSaturationAliBlock
   | NestedSectionDividerSettingAliBlock
   | LayerIdAliBlock
   | ArtboardDataAliBlock
   | SmartObjectPlacedLayerDataAliBlock
   | LinkedLayerAliBlock
+  | PatternAliBlock
   | UnknownAliBlock;

packages/psd/src/interfaces/Descriptor.ts

@@ -185,6 +185,14 @@ export enum UnitFloatType {
   Pixels = "#Pxl",
   /** Tagged unit value */
   Points = "#Pnt",
+
+  /**
+   *  Following descriptions were taken from https://psd-tools.readthedocs.io/en/latest/reference/psd_tools.terminology.html#psd_tools.terminology.Enum.RulerCm
+   *  */
+  /** Ruler centimeter */
+  RulerCm = "RrCm",
+  /**Ruler inches */
+  RulerInches = "RrIn",
 }
 
 /**