ag-psd 21.0.2 → 22.0.0

package/src/additionalInfo.ts

@@ -2,7 +2,7 @@ import { fromByteArray, toByteArray } from 'base64-js';
 import { readEffects, writeEffects } from './effectsHelpers';
 import { clamp, createEnum, layerColors, MOCK_HANDLERS } from './helpers';
 import { LayerAdditionalInfo, BezierPath, Psd, BrightnessAdjustment, ExposureAdjustment, VibranceAdjustment, ColorBalanceAdjustment, BlackAndWhiteAdjustment, PhotoFilterAdjustment, ChannelMixerChannel, ChannelMixerAdjustment, PosterizeAdjustment, ThresholdAdjustment, GradientMapAdjustment, CMYK, SelectiveColorAdjustment, ColorLookupAdjustment, LevelsAdjustmentChannel, LevelsAdjustment, CurvesAdjustment, CurvesAdjustmentChannel, HueSaturationAdjustment, HueSaturationAdjustmentChannel, PresetInfo, Color, ColorBalanceValues, WriteOptions, LinkedFile, PlacedLayerType, Warp, KeyDescriptorItem, BooleanOperation, LayerEffectsInfo, Annotation, LayerVectorMask, AnimationFrame, Timeline, PlacedLayerFilter, UnitsValue, Filter, PlacedLayer, ReadOptions } from './psd';
-import { PsdReader, readSignature, readUnicodeString, skipBytes, readUint32, readUint8, readFloat64, readUint16, readBytes, readInt16, checkSignature, readFloat32, readFixedPointPath32, readSection, readColor, readInt32, readPascalString, readUnicodeStringWithLength, readAsciiString, readPattern, readLayerInfo, ReadOptionsExt } from './psdReader';
+import { PsdReader, readSignature, readUnicodeString, skipBytes, readUint32, readUint8, readFloat64, readUint16, readBytes, readInt16, checkSignature, readFloat32, readFixedPointPath32, readSection, readColor, readInt32, readPascalString, readUnicodeStringWithLength, readAsciiString, readPattern, readLayerInfo } from './psdReader';
 import { PsdWriter, writeZeros, writeSignature, writeBytes, writeUint32, writeUint16, writeFloat64, writeUint8, writeInt16, writeFloat32, writeFixedPointPath32, writeUnicodeString, writeSection, writeUnicodeStringWithPadding, writeColor, writePascalString, writeInt32 } from './psdWriter';
 import { Annt, BlnM, DescriptorColor, DescriptorUnitsValue, parsePercent, parseUnits, parseUnitsOrNumber, QuiltWarpDescriptor, strokeStyleLineAlignment, strokeStyleLineCapType, strokeStyleLineJoinType, TextDescriptor, textGridding, unitsPercent, unitsValue, WarpDescriptor, warpStyle, writeVersionAndDescriptor, readVersionAndDescriptor, StrokeDescriptor, Ornt, horzVrtcToXY, LmfxDescriptor, Lfx2Descriptor, FrameListDescriptor, TimelineDescriptor, FrameDescriptor, xyToHorzVrtc, serializeEffects, parseEffects, parseColor, serializeColor, serializeVectorContent, parseVectorContent, parseTrackList, serializeTrackList, FractionDescriptor, BlrM, BlrQ, SmBQ, SmBM, DspM, UndA, Cnvr, RplS, SphM, Wvtp, ZZTy, Dstr, Chnl, MztT, Lns, blurType, DfsM, ExtT, ExtR, FlCl, CntE, WndM, Drct, IntE, IntC, FlMd, unitsPercentF, frac, ClrS, descBoundsToBounds, boundsToDescBounds } from './descriptor';
 import { serializeEngineData, parseEngineData } from './engineData';
@@ -14,7 +14,7 @@ export interface ExtendedWriteOptions extends WriteOptions {
 }
 
 type HasMethod = (target: LayerAdditionalInfo) => boolean;
