mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-02-01 22:09:55 +00:00
3c4b99ed84
## Summary integrated sparkjs https://sparkjs.dev/, built by [world labs ](https://www.worldlabs.ai/) to support 3dgs. - Add 3D Gaussian Splatting (3DGS) support using @sparkjsdev/spark library - Add PLY file format support with multiple rendering engines - Support new file formats: `.ply`, `.spz`, `.splat`, `.ksplat` - Add PLY Engine setting with three options: `threejs` (mesh), `fastply` (optimized ASCII point clouds), `sparkjs` (3DGS) - Add `FastPLYLoader` for 4-5x faster ASCII PLY parsing - Add `original(Advanced)` material mode for point cloud rendering with THREE.Points 3dgs generated by https://marble.worldlabs.ai/ test ply file from: 1. made by https://github.com/PozzettiAndrea/ComfyUI-DepthAnythingV3 2. threejs offically repo ## Screenshots https://github.com/user-attachments/assets/44e64d3e-b58d-4341-9a70-a9aa64801220 https://github.com/user-attachments/assets/76b0dfba-0c12-4f64-91cb-bfc5d672294d https://github.com/user-attachments/assets/2a8bfe81-1fb2-44c4-8787-dff325369c61 https://github.com/user-attachments/assets/e4beecee-d7a2-40c9-97f7-79b09c60312d ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-7602-3dgs-ply-support-2cd6d73d3650814098fcea86cfaf747d) by [Unito](https://www.unito.io)
449 lines
11 KiB
TypeScript
449 lines
11 KiB
TypeScript
import { describe, expect, it } from 'vitest'
|
|
|
|
import { isPLYAsciiFormat, parseASCIIPLY } from '@/scripts/metadata/ply'
|
|
|
|
function createPLYBuffer(content: string): ArrayBuffer {
|
|
return new TextEncoder().encode(content).buffer
|
|
}
|
|
|
|
describe('PLY metadata parser', () => {
|
|
describe('isPLYAsciiFormat', () => {
|
|
it('should return true for ASCII format PLY', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
element vertex 3
|
|
property float x
|
|
property float y
|
|
property float z
|
|
end_header
|
|
0 0 0
|
|
1 0 0
|
|
0 1 0`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
expect(isPLYAsciiFormat(buffer)).toBe(true)
|
|
})
|
|
|
|
it('should return false for binary format PLY', () => {
|
|
const ply = `ply
|
|
format binary_little_endian 1.0
|
|
element vertex 3
|
|
property float x
|
|
property float y
|
|
property float z
|
|
end_header`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
expect(isPLYAsciiFormat(buffer)).toBe(false)
|
|
})
|
|
|
|
it('should return false for binary big endian format', () => {
|
|
const ply = `ply
|
|
format binary_big_endian 1.0
|
|
element vertex 3
|
|
end_header`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
expect(isPLYAsciiFormat(buffer)).toBe(false)
|
|
})
|
|
|
|
it('should handle empty buffer', () => {
|
|
const buffer = new ArrayBuffer(0)
|
|
expect(isPLYAsciiFormat(buffer)).toBe(false)
|
|
})
|
|
})
|
|
|
|
describe('parseASCIIPLY', () => {
|
|
it('should parse simple PLY with positions only', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
element vertex 3
|
|
property float x
|
|
property float y
|
|
property float z
|
|
end_header
|
|
0.0 0.0 0.0
|
|
1.0 0.0 0.0
|
|
0.0 1.0 0.0`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).not.toBeNull()
|
|
expect(result!.vertexCount).toBe(3)
|
|
expect(result!.colors).toBeNull()
|
|
expect(result!.positions).toBeInstanceOf(Float32Array)
|
|
expect(result!.positions.length).toBe(9)
|
|
|
|
expect(result!.positions[0]).toBeCloseTo(0.0)
|
|
expect(result!.positions[1]).toBeCloseTo(0.0)
|
|
expect(result!.positions[2]).toBeCloseTo(0.0)
|
|
|
|
expect(result!.positions[3]).toBeCloseTo(1.0)
|
|
expect(result!.positions[4]).toBeCloseTo(0.0)
|
|
expect(result!.positions[5]).toBeCloseTo(0.0)
|
|
|
|
expect(result!.positions[6]).toBeCloseTo(0.0)
|
|
expect(result!.positions[7]).toBeCloseTo(1.0)
|
|
expect(result!.positions[8]).toBeCloseTo(0.0)
|
|
})
|
|
|
|
it('should parse PLY with positions and colors', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
element vertex 2
|
|
property float x
|
|
property float y
|
|
property float z
|
|
property uchar red
|
|
property uchar green
|
|
property uchar blue
|
|
end_header
|
|
1.0 2.0 3.0 255 128 0
|
|
-1.0 -2.0 -3.0 0 255 128`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).not.toBeNull()
|
|
expect(result!.vertexCount).toBe(2)
|
|
expect(result!.colors).not.toBeNull()
|
|
expect(result!.colors).toBeInstanceOf(Float32Array)
|
|
expect(result!.colors!.length).toBe(6)
|
|
|
|
// First vertex position
|
|
expect(result!.positions[0]).toBeCloseTo(1.0)
|
|
expect(result!.positions[1]).toBeCloseTo(2.0)
|
|
expect(result!.positions[2]).toBeCloseTo(3.0)
|
|
|
|
// First vertex color (normalized to 0-1)
|
|
expect(result!.colors![0]).toBeCloseTo(1.0) // 255/255
|
|
expect(result!.colors![1]).toBeCloseTo(128 / 255)
|
|
expect(result!.colors![2]).toBeCloseTo(0.0)
|
|
|
|
// Second vertex color
|
|
expect(result!.colors![3]).toBeCloseTo(0.0)
|
|
expect(result!.colors![4]).toBeCloseTo(1.0)
|
|
expect(result!.colors![5]).toBeCloseTo(128 / 255)
|
|
})
|
|
|
|
it('should handle properties in non-standard order', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
element vertex 1
|
|
property uchar red
|
|
property float z
|
|
property uchar green
|
|
property float x
|
|
property uchar blue
|
|
property float y
|
|
end_header
|
|
255 3.0 128 1.0 64 2.0`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).not.toBeNull()
|
|
expect(result!.vertexCount).toBe(1)
|
|
|
|
expect(result!.positions[0]).toBeCloseTo(1.0)
|
|
expect(result!.positions[1]).toBeCloseTo(2.0)
|
|
expect(result!.positions[2]).toBeCloseTo(3.0)
|
|
|
|
expect(result!.colors![0]).toBeCloseTo(1.0)
|
|
expect(result!.colors![1]).toBeCloseTo(128 / 255)
|
|
expect(result!.colors![2]).toBeCloseTo(64 / 255)
|
|
})
|
|
|
|
it('should handle extra properties', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
element vertex 1
|
|
property float x
|
|
property float y
|
|
property float z
|
|
property float nx
|
|
property float ny
|
|
property float nz
|
|
property uchar red
|
|
property uchar green
|
|
property uchar blue
|
|
property uchar alpha
|
|
end_header
|
|
1.0 2.0 3.0 0.0 1.0 0.0 255 128 64 255`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).not.toBeNull()
|
|
expect(result!.positions[0]).toBeCloseTo(1.0)
|
|
expect(result!.positions[1]).toBeCloseTo(2.0)
|
|
expect(result!.positions[2]).toBeCloseTo(3.0)
|
|
|
|
expect(result!.colors![0]).toBeCloseTo(1.0)
|
|
expect(result!.colors![1]).toBeCloseTo(128 / 255)
|
|
expect(result!.colors![2]).toBeCloseTo(64 / 255)
|
|
})
|
|
|
|
it('should handle negative coordinates', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
element vertex 1
|
|
property float x
|
|
property float y
|
|
property float z
|
|
end_header
|
|
-1.5 -2.5 -3.5`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).not.toBeNull()
|
|
expect(result!.positions[0]).toBeCloseTo(-1.5)
|
|
expect(result!.positions[1]).toBeCloseTo(-2.5)
|
|
expect(result!.positions[2]).toBeCloseTo(-3.5)
|
|
})
|
|
|
|
it('should handle scientific notation', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
element vertex 1
|
|
property float x
|
|
property float y
|
|
property float z
|
|
end_header
|
|
1.5e-3 2.5e+2 -3.5e1`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).not.toBeNull()
|
|
expect(result!.positions[0]).toBeCloseTo(0.0015)
|
|
expect(result!.positions[1]).toBeCloseTo(250)
|
|
expect(result!.positions[2]).toBeCloseTo(-35)
|
|
})
|
|
|
|
it('should skip empty lines in vertex data', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
element vertex 2
|
|
property float x
|
|
property float y
|
|
property float z
|
|
end_header
|
|
|
|
1.0 0.0 0.0
|
|
|
|
0.0 1.0 0.0
|
|
`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).not.toBeNull()
|
|
expect(result!.vertexCount).toBe(2)
|
|
expect(result!.positions[0]).toBeCloseTo(1.0)
|
|
expect(result!.positions[3]).toBeCloseTo(0.0)
|
|
expect(result!.positions[4]).toBeCloseTo(1.0)
|
|
})
|
|
|
|
it('should handle whitespace variations', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
element vertex 1
|
|
property float x
|
|
property float y
|
|
property float z
|
|
end_header
|
|
1.0 2.0 3.0 `
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).not.toBeNull()
|
|
expect(result!.positions[0]).toBeCloseTo(1.0)
|
|
expect(result!.positions[1]).toBeCloseTo(2.0)
|
|
expect(result!.positions[2]).toBeCloseTo(3.0)
|
|
})
|
|
|
|
it('should return null for invalid header - missing vertex count', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
property float x
|
|
property float y
|
|
property float z
|
|
end_header
|
|
1.0 2.0 3.0`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).toBeNull()
|
|
})
|
|
|
|
it('should return null for invalid header - missing x property', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
element vertex 1
|
|
property float y
|
|
property float z
|
|
end_header
|
|
2.0 3.0`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).toBeNull()
|
|
})
|
|
|
|
it('should return null for invalid header - missing y property', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
element vertex 1
|
|
property float x
|
|
property float z
|
|
end_header
|
|
1.0 3.0`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).toBeNull()
|
|
})
|
|
|
|
it('should return null for invalid header - missing z property', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
element vertex 1
|
|
property float x
|
|
property float y
|
|
end_header
|
|
1.0 2.0`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).toBeNull()
|
|
})
|
|
|
|
it('should return null for empty buffer', () => {
|
|
const buffer = new ArrayBuffer(0)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).toBeNull()
|
|
})
|
|
|
|
it('should handle large vertex count', () => {
|
|
const vertexCount = 1000
|
|
let plyContent = `ply
|
|
format ascii 1.0
|
|
element vertex ${vertexCount}
|
|
property float x
|
|
property float y
|
|
property float z
|
|
end_header
|
|
`
|
|
for (let i = 0; i < vertexCount; i++) {
|
|
plyContent += `${i} ${i * 2} ${i * 3}\n`
|
|
}
|
|
|
|
const buffer = createPLYBuffer(plyContent)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).not.toBeNull()
|
|
expect(result!.vertexCount).toBe(vertexCount)
|
|
expect(result!.positions.length).toBe(vertexCount * 3)
|
|
|
|
expect(result!.positions[0]).toBeCloseTo(0)
|
|
expect(result!.positions[1]).toBeCloseTo(0)
|
|
expect(result!.positions[2]).toBeCloseTo(0)
|
|
|
|
const lastIdx = (vertexCount - 1) * 3
|
|
expect(result!.positions[lastIdx]).toBeCloseTo(vertexCount - 1)
|
|
expect(result!.positions[lastIdx + 1]).toBeCloseTo((vertexCount - 1) * 2)
|
|
expect(result!.positions[lastIdx + 2]).toBeCloseTo((vertexCount - 1) * 3)
|
|
})
|
|
|
|
it('should handle partial color properties', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
element vertex 1
|
|
property float x
|
|
property float y
|
|
property float z
|
|
property uchar red
|
|
end_header
|
|
1.0 2.0 3.0 255`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).not.toBeNull()
|
|
// hasColor is true but green/blue indices are -1, so colors won't be parsed
|
|
expect(result!.positions[0]).toBeCloseTo(1.0)
|
|
})
|
|
|
|
it('should handle double property type', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
element vertex 1
|
|
property double x
|
|
property double y
|
|
property double z
|
|
end_header
|
|
1.123456789 2.987654321 3.111111111`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).not.toBeNull()
|
|
expect(result!.positions[0]).toBeCloseTo(1.123456789)
|
|
expect(result!.positions[1]).toBeCloseTo(2.987654321)
|
|
expect(result!.positions[2]).toBeCloseTo(3.111111111)
|
|
})
|
|
|
|
it('should stop parsing at vertex count limit', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
element vertex 2
|
|
property float x
|
|
property float y
|
|
property float z
|
|
end_header
|
|
1.0 0.0 0.0
|
|
0.0 1.0 0.0
|
|
0.0 0.0 1.0
|
|
999 999 999`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).not.toBeNull()
|
|
expect(result!.vertexCount).toBe(2)
|
|
expect(result!.positions.length).toBe(6)
|
|
})
|
|
|
|
it('should handle face elements after vertices', () => {
|
|
const ply = `ply
|
|
format ascii 1.0
|
|
element vertex 3
|
|
property float x
|
|
property float y
|
|
property float z
|
|
element face 1
|
|
property list uchar int vertex_indices
|
|
end_header
|
|
0.0 0.0 0.0
|
|
1.0 0.0 0.0
|
|
0.0 1.0 0.0
|
|
3 0 1 2`
|
|
|
|
const buffer = createPLYBuffer(ply)
|
|
const result = parseASCIIPLY(buffer)
|
|
|
|
expect(result).not.toBeNull()
|
|
expect(result!.vertexCount).toBe(3)
|
|
})
|
|
})
|
|
})
|