mirror of
https://github.com/protomaps/PMTiles.git
synced 2026-02-04 10:51:07 +00:00
rename pmtiles.ts > index.ts to fix node-style module resolution
This commit is contained in:
Brandon Liu
499
js/index.ts
Normal file
499
js/index.ts
Normal file
@@ -0,0 +1,499 @@
|
||||
declare const L: any;
|
||||
|
||||
export const shift = (n: number, shift: number) => {
|
||||
return n * Math.pow(2, shift);
|
||||
};
|
||||
|
||||
export const unshift = (n: number, shift: number) => {
|
||||
return Math.floor(n / Math.pow(2, shift));
|
||||
};
|
||||
|
||||
export const getUint24 = (view: DataView, pos: number) => {
|
||||
return shift(view.getUint16(pos + 1, true), 8) + view.getUint8(pos);
|
||||
};
|
||||
|
||||
export const getUint48 = (view: DataView, pos: number) => {
|
||||
return shift(view.getUint32(pos + 2, true), 16) + view.getUint16(pos, true);
|
||||
};
|
||||
|
||||
interface Zxy {
|
||||
z: number;
|
||||
x: number;
|
||||
y: number;
|
||||
}
|
||||
|
||||
interface Header {
|
||||
version: number;
|
||||
json_size: number;
|
||||
root_entries: number;
|
||||
}
|
||||
|
||||
interface Root {
|
||||
header: Header;
|
||||
buffer: ArrayBuffer;
|
||||
dir: DataView;
|
||||
// etag: string | null;
|
||||
}
|
||||
|
||||
export interface Entry {
|
||||
z: number;
|
||||
x: number;
|
||||
y: number;
|
||||
offset: number;
|
||||
length: number;
|
||||
is_dir: boolean;
|
||||
}
|
||||
|
||||
interface CachedLeaf {
|
||||
lastUsed: number;
|
||||
buffer: Promise<ArrayBuffer>;
|
||||
}
|
||||
|
||||
const compare = (
|
||||
tz: number,
|
||||
tx: number,
|
||||
ty: number,
|
||||
view: DataView,
|
||||
i: number
|
||||
) => {
|
||||
if (tz != view.getUint8(i)) return tz - view.getUint8(i);
|
||||
const x = getUint24(view, i + 1);
|
||||
if (tx != x) return tx - x;
|
||||
const y = getUint24(view, i + 4);
|
||||
if (ty != y) return ty - y;
|
||||
return 0;
|
||||
};
|
||||
|
||||
export const queryLeafdir = (
|
||||
view: DataView,
|
||||
z: number,
|
||||
x: number,
|
||||
y: number
|
||||
): Entry | null => {
|
||||
const offset_len = queryView(view, z | 0x80, x, y);
|
||||
if (offset_len) {
|
||||
return {
|
||||
z: z,
|
||||
x: x,
|
||||
y: y,
|
||||
offset: offset_len[0],
|
||||
length: offset_len[1],
|
||||
is_dir: true,
|
||||
};
|
||||
}
|
||||
return null;
|
||||
};
|
||||
|
||||
export const queryTile = (view: DataView, z: number, x: number, y: number) => {
|
||||
const offset_len = queryView(view, z, x, y);
|
||||
if (offset_len) {
|
||||
return {
|
||||
z: z,
|
||||
x: x,
|
||||
y: y,
|
||||
offset: offset_len[0],
|
||||
length: offset_len[1],
|
||||
is_dir: false,
|
||||
};
|
||||
}
|
||||
return null;
|
||||
};
|
||||
|
||||
const queryView = (
|
||||
view: DataView,
|
||||
z: number,
|
||||
x: number,
|
||||
y: number
|
||||
): [number, number] | null => {
|
||||
let m = 0;
|
||||
let n = view.byteLength / 17 - 1;
|
||||
while (m <= n) {
|
||||
const k = (n + m) >> 1;
|
||||
const cmp = compare(z, x, y, view, k * 17);
|
||||
if (cmp > 0) {
|
||||
m = k + 1;
|
||||
} else if (cmp < 0) {
|
||||
n = k - 1;
|
||||
} else {
|
||||
return [getUint48(view, k * 17 + 7), view.getUint32(k * 17 + 13, true)];
|
||||
}
|
||||
}
|
||||
return null;
|
||||
};
|
||||
|
||||
export const queryLeafLevel = (view: DataView): number | null => {
|
||||
if (view.byteLength < 17) return null;
|
||||
const numEntries = view.byteLength / 17;
|
||||
const entry = parseEntry(view, numEntries - 1);
|
||||
if (entry.is_dir) return entry.z;
|
||||
return null;
|
||||
};
|
||||
|
||||
const entrySort = (a: Entry, b: Entry): number => {
|
||||
if (a.is_dir && !b.is_dir) {
|
||||
return 1;
|
||||
}
|
||||
if (!a.is_dir && b.is_dir) {
|
||||
return -1;
|
||||
}
|
||||
if (a.z !== b.z) {
|
||||
return a.z - b.z;
|
||||
}
|
||||
if (a.x !== b.x) {
|
||||
return a.x - b.x;
|
||||
}
|
||||
return a.y - b.y;
|
||||
};
|
||||
|
||||
export const parseEntry = (dataview: DataView, i: number): Entry => {
|
||||
const z_raw = dataview.getUint8(i * 17);
|
||||
const z = z_raw & 127;
|
||||
return {
|
||||
z: z,
|
||||
x: getUint24(dataview, i * 17 + 1),
|
||||
y: getUint24(dataview, i * 17 + 4),
|
||||
offset: getUint48(dataview, i * 17 + 7),
|
||||
length: dataview.getUint32(i * 17 + 13, true),
|
||||
is_dir: z_raw >> 7 === 1,
|
||||
};
|
||||
};
|
||||
|
||||
export const sortDir = (dataview: DataView): ArrayBuffer => {
|
||||
const entries: Entry[] = [];
|
||||
for (let i = 0; i < dataview.byteLength / 17; i++) {
|
||||
entries.push(parseEntry(dataview, i));
|
||||
}
|
||||
return createDirectory(entries);
|
||||
};
|
||||
|
||||
export const createDirectory = (entries: Entry[]): ArrayBuffer => {
|
||||
entries.sort(entrySort);
|
||||
|
||||
const buffer = new ArrayBuffer(17 * entries.length);
|
||||
const arr = new Uint8Array(buffer);
|
||||
for (let i = 0; i < entries.length; i++) {
|
||||
const entry = entries[i];
|
||||
let z = entry.z;
|
||||
if (entry.is_dir) z = z | 0x80;
|
||||
arr[i * 17] = z;
|
||||
|
||||
arr[i * 17 + 1] = entry.x & 0xff;
|
||||
arr[i * 17 + 2] = (entry.x >> 8) & 0xff;
|
||||
arr[i * 17 + 3] = (entry.x >> 16) & 0xff;
|
||||
|
||||
arr[i * 17 + 4] = entry.y & 0xff;
|
||||
arr[i * 17 + 5] = (entry.y >> 8) & 0xff;
|
||||
arr[i * 17 + 6] = (entry.y >> 16) & 0xff;
|
||||
|
||||
arr[i * 17 + 7] = entry.offset & 0xff;
|
||||
arr[i * 17 + 8] = unshift(entry.offset, 8) & 0xff;
|
||||
arr[i * 17 + 9] = unshift(entry.offset, 16) & 0xff;
|
||||
arr[i * 17 + 10] = unshift(entry.offset, 24) & 0xff;
|
||||
arr[i * 17 + 11] = unshift(entry.offset, 32) & 0xff;
|
||||
arr[i * 17 + 12] = unshift(entry.offset, 48) & 0xff;
|
||||
|
||||
arr[i * 17 + 13] = entry.length & 0xff;
|
||||
arr[i * 17 + 14] = (entry.length >> 8) & 0xff;
|
||||
arr[i * 17 + 15] = (entry.length >> 16) & 0xff;
|
||||
arr[i * 17 + 16] = (entry.length >> 24) & 0xff;
|
||||
}
|
||||
return buffer;
|
||||
};
|
||||
|
||||
export const deriveLeaf = (root: Root, tile: Zxy): Zxy | null => {
|
||||
const leaf_level = queryLeafLevel(root.dir);
|
||||
if (leaf_level) {
|
||||
const level_diff = tile.z - leaf_level;
|
||||
const leaf_x = Math.trunc(tile.x / (1 << level_diff));
|
||||
const leaf_y = Math.trunc(tile.y / (1 << level_diff));
|
||||
return { z: leaf_level, x: leaf_x, y: leaf_y };
|
||||
}
|
||||
return null;
|
||||
};
|
||||
|
||||
export const parseHeader = (dataview: DataView): Header => {
|
||||
const magic = dataview.getUint16(0, true);
|
||||
if (magic !== 19792) {
|
||||
throw new Error('File header does not begin with "PM"');
|
||||
}
|
||||
const version = dataview.getUint16(2, true);
|
||||
const json_size = dataview.getUint32(4, true);
|
||||
const root_entries = dataview.getUint16(8, true);
|
||||
return {
|
||||
version: version,
|
||||
json_size: json_size,
|
||||
root_entries: root_entries,
|
||||
};
|
||||
};
|
||||
|
||||
export class PMTiles {
|
||||
root: Promise<Root> | null;
|
||||
url: string;
|
||||
leaves: Map<number, CachedLeaf>;
|
||||
maxLeaves: number;
|
||||
|
||||
constructor(url: string, maxLeaves = 64) {
|
||||
this.root = null;
|
||||
this.url = url;
|
||||
this.leaves = new Map<number, CachedLeaf>();
|
||||
this.maxLeaves = maxLeaves;
|
||||
}
|
||||
|
||||
async fetchRoot(url: string): Promise<Root> {
|
||||
const controller = new AbortController();
|
||||
const signal = controller.signal;
|
||||
const resp = await fetch(url, {
|
||||
signal: signal,
|
||||
headers: { Range: "bytes=0-511999" },
|
||||
});
|
||||
const contentLength = resp.headers.get("Content-Length");
|
||||
if (!contentLength || +contentLength !== 512000) {
|
||||
console.error(
|
||||
"Content-Length mismatch indicates byte serving not supported; aborting."
|
||||
);
|
||||
controller.abort();
|
||||
}
|
||||
|
||||
const a = await resp.arrayBuffer();
|
||||
const header = parseHeader(new DataView(a, 0, 10));
|
||||
|
||||
let root_dir = new DataView(
|
||||
a,
|
||||
10 + header.json_size,
|
||||
17 * header.root_entries
|
||||
);
|
||||
if (header.version === 1) {
|
||||
console.warn("Sorting pmtiles v1 directory");
|
||||
root_dir = new DataView(sortDir(root_dir));
|
||||
}
|
||||
|
||||
return {
|
||||
buffer: a,
|
||||
header: header,
|
||||
dir: root_dir,
|
||||
};
|
||||
}
|
||||
|
||||
async getRoot(): Promise<Root> {
|
||||
if (this.root) return this.root;
|
||||
this.root = this.fetchRoot(this.url);
|
||||
return this.root;
|
||||
}
|
||||
|
||||
async metadata(): Promise<any> {
|
||||
const root = await this.getRoot();
|
||||
const dec = new TextDecoder("utf-8");
|
||||
const result = JSON.parse(
|
||||
dec.decode(new DataView(root.buffer, 10, root.header.json_size))
|
||||
);
|
||||
if (result.compression) {
|
||||
console.warn(
|
||||
`Archive has compression type: ${result.compression} and may not be readable directly by browsers.`
|
||||
);
|
||||
}
|
||||
if (!result.bounds) {
|
||||
console.warn(
|
||||
`Archive is missing 'bounds' in metadata, required in v2 and above.`
|
||||
);
|
||||
}
|
||||
if (!result.minzoom) {
|
||||
console.warn(
|
||||
`Archive is missing 'minzoom' in metadata, required in v2 and above.`
|
||||
);
|
||||
}
|
||||
if (!result.maxzoom) {
|
||||
console.warn(
|
||||
`Archive is missing 'maxzoom' in metadata, required in v2 and above.`
|
||||
);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
async fetchLeafdir(version: number, entry: Entry): Promise<ArrayBuffer> {
|
||||
const resp = await fetch(this.url, {
|
||||
headers: {
|
||||
Range:
|
||||
"bytes=" + entry.offset + "-" + (entry.offset + entry.length - 1),
|
||||
},
|
||||
});
|
||||
let buf = await resp.arrayBuffer();
|
||||
|
||||
if (version === 1) {
|
||||
console.warn("Sorting pmtiles v1 directory.");
|
||||
buf = sortDir(new DataView(buf));
|
||||
}
|
||||
|
||||
return buf;
|
||||
}
|
||||
|
||||
async getLeafdir(version: number, entry: Entry): Promise<ArrayBuffer> {
|
||||
const leaf = this.leaves.get(entry.offset);
|
||||
if (leaf) return await leaf.buffer;
|
||||
|
||||
const buf = this.fetchLeafdir(version, entry);
|
||||
|
||||
this.leaves.set(entry.offset, {
|
||||
lastUsed: performance.now(),
|
||||
buffer: buf,
|
||||
});
|
||||
if (this.leaves.size > this.maxLeaves) {
|
||||
let minUsed = Infinity;
|
||||
let minKey = undefined;
|
||||
this.leaves.forEach((val, key) => {
|
||||
if (val.lastUsed < minUsed) {
|
||||
minUsed = val.lastUsed;
|
||||
minKey = key;
|
||||
}
|
||||
});
|
||||
if (minKey) this.leaves.delete(minKey);
|
||||
}
|
||||
return await buf;
|
||||
}
|
||||
|
||||
async getZxy(z: number, x: number, y: number): Promise<Entry | null> {
|
||||
const root = await this.getRoot();
|
||||
const entry = queryTile(root.dir, z, x, y);
|
||||
if (entry) return entry;
|
||||
|
||||
const leafcoords = deriveLeaf(root, { z: z, x: x, y: y });
|
||||
if (leafcoords) {
|
||||
const leafdir_entry = queryLeafdir(
|
||||
root.dir,
|
||||
leafcoords.z,
|
||||
leafcoords.x,
|
||||
leafcoords.y
|
||||
);
|
||||
if (leafdir_entry) {
|
||||
const leafdir = await this.getLeafdir(
|
||||
root.header.version,
|
||||
leafdir_entry
|
||||
);
|
||||
return queryTile(new DataView(leafdir), z, x, y);
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
export const leafletLayer = (source: PMTiles, options: any) => {
|
||||
const cls = L.GridLayer.extend({
|
||||
createTile: function (coord: any, done: any) {
|
||||
const tile: any = document.createElement("img");
|
||||
source.getZxy(coord.z, coord.x, coord.y).then((result) => {
|
||||
if (result === null) return;
|
||||
|
||||
const controller = new AbortController();
|
||||
const signal = controller.signal;
|
||||
tile.cancel = () => {
|
||||
controller.abort();
|
||||
};
|
||||
fetch(source.url, {
|
||||
signal: signal,
|
||||
headers: {
|
||||
Range:
|
||||
"bytes=" +
|
||||
result.offset +
|
||||
"-" +
|
||||
(result.offset + result.length - 1),
|
||||
},
|
||||
})
|
||||
.then((resp) => {
|
||||
return resp.arrayBuffer();
|
||||
})
|
||||
.then((buf) => {
|
||||
const blob = new Blob([buf], { type: "image/png" });
|
||||
const imageUrl = window.URL.createObjectURL(blob);
|
||||
tile.src = imageUrl;
|
||||
tile.cancel = null;
|
||||
done(null, tile);
|
||||
})
|
||||
.catch((error) => {
|
||||
if (error.name !== "AbortError") throw error;
|
||||
});
|
||||
});
|
||||
return tile;
|
||||
},
|
||||
|
||||
_removeTile: function (key: string) {
|
||||
const tile = this._tiles[key];
|
||||
if (!tile) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (tile.el.cancel) tile.el.cancel();
|
||||
|
||||
tile.el.width = 0;
|
||||
tile.el.height = 0;
|
||||
tile.el.deleted = true;
|
||||
L.DomUtil.remove(tile.el);
|
||||
delete this._tiles[key];
|
||||
this.fire("tileunload", {
|
||||
tile: tile.el,
|
||||
coords: this._keyToTileCoords(key),
|
||||
});
|
||||
},
|
||||
});
|
||||
return new cls(options);
|
||||
};
|
||||
|
||||
export class ProtocolCache {
|
||||
tiles: Map<string, PMTiles>;
|
||||
|
||||
constructor() {
|
||||
this.tiles = new Map<string, PMTiles>();
|
||||
}
|
||||
|
||||
add(p: PMTiles) {
|
||||
this.tiles.set(p.url, p);
|
||||
}
|
||||
|
||||
get(url: string) {
|
||||
return this.tiles.get(url);
|
||||
}
|
||||
|
||||
protocol = (params: any, callback: any) => {
|
||||
const re = new RegExp(/pmtiles:\/\/(.+)\/(\d+)\/(\d+)\/(\d+)/);
|
||||
const result = params.url.match(re);
|
||||
const pmtiles_url = result[1];
|
||||
|
||||
let instance = this.tiles.get(pmtiles_url);
|
||||
if (!instance) {
|
||||
instance = new PMTiles(pmtiles_url);
|
||||
this.tiles.set(pmtiles_url, instance);
|
||||
}
|
||||
const z = result[2];
|
||||
const x = result[3];
|
||||
const y = result[4];
|
||||
let cancel = () => {};
|
||||
|
||||
instance.getZxy(+z, +x, +y).then((val) => {
|
||||
if (val) {
|
||||
const headers = {
|
||||
Range: "bytes=" + val.offset + "-" + (val.offset + val.length - 1),
|
||||
};
|
||||
const controller = new AbortController();
|
||||
const signal = controller.signal;
|
||||
cancel = () => {
|
||||
controller.abort();
|
||||
};
|
||||
fetch(pmtiles_url, { signal: signal, headers: headers })
|
||||
.then((resp) => {
|
||||
return resp.arrayBuffer();
|
||||
})
|
||||
.then((arr) => {
|
||||
callback(null, arr, null, null);
|
||||
})
|
||||
.catch((e) => {
|
||||
callback(new Error("Canceled"), null, null, null);
|
||||
});
|
||||
} else {
|
||||
callback(null, new Uint8Array(), null, null);
|
||||
}
|
||||
});
|
||||
return {
|
||||
cancel: () => {
|
||||
cancel();
|
||||
},
|
||||
};
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user