psd 3.4.0 → 4.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (216) hide show
  1. package/README.md +196 -149
  2. package/dist/descriptor.d.ts +20 -0
  3. package/dist/descriptor.d.ts.map +1 -0
  4. package/dist/descriptor.js +114 -0
  5. package/dist/descriptor.js.map +1 -0
  6. package/dist/engine-data.d.ts +11 -0
  7. package/dist/engine-data.d.ts.map +1 -0
  8. package/dist/engine-data.js +82 -0
  9. package/dist/engine-data.js.map +1 -0
  10. package/dist/image.d.ts +52 -0
  11. package/dist/image.d.ts.map +1 -0
  12. package/dist/image.js +301 -0
  13. package/dist/image.js.map +1 -0
  14. package/dist/index.d.ts +16 -0
  15. package/dist/index.d.ts.map +1 -0
  16. package/dist/index.js +10 -0
  17. package/dist/index.js.map +1 -0
  18. package/dist/layer-info.d.ts +494 -0
  19. package/dist/layer-info.d.ts.map +1 -0
  20. package/dist/layer-info.js +529 -0
  21. package/dist/layer-info.js.map +1 -0
  22. package/dist/layer-styles.d.ts +160 -0
  23. package/dist/layer-styles.d.ts.map +1 -0
  24. package/dist/layer-styles.js +183 -0
  25. package/dist/layer-styles.js.map +1 -0
  26. package/dist/layer.d.ts +143 -0
  27. package/dist/layer.d.ts.map +1 -0
  28. package/dist/layer.js +249 -0
  29. package/dist/layer.js.map +1 -0
  30. package/dist/nodes.d.ts +233 -0
  31. package/dist/nodes.d.ts.map +1 -0
  32. package/dist/nodes.js +326 -0
  33. package/dist/nodes.js.map +1 -0
  34. package/dist/path-record.d.ts +34 -0
  35. package/dist/path-record.d.ts.map +1 -0
  36. package/dist/path-record.js +44 -0
  37. package/dist/path-record.js.map +1 -0
  38. package/dist/png.d.ts +10 -0
  39. package/dist/png.d.ts.map +1 -0
  40. package/dist/png.js +85 -0
  41. package/dist/png.js.map +1 -0
  42. package/dist/psd.d.ts +49 -0
  43. package/dist/psd.d.ts.map +1 -0
  44. package/dist/psd.js +106 -0
  45. package/dist/psd.js.map +1 -0
  46. package/dist/reader.d.ts +41 -0
  47. package/dist/reader.d.ts.map +1 -0
  48. package/dist/reader.js +100 -0
  49. package/dist/reader.js.map +1 -0
  50. package/dist/resources.d.ts +105 -0
  51. package/dist/resources.d.ts.map +1 -0
  52. package/dist/resources.js +173 -0
  53. package/dist/resources.js.map +1 -0
  54. package/dist/type-tool.d.ts +142 -0
  55. package/dist/type-tool.d.ts.map +1 -0
  56. package/dist/type-tool.js +222 -0
  57. package/dist/type-tool.js.map +1 -0
  58. package/package.json +26 -32
  59. package/src/descriptor.ts +141 -0
  60. package/src/engine-data.ts +86 -0
  61. package/src/image.ts +338 -0
  62. package/src/index.ts +38 -0
  63. package/src/layer-info.ts +578 -0
  64. package/src/layer-styles.ts +339 -0
  65. package/src/layer.ts +334 -0
  66. package/src/nodes.ts +411 -0
  67. package/src/path-record.ts +69 -0
  68. package/src/png.ts +92 -0
  69. package/src/psd.ts +133 -0
  70. package/src/reader.ts +125 -0
  71. package/src/resources.ts +273 -0
  72. package/src/type-tool.ts +270 -0
  73. package/.travis.yml +0 -5
  74. package/Cakefile +0 -61
  75. package/DEVELOPMENT.md +0 -27
  76. package/bower.json +0 -26
  77. package/docs/docco.css +0 -284
  78. package/docs/lib/psd/blend_mode.coffee.html +0 -72
  79. package/docs/lib/psd/channel_image.coffee.html +0 -81
  80. package/docs/lib/psd/color.coffee.html +0 -13
  81. package/docs/lib/psd/descriptor.coffee.html +0 -173
  82. package/docs/lib/psd/file.coffee.html +0 -78
  83. package/docs/lib/psd/header.coffee.html +0 -71
  84. package/docs/lib/psd/image.coffee.html +0 -94
  85. package/docs/lib/psd/image_export.coffee.html +0 -5
  86. package/docs/lib/psd/image_exports/png.coffee.html +0 -19
  87. package/docs/lib/psd/image_format.coffee.html +0 -8
  88. package/docs/lib/psd/image_formats/layer_raw.coffee.html +0 -9
  89. package/docs/lib/psd/image_formats/layer_rle.coffee.html +0 -10
  90. package/docs/lib/psd/image_formats/raw.coffee.html +0 -6
  91. package/docs/lib/psd/image_formats/rle.coffee.html +0 -37
  92. package/docs/lib/psd/image_mode.coffee.html +0 -7
  93. package/docs/lib/psd/image_modes/cmyk.coffee.html +0 -36
  94. package/docs/lib/psd/image_modes/greyscale.coffee.html +0 -17
  95. package/docs/lib/psd/image_modes/rgb.coffee.html +0 -32
  96. package/docs/lib/psd/init.coffee.html +0 -22
  97. package/docs/lib/psd/layer/blend_modes.coffee.html +0 -22
  98. package/docs/lib/psd/layer/blending_ranges.coffee.html +0 -29
  99. package/docs/lib/psd/layer/channel_image.coffee.html +0 -13
  100. package/docs/lib/psd/layer/helpers.coffee.html +0 -19
  101. package/docs/lib/psd/layer/info.coffee.html +0 -69
  102. package/docs/lib/psd/layer/mask.coffee.html +0 -11
  103. package/docs/lib/psd/layer/name.coffee.html +0 -15
  104. package/docs/lib/psd/layer/position_channels.coffee.html +0 -24
  105. package/docs/lib/psd/layer.coffee.html +0 -64
  106. package/docs/lib/psd/layer_info/blend_clipping_elements.coffee.html +0 -11
  107. package/docs/lib/psd/layer_info/blend_interior_elements.coffee.html +0 -11
  108. package/docs/lib/psd/layer_info/fill_opacity.coffee.html +0 -10
  109. package/docs/lib/psd/layer_info/gradient_fill.coffee.html +0 -12
  110. package/docs/lib/psd/layer_info/layer_id.coffee.html +0 -10
  111. package/docs/lib/psd/layer_info/layer_name_source.coffee.html +0 -10
  112. package/docs/lib/psd/layer_info/legacy_typetool.coffee.html +0 -82
  113. package/docs/lib/psd/layer_info/locked.coffee.html +0 -24
  114. package/docs/lib/psd/layer_info/metadata.coffee.html +0 -30
  115. package/docs/lib/psd/layer_info/nested_section_divider.coffee.html +0 -23
  116. package/docs/lib/psd/layer_info/object_effects.coffee.html +0 -12
  117. package/docs/lib/psd/layer_info/section_divider.coffee.html +0 -41
  118. package/docs/lib/psd/layer_info/solid_color.coffee.html +0 -24
  119. package/docs/lib/psd/layer_info/typetool.coffee.html +0 -121
  120. package/docs/lib/psd/layer_info/unicode_name.coffee.html +0 -14
  121. package/docs/lib/psd/layer_info/vector_mask.coffee.html +0 -37
  122. package/docs/lib/psd/layer_info/vector_origination.coffee.html +0 -12
  123. package/docs/lib/psd/layer_info/vector_stroke.coffee.html +0 -12
  124. package/docs/lib/psd/layer_info/vector_stroke_content.coffee.html +0 -12
  125. package/docs/lib/psd/layer_info.coffee.html +0 -11
  126. package/docs/lib/psd/layer_mask.coffee.html +0 -73
  127. package/docs/lib/psd/lazy_execute.coffee.html +0 -80
  128. package/docs/lib/psd/mask.coffee.html +0 -47
  129. package/docs/lib/psd/node.coffee.html +0 -100
  130. package/docs/lib/psd/nodes/ancestry.coffee.html +0 -47
  131. package/docs/lib/psd/nodes/build_preview.coffee.html +0 -6
  132. package/docs/lib/psd/nodes/group.coffee.html +0 -19
  133. package/docs/lib/psd/nodes/layer.coffee.html +0 -17
  134. package/docs/lib/psd/nodes/root.coffee.html +0 -61
  135. package/docs/lib/psd/nodes/search.coffee.html +0 -23
  136. package/docs/lib/psd/path_record.coffee.html +0 -73
  137. package/docs/lib/psd/resource.coffee.html +0 -20
  138. package/docs/lib/psd/resource_section.coffee.html +0 -16
  139. package/docs/lib/psd/resources/layer_comps.coffee.html +0 -31
  140. package/docs/lib/psd/resources.coffee.html +0 -44
  141. package/docs/lib/psd/util.coffee.html +0 -24
  142. package/docs/lib/psd.coffee.html +0 -85
  143. package/index.js +0 -2
  144. package/lib/psd/blend_mode.coffee +0 -78
  145. package/lib/psd/channel_image.coffee +0 -87
  146. package/lib/psd/color.coffee +0 -10
  147. package/lib/psd/descriptor.coffee +0 -189
  148. package/lib/psd/file.coffee +0 -88
  149. package/lib/psd/header.coffee +0 -83
  150. package/lib/psd/image.coffee +0 -107
  151. package/lib/psd/image_export.coffee +0 -2
  152. package/lib/psd/image_exports/png.coffee +0 -28
  153. package/lib/psd/image_format.coffee +0 -5
  154. package/lib/psd/image_formats/layer_raw.coffee +0 -6
  155. package/lib/psd/image_formats/layer_rle.coffee +0 -7
  156. package/lib/psd/image_formats/raw.coffee +0 -3
  157. package/lib/psd/image_formats/rle.coffee +0 -38
  158. package/lib/psd/image_mode.coffee +0 -4
  159. package/lib/psd/image_modes/cmyk.coffee +0 -36
  160. package/lib/psd/image_modes/greyscale.coffee +0 -14
  161. package/lib/psd/image_modes/rgb.coffee +0 -39
  162. package/lib/psd/init.coffee +0 -21
  163. package/lib/psd/layer/blend_modes.coffee +0 -20
  164. package/lib/psd/layer/blending_ranges.coffee +0 -28
  165. package/lib/psd/layer/channel_image.coffee +0 -10
  166. package/lib/psd/layer/helpers.coffee +0 -16
  167. package/lib/psd/layer/info.coffee +0 -76
  168. package/lib/psd/layer/mask.coffee +0 -8
  169. package/lib/psd/layer/name.coffee +0 -12
  170. package/lib/psd/layer/position_channels.coffee +0 -22
  171. package/lib/psd/layer.coffee +0 -64
  172. package/lib/psd/layer_info/artboard.coffee +0 -16
  173. package/lib/psd/layer_info/blend_clipping_elements.coffee +0 -8
  174. package/lib/psd/layer_info/blend_interior_elements.coffee +0 -8
  175. package/lib/psd/layer_info/fill_opacity.coffee +0 -7
  176. package/lib/psd/layer_info/gradient_fill.coffee +0 -9
  177. package/lib/psd/layer_info/layer_id.coffee +0 -7
  178. package/lib/psd/layer_info/layer_name_source.coffee +0 -7
  179. package/lib/psd/layer_info/legacy_typetool.coffee +0 -80
  180. package/lib/psd/layer_info/locked.coffee +0 -21
  181. package/lib/psd/layer_info/metadata.coffee +0 -27
  182. package/lib/psd/layer_info/nested_section_divider.coffee +0 -22
  183. package/lib/psd/layer_info/object_effects.coffee +0 -9
  184. package/lib/psd/layer_info/section_divider.coffee +0 -38
  185. package/lib/psd/layer_info/solid_color.coffee +0 -21
  186. package/lib/psd/layer_info/typetool.coffee +0 -172
  187. package/lib/psd/layer_info/unicode_name.coffee +0 -11
  188. package/lib/psd/layer_info/vector_mask.coffee +0 -35
  189. package/lib/psd/layer_info/vector_origination.coffee +0 -9
  190. package/lib/psd/layer_info/vector_stroke.coffee +0 -9
  191. package/lib/psd/layer_info/vector_stroke_content.coffee +0 -9
  192. package/lib/psd/layer_info.coffee +0 -8
  193. package/lib/psd/layer_mask.coffee +0 -73
  194. package/lib/psd/lazy_execute.coffee +0 -86
  195. package/lib/psd/mask.coffee +0 -52
  196. package/lib/psd/node.coffee +0 -150
  197. package/lib/psd/nodes/ancestry.coffee +0 -44
  198. package/lib/psd/nodes/build_preview.coffee +0 -3
  199. package/lib/psd/nodes/group.coffee +0 -16
  200. package/lib/psd/nodes/layer.coffee +0 -14
  201. package/lib/psd/nodes/root.coffee +0 -59
  202. package/lib/psd/nodes/search.coffee +0 -20
  203. package/lib/psd/path_record.coffee +0 -72
  204. package/lib/psd/resource.coffee +0 -17
  205. package/lib/psd/resource_section.coffee +0 -16
  206. package/lib/psd/resources/guides.coffee +0 -25
  207. package/lib/psd/resources/layer_comps.coffee +0 -28
  208. package/lib/psd/resources/layer_links.coffee +0 -17
  209. package/lib/psd/resources/resolution_info.coffee +0 -26
  210. package/lib/psd/resources.coffee +0 -41
  211. package/lib/psd/util.coffee +0 -23
  212. package/lib/psd.coffee +0 -92
  213. package/output/Logo_Glyph.png +0 -0
  214. package/output/Make a change and save..png +0 -0
  215. package/output/Matte.png +0 -0
  216. package/webpack.config.js +0 -23
@@ -0,0 +1,339 @@
1
+ import type { Descriptor } from './descriptor.ts';
2
+ import { labToRgb } from './image.ts';
3
+ import type { BlendMode } from './layer.ts';
4
+
5
+ export type RGB = [number, number, number];
6
+
7
+ /** Layer styles (the `lfx2`/`lmfx` block, or `lfxs` for groups). Photoshop CC allows several of some effects per layer. */
8
+ export interface LayerStyles {
9
+ /** The master "show effects" switch. */
10
+ enabled: boolean;
11
+ /** Effect scale, where 1 is 100%. */
12
+ scale: number;
13
+ dropShadows: Shadow[];
14
+ innerShadows: Shadow[];
15
+ outerGlows: Glow[];
16
+ innerGlows: Glow[];
17
+ bevels: Bevel[];
18
+ satins: Satin[];
19
+ colorOverlays: ColorOverlay[];
20
+ gradientOverlays: GradientOverlay[];
21
+ patternOverlays: PatternOverlay[];
22
+ strokes: Stroke[];
23
+ /** The raw descriptor, for anything not covered above. */
24
+ data: Descriptor;
25
+ }
26
+
27
+ interface Effect {
28
+ enabled: boolean;
29
+ blendMode: BlendMode | string | undefined;
30
+ /** 0 to 1. */
31
+ opacity: number;
32
+ }
33
+
34
+ export interface Shadow extends Effect {
35
+ /** Undefined for colors that can't be converted, such as book colors. */
36
+ color: RGB | undefined;
37
+ /** Degrees. */
38
+ angle: number;
39
+ useGlobalLight: boolean;
40
+ distance: number;
41
+ /** "Spread" for drop shadows, "choke" for inner shadows, in pixels. */
42
+ spread: number;
43
+ size: number;
44
+ /** 0 to 1. */
45
+ noise: number;
46
+ antiAlias: boolean;
47
+ contour: string | undefined;
48
+ }
49
+
50
+ export interface Glow extends Effect {
51
+ /** Glows use either a color or a gradient. */
52
+ color: RGB | undefined;
53
+ gradient: Gradient | undefined;
54
+ /** `SfBL` (softer) or `PrBL` (precise). */
55
+ technique: string | undefined;
56
+ /** "Spread" for outer glows, "choke" for inner glows, in pixels. */
57
+ spread: number;
58
+ size: number;
59
+ noise: number;
60
+ jitter: number;
61
+ range: number;
62
+ /** Inner glows only: `SrcC` (center) or `SrcE` (edge). */
63
+ source: string | undefined;
64
+ antiAlias: boolean;
65
+ contour: string | undefined;
66
+ }
67
+
68
+ export interface Bevel {
69
+ enabled: boolean;
70
+ /** `OtrB` (outer bevel), `InrB` (inner bevel), `Embs` (emboss), `PlEb` (pillow emboss) or `strokeEmboss`. */
71
+ style: string | undefined;
72
+ /** `SfBL` (smooth), `PrBL` (chisel hard) or `Slmt` (chisel soft). */
73
+ technique: string | undefined;
74
+ /** 0 to 10 (1 = 100%). */
75
+ depth: number;
76
+ direction: 'up' | 'down';
77
+ size: number;
78
+ soften: number;
79
+ angle: number;
80
+ altitude: number;
81
+ useGlobalLight: boolean;
82
+ highlight: { blendMode: BlendMode | string | undefined; color: RGB | undefined; opacity: number };
83
+ shadow: { blendMode: BlendMode | string | undefined; color: RGB | undefined; opacity: number };
84
+ antiAlias: boolean;
85
+ contour: string | undefined;
86
+ }
87
+
88
+ export interface Satin extends Effect {
89
+ color: RGB | undefined;
90
+ angle: number;
91
+ distance: number;
92
+ size: number;
93
+ invert: boolean;
94
+ antiAlias: boolean;
95
+ contour: string | undefined;
96
+ }
97
+
98
+ export interface ColorOverlay extends Effect {
99
+ color: RGB | undefined;
100
+ }
101
+
102
+ export interface GradientStop {
103
+ /** 0 to 1. */
104
+ location: number;
105
+ /** 0 to 1. */
106
+ midpoint: number;
107
+ }
108
+
109
+ export interface Gradient {
110
+ name: string;
111
+ /** `CstS` (solid) or `ClNs` (noise). */
112
+ type: string | undefined;
113
+ /** 0 to 1. */
114
+ smoothness: number;
115
+ colorStops: Array<GradientStop & { color: RGB | undefined }>;
116
+ opacityStops: Array<GradientStop & { opacity: number }>;
117
+ }
118
+
119
+ export interface GradientOverlay extends Effect {
120
+ gradient: Gradient | undefined;
121
+ angle: number;
122
+ /** `Lnr` (linear), `Rdl` (radial), `Angl` (angle), `Rflc` (reflected) or `Dmnd` (diamond). */
123
+ style: string | undefined;
124
+ reverse: boolean;
125
+ alignWithLayer: boolean;
126
+ /** 1 = 100%. */
127
+ scale: number;
128
+ /** Percent of the layer size. */
129
+ offset: { x: number; y: number };
130
+ }
131
+
132
+ export interface PatternOverlay extends Effect {
133
+ pattern: { name: string; id: string } | undefined;
134
+ scale: number;
135
+ alignWithLayer: boolean;
136
+ }
137
+
138
+ export interface Stroke extends Effect {
139
+ size: number;
140
+ /** `OutF` (outside), `InsF` (inside) or `CtrF` (center). */
141
+ position: string | undefined;
142
+ /** `SClr` (color), `GrFl` (gradient) or `Ptrn` (pattern). */
143
+ fillType: string | undefined;
144
+ color: RGB | undefined;
145
+ gradient: Gradient | undefined;
146
+ pattern: { name: string; id: string } | undefined;
147
+ }
148
+
149
+ const BLEND_MODES: Record<string, BlendMode> = {
150
+ Nrml: 'normal',
151
+ Dslv: 'dissolve',
152
+ Drkn: 'darken',
153
+ Mltp: 'multiply',
154
+ CBrn: 'color_burn',
155
+ linearBurn: 'linear_burn',
156
+ darkerColor: 'darker_color',
157
+ Lghn: 'lighten',
158
+ Scrn: 'screen',
159
+ CDdg: 'color_dodge',
160
+ linearDodge: 'linear_dodge',
161
+ lighterColor: 'lighter_color',
162
+ Ovrl: 'overlay',
163
+ SftL: 'soft_light',
164
+ HrdL: 'hard_light',
165
+ vividLight: 'vivid_light',
166
+ linearLight: 'linear_light',
167
+ pinLight: 'pin_light',
168
+ hardMix: 'hard_mix',
169
+ Dfrn: 'difference',
170
+ Xclu: 'exclusion',
171
+ blendSubtraction: 'subtract',
172
+ blendDivide: 'divide',
173
+ H: 'hue',
174
+ Strt: 'saturation',
175
+ Clr: 'color',
176
+ Lmns: 'luminosity',
177
+ passThrough: 'passthru',
178
+ };
179
+
180
+ /** Unit values (`{ value }`) and plain numbers as a number. */
181
+ const num = (v: any): number => (typeof v === 'object' && v !== null ? v.value : (v ?? 0));
182
+ const percent = (v: any) => num(v) / 100;
183
+ const enumValue = (v: any): string | undefined => v?.value?.trim();
184
+ const blendMode = (v: any) => {
185
+ const value = enumValue(v);
186
+ return value === undefined ? undefined : (BLEND_MODES[value] ?? value);
187
+ };
188
+ const contour = (v: any): string | undefined => v?.['Nm '];
189
+ const pattern = (v: any) => (v ? { name: v['Nm '] as string, id: v.Idnt as string } : undefined);
190
+
191
+ /** Converts a descriptor color to RGB. */
192
+ export function descriptorColor(c: Descriptor | undefined): RGB | undefined {
193
+ if (!c) return undefined;
194
+ const round = (values: number[]) => values.map((v) => Math.round(Math.min(Math.max(v, 0), 255))) as RGB;
195
+ switch (c.class.id) {
196
+ case 'RGBC':
197
+ return 'redFloat' in c
198
+ ? round([c.redFloat * 255, c.greenFloat * 255, c.blueFloat * 255])
199
+ : round([c['Rd '], c['Grn '], c['Bl ']]);
200
+ case 'Grsc': {
201
+ const gray = 255 - (num(c['Gry ']) * 255) / 100;
202
+ return round([gray, gray, gray]);
203
+ }
204
+ case 'HSBC': {
205
+ const [h, s, v] = [num(c['H ']) / 60, c['Strt'] / 100, c['Brgh'] / 100];
206
+ const f = (n: number) => {
207
+ const k = (n + h) % 6;
208
+ return 255 * (v - v * s * Math.max(0, Math.min(k, 4 - k, 1)));
209
+ };
210
+ return round([f(5), f(3), f(1)]);
211
+ }
212
+ case 'CMYC': {
213
+ const k = c['Blck'] / 100;
214
+ return round([c['Cyn '], c['Mgnt'], c['Ylw ']].map((v) => 255 * (1 - v / 100) * (1 - k)));
215
+ }
216
+ case 'LbCl':
217
+ return labToRgb((c['Lmnc'] * 255) / 100, c['A '] + 128, c['B '] + 128);
218
+ default:
219
+ return undefined;
220
+ }
221
+ }
222
+
223
+ function gradient(g: Descriptor | undefined): Gradient | undefined {
224
+ if (!g) return undefined;
225
+ const stop = (s: Descriptor) => ({ location: s.Lctn / 4096, midpoint: s.Mdpn / 100 });
226
+ return {
227
+ name: g['Nm '],
228
+ type: enumValue(g.GrdF),
229
+ smoothness: (g.Intr ?? 4096) / 4096,
230
+ colorStops: (g.Clrs ?? []).map((s: Descriptor) => ({ ...stop(s), color: descriptorColor(s['Clr ']) })),
231
+ opacityStops: (g.Trns ?? []).map((s: Descriptor) => ({ ...stop(s), opacity: percent(s.Opct) })),
232
+ };
233
+ }
234
+
235
+ const effect = (d: Descriptor): Effect => ({ enabled: d.enab ?? false, blendMode: blendMode(d['Md ']), opacity: percent(d.Opct) });
236
+
237
+ const shadow = (d: Descriptor): Shadow => ({
238
+ ...effect(d),
239
+ color: descriptorColor(d['Clr ']),
240
+ angle: num(d.lagl),
241
+ useGlobalLight: d.uglg ?? false,
242
+ distance: num(d.Dstn),
243
+ spread: num(d.Ckmt),
244
+ size: num(d.blur),
245
+ noise: percent(d.Nose),
246
+ antiAlias: d.AntA ?? false,
247
+ contour: contour(d.TrnS),
248
+ });
249
+
250
+ const glow = (d: Descriptor): Glow => ({
251
+ ...effect(d),
252
+ color: descriptorColor(d['Clr ']),
253
+ gradient: gradient(d.Grad),
254
+ technique: enumValue(d.GlwT),
255
+ spread: num(d.Ckmt),
256
+ size: num(d.blur),
257
+ noise: percent(d.Nose),
258
+ jitter: percent(d.ShdN),
259
+ range: percent(d.Inpr),
260
+ source: enumValue(d.glwS),
261
+ antiAlias: d.AntA ?? false,
262
+ contour: contour(d.TrnS),
263
+ });
264
+
265
+ const bevel = (d: Descriptor): Bevel => ({
266
+ enabled: d.enab ?? false,
267
+ style: enumValue(d.bvlS),
268
+ technique: enumValue(d.bvlT),
269
+ depth: percent(d.srgR),
270
+ direction: enumValue(d.bvlD) === 'Out' ? 'down' : 'up',
271
+ size: num(d.blur),
272
+ soften: num(d.Sftn),
273
+ angle: num(d.lagl),
274
+ altitude: num(d.Lald),
275
+ useGlobalLight: d.uglg ?? false,
276
+ highlight: { blendMode: blendMode(d.hglM), color: descriptorColor(d.hglC), opacity: percent(d.hglO) },
277
+ shadow: { blendMode: blendMode(d.sdwM), color: descriptorColor(d.sdwC), opacity: percent(d.sdwO) },
278
+ antiAlias: d.AntA ?? false,
279
+ contour: contour(d.TrnS),
280
+ });
281
+
282
+ const satin = (d: Descriptor): Satin => ({
283
+ ...effect(d),
284
+ color: descriptorColor(d['Clr ']),
285
+ angle: num(d.lagl),
286
+ distance: num(d.Dstn),
287
+ size: num(d.blur),
288
+ invert: d.Invr ?? false,
289
+ antiAlias: d.AntA ?? false,
290
+ contour: contour(d.MpgS),
291
+ });
292
+
293
+ const gradientOverlay = (d: Descriptor): GradientOverlay => ({
294
+ ...effect(d),
295
+ gradient: gradient(d.Grad),
296
+ angle: num(d.Angl),
297
+ style: enumValue(d.Type),
298
+ reverse: d.Rvrs ?? false,
299
+ alignWithLayer: d.Algn ?? false,
300
+ scale: percent(d['Scl ']),
301
+ offset: { x: num(d.Ofst?.Hrzn), y: num(d.Ofst?.Vrtc) },
302
+ });
303
+
304
+ const stroke = (d: Descriptor): Stroke => ({
305
+ ...effect(d),
306
+ size: num(d['Sz ']),
307
+ position: enumValue(d.Styl),
308
+ fillType: enumValue(d.PntT),
309
+ color: descriptorColor(d['Clr ']),
310
+ gradient: gradient(d.Grad),
311
+ pattern: pattern(d.Ptrn),
312
+ });
313
+
314
+ /** Normalizes the layer styles descriptor. */
315
+ export function readLayerStyles(data: Descriptor): LayerStyles {
316
+ // Each effect is stored singly, or as a list under a `...Multi` key in Photoshop CC.
317
+ const list = (single: string, multi?: string): Descriptor[] =>
318
+ (multi && data[multi]) || (data[single] ? [data[single]] : []);
319
+ return {
320
+ enabled: data.masterFXSwitch ?? true,
321
+ scale: data['Scl '] ? percent(data['Scl ']) : 1,
322
+ dropShadows: list('DrSh', 'dropShadowMulti').map(shadow),
323
+ innerShadows: list('IrSh', 'innerShadowMulti').map(shadow),
324
+ outerGlows: list('OrGl').map(glow),
325
+ innerGlows: list('IrGl').map(glow),
326
+ bevels: list('ebbl').map(bevel),
327
+ satins: list('ChFX').map(satin),
328
+ colorOverlays: list('SoFi', 'solidFillMulti').map((d) => ({ ...effect(d), color: descriptorColor(d['Clr ']) })),
329
+ gradientOverlays: list('GrFl', 'gradientFillMulti').map(gradientOverlay),
330
+ patternOverlays: list('patternFill').map((d) => ({
331
+ ...effect(d),
332
+ pattern: pattern(d.Ptrn),
333
+ scale: percent(d['Scl ']),
334
+ alignWithLayer: d.Algn ?? false,
335
+ })),
336
+ strokes: list('FrFX', 'frameFXMulti').map(stroke),
337
+ data,
338
+ };
339
+ }
package/src/layer.ts ADDED
@@ -0,0 +1,334 @@
1
+ import { LayerImage } from './image.ts';
2
+ import { createLayerInfo, type LayerInfo } from './layer-info.ts';
3
+ import type { Header } from './psd.ts';
4
+ import { pad2, type Reader } from './reader.ts';
5
+ import type { Resources } from './resources.ts';
6
+
7
+ export const BLEND_MODES = {
8
+ norm: 'normal',
9
+ dark: 'darken',
10
+ lite: 'lighten',
11
+ hue: 'hue',
12
+ sat: 'saturation',
13
+ colr: 'color',
14
+ lum: 'luminosity',
15
+ mul: 'multiply',
16
+ scrn: 'screen',
17
+ diss: 'dissolve',
18
+ over: 'overlay',
19
+ hLit: 'hard_light',
20
+ sLit: 'soft_light',
21
+ diff: 'difference',
22
+ smud: 'exclusion',
23
+ div: 'color_dodge',
24
+ idiv: 'color_burn',
25
+ lbrn: 'linear_burn',
26
+ lddg: 'linear_dodge',
27
+ vLit: 'vivid_light',
28
+ lLit: 'linear_light',
29
+ pLit: 'pin_light',
30
+ hMix: 'hard_mix',
31
+ pass: 'passthru',
32
+ dkCl: 'darker_color',
33
+ lgCl: 'lighter_color',
34
+ fsub: 'subtract',
35
+ fdiv: 'divide',
36
+ } as const;
37
+
38
+ export type BlendMode = (typeof BLEND_MODES)[keyof typeof BLEND_MODES];
39
+
40
+ export const blendModeName = (key: string): BlendMode | undefined => BLEND_MODES[key.trim() as keyof typeof BLEND_MODES];
41
+
42
+ export interface ChannelInfo {
43
+ /** 0, 1, 2... are color channels, -1 is transparency, -2 the user mask, -3 the real user mask. */
44
+ id: number;
45
+ length: number;
46
+ /** Offset of the channel's image data in the file. */
47
+ offset: number;
48
+ }
49
+
50
+ export interface Mask {
51
+ top: number;
52
+ left: number;
53
+ bottom: number;
54
+ right: number;
55
+ width: number;
56
+ height: number;
57
+ defaultColor: number;
58
+ /** Position is relative to the layer. */
59
+ relative: boolean;
60
+ disabled: boolean;
61
+ invert: boolean;
62
+ }
63
+
64
+ export interface BlendingRange {
65
+ source: { black: [number, number]; white: [number, number] };
66
+ dest: { black: [number, number]; white: [number, number] };
67
+ }
68
+
69
+ export interface BlendingRanges {
70
+ grey: BlendingRange;
71
+ channels: BlendingRange[];
72
+ }
73
+
74
+ /** A tagged block found in a layer record, located by file offset. */
75
+ export interface InfoBlock {
76
+ key: string;
77
+ offset: number;
78
+ length: number;
79
+ }
80
+
81
+ export interface GlobalMask {
82
+ overlayColorSpace: number;
83
+ colorComponents: number[];
84
+ /** 0 (transparent) to 100 (opaque). */
85
+ opacity: number;
86
+ /** 0 = color selected, 1 = color protected, 128 = use value stored per layer. */
87
+ kind: number;
88
+ }
89
+
90
+ /** Tagged block keys whose length is 8 bytes in PSB files. */
91
+ const BIG_KEYS = new Set(['LMsk', 'Lr16', 'Lr32', 'Layr', 'Mt16', 'Mt32', 'Mtrn', 'Alph', 'FMsk', 'lnk2', 'FEid', 'FXid', 'PxSD']);
92
+
93
+ export const readBlockLength = (r: Reader, header: Header, key: string) =>
94
+ header.isBig && BIG_KEYS.has(key) ? r.int64() : r.uint32();
95
+
96
+ /**
97
+ * A raw layer record. Section dividers (the start and end markers of groups) are layers too;
98
+ * use `psd.tree` for the document hierarchy.
99
+ */
100
+ export class Layer {
101
+ readonly header: Header;
102
+ readonly top: number;
103
+ readonly left: number;
104
+ readonly bottom: number;
105
+ readonly right: number;
106
+ readonly channels: ChannelInfo[] = [];
107
+ /** The raw 4-character blend mode key, e.g. `norm`. */
108
+ readonly blendKey: string;
109
+ /** 0-255. */
110
+ readonly opacity: number;
111
+ /** Clipped to the layer below it. */
112
+ readonly clipped: boolean;
113
+ readonly flags: number;
114
+ readonly mask: Mask | undefined;
115
+ readonly blendingRanges: BlendingRanges | undefined;
116
+ /** The pre-Photoshop 5 name. Prefer `name`. */
117
+ readonly legacyName: string;
118
+ /** Every tagged block key in this layer, including ones this library can't parse. */
119
+ readonly infoBlocks: InfoBlock[] = [];
120
+ /** Parsed additional layer information, keyed by name. Each block is parsed on first access. */
121
+ readonly info: LayerInfo;
122
+ readonly #reader: Reader;
123
+ readonly #resources: () => Resources;
124
+ #image: LayerImage | undefined;
125
+
126
+ constructor(r: Reader, header: Header, resources: () => Resources) {
127
+ this.header = header;
128
+ this.#reader = r;
129
+ this.#resources = resources;
130
+ this.top = r.int32();
131
+ this.left = r.int32();
132
+ this.bottom = r.int32();
133
+ this.right = r.int32();
134
+
135
+ const channelCount = r.uint16();
136
+ for (let i = 0; i < channelCount; i++) {
137
+ this.channels.push({ id: r.int16(), length: header.isBig ? r.int64() : r.uint32(), offset: 0 });
138
+ }
139
+
140
+ r.skip(4); // signature, 8BIM
141
+ this.blendKey = r.ascii(4);
142
+ this.opacity = r.uint8();
143
+ this.clipped = r.uint8() === 1;
144
+ this.flags = r.uint8();
145
+ r.skip(1); // filler
146
+
147
+ const extraLength = r.uint32();
148
+ const end = r.pos + extraLength;
149
+
150
+ this.mask = readMask(r);
151
+ this.blendingRanges = readBlendingRanges(r);
152
+
153
+ const nameLength = ((r.uint8() + 4) & ~3) - 1; // padded to a multiple of 4, including the length byte
154
+ this.legacyName = r.ascii(nameLength);
155
+
156
+ while (r.pos < end) {
157
+ r.skip(4); // signature, 8BIM or 8B64
158
+ const key = r.ascii(4);
159
+ const length = pad2(readBlockLength(r, header, key));
160
+ this.infoBlocks.push({ key, offset: r.pos, length });
161
+ r.skip(length);
162
+ }
163
+ r.seek(end);
164
+
165
+ this.info = createLayerInfo(r, this.infoBlocks, header);
166
+ }
167
+
168
+ get width(): number {
169
+ return this.right - this.left;
170
+ }
171
+
172
+ get height(): number {
173
+ return this.bottom - this.top;
174
+ }
175
+
176
+ get name(): string {
177
+ return this.info.name ?? this.legacyName;
178
+ }
179
+
180
+ /** The layer's unique ID, if the file has one. */
181
+ get id(): number | undefined {
182
+ return this.info.layerId;
183
+ }
184
+
185
+ get visible(): boolean {
186
+ return (this.flags & 0x02) === 0;
187
+ }
188
+
189
+ get blendMode(): BlendMode | undefined {
190
+ const dividerMode = this.info.sectionDivider?.blendMode;
191
+ return blendModeName(dividerMode ?? this.blendKey);
192
+ }
193
+
194
+ /** 0-255. */
195
+ get fillOpacity(): number {
196
+ return this.info.fillOpacity ?? 255;
197
+ }
198
+
199
+ /** Starts a group (folder) in the flat layer list. */
200
+ get isFolder(): boolean {
201
+ const divider = this.info.sectionDivider ?? this.info.nestedSectionDivider;
202
+ return divider ? divider.isFolder : this.name === '<Layer group>';
203
+ }
204
+
205
+ /** Ends a group in the flat layer list. */
206
+ get isFolderEnd(): boolean {
207
+ const divider = this.info.sectionDivider ?? this.info.nestedSectionDivider;
208
+ return divider ? divider.isHidden : this.name === '</Layer group>';
209
+ }
210
+
211
+ /** The layer's pixels. Decoding happens on demand. */
212
+ get image(): LayerImage {
213
+ return (this.#image ??= new LayerImage(this, this.#reader, this.#resources));
214
+ }
215
+ }
216
+
217
+ function readMask(r: Reader): Mask | undefined {
218
+ const size = r.uint32();
219
+ if (size === 0) return undefined;
220
+ const end = r.pos + size;
221
+ const top = r.int32();
222
+ const left = r.int32();
223
+ const bottom = r.int32();
224
+ const right = r.int32();
225
+ const defaultColor = r.uint8();
226
+ const flags = r.uint8();
227
+ r.seek(end);
228
+ return {
229
+ top,
230
+ left,
231
+ bottom,
232
+ right,
233
+ width: right - left,
234
+ height: bottom - top,
235
+ defaultColor,
236
+ relative: (flags & 0x01) > 0,
237
+ disabled: (flags & 0x02) > 0,
238
+ invert: (flags & 0x04) > 0,
239
+ };
240
+ }
241
+
242
+ function readBlendingRanges(r: Reader): BlendingRanges | undefined {
243
+ const length = r.uint32();
244
+ if (length === 0) return undefined;
245
+ const end = r.pos + length;
246
+ const pair = (): [number, number] => [r.uint8(), r.uint8()];
247
+ const range = (): BlendingRange => ({ source: { black: pair(), white: pair() }, dest: { black: pair(), white: pair() } });
248
+ const grey = range();
249
+ const channels = Array.from({ length: (length - 8) / 8 }, range);
250
+ r.seek(end);
251
+ return { grey, channels };
252
+ }
253
+
254
+ export interface LayerSection {
255
+ /** Top to bottom, including group start/end dividers. */
256
+ layers: Layer[];
257
+ globalMask: GlobalMask | undefined;
258
+ /** The first alpha channel of the composite image holds the merged transparency. */
259
+ mergedAlpha: boolean;
260
+ }
261
+
262
+ /**
263
+ * Parses the layer and mask information section. `r` is positioned at its length field.
264
+ * `resources` is only read when decoding indexed color layers, which need the color table.
265
+ */
266
+ export function readLayerSection(r: Reader, header: Header, resources: () => Resources): LayerSection {
267
+ const section: LayerSection = { layers: [], globalMask: undefined, mergedAlpha: false };
268
+ const length = header.isBig ? r.int64() : r.uint32();
269
+ const end = r.pos + length;
270
+ if (length === 0) return section;
271
+
272
+ const readLayers = (infoLength: number) => {
273
+ const infoEnd = r.pos + infoLength;
274
+ if (infoLength > 0) {
275
+ const count = r.int16();
276
+ if (count < 0) section.mergedAlpha = true;
277
+ const layers = Array.from({ length: Math.abs(count) }, () => new Layer(r, header, resources));
278
+
279
+ // Channel image data follows the records, in layer order then channel order.
280
+ let offset = r.pos;
281
+ for (const layer of layers) {
282
+ for (const channel of layer.channels) {
283
+ channel.offset = offset;
284
+ offset += channel.length;
285
+ }
286
+ }
287
+ section.layers.push(...layers);
288
+ }
289
+ r.seek(infoEnd);
290
+ };
291
+
292
+ readLayers(pad2(header.isBig ? r.int64() : r.uint32()));
293
+ section.globalMask = readGlobalMask(r);
294
+
295
+ // 16 and 32-bit documents store their layers in an Lr16 or Lr32 block after the global mask.
296
+ // The main section may hold 8-bit compatibility copies, which these replace. Some files use a
297
+ // Layr block instead, and some pad the blocks with zero bytes.
298
+ while (r.pos + 12 <= end) {
299
+ if (r.bytes[r.pos] === 0) {
300
+ r.skip(1);
301
+ continue;
302
+ }
303
+ const sig = r.ascii(4);
304
+ if (sig !== '8BIM' && sig !== '8B64') break;
305
+ const key = r.ascii(4);
306
+ const blockLength = pad2(readBlockLength(r, header, key));
307
+ const blockEnd = r.pos + blockLength;
308
+ if (key === `Lr${header.depth}`) {
309
+ section.layers = [];
310
+ readLayers(blockLength);
311
+ } else if (key === 'Layr' && section.layers.length === 0) {
312
+ readLayers(blockLength);
313
+ }
314
+ r.seek(blockEnd);
315
+ }
316
+
317
+ section.layers.reverse();
318
+ r.seek(end);
319
+ return section;
320
+ }
321
+
322
+ function readGlobalMask(r: Reader): GlobalMask | undefined {
323
+ const length = r.uint32();
324
+ if (length === 0) return undefined;
325
+ const end = r.pos + length;
326
+ const mask = {
327
+ overlayColorSpace: r.int16(),
328
+ colorComponents: [0, 0, 0, 0].map(() => r.uint16() >> 8),
329
+ opacity: r.uint16(),
330
+ kind: r.uint8(),
331
+ };
332
+ r.seek(end);
333
+ return mask;
334
+ }