-
-
Notifications
You must be signed in to change notification settings - Fork 149
/
quantize.ts
579 lines (501 loc) · 19.3 KB
/
quantize.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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
import {
Accessor,
AnimationChannel,
bbox,
Document,
ILogger,
mat4,
MathUtils,
Mesh,
Node,
Primitive,
PrimitiveTarget,
PropertyType,
Skin,
Transform,
vec2,
vec3,
vec4,
} from '@gltf-transform/core';
import { dedup } from './dedup.js';
import { fromRotationTranslationScale, fromScaling, invert, multiply as multiplyMat4 } from 'gl-matrix/mat4';
import { max, min, scale, transformMat4 } from 'gl-matrix/vec3';
import { InstancedMesh, KHRMeshQuantization } from '@gltf-transform/extensions';
import type { Volume } from '@gltf-transform/extensions';
import { prune } from './prune.js';
import { assignDefaults, createTransform } from './utils.js';
import { sortPrimitiveWeights } from './sort-primitive-weights.js';
import { getPrimitiveVertexCount, VertexCountMethod } from './get-vertex-count.js';
import { compactPrimitive } from './compact-primitive.js';
const NAME = 'quantize';
type TypedArrayConstructor =
| Int8ArrayConstructor
| Int16ArrayConstructor
| Uint8ArrayConstructor
| Uint16ArrayConstructor;
const SIGNED_INT = [Int8Array, Int16Array, Int32Array] as TypedArrayConstructor[];
const { TRANSLATION, ROTATION, SCALE, WEIGHTS } = AnimationChannel.TargetPath;
const TRS_CHANNELS = [TRANSLATION, ROTATION, SCALE];
/** Options for the {@link quantize} function. */
export interface QuantizeOptions {
/** Pattern (regex) used to filter vertex attribute semantics for quantization. Default: all. */
pattern?: RegExp;
/** Pattern (regex) used to filter morph target semantics for quantization. Default: `options.pattern`. */
patternTargets?: RegExp;
/** Bounds for quantization grid. */
quantizationVolume?: 'mesh' | 'scene';
/** Quantization bits for `POSITION` attributes. */
quantizePosition?: number;
/** Quantization bits for `NORMAL` attributes. */
quantizeNormal?: number;
/** Quantization bits for `TEXCOORD_*` attributes. */
quantizeTexcoord?: number;
/** Quantization bits for `COLOR_*` attributes. */
quantizeColor?: number;
/** Quantization bits for `WEIGHT_*` attributes. */
quantizeWeight?: number;
/** Quantization bits for application-specific (`_*`) attributes. */
quantizeGeneric?: number;
/** Normalize weight attributes. */
normalizeWeights?: boolean;
/**
* Whether to perform cleanup steps after completing the operation. Recommended, and enabled by
* default. Cleanup removes temporary resources created during the operation, but may also remove
* pre-existing unused or duplicate resources in the {@link Document}. Applications that require
* keeping these resources may need to disable cleanup, instead calling {@link dedup} and
* {@link prune} manually (with customized options) later in the processing pipeline.
* @experimental
*/
cleanup?: boolean;
}
export const QUANTIZE_DEFAULTS: Required<Omit<QuantizeOptions, 'patternTargets'>> = {
pattern: /.*/,
quantizationVolume: 'mesh',
quantizePosition: 14,
quantizeNormal: 10,
quantizeTexcoord: 12,
quantizeColor: 8,
quantizeWeight: 8,
quantizeGeneric: 12,
normalizeWeights: true,
cleanup: true,
};
/**
* References:
* - https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_mesh_quantization
* - http://www.aclockworkberry.com/normal-unpacking-quantization-errors/
* - https://www.mathworks.com/help/dsp/ref/uniformencoder.html
* - https://oroboro.com/compressed-unit-vectors/
*/
/**
* Quantizes vertex attributes with `KHR_mesh_quantization`, reducing the size and memory footprint
* of the file.
*
* @category Transforms
*/
export function quantize(_options: QuantizeOptions = QUANTIZE_DEFAULTS): Transform {
const options = assignDefaults(QUANTIZE_DEFAULTS, {
patternTargets: _options.pattern || QUANTIZE_DEFAULTS.pattern,
..._options,
});
return createTransform(NAME, async (document: Document): Promise<void> => {
const logger = document.getLogger();
const root = document.getRoot();
// Compute vertex position quantization volume.
let nodeTransform: VectorTransform<vec3> | undefined = undefined;
if (options.quantizationVolume === 'scene') {
nodeTransform = getNodeTransform(expandBounds(root.listMeshes().map(getPositionQuantizationVolume)));
}
// Quantize mesh primitives.
for (const mesh of document.getRoot().listMeshes()) {
if (options.quantizationVolume === 'mesh') {
nodeTransform = getNodeTransform(getPositionQuantizationVolume(mesh));
}
if (nodeTransform && options.pattern.test('POSITION')) {
transformMeshParents(document, mesh, nodeTransform);
transformMeshMaterials(mesh, 1 / nodeTransform.scale);
}
for (const prim of mesh.listPrimitives()) {
const renderCount = getPrimitiveVertexCount(prim, VertexCountMethod.RENDER);
const uploadCount = getPrimitiveVertexCount(prim, VertexCountMethod.UPLOAD);
if (renderCount < uploadCount / 2) {
compactPrimitive(prim);
}
quantizePrimitive(document, prim, nodeTransform!, options);
for (const target of prim.listTargets()) {
quantizePrimitive(document, target, nodeTransform!, options);
}
}
}
const needsExtension = root
.listMeshes()
.flatMap((mesh) => mesh.listPrimitives())
.some(isQuantizedPrimitive);
if (needsExtension) {
document.createExtension(KHRMeshQuantization).setRequired(true);
}
if (options.cleanup) {
await document.transform(
prune({
propertyTypes: [PropertyType.ACCESSOR, PropertyType.SKIN, PropertyType.MATERIAL],
keepAttributes: true,
keepIndices: true,
keepLeaves: true,
keepSolidTextures: true,
}),
dedup({
propertyTypes: [PropertyType.ACCESSOR, PropertyType.MATERIAL, PropertyType.SKIN],
keepUniqueNames: true,
}),
);
}
logger.debug(`${NAME}: Complete.`);
});
}
function quantizePrimitive(
doc: Document,
prim: Primitive | PrimitiveTarget,
nodeTransform: VectorTransform<vec3>,
options: Required<QuantizeOptions>,
): void {
const isTarget = prim instanceof PrimitiveTarget;
const logger = doc.getLogger();
for (const semantic of prim.listSemantics()) {
if (!isTarget && !options.pattern.test(semantic)) continue;
if (isTarget && !options.patternTargets.test(semantic)) continue;
const srcAttribute = prim.getAttribute(semantic)!;
const { bits, ctor } = getQuantizationSettings(semantic, srcAttribute, logger, options);
if (!ctor) continue;
if (bits < 8 || bits > 16) throw new Error(`${NAME}: Requires bits = 8–16.`);
if (srcAttribute.getComponentSize() <= bits / 8) continue;
const dstAttribute = srcAttribute.clone();
// Remap position data.
if (semantic === 'POSITION') {
const scale = nodeTransform.scale;
const transform: mat4 = [] as unknown as mat4;
// Morph targets are relative offsets, don't translate them.
prim instanceof Primitive
? invert(transform, fromTransform(nodeTransform))
: fromScaling(transform, [1 / scale, 1 / scale, 1 / scale]);
for (let i = 0, el: vec3 = [0, 0, 0], il = dstAttribute.getCount(); i < il; i++) {
dstAttribute.getElement(i, el);
dstAttribute.setElement(i, transformMat4(el, el, transform) as vec3);
}
}
// Quantize the vertex attribute.
quantizeAttribute(dstAttribute, ctor, bits);
prim.setAttribute(semantic, dstAttribute);
}
// Normalize skinning weights.
if (options.normalizeWeights && prim.getAttribute('WEIGHTS_0')) {
sortPrimitiveWeights(prim, Infinity);
}
if (
prim instanceof Primitive &&
prim.getIndices() &&
prim.listAttributes().length &&
prim.listAttributes()[0]!.getCount() < 65535
) {
const indices = prim.getIndices()!;
indices.setArray(new Uint16Array(indices.getArray()!));
}
}
/** Computes node quantization transforms in local space. */
function getNodeTransform(volume: bbox): VectorTransform<vec3> {
const { min, max } = volume;
// Scaling factor transforms [-1,1] box to the mesh AABB in local space.
// See: https://github.com/donmccurdy/glTF-Transform/issues/328
const scale = Math.max(
(max[0] - min[0]) / 2, // Divide because interval [-1,1] has length 2.
(max[1] - min[1]) / 2,
(max[2] - min[2]) / 2,
);
// Original center of the mesh, in local space.
const offset: vec3 = [
min[0] + (max[0] - min[0]) / 2,
min[1] + (max[1] - min[1]) / 2,
min[2] + (max[2] - min[2]) / 2,
];
return { offset, scale };
}
/** Applies corrective scale and offset to nodes referencing a quantized Mesh. */
function transformMeshParents(doc: Document, mesh: Mesh, nodeTransform: VectorTransform<vec3>): void {
const transformMatrix = fromTransform(nodeTransform);
for (const parent of mesh.listParents()) {
if (!(parent instanceof Node)) continue;
const animChannels = parent.listParents().filter((p) => p instanceof AnimationChannel) as AnimationChannel[];
const isAnimated = animChannels.some((channel) => TRS_CHANNELS.includes(channel.getTargetPath()!));
const isParentNode = parent.listChildren().length > 0;
const skin = parent.getSkin();
if (skin) {
parent.setSkin(transformSkin(skin, nodeTransform));
continue;
}
const batch = parent.getExtension<InstancedMesh>('EXT_mesh_gpu_instancing');
if (batch) {
parent.setExtension('EXT_mesh_gpu_instancing', transformBatch(batch, nodeTransform));
continue;
}
let targetNode: Node;
if (isParentNode || isAnimated) {
targetNode = doc.createNode('').setMesh(mesh);
parent.addChild(targetNode).setMesh(null);
animChannels
.filter((channel) => channel.getTargetPath() === WEIGHTS)
.forEach((channel) => channel.setTargetNode(targetNode));
} else {
targetNode = parent;
}
const nodeMatrix = targetNode.getMatrix();
multiplyMat4(nodeMatrix, nodeMatrix, transformMatrix);
targetNode.setMatrix(nodeMatrix);
}
}
/** Applies corrective scale and offset to skin IBMs. */
function transformSkin(skin: Skin, nodeTransform: VectorTransform<vec3>): Skin {
skin = skin.clone(); // quantize() does cleanup.
const transformMatrix = fromTransform(nodeTransform);
const inverseBindMatrices = skin.getInverseBindMatrices()!.clone();
const ibm = [] as unknown as mat4;
for (let i = 0, count = inverseBindMatrices.getCount(); i < count; i++) {
inverseBindMatrices.getElement(i, ibm);
multiplyMat4(ibm, ibm, transformMatrix);
inverseBindMatrices.setElement(i, ibm);
}
return skin.setInverseBindMatrices(inverseBindMatrices);
}
/** Applies corrective scale and offset to GPU instancing batches. */
function transformBatch(batch: InstancedMesh, nodeTransform: VectorTransform<vec3>): InstancedMesh {
if (!batch.getAttribute('TRANSLATION') && !batch.getAttribute('ROTATION') && !batch.getAttribute('SCALE')) {
return batch;
}
batch = batch.clone(); // quantize() does cleanup.
const instanceTranslation = batch.getAttribute('TRANSLATION')?.clone();
const instanceRotation = batch.getAttribute('ROTATION')?.clone();
const instanceScale = batch.getAttribute('SCALE')?.clone();
const tpl = (instanceTranslation || instanceRotation || instanceScale)!;
const T_IDENTITY = [0, 0, 0] as vec3;
const R_IDENTITY = [0, 0, 0, 1] as vec4;
const S_IDENTITY = [1, 1, 1] as vec3;
const t = [0, 0, 0] as vec3;
const r = [0, 0, 0, 1] as vec4;
const s = [1, 1, 1] as vec3;
// prettier-ignore
const instanceMatrix = [
1, 0, 0, 0,
0, 1, 0, 0,
0, 0, 1, 0,
0, 0, 0, 1,
] as mat4;
const transformMatrix = fromTransform(nodeTransform);
for (let i = 0, count = tpl.getCount(); i < count; i++) {
MathUtils.compose(
instanceTranslation ? (instanceTranslation.getElement(i, t) as vec3) : T_IDENTITY,
instanceRotation ? (instanceRotation.getElement(i, r) as vec4) : R_IDENTITY,
instanceScale ? (instanceScale.getElement(i, s) as vec3) : S_IDENTITY,
instanceMatrix,
);
multiplyMat4(instanceMatrix, instanceMatrix, transformMatrix);
MathUtils.decompose(instanceMatrix, t, r, s);
if (instanceTranslation) instanceTranslation.setElement(i, t);
if (instanceRotation) instanceRotation.setElement(i, r);
if (instanceScale) instanceScale.setElement(i, s);
}
if (instanceTranslation) batch.setAttribute('TRANSLATION', instanceTranslation);
if (instanceRotation) batch.setAttribute('ROTATION', instanceRotation);
if (instanceScale) batch.setAttribute('SCALE', instanceScale);
return batch;
}
/** Applies corrective scale to volumetric materials, which give thickness in local units. */
function transformMeshMaterials(mesh: Mesh, scale: number) {
for (const prim of mesh.listPrimitives()) {
let material = prim.getMaterial();
if (!material) continue;
let volume = material.getExtension<Volume>('KHR_materials_volume');
if (!volume || volume.getThicknessFactor() <= 0) continue;
// quantize() does cleanup.
volume = volume.clone().setThicknessFactor(volume.getThicknessFactor() * scale);
material = material.clone().setExtension('KHR_materials_volume', volume);
prim.setMaterial(material);
}
}
/**
* Quantizes an attribute to the given parameters.
*
* Uniformly remap 32-bit floats to reduced-precision 8- or 16-bit integers, so
* that there are only 2^N unique values, for N within [8, 16].
*
* See: https://github.com/donmccurdy/glTF-Transform/issues/208
*/
function quantizeAttribute(attribute: Accessor, ctor: TypedArrayConstructor, bits: number): void {
const dstArray = new ctor(attribute.getArray()!.length);
const signBits = SIGNED_INT.includes(ctor) ? 1 : 0;
const quantBits = bits - signBits;
const storageBits = ctor.BYTES_PER_ELEMENT * 8 - signBits;
const scale = Math.pow(2, quantBits) - 1;
const lo = storageBits - quantBits;
const hi = 2 * quantBits - storageBits;
const range = [signBits > 0 ? -1 : 0, 1] as vec2;
for (let i = 0, di = 0, el: number[] = []; i < attribute.getCount(); i++) {
attribute.getElement(i, el);
for (let j = 0; j < el.length; j++) {
// Clamp to range.
let value = clamp(el[j], range);
// Map [0.0 ... 1.0] to [0 ... scale].
value = Math.round(Math.abs(value) * scale);
// Replicate msb to missing lsb.
value = (value << lo) | (value >> hi);
// Restore sign.
dstArray[di++] = value * Math.sign(el[j]);
}
}
// TODO(feat): Support sparse accessors, https://github.com/donmccurdy/glTF-Transform/issues/795
attribute.setArray(dstArray).setNormalized(true).setSparse(false);
}
function getQuantizationSettings(
semantic: string,
attribute: Accessor,
logger: ILogger,
options: Required<QuantizeOptions>,
): { bits: number; ctor?: TypedArrayConstructor } {
const min = attribute.getMinNormalized([]);
const max = attribute.getMaxNormalized([]);
let bits: number;
let ctor: TypedArrayConstructor;
if (semantic === 'POSITION') {
bits = options.quantizePosition;
ctor = bits <= 8 ? Int8Array : Int16Array;
} else if (semantic === 'NORMAL' || semantic === 'TANGENT') {
bits = options.quantizeNormal;
ctor = bits <= 8 ? Int8Array : Int16Array;
} else if (semantic.startsWith('COLOR_')) {
bits = options.quantizeColor;
ctor = bits <= 8 ? Uint8Array : Uint16Array;
} else if (semantic.startsWith('TEXCOORD_')) {
if (min.some((v) => v < 0) || max.some((v) => v > 1)) {
logger.warn(`${NAME}: Skipping ${semantic}; out of [0,1] range.`);
return { bits: -1 };
}
bits = options.quantizeTexcoord;
ctor = bits <= 8 ? Uint8Array : Uint16Array;
} else if (semantic.startsWith('JOINTS_')) {
bits = Math.max(...attribute.getMax([])) <= 255 ? 8 : 16;
ctor = bits <= 8 ? Uint8Array : Uint16Array;
if (attribute.getComponentSize() > bits / 8) {
attribute.setArray(new ctor(attribute.getArray()!));
}
return { bits: -1 };
} else if (semantic.startsWith('WEIGHTS_')) {
if (min.some((v) => v < 0) || max.some((v) => v > 1)) {
logger.warn(`${NAME}: Skipping ${semantic}; out of [0,1] range.`);
return { bits: -1 };
}
bits = options.quantizeWeight;
ctor = bits <= 8 ? Uint8Array : Uint16Array;
} else if (semantic.startsWith('_')) {
if (min.some((v) => v < -1) || max.some((v) => v > 1)) {
logger.warn(`${NAME}: Skipping ${semantic}; out of [-1,1] range.`);
return { bits: -1 };
}
bits = options.quantizeGeneric;
ctor = min.some((v) => v < 0)
? (ctor = bits <= 8 ? Int8Array : Int16Array)
: (ctor = bits <= 8 ? Uint8Array : Uint16Array);
} else {
throw new Error(`${NAME}: Unexpected semantic, "${semantic}".`);
}
return { bits, ctor };
}
function getPositionQuantizationVolume(mesh: Mesh): bbox {
const positions: Accessor[] = [];
const relativePositions: Accessor[] = [];
for (const prim of mesh.listPrimitives()) {
const attribute = prim.getAttribute('POSITION');
if (attribute) positions.push(attribute);
for (const target of prim.listTargets()) {
const attribute = target.getAttribute('POSITION');
if (attribute) relativePositions.push(attribute);
}
}
if (positions.length === 0) {
throw new Error(`${NAME}: Missing "POSITION" attribute.`);
}
const bbox = flatBounds<vec3>(positions, 3);
// Morph target quantization volume is computed differently. First, ensure that the origin
// <0, 0, 0> is in the quantization volume. Because we can't offset target positions (they're
// relative deltas), default remapping will only map to a [-2, 2] AABB. Double the bounding box
// to ensure scaling puts them within a [-1, 1] AABB instead.
if (relativePositions.length > 0) {
const { min: relMin, max: relMax } = flatBounds<vec3>(relativePositions, 3);
min(bbox.min, bbox.min, min(relMin, scale(relMin, relMin, 2), [0, 0, 0]));
max(bbox.max, bbox.max, max(relMax, scale(relMax, relMax, 2), [0, 0, 0]));
}
return bbox;
}
function isQuantizedAttribute(semantic: string, attribute: Accessor): boolean {
// https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html#meshes-overview
const componentSize = attribute.getComponentSize();
if (semantic === 'POSITION') return componentSize < 4;
if (semantic === 'NORMAL') return componentSize < 4;
if (semantic === 'TANGENT') return componentSize < 4;
if (semantic.startsWith('TEXCOORD_')) {
const componentType = attribute.getComponentType();
const normalized = attribute.getNormalized();
return (
componentSize < 4 &&
!(normalized && componentType === Accessor.ComponentType.UNSIGNED_BYTE) &&
!(normalized && componentType === Accessor.ComponentType.UNSIGNED_SHORT)
);
}
return false;
}
function isQuantizedPrimitive(prim: Primitive | PrimitiveTarget): boolean {
for (const semantic of prim.listSemantics()) {
const attribute = prim.getAttribute('POSITION')!;
if (isQuantizedAttribute(semantic, attribute)) {
return true;
}
}
if (prim.propertyType === PropertyType.PRIMITIVE) {
return prim.listTargets().some(isQuantizedPrimitive);
}
return false;
}
/** Computes total min and max of all Accessors in a list. */
function flatBounds<T = vec2 | vec3>(accessors: Accessor[], elementSize: number): { min: T; max: T } {
const min: number[] = new Array(elementSize).fill(Infinity);
const max: number[] = new Array(elementSize).fill(-Infinity);
const tmpMin: number[] = [];
const tmpMax: number[] = [];
for (const accessor of accessors) {
accessor.getMinNormalized(tmpMin);
accessor.getMaxNormalized(tmpMax);
for (let i = 0; i < elementSize; i++) {
min[i] = Math.min(min[i], tmpMin[i]);
max[i] = Math.max(max[i], tmpMax[i]);
}
}
return { min, max } as unknown as { min: T; max: T };
}
function expandBounds(bboxes: bbox[]): bbox {
const result = bboxes[0];
for (const bbox of bboxes) {
min(result.min, result.min, bbox.min);
max(result.max, result.max, bbox.max);
}
return result;
}
interface VectorTransform<T = vec2 | vec3 | vec4> {
offset: T;
scale: number;
}
function fromTransform(transform: VectorTransform<vec3>): mat4 {
return fromRotationTranslationScale([] as unknown as mat4, [0, 0, 0, 1], transform.offset, [
transform.scale,
transform.scale,
transform.scale,
]) as mat4;
}
function clamp(value: number, range: vec2): number {
return Math.min(Math.max(value, range[0]), range[1]);
}