-type ReadMethod = (reader: PsdReader, target: LayerAdditionalInfo, left: () => number, psd: Psd, options: ReadOptionsExt) => void;
+type ReadMethod = (reader: PsdReader, target: LayerAdditionalInfo, left: () => number, psd: Psd) => void;
 type WriteMethod = (writer: PsdWriter, target: LayerAdditionalInfo, psd: Psd, options: ExtendedWriteOptions) => void;
 
 export interface InfoHandler {
@@ -513,7 +513,7 @@ addHandler(
 addHandler(
 	'lmfx',
 	target => target.effects !== undefined && hasMultiEffects(target.effects),
-	(reader, target, left, _, options) => {
+	(reader, target, left) => {
 		const version = readUint32(reader);
 		if (version !== 0) throw new Error('Invalid lmfx version');
 
@@ -521,7 +521,7 @@ addHandler(
 		// console.log(require('util').inspect(info, false, 99, true));
 
 		// discard if read in 'lrFX' or 'lfx2' section
-		target.effects = parseEffects(desc, !!options.logMissingFeatures);
+		target.effects = parseEffects(desc, !!reader.logMissingFeatures);
 
 		skipBytes(reader, left());
 	},
@@ -550,7 +550,18 @@ addHandler(
 	'luni',
 	hasKey('name'),
 	(reader, target, left) => {
-		target.name = readUnicodeString(reader);
+		if (left() > 4) {
+			const length = readUint32(reader);
+
+			if (left() >= (length * 2)) {
+				target.name = readUnicodeStringWithLength(reader, length);
+			} else {
+				if (reader.logDevFeatures) reader.log('name in luni section is too long');
+			}
+		} else {
+			if (reader.logDevFeatures) reader.log('empty luni section');
+		}
+
 		skipBytes(reader, left());
 	},
 	(writer, target) => {
@@ -722,7 +733,7 @@ addHandler(
 	'shmd',
 	target => target.timestamp !== undefined || target.animationFrames !== undefined ||
 		target.animationFrameFlags !== undefined || target.timeline !== undefined || target.comps !== undefined,
-	(reader, target, left, _, options) => {
+	(reader, target, left) => {
 		const count = readUint32(reader);
 
 		for (let i = 0; i < count; i++) {
@@ -748,7 +759,7 @@ addHandler(
 						if (f.enab !== undefined) frame.enable = f.enab;
 						if (f.Ofst) frame.offset = horzVrtcToXY(f.Ofst);
 						if (f.FXRf) frame.referencePoint = horzVrtcToXY(f.FXRf);
-						if (f.Lefx) frame.effects = parseEffects(f.Lefx, !!options.logMissingFeatures);
+						if (f.Lefx) frame.effects = parseEffects(f.Lefx, !!reader.logMissingFeatures);
 						if (f.blendOptions && f.blendOptions.Opct) frame.opacity = parsePercent(f.blendOptions.Opct);
 						target.animationFrames.push(frame);
 					}
@@ -779,7 +790,7 @@ addHandler(
 					};
 
 					if (desc.trackList) {
-						timeline.tracks = parseTrackList(desc.trackList, !!options.logMissingFeatures);
+						timeline.tracks = parseTrackList(desc.trackList, !!reader.logMissingFeatures);
 					}
 
 					target.timeline = timeline;
@@ -802,7 +813,7 @@ addHandler(
 						if (item.FXRefPoint) t.effectsReferencePoint = { x: item.FXRefPoint.Hrzn, y: item.FXRefPoint.Vrtc };
 					}
 				} else {
-					options.logMissingFeatures && console.log('Unhandled "shmd" section key', key);
+					reader.logMissingFeatures && reader.log('Unhandled "shmd" section key', key);
 				}
 
 				skipBytes(reader, left());
@@ -3209,7 +3220,7 @@ function getWarpFromPlacedLayer(placed: PlacedLayer): Warp {
 addHandler(
 	'SoLd',
 	hasKey('placedLayer'),
-	(reader, target, left, _, options) => {
+	(reader, target, left) => {
 		if (readSignature(reader) !== 'soLD') throw new Error(`Invalid SoLd type`);
 		const version = readInt32(reader);
 		if (version !== 4 && version !== 5) throw new Error(`Invalid SoLd version`);
@@ -3250,7 +3261,7 @@ addHandler(
 				originalCompID: desc.compInfo.originalCompID,
 			};
 		}
-		if (desc.filterFX) target.placedLayer.filter = parseFilterFX(desc.filterFX, options);
+		if (desc.filterFX) target.placedLayer.filter = parseFilterFX(desc.filterFX, reader);
 
 		// console.log('filter', require('util').inspect(target.placedLayer.filter, false, 99, true));
 
@@ -3356,8 +3367,8 @@ addHandler(
 addHandler(
 	'Lr16',
 	() => false,
-	(reader, _target, _left, psd, options) => {
-		readLayerInfo(reader, psd, options);
+	(reader, _target, _left, psd) => {
+		readLayerInfo(reader, psd);
 	},
 	(_writer, _target) => {
 	},
@@ -3366,8 +3377,8 @@ addHandler(
 addHandler(
 	'Lr32',
 	() => false,
-	(reader, _target, _left, psd, options) => {
-		readLayerInfo(reader, psd, options);
+	(reader, _target, _left, psd) => {
+		readLayerInfo(reader, psd);
 	},
 	(_writer, _target) => {
 	},
@@ -3594,7 +3605,7 @@ interface FileOpenDescriptor {
 addHandler(
 	'lnk2',
 	(target: any) => !!(target as Psd).linkedFiles && (target as Psd).linkedFiles!.length > 0,
-	(reader, target, left, _, options) => {
+	(reader, target, left) => {
 		const psd = target as Psd;
 		psd.linkedFiles = psd.linkedFiles || [];
 
@@ -3649,7 +3660,7 @@ addHandler(
 			if (version >= 7) file.assetLockedState = readUint8(reader);
 			if (type === 'liFE' && version === 2) file.data = readBytes(reader, fileSize);
 
-			if (options.skipLinkedFilesData) file.data = undefined;
+			if (reader.skipLinkedFilesData) file.data = undefined;
 
 			psd.linkedFiles.push(file);
 			linkedFileDescriptor;
@@ -4836,7 +4847,7 @@ export function hasMultiEffects(effects: LayerEffectsInfo) {
 addHandler(
 	'lfx2',
 	target => target.effects !== undefined && !hasMultiEffects(target.effects),
-	(reader, target, left, _, options) => {
+	(reader, target, left) => {
 		const version = readUint32(reader);
 		if (version !== 0) throw new Error(`Invalid lfx2 version`);
 
@@ -4845,7 +4856,7 @@ addHandler(
 
 		// TODO: don't discard if we got it from lmfx
 		// discard if read in 'lrFX' section
-		target.effects = parseEffects(desc, !!options.logMissingFeatures);
+		target.effects = parseEffects(desc, !!reader.logMissingFeatures);
 
 		skipBytes(reader, left());
 	},

package/src/descriptor.ts

@@ -1910,6 +1910,7 @@ export const gradientInterpolationMethodType = createEnum<InterpolationMethod>('
 	perceptual: 'Perc',
 	linear: 'Lnr',
 	classic: 'Gcls',
+	smooth: 'Smoo',
 });
 
 export const ClrS = createEnum<'rgb' | 'hsb' | 'lab'>('ClrS', 'rgb', {

package/src/engineData2.ts

@@ -31,7 +31,7 @@ const keysStyleSheet: KeysDict = {
 	'8': { name: 'Tracking' },
 	'9': { name: 'BaselineShift' },
 	// '10': ???
-	'11': { name: 'Kerning?' }, // different value than EngineData
+	'11': { name: 'Kerning?' }, // different value than EngineData (0 - numerical value, 1 - metric, 2 - optical)
 	'12': { name: 'FontCaps' },
 	'13': { name: 'FontBaseline' },
 
@@ -255,7 +255,7 @@ const keysRoot: KeysDict = {
 				},
 			},
 			'1': {
-				name: 'Editors?',
+				name: 'Editors?', // layer.text.index is specifying the index of the editor related to the layer
 				children: {
 					'0': {
 						name: 'Editor',

package/src/imageResources.ts

@@ -1,5 +1,5 @@
 import { toByteArray } from 'base64-js';
-import { BlendMode, ImageResources, ReadOptions, RenderingIntent } from './psd';
+import { BlendMode, ImageResources, RenderingIntent } from './psd';
 import {
 	PsdReader, readPascalString, readUnicodeString, readUint32, readUint16, readUint8, readFloat64,
 	readBytes, skipBytes, readFloat32, readInt16, readFixedPoint32, readSignature, checkSignature,
@@ -21,7 +21,7 @@ import {
 export interface ResourceHandler {
 	key: number;
 	has: (target: ImageResources) => boolean | number;
-	read: (reader: PsdReader, target: ImageResources, left: () => number, options: ReadOptions) => void;
+	read: (reader: PsdReader, target: ImageResources, left: () => number) => void;
 	write: (writer: PsdWriter, target: ImageResources, index: number) => void;
 }
 
@@ -31,7 +31,7 @@ export const resourceHandlersMap: { [key: number]: ResourceHandler } = {};
 function addHandler(
 	key: number,
 	has: (target: ImageResources) => boolean | number,
-	read: (reader: PsdReader, target: ImageResources, left: () => number, options: ReadOptions) => void,
+	read: (reader: PsdReader, target: ImageResources, left: () => number) => void,
 	write: (writer: PsdWriter, target: ImageResources, index: number) => void,
 ) {
 	const handler: ResourceHandler = { key, has, read, write };
@@ -732,7 +732,7 @@ interface TimelineInformationDescriptor {
 addHandler(
 	1075, // Timeline Information
 	target => target.timelineInformation !== undefined,
-	(reader, target, _, options) => {
+	(reader, target) => {
 		const desc = readVersionAndDescriptor(reader) as TimelineInformationDescriptor;
 
 		target.timelineInformation = {
@@ -745,7 +745,7 @@ addHandler(
 			workOutTime: frac(desc.workOutTime),
 			repeats: desc.LCnt,
 			hasMotion: desc.hasMotion,
-			globalTracks: parseTrackList(desc.globalTrackList, !!options.logMissingFeatures),
+			globalTracks: parseTrackList(desc.globalTrackList, !!reader.logMissingFeatures),
 		};
 
 		if (desc.audioClipGroupList?.audioClipGroupList?.length) {
@@ -874,13 +874,13 @@ addHandler(
 addHandler(
 	1054, // URL List
 	target => target.urlsList !== undefined,
-	(reader, target, _, options) => {
+	(reader, target) => {
 		const count = readUint32(reader);
 		target.urlsList = [];
 
 		for (let i = 0; i < count; i++) {
 			const long = readSignature(reader);
-			if (long !== 'slic' && options.throwForMissingFeatures) throw new Error('Unknown long');
+			if (long !== 'slic' && reader.throwForMissingFeatures) throw new Error('Unknown long');
 			const id = readUint32(reader);
 			const url = readUnicodeString(reader);
 			target.urlsList.push({ id, url, ref: 'slice' });
@@ -1180,7 +1180,7 @@ addHandler(
 addHandler(
 	1036,
 	target => target.thumbnail !== undefined || target.thumbnailRaw !== undefined,
-	(reader, target, left, options) => {
+	(reader, target, left) => {
 		const format = readUint32(reader); // 1 = kJpegRGB, 0 = kRawRGB
 		const width = readUint32(reader);
 		const height = readUint32(reader);
@@ -1191,7 +1191,7 @@ addHandler(
 		const planes = readUint16(reader); // 1
 
 		if (format !== 1 || bitsPerPixel !== 24 || planes !== 1) {
-			options.logMissingFeatures && console.log(`Invalid thumbnail data (format: ${format}, bitsPerPixel: ${bitsPerPixel}, planes: ${planes})`);
+			reader.logMissingFeatures && reader.log(`Invalid thumbnail data (format: ${format}, bitsPerPixel: ${bitsPerPixel}, planes: ${planes})`);
 			skipBytes(reader, left());
 			return;
 		}
@@ -1199,7 +1199,7 @@ addHandler(
 		const size = left();
 		const data = readBytes(reader, size);
 
-		if (options.useRawThumbnail) {
+		if (reader.useRawThumbnail) {
 			target.thumbnailRaw = { width, height, data };
 		} else if (data.byteLength) {
 			target.thumbnail = createCanvasFromData(data);
@@ -1362,7 +1362,7 @@ interface AnimationsDescriptor {
 addHandler(
 	4000, // Plug-In resource(s)
 	target => target.animations !== undefined,
-	(reader, target, left, { logMissingFeatures, logDevFeatures }) => {
+	(reader, target, left) => {
 		const key = readSignature(reader);
 
 		if (key === 'mani') {
@@ -1395,18 +1395,18 @@ addHandler(
 							// console.log('#4000 AnDs:result', require('util').inspect(target.animations, false, 99, true));
 						} else if (key === 'Roll') {
 							const bytes = readBytes(reader, left());
-							logDevFeatures && console.log('#4000 Roll', bytes);
+							reader.logDevFeatures && reader.log('#4000 Roll', bytes);
 						} else {
-							logMissingFeatures && console.log('Unhandled subsection in #4000', key);
+							reader.logMissingFeatures && reader.log('Unhandled subsection in #4000', key);
 						}
 					});
 				}
 			});
 		} else if (key === 'mopt') {
 			const bytes = readBytes(reader, left());
-			logDevFeatures && console.log('#4000 mopt', bytes);
+			reader.logDevFeatures && reader.log('#4000 mopt', bytes);
 		} else {
-			logMissingFeatures && console.log('Unhandled key in #4000:', key);
+			reader.logMissingFeatures && reader.log('Unhandled key in #4000:', key);
 		}
 	},
 	(writer, target) => {
@@ -1462,7 +1462,7 @@ addHandler(
 MOCK_HANDLERS && addHandler(
 	4001, // Plug-In resource(s)
 	target => (target as any)._ir4001 !== undefined,
-	(reader, target, left, { logMissingFeatures, logDevFeatures }) => {
+	(reader, target, left) => {
 		if (MOCK_HANDLERS) {
 			LOG_MOCK_HANDLERS && console.log('image resource 4001', left());
 			(target as any)._ir4001 = readBytes(reader, left());
@@ -1477,12 +1477,12 @@ MOCK_HANDLERS && addHandler(
 
 			const length = readUint32(reader);
 			const bytes = readBytes(reader, length);
-			logDevFeatures && console.log('mfri', bytes);
+			reader.logDevFeatures && reader.log('mfri', bytes);
 		} else if (key === 'mset') {
 			const desc = readVersionAndDescriptor(reader);
-			logDevFeatures && console.log('mset', desc);
+			reader.logDevFeatures && reader.log('mset', desc);
 		} else {
-			logMissingFeatures && console.log('Unhandled key in #4001', key);
+			reader.logMissingFeatures && reader.log('Unhandled key in #4001', key);
 		}
 	},
 	(writer, target) => {

package/src/psd.ts

@@ -402,7 +402,7 @@ export interface LayerTextData {
 	antiAlias?: AntiAlias;
 	gridding?: TextGridding;
 	orientation?: Orientation;
-	index?: number;
+	index?: number; // index of Editor in extra editor data related to this layer
 	warp?: Warp;
 	top?: number;
 	left?: number;
@@ -1689,8 +1689,15 @@ export interface ReadOptions {
 	/** Loads thumbnail raw data instead of decoding it's content into canvas.
 	 * `thumnailRaw` field is used instead. */
 	useRawThumbnail?: boolean;
-	/** Usend only for development. */
+
+	/** Used only for development. */
 	logDevFeatures?: boolean;
+	/** Used only for development. */
+	strict?: boolean;
+	/** Used only for development. */
+	debug?: boolean;
+	/** Used only for development. */
+	log?: (...args: any[]) => void;
 }
 
 export interface WriteOptions {