-
Notifications
You must be signed in to change notification settings - Fork 0
/
tagMetadata.js
410 lines (337 loc) · 17.5 KB
/
tagMetadata.js
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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
// copywrite 2023-2024 Richard R. Lyman
const { errorLog, capitalize } = require("./tagUtils.js");
function isSameArea(mwgRect, mpRect) {
for (let i = 0; i < 4; i++) {
if ((mwgRect[i] < (mpRect[i] - .01)) || (mwgRect[i] > (mpRect[i] + .01))) {
return false;
}
}
return true;
};
function tagFile(nativePath) {
let str = nativePath;
str = "-m \"" + nativePath + "\" ";
return str;
}
function noDifs(subjects) {
let z = [];
subjects.forEach((x) => {
if (x != undefined)
z.push(x)
});
return z;
}
/**
* Copy the names in the regions to the keywords and Subject
* @param {*} entry
* @param {*} html
* @param {*} cmd
* @param {*} regions
* @param {*} subjects
*/
function refreshSubjects(entry, html, cmd, regions, subjects) {
if (regions != undefined) {
regions.forEach((region) => {
if (region.name != undefined) {
if (!noDifs(subjects).includes(region.name)) {
errorLog(html, cmd,
"WARNING 03: \"" + region.name + "\" is in MWG mwgRectangle but is not in dc:subject. Copy the name to the keywords and Subject",
"exiftool -Keywords-=\"" + region.name + "\" -Subject-=\"" + region.name + "\" -Subject+=\"" + region.name + "\" -Keywords+=\"" + region.name + "\" " + tagFile(entry.nativePath));
}
}
});
}
}
function regionInfoStruc(mRegions, appliedToWidth, appliedToHeight) {
let str;
if (isNaN(appliedToHeight) || isNaN(appliedToWidth))
str = "RegionList=[";
else
str = "{AppliedToDimensions={H=" + appliedToHeight + ", Unit=pixels, W=" + appliedToWidth + "} , RegionList=[";
let x = [];
for (i in mRegions) {
const mRegion = mRegions[i];
if (mRegion != undefined) {
const rect = mRegion.rect;
x = x.concat("{ Area={ H=" + rect[3].toFixed(4) + ", W=" + rect[2].toFixed(4) + ", X=" + rect[0].toFixed(4) + ", Y=" + rect[1].toFixed(4) + "}, Name=" + mRegion.name + ", Rotation=0.000000, Type=Face } ");
}
};
return str + x.join(", ") + "]}";
}
/**
*
* @param {*} mwgRegions Array from mwg-rs:Regions
* @param {*} subjects Array from dc:Subject
* @param {*} mpRegions Array from Microsoft MP:RegionInfo
* @returns html array of strings containing errors.
*/
function checkProperties(entry, mwgRegions, subjects, mpRegions, appliedToWidth, appliedToHeight) {
let html = [];
let cmd = [];
let mwgNames = [];
let mpNames = [];
mwgRegions.forEach((mwgRegion) => {
if (mwgRegion.name != undefined)
mwgNames.push(mwgRegion.name)
});
mpRegions.forEach((mpRegion) => {
if (mpRegion.name != undefined)
mpNames.push(mpRegion.name)
});
if (mwgRegions.length == 0 && mpRegions.length > 0) {
errorLog(html, cmd,
"WARNING 02: There are Microsoft regions but no Adobe regions. Copy all the valid Microsoft regions to the Adobe regions.",
'exiftool -config facetags.config -RegionInfo<MPRegion2MWGRegion ' + tagFile(entry.nativePath));
refreshSubjects(entry, html, cmd, mpRegions, []);
};
refreshSubjects(entry, html, cmd, mwgRegions, subjects);
// deletes quotation marks that are in the subject name
let done = false;
subjects.forEach((subject) => {
if ((!done) && subject.includes("\"")) {
done = true;
errorLog(html, cmd,
"WARNING 04: Subject, \"" + subject + "\" contains quotation marks. Remove them",
"exiftool -TagsFromFile @ -api 'Filter=s/\\\"//g' -Keywords= " + tagFile(entry.nativePath));
errorLog(html, cmd,
"",
"exiftool -TagsFromFile @ -api 'Filter=s/\\\"//g' -Subject= " + tagFile(entry.nativePath));
refreshSubjects(entry, html, cmd, mwgRegions, []);
}
});
//if there is a name in the subjects and it is not in the adobe regions but it is in the Microsoft regions, then copy over the Microsoft Regions
let newRegions = [];
let newNames = [];
subjects.forEach((subject) => {
let indx = mpNames.indexOf(subject);
if (!mwgNames.includes(subject) && indx >= 0) {
newRegions.push(mpRegions[indx]);
newNames.push(subject);
}
})
if (newRegions.length > 0) {
errorLog(html, cmd,
"WARNING 07: The Microsoft rectangle for \"" + newNames.join(", and ") + "\" " +
"is missing from the matching Adobe rectangle. Transfer the name from the Microsoft region to the Adobe region.",
'exiftool -config facetags.config -RegionInfo<MPRegion2MWGRegion ' + tagFile(entry.nativePath));
// "exiftool -RegionInfo=\"" + regionInfoStruc(mpRegions, appliedToWidth, appliedToHeight) + "\" " + tagFile(entry.nativePath));
errorLog(html, cmd,
"WARNING 07a: The Microsoft rectangle for \"" + newNames.join(", and ") + "\" " +
"is missing from the matching Adobe rectangle. Transfer the name from the Microsoft region to the Adobe region.",
"exiftool -Keywords-=\"" + zKey + "\" -Subject-=\"" + zKey + "\" -Subject+=\"" + zKey + "\" -Keywords+=\"" + zKey + "\" " + tagFile(entry.nativePath));
refreshSubjects(entry, html, cmd, mpRegions, []);
}
// if there is an unidentified rectangle (has a ? for a name), with the same dimensions in Microsoft and Adobe and the name is in the Microsoft rectangles, than add it back in.
newNames = [];
for (let i in mwgRegions) {
for (let k in mpRegions) {
if (isSameArea(mwgRegions[i].rect, mpRegions[k].rect)) {
if ((mwgRegions[i].name == undefined || mwgRegions[i].name.length == 0) && (mpRegions[k].name != undefined && mpRegions[k].name.length != 0)) {
// mwgRegions[i] = mpRegions[k];
newNames.push(mpRegions[k].name);
}
}
}
}
if (newNames.length > 0) {
errorLog(html, cmd,
"WARNING 05: The Microsoft rectangle for \"" + newNames.join(", and ") + "\" " +
"is missing from the matching Adobe rectangle. Transfer the name from the Microsoft region to the Adobe region.",
"exiftool -RegionInfo=\"" + regionInfoStruc(mpRegions, appliedToWidth, appliedToHeight) + "\" " + tagFile(entry.nativePath));
refreshSubjects(entry, html, cmd, mwgRegions, []);
}
let dupNames = [];
let foundDup = false;
for (let i = 0; i < mwgRegions.length; i++) {
for (let k = i + 1; k < mwgRegions.length; k++) {
if (mwgRegions[i] != undefined && mwgRegions[i].name != undefined && mwgRegions[k].name != undefined && mwgRegions[i].name == mwgRegions[k].name) {
foundDup = true;
dupNames.push(mwgRegions[i].name);
delete mwgRegions[i];
}
}
}
if (foundDup) {
errorLog(html, cmd,
"WARNING 06: Remove duplicate names " + dupNames.join(",") + " from Adobe regions.",
"exiftool -RegionInfo=\"" + regionInfoStruc(mwgRegions, appliedToWidth, appliedToHeight) + "\" " + tagFile(entry.nativePath));
}
return [html, cmd];
};
function parseString(str) { if (str == undefined || str == null) return undefined; else return str.toString(); }
/**
* Picks up the metadata for the photo, parses it to find the People in Metadata Working Group format
*
* @param {*} entry // File entry of file to extract metadata. If null, use the Photoshop metadata instead of xmpFile
* @returns [persons, subjects] directory of persons in the photo metadata and the subject subjects
*/
function readPersonsFromMetadata(entry) {
if (entry != null && entry.name.includes(fileToDebug)) {
let k = 5;
}
let persons = [];
let subjects = new Set();
let regionNames = new Set();
let mpRegions = [];
let mwgRegions = [];
let dcSubjects = [];
let html = [];
let cmd = [];
let lastDate = "2021-09-15T00:22:20";
// NOTE: the x and y point in the metadata is the center of the mwgRectangle for Adobe face Areas. i.e. (x,y) = (top-bottom)/2, (right-left)/2
// Elsewhere in this program, we change the anchor point to be the center of the top of the mwgRectangle.
// There are two ways to get the Metadata; from the file directly with xmpFile or via BatchPlay from Photoshop
// Either way should return the same data.
// The advantage of reading directly from the file is that the metadata can be read without incurring the overhead of loading the photo into photoshop
// The disadvatnge is that, if a new document is created from history, then a file has not yet been written to the disk, but there is metadata
// available if read via photoshop
// NOTE: XMPFile once in a while gets stuck and either needs Photoshop to be restarted or the computer to be rebooted.
// getDocumentXMP is more reliable.
let xmpMeta;
let xmpFile = null;
if (entry == null) {
xmpMeta = new xmp.XMPMeta(getDocumentXMP());
} else {
xmpFile = new xmp.XMPFile(entry.nativePath, xmp.XMPConst.FILE_JPEG, xmp.XMPConst.OPEN_FOR_READ); // not listed as async
xmpMeta = xmpFile.getXMP(); // not listed as async
}
const ns = "http://www.metadataworkinggroup.com/schemas/regions/";
const NSArea = "http://ns.adobe.com/xmp/sType/Area#";
const NSCRS = "http://ns.adobe.com/camera-raw-settings/1.0/";
const XMPDateTime = require('uxp').xmp.XMPDateTime;
const MP = "http://ns.microsoft.com/photo/1.2/";
const MPRI = "http://ns.microsoft.com/photo/1.2/t/RegionInfo#";
const MPReg = "http://ns.microsoft.com/photo/1.2/t/Region#";
try {
////////////////////// read in essential fields ///////////////////////////////////////
let top = parseFloat(xmpMeta.getProperty(xmpConstants.NS_CAMERA_RAW, "crs:CropTop"));
let bottom = 1 - parseFloat(xmpMeta.getProperty(xmpConstants.NS_CAMERA_RAW, "crs:CropBottom"));
let left = parseFloat(xmpMeta.getProperty(xmpConstants.NS_CAMERA_RAW, "crs:CropLeft"));
let right = 1 - parseFloat(xmpMeta.getProperty(xmpConstants.NS_CAMERA_RAW, "crs:CropRight"));
const appliedToHeight = parseFloat(xmpMeta.getProperty(ns, "mwg-rs:Regions/mwg-rs:AppliedToDimensions/stDim:h"));
const appliedToWidth = parseFloat(xmpMeta.getProperty(ns, "mwg-rs:Regions/mwg-rs:AppliedToDimensions/stDim:w"));
let dateTaken = parseString(xmpMeta.getProperty(xmpConstants.NS_XMP, "xmp:CreateDate"));
const dateModified = parseString(xmpMeta.getProperty(xmpConstants.NS_XMP, "xmp:ModifyDate"));
for (let i = 1; xmpMeta.getProperty(MP, "MP:RegionInfo/MPRI:Regions[" + i + "]") != undefined; i++) {
let rect = parseString(xmpMeta.getProperty(MP, "MP:RegionInfo/MPRI:Regions[" + i + "]/MPReg:Rectangle"));
const personDisplayName = capitalize(parseString(xmpMeta.getProperty(MP, "MP:RegionInfo/MPRI:Regions[" + i + "]/MPReg:PersonDisplayName")));
if ((rect == undefined))
mpRegions.push({ "name": personDisplayName });
else {
rect = rect.split(",");
const mpRegion = {
"name": personDisplayName,
"rect": [
Number(rect[0]) + Number(rect[2]) / 2, // x top left coordinate in the original uncropped photo
Number(rect[1]) + Number(rect[3]) / 2, // y top left coordinate in the original uncropped photo
Number(rect[2]),
Number(rect[3])],
"rectType": "Face",
"unit": "normalized",
"rotation": undefined
}
mpRegions.push(mpRegion);
}
}
for (let i = 1; xmpMeta.getProperty(xmpConstants.NS_DC, "dc:subject[" + i + "]") != undefined; i++) {
let dcSubject = capitalize(parseString(xmpMeta.getProperty(xmpConstants.NS_DC, "dc:subject[" + i + "]")));
dcSubjects.push(dcSubject);
}
for (let i = 1; xmpMeta.getProperty(ns, "mwg-rs:Regions/mwg-rs:RegionList[" + i + "]") != undefined; i++) {
let personName = capitalize(parseString(xmpMeta.getProperty(ns, "mwg-rs:Regions/mwg-rs:RegionList[" + i + "]/mwg-rs:Name"))); // not listed as async
let x = parseFloat(xmpMeta.getStructField(ns, "mwg-rs:Regions/mwg-rs:RegionList[" + i + "]/mwg-rs:Area", NSArea, "x"));
let y = parseFloat(xmpMeta.getStructField(ns, "mwg-rs:Regions/mwg-rs:RegionList[" + i + "]/mwg-rs:Area", NSArea, "y"));
let w = parseFloat(xmpMeta.getStructField(ns, "mwg-rs:Regions/mwg-rs:RegionList[" + i + "]/mwg-rs:Area", NSArea, "w"));
let h = parseFloat(xmpMeta.getStructField(ns, "mwg-rs:Regions/mwg-rs:RegionList[" + i + "]/mwg-rs:Area", NSArea, "h"));
let rectUnit = parseString(xmpMeta.getStructField(ns, "mwg-rs:Regions/mwg-rs:RegionList[" + i + "]/mwg-rs:Area", NSArea, "unit"));
let rectType = parseString(xmpMeta.getProperty(ns, "mwg-rs:Regions/mwg-rs:RegionList[" + i + "]/mwg-rs:Type")); // not listed as async
let rotation = parseString(xmpMeta.getProperty(ns, "mwg-rs:Regions/mwg-rs:RegionList[" + i + "]/mwg-rs:Rotation")); // not listed as async
const mwgRegion = {
"name": personName,
"rect": [x, y, w, h],
"rectType": rectType,
"unit": rectUnit,
"rotation": rotation
};
// ignore partially defined regiions. Both Microsoft and Adobe leave partially defined regions. Ignore them instead of try to deal withthem
// if (hasArea(mwgRegion.rect) && (mwgRegion.name != undefined))
mwgRegions.push(mwgRegion);
}
[html, cmd] = checkProperties(entry, mwgRegions, dcSubjects, mpRegions, appliedToWidth, appliedToHeight);
////////////////////////////// fix up values ////////////////////////////
if (!(isNaN(appliedToHeight) || isNaN(appliedToWidth))) {
// When a photo is cropped in Lightroom, the appliedToWidth and appliedToHeight are the CROPPED dimensions.
// However, the x,y,w,h are the relative (between 0 and 1) coordinates of the face mwgRectangle in the UNCROPPED photo.
// To calculate the uncropped photos width and height, the original dimensions are the shrunken appliedTo dimensions
// divided by the amount that was cropped out, that is available in CropTop, CropBottom, CropLeft, and CropRight
if (isNaN(top) || isNaN(bottom) || isNaN(left) || isNaN(right)) {
top = left = bottom = right = 0.0;
}
const xAdj = 1 - (left + right);
const yAdj = 1 - (top + bottom);
let actualWidth = appliedToWidth;
let actualHeight = appliedToHeight;
if (!(xAdj <= 0 || xAdj > 1 || yAdj <= 0 || yAdj > 1 ||
isNaN(appliedToHeight) || isNaN(appliedToWidth))) {
actualWidth = appliedToWidth / xAdj;
actualHeight = appliedToHeight / yAdj;
}
// the dateTaken may be missing so create some date
if (dateTaken != undefined)
dateTaken = dateTaken.toString();
else if (dateModified != undefined)
dateTaken = dateModified.toString();
else
dateTaken = lastDate;
lastDate = dateTaken;
let javascriptDate = new XMPDateTime(dateTaken).getDate();
dcSubjects.forEach((x) => { subjects.add(x) });
mwgRegions.forEach((mwgRegion) => {
const person = {
"name": mwgRegion.name,
"x": mwgRegion.rect[0] * actualWidth, // x pixel coordinate in the original uncropped photo
"y": mwgRegion.rect[1] * actualHeight, // y pixel coordinate in the original uncropped photo
"w": mwgRegion.rect[2] * appliedToWidth, // mwgRectangle number of pixels wide
"h": mwgRegion.rect[3] * appliedToHeight, // mwgRectangle number of pixels high
"entry": entry, // File pointer for opening in photoshop
"dateTaken": javascriptDate,
};
if (!(person.name == undefined || person.x == undefined | person.y == undefined | person.w == undefined | person.h == undefined | person.dateTaken == undefined))
persons.push(person);
})
}
} catch (e) {
if (entry != null)
console.log("metadata error " + e.toString() + " FILE: " + entry.nativePath);
else
console.log("metadata error " + e.toString());
}
if (xmpFile != null)
xmpFile.closeFile(0);
persons.forEach((person) => {
regionNames.add(person.name);
});
return [persons, subjects, html, cmd, regionNames];
};
/**
* picks up the metadata of the currently loaded photo in Photoshop
* @returns text buffer containing the metadata
*/
const getDocumentXMP = () => {
return batchPlay(
[
{
_obj: "get",
_target: {
_ref: [
{ _property: "XMPMetadataAsUTF8" },
{ _ref: "document", _enum: "ordinal", _value: "targetEnum" },
],
},
},],
{ synchronousExecution: true }
)[0].XMPMetadataAsUTF8;
};
module.exports = {
readPersonsFromMetadata
};