ag-psd 31.0.3 → 33.0.0

package/CHANGELOG.md

@@ -1,5 +1,112 @@
 # Changelog
 
+## v33.0.0
+- **BREAKING CHANGE:** CMYK colors stored in binary color structures (legacy `lrFX` effects, background color, filter mask, etc.) are now inverted on read and write (Photoshop stores 0 as 100% ink), matching CMYK colors read from descriptors
+- **BREAKING CHANGE:** Text layers with "Windows" and "Windows LCD" anti-aliasing now read as `platform` and `platformLCD` instead of `smooth`, and writing them no longer produces `sharp` anti-aliasing
+- **BREAKING CHANGE:** Hue/saturation adjustment colorize settings are now read as `colorize` and `colorization` (`hue` 0-360, `saturation`, `lightness`) fields, previously they were incorrectly read as `a`, `b`, `c`, `d` fields of `master`, which now only has `hue`, `saturation` and `lightness`
+- **BREAKING CHANGE:** Removed `pathList` field (it was always empty), saved paths are now read and written as `imageResources.savedPaths`
+- **BREAKING CHANGE:** Levels and curves adjustment layers now use `channels` array (index 0 is composite channel, followed by document color channels) instead of `rgb`, `red`, `green` and `blue` fields, previously black channel of CMYK documents (and other channels) was lost
+- Added support for levels smart filter
+- Added `savedPaths`, `workPath` and `clippingPath` image resources (paths from the Paths panel), previously they were not written back
+- Added support for reading CMYK documents (8 and 16 bits per channel), image data is converted to RGB using approximation of Photoshop's default U.S. Web Coated (SWOP) v2 profile
+- Added `iccProfile`, `exifData`, `iptcData`, `printStyle`, `printFlagsInfo`, `indexedColorCount`, `transparencyIndex`, `alphaChannelDisplayInfo`, `colorHalftoneScreens`, `grayscaleHalftoneScreens`, `colorTransferFunctions` and `grayscaleTransferFunctions` image resources, previously they were not written back
+- Added `generatorSettings` layer field (Generator / Export As settings), and document-level `generatorSettings` (with `assets` and `crema` fields), previously it was not written back
+- Added `printerProfileColorSpace` field to `printInformation`, grayscale printer profile was previously written as RGB, `printerProfile`, `blackPointCompensation` and `proofSetup` are no longer written with default values when missing
+- Added `buildUp` and `group` (brush groups / folders) fields to brushes read with `readAbr`
+- Added support for reading ABR version 1 and 2 files (Photoshop 6 and earlier), sampled brushes are read as brushes with `sampled` shape and sample with generated `brush-N` id
+- Added pattern `linked`, `phase`, `scale` and `angle` fields to stroke effect type (they were already read and written)
+- Fixed writing file read with `useRawData` option producing black composite image
+- Fixed writing color palette of Indexed documents into color mode data of RGB file
+- Fixed writing vector mask of layers with vector stroke as `vmsk` instead of `vsms` (and vector mask of all layers in PSB files as `vsms`), vector masks now also include path component indices like Photoshop
+- Fixed writing effects of group layers in `lfx2` / `lmfx` section instead of `lfxs`
+- Fixed writing Displace smart filter displacement map path without trailing null character
+- Fixed writing placed layer without `width` and `height` with zero size when `warp` is provided
+- Added `'Distance'` units (used by print style)
+- Added `external` field to `placedLayer` for linked smart objects, they are now written as `SoLE` without `PlLd` (like Photoshop), previously they were written as embedded smart objects
+- Added `gradient` and `interpolationMethod` fields to outer and inner glow effect types
+- Added `throwForMissingFeatures` and `totalMemoryLimit` options to `readAbr` and `logMissingFeatures` and `throwForMissingFeatures` options to `readAse`
+- Added `log` write option and `log` field to `PsdWriter`, same as for reading
+- Fixed curves smart filter without preset kind removing all smart filters of the layer
+- Added `shapeContour` field to bevel effect (contour used when `useShape` is enabled), previously it overwrote `contour` (gloss contour) and was lost when writing
+- Added `protected.all` field for "lock all" layer protection flag
+- Added `type` field to gradient color stops using foreground or background color
+- Added `scale` and `angle` fields to pattern stroke and pattern fill layer content
+- Added missing `angle` type on pattern overlay effect, `range` and `antialiased` on bevel effect and `technique` on outer glow effect
+- Fixed writing gradient map layers with interpolation method throwing an error, and interpolation method always reading as `perceptual`
+- Fixed writing layer raw data (`useRawData` option) to a file with different format (PSB to PSD or vice versa, or non-RGB color mode)
+- Fixed crash reading artboard info without background color
+- Fixed lost effects (other than the first) and rounded opacity of animation frames
+- Fixed lost style of empty last paragraph of text layer
+- Fixed reading book (Pantone) colors in descriptors throwing an error (book colors are not supported, they are read as black)
+- Removed hidden properties used to write back original descriptor value types, reference classes and exact color values, values are now always written based on their current data (`GlobalObject`, `GlobalClass` and `UnitFloat` descriptor values are written as `Object`, `Class` and `UnitDouble`)
+- Fixed gradient opacity stops, gradient offsets and HSB hue values changing slightly on round-trip
+- Fixed changing explicit id of other layer when fixing duplicate layer ids
+- Fixed writing `realMask` without `mask` producing empty user mask
+- Fixed reading 16bit RLE compressed brush samples
+- Fixed brushes with transfer dynamics from older Photoshop versions being skipped when reading ABR files (`transfer.wetnessDynamics` and `transfer.mixDynamics` are now optional)
+- Fixed reading empty ABR file throwing `RangeError` instead of `Invalid ABR file` error
+- Fixed reading legacy (non-unicode) UTF-8 alpha channel names that are not valid GBK
+- Fixed empty linked file creator and type being read as `'\0\0\0\0'`
+- Fixed leading BOM being stripped only from long UTF-8 strings
+- Fixed JPEG thumbnails with both JFIF and Adobe markers decoding with wrong colors
+- Fixed malformed patterns and brushes bypassing memory limit
+- Fixed reading files with layers with negative size (now read as empty layers)
+- Fixed composite image transparency marked only by `Mtrn`/`Mt16`/`Mt32` (or by "Transparency" alpha channel name in 16bit documents) being ignored
+- Fixed duplicate layers in 16bit and 32bit documents with both 8bit compatibility layers and `Lr16`/`Lr32` layers
+- Fixed writing `lnk3`, `lnkE`, `pths`, `extd`, `extn`, `FELS` and `artd` in PSB files with 32bit length (Photoshop uses 64bit length), files written by previous versions are still read correctly
+- Fixed glow effect gradient interpolation method being lost
+- Fixed gradient fill and gradient stroke scale and offset being rounded to whole percent when writing
+- Fixed vector stroke without line dash set being lost
+- Fixed faux bold/faux italic (synthetic) variants of the same font being merged when writing text layers
+- Fixed reading photo filter version 3 colors (stored as XYZ, not Lab)
+- Fixed reading pattern transparency, 16bit/32bit patterns and RLE compressed indexed patterns, unsupported or invalid patterns are now skipped instead of removing all following patterns
+- Fixed invalid pattern channel bounds, brush sample sizes and section sizes in ABR files causing huge allocations or hangs
+- Fixed unknown sections (for example tool presets), invalid brushes and samples failing reading of whole ABR file, they are now skipped
+- Fixed ASE files with unknown blocks, unknown color modes or color types, missing color types or non-zero minor version failing to read
+- Fixed frame animations (`imageResources.animations`) being lost when stored in plug-in image resource other than 4000
+- Fixed reading files with 57 channels (56 channels and transparency, written by Photoshop CS3 for 53 alpha channels)
+- Fixed reading files with trailing bytes in image resources section or with image resources section length larger than its data (Photoshop CS2)
+- Fixed layer metadata (timestamp, animation frames, layer comps) being lost for files from Photoshop Elements (`8ELE` signature) and when one of metadata items fails to read
+- Fixed reading stroke effect size stored as number (old Photoshop versions)
+- Fixed display info (`alphaChannelDisplayInfo`) being lost when channel color uses unsupported color space, the color is kept in `rawColor` field
+- Fixed layers with unknown blend mode failing the whole file, they are read with normal blend mode (unless `throwForMissingFeatures` is set)
+- Added support for reading CMYK patterns
+- Added `colorSamplers` (Photoshop 5 color samplers) and `effectsVisible` image resources, obsolete display info resource is read into `alphaChannelDisplayInfo`
+- Added `color` and `id` fields to guides (`gridAndGuidesInformation.guides`)
+- Added `windowsDevMode` (raw printer settings) and `outputSettings` (Save for Web output settings) image resources
+- Frame info plug-in resource is written together with animations, plug-in resources are written with consecutive ids like in Photoshop
+- Added reading of uncompressed (raw RGB) thumbnails
+- Fixed JPEG thumbnails with number of planes other than 1 not being read
+
+## v32.0.0
+- **BREAKING CHANGE:** Mask opacity (`filterMask.opacity`, `userMask.opacity` from `LMsk`, `globalLayerMaskInfo.opacity`) is now read and written using the correct 0-100 scale (Photoshop's default 50% now reads as `0.5` instead of `0.196`)
+- **BREAKING CHANGE:** HSB, CMYK, Lab and Grayscale colors in descriptors (effects, gradients, filters) are now converted to the ranges documented on the `Color` type (HSB `s`/`b` 0-1, CMYK and Gray 0-255, Lab `l` 0-1 and `a`/`b` -1..1)
+- **BREAKING CHANGE:** Gradient stop locations are no longer scaled by gradient smoothness
+- **BREAKING CHANGE:** Text style runs without a font now use the font of the normal style sheet instead of the first font in the font set (usually `AdobeInvisFont`)
+- **BREAKING CHANGE:** Only one trailing newline is removed from text layer text, empty last paragraphs are preserved
+- **BREAKING CHANGE:** Renamed `TextPath.BaselineAlignment` to `baselineAlignment` to match decoded data
+- Fixed decoding 16bit and 32bit RLE compressed image data
+- Fixed reading 16bit and 32bit files modifying input buffer
+- Fixed reading 16bit and 32bit files with transparent composite image
+- Fixed reading composite image with extra alpha/spot channels
+- Fixed reading files with more than 16 channels (up to 56)
+- Fixed reading indexed composite image with raw compression
+- Fixed `getCompositeImageData` for PSB files and files with transparency (added `rawCompositeDataInfo` field to `Psd`, set together with `rawCompositeData`)
+- Fixed writing composite image, layers and patterns with very narrow width (1-2 pixels)
+- Fixed writing masks with both feather parameters producing files that couldn't be read back
+- Fixed layer mask data padding to match Photoshop (padded to multiple of 4 bytes)
+- Layers with animation frames, timeline or layer comps now get generated layer id when writing if `id` field is missing
+- Fixed writing timeline without audio, pattern `linked` field, colored slices, pixel source (video) layers, print proof setup, and some smart filters (perspective warp, oil paint, curves, hsb/hsl)
+- Fixed writing linked files (`lnkE`) producing files that couldn't be read back
+- Fixed negative guide positions
+- Fixed lost or incorrect values on round-trip: channel blending restrictions, filter effect mask extra data, animation frame layer ids, timeline effect keys, pattern overlay angle, grid leading fill color, photo filter Lab color, and several values truncated instead of rounded
+- Fixed reading text annotations with empty or odd-length data
+- Fixed parsing and serializing engine data with `null` values inside arrays and `undefined`/`NaN` values
+- Fixed writing text layers with `FRGB` or `HSB` colors, empty `styleRuns`, CRLF line endings and missing bounds
+- Fixed crashes and infinite loops on malformed files (RLE data, zip data, JPEG thumbnails, layer groups, engine data, brushes)
+- Fixed memory limit not applying to zip-compressed data
+- Reduced memory usage and copying when reading and writing files
+
 ## v31.0.3
 - Fixed crash when string doesn't contain utf-16 BOM
 

package/LICENSE

@@ -24,3 +24,8 @@ SOFTWARE.
 
 Any image or brush files included in this repository are not covered by this
 license and belong to their copyright holders.
+
+CMYK to RGB conversion coefficients in src/psdReader.ts are taken from pdf.js
+(https://github.com/mozilla/pdf.js), Copyright 2012 Mozilla Foundation,
+licensed under the Apache License, Version 2.0
+(http://www.apache.org/licenses/LICENSE-2.0).

package/README.md

@@ -9,13 +9,10 @@ Implemented according to [official documentation](https://www.adobe.com/devnet-a
 
 ## Limitations
 
-* Does not support reading Indexed, CMYK, Multichannel, Duotone and LAB color modes (all supported color modes are converted to RGB mode when reading)
+* Does not support reading Multichannel, Duotone and LAB color modes (image data of all supported color modes - Bitmap, Grayscale, Indexed, RGB and CMYK - is converted to RGB when reading, CMYK colors are converted using approximation of U.S. Web Coated (SWOP) v2 profile, embedded color profile is not used)
 * Does not support writing any color modes other than RGB
-* Does not support 16 bits per channel
-* Does not support The Large Document Format (8BPB/PSB) 
-* Does not support color palettes
-* Does not support animations
-* Limited pattern support: reads and writes document-level pattern blocks (`Patt`/`Pat2`/`Pat3`) for raw/RLE-compressed, RGB/Grayscale patterns. Does not support zip-compressed patterns (used by most real Photoshop files), Indexed or 16-bit patterns, or the "Pattern Overlay" layer effect (only its name/id reference is read/written)
+* Does not support writing 16 or 32 bits per channel (reading is supported)
+* Limited pattern support: reads and writes document-level pattern blocks (`Patt`/`Pat2`/`Pat3`) for raw/RLE-compressed RGB/Grayscale patterns and raw Indexed patterns (patterns are always written as RGB). Does not support zip-compressed patterns (used by most real Photoshop files), RLE-compressed Indexed patterns or 16-bit patterns. Pattern references in layer effects and vector fills (such as "Pattern Overlay") only carry pattern name/id and are not linked to pattern data
 * Does not support some metadata fields
 * Does not support 3d effects
 * Does not support some new features from latest versions of Photoshop