-
Notifications
You must be signed in to change notification settings - Fork 43
/
TilesetUpgrader.ts
425 lines (392 loc) · 13.9 KB
/
TilesetUpgrader.ts
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
import { Buffers } from "../base/Buffers";
import { DeveloperError } from "../base/DeveloperError";
import { BufferedContentData } from "../contentTypes/BufferedContentData";
import { ContentDataTypeRegistry } from "../contentTypes/ContentDataTypeRegistry";
import { ContentDataTypes } from "../contentTypes/ContentDataTypes";
import { Tile } from "../structure/Tile";
import { Tileset } from "../structure/Tileset";
import { Content } from "../structure/Content";
import { TilesetError } from "../tilesetData/TilesetError";
import { TilesetSource } from "../tilesetData/TilesetSource";
import { TilesetTarget } from "../tilesetData/TilesetTarget";
import { TilesetTargets } from "../tilesetData/TilesetTargets";
import { TilesetSources } from "../tilesetData/TilesetSources";
import { Tiles } from "../tilesets/Tiles";
import { Tilesets } from "../tilesets/Tilesets";
import { Extensions } from "../tilesets/Extensions";
import { TileFormats } from "../tileFormats/TileFormats";
import { GltfUtilities } from "../contentProcessing/GtlfUtilities";
/**
* The options for the upgrade. This is only used internally,
* as a collection of flags to enable/disable certain parts
* of the update.
*
* The exact set of options (and how they may eventually
* be exposed to the user) still have to be decided.
*/
type UpgradeOptions = {
upgradeAssetVersionNumber: boolean;
upgradeRefineCase: boolean;
upgradeContentUrlToUri: boolean;
upgradeB3dmGltf1ToGltf2: boolean;
upgradeI3dmGltf1ToGltf2: boolean;
upgradeExternalTilesets: boolean;
upgradeExtensionDeclarations: boolean;
};
/**
* A class for "upgrading" a tileset from a previous version to
* a more recent version. The details of what that means exactly
* are not (yet) specified.
*/
export class TilesetUpgrader {
/**
* A function that will receive log messages during the upgrade process
*/
private readonly logCallback: (message: any) => void;
/**
* The tileset source for the input
*/
private tilesetSource: TilesetSource | undefined;
/**
* The tileset target for the output.
*/
private tilesetTarget: TilesetTarget | undefined;
/**
* The options for the upgrade.
*/
private readonly upgradeOptions: UpgradeOptions;
/**
* Creates a new instance
*
* @param quiet - Whether log messages should be omitted
*/
constructor(quiet?: boolean) {
if (quiet !== true) {
this.logCallback = (message: any) => console.log(message);
} else {
// eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-empty-function
this.logCallback = (message: any) => {};
}
// By default, ALL options are enabled
this.upgradeOptions = {
upgradeAssetVersionNumber: true,
upgradeRefineCase: true,
upgradeContentUrlToUri: true,
upgradeB3dmGltf1ToGltf2: true,
upgradeI3dmGltf1ToGltf2: true,
upgradeExternalTilesets: true,
upgradeExtensionDeclarations: true,
};
}
/**
* Upgrade the specified source tileset, and write it to the given
* target.
*
* @param tilesetSourceName - The tileset source name
* @param tilesetTargetName - The tileset target name
* @param overwrite Whether the target should be overwritten if
* it already exists
* @returns A promise that resolves when the process is finished
* @throws TilesetError When the input could not be processed,
* or when the output already exists and `overwrite` was `false`.
*/
async upgrade(
tilesetSourceName: string,
tilesetTargetName: string,
overwrite: boolean
): Promise<void> {
const tilesetSource = TilesetSources.createAndOpen(tilesetSourceName);
const tilesetTarget = TilesetTargets.createAndBegin(
tilesetTargetName,
overwrite
);
this.tilesetSource = tilesetSource;
this.tilesetTarget = tilesetTarget;
const tilesetSourceJsonFileName =
Tilesets.determineTilesetJsonFileName(tilesetSourceName);
const tilesetTargetJsonFileName =
Tilesets.determineTilesetJsonFileName(tilesetTargetName);
const upgradedTilesetJsonBuffer = await this.upgradeInternal(
tilesetSourceJsonFileName
);
this.tilesetTarget.addEntry(
tilesetTargetJsonFileName,
upgradedTilesetJsonBuffer
);
await this.upgradeResources(tilesetSourceJsonFileName);
tilesetSource.close();
await tilesetTarget.end();
this.tilesetSource = undefined;
this.tilesetTarget = undefined;
}
/**
* Internal method for the actual upgrade.
*
* It just obtains the tileset JSON data from the source, passes
* it to `upgradeTileset`, and returns the buffer containing the
* JSON data of the upgraded result.
*
* @param tilesetSourceJsonFileName - The name of the tileset JSON in the source
* @returns A promise that resolves when the process is finished
* @throws TilesetError When the input could not be processed
*/
private async upgradeInternal(
tilesetSourceJsonFileName: string
): Promise<Buffer> {
if (!this.tilesetSource || !this.tilesetTarget) {
throw new DeveloperError("The source and target must be defined");
}
// Obtain the tileset JSON buffer (unzip it if necessary)
// and parse the Tileset out of it
let tilesetJsonBuffer = this.tilesetSource.getValue(
tilesetSourceJsonFileName
);
if (!tilesetJsonBuffer) {
const message = `No ${tilesetSourceJsonFileName} found in input`;
throw new TilesetError(message);
}
let tilesetJsonBufferWasZipped = false;
if (Buffers.isGzipped(tilesetJsonBuffer)) {
tilesetJsonBufferWasZipped = true;
tilesetJsonBuffer = Buffers.gunzip(tilesetJsonBuffer);
}
const tileset = JSON.parse(tilesetJsonBuffer.toString()) as Tileset;
// Perform the actual upgrade
await this.upgradeTileset(tileset);
// Put the upgraded tileset JSON buffer into the target
// (zipping it, if the input was zipped)
const resultTilesetJsonString = JSON.stringify(tileset, null, 2);
let resultTilesetJsonBuffer = Buffer.from(resultTilesetJsonString);
if (tilesetJsonBufferWasZipped) {
resultTilesetJsonBuffer = Buffers.gzip(resultTilesetJsonBuffer);
}
return resultTilesetJsonBuffer;
}
/**
* Upgrades the given tileset, in place.
*
* @param tileset - The parsed tileset
*/
async upgradeTileset(tileset: Tileset): Promise<void> {
if (this.upgradeOptions.upgradeAssetVersionNumber) {
this.logCallback(`Upgrading asset version number`);
this.upgradeAssetVersionNumber(tileset);
}
if (this.upgradeOptions.upgradeRefineCase) {
this.logCallback(`Upgrading refine to be in uppercase`);
await this.upgradeRefineValues(tileset);
}
if (this.upgradeOptions.upgradeContentUrlToUri) {
this.logCallback(`Upgrading content.url to content.uri`);
await this.upgradeEachContentUrlToUri(tileset);
}
if (this.upgradeOptions.upgradeExtensionDeclarations) {
this.logCallback(`Upgrading extension declarations`);
Extensions.removeExtensionUsed(tileset, "3DTILES_content_gltf");
}
}
/**
* Upgrade the `asset.version` number in the given tileset
* to be "1.1".
*
* @param tileset - The tileset
*/
private upgradeAssetVersionNumber(tileset: Tileset) {
if (tileset.asset.version !== "1.1") {
this.logCallback(
` Upgrading asset version from ${tileset.asset.version} to 1.1`
);
tileset.asset.version = "1.1";
}
}
/**
* Upgrade the `url` property of each tile content to `uri`.
*
* This will examine each `tile.content` in the explicit representation
* of the tile hierarchy in the given tileset. If any content does not
* define a `uri`, but a (legacy) `url` property, then the `url` is
* renamed to `uri`.
*
* @param tileset - The tileset
*/
private async upgradeEachContentUrlToUri(tileset: Tileset) {
const root = tileset.root;
await Tiles.traverseExplicit(root, async (tilePath: Tile[]) => {
const tile = tilePath[tilePath.length - 1];
if (tile.content) {
this.upgradeContentUrlToUri(tile.content);
}
if (tile.contents) {
for (const content of tile.contents) {
this.upgradeContentUrlToUri(content);
}
}
return true;
});
}
/**
* If the given `Content` does not have a `uri` but uses the
* legacy `url` property, then a message is logged, and the
* `url` property is renamed to `uri`.
*
* @param content - The `Content`
*/
private upgradeContentUrlToUri(content: Content): void {
if (content.uri) {
return;
}
const legacyContent = content as any;
if (legacyContent.url) {
this.logCallback(
` Renaming 'url' property for content ${legacyContent.url} to 'uri'`
);
content.uri = legacyContent.url;
delete legacyContent.url;
return;
}
// This should never be the case:
this.logCallback(
" The content does not have a 'uri' property (and no legacy 'url' property)"
);
}
/**
* Upgrade the `refine` property of each tile to be written in
* uppercase letters.
*
* @param tileset - The tileset
*/
private async upgradeRefineValues(tileset: Tileset) {
const root = tileset.root;
await Tiles.traverseExplicit(root, async (tilePath: Tile[]) => {
const tile = tilePath[tilePath.length - 1];
if (tile.refine && tile.refine !== "ADD" && tile.refine !== "REPLACE") {
const oldValue = tile.refine;
const newValue = oldValue.toUpperCase();
this.logCallback(
` Renaming 'refine' value from ${oldValue} to ${newValue}`
);
tile.refine = newValue;
}
return true;
});
}
/**
* Upgrade all resources from the tileset source (except for the
* file with the given name) and put them into the tileset target.
*
* @param tilesetSourceJsonFileName - The name of the tileset JSON file
* in the source
* @returns A promise that resolves when the process is finished.
*/
private async upgradeResources(
tilesetSourceJsonFileName: string
): Promise<void> {
if (!this.tilesetSource || !this.tilesetTarget) {
throw new DeveloperError("The source and target must be defined");
}
const entries = TilesetSources.getEntries(this.tilesetSource);
for (const entry of entries) {
const key = entry.key;
if (key === tilesetSourceJsonFileName) {
continue;
}
const sourceValue = entry.value;
const contentData = new BufferedContentData(key, sourceValue);
const type = await ContentDataTypeRegistry.findContentDataType(
contentData
);
const targetValue = await this.processValue(key, sourceValue, type);
this.tilesetTarget.addEntry(key, targetValue);
}
}
/**
* Process the value of an entry (i.e. the data of one file), and return
* a possibly "upgraded" version of that value.
*
* @param key - The key (file name)
* @param value - The value (file contents buffer)
* @param type - The type of the content. See `ContentDataTypes`.
* @returns A promise that resolves when the value is processed.
*/
private async processValue(
key: string,
value: Buffer,
type: string | undefined
): Promise<Buffer> {
if (type === ContentDataTypes.CONTENT_TYPE_B3DM) {
if (this.upgradeOptions.upgradeB3dmGltf1ToGltf2) {
this.logCallback(` Upgrading GLB in ${key}`);
value = await TilesetUpgrader.upgradeB3dmGltf1ToGltf2(value);
} else {
this.logCallback(` Not upgrading GLB in ${key} (disabled via option)`);
}
} else if (type === ContentDataTypes.CONTENT_TYPE_I3DM) {
if (this.upgradeOptions.upgradeI3dmGltf1ToGltf2) {
this.logCallback(` Upgrading GLB in ${key}`);
value = await TilesetUpgrader.upgradeI3dmGltf1ToGltf2(value);
} else {
this.logCallback(` Not upgrading GLB in ${key} (disabled via option)`);
}
} else if (type == ContentDataTypes.CONTENT_TYPE_TILESET) {
if (this.upgradeOptions.upgradeExternalTilesets) {
this.logCallback(` Upgrading external tileset in ${key}`);
value = await this.upgradeInternal(key);
} else {
this.logCallback(
` Not upgrading external tileset in ${key} (disabled via option)`
);
}
} else {
this.logCallback(` No upgrade operation to perform for ${key}`);
}
return value;
}
/**
* For the given B3DM data buffer, extract the GLB, upgrade it
* with `GltfUtilities.upgradeGlb`, create a new B3DM from the
* result, and return it.
*
* @param inputBuffer - The input buffer
* @returns The upgraded buffer
*/
private static async upgradeB3dmGltf1ToGltf2(
inputBuffer: Buffer
): Promise<Buffer> {
const inputTileData = TileFormats.readTileData(inputBuffer);
const inputGlb = inputTileData.payload;
const outputGlb = await GltfUtilities.upgradeGlb(inputGlb);
const outputTileData = TileFormats.createB3dmTileDataFromGlb(
outputGlb,
inputTileData.featureTable.json,
inputTileData.featureTable.binary,
inputTileData.batchTable.json,
inputTileData.batchTable.binary
);
const outputBuffer = TileFormats.createTileDataBuffer(outputTileData);
return outputBuffer;
}
/**
* For the given I3DM data buffer, extract the GLB, upgrade it
* with `GltfUtilities.upgradeGlb`, create a new B3DM from the
* result, and return it.
*
* @param inputBuffer - The input buffer
* @returns The upgraded buffer
*/
private static async upgradeI3dmGltf1ToGltf2(
inputBuffer: Buffer
): Promise<Buffer> {
const inputTileData = TileFormats.readTileData(inputBuffer);
const inputGlb = inputTileData.payload;
const outputGlb = await GltfUtilities.upgradeGlb(inputGlb);
const outputTileData = TileFormats.createI3dmTileDataFromGlb(
outputGlb,
inputTileData.featureTable.json,
inputTileData.featureTable.binary,
inputTileData.batchTable.json,
inputTileData.batchTable.binary
);
const outputBuffer = TileFormats.createTileDataBuffer(outputTileData);
return outputBuffer;
}
}