@loaders.gl/splats 5.0.0-beta.10 → 5.0.0-beta.11

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 (47) hide show
  1. package/dist/dist.dev.js +32 -49
  2. package/dist/dist.min.js +4 -4
  3. package/dist/index.cjs +33 -46
  4. package/dist/index.cjs.map +1 -1
  5. package/dist/ksplat-loader-types.d.ts +2 -2
  6. package/dist/ksplat-loader-types.js +1 -1
  7. package/dist/ksplat-loader.d.ts +2 -2
  8. package/dist/ksplat-loader.js +2 -2
  9. package/dist/ksplat-loader.js.map +1 -1
  10. package/dist/lib/parse-ksplat.d.ts +2 -2
  11. package/dist/lib/parse-ksplat.d.ts.map +1 -1
  12. package/dist/lib/parse-rad-chunk.d.ts +2 -2
  13. package/dist/lib/parse-rad-chunk.d.ts.map +1 -1
  14. package/dist/lib/parse-splat.d.ts +2 -2
  15. package/dist/lib/parse-splat.d.ts.map +1 -1
  16. package/dist/lib/parse-spz.d.ts +2 -2
  17. package/dist/lib/parse-spz.d.ts.map +1 -1
  18. package/dist/lib/parse-spz.js.map +1 -1
  19. package/dist/lib/splats-arrow-table.d.ts +2 -2
  20. package/dist/lib/splats-arrow-table.d.ts.map +1 -1
  21. package/dist/lib/splats-arrow-table.js +25 -38
  22. package/dist/lib/splats-arrow-table.js.map +1 -1
  23. package/dist/rad-loader-types.js +1 -1
  24. package/dist/rad-source-loader.d.ts +3 -3
  25. package/dist/rad-source-loader.d.ts.map +1 -1
  26. package/dist/rad-source-loader.js +1 -1
  27. package/dist/rad-source-loader.js.map +1 -1
  28. package/dist/splat-loader-types.d.ts +2 -2
  29. package/dist/splat-loader-types.js +1 -1
  30. package/dist/splat-loader.d.ts +2 -2
  31. package/dist/splat-loader.js +2 -2
  32. package/dist/splat-loader.js.map +1 -1
  33. package/dist/spz-loader-types.d.ts +1 -1
  34. package/dist/spz-loader-types.js +1 -1
  35. package/dist/spz-loader.d.ts +1 -1
  36. package/dist/spz-loader.js +1 -1
  37. package/dist/spz-loader.js.map +1 -1
  38. package/package.json +3 -3
  39. package/src/ksplat-loader.ts +2 -2
  40. package/src/lib/parse-ksplat.ts +2 -2
  41. package/src/lib/parse-rad-chunk.ts +2 -2
  42. package/src/lib/parse-splat.ts +2 -2
  43. package/src/lib/parse-spz.ts +2 -5
  44. package/src/lib/splats-arrow-table.ts +24 -49
  45. package/src/rad-source-loader.ts +4 -7
  46. package/src/splat-loader.ts +2 -2
  47. package/src/spz-loader.ts +1 -1
@@ -3,7 +3,7 @@
3
3
  // Copyright (c) vis.gl contributors
4
4
 
5
5
  import {DeflateDecompressor} from '@loaders.gl/compression/deflate-decompressor';
6
- import type {MeshArrowTable} from '@loaders.gl/core/schema';
6
+ import type {Table} from 'apache-arrow';
7
7
  import type {GaussianSplats, SplatsLoaderOptions} from '../types';
8
8
  import {
9
9
  parseRADChunkHeader,
@@ -39,7 +39,7 @@ export type RADChunkDecodeOptions = SplatsLoaderOptions & {
39
39
  export function parseRADChunk(
40
40
  data: ArrayBuffer | ArrayBufferView,
41
41
  options?: RADChunkDecodeOptions
42
- ): MeshArrowTable {
42
+ ): Table {
43
43
  return makeGaussianSplatsArrowTable(parseRADChunkToGaussianSplats(data, options));
44
44
  }
45
45
 
@@ -2,7 +2,7 @@
2
2
  // SPDX-License-Identifier: MIT
3
3
  // Copyright (c) vis.gl contributors
4
4
 
5
- import type {MeshArrowTable} from '@loaders.gl/core/schema';
5
+ import type {Table} from 'apache-arrow';
6
6
  import type {GaussianSplats} from '../types';
7
7
  import {makeGaussianSplatsArrowTable} from './splats-arrow-table';
8
8
  import {
@@ -14,7 +14,7 @@ import {
14
14
  const SPLAT_ROW_BYTE_LENGTH = 32;
15
15
 
16
16
  /** Parses a raw `.splat` ArrayBuffer into a Mesh Arrow table. */
17
- export function parseSPLAT(data: ArrayBuffer): MeshArrowTable {
17
+ export function parseSPLAT(data: ArrayBuffer): Table {
18
18
  return makeGaussianSplatsArrowTable(parseSPLATToGaussianSplats(data));
19
19
  }
20
20
 
@@ -3,7 +3,7 @@
3
3
  // Copyright (c) vis.gl contributors
4
4
 
5
5
  import {GZipDecompressor, ZstdDecompressor} from '@loaders.gl/compression';
6
- import type {MeshArrowTable} from '@loaders.gl/core/schema';
6
+ import type {Table} from 'apache-arrow';
7
7
  import type {GaussianSplats, SPZCoordinateSystem, SplatsLoaderOptions} from '../types';
8
8
  import {makeGaussianSplatsArrowTable} from './splats-arrow-table';
9
9
  import {normalizeQuaternion} from './splat-utils';
@@ -34,10 +34,7 @@ type SPZStreamInfo = {
34
34
  };
35
35
 
36
36
  /** Parses a Niantic Spatial `.spz` ArrayBuffer into a Mesh Arrow table. */
37
- export async function parseSPZ(
38
- data: ArrayBuffer,
39
- options?: SplatsLoaderOptions
40
- ): Promise<MeshArrowTable> {
37
+ export async function parseSPZ(data: ArrayBuffer, options?: SplatsLoaderOptions): Promise<Table> {
41
38
  return makeGaussianSplatsArrowTable(await parseSPZToGaussianSplats(data, options));
42
39
  }
43
40
 
@@ -4,55 +4,42 @@
4
4
 
5
5
  import * as arrow from 'apache-arrow';
6
6
  import {encodeArrayBufferToBase64} from '@loaders.gl/core/loader-utils';
7
- import type {Field, MeshArrowTable, Schema} from '@loaders.gl/core/schema';
8
7
  import type {GaussianSplats} from '../types';
9
8
  import {convertColorByteToSphericalHarmonicDc} from './splat-utils';
10
9
 
11
10
  /** Builds a Mesh Arrow table from decoded Gaussian splat values. */
12
- export function makeGaussianSplatsArrowTable(splats: GaussianSplats): MeshArrowTable {
11
+ export function makeGaussianSplatsArrowTable(splats: GaussianSplats): arrow.Table {
13
12
  const columns: Record<string, arrow.Vector> = {};
14
13
  const fields: arrow.Field[] = [];
15
- const schemaFields: Field[] = [];
16
14
 
17
- addColumn(
18
- columns,
19
- fields,
20
- schemaFields,
21
- 'POSITION',
22
- makeFixedSizeListVector(splats.positions, 3),
23
- {
24
- type: 'fixed-size-list',
25
- listSize: 3,
26
- children: [{name: 'value', type: 'float32'}]
27
- }
28
- );
15
+ addColumn(columns, fields, 'POSITION', makeFixedSizeListVector(splats.positions, 3));
29
16
 
30
17
  const colorCoefficients = getColorCoefficients(splats);
31
- addScalarColumn(columns, fields, schemaFields, 'f_dc_0', colorCoefficients[0], {
18
+ addScalarColumn(columns, fields, 'f_dc_0', colorCoefficients[0], {
32
19
  'loaders_gl.gaussian_splats.semantic': 'spherical_harmonic_dc',
33
20
  'loaders_gl.gaussian_splats.component': '0',
34
21
  'loaders_gl.gaussian_splats.encoding': 'coefficient'
35
22
  });
36
- addScalarColumn(columns, fields, schemaFields, 'f_dc_1', colorCoefficients[1], {
23
+ addScalarColumn(columns, fields, 'f_dc_1', colorCoefficients[1], {
37
24
  'loaders_gl.gaussian_splats.semantic': 'spherical_harmonic_dc',
38
25
  'loaders_gl.gaussian_splats.component': '1',
39
26
  'loaders_gl.gaussian_splats.encoding': 'coefficient'
40
27
  });
41
- addScalarColumn(columns, fields, schemaFields, 'f_dc_2', colorCoefficients[2], {
28
+ addScalarColumn(columns, fields, 'f_dc_2', colorCoefficients[2], {
42
29
  'loaders_gl.gaussian_splats.semantic': 'spherical_harmonic_dc',
43
30
  'loaders_gl.gaussian_splats.component': '2',
44
31
  'loaders_gl.gaussian_splats.encoding': 'coefficient'
45
32
  });
46
33
 
47
- addScalarColumn(columns, fields, schemaFields, 'opacity', splats.opacities, {
34
+ addScalarColumn(columns, fields, 'opacity', splats.opacities, {
48
35
  'loaders_gl.gaussian_splats.semantic': 'opacity',
49
36
  'loaders_gl.gaussian_splats.encoding': 'linear'
50
37
  });
51
- addVectorComponents(columns, fields, schemaFields, 'scale', splats.scales, 3, {
38
+ addVectorComponents(columns, fields, 'scale', splats.scales, 3, {
52
39
  'loaders_gl.gaussian_splats.semantic': 'scale',
53
40
  'loaders_gl.gaussian_splats.encoding': 'linear'
54
41
  });
55
- addVectorComponents(columns, fields, schemaFields, 'rot', splats.rotations, 4, {
42
+ addVectorComponents(columns, fields, 'rot', splats.rotations, 4, {
56
43
  'loaders_gl.gaussian_splats.semantic': 'rotation',
57
44
  'loaders_gl.gaussian_splats.encoding': 'quaternion'
58
45
  });
@@ -61,7 +48,6 @@ export function makeGaussianSplatsArrowTable(splats: GaussianSplats): MeshArrowT
61
48
  addSphericalHarmonicRestColumns(
62
49
  columns,
63
50
  fields,
64
- schemaFields,
65
51
  splats.sphericalHarmonics,
66
52
  splats.sphericalHarmonicsComponentCount
67
53
  );
@@ -74,9 +60,16 @@ export function makeGaussianSplatsArrowTable(splats: GaussianSplats): MeshArrowT
74
60
  ['topology', 'point-list'],
75
61
  ['mode', '0']
76
62
  ]);
77
- if (splats.format !== 'rad' && splats.loaderData) {
78
- const {extensionBytes, ...header} = splats.loaderData;
79
- metadata.set('loaders_gl.gaussian_splats.loader_data', JSON.stringify(header));
63
+ if (splats.loaderData) {
64
+ const {extensionBytes, childCounts, childStarts, ...header} = splats.loaderData;
65
+ metadata.set(
66
+ 'loaders_gl.gaussian_splats.loader_data',
67
+ JSON.stringify({
68
+ ...header,
69
+ childCounts: childCounts instanceof Uint16Array ? Array.from(childCounts) : childCounts,
70
+ childStarts: childStarts instanceof Uint32Array ? Array.from(childStarts) : childStarts
71
+ })
72
+ );
80
73
  if (extensionBytes instanceof Uint8Array) {
81
74
  metadata.set(
82
75
  'loaders_gl.gaussian_splats.extension_bytes',
@@ -84,26 +77,13 @@ export function makeGaussianSplatsArrowTable(splats: GaussianSplats): MeshArrowT
84
77
  );
85
78
  }
86
79
  }
87
- const arrowSchema = new arrow.Schema(fields, metadata);
88
- const schema: Schema = {
89
- fields: schemaFields,
90
- metadata: Object.fromEntries(metadata)
91
- };
92
-
93
- return {
94
- shape: 'arrow-table',
95
- schema,
96
- data: new arrow.Table(arrowSchema, columns),
97
- topology: 'point-list',
98
- loaderData: splats.loaderData
99
- } as MeshArrowTable;
80
+ return new arrow.Table(new arrow.Schema(fields, metadata), columns);
100
81
  }
101
82
 
102
83
  /** Adds one scalar Arrow column per component of an interleaved vector array. */
103
84
  function addVectorComponents(
104
85
  columns: Record<string, arrow.Vector>,
105
86
  fields: arrow.Field[],
106
- schemaFields: Field[],
107
87
  prefix: string,
108
88
  values: Float32Array,
109
89
  size: number,
@@ -114,7 +94,7 @@ function addVectorComponents(
114
94
  for (let rowIndex = 0; rowIndex < componentValues.length; rowIndex++) {
115
95
  componentValues[rowIndex] = values[rowIndex * size + component];
116
96
  }
117
- addScalarColumn(columns, fields, schemaFields, `${prefix}_${component}`, componentValues, {
97
+ addScalarColumn(columns, fields, `${prefix}_${component}`, componentValues, {
118
98
  ...metadata,
119
99
  'loaders_gl.gaussian_splats.component': String(component)
120
100
  });
@@ -125,7 +105,6 @@ function addVectorComponents(
125
105
  function addSphericalHarmonicRestColumns(
126
106
  columns: Record<string, arrow.Vector>,
127
107
  fields: arrow.Field[],
128
- schemaFields: Field[],
129
108
  sphericalHarmonics: Float32Array,
130
109
  componentCount: number
131
110
  ): void {
@@ -134,7 +113,7 @@ function addSphericalHarmonicRestColumns(
134
113
  for (let rowIndex = 0; rowIndex < componentValues.length; rowIndex++) {
135
114
  componentValues[rowIndex] = sphericalHarmonics[rowIndex * componentCount + component];
136
115
  }
137
- addScalarColumn(columns, fields, schemaFields, `f_rest_${component}`, componentValues, {
116
+ addScalarColumn(columns, fields, `f_rest_${component}`, componentValues, {
138
117
  'loaders_gl.gaussian_splats.semantic': 'spherical_harmonic_rest',
139
118
  'loaders_gl.gaussian_splats.component': String(component),
140
119
  'loaders_gl.gaussian_splats.encoding': 'coefficient'
@@ -142,31 +121,27 @@ function addSphericalHarmonicRestColumns(
142
121
  }
143
122
  }
144
123
 
145
- /** Adds a Float32 scalar Arrow column and matching loaders.gl schema field. */
124
+ /** Adds a Float32 scalar Arrow column. */
146
125
  function addScalarColumn(
147
126
  columns: Record<string, arrow.Vector>,
148
127
  fields: arrow.Field[],
149
- schemaFields: Field[],
150
128
  name: string,
151
129
  values: Float32Array,
152
130
  metadata: Record<string, string>
153
131
  ): void {
154
- addColumn(columns, fields, schemaFields, name, arrow.makeVector(values), 'float32', metadata);
132
+ addColumn(columns, fields, name, arrow.makeVector(values), metadata);
155
133
  }
156
134
 
157
- /** Adds an Arrow column, Arrow field, and loaders.gl schema field. */
135
+ /** Adds an Arrow column and its field metadata. */
158
136
  function addColumn(
159
137
  columns: Record<string, arrow.Vector>,
160
138
  fields: arrow.Field[],
161
- schemaFields: Field[],
162
139
  name: string,
163
140
  column: arrow.Vector,
164
- schemaType: Field['type'],
165
141
  metadata: Record<string, string> = {}
166
142
  ): void {
167
143
  columns[name] = column;
168
144
  fields.push(new arrow.Field(name, column.type, false, new Map(Object.entries(metadata))));
169
- schemaFields.push({name, type: schemaType, nullable: false, metadata});
170
145
  }
171
146
 
172
147
  /** Builds a FixedSizeList Arrow vector from an interleaved Float32 array. */
@@ -4,7 +4,7 @@
4
4
 
5
5
  import type {CoreAPI, DataSourceOptions} from '@loaders.gl/core/loader-utils';
6
6
  import {DataSource} from '@loaders.gl/core/loader-utils';
7
- import type {MeshArrowTable} from '@loaders.gl/core/schema';
7
+ import type {Table} from 'apache-arrow';
8
8
  import {
9
9
  parseRADChunkHeader,
10
10
  tryParseRADHeader,
@@ -173,10 +173,7 @@ export class RADSource extends DataSource<string | Blob, RADSourceLoaderOptions>
173
173
  }
174
174
 
175
175
  /** Fetches and decodes one RADC chunk into a Mesh Arrow table. */
176
- async getChunkTable(
177
- chunkIndex: number,
178
- options: RADChunkRequestOptions = {}
179
- ): Promise<MeshArrowTable> {
176
+ async getChunkTable(chunkIndex: number, options: RADChunkRequestOptions = {}): Promise<Table> {
180
177
  const metadata = await this.getMetadata();
181
178
  await preloadRADCompression();
182
179
  return parseRADChunk(
@@ -186,7 +183,7 @@ export class RADSource extends DataSource<string | Blob, RADSourceLoaderOptions>
186
183
  }
187
184
 
188
185
  /** Iterates decoded RADC chunks as Mesh Arrow tables. */
189
- async *getChunkTables(options: RADChunkTableIteratorOptions = {}): AsyncIterable<MeshArrowTable> {
186
+ async *getChunkTables(options: RADChunkTableIteratorOptions = {}): AsyncIterable<Table> {
190
187
  const metadata = await this.getMetadata();
191
188
  const startChunkIndex = options.startChunkIndex ?? 0;
192
189
  const maxChunks = options.maxChunks ?? Number.POSITIVE_INFINITY;
@@ -222,7 +219,7 @@ export class RADSource extends DataSource<string | Blob, RADSourceLoaderOptions>
222
219
  ) {
223
220
  const table = await this.getChunkTable(chunkIndex, options);
224
221
  chunkCount++;
225
- splatCount += table.data.numRows;
222
+ splatCount += table.numRows;
226
223
  yield table;
227
224
  }
228
225
  }
@@ -13,6 +13,6 @@ const {preload: _SPLATLoaderPreload, ...SPLATLoaderMetadataWithoutPreload} = SPL
13
13
  /** Parser-bearing loader for raw `.splat` Gaussian splat files. */
14
14
  export const SPLATLoaderWithParser = {
15
15
  ...SPLATLoaderMetadataWithoutPreload,
16
- parse: async (arrayBuffer: ArrayBuffer) => parseSPLAT(arrayBuffer).data,
17
- parseSync: (arrayBuffer: ArrayBuffer) => parseSPLAT(arrayBuffer).data
16
+ parse: async (arrayBuffer: ArrayBuffer) => parseSPLAT(arrayBuffer),
17
+ parseSync: (arrayBuffer: ArrayBuffer) => parseSPLAT(arrayBuffer)
18
18
  } as const satisfies LoaderWithParser<Table, never, SplatsLoaderOptions>;
package/src/spz-loader.ts CHANGED
@@ -14,5 +14,5 @@ const {preload: _SPZLoaderPreload, ...SPZLoaderMetadataWithoutPreload} = SPZLoad
14
14
  export const SPZLoaderWithParser = {
15
15
  ...SPZLoaderMetadataWithoutPreload,
16
16
  parse: async (arrayBuffer: ArrayBuffer, options?: SplatsLoaderOptions) =>
17
- (await parseSPZ(arrayBuffer, options)).data
17
+ parseSPZ(arrayBuffer, options)
18
18
  } as const satisfies LoaderWithParser<Table, never, SplatsLoaderOptions>;