diff --git a/Cargo.lock b/Cargo.lock index a51d11de3cf..6da074a58e5 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1931,6 +1931,12 @@ version = "0.5.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "022dfe9eb35f19ebbcb51e0b40a5ab759f46ad60cadf7297e0bd085afb50e076" +[[package]] +name = "base64" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9e1b586273c5702936fe7b7d6896644d8be71e6314cfe09d3167c95f712589e8" + [[package]] name = "base64" version = "0.21.7" @@ -5218,6 +5224,12 @@ dependencies = [ "winapi", ] +[[package]] +name = "glam" +version = "0.34.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "627003914c6057c9c8f0832ee4f870b5a4f599d0cfa83f4072675114860cd0ff" + [[package]] name = "glib" version = "0.18.5" @@ -5271,6 +5283,45 @@ version = "0.3.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e4eba85ea1d0a966a983acd07deee566e67395d2d96b6fb39e62b5a833f1eb0b" +[[package]] +name = "gltf" +version = "1.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e3ce1918195723ce6ac74e80542c5a96a40c2b26162c1957a5cd70799b8cacf7" +dependencies = [ + "base64 0.13.1", + "byteorder", + "gltf-json", + "image", + "lazy_static", + "serde_json", + "urlencoding", +] + +[[package]] +name = "gltf-derive" +version = "1.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "14070e711538afba5d6c807edb74bcb84e5dbb9211a3bf5dea0dfab5b24f4c51" +dependencies = [ + "inflections", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "gltf-json" +version = "1.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6176f9d60a7eab0a877e8e96548605dedbde9190a7ae1e80bbcc1c9af03ab14" +dependencies = [ + "gltf-derive", + "serde", + "serde_derive", + "serde_json", +] + [[package]] name = "gobject-sys" version = "0.18.0" @@ -6270,6 +6321,12 @@ dependencies = [ "str_stack", ] +[[package]] +name = "inflections" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a257582fdcde896fd96463bf2d40eefea0580021c0712a0e2b028b60b47a837a" + [[package]] name = "inlinable_string" version = "0.1.15" @@ -8335,6 +8392,17 @@ dependencies = [ "tracing-subscriber", ] +[[package]] +name = "modrinth-skin-rendering" +version = "0.1.0" +dependencies = [ + "glam", + "gltf", + "png 0.18.1", + "serde", + "thiserror 2.0.21", +] + [[package]] name = "modrinth-util" version = "0.0.0" @@ -13839,6 +13907,7 @@ dependencies = [ "libc", "minecraft-meta-manifest", "modrinth-content-management", + "modrinth-skin-rendering", "notify", "notify-debouncer-mini", "p256", diff --git a/Cargo.toml b/Cargo.toml index ca462e9d00d..774fb640007 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -13,6 +13,7 @@ members = [ "packages/modrinth-content-management", "packages/modrinth-log", "packages/modrinth-maxmind", + "packages/modrinth-skin-rendering", "packages/modrinth-util", "packages/neverbounce", "packages/path-util", @@ -101,6 +102,8 @@ flate2 = "1.1.10" fs4 = { version = "1.1.0", default-features = false } futures = "0.3.34" futures-util = "0.3.34" +glam = "0.34.3" +gltf = "1.4.1" governor = "0.10.4" heck = "0.5.0" hex = "0.4.3" @@ -152,6 +155,7 @@ minecraft-meta-manifest = { path = "packages/minecraft-meta-manifest" } minecraft-meta-model = { path = "packages/minecraft-meta-model" } modrinth-content-management = { path = "packages/modrinth-content-management" } modrinth-log = { path = "packages/modrinth-log" } +modrinth-skin-rendering = { path = "packages/modrinth-skin-rendering" } modrinth-util = { path = "packages/modrinth-util" } muralpay = { path = "packages/muralpay" } murmur2 = "0.1.0" @@ -342,6 +346,22 @@ tauri-utils = { git = "https://github.com/tauri-apps/tauri", rev = "7cc68e74ff69 # Toasty's unused SQLite driver conflicts with SQLx's native SQLite bindings. toasty = { path = "packages/toasty" } +[profile.dev.package.fdeflate] +opt-level = 3 + +[profile.dev.package.flate2] +opt-level = 3 + +[profile.dev.package.miniz_oxide] +opt-level = 3 + +# Unoptimized, rendering one skin preview takes over a second +[profile.dev.package.modrinth-skin-rendering] +opt-level = 3 + +[profile.dev.package.png] +opt-level = 3 + [profile.dev.package.sqlx-macros] opt-level = 3 diff --git a/apps/app-frontend/src/components/ui/skin/BakedSkinButton.vue b/apps/app-frontend/src/components/ui/skin/BakedSkinButton.vue index 89bd046823b..199bda01e77 100644 --- a/apps/app-frontend/src/components/ui/skin/BakedSkinButton.vue +++ b/apps/app-frontend/src/components/ui/skin/BakedSkinButton.vue @@ -3,8 +3,8 @@ import { SkinButton } from '@modrinth/ui' import { useIntersectionObserver } from '@vueuse/core' import { computed, ref, watch } from 'vue' -import { acquireSkinPreview, getSkinPreviewKey } from '@/helpers/rendering/skin-previews' import type { Cape, Skin } from '@/helpers/skins' +import { renderSkinPreview } from '@/platform/app-lib/skins/commands' const props = defineProps<{ skin: Skin @@ -14,7 +14,12 @@ const props = defineProps<{ const button = ref>() const visible = ref(false) const url = ref() -const key = computed(() => getSkinPreviewKey(props.skin)) +const capeTexture = computed( + () => props.capes.find((cape) => cape.id === props.skin.cape_id)?.texture, +) +const key = computed( + () => `${props.skin.texture_key}+${props.skin.variant}+${capeTexture.value ?? 'no-cape'}`, +) useIntersectionObserver( button, @@ -25,19 +30,17 @@ useIntersectionObserver( ) watch( - [visible, key, () => props.capes], + [visible, key], ([isVisible], _, onCleanup) => { url.value = undefined if (!isVisible) return - const preview = acquireSkinPreview(props.skin, props.capes) let active = true onCleanup(() => { active = false - preview.release() }) - void preview.promise + void renderSkinPreview(props.skin, capeTexture.value) .then((result) => { - if (active) url.value = result?.forwards + if (active) url.value = result }) .catch((error) => console.warn('Could not load skin preview', error)) }, diff --git a/apps/app-frontend/src/components/ui/skin/EditSkinModal.vue b/apps/app-frontend/src/components/ui/skin/EditSkinModal.vue index ee32e2e9cc7..58c13b7f2dd 100644 --- a/apps/app-frontend/src/components/ui/skin/EditSkinModal.vue +++ b/apps/app-frontend/src/components/ui/skin/EditSkinModal.vue @@ -12,6 +12,7 @@ :variant="variant" :texture-src="previewSkin || ''" :ears-texture-src="uploadedTextureUrl?.original ?? currentSkin?.texture" + :ears-loader="getSkinEars" :cape-src="selectedCapeTexture" framing="modal" :initial-rotation="Math.PI / 8" @@ -159,6 +160,7 @@ import { type SkinModel, type SkinTextureUrl, } from '@/helpers/skins.ts' +import { getSkinEars } from '@/platform/app-lib/skins/commands' const CAPE_LIST_MAX_HEIGHT = 334 const messages = defineMessages({ diff --git a/apps/app-frontend/src/features/minecraft-accounts/accounts-card.vue b/apps/app-frontend/src/features/minecraft-accounts/accounts-card.vue index 70cc46e9ed1..651b377e82c 100644 --- a/apps/app-frontend/src/features/minecraft-accounts/accounts-card.vue +++ b/apps/app-frontend/src/features/minecraft-accounts/accounts-card.vue @@ -116,9 +116,9 @@ import { set_default_user, users, } from '@/helpers/auth' -import { getPlayerHeadUrl } from '@/helpers/rendering/player-head' import type { Skin } from '@/helpers/skins' import { get_available_skins } from '@/helpers/skins' +import { renderSkinHead } from '@/platform/app-lib/skins/commands' const { formatMessage } = useVIntl() const { handleError } = injectNotificationManager() @@ -143,17 +143,14 @@ let headRequest = 0 async function updateHeadUrl(skin: Skin | null) { const request = ++headRequest - if (equippedHeadUrl.value) URL.revokeObjectURL(equippedHeadUrl.value) equippedHeadUrl.value = undefined if (!skin) return - const url = await getPlayerHeadUrl(skin) - if (request !== headRequest) URL.revokeObjectURL(url) - else equippedHeadUrl.value = url + const url = await renderSkinHead(skin) + if (request === headRequest) equippedHeadUrl.value = url } onUnmounted(() => { headRequest++ - if (equippedHeadUrl.value) URL.revokeObjectURL(equippedHeadUrl.value) }) async function refreshValues() { diff --git a/apps/app-frontend/src/features/skins/legacy-preview-storage.ts b/apps/app-frontend/src/features/skins/legacy-preview-storage.ts new file mode 100644 index 00000000000..ea0ed8fe05f --- /dev/null +++ b/apps/app-frontend/src/features/skins/legacy-preview-storage.ts @@ -0,0 +1,10 @@ +/** Skin previews used to be cached in IndexedDB. app-lib caches them on disk now. */ +export function deleteLegacySkinPreviewStorage() { + for (const name of ['skin-previews', 'head-storage']) { + try { + indexedDB.deleteDatabase(name) + } catch (error) { + console.warn('Could not delete legacy skin preview storage', error) + } + } +} diff --git a/apps/app-frontend/src/helpers/rendering/batch-skin-renderer.ts b/apps/app-frontend/src/helpers/rendering/batch-skin-renderer.ts deleted file mode 100644 index 2b1d14137ce..00000000000 --- a/apps/app-frontend/src/helpers/rendering/batch-skin-renderer.ts +++ /dev/null @@ -1,223 +0,0 @@ -import { ClassicPlayerModel, SlimPlayerModel } from '@modrinth/assets' -import { loadSkinRendering } from '@modrinth/ui' -import * as THREE from 'three' - -import type { Cape, Skin } from '../skins' -import { determineModelType, get_normalized_skin_texture } from '../skins' - -export interface RenderResult { - forwards: string -} - -export interface RawRenderResult { - forwards: Blob -} - -class BatchSkinRenderer { - private renderer: THREE.WebGLRenderer | null = null - private scene: THREE.Scene | null = null - private camera: THREE.PerspectiveCamera | null = null - private currentModel: THREE.Group | null = null - private transparentTexture: THREE.Texture | null = null - private readonly width: number - private readonly height: number - - constructor( - private readonly rendering: Awaited>, - width: number = 360, - height: number = 504, - ) { - this.width = width - this.height = height - } - - private initializeRenderer(): void { - if (this.renderer) return - - const canvas = document.createElement('canvas') - canvas.width = this.width - canvas.height = this.height - - this.renderer = new THREE.WebGLRenderer({ - canvas: canvas, - antialias: true, - alpha: true, - preserveDrawingBuffer: true, - }) - - this.renderer.outputColorSpace = THREE.SRGBColorSpace - this.renderer.shadowMap.enabled = false - this.renderer.toneMapping = THREE.NoToneMapping - this.renderer.toneMappingExposure = 10.0 - this.renderer.setClearColor(0x000000, 0) - this.renderer.setSize(this.width, this.height) - - this.scene = new THREE.Scene() - this.camera = new THREE.PerspectiveCamera(20, this.width / this.height, 0.4, 1000) - - const ambientLight = new THREE.AmbientLight(0xffffff, 2) - const directionalLight = new THREE.DirectionalLight(0xffffff, 1.2) - directionalLight.castShadow = false - directionalLight.position.set(2, 4, 3) - this.scene.add(ambientLight) - this.scene.add(directionalLight) - } - - public async renderSkin( - textureUrl: string, - modelUrl: string, - capeUrl?: string, - earsTextureUrl?: string, - ): Promise { - this.initializeRenderer() - - this.clearScene() - - await this.setupModel(modelUrl, textureUrl, capeUrl, earsTextureUrl) - - const headPart = this.currentModel!.getObjectByName('Head') - let lookAtTarget: [number, number, number] - - if (headPart) { - const headPosition = new THREE.Vector3() - headPart.getWorldPosition(headPosition) - lookAtTarget = [headPosition.x, headPosition.y - 0.3, headPosition.z] - } else { - throw new Error("Failed to find 'Head' object in model.") - } - - const frontCameraPos: [number, number, number] = [-1.3, 1, 6.3] - const forwards = await this.renderView(frontCameraPos, lookAtTarget) - - return { forwards } - } - - private async renderView( - cameraPosition: [number, number, number], - lookAtPosition: [number, number, number], - ): Promise { - if (!this.camera || !this.renderer || !this.scene) { - throw new Error('Renderer not initialized') - } - - this.camera.position.set(...cameraPosition) - this.camera.lookAt(...lookAtPosition) - - this.renderer.render(this.scene, this.camera) - - return await new Promise((resolve, reject) => { - this.renderer!.domElement.toBlob( - (blob) => { - if (blob) { - resolve(blob) - } else { - reject(new Error('Failed to create blob from rendered canvas')) - } - }, - 'image/webp', - 0.9, - ) - }) - } - - private async setupModel( - modelUrl: string, - textureUrl: string, - capeUrl?: string, - earsTextureUrl?: string, - ): Promise { - if (!this.scene) { - throw new Error('Renderer not initialized') - } - - const [{ model }, earsTexture] = await Promise.all([ - this.rendering.setupSkinModel(modelUrl, textureUrl, capeUrl), - earsTextureUrl ? this.rendering.loadTexture(earsTextureUrl) : Promise.resolve(null), - ]) - - if (!capeUrl) { - this.rendering.applyCapeTexture(model, null, this.getTransparentTexture()) - } - - if (earsTexture) { - this.rendering.applyEarsMod(model, earsTexture) - } - - const group = new THREE.Group() - group.add(model) - group.position.set(0, 0.3, 1.95) - group.scale.set(0.8, 0.8, 0.8) - - this.scene.add(group) - this.currentModel = group - } - - private getTransparentTexture(): THREE.Texture { - if (!this.transparentTexture) { - this.transparentTexture = this.rendering.createTransparentTexture() - } - - return this.transparentTexture - } - - private clearScene(): void { - if (!this.scene || !this.currentModel) return - - this.rendering.removeEarsMod(this.currentModel) - this.scene.remove(this.currentModel) - this.currentModel.clear() - this.currentModel = null - } - - public dispose(): void { - this.clearScene() - - if (this.transparentTexture) { - this.transparentTexture.dispose() - this.transparentTexture = null - } - - if (this.renderer) { - this.renderer.dispose() - this.renderer.forceContextLoss() - } - - this.renderer = null - this.scene = null - this.camera = null - - this.rendering.disposeCaches() - } -} - -function getModelUrlForVariant(variant: string): string { - switch (variant) { - case 'SLIM': - return SlimPlayerModel - case 'CLASSIC': - case 'UNKNOWN': - default: - return ClassicPlayerModel - } -} - -let sharedRenderer: BatchSkinRenderer | null = null - -export function disposeSharedRenderer(): void { - sharedRenderer?.dispose() - sharedRenderer = null -} - -export async function renderSkinPreview(skin: Skin, capes: Cape[]): Promise { - sharedRenderer ??= new BatchSkinRenderer(await loadSkinRendering()) - const variant = - skin.variant === 'UNKNOWN' - ? await determineModelType(skin.texture).catch(() => 'CLASSIC') - : skin.variant - return sharedRenderer.renderSkin( - await get_normalized_skin_texture(skin), - getModelUrlForVariant(variant), - capes.find((cape) => cape.id === skin.cape_id)?.texture, - skin.texture, - ) -} diff --git a/apps/app-frontend/src/helpers/rendering/player-head.ts b/apps/app-frontend/src/helpers/rendering/player-head.ts deleted file mode 100644 index 4095d22b8db..00000000000 --- a/apps/app-frontend/src/helpers/rendering/player-head.ts +++ /dev/null @@ -1,109 +0,0 @@ -import type { Skin } from '../skins' -import { get_normalized_skin_texture } from '../skins' -import { headStorage } from '../storage/head-storage' - -export async function generatePlayerHeadBlob(skinUrl: string, size: number = 64): Promise { - return new Promise((resolve, reject) => { - const img = new Image() - img.crossOrigin = 'anonymous' - - img.onload = () => { - try { - const sourceCanvas = document.createElement('canvas') - const sourceCtx = sourceCanvas.getContext('2d') - - if (!sourceCtx) { - throw new Error('Could not get 2D context from source canvas') - } - - sourceCanvas.width = img.width - sourceCanvas.height = img.height - - sourceCtx.drawImage(img, 0, 0) - - const outputCanvas = document.createElement('canvas') - const outputCtx = outputCanvas.getContext('2d') - - if (!outputCtx) { - throw new Error('Could not get 2D context from output canvas') - } - - outputCanvas.width = size - outputCanvas.height = size - - outputCtx.imageSmoothingEnabled = false - - const headImageData = sourceCtx.getImageData(8, 8, 8, 8) - - const headCanvas = document.createElement('canvas') - const headCtx = headCanvas.getContext('2d') - - if (!headCtx) { - throw new Error('Could not get 2D context from head canvas') - } - - headCanvas.width = 8 - headCanvas.height = 8 - headCtx.putImageData(headImageData, 0, 0) - - outputCtx.drawImage(headCanvas, 0, 0, 8, 8, 0, 0, size, size) - - const hatImageData = sourceCtx.getImageData(40, 8, 8, 8) - - const hatCanvas = document.createElement('canvas') - const hatCtx = hatCanvas.getContext('2d') - - if (!hatCtx) { - throw new Error('Could not get 2D context from hat canvas') - } - - hatCanvas.width = 8 - hatCanvas.height = 8 - hatCtx.putImageData(hatImageData, 0, 0) - - const hatPixels = hatImageData.data - let hasHat = false - - for (let i = 3; i < hatPixels.length; i += 4) { - if (hatPixels[i] > 0) { - hasHat = true - break - } - } - - if (hasHat) { - outputCtx.drawImage(hatCanvas, 0, 0, 8, 8, 0, 0, size, size) - } - - outputCanvas.toBlob( - (blob) => { - if (blob) { - resolve(blob) - } else { - reject(new Error('Failed to create blob from canvas')) - } - }, - 'image/webp', - 0.9, - ) - } catch (error) { - reject(error) - } - } - - img.onerror = () => { - reject(new Error('Failed to load skin texture image')) - } - - img.src = skinUrl - }) -} - -export async function getPlayerHeadUrl(skin: Skin): Promise { - const key = `${skin.texture_key}-head` - const cached = await headStorage.retrieve(key).catch(() => null) - if (cached) return cached - const blob = await generatePlayerHeadBlob(await get_normalized_skin_texture(skin), 64) - await headStorage.store(key, blob).catch(() => {}) - return URL.createObjectURL(blob) -} diff --git a/apps/app-frontend/src/helpers/rendering/skin-previews.ts b/apps/app-frontend/src/helpers/rendering/skin-previews.ts deleted file mode 100644 index 0cffb50dc56..00000000000 --- a/apps/app-frontend/src/helpers/rendering/skin-previews.ts +++ /dev/null @@ -1,76 +0,0 @@ -import type { Cape, Skin } from '../skins' -import { headStorage } from '../storage/head-storage' -import { skinPreviewStorage } from '../storage/skin-preview-storage' -import type { RenderResult } from './batch-skin-renderer' - -interface PreviewEntry { - users: number - result?: RenderResult - promise: Promise -} - -const previews = new Map() -let renderQueue: Promise = Promise.resolve() -let pendingRenders = 0 - -export function getSkinPreviewKey(skin: Skin): string { - return `ears-2-fixed-uvs+${skin.texture_key}+${skin.variant}+${skin.cape_id ?? 'no-cape'}` -} - -export function acquireSkinPreview(skin: Skin, capes: Cape[]) { - const key = getSkinPreviewKey(skin) - let entry = previews.get(key) - if (!entry) { - const created: PreviewEntry = { users: 0, promise: Promise.resolve(undefined) } - created.promise = skinPreviewStorage - .retrieve(key) - .catch(() => null) - .then(async (cached) => { - if (created.users === 0) return - if (!cached) { - pendingRenders++ - const render = renderQueue - .then(async () => { - if (created.users === 0) return - const { renderSkinPreview } = await import('./batch-skin-renderer') - const result = await renderSkinPreview(skin, capes) - await skinPreviewStorage.store(key, result).catch(() => {}) - return result - }) - .finally(async () => { - if (--pendingRenders === 0) { - const { disposeSharedRenderer } = await import('./batch-skin-renderer') - if (pendingRenders === 0) disposeSharedRenderer() - } - }) - renderQueue = render.catch(() => {}) - cached = (await render) ?? null - } - if (!cached || created.users === 0) return - created.result = { forwards: URL.createObjectURL(cached.forwards) } - return created.result - }) - previews.set(key, created) - entry = created - } - const acquired = entry - acquired.users++ - let released = false - return { - promise: acquired.promise, - release: () => { - if (released) return - released = true - if (--acquired.users > 0) return - if (acquired.result) URL.revokeObjectURL(acquired.result.forwards) - if (previews.get(key) === acquired) previews.delete(key) - }, - } -} - -export async function cleanupUnusedPreviews(skins: Skin[]): Promise { - await Promise.all([ - skinPreviewStorage.cleanupInvalidKeys(new Set(skins.map(getSkinPreviewKey))), - headStorage.cleanupInvalidKeys(new Set(skins.map((skin) => `${skin.texture_key}-head`))), - ]) -} diff --git a/apps/app-frontend/src/helpers/storage/head-storage.ts b/apps/app-frontend/src/helpers/storage/head-storage.ts deleted file mode 100644 index a6eb0e6d0db..00000000000 --- a/apps/app-frontend/src/helpers/storage/head-storage.ts +++ /dev/null @@ -1,234 +0,0 @@ -interface StoredHead { - blob: Blob - timestamp: number -} - -export class HeadStorage { - private dbName = 'head-storage' - private version = 1 - private db: IDBDatabase | null = null - private opening: Promise | undefined - - async init(): Promise { - if (this.db) return - this.opening ??= new Promise((resolve, reject) => { - const request = indexedDB.open(this.dbName, this.version) - - request.onerror = () => reject(request.error) - request.onsuccess = () => { - this.db = request.result - resolve() - } - - request.onupgradeneeded = () => { - const db = request.result - if (!db.objectStoreNames.contains('heads')) { - db.createObjectStore('heads') - } - } - }).finally(() => { - this.opening = undefined - }) - return this.opening - } - - async store(key: string, blob: Blob): Promise { - if (!this.db) await this.init() - - const transaction = this.db!.transaction(['heads'], 'readwrite') - const store = transaction.objectStore('heads') - - const storedHead: StoredHead = { - blob, - timestamp: Date.now(), - } - - return new Promise((resolve, reject) => { - const request = store.put(storedHead, key) - - request.onsuccess = () => resolve() - request.onerror = () => reject(request.error) - }) - } - - async retrieve(key: string): Promise { - if (!this.db) await this.init() - - const transaction = this.db!.transaction(['heads'], 'readonly') - const store = transaction.objectStore('heads') - - return new Promise((resolve, reject) => { - const request = store.get(key) - - request.onsuccess = () => { - const result = request.result as StoredHead | undefined - - if (!result) { - resolve(null) - return - } - - const url = URL.createObjectURL(result.blob) - resolve(url) - } - request.onerror = () => reject(request.error) - }) - } - - async batchRetrieve(keys: string[]): Promise> { - if (!this.db) await this.init() - - const transaction = this.db!.transaction(['heads'], 'readonly') - const store = transaction.objectStore('heads') - const results: Record = {} - - return new Promise((resolve, _reject) => { - let completedRequests = 0 - - if (keys.length === 0) { - resolve(results) - return - } - - for (const key of keys) { - const request = store.get(key) - - request.onsuccess = () => { - const result = request.result as StoredHead | undefined - - if (result) { - results[key] = result.blob - } else { - results[key] = null - } - - completedRequests++ - if (completedRequests === keys.length) { - resolve(results) - } - } - - request.onerror = () => { - results[key] = null - completedRequests++ - if (completedRequests === keys.length) { - resolve(results) - } - } - } - }) - } - - async cleanupInvalidKeys(validKeys: Set): Promise { - if (!this.db) await this.init() - - const transaction = this.db!.transaction(['heads'], 'readwrite') - const store = transaction.objectStore('heads') - let deletedCount = 0 - - return new Promise((resolve, reject) => { - const request = store.openKeyCursor() - - request.onsuccess = (event) => { - const cursor = (event.target as IDBRequest).result - - if (cursor) { - const key = cursor.primaryKey as string - - if (!validKeys.has(key)) { - const deleteRequest = cursor.delete() - deleteRequest.onsuccess = () => { - deletedCount++ - } - deleteRequest.onerror = () => { - console.warn('Failed to delete invalid head entry:', key) - } - } - - cursor.continue() - } else { - resolve(deletedCount) - } - } - - request.onerror = () => reject(request.error) - }) - } - - async debugCalculateStorage(): Promise { - if (!this.db) await this.init() - - const transaction = this.db!.transaction(['heads'], 'readonly') - const store = transaction.objectStore('heads') - - let totalSize = 0 - let count = 0 - const entries: Array<{ key: string; size: number }> = [] - - return new Promise((resolve, reject) => { - const request = store.openCursor() - - request.onsuccess = (event) => { - const cursor = (event.target as IDBRequest).result - - if (cursor) { - const key = cursor.primaryKey as string - const value = cursor.value as StoredHead - - const entrySize = value.blob.size - totalSize += entrySize - count++ - - entries.push({ - key, - size: entrySize, - }) - - cursor.continue() - } else { - console.group('🗄️ Head Storage Debug Info') - console.log(`Total entries: ${count}`) - console.log(`Total size: ${(totalSize / 1024 / 1024).toFixed(2)} MB`) - console.log( - `Average size per entry: ${count > 0 ? (totalSize / count / 1024).toFixed(2) : 0} KB`, - ) - - if (entries.length > 0) { - const sortedEntries = entries.sort((a, b) => b.size - a.size) - console.log( - 'Largest entry:', - sortedEntries[0].key, - '(' + (sortedEntries[0].size / 1024).toFixed(2) + ' KB)', - ) - console.log( - 'Smallest entry:', - sortedEntries[sortedEntries.length - 1].key, - '(' + (sortedEntries[sortedEntries.length - 1].size / 1024).toFixed(2) + ' KB)', - ) - } - - console.groupEnd() - resolve() - } - } - - request.onerror = () => reject(request.error) - }) - } - - async clearAll(): Promise { - if (!this.db) await this.init() - - const transaction = this.db!.transaction(['heads'], 'readwrite') - const store = transaction.objectStore('heads') - - return new Promise((resolve, reject) => { - const request = store.clear() - - request.onsuccess = () => resolve() - request.onerror = () => reject(request.error) - }) - } -} - -export const headStorage = new HeadStorage() diff --git a/apps/app-frontend/src/helpers/storage/skin-preview-storage.ts b/apps/app-frontend/src/helpers/storage/skin-preview-storage.ts deleted file mode 100644 index c0fd9ce43e2..00000000000 --- a/apps/app-frontend/src/helpers/storage/skin-preview-storage.ts +++ /dev/null @@ -1,221 +0,0 @@ -import type { RawRenderResult } from '../rendering/batch-skin-renderer' - -interface StoredPreview { - forwards: Blob - timestamp: number -} - -export class SkinPreviewStorage { - private dbName = 'skin-previews' - private version = 1 - private db: IDBDatabase | null = null - private opening: Promise | undefined - - async init(): Promise { - if (this.db) return - this.opening ??= new Promise((resolve, reject) => { - const request = indexedDB.open(this.dbName, this.version) - - request.onerror = () => reject(request.error) - request.onsuccess = () => { - this.db = request.result - resolve() - } - - request.onupgradeneeded = () => { - const db = request.result - if (!db.objectStoreNames.contains('previews')) { - db.createObjectStore('previews') - } - } - }).finally(() => { - this.opening = undefined - }) - return this.opening - } - - async store(key: string, result: RawRenderResult): Promise { - if (!this.db) await this.init() - - const transaction = this.db!.transaction(['previews'], 'readwrite') - const store = transaction.objectStore('previews') - - const storedPreview: StoredPreview = { - forwards: result.forwards, - timestamp: Date.now(), - } - - return new Promise((resolve, reject) => { - const request = store.put(storedPreview, key) - - request.onsuccess = () => resolve() - request.onerror = () => reject(request.error) - }) - } - - async retrieve(key: string): Promise { - if (!this.db) await this.init() - - const transaction = this.db!.transaction(['previews'], 'readonly') - const store = transaction.objectStore('previews') - - return new Promise((resolve, reject) => { - const request = store.get(key) - - request.onsuccess = () => { - const result = request.result as StoredPreview | undefined - - if (!result) { - resolve(null) - return - } - - resolve({ forwards: result.forwards }) - } - request.onerror = () => reject(request.error) - }) - } - - async batchRetrieve(keys: string[]): Promise> { - if (!this.db) await this.init() - - const transaction = this.db!.transaction(['previews'], 'readonly') - const store = transaction.objectStore('previews') - const results: Record = {} - - return new Promise((resolve, _reject) => { - let completedRequests = 0 - - if (keys.length === 0) { - resolve(results) - return - } - - for (const key of keys) { - const request = store.get(key) - - request.onsuccess = () => { - const result = request.result as StoredPreview | undefined - - if (result) { - results[key] = { forwards: result.forwards } - } else { - results[key] = null - } - - completedRequests++ - if (completedRequests === keys.length) { - resolve(results) - } - } - - request.onerror = () => { - results[key] = null - completedRequests++ - if (completedRequests === keys.length) { - resolve(results) - } - } - } - }) - } - - async cleanupInvalidKeys(validKeys: Set): Promise { - if (!this.db) await this.init() - - const transaction = this.db!.transaction(['previews'], 'readwrite') - const store = transaction.objectStore('previews') - let deletedCount = 0 - - return new Promise((resolve, reject) => { - const request = store.openKeyCursor() - - request.onsuccess = (event) => { - const cursor = (event.target as IDBRequest).result - - if (cursor) { - const key = cursor.primaryKey as string - - if (!validKeys.has(key)) { - const deleteRequest = cursor.delete() - deleteRequest.onsuccess = () => { - deletedCount++ - } - deleteRequest.onerror = () => { - console.warn('Failed to delete invalid entry:', key) - } - } - - cursor.continue() - } else { - resolve(deletedCount) - } - } - - request.onerror = () => reject(request.error) - }) - } - - async debugCalculateStorage(): Promise { - if (!this.db) await this.init() - - const transaction = this.db!.transaction(['previews'], 'readonly') - const store = transaction.objectStore('previews') - - let totalSize = 0 - let count = 0 - const entries: Array<{ key: string; size: number }> = [] - - return new Promise((resolve, reject) => { - const request = store.openCursor() - - request.onsuccess = (event) => { - const cursor = (event.target as IDBRequest).result - - if (cursor) { - const key = cursor.primaryKey as string - const value = cursor.value as StoredPreview - - const entrySize = value.forwards.size - totalSize += entrySize - count++ - - entries.push({ - key, - size: entrySize, - }) - - cursor.continue() - } else { - console.group('🗄️ Skin Preview Storage Debug Info') - console.log(`Total entries: ${count}`) - console.log(`Total size: ${(totalSize / 1024 / 1024).toFixed(2)} MB`) - console.log( - `Average size per entry: ${count > 0 ? (totalSize / count / 1024).toFixed(2) : 0} KB`, - ) - - if (entries.length > 0) { - const sortedEntries = entries.sort((a, b) => b.size - a.size) - console.log( - 'Largest entry:', - sortedEntries[0].key, - '(' + (sortedEntries[0].size / 1024).toFixed(2) + ' KB)', - ) - console.log( - 'Smallest entry:', - sortedEntries[sortedEntries.length - 1].key, - '(' + (sortedEntries[sortedEntries.length - 1].size / 1024).toFixed(2) + ' KB)', - ) - } - - console.groupEnd() - resolve() - } - } - - request.onerror = () => reject(request.error) - }) - } -} - -export const skinPreviewStorage = new SkinPreviewStorage() diff --git a/apps/app-frontend/src/pages/Skins.vue b/apps/app-frontend/src/pages/Skins.vue index b10ea60daaa..63bc725bd86 100644 --- a/apps/app-frontend/src/pages/Skins.vue +++ b/apps/app-frontend/src/pages/Skins.vue @@ -32,10 +32,10 @@ import VirtualSkinSectionList from '@/components/ui/skin/VirtualSkinSectionList. import { useAppSettings } from '@/composables/use-app-settings.ts' import { handleSevereError } from '@/composables/use-error.js' import { injectMinecraftAccounts } from '@/features/minecraft-accounts/context' +import { deleteLegacySkinPreviewStorage } from '@/features/skins/legacy-preview-storage' import { trackEvent } from '@/helpers/analytics' import { check_reachable, get_default_user, login as login_flow, users } from '@/helpers/auth' import { listenNativeDragDrop, type NativeDragDropEvent } from '@/helpers/native-drag-drop' -import { cleanupUnusedPreviews } from '@/helpers/rendering/skin-previews' import type { Cape, Skin, SkinTextureUrl } from '@/helpers/skins.ts' import { equip_skin, @@ -53,6 +53,7 @@ import { set_custom_skin_order, } from '@/helpers/skins.ts' import { hasPride26Badge } from '@/helpers/user-campaigns.ts' +import { getSkinEars } from '@/platform/app-lib/skins/commands' import { useRootBreadcrumb } from '@/shared/breadcrumbs' import { appMessages } from '@/utils/app-messages' @@ -418,9 +419,6 @@ async function loadSkins() { shouldPreserveKnownEquippedSkin && locallyKnownEquippedSkin ? mergeEquippedSkin(loadedSkins, locallyKnownEquippedSkin) : loadedSkins - void cleanupUnusedPreviews(skins.value).catch((error) => - console.warn('Could not clean skin previews', error), - ) selectedSkin.value = skins.value.find((s) => s.is_equipped) ?? null originalSelectedSkin.value = selectedSkin.value } catch (error) { @@ -572,10 +570,6 @@ function removeLocalSkin(deletedSkin: Skin) { if (originalSelectedSkin.value && skinsMatch(originalSelectedSkin.value, deletedSkin)) { originalSelectedSkin.value = nextSkins.find((skin) => skin.is_equipped) ?? null } - - void cleanupUnusedPreviews(skins.value).catch((error) => - console.warn('Could not clean skin previews', error), - ) } function setLocallyEquippedSkin(skinToApply: Skin) { @@ -655,10 +649,6 @@ function updateLocalSkin(savedSkin: Skin, applied: boolean, previousSkin?: Skin) originalSelectedSkin.value = locallySavedSkin } } - - void cleanupUnusedPreviews(skins.value).catch((error) => - console.warn('Could not clean skin previews', error), - ) } async function reorderSavedSkins(orderedSkins: Skin[]) { @@ -674,18 +664,12 @@ async function reorderSavedSkins(orderedSkins: Skin[]) { const nextSavedSkins = [...orderedSkins, ...remainingSavedSkins] skins.value = [...nextSavedSkins, ...defaultSkins] - void cleanupUnusedPreviews(skins.value).catch((error) => - console.warn('Could not clean skin previews', error), - ) try { const persistedSavedSkins = await preserveExternalSkins(nextSavedSkins) if (persistedSavedSkins.some((skin, index) => skin !== nextSavedSkins[index])) { skins.value = [...persistedSavedSkins, ...defaultSkins] - void cleanupUnusedPreviews(skins.value).catch((error) => - console.warn('Could not clean skin previews', error), - ) } await set_custom_skin_order( @@ -697,9 +681,6 @@ async function reorderSavedSkins(orderedSkins: Skin[]) { skins.value = previousSkins selectedSkin.value = previousSelectedSkin originalSelectedSkin.value = previousOriginalSelectedSkin - void cleanupUnusedPreviews(skins.value).catch((error) => - console.warn('Could not clean skin previews', error), - ) addNotification({ type: 'error', title: formatMessage(messages.reorderSkinErrorTitle), @@ -1032,6 +1013,7 @@ onMounted(() => { window.addEventListener('online', onOnline) userCheckInterval = window.setInterval(checkUserChanges, 250) void setupAddSkinDragDropListener() + deleteLegacySkinPreviewStorage() }) onUnmounted(() => { @@ -1118,6 +1100,7 @@ await loadSkins() :cape-src="capeTexture" :texture-src="skinTexture || ''" :ears-texture-src="selectedSkin?.texture" + :ears-loader="getSkinEars" :variant="skinVariant" :nametag="skinNametag" :initial-rotation="Math.PI / 8" diff --git a/apps/app-frontend/src/platform/app-lib/skins/commands.ts b/apps/app-frontend/src/platform/app-lib/skins/commands.ts new file mode 100644 index 00000000000..1a03a58f6ec --- /dev/null +++ b/apps/app-frontend/src/platform/app-lib/skins/commands.ts @@ -0,0 +1,19 @@ +import type { SkinEarsData } from '@modrinth/ui' +import { invoke } from '@tauri-apps/api/core' + +import type { Skin } from '@/helpers/skins' + +/** Returns the asset URL of the skin's full-body preview, rendering it if it is not cached. */ +export function renderSkinPreview(skin: Skin, capeTexture?: string): Promise { + return invoke('plugin:minecraft-skins|render_skin_preview', { skin, capeTexture }) +} + +/** Returns the asset URL of the skin's head image, rendering it if it is not cached. */ +export function renderSkinHead(skin: Skin): Promise { + return invoke('plugin:minecraft-skins|render_skin_head', { skin }) +} + +/** Resolves to `null` if the texture has no Ears data. */ +export function getSkinEars(texture: string, slim: boolean): Promise { + return invoke('plugin:minecraft-skins|get_skin_ears', { texture, slim }) +} diff --git a/apps/app/build.rs b/apps/app/build.rs index 5413d1ba5a1..e26b8a28cf8 100644 --- a/apps/app/build.rs +++ b/apps/app/build.rs @@ -123,6 +123,9 @@ fn main() { "flush_pending_skin_change_for_profile", "normalize_skin_texture", "get_dragged_skin_data", + "render_skin_preview", + "render_skin_head", + "get_skin_ears", ]) .default_permission( DefaultPermissionRule::AllowAllCommands, diff --git a/apps/app/src/api/minecraft_skins.rs b/apps/app/src/api/minecraft_skins.rs index 0f190f4f530..c28544e8253 100644 --- a/apps/app/src/api/minecraft_skins.rs +++ b/apps/app/src/api/minecraft_skins.rs @@ -2,8 +2,11 @@ use crate::api::Result; use std::path::Path; use theseus::minecraft_skins::{ - self, Bytes, Cape, MinecraftSkinVariant, Skin, UrlOrBlob, + self, Bytes, Cape, MinecraftSkinVariant, Skin, SkinEars, UrlOrBlob, }; +use url::Url; + +use super::utils::tauri_convert_file_src; pub fn init() -> tauri::plugin::TauriPlugin { tauri::plugin::Builder::new("minecraft-skins") @@ -20,6 +23,9 @@ pub fn init() -> tauri::plugin::TauriPlugin { flush_pending_skin_change_for_profile, normalize_skin_texture, get_dragged_skin_data, + render_skin_preview, + render_skin_head, + get_skin_ears, ]) .build() } @@ -145,3 +151,37 @@ pub async fn get_dragged_skin_data(path: String) -> Result { let path = Path::new(&path); Ok(minecraft_skins::get_dragged_skin_data(path).await?) } + +/// `invoke('plugin:minecraft-skins|render_skin_preview', skin, cape_texture)` +/// +/// See also: [minecraft_skins::render_skin_preview] +#[tauri::command] +pub async fn render_skin_preview( + skin: Skin, + cape_texture: Option, +) -> Result { + let path = + minecraft_skins::render_skin_preview(&skin, cape_texture.as_ref()) + .await?; + Ok(tauri_convert_file_src(&path)?.to_string()) +} + +/// `invoke('plugin:minecraft-skins|render_skin_head', skin)` +/// +/// See also: [minecraft_skins::render_skin_head] +#[tauri::command] +pub async fn render_skin_head(skin: Skin) -> Result { + let path = minecraft_skins::render_skin_head(&skin).await?; + Ok(tauri_convert_file_src(&path)?.to_string()) +} + +/// `invoke('plugin:minecraft-skins|get_skin_ears', texture, slim)` +/// +/// See also: [minecraft_skins::get_skin_ears] +#[tauri::command] +pub async fn get_skin_ears( + texture: UrlOrBlob, + slim: bool, +) -> Result> { + Ok(minecraft_skins::get_skin_ears(&texture, slim).await?) +} diff --git a/apps/app/src/main.rs b/apps/app/src/main.rs index 5347d24003a..b52793c5dd8 100644 --- a/apps/app/src/main.rs +++ b/apps/app/src/main.rs @@ -45,6 +45,14 @@ async fn initialize_state( app.fs_scope() .allow_directory(state.directories.instances_dir(), true)?; + tauri::async_runtime::spawn(async { + if let Err(error) = + theseus::minecraft_skins::prewarm_skin_previews().await + { + tracing::warn!("Failed to prewarm skin previews: {error}"); + } + }); + Ok(()) } diff --git a/packages/app-lib/Cargo.toml b/packages/app-lib/Cargo.toml index 816d7ee487e..c5885040d65 100644 --- a/packages/app-lib/Cargo.toml +++ b/packages/app-lib/Cargo.toml @@ -48,6 +48,7 @@ itertools = { workspace = true } json5 = { workspace = true } minecraft-meta-manifest = { workspace = true } modrinth-content-management = { workspace = true } +modrinth-skin-rendering = { workspace = true, features = ["serde"] } notify = { workspace = true } notify-debouncer-mini = { workspace = true } p256 = { workspace = true, features = ["ecdsa"] } diff --git a/packages/app-lib/src/api/minecraft_skins.rs b/packages/app-lib/src/api/minecraft_skins.rs index 6e44ede1178..822bf330ac3 100644 --- a/packages/app-lib/src/api/minecraft_skins.rs +++ b/packages/app-lib/src/api/minecraft_skins.rs @@ -83,6 +83,13 @@ mod assets { } mod png_util; +mod render_cache; +mod rendering; + +pub use rendering::{ + SkinEars, get_skin_ears, prewarm_skin_previews, render_skin_head, + render_skin_preview, +}; const SKIN_CHANGE_DEBOUNCE: Duration = Duration::from_secs(10); diff --git a/packages/app-lib/src/api/minecraft_skins/png_util.rs b/packages/app-lib/src/api/minecraft_skins/png_util.rs index 28cc795df69..d45fdf82472 100644 --- a/packages/app-lib/src/api/minecraft_skins/png_util.rs +++ b/packages/app-lib/src/api/minecraft_skins/png_util.rs @@ -139,11 +139,10 @@ pub async fn normalize_skin_texture( let is_legacy_skin = png_reader.info().height == 32; let mut texture_buf = get_skin_texture_buffer(&mut png_reader, is_legacy_skin)?; - if is_legacy_skin { - convert_legacy_skin_texture(&mut texture_buf, png_reader.info()); - do_notch_transparency_hack(&mut texture_buf, png_reader.info()); - } - make_inner_parts_opaque(&mut texture_buf, png_reader.info()); + modrinth_skin_rendering::normalize_skin_pixels( + bytemuck::cast_slice_mut(&mut texture_buf), + is_legacy_skin, + ); let mut encoded_png = vec![]; @@ -197,7 +196,7 @@ fn get_skin_texture_buffer( }; png_reader.next_frame(&mut png_buf)?; - let mut texture_buf = match png_reader.output_color_type().0 { + Ok(match png_reader.output_color_type().0 { png::ColorType::Grayscale => png_buf .iter() .map(|&value| Rgba { @@ -228,149 +227,7 @@ fn get_skin_texture_buffer( png::ColorType::Rgba => bytemuck::try_cast_vec(png_buf) .map_err(|_| ErrorKind::InvalidPng)?, _ => bail!(ErrorKind::InvalidPng), // Cannot happen by PNG spec after transformations - }; - - // Make the added bottom half of the expanded legacy skin buffer transparent - if is_legacy_skin { - set_alpha(&mut texture_buf, png_reader.info(), 0, 32, 64, 64, 0); - } - - Ok(texture_buf) -} - -/// Converts a legacy skin texture (32x64 pixels) within a 64x64 buffer to the -/// native 64x64 format used by modern Minecraft clients. -/// -/// See also 25w16a's `SkinTextureDownloader#processLegacySkin` method. -#[inline] -fn convert_legacy_skin_texture( - texture_buf: &mut [Rgba], - texture_info: &png::Info, -) { - /// The skin faces the game client copies around, in order, when converting a - /// legacy skin to the native 64x64 format. - const FACE_COPY_PARAMETERS: &[( - usize, - usize, - isize, - isize, - usize, - usize, - )] = &[ - (4, 16, 16, 32, 4, 4), - (8, 16, 16, 32, 4, 4), - (0, 20, 24, 32, 4, 12), - (4, 20, 16, 32, 4, 12), - (8, 20, 8, 32, 4, 12), - (12, 20, 16, 32, 4, 12), - (44, 16, -8, 32, 4, 4), - (48, 16, -8, 32, 4, 4), - (40, 20, 0, 32, 4, 12), - (44, 20, -8, 32, 4, 12), - (48, 20, -16, 32, 4, 12), - (52, 20, -8, 32, 4, 12), - ]; - - for (x, y, off_x, off_y, width, height) in FACE_COPY_PARAMETERS { - copy_rect_mirror_horizontally( - texture_buf, - texture_info, - *x, - *y, - *off_x, - *off_y, - *width, - *height, - ) - } -} - -/// Makes outer head layer transparent if every pixel has alpha greater or equal to 128. -/// -/// See also 25w16a's `SkinTextureDownloader#doNotchTransparencyHack` method. -fn do_notch_transparency_hack( - texture_buf: &mut [Rgba], - texture_info: &png::Info, -) { - // The skin part the game client makes transparent - let (x1, y1, x2, y2) = (32, 0, 64, 32); - - for y in y1..y2 { - for x in x1..x2 { - if texture_buf[x + y * texture_info.width as usize].a < 128 { - return; - } - } - } - - set_alpha(texture_buf, texture_info, x1, y1, x2, y2, 0); -} - -/// Makes inner parts of a skin texture opaque. -/// -/// See also 25w16a's `SkinTextureDownloader#processLegacySkin` method. -#[inline] -fn make_inner_parts_opaque( - texture_buf: &mut [Rgba], - texture_info: &png::Info, -) { - /// The skin parts the game client makes opaque. - const OPAQUE_PART_PARAMETERS: &[(usize, usize, usize, usize)] = - &[(0, 0, 32, 16), (0, 16, 64, 32), (16, 48, 48, 64)]; - - for (x1, y1, x2, y2) in OPAQUE_PART_PARAMETERS { - set_alpha(texture_buf, texture_info, *x1, *y1, *x2, *y2, 255); - } -} - -/// Copies a `width` pixels wide, `height` pixels tall rectangle of pixels within `texture_buf` -/// whose top-left corner is at coordinates `(x, y)` to a destination rectangle whose top-left -/// corner is at coordinates `(x + off_x, y + off_y)`, while mirroring (i.e., flipping) the -/// pixels horizontally. -/// -/// Equivalent to Mojang's Blaze3D `NativeImage#copyRect(int, int, int, int, int, int, -/// boolean, boolean)` method, but with the last two parameters fixed to `true` and `false`, -/// respectively. -#[allow(clippy::too_many_arguments)] -fn copy_rect_mirror_horizontally( - texture_buf: &mut [Rgba], - texture_info: &png::Info, - x: usize, - y: usize, - off_x: isize, - off_y: isize, - width: usize, - height: usize, -) { - for row in 0..height { - for col in 0..width { - let src_x = x + col; - let src_y = y + row; - let dst_x = (x as isize + off_x) as usize + (width - 1 - col); - let dst_y = (y as isize + off_y) as usize + row; - - texture_buf[dst_x + dst_y * texture_info.width as usize] = - texture_buf[src_x + src_y * texture_info.width as usize]; - } - } -} - -/// Sets alpha for every pixel of a rectangle within `texture_buf` -/// whose top-left corner is at `(x1, y1)` and bottom-right corner is at `(x2 - 1, y2 - 1)`. -fn set_alpha( - texture_buf: &mut [Rgba], - texture_info: &png::Info, - x1: usize, - y1: usize, - x2: usize, - y2: usize, - alpha: u8, -) { - for y in y1..y2 { - for x in x1..x2 { - texture_buf[x + y * texture_info.width as usize].a = alpha; - } - } + }) } #[cfg(test)] diff --git a/packages/app-lib/src/api/minecraft_skins/render_cache.rs b/packages/app-lib/src/api/minecraft_skins/render_cache.rs new file mode 100644 index 00000000000..d8a5d39a003 --- /dev/null +++ b/packages/app-lib/src/api/minecraft_skins/render_cache.rs @@ -0,0 +1,214 @@ +use std::fmt; +use std::io; +use std::path::{Path, PathBuf}; +use std::sync::atomic::{AtomicU64, Ordering}; +use std::time::SystemTime; + +use modrinth_skin_rendering::RENDERER_VERSION; +use sha2::{Digest, Sha256}; + +/// A hash of its fields and [`RENDERER_VERSION`]. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] +pub struct CacheKey([u8; 32]); + +impl CacheKey { + pub fn builder() -> CacheKeyBuilder { + let mut builder = CacheKeyBuilder(Sha256::new()); + builder.update(&RENDERER_VERSION.to_le_bytes()); + builder + } +} + +impl fmt::Display for CacheKey { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + for byte in self.0 { + write!(formatter, "{byte:02x}")?; + } + Ok(()) + } +} + +pub struct CacheKeyBuilder(Sha256); + +impl CacheKeyBuilder { + pub fn field(mut self, bytes: impl AsRef<[u8]>) -> Self { + self.update(bytes.as_ref()); + self + } + + pub fn finish(self) -> CacheKey { + CacheKey(self.0.finalize().into()) + } + + fn update(&mut self, bytes: &[u8]) { + self.0.update((bytes.len() as u64).to_le_bytes()); + self.0.update(bytes); + } +} + +#[derive(Clone, Debug)] +pub struct DirCache { + directory: PathBuf, + extension: String, +} + +impl DirCache { + pub fn new( + directory: impl Into, + extension: impl Into, + ) -> Self { + Self { + directory: directory.into(), + extension: extension.into(), + } + } + + pub fn path(&self, key: &CacheKey) -> PathBuf { + self.directory.join(format!("{key}.{}", self.extension)) + } + + /// Updates the file's modification time, which [`DirCache::prune`] reads as last use. + pub fn lookup(&self, key: &CacheKey) -> Option { + let path = self.path(key); + if !path.is_file() { + return None; + } + if let Ok(file) = std::fs::File::options().write(true).open(&path) { + let _ = file.set_modified(SystemTime::now()); + } + Some(path) + } + + pub fn store(&self, key: &CacheKey, image: &[u8]) -> io::Result { + std::fs::create_dir_all(&self.directory)?; + let path = self.path(key); + static WRITES: AtomicU64 = AtomicU64::new(0); + let temporary = self.directory.join(format!( + "{key}.{}.{}.tmp", + std::process::id(), + WRITES.fetch_add(1, Ordering::Relaxed) + )); + std::fs::write(&temporary, image)?; + if let Err(error) = std::fs::rename(&temporary, &path) { + let _ = std::fs::remove_file(&temporary); + return Err(error); + } + Ok(path) + } + + /// Deletes least recently used files until the directory is at most `max_bytes`. + pub fn prune(&self, max_bytes: u64) -> io::Result<()> { + let mut files = Vec::new(); + let entries = match std::fs::read_dir(&self.directory) { + Ok(entries) => entries, + Err(error) if error.kind() == io::ErrorKind::NotFound => { + return Ok(()); + } + Err(error) => return Err(error), + }; + for entry in entries { + let entry = entry?; + let metadata = entry.metadata()?; + if metadata.is_file() { + files.push(( + metadata.modified().unwrap_or(SystemTime::UNIX_EPOCH), + metadata.len(), + entry.path(), + )); + } + } + + let mut total: u64 = files.iter().map(|(_, size, _)| size).sum(); + files.sort(); + for (_, size, path) in files { + if total <= max_bytes { + break; + } + remove_cached_file(&path)?; + total -= size; + } + Ok(()) + } +} + +fn remove_cached_file(path: &Path) -> io::Result<()> { + match std::fs::remove_file(path) { + Err(error) if error.kind() != io::ErrorKind::NotFound => Err(error), + _ => Ok(()), + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn key(fields: &[&str]) -> CacheKey { + fields + .iter() + .fold(CacheKey::builder(), |builder, field| builder.field(field)) + .finish() + } + + fn scratch_directory(name: &str) -> PathBuf { + let directory = std::env::temp_dir().join(format!( + "modrinth-skin-render-cache-{name}-{}", + std::process::id() + )); + let _ = std::fs::remove_dir_all(&directory); + directory + } + + #[test] + fn keys_depend_on_field_boundaries_and_content() { + assert_eq!(key(&["a", "b"]), key(&["a", "b"])); + assert_ne!(key(&["ab", "c"]), key(&["a", "bc"])); + assert_ne!(key(&["a"]), key(&["b"])); + assert_eq!(key(&["a"]).to_string().len(), 64); + } + + #[test] + fn stored_images_can_be_looked_up() { + let directory = scratch_directory("round-trip"); + let cache = DirCache::new(&directory, "png"); + let key = key(&["skin"]); + + assert!(cache.lookup(&key).is_none()); + let path = cache.store(&key, b"image").unwrap(); + assert_eq!(cache.lookup(&key), Some(path.clone())); + assert_eq!(std::fs::read(path).unwrap(), b"image"); + assert_eq!(std::fs::read_dir(&directory).unwrap().count(), 1); + + std::fs::remove_dir_all(directory).unwrap(); + } + + #[test] + fn pruning_removes_the_least_recently_used_files_first() { + let directory = scratch_directory("prune"); + let cache = DirCache::new(&directory, "png"); + let keys = [key(&["old"]), key(&["middle"]), key(&["new"])]; + for (age, key) in keys.iter().enumerate() { + let path = cache.store(key, &[0; 10]).unwrap(); + let modified = SystemTime::UNIX_EPOCH + + std::time::Duration::from_secs(1_000 + age as u64); + std::fs::File::options() + .write(true) + .open(path) + .unwrap() + .set_modified(modified) + .unwrap(); + } + + cache.prune(25).unwrap(); + assert!(!cache.path(&keys[0]).exists()); + assert!(cache.path(&keys[1]).exists()); + assert!(cache.path(&keys[2]).exists()); + + cache.prune(0).unwrap(); + assert_eq!(std::fs::read_dir(&directory).unwrap().count(), 0); + DirCache::new(directory.join("missing"), "png") + .prune(0) + .unwrap(); + + std::fs::remove_dir_all(directory).unwrap(); + } +} diff --git a/packages/app-lib/src/api/minecraft_skins/rendering.rs b/packages/app-lib/src/api/minecraft_skins/rendering.rs new file mode 100644 index 00000000000..73d4ace3705 --- /dev/null +++ b/packages/app-lib/src/api/minecraft_skins/rendering.rs @@ -0,0 +1,368 @@ +use std::path::PathBuf; +use std::sync::atomic::{AtomicU64, Ordering}; +use std::sync::{Arc, LazyLock}; + +use base64::Engine; +use bytes::Bytes; +use futures::TryStreamExt; +use modrinth_skin_rendering::{ + ArmModel, BodyPart, Camera, Mat4, Model, RenderOptions, Scene, SkinTexture, + Texture, Vec3, + ears::{Ears, EarsQuad, TexturePair}, + render, render_face, +}; +use serde::Serialize; +use tokio::sync::{OnceCell, Semaphore}; +use url::Url; + +use super::render_cache::{CacheKey, DirCache}; +use super::{MinecraftSkinVariant, Skin, UrlOrBlob, png_util}; +use crate::State; + +const CACHE_FOLDER_NAME: &str = "skin-renders"; +const CACHE_LIMIT_BYTES: u64 = 64 * 1024 * 1024; +const PRUNE_INTERVAL_BYTES: u64 = CACHE_LIMIT_BYTES / 8; +const PREVIEW_WIDTH: u32 = 360; +const PREVIEW_HEIGHT: u32 = 504; +const HEAD_SIZE: u32 = 64; + +/// Part of the cache key. Bump when preview framing or lighting changes. +const PREVIEW_STYLE: &str = "preview-1"; +const HEAD_STYLE: &str = "head-1"; + +static RENDER_WORKERS: Semaphore = Semaphore::const_new(2); +static CACHE_PRUNED: OnceCell<()> = OnceCell::const_new(); +static BYTES_SINCE_PRUNE: AtomicU64 = AtomicU64::new(0); + +static CLASSIC_MODEL: LazyLock = LazyLock::new(|| { + Model::from_gltf(include_bytes!( + "../../../../assets/models/classic-player.gltf" + )) + .expect("bundled classic player model is valid") +}); +static SLIM_MODEL: LazyLock = LazyLock::new(|| { + Model::from_gltf(include_bytes!( + "../../../../assets/models/slim-player.gltf" + )) + .expect("bundled slim player model is valid") +}); + +#[derive(Serialize, Debug, Clone)] +pub struct SkinEarsTexture { + pub width: u32, + pub height: u32, + /// Base64. + pub rgba: String, +} + +#[derive(Serialize, Debug, Clone)] +pub struct SkinEarsTexturePair { + pub base: SkinEarsTexture, + pub emissive: Option, +} + +#[derive(Serialize, Debug, Clone)] +pub struct SkinEars { + pub skin: SkinEarsTexturePair, + pub displaced_skin: Option, + pub wing: Option, + pub cape: Option, + pub quads: Vec, +} + +impl From<&Texture> for SkinEarsTexture { + fn from(texture: &Texture) -> Self { + Self { + width: texture.width(), + height: texture.height(), + rgba: base64::engine::general_purpose::STANDARD + .encode(texture.as_rgba8()), + } + } +} + +impl From<&TexturePair> for SkinEarsTexturePair { + fn from(pair: &TexturePair) -> Self { + Self { + base: (&pair.base).into(), + emissive: pair.emissive.as_ref().map(Into::into), + } + } +} + +/// Returns the path of the cached preview image, rendering it first if needed. +#[tracing::instrument(skip(skin), fields(texture_key = %skin.texture_key))] +pub async fn render_skin_preview( + skin: &Skin, + cape_texture: Option<&Url>, +) -> crate::Result { + let key = CacheKey::builder() + .field(PREVIEW_STYLE) + .field(skin.texture_key.as_bytes()) + .field(format!("{:?}", skin.variant)) + .field(cape_texture.map_or("", Url::as_str)) + .finish(); + + let cache = cache().await?; + if let Some(path) = cache.lookup(&key) { + return Ok(path); + } + + let texture = fetch_texture(&skin.texture).await?; + let cape = match cape_texture { + Some(url) => Some(fetch_texture(url).await?), + None => None, + }; + let variant = skin.variant; + + render_to_cache(cache, key, move || { + let skin = SkinTexture::from_png(&texture)?; + let cape = cape.map(|cape| Texture::from_png(&cape)).transpose()?; + let model = match variant { + MinecraftSkinVariant::Classic => &*CLASSIC_MODEL, + MinecraftSkinVariant::Slim => &*SLIM_MODEL, + MinecraftSkinVariant::Unknown => match skin.detect_arm_model() { + ArmModel::Classic => &*CLASSIC_MODEL, + ArmModel::Slim => &*SLIM_MODEL, + }, + }; + Ok(render_preview(model, &skin, cape.as_ref())) + }) + .await +} + +/// Renders the preview of every available skin that is not cached yet, one at a time. +#[tracing::instrument] +pub async fn prewarm_skin_previews() -> crate::Result<()> { + let (skins, capes) = tokio::join!( + super::get_available_skins(), + super::get_available_capes() + ); + let skins = skins?; + let capes = capes.unwrap_or_default(); + + for skin in &skins { + let cape_texture = skin.cape_id.and_then(|cape_id| { + capes + .iter() + .find(|cape| cape.id == cape_id) + .map(|cape| &*cape.texture) + }); + if let Err(error) = render_skin_preview(skin, cape_texture).await { + tracing::warn!( + texture_key = %skin.texture_key, + "Failed to prewarm skin preview: {error}" + ); + } + } + + Ok(()) +} + +/// Returns the path of the cached head image, rendering it first if needed. +#[tracing::instrument(skip(skin), fields(texture_key = %skin.texture_key))] +pub async fn render_skin_head(skin: &Skin) -> crate::Result { + let key = CacheKey::builder() + .field(HEAD_STYLE) + .field(skin.texture_key.as_bytes()) + .finish(); + + let cache = cache().await?; + if let Some(path) = cache.lookup(&key) { + return Ok(path); + } + + let texture = fetch_texture(&skin.texture).await?; + render_to_cache(cache, key, move || { + Ok(render_face(&SkinTexture::from_png(&texture)?, HEAD_SIZE)) + }) + .await +} + +/// `None` if the texture has no Ears data. +#[tracing::instrument(skip(texture))] +pub async fn get_skin_ears( + texture: &UrlOrBlob, + slim: bool, +) -> crate::Result> { + let texture = match texture { + UrlOrBlob::Url(url) => fetch_texture(url).await?, + UrlOrBlob::Blob(blob) => Bytes::clone(blob), + }; + + tokio::task::spawn_blocking(move || { + let skin = SkinTexture::from_png(&texture)?; + Ok(Ears::build(&skin, slim).map(|ears| SkinEars { + skin: (&ears.skin).into(), + displaced_skin: ears.displaced_skin.as_ref().map(Into::into), + wing: ears.wing.as_ref().map(Into::into), + cape: ears.cape.as_ref().map(Into::into), + quads: ears.quads, + })) + }) + .await? +} + +fn render_preview( + model: &Model, + skin: &SkinTexture, + cape: Option<&Texture>, +) -> Texture { + let placement = Mat4::from_translation(Vec3::new(0.0, 0.3, 1.95)) + * Mat4::from_scale(Vec3::splat(0.8)); + let head = placement.transform_point3( + model + .node_position(BodyPart::Head) + .unwrap_or(Vec3::new(0.0, 1.5, 0.0)), + ); + + let mut scene = Scene::build(model, skin, cape); + scene.transform(&placement); + + render( + &scene, + &Camera { + position: Vec3::new(-1.3, 1.0, 6.3), + target: head - Vec3::new(0.0, 0.3, 0.0), + up: Vec3::Y, + fov_y_degrees: 20.0, + near: 0.4, + far: 1000.0, + }, + &RenderOptions { + width: PREVIEW_WIDTH, + height: PREVIEW_HEIGHT, + ..RenderOptions::default() + }, + ) +} + +async fn cache() -> crate::Result> { + let state = State::get().await?; + let cache = Arc::new(DirCache::new( + state.directories.caches_dir().join(CACHE_FOLDER_NAME), + "png", + )); + + CACHE_PRUNED + .get_or_init(|| async { + let cache = Arc::clone(&cache); + let _ = + tokio::task::spawn_blocking(move || prune_cache(&cache)).await; + }) + .await; + + Ok(cache) +} + +async fn render_to_cache( + cache: Arc, + key: CacheKey, + draw: impl FnOnce() -> crate::Result + Send + 'static, +) -> crate::Result { + let permit = RENDER_WORKERS.acquire().await?; + tokio::task::spawn_blocking(move || { + let _permit = permit; + if let Some(path) = cache.lookup(&key) { + return Ok(path); + } + let png = draw()?.to_png()?; + let path = cache.store(&key, &png)?; + let written = png.len() as u64; + if BYTES_SINCE_PRUNE.fetch_add(written, Ordering::Relaxed) + written + >= PRUNE_INTERVAL_BYTES + { + BYTES_SINCE_PRUNE.store(0, Ordering::Relaxed); + prune_cache(&cache); + } + Ok(path) + }) + .await? +} + +fn prune_cache(cache: &DirCache) { + if let Err(error) = cache.prune(CACHE_LIMIT_BYTES) { + tracing::warn!("Failed to prune skin render cache: {error}"); + } +} + +async fn fetch_texture(url: &Url) -> crate::Result { + let texture = png_util::url_to_data_stream(url) + .await? + .try_fold(Vec::new(), |mut texture, chunk| async move { + texture.extend_from_slice(&chunk); + Ok(texture) + }) + .await?; + Ok(texture.into()) +} + +#[cfg(test)] +mod tests { + use super::*; + + fn test_skin(name: &str) -> SkinTexture { + let png: &[u8] = match name { + "legacy" => include_bytes!("assets/test/legacy.png"), + "notch" => include_bytes!("assets/test/notch.png"), + _ => include_bytes!("assets/test/transparent.png"), + }; + SkinTexture::from_png(png).unwrap() + } + + fn opaque_pixels(image: &Texture) -> usize { + image + .pixels() + .iter() + .filter(|pixel| pixel[3] == 255) + .count() + } + + #[test] + fn bundled_models_have_every_body_part_the_renderer_looks_for() { + for model in [&*CLASSIC_MODEL, &*SLIM_MODEL] { + for part in BodyPart::ALL { + assert!( + model.base_mesh_bounds(part).is_some(), + "missing {part:?}" + ); + } + } + + let arm_width = |model: &Model| { + let bounds = model.base_mesh_bounds(BodyPart::RightArm).unwrap(); + ((bounds.max.x - bounds.min.x) * 16.0).round() + }; + assert_eq!(arm_width(&CLASSIC_MODEL), 4.0); + assert_eq!(arm_width(&SLIM_MODEL), 3.0); + } + + #[test] + fn previews_show_the_player_centered_on_a_transparent_background() { + for name in ["legacy", "notch", "transparent"] { + let image = render_preview(&CLASSIC_MODEL, &test_skin(name), None); + assert_eq!( + (image.width(), image.height()), + (PREVIEW_WIDTH, PREVIEW_HEIGHT) + ); + assert_eq!(image.get(0, 0)[3], 0, "{name}"); + assert_eq!(image.get(PREVIEW_WIDTH - 1, 0)[3], 0, "{name}"); + assert_eq!(image.get(180, 250)[3], 255, "{name}"); + + let coverage = opaque_pixels(&image) as f32 + / (PREVIEW_WIDTH * PREVIEW_HEIGHT) as f32; + assert!((0.3..0.7).contains(&coverage), "{name}: {coverage}"); + } + } + + #[test] + fn capes_add_to_the_preview_only_when_given() { + let skin = test_skin("notch"); + let cape = + Texture::from_pixels(64, 32, vec![[200, 30, 30, 255]; 64 * 32]) + .unwrap(); + let without = render_preview(&CLASSIC_MODEL, &skin, None); + let with = render_preview(&CLASSIC_MODEL, &skin, Some(&cape)); + assert!(opaque_pixels(&with) > opaque_pixels(&without)); + } +} diff --git a/packages/modrinth-skin-rendering/Cargo.toml b/packages/modrinth-skin-rendering/Cargo.toml new file mode 100644 index 00000000000..ac041047a97 --- /dev/null +++ b/packages/modrinth-skin-rendering/Cargo.toml @@ -0,0 +1,20 @@ +[package] +name = "modrinth-skin-rendering" +version = "0.1.0" +edition.workspace = true +rust-version.workspace = true +description = "CPU rendering of Minecraft player skins" +repository.workspace = true + +[dependencies] +glam = { workspace = true } +gltf = { workspace = true } +png = { workspace = true } +serde = { workspace = true, features = ["derive"], optional = true } +thiserror = { workspace = true } + +[features] +serde = ["dep:serde"] + +[lints] +workspace = true diff --git a/packages/modrinth-skin-rendering/README.md b/packages/modrinth-skin-rendering/README.md new file mode 100644 index 00000000000..be0ca9aad41 --- /dev/null +++ b/packages/modrinth-skin-rendering/README.md @@ -0,0 +1,7 @@ +# modrinth-skin-rendering + +Renders Minecraft player skins on the CPU. + +## Credits + +See [THIRD_PARTY.md](./THIRD_PARTY.md). diff --git a/packages/modrinth-skin-rendering/THIRD_PARTY.md b/packages/modrinth-skin-rendering/THIRD_PARTY.md new file mode 100644 index 00000000000..a5eed35d5d5 --- /dev/null +++ b/packages/modrinth-skin-rendering/THIRD_PARTY.md @@ -0,0 +1,33 @@ +# Third-party code + +## Ears + +Portions of `src/ears/` are adapted from Ears, Ears2, and the Ears Skin Manipulator: + +- (revision `5d050d461d207c1a7cda0de11e2562f6581f7a16`) +- (revision `8ad9adc213e3b16b1a3306fb4141cfb618c25a6f`) + +```text +MIT License + +Copyright (c) 2020-2026 Exa Skye and contributors +Copyright (c) 2021-2026 Exa Skye and contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notices and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +``` diff --git a/packages/modrinth-skin-rendering/examples/render.rs b/packages/modrinth-skin-rendering/examples/render.rs new file mode 100644 index 00000000000..3af10dbe1ca --- /dev/null +++ b/packages/modrinth-skin-rendering/examples/render.rs @@ -0,0 +1,43 @@ +//! Renders a skin onto a glTF player model. +//! +//! ```sh +//! cargo run -p modrinth-skin-rendering --example render -- model.gltf skin.png preview.png +//! ``` + +use modrinth_skin_rendering::{ + Camera, Model, RenderOptions, Scene, SkinTexture, Texture, Vec3, render, + render_face, +}; + +fn main() -> Result<(), Box> { + let args: Vec = std::env::args().skip(1).collect(); + let [model, skin, output, rest @ ..] = &args[..] else { + eprintln!( + "usage: render [cape.png]" + ); + std::process::exit(2); + }; + + let model = Model::from_gltf(&std::fs::read(model)?)?; + let skin = SkinTexture::from_png(&std::fs::read(skin)?)?; + let cape = match rest.first() { + Some(path) => Some(Texture::from_png(&std::fs::read(path)?)?), + None => None, + }; + + let scene = Scene::build(&model, &skin, cape.as_ref()); + let camera = Camera { + position: Vec3::new(-1.6, 1.2, 5.4), + target: Vec3::new(0.0, 1.0, 0.0), + up: Vec3::Y, + fov_y_degrees: 24.0, + near: 0.1, + far: 100.0, + }; + let image = render(&scene, &camera, &RenderOptions::default()); + std::fs::write(output, image.to_png()?)?; + + let face_path = format!("{}.face.png", output.trim_end_matches(".png")); + std::fs::write(face_path, render_face(&skin, 64).to_png()?)?; + Ok(()) +} diff --git a/packages/modrinth-skin-rendering/src/ears/builder.rs b/packages/modrinth-skin-rendering/src/ears/builder.rs new file mode 100644 index 00000000000..fd879e6bed5 --- /dev/null +++ b/packages/modrinth-skin-rendering/src/ears/builder.rs @@ -0,0 +1,371 @@ +use glam::{Mat4, Vec3}; + +use super::{EarsQuad, EarsTextureSlot}; +use crate::model::BodyPart; + +const UV_TEXEL_INSET: f32 = 1.0 / 32.0; + +#[derive(Clone, Copy, PartialEq, Eq)] +pub(super) enum Rotation { + None, + Cw, + UpsideDown, +} + +#[derive(Clone, Copy, PartialEq, Eq)] +pub(super) enum Flip { + None, + Horizontal, + Vertical, + Both, +} + +impl Flip { + const fn flipped_horizontally(self) -> Self { + match self { + Self::None => Self::Horizontal, + Self::Horizontal => Self::None, + Self::Vertical => Self::Both, + Self::Both => Self::Vertical, + } + } +} + +/// In texels. +#[derive(Clone, Copy)] +pub(super) struct Face { + u: f32, + v: f32, + width: f32, + height: f32, + rotation: Rotation, + flip: Flip, + grow: f32, +} + +pub(super) const fn face(u: f32, v: f32, width: f32, height: f32) -> Face { + Face { + u, + v, + width, + height, + rotation: Rotation::None, + flip: Flip::None, + grow: 0.0, + } +} + +impl Face { + pub(super) const fn rotated(mut self, rotation: Rotation) -> Self { + self.rotation = rotation; + self + } + + pub(super) const fn flipped(mut self, flip: Flip) -> Self { + self.flip = flip; + self + } + + pub(super) const fn grown(mut self, grow: f32) -> Self { + self.grow = grow; + self + } +} + +#[derive(Clone, Copy)] +struct State { + anchor: Option, + matrix: Mat4, + texture: EarsTextureSlot, +} + +/// Takes coordinates as the Ears mod does, with X and Y negated relative to the output. +pub(super) struct QuadBuilder { + stack: Vec, + state: State, + pub(super) quads: Vec, +} + +impl QuadBuilder { + pub(super) const fn new() -> Self { + Self { + stack: Vec::new(), + state: State { + anchor: None, + matrix: Mat4::IDENTITY, + texture: EarsTextureSlot::Skin, + }, + quads: Vec::new(), + } + } + + pub(super) fn push(&mut self) { + self.stack.push(self.state); + } + + pub(super) fn pop(&mut self) { + if let Some(state) = self.stack.pop() { + self.state = state; + } + } + + pub(super) fn anchor_to(&mut self, part: BodyPart) { + self.state.anchor = Some(part); + self.state.matrix = Mat4::IDENTITY; + } + + pub(super) const fn bind(&mut self, texture: EarsTextureSlot) { + self.state.texture = texture; + } + + pub(super) fn translate(&mut self, x: f32, y: f32, z: f32) { + self.state.matrix *= Mat4::from_translation(Vec3::new(-x, -y, z)); + } + + pub(super) fn rotate(&mut self, degrees: f32, x: f32, y: f32, z: f32) { + self.state.matrix *= Mat4::from_axis_angle( + Vec3::new(-x, -y, z).normalize_or_zero(), + degrees.to_radians(), + ); + } + + pub(super) fn scale(&mut self, x: f32, y: f32, z: f32) { + self.state.matrix *= Mat4::from_scale(Vec3::new(x, y, z)); + } + + pub(super) fn front(&mut self, face: Face) { + self.front_skew(face, [0.0; 3]); + } + + pub(super) fn front_skew(&mut self, face: Face, [xs, ys, zs]: [f32; 3]) { + let Face { + width, + height, + grow, + .. + } = face; + let uvs = self.uvs(face); + self.emit( + [ + [grow - xs, -height - grow + ys, zs], + [-width - grow - xs, -height - grow - ys, zs], + [-width - grow + xs, grow - ys, -zs], + [grow + xs, grow + ys, -zs], + ], + uvs, + ); + } + + pub(super) fn back(&mut self, face: Face) { + self.reversed(face.flipped(face.flip.flipped_horizontally())); + } + + pub(super) fn double_sided(&mut self, face: Face) { + self.front(face); + self.reversed(face); + } + + fn reversed(&mut self, face: Face) { + let Face { + width, + height, + grow, + .. + } = face; + let [a, b, c, d] = self.uvs(face); + self.emit( + [ + [grow, grow, 0.0], + [-width - grow, grow, 0.0], + [-width - grow, -height - grow, 0.0], + [grow, -height - grow, 0.0], + ], + [d, c, b, a], + ); + } + + fn uvs(&self, face: Face) -> [[f32; 2]; 4] { + let (width, height) = self.state.texture.size(); + face_uvs(face, width as f32, height as f32) + } + + fn emit(&mut self, positions: [[f32; 3]; 4], uvs: [[f32; 2]; 4]) { + let Some(part) = self.state.anchor else { + return; + }; + self.quads.push(EarsQuad { + part, + texture: self.state.texture, + positions: positions.map(|position| { + self.state + .matrix + .transform_point3(position.into()) + .to_array() + }), + uvs, + }); + } +} + +fn face_uvs( + face: Face, + texture_width: f32, + texture_height: f32, +) -> [[f32; 2]; 4] { + let transposed = face.rotation == Rotation::Cw; + let (span_u, span_v) = if transposed { + (face.height, face.width) + } else { + (face.width, face.height) + }; + let mut min_u = (face.u + UV_TEXEL_INSET) / texture_width; + let mut min_v = (face.v + UV_TEXEL_INSET) / texture_height; + let mut max_u = (face.u + span_u - UV_TEXEL_INSET) / texture_width; + let mut max_v = (face.v + span_v - UV_TEXEL_INSET) / texture_height; + + let flip = match (transposed, face.flip) { + (true, Flip::Horizontal) => Flip::Vertical, + (true, Flip::Vertical) => Flip::Horizontal, + (_, flip) => flip, + }; + if matches!(flip, Flip::Horizontal | Flip::Both) { + std::mem::swap(&mut min_u, &mut max_u); + } + if matches!(flip, Flip::Vertical | Flip::Both) { + std::mem::swap(&mut min_v, &mut max_v); + } + + let mut uvs = [ + [min_u, max_v], + [max_u, max_v], + [max_u, min_v], + [min_u, min_v], + ]; + match face.rotation { + Rotation::None => {} + Rotation::Cw => uvs.rotate_right(1), + Rotation::UpsideDown => uvs.rotate_left(2), + } + uvs +} + +#[cfg(test)] +mod tests { + use super::*; + + fn builder() -> QuadBuilder { + QuadBuilder::new() + } + + fn texels(uvs: [[f32; 2]; 4]) -> [[f32; 2]; 4] { + uvs.map(|[u, v]| [(u * 64.0).round(), (v * 64.0).round()]) + } + + #[test] + fn nothing_is_drawn_before_anchoring() { + let mut builder = builder(); + builder.front(face(0.0, 0.0, 8.0, 8.0)); + assert!(builder.quads.is_empty()); + } + + #[test] + fn a_front_quad_hangs_down_and_towards_negative_x_from_the_origin() { + let mut builder = builder(); + builder.anchor_to(BodyPart::Head); + builder.front(face(24.0, 0.0, 16.0, 8.0)); + + let quad = &builder.quads[0]; + assert_eq!(quad.part, BodyPart::Head); + assert_eq!( + quad.positions, + [ + [0.0, -8.0, 0.0], + [-16.0, -8.0, 0.0], + [-16.0, 0.0, 0.0], + [0.0, 0.0, 0.0] + ] + ); + assert_eq!( + texels(quad.uvs), + [[24.0, 8.0], [40.0, 8.0], [40.0, 0.0], [24.0, 0.0]] + ); + } + + #[test] + fn translation_negates_x_and_y() { + let mut builder = builder(); + builder.anchor_to(BodyPart::Head); + builder.translate(-4.0, -16.0, 4.0); + builder.front(face(24.0, 0.0, 16.0, 8.0)); + assert_eq!(builder.quads[0].positions[3], [4.0, 16.0, 4.0]); + } + + #[test] + fn back_quads_reverse_winding_and_mirror_the_texture() { + let mut builder = builder(); + builder.anchor_to(BodyPart::Head); + builder.back(face(8.0, 0.0, 4.0, 2.0)); + + let quad = &builder.quads[0]; + assert_eq!( + quad.positions, + [ + [0.0, 0.0, 0.0], + [-4.0, 0.0, 0.0], + [-4.0, -2.0, 0.0], + [0.0, -2.0, 0.0] + ] + ); + assert_eq!( + texels(quad.uvs), + [[12.0, 0.0], [8.0, 0.0], [8.0, 2.0], [12.0, 2.0]] + ); + } + + #[test] + fn double_sided_faces_show_the_same_texels_from_both_sides() { + let mut builder = builder(); + builder.anchor_to(BodyPart::Torso); + builder.double_sided(face(56.0, 16.0, 8.0, 12.0)); + + let [front, back] = &builder.quads[..] else { + panic!("expected two quads"); + }; + for (position, uv) in back.positions.iter().zip(back.uvs) { + let index = front + .positions + .iter() + .position(|candidate| candidate == position) + .unwrap(); + assert_eq!(texels([uv; 4])[0], texels([front.uvs[index]; 4])[0]); + } + } + + #[test] + fn clockwise_rotation_transposes_the_sampled_rectangle() { + let uvs = texels(face_uvs( + face(56.0, 28.0, 16.0, 8.0).rotated(Rotation::Cw), + 64.0, + 64.0, + )); + assert_eq!( + uvs, + [[56.0, 28.0], [56.0, 44.0], [64.0, 44.0], [64.0, 28.0]] + ); + } + + #[test] + fn push_and_pop_restore_the_transform_anchor_and_texture() { + let mut builder = builder(); + builder.anchor_to(BodyPart::Head); + builder.push(); + builder.anchor_to(BodyPart::Torso); + builder.bind(EarsTextureSlot::Wing); + builder.translate(1.0, 2.0, 3.0); + builder.pop(); + builder.front(face(0.0, 0.0, 1.0, 1.0)); + assert_eq!(builder.quads[0].part, BodyPart::Head); + assert_eq!(builder.quads[0].texture, EarsTextureSlot::Skin); + assert_eq!(builder.quads[0].positions[3], [0.0, 0.0, 0.0]); + } +} diff --git a/packages/modrinth-skin-rendering/src/ears/features.rs b/packages/modrinth-skin-rendering/src/ears/features.rs new file mode 100644 index 00000000000..b4d24191a43 --- /dev/null +++ b/packages/modrinth-skin-rendering/src/ears/features.rs @@ -0,0 +1,631 @@ +use crate::texture::Texture; + +macro_rules! feature_enum { + ($name:ident { $($variant:ident),+ $(,)? }) => { + #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] + pub enum $name { + $($variant),+ + } + + impl $name { + const ALL: &[Self] = &[$(Self::$variant),+]; + } + }; +} + +feature_enum!(EarMode { + None, + Above, + Sides, + Behind, + Around, + Floppy, + Cross, + Out, + Tall, + TallCross, +}); +feature_enum!(EarAnchor { + Center, + Front, + Back +}); +feature_enum!(TailMode { + None, + Down, + Back, + Up, + Vertical, + Cross, + CrossOverlap, + Star, + StarOverlap, +}); +feature_enum!(WingMode { + None, + SymmetricDual, + SymmetricSingle, + AsymmetricL, + AsymmetricR, + AsymmetricDual, + Flat, +}); +feature_enum!(WingAnimationMode { + Normal, + None, + NoFlight +}); +feature_enum!(LegMode { + Plantigrade, + DigitigradePartial, + DigitigradeFull +}); +feature_enum!(Protrusions { + None, + Horn, + Claws, + ClawsAndHorn, + Halo, + DoubleHalo, + ClawsAndHalo, + ClawsAndDoubleHalo, +}); + +impl Protrusions { + pub const fn has_claws(self) -> bool { + matches!( + self, + Self::Claws + | Self::ClawsAndHorn + | Self::ClawsAndHalo + | Self::ClawsAndDoubleHalo + ) + } +} + +#[derive(Clone, Debug, PartialEq)] +pub struct Features { + pub ear_mode: EarMode, + pub ear_anchor: EarAnchor, + pub protrusions: Protrusions, + pub tail_mode: TailMode, + pub tail_segments: u32, + pub tail_bends: [f32; 4], + pub snout_offset: u32, + pub snout_width: u32, + pub snout_height: u32, + pub snout_depth: u32, + pub chest_size: f32, + pub wing_mode: WingMode, + pub wing_animation_mode: WingAnimationMode, + pub cape_enabled: bool, + pub emissive: bool, + pub leg_mode: LegMode, + pub animate_tail: bool, + pub swap_jacket_back_and_tail: bool, +} + +const V0_MAGIC: u32 = 0x3f23d8; +const V1_MAGIC: u32 = 0xea2501; + +const BLUE: u32 = 0x3f23d8; +const GREEN: u32 = 0x23d848; +const RED: u32 = 0xd82350; +const PURPLE: u32 = 0xb923d8; +const CYAN: u32 = 0x23d8c6; +const ORANGE: u32 = 0xd87823; +const PINK: u32 = 0xd823b7; +const PURPLE2: u32 = 0xd823ff; +const WHITE: u32 = 0xfefdf2; +const GRAY: u32 = 0x5e605a; + +pub(super) fn rgb(pixel: [u8; 4]) -> u32 { + (u32::from(pixel[0]) << 16) + | (u32::from(pixel[1]) << 8) + | u32::from(pixel[2]) +} + +fn config_pixel(texture: &Texture, index: u32) -> [u8; 4] { + texture.get(index % 4, 32 + index / 4) +} + +pub(super) struct BitReader<'a> { + data: &'a [u8], + bit_index: usize, +} + +impl<'a> BitReader<'a> { + pub(super) const fn new(data: &'a [u8]) -> Self { + Self { data, bit_index: 0 } + } + + pub(super) const fn remaining_bits(&self) -> usize { + self.data.len() * 8 - self.bit_index + } + + pub(super) fn read(&mut self, bits: u32) -> Option { + if self.remaining_bits() < bits as usize { + return None; + } + let mut result = 0; + for _ in 0..bits { + let byte = self.data[self.bit_index / 8]; + let shift = 7 - (self.bit_index % 8); + result = (result << 1) | u32::from((byte >> shift) & 1); + self.bit_index += 1; + } + Some(result) + } + + fn read_bool(&mut self) -> Option { + Some(self.read(1)? == 1) + } + + fn read_unit(&mut self, bits: u32) -> Option { + Some(self.read(bits)? as f32 / ((1 << bits) - 1) as f32) + } + + fn read_signed_unit(&mut self, bits: u32) -> Option { + let negative = self.read_bool()?; + let value = self.read_unit(bits)?; + Some(if negative { -value } else { value }) + } +} + +fn lookup(values: &[T], index: u32, fallback: T) -> T { + values.get(index as usize).copied().unwrap_or(fallback) +} + +fn parse_v1(texture: &Texture) -> Option { + let mut bytes = Vec::with_capacity(45); + for y in 0..4 { + for x in 0..4 { + if x == 0 && y == 0 { + continue; + } + bytes.extend_from_slice(&texture.get(x, 32 + y)[..3]); + } + } + + let mut reader = BitReader::new(&bytes); + let version = reader.read(8)?; + + let ears = reader.read(6)?; + let (ear_mode, ear_anchor) = if ears == 0 { + (EarMode::None, EarAnchor::Center) + } else { + ( + lookup(EarMode::ALL, (ears - 1) / 3 + 1, EarMode::None), + lookup(EarAnchor::ALL, (ears - 1) % 3, EarAnchor::Center), + ) + }; + let mut protrusions_index = reader.read(2)?; + let tail_index = reader.read(3)?; + let mut tail_mode = lookup(TailMode::ALL, tail_index, TailMode::None); + let mut tail_segments = 0; + let mut tail_bends = [0.0; 4]; + + if tail_index != 0 { + tail_segments = reader.read(2)? + 1; + for bend in tail_bends.iter_mut().take(tail_segments as usize) { + *bend = reader.read_signed_unit(6)? * 90.0; + } + } + + let snout_width = reader.read(3)?; + let mut snout_height = 0; + let mut snout_depth = 0; + let mut snout_offset = 0; + if snout_width > 0 { + snout_height = reader.read(2)? + 1; + snout_depth = reader.read(3)? + 1; + snout_offset = reader.read(3)?.min(8 - snout_height); + } + + let chest_size = reader.read_unit(5)?; + let wing_mode = lookup(WingMode::ALL, reader.read(3)?, WingMode::None); + let animate_wings = if wing_mode == WingMode::None { + false + } else { + reader.read_bool()? + }; + let cape_enabled = reader.read_bool()?; + let emissive = reader.read_bool()?; + let mut wing_animation_mode = if animate_wings { + WingAnimationMode::Normal + } else { + WingAnimationMode::None + }; + let mut leg_mode = LegMode::Plantigrade; + let mut animate_tail = true; + let mut swap_jacket_back_and_tail = false; + + if version >= 1 && tail_index == 7 { + tail_mode = + lookup(TailMode::ALL, tail_index + reader.read(3)?, TailMode::None); + } + if version >= 2 { + leg_mode = lookup(LegMode::ALL, reader.read(3)?, LegMode::Plantigrade); + if wing_mode != WingMode::None { + wing_animation_mode = lookup( + WingAnimationMode::ALL, + reader.read(3)?, + wing_animation_mode, + ); + } + animate_tail = reader.read_bool()?; + swap_jacket_back_and_tail = reader.read_bool()?; + } + if version >= 3 { + protrusions_index |= reader.read(2)? << 2; + } + + Some(Features { + ear_mode, + ear_anchor, + protrusions: lookup( + Protrusions::ALL, + protrusions_index, + Protrusions::None, + ), + tail_mode, + tail_segments, + tail_bends, + snout_offset, + snout_width, + snout_height, + snout_depth, + chest_size, + wing_mode, + wing_animation_mode, + cape_enabled, + emissive, + leg_mode, + animate_tail, + swap_jacket_back_and_tail, + }) +} + +fn pixel_value_to_unit(value: u8) -> f32 { + if value == 0 { + return 0.0; + } + let mut shifted = i32::from(value) - 128; + shifted += if shifted < 0 { -1 } else { 1 }; + shifted as f32 / 128.0 +} + +fn by_pixel(table: &[(u32, T)], pixel: [u8; 4], fallback: T) -> T { + let color = rgb(pixel); + table + .iter() + .find(|(key, _)| *key == color) + .map_or(fallback, |(_, value)| *value) +} + +fn parse_v0(texture: &Texture) -> Features { + let ear_mode = by_pixel( + &[ + (RED, EarMode::None), + (BLUE, EarMode::Above), + (GREEN, EarMode::Sides), + (PURPLE, EarMode::Behind), + (CYAN, EarMode::Around), + (ORANGE, EarMode::Floppy), + (PINK, EarMode::Cross), + (PURPLE2, EarMode::Out), + (WHITE, EarMode::Tall), + (GRAY, EarMode::TallCross), + ], + config_pixel(texture, 1), + EarMode::None, + ); + let ear_anchor = by_pixel( + &[ + (BLUE, EarAnchor::Center), + (GREEN, EarAnchor::Front), + (RED, EarAnchor::Back), + ], + config_pixel(texture, 2), + EarAnchor::Center, + ); + let protrusions = by_pixel( + &[ + (BLUE, Protrusions::None), + (RED, Protrusions::None), + (GREEN, Protrusions::Claws), + (PURPLE, Protrusions::Horn), + (CYAN, Protrusions::ClawsAndHorn), + (WHITE, Protrusions::Halo), + (GRAY, Protrusions::DoubleHalo), + (PURPLE2, Protrusions::ClawsAndHalo), + (PINK, Protrusions::ClawsAndDoubleHalo), + ], + config_pixel(texture, 3), + Protrusions::None, + ); + let tail_mode = by_pixel( + &[ + (RED, TailMode::None), + (BLUE, TailMode::Down), + (GREEN, TailMode::Back), + (PURPLE, TailMode::Up), + (ORANGE, TailMode::Vertical), + (PINK, TailMode::Cross), + (PURPLE2, TailMode::CrossOverlap), + (WHITE, TailMode::Star), + (GRAY, TailMode::StarOverlap), + ], + config_pixel(texture, 4), + TailMode::None, + ); + + let tail_pixel = config_pixel(texture, 5); + let mut tail_bends = [0.0; 4]; + let mut tail_segments = 0; + if rgb(tail_pixel) != BLUE { + tail_bends = [ + pixel_value_to_unit(255 - tail_pixel[3]) * 90.0, + pixel_value_to_unit(tail_pixel[0]) * 90.0, + pixel_value_to_unit(tail_pixel[1]) * 90.0, + pixel_value_to_unit(tail_pixel[2]) * 90.0, + ]; + tail_segments = 1; + for (index, bend) in tail_bends.iter().enumerate().skip(1) { + if *bend != 0.0 { + tail_segments = index as u32 + 1; + } + } + } + + let snout_pixel = config_pixel(texture, 6); + let etc_pixel = config_pixel(texture, 7); + let mut snout_width = 0; + let mut snout_height = 0; + let mut snout_depth = 0; + let mut snout_offset = 0; + if rgb(snout_pixel) != BLUE { + snout_width = u32::from(snout_pixel[0]).min(7); + snout_height = u32::from(snout_pixel[1]).min(4); + snout_depth = u32::from(snout_pixel[2]).min(8); + snout_offset = u32::from(etc_pixel[1]).min(8 - snout_height); + } + + let etc_is_default = rgb(etc_pixel) == BLUE; + let bitflags = rgb(config_pixel(texture, 12)); + let bitflags_are_default = bitflags == BLUE; + + Features { + ear_mode, + ear_anchor, + protrusions, + tail_mode, + tail_segments, + tail_bends, + snout_offset, + snout_width, + snout_height, + snout_depth, + chest_size: if etc_is_default { + 0.0 + } else { + (f32::from(etc_pixel[0]) / 128.0).min(1.0) + }, + wing_mode: by_pixel( + &[ + (BLUE, WingMode::None), + (RED, WingMode::None), + (PINK, WingMode::SymmetricDual), + (GREEN, WingMode::SymmetricSingle), + (CYAN, WingMode::AsymmetricL), + (ORANGE, WingMode::AsymmetricR), + (PURPLE, WingMode::AsymmetricDual), + (PURPLE2, WingMode::Flat), + ], + config_pixel(texture, 8), + WingMode::None, + ), + wing_animation_mode: by_pixel( + &[ + (BLUE, WingAnimationMode::Normal), + (RED, WingAnimationMode::None), + (GREEN, WingAnimationMode::NoFlight), + ], + config_pixel(texture, 9), + WingAnimationMode::Normal, + ), + cape_enabled: !etc_is_default && (etc_pixel[2] & 16) != 0, + emissive: rgb(config_pixel(texture, 10)) == ORANGE, + leg_mode: by_pixel( + &[ + (BLUE, LegMode::Plantigrade), + (GREEN, LegMode::DigitigradePartial), + (PINK, LegMode::DigitigradeFull), + ], + config_pixel(texture, 11), + LegMode::Plantigrade, + ), + animate_tail: bitflags_are_default || (bitflags & 1) != 0, + swap_jacket_back_and_tail: !bitflags_are_default && (bitflags & 2) != 0, + } +} + +pub(super) fn parse(texture: &Texture) -> Option { + match rgb(texture.get(0, 32)) { + V0_MAGIC => Some(parse_v0(texture)), + V1_MAGIC => parse_v1(texture), + _ => None, + } +} + +#[cfg(test)] +pub(super) mod tests { + use super::*; + + pub(in crate::ears) fn color(value: u32) -> [u8; 4] { + [(value >> 16) as u8, (value >> 8) as u8, value as u8, 255] + } + + pub(in crate::ears) fn v0_skin(config: &[(u32, [u8; 4])]) -> Texture { + let mut texture = Texture::new(64, 64); + for index in 0..16 { + texture.set(index % 4, 32 + index / 4, color(BLUE)); + } + for &(index, pixel) in config { + texture.set(index % 4, 32 + index / 4, pixel); + } + texture + } + + pub(in crate::ears) fn v1_skin(bits: &[(u32, u32)]) -> Texture { + let mut stream = Vec::new(); + for &(value, width) in bits { + for bit in (0..width).rev() { + stream.push((value >> bit) & 1 == 1); + } + } + stream.resize(45 * 8, false); + let bytes: Vec = stream + .chunks(8) + .map(|byte| { + byte.iter().fold(0, |acc, &bit| (acc << 1) | u8::from(bit)) + }) + .collect(); + + let mut texture = Texture::new(64, 64); + texture.set(0, 32, color(V1_MAGIC)); + for (index, rgb) in bytes.chunks(3).enumerate() { + let position = index as u32 + 1; + texture.set( + position % 4, + 32 + position / 4, + [rgb[0], rgb[1], rgb[2], 255], + ); + } + texture + } + + #[test] + fn skins_without_the_magic_pixel_have_no_features() { + assert_eq!(parse(&Texture::new(64, 64)), None); + } + + #[test] + fn v0_defaults_are_plain_ears_above_and_a_downward_tail() { + let features = parse(&v0_skin(&[])).unwrap(); + assert_eq!(features.ear_mode, EarMode::Above); + assert_eq!(features.ear_anchor, EarAnchor::Center); + assert_eq!(features.tail_mode, TailMode::Down); + assert_eq!(features.tail_segments, 0); + assert_eq!(features.snout_width, 0); + assert_eq!(features.wing_mode, WingMode::None); + assert_eq!(features.leg_mode, LegMode::Plantigrade); + assert!(features.animate_tail); + assert!(!features.cape_enabled); + assert!(!features.emissive); + } + + #[test] + fn v0_reads_each_config_pixel() { + let features = parse(&v0_skin(&[ + (1, color(PINK)), + (2, color(RED)), + (3, color(CYAN)), + (4, color(GRAY)), + (5, [255, 128, 0, 0]), + (6, [3, 2, 9, 255]), + (7, [64, 7, 16, 255]), + (8, color(PURPLE2)), + (10, color(ORANGE)), + (11, color(PINK)), + (12, [0, 0, 2, 255]), + ])) + .unwrap(); + + assert_eq!(features.ear_mode, EarMode::Cross); + assert_eq!(features.ear_anchor, EarAnchor::Back); + assert_eq!(features.protrusions, Protrusions::ClawsAndHorn); + assert_eq!(features.tail_mode, TailMode::StarOverlap); + assert_eq!(features.tail_bends, [90.0, 90.0, 0.703125, 0.0]); + assert_eq!(features.tail_segments, 3); + assert_eq!( + ( + features.snout_width, + features.snout_height, + features.snout_depth, + features.snout_offset + ), + (3, 2, 8, 6) + ); + assert_eq!(features.chest_size, 0.5); + assert!(features.cape_enabled); + assert_eq!(features.wing_mode, WingMode::Flat); + assert!(features.emissive); + assert_eq!(features.leg_mode, LegMode::DigitigradeFull); + assert!(!features.animate_tail); + assert!(features.swap_jacket_back_and_tail); + } + + #[test] + fn v1_reads_the_packed_bit_stream() { + let features = parse(&v1_skin(&[ + (3, 8), + (5, 6), + (1, 2), + (7, 3), + (1, 2), + (1, 1), + (63, 6), + (0, 1), + (21, 6), + (2, 3), + (1, 2), + (2, 3), + (7, 3), + (31, 5), + (1, 3), + (1, 1), + (1, 1), + (1, 1), + (1, 3), + (2, 3), + (2, 3), + (0, 1), + (1, 1), + (1, 2), + ])) + .unwrap(); + + assert_eq!(features.ear_mode, EarMode::Sides); + assert_eq!(features.ear_anchor, EarAnchor::Front); + assert_eq!(features.protrusions, Protrusions::DoubleHalo); + assert_eq!(features.tail_mode, TailMode::StarOverlap); + assert_eq!(features.tail_segments, 2); + assert_eq!(features.tail_bends[0], -90.0); + assert!((features.tail_bends[1] - 30.0).abs() < 1e-4); + assert_eq!(features.tail_bends[2..], [0.0, 0.0]); + assert_eq!( + ( + features.snout_width, + features.snout_height, + features.snout_depth, + features.snout_offset + ), + (2, 2, 3, 6) + ); + assert_eq!(features.chest_size, 1.0); + assert_eq!(features.wing_mode, WingMode::SymmetricDual); + assert_eq!(features.wing_animation_mode, WingAnimationMode::NoFlight); + assert!(features.cape_enabled); + assert!(features.emissive); + assert_eq!(features.leg_mode, LegMode::DigitigradeFull); + assert!(!features.animate_tail); + assert!(features.swap_jacket_back_and_tail); + } + + #[test] + fn v1_ear_values_past_the_known_modes_mean_no_ears() { + let features = parse(&v1_skin(&[(0, 8), (63, 6)])).unwrap(); + assert_eq!(features.ear_mode, EarMode::None); + } +} diff --git a/packages/modrinth-skin-rendering/src/ears/mod.rs b/packages/modrinth-skin-rendering/src/ears/mod.rs new file mode 100644 index 00000000000..ee46b555cd4 --- /dev/null +++ b/packages/modrinth-skin-rendering/src/ears/mod.rs @@ -0,0 +1,308 @@ +//! [Ears mod](https://ears.unascribed.com) support. +//! +//! Adapted from Ears, Ears2 and the Ears Skin Manipulator +//! (, ), +//! copyright (c) 2020-2026 Exa Skye and contributors +//! +//! See `THIRD_PARTY.md`. + +mod builder; +mod features; +mod parts; +mod pixels; + +use features::WingMode; + +use crate::model::BodyPart; +use crate::texture::{SkinTexture, Texture}; + +pub(crate) const QUAD_INDICES: [usize; 6] = [0, 1, 2, 0, 2, 3]; + +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] +#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] +#[cfg_attr(feature = "serde", serde(rename_all = "snake_case"))] +pub enum EarsTextureSlot { + Skin, + DisplacedSkin, + Wing, + Cape, +} + +impl EarsTextureSlot { + /// In texels. + pub const fn size(self) -> (u32, u32) { + match self { + Self::Skin | Self::DisplacedSkin => (64, 64), + Self::Wing | Self::Cape => (20, 16), + } + } +} + +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct TexturePair { + pub base: Texture, + pub emissive: Option, +} + +/// Positions are in skin pixels, relative to the corner of the body part's base cuboid with the +/// largest X and the smallest Y and Z, in the body part's own space. Vertices wind +/// counter-clockwise seen from the front. +#[derive(Clone, Debug, PartialEq)] +#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] +pub struct EarsQuad { + pub part: BodyPart, + pub texture: EarsTextureSlot, + pub positions: [[f32; 3]; 4], + pub uvs: [[f32; 2]; 4], +} + +#[derive(Clone, Debug, PartialEq)] +pub struct Ears { + /// Replaces the regular skin texture on the body. + pub skin: TexturePair, + pub displaced_skin: Option, + pub wing: Option, + pub cape: Option, + pub quads: Vec, +} + +impl Ears { + /// `None` if the skin has no Ears data. `slim` moves the left arm claw. + pub fn build(skin: &SkinTexture, slim: bool) -> Option { + if skin.is_legacy() { + return None; + } + let mut features = features::parse(skin.raw())?; + let alfalfa = pixels::parse_alfalfa(skin.raw()); + + let mut processed = skin.raw().clone(); + if let Some(erase) = &alfalfa.erase { + pixels::apply_erase_data(&mut processed, erase); + } + let displaced = pixels::displace_digitigrade_legs( + &mut processed, + features.leg_mode, + ); + if features.swap_jacket_back_and_tail { + pixels::swap_jacket_back_and_tail(&mut processed); + } + pixels::force_opaque_regions(&mut processed, features.leg_mode); + + let palette = if features.emissive { + pixels::emissive_palette(&processed) + } else { + std::collections::HashSet::new() + }; + let split = |texture: Texture| { + if palette.is_empty() { + TexturePair { + base: texture, + emissive: None, + } + } else { + let (base, emissive) = + pixels::split_emissive(&texture, &palette); + TexturePair { + base, + emissive: Some(emissive), + } + } + }; + + let skin_textures = split(processed); + let displaced_skin = displaced.map(split); + + let wing = alfalfa + .wing + .filter(|_| features.wing_mode != WingMode::None) + .and_then(|data| pixels::wing_texture(&data)) + .map(split); + if wing.is_none() { + features.wing_mode = WingMode::None; + } + + let cape = alfalfa + .cape + .filter(|_| features.cape_enabled) + .and_then(|data| pixels::cape_texture(&data)) + .map(|base| TexturePair { + base, + emissive: None, + }); + features.cape_enabled = cape.is_some(); + + let mut builder = builder::QuadBuilder::new(); + parts::draw_all(&mut builder, &features, slim); + + Some(Self { + skin: skin_textures, + displaced_skin, + wing, + cape, + quads: builder.quads, + }) + } + + pub const fn texture(&self, slot: EarsTextureSlot) -> Option<&TexturePair> { + match slot { + EarsTextureSlot::Skin => Some(&self.skin), + EarsTextureSlot::DisplacedSkin => self.displaced_skin.as_ref(), + EarsTextureSlot::Wing => self.wing.as_ref(), + EarsTextureSlot::Cape => self.cape.as_ref(), + } + } +} + +#[cfg(test)] +pub(crate) mod test_support { + use crate::texture::Texture; + + pub(crate) fn default_ears_skin() -> Texture { + super::features::tests::v0_skin(&[]) + } +} + +#[cfg(test)] +mod tests { + use super::features::tests::{color, v0_skin, v1_skin}; + use super::*; + + const PINK: u32 = 0xd823b7; + const ORANGE: u32 = 0xd87823; + + fn skin(texture: Texture) -> SkinTexture { + SkinTexture::new(texture).unwrap() + } + + #[test] + fn plain_and_legacy_skins_have_no_ears() { + assert!(Ears::build(&skin(Texture::new(64, 64)), false).is_none()); + assert!(Ears::build(&skin(Texture::new(64, 32)), false).is_none()); + } + + #[test] + fn default_features_draw_ears_on_the_head_and_a_tail_on_the_torso() { + let ears = Ears::build(&skin(v0_skin(&[])), false).unwrap(); + let on = |part| ears.quads.iter().filter(|q| q.part == part).count(); + assert_eq!(on(BodyPart::Head), 2); + assert_eq!(on(BodyPart::Torso), 2); + assert_eq!(ears.quads.len(), 4); + assert!( + ears.quads + .iter() + .all(|q| q.texture == EarsTextureSlot::Skin) + ); + assert!(ears.skin.emissive.is_none()); + assert!(ears.displaced_skin.is_none()); + } + + #[test] + fn ears_above_sit_on_top_of_the_head() { + let ears = Ears::build(&skin(v0_skin(&[])), false).unwrap(); + let front = &ears.quads[0]; + let ys: Vec = front.positions.iter().map(|p| p[1]).collect(); + let xs: Vec = front.positions.iter().map(|p| p[0]).collect(); + assert_eq!(ys, [8.0, 8.0, 16.0, 16.0]); + assert_eq!(xs, [4.0, -12.0, -12.0, 4.0]); + assert!(front.positions.iter().all(|p| p[2] == 4.0)); + } + + #[test] + fn the_body_texture_is_made_opaque_only_where_ears_requires_it() { + let mut texture = v0_skin(&[]); + texture.set(8, 8, [1, 2, 3, 0]); + texture.set(40, 8, [4, 5, 6, 0]); + let ears = Ears::build(&skin(texture), false).unwrap(); + assert_eq!(ears.skin.base.get(8, 8), [1, 2, 3, 255]); + assert_eq!(ears.skin.base.get(40, 8), [4, 5, 6, 0]); + } + + #[test] + fn digitigrade_legs_use_the_displaced_texture() { + let ears = + Ears::build(&skin(v0_skin(&[(11, color(PINK))])), false).unwrap(); + assert!(ears.displaced_skin.is_some()); + assert!( + ears.quads + .iter() + .any(|q| q.texture == EarsTextureSlot::DisplacedSkin + && q.part == BodyPart::LeftLeg) + ); + assert_eq!(ears.skin.base.get(0, 20)[3], 0); + } + + #[test] + fn emissive_is_dropped_when_the_palette_is_empty() { + let ears = + Ears::build(&skin(v0_skin(&[(10, color(ORANGE))])), false).unwrap(); + assert!(ears.skin.emissive.is_none()); + } + + #[test] + fn emissive_pixels_move_to_their_own_texture() { + let mut texture = v0_skin(&[(10, color(ORANGE))]); + texture.set(52, 32, [250, 250, 0, 255]); + texture.set(9, 9, [250, 250, 0, 255]); + let ears = Ears::build(&skin(texture), false).unwrap(); + assert_eq!(ears.skin.base.get(9, 9)[3], 0); + assert_eq!( + ears.skin.emissive.as_ref().unwrap().get(9, 9), + [250, 250, 0, 255] + ); + } + + #[test] + fn wings_without_an_embedded_texture_are_disabled() { + let ears = + Ears::build(&skin(v0_skin(&[(8, color(PINK))])), false).unwrap(); + assert!(ears.wing.is_none()); + assert!( + ears.quads + .iter() + .all(|q| q.texture != EarsTextureSlot::Wing) + ); + } + + #[test] + fn embedded_wings_are_drawn_from_alfalfa_data() { + use super::pixels::tests::{alfalfa_payload, write_alfalfa}; + const GREEN: u32 = 0x23d848; + + let mut wing = Texture::new(20, 16); + wing.set(3, 4, [10, 20, 30, 255]); + let png = wing.to_png().unwrap(); + + let mut texture = v0_skin(&[(8, color(GREEN))]); + for pixel in texture.pixels_mut() { + pixel[3] = 255; + } + write_alfalfa(&mut texture, &alfalfa_payload(&[(1, &png)])); + + let ears = Ears::build(&skin(texture), false).unwrap(); + assert_eq!( + ears.wing.as_ref().unwrap().base.get(3, 4), + [10, 20, 30, 255] + ); + let wing_quads: Vec<_> = ears + .quads + .iter() + .filter(|q| q.texture == EarsTextureSlot::Wing) + .collect(); + assert_eq!(wing_quads.len(), 2); + assert!(wing_quads.iter().all(|q| q.part == BodyPart::Torso)); + } + + #[test] + fn slim_arms_move_the_left_claw_inwards() { + let claws = |slim| { + let texture = v1_skin(&[(3, 8), (0, 6), (2, 2)]); + Ears::build(&skin(texture), slim) + .unwrap() + .quads + .into_iter() + .find(|q| q.part == BodyPart::LeftArm) + .unwrap() + }; + assert_ne!(claws(true).positions, claws(false).positions); + } +} diff --git a/packages/modrinth-skin-rendering/src/ears/parts.rs b/packages/modrinth-skin-rendering/src/ears/parts.rs new file mode 100644 index 00000000000..6cea35e681c --- /dev/null +++ b/packages/modrinth-skin-rendering/src/ears/parts.rs @@ -0,0 +1,644 @@ +use super::EarsTextureSlot; +use super::builder::{Flip, QuadBuilder, Rotation, face}; +use super::features::{ + EarAnchor, EarMode, Features, LegMode, Protrusions, TailMode, + WingAnimationMode, WingMode, +}; +use crate::model::BodyPart; + +pub(super) fn draw_all(b: &mut QuadBuilder, features: &Features, slim: bool) { + ears(b, features); + tail(b, features); + protrusions(b, features, slim); + snout(b, features); + chest(b, features); + wings(b, features); + cape(b, features); + digitigrade_legs(b, features); +} + +fn apply_ear_anchor(b: &mut QuadBuilder, anchor: EarAnchor) { + match anchor { + EarAnchor::Center => b.translate(0.0, 0.0, 4.0), + EarAnchor::Back => b.translate(0.0, 0.0, 8.0), + EarAnchor::Front => {} + } +} + +fn ears(b: &mut QuadBuilder, features: &Features) { + let cw = Rotation::Cw; + match features.ear_mode { + EarMode::None => {} + EarMode::Above | EarMode::Around => { + b.push(); + b.anchor_to(BodyPart::Head); + apply_ear_anchor(b, features.ear_anchor); + b.push(); + b.translate(-4.0, -16.0, 0.0); + b.front(face(24.0, 0.0, 16.0, 8.0)); + b.back(face(56.0, 28.0, 16.0, 8.0).rotated(cw)); + b.pop(); + if features.ear_mode == EarMode::Around { + b.translate(-4.0, -8.0, 0.0); + b.front(face(36.0, 16.0, 4.0, 8.0).rotated(cw)); + b.back(face(12.0, 16.0, 4.0, 8.0).rotated(cw)); + b.translate(12.0, 0.0, 0.0); + b.front(face(36.0, 32.0, 4.0, 8.0).rotated(cw)); + b.back(face(12.0, 32.0, 4.0, 8.0).rotated(cw)); + } + b.pop(); + } + EarMode::Sides => { + b.push(); + b.anchor_to(BodyPart::Head); + apply_ear_anchor(b, features.ear_anchor); + b.translate(-8.0, -8.0, 0.0); + b.front(face(24.0, 0.0, 8.0, 8.0)); + b.back(face(56.0, 28.0, 8.0, 8.0).rotated(cw)); + b.translate(16.0, 0.0, 0.0); + b.front(face(32.0, 0.0, 8.0, 8.0)); + b.back(face(56.0, 36.0, 8.0, 8.0).rotated(cw)); + b.pop(); + } + EarMode::Behind => { + b.push(); + b.anchor_to(BodyPart::Head); + b.rotate(90.0, 0.0, 1.0, 0.0); + b.translate(-16.0, -8.0, 0.0); + b.front(face(24.0, 0.0, 8.0, 8.0)); + b.back(face(56.0, 28.0, 8.0, 8.0).rotated(cw)); + b.rotate(180.0, 0.0, 1.0, 0.0); + b.translate(-8.0, 0.0, -8.0); + b.front(face(32.0, 0.0, 8.0, 8.0)); + b.back(face(56.0, 36.0, 8.0, 8.0).rotated(cw)); + b.pop(); + } + EarMode::Floppy => { + b.push(); + b.anchor_to(BodyPart::Head); + b.rotate(90.0, 0.0, 1.0, 0.0); + b.translate(-8.0, -7.0, 0.0); + b.rotate(-30.0, 1.0, 0.0, 0.0); + b.front(face(24.0, 0.0, 8.0, 8.0)); + b.back(face(56.0, 28.0, 8.0, 8.0).rotated(cw)); + b.pop(); + + b.push(); + b.anchor_to(BodyPart::Head); + b.rotate(-90.0, 0.0, 1.0, 0.0); + b.translate(0.0, -7.0, -8.0); + b.rotate(-30.0, 1.0, 0.0, 0.0); + b.front(face(32.0, 0.0, 8.0, 8.0)); + b.back(face(56.0, 36.0, 8.0, 8.0).rotated(cw)); + b.pop(); + } + EarMode::Cross => { + b.push(); + b.anchor_to(BodyPart::Head); + apply_ear_anchor(b, features.ear_anchor); + b.translate(4.0, -16.0, 0.0); + b.push(); + b.rotate(45.0, 0.0, 1.0, 0.0); + b.translate(-4.0, 0.0, 0.0); + b.front(face(24.0, 0.0, 8.0, 8.0)); + b.back(face(56.0, 28.0, 8.0, 8.0).rotated(cw)); + b.pop(); + b.push(); + b.rotate(-45.0, 0.0, 1.0, 0.0); + b.translate(-4.0, 0.0, 0.0); + b.front(face(32.0, 0.0, 8.0, 8.0)); + b.back(face(56.0, 36.0, 8.0, 8.0).rotated(cw)); + b.pop(); + b.pop(); + } + EarMode::Out => { + b.push(); + b.anchor_to(BodyPart::Head); + b.rotate(90.0, 0.0, 1.0, 0.0); + match features.ear_anchor { + EarAnchor::Back => b.translate(-16.0, -8.0, 0.0), + EarAnchor::Center => b.translate(-8.0, -16.0, 0.0), + EarAnchor::Front => b.translate(0.0, -8.0, 0.0), + } + b.front(face(24.0, 0.0, 8.0, 8.0)); + b.back(face(56.0, 28.0, 8.0, 8.0).rotated(cw)); + b.rotate(180.0, 0.0, 1.0, 0.0); + b.translate(-8.0, 0.0, -8.0); + b.front(face(32.0, 0.0, 8.0, 8.0)); + b.back(face(56.0, 36.0, 8.0, 8.0).rotated(cw)); + b.pop(); + } + EarMode::Tall => { + let angle = -6.0; + b.push(); + b.anchor_to(BodyPart::Head); + b.translate(0.0, -8.0, 0.0); + apply_ear_anchor(b, features.ear_anchor); + b.rotate(angle / 3.0, 1.0, 0.0, 0.0); + b.translate(0.0, -4.0, 0.0); + b.front(face(24.0, 0.0, 8.0, 4.0).rotated(cw)); + b.back(face(56.0, 40.0, 8.0, 4.0)); + b.rotate(angle, 1.0, 0.0, 0.0); + b.translate(0.0, -4.0, 0.0); + b.front(face(28.0, 0.0, 8.0, 4.0).rotated(cw)); + b.back(face(56.0, 36.0, 8.0, 4.0)); + b.rotate(angle / 2.0, 1.0, 0.0, 0.0); + b.translate(0.0, -4.0, 0.0); + b.front(face(32.0, 0.0, 8.0, 4.0).rotated(cw)); + b.back(face(56.0, 32.0, 8.0, 4.0)); + b.rotate(angle, 1.0, 0.0, 0.0); + b.translate(0.0, -4.0, 0.0); + b.front(face(36.0, 0.0, 8.0, 4.0).rotated(cw)); + b.back(face(56.0, 28.0, 8.0, 4.0)); + b.pop(); + } + EarMode::TallCross => { + b.push(); + b.anchor_to(BodyPart::Head); + apply_ear_anchor(b, features.ear_anchor); + b.translate(4.0, -24.0, 0.0); + for angle in [45.0, -45.0] { + b.push(); + b.rotate(angle, 0.0, 1.0, 0.0); + b.translate(-4.0, 0.0, 0.0); + b.front(face(24.0, 0.0, 8.0, 16.0).rotated(cw)); + b.back(face(56.0, 28.0, 8.0, 16.0)); + b.pop(); + } + b.pop(); + } + } +} + +fn tail(b: &mut QuadBuilder, features: &Features) { + let mode = features.tail_mode; + let angle = match mode { + TailMode::None => return, + TailMode::Down => 30.0, + TailMode::Back + | TailMode::Cross + | TailMode::CrossOverlap + | TailMode::Star + | TailMode::StarOverlap => { + if features.tail_bends[0] != 0.0 { + 90.0 + } else { + 80.0 + } + } + TailMode::Up => 130.0, + TailMode::Vertical => 0.0, + }; + + let vertical = mode == TailMode::Vertical; + let base_angle = features.tail_bends[0]; + b.push(); + b.anchor_to(BodyPart::Torso); + b.translate(0.0, -2.0, 4.0); + b.rotate(angle, 1.0, 0.0, 0.0); + if vertical { + b.translate(4.0, 0.0, 0.0); + b.rotate(90.0, 0.0, 0.0, 1.0); + if base_angle < 0.0 { + b.translate(4.0, 0.0, 0.0); + b.rotate(base_angle, 0.0, 1.0, 0.0); + b.translate(-4.0, 0.0, 0.0); + } + b.translate(-4.0, 0.0, 0.0); + if base_angle > 0.0 { + b.rotate(base_angle, 0.0, 1.0, 0.0); + } + b.rotate(90.0, 1.0, 0.0, 0.0); + } + + let segments = features.tail_segments.max(1); + let segment_height = (12 / segments) as f32; + let mut angles = features.tail_bends; + if vertical { + angles[0] = 0.0; + } + let overlapping = + matches!(mode, TailMode::CrossOverlap | TailMode::StarOverlap); + let horizontal = Flip::Horizontal; + + for (index, angle) in angles.into_iter().take(segments as usize).enumerate() + { + let overlap = if index == 0 || !overlapping { 0.0 } else { 4.0 }; + let v = 16.0 + index as f32 * segment_height; + b.rotate(angle, 1.0, 0.0, 0.0); + b.double_sided(face(56.0, v, 8.0, segment_height).flipped(horizontal)); + + let side_angles: &[f32] = match mode { + TailMode::Cross | TailMode::CrossOverlap => &[90.0], + TailMode::Star | TailMode::StarOverlap => &[45.0, 90.0, 135.0], + _ => &[], + }; + for &side_angle in side_angles { + b.push(); + b.translate(4.0, 0.0, 0.0); + b.rotate(side_angle, 0.0, 1.0, 0.0); + b.translate(-4.0, -overlap, 0.0); + b.double_sided( + face(56.0, v - overlap, 8.0, segment_height + overlap) + .flipped(horizontal), + ); + b.pop(); + } + b.translate(0.0, segment_height, 0.0); + } + b.pop(); +} + +fn protrusions(b: &mut QuadBuilder, features: &Features, slim: bool) { + let horizontal = Flip::Horizontal; + if features.protrusions.has_claws() { + let leg_offset = match features.leg_mode { + LegMode::DigitigradeFull => -1.5, + LegMode::DigitigradePartial => -1.0, + LegMode::Plantigrade => 0.0, + }; + b.push(); + b.anchor_to(BodyPart::LeftLeg); + b.translate(0.0, 0.0, -4.0 + leg_offset); + b.rotate(90.0, 1.0, 0.0, 0.0); + b.double_sided(face(16.0, 48.0, 4.0, 4.0).flipped(horizontal)); + b.pop(); + + b.push(); + b.anchor_to(BodyPart::RightLeg); + b.translate(0.0, 0.0, -4.0 + leg_offset); + b.rotate(90.0, 1.0, 0.0, 0.0); + b.double_sided(face(0.0, 16.0, 4.0, 4.0).flipped(horizontal)); + b.pop(); + + b.push(); + b.anchor_to(BodyPart::LeftArm); + b.rotate(90.0, 0.0, 1.0, 0.0); + b.translate(-4.0, 0.0, if slim { 3.0 } else { 4.0 }); + b.double_sided( + face(44.0, 48.0, 4.0, 4.0) + .rotated(Rotation::UpsideDown) + .flipped(horizontal), + ); + b.pop(); + + b.push(); + b.anchor_to(BodyPart::RightArm); + b.rotate(90.0, 0.0, 1.0, 0.0); + b.translate(-4.0, 0.0, 0.0); + b.double_sided( + face(52.0, 16.0, 4.0, 4.0).rotated(Rotation::UpsideDown), + ); + b.pop(); + } + + let horn_or_halo = face(56.0, 0.0, 8.0, 8.0); + match features.protrusions { + Protrusions::Horn | Protrusions::ClawsAndHorn => { + b.push(); + b.anchor_to(BodyPart::Head); + b.translate(0.0, -8.0, 0.0); + b.rotate(25.0, 1.0, 0.0, 0.0); + b.translate(0.0, -8.0, 0.0); + b.double_sided(horn_or_halo); + b.pop(); + } + Protrusions::Halo | Protrusions::ClawsAndHalo => { + b.push(); + b.anchor_to(BodyPart::Head); + b.translate(0.0, -12.0, 0.0); + b.rotate(90.0, 1.0, 0.0, 0.0); + b.double_sided(horn_or_halo); + b.pop(); + } + Protrusions::DoubleHalo | Protrusions::ClawsAndDoubleHalo => { + b.push(); + b.anchor_to(BodyPart::Head); + b.translate(0.0, -10.0, 0.0); + b.rotate(90.0, 1.0, 0.0, 0.0); + for _ in 0..2 { + b.translate(4.0, 4.0, 0.0); + b.rotate(45.0, 0.0, 0.0, 1.0); + b.translate(-4.0, -4.0, 2.0); + b.double_sided(horn_or_halo); + } + b.pop(); + } + Protrusions::None | Protrusions::Claws => {} + } +} + +fn digitigrade_leg( + b: &mut QuadBuilder, + u: f32, + v: f32, + grow: f32, + bottom: bool, + mend: bool, +) { + let (width, height, depth) = (4.0, 12.0, 4.0); + let double_grow = grow * 2.0; + let skew = 1.0; + let v_offset = if bottom { 10.0 } else { 4.0 }; + let v_side = v + v_offset; + + b.push(); + b.translate(width / 2.0, height / 2.0, depth / 2.0); + b.scale( + (width + double_grow) / width, + (height + double_grow) / height, + (depth + double_grow) / depth, + ); + b.translate(-width / 2.0, -height / 2.0, -depth / 2.0); + + b.push(); + b.translate(0.0, if bottom { -6.0 } else { -12.0 }, 0.0); + let sides: [(f32, [f32; 3], f32); 4] = [ + (u + 4.0, [0.0, 0.0, -skew], 6.0), + (u + 8.0, [-skew, 0.0, 0.0], 6.0), + (u + 12.0, [0.0, 0.0, skew], 5.0), + (u, [skew, 0.0, 0.0], 6.0), + ]; + for (index, (side_u, side_skew, mend_v)) in sides.into_iter().enumerate() { + if index > 0 { + b.rotate(-90.0, 0.0, 1.0, 0.0); + b.translate(0.0, 0.0, -4.0); + } + if !mend && bottom { + b.push(); + b.translate(0.0, 2.0, 0.0); + b.front_skew(face(side_u, v_side + 2.0, 4.0, 4.0), side_skew); + b.pop(); + } else { + b.front_skew(face(side_u, v_side, 4.0, 6.0), side_skew); + } + if mend && !bottom { + b.push(); + b.translate(0.0, 6.0, 0.0); + b.front_skew( + face(side_u, v_side + mend_v, 4.0, 2.0), + side_skew.map(|component: f32| -component), + ); + b.pop(); + } + } + b.pop(); + + b.push(); + b.rotate(90.0, 1.0, 0.0, 0.0); + let sole = face(u + 8.0, v, 4.0, 4.0).flipped(Flip::Vertical); + b.push(); + if bottom { + b.translate(0.0, -skew, 0.0); + b.front(sole); + } else { + b.translate(0.0, skew, 12.0); + b.back(sole); + } + b.pop(); + if mend && bottom { + b.translate(0.0, 0.0, 6.0); + b.front(face(u + 4.0, v_side, 4.0, 1.0)); + b.translate(0.0, 4.0, 0.0); + b.back(face(u + 12.0, v_side, 4.0, 1.0)); + } + b.pop(); + b.pop(); +} + +fn digitigrade_legs(b: &mut QuadBuilder, features: &Features) { + if features.leg_mode == LegMode::Plantigrade { + return; + } + + let full = features.leg_mode == LegMode::DigitigradeFull; + b.push(); + b.bind(EarsTextureSlot::DisplacedSkin); + for (overlay, grow) in [(false, 0.0), (true, 0.25)] { + let legs = [ + (BodyPart::LeftLeg, if overlay { 0.0 } else { 16.0 }, 48.0), + (BodyPart::RightLeg, 0.0, if overlay { 32.0 } else { 16.0 }), + ]; + for (part, u, v) in legs { + b.push(); + b.anchor_to(part); + if full { + b.translate(0.0, 0.0, -0.5); + } + if overlay { + b.translate(0.0, 0.5, 0.0); + } + if full { + digitigrade_leg(b, u, v, grow, false, true); + } + digitigrade_leg(b, u, v, grow, true, !full); + b.pop(); + } + } + b.pop(); +} + +fn snout(b: &mut QuadBuilder, features: &Features) { + if features.snout_width == 0 + || features.snout_height == 0 + || features.snout_depth == 0 + { + return; + } + let width = features.snout_width as f32; + let height = features.snout_height as f32; + let depth = features.snout_depth as f32; + let offset = features.snout_offset as f32; + let extra_rows = features.snout_depth - 1; + + b.push(); + b.anchor_to(BodyPart::Head); + b.translate((8.0 - width) / 2.0, -(offset + height), -depth); + b.double_sided(face(0.0, 2.0, width, height)); + + b.push(); + b.rotate(-90.0, 1.0, 0.0, 0.0); + b.translate(0.0, -1.0, 0.0); + b.double_sided(face(0.0, 1.0, width, 1.0)); + for _ in 0..extra_rows { + b.translate(0.0, -1.0, 0.0); + b.double_sided(face(0.0, 0.0, width, 1.0)); + } + b.pop(); + + b.push(); + b.translate(0.0, height, 0.0); + b.rotate(90.0, 1.0, 0.0, 0.0); + b.double_sided(face(0.0, 2.0 + height, width, 1.0)); + for _ in 0..extra_rows { + b.translate(0.0, 1.0, 0.0); + b.double_sided(face(0.0, 3.0 + height, width, 1.0)); + } + b.pop(); + + b.push(); + b.rotate(90.0, 0.0, 1.0, 0.0); + for side_offset in [0.0, width] { + b.push(); + b.translate(-1.0, 0.0, side_offset); + b.double_sided(face(7.0, 0.0, 1.0, height)); + for _ in 0..extra_rows { + b.translate(-1.0, 0.0, 0.0); + b.double_sided(face(7.0, 4.0, 1.0, height)); + } + b.pop(); + } + b.pop(); + b.pop(); +} + +fn chest(b: &mut QuadBuilder, features: &Features) { + if features.chest_size <= 0.0 { + return; + } + let horizontal = Flip::Horizontal; + + for overlay in [false, true] { + b.push(); + b.anchor_to(BodyPart::Torso); + b.translate(0.0, -10.0, 0.0); + b.rotate(-features.chest_size * 45.0, 1.0, 0.0, 0.0); + if overlay { + b.push(); + b.translate(4.0, 2.0, 0.0); + b.scale(8.5 / 8.0, 4.5 / 4.0, 1.0); + b.translate(-4.0, -2.0, -0.25); + b.double_sided(face(0.0, 48.0, 4.0, 4.0)); + b.translate(4.0, 0.0, 0.0); + b.double_sided(face(12.0, 48.0, 4.0, 4.0)); + b.pop(); + } else { + b.double_sided(face(20.0, 22.0, 8.0, 4.0)); + } + + b.push(); + b.translate(0.0, 4.0, 0.0); + b.rotate(90.0, 1.0, 0.0, 0.0); + if overlay { + b.translate(0.0, 0.0, -0.25); + b.double_sided(face(28.0, 48.0, 8.0, 4.0).grown(0.25)); + } else { + b.double_sided(face(56.0, 44.0, 8.0, 4.0)); + } + b.pop(); + + b.push(); + b.rotate(90.0, 0.0, 1.0, 0.0); + b.translate(-4.0, 0.0, 0.01); + if overlay { + b.translate(0.0, 0.0, -0.25); + b.double_sided(face(48.0, 48.0, 4.0, 4.0).grown(0.25)); + b.translate(0.0, 0.0, 0.25); + } else { + b.double_sided(face(60.0, 48.0, 4.0, 4.0)); + } + b.translate(0.0, 0.0, 7.98); + b.rotate(180.0, 0.0, 1.0, 0.0); + b.translate(-4.0, 0.0, 0.0); + if overlay { + b.translate(0.0, 0.0, -0.25); + b.double_sided( + face(48.0, 48.0, 4.0, 4.0).flipped(horizontal).grown(0.25), + ); + } else { + b.double_sided(face(60.0, 48.0, 4.0, 4.0).flipped(horizontal)); + } + b.pop(); + b.pop(); + } +} + +fn wings(b: &mut QuadBuilder, features: &Features) { + let mode = features.wing_mode; + if mode == WingMode::None { + return; + } + + let wiggle = if features.wing_animation_mode == WingAnimationMode::None { + 0.0 + } else { + (8.0_f32 / 12.0).sin() * 2.0 + }; + let full_wing = face(0.0, 0.0, 20.0, 16.0); + + b.push(); + b.anchor_to(BodyPart::Torso); + b.bind(EarsTextureSlot::Wing); + b.translate(2.0, -14.0, 4.0); + + if matches!(mode, WingMode::SymmetricDual | WingMode::AsymmetricR) { + b.push(); + b.rotate(-120.0 + wiggle, 0.0, 1.0, 0.0); + b.double_sided(full_wing); + b.pop(); + } + if matches!(mode, WingMode::SymmetricDual | WingMode::AsymmetricL) { + b.translate(4.0, 0.0, 0.0); + b.push(); + b.rotate(-60.0 - wiggle, 0.0, 1.0, 0.0); + b.double_sided(full_wing); + b.pop(); + } + if mode == WingMode::SymmetricSingle { + b.translate(2.0, 0.0, 0.0); + b.push(); + b.rotate(-90.0 + wiggle, 0.0, 1.0, 0.0); + b.double_sided(full_wing); + b.pop(); + } + if mode == WingMode::AsymmetricDual { + b.push(); + b.rotate(-120.0 + wiggle, 0.0, 1.0, 0.0); + b.double_sided(face(0.0, 0.0, 10.0, 16.0)); + b.pop(); + b.translate(4.0, 0.0, 0.0); + b.push(); + b.rotate(-60.0 - wiggle, 0.0, 1.0, 0.0); + b.double_sided(face(10.0, 0.0, 10.0, 16.0)); + b.pop(); + } + if mode == WingMode::Flat { + b.translate(-8.0, 0.0, 0.75); + b.double_sided(full_wing); + } + b.pop(); +} + +fn cape(b: &mut QuadBuilder, features: &Features) { + if !features.cape_enabled { + return; + } + let horizontal = Flip::Horizontal; + let vertical = Flip::Vertical; + + b.push(); + b.anchor_to(BodyPart::Torso); + b.translate(4.0, -12.0, 5.0); + b.rotate(6.0, 1.0, 0.0, 0.0); + b.rotate(180.0, 0.0, 1.0, 0.0); + b.bind(EarsTextureSlot::Cape); + b.translate(-5.0, 0.0, 0.0); + b.double_sided(face(0.0, 0.0, 10.0, 16.0)); + + b.push(); + b.translate(10.0, 0.0, 1.0); + b.rotate(90.0, 0.0, 1.0, 0.0); + b.double_sided(face(9.0, 0.0, 1.0, 16.0).flipped(horizontal)); + b.rotate(90.0, 0.0, 1.0, 0.0); + b.double_sided(face(10.0, 0.0, 10.0, 16.0)); + b.translate(10.0, 0.0, 1.0); + b.rotate(90.0, 0.0, 1.0, 0.0); + b.double_sided(face(0.0, 0.0, 1.0, 16.0).flipped(horizontal)); + b.pop(); + + b.rotate(90.0, 1.0, 0.0, 0.0); + b.double_sided(face(0.0, 0.0, 10.0, 1.0).flipped(vertical)); + b.translate(0.0, 0.0, -16.0); + b.double_sided(face(0.0, 15.0, 10.0, 1.0).flipped(vertical)); + b.pop(); +} diff --git a/packages/modrinth-skin-rendering/src/ears/pixels.rs b/packages/modrinth-skin-rendering/src/ears/pixels.rs new file mode 100644 index 00000000000..30ab4935f60 --- /dev/null +++ b/packages/modrinth-skin-rendering/src/ears/pixels.rs @@ -0,0 +1,500 @@ +use std::collections::HashSet; + +use super::features::{BitReader, LegMode, rgb}; +use crate::texture::{SKIN_SIZE, Texture}; + +type Region = (u32, u32, u32, u32); + +const ALFALFA_MAGIC: u32 = 0xea1f_a1fa; +const ALFALFA_KEYS: [&[u8]; 4] = [b"END", b"wing", b"erase", b"cape"]; + +const ALFALFA_REGIONS: [Region; 10] = [ + (8, 0, 24, 8), + (0, 8, 8, 16), + (16, 8, 32, 16), + (4, 16, 12, 20), + (20, 16, 36, 20), + (44, 16, 52, 20), + (0, 20, 56, 32), + (20, 48, 28, 52), + (36, 48, 44, 52), + (16, 52, 48, 64), +]; + +const FORCED_OPAQUE: &[Region] = &[ + (8, 0, 24, 8), + (0, 8, 32, 16), + (4, 16, 12, 20), + (20, 16, 36, 20), + (44, 16, 52, 20), + (0, 20, 56, 32), + (20, 48, 28, 52), + (36, 48, 44, 52), + (16, 52, 48, 64), +]; + +const FORCED_OPAQUE_WITHOUT_LEG_BOTTOM: &[Region] = &[ + (8, 0, 24, 8), + (0, 8, 32, 16), + (4, 16, 8, 20), + (20, 16, 36, 20), + (44, 16, 52, 20), + (0, 20, 16, 38), + (16, 20, 56, 32), + (20, 48, 24, 52), + (36, 48, 44, 52), + (16, 52, 32, 58), + (32, 52, 48, 64), +]; + +const FORCED_OPAQUE_WITHOUT_LEGS: &[Region] = &[ + (8, 0, 24, 8), + (0, 8, 32, 16), + (4, 16, 8, 20), + (20, 16, 36, 20), + (44, 16, 52, 20), + (16, 20, 56, 32), + (20, 48, 24, 52), + (36, 48, 44, 52), + (32, 52, 48, 64), +]; + +const LEG_BOTTOM_HALF_REGIONS: [(Region, bool); 8] = [ + ((24, 48, 28, 52), true), + ((16, 58, 32, 64), true), + ((8, 16, 12, 20), true), + ((0, 26, 16, 32), true), + ((8, 32, 12, 36), false), + ((0, 42, 16, 48), false), + ((8, 48, 12, 52), false), + ((0, 58, 16, 64), false), +]; + +const LEG_REGIONS: [(Region, bool); 8] = [ + ((20, 48, 28, 52), true), + ((16, 52, 32, 64), true), + ((4, 16, 12, 20), true), + ((0, 20, 16, 32), true), + ((4, 32, 12, 36), false), + ((0, 36, 16, 48), false), + ((4, 48, 12, 52), false), + ((0, 52, 16, 64), false), +]; + +fn columns((x1, y1, x2, y2): Region) -> impl Iterator { + (x1..x2).flat_map(move |x| (y1..y2).map(move |y| (x, y))) +} + +#[derive(Debug, Default, PartialEq, Eq)] +pub(super) struct Alfalfa { + pub(super) wing: Option>, + pub(super) erase: Option>, + pub(super) cape: Option>, +} + +/// Alfalfa is a key-value store packed into the alpha channel of opaque skin regions. +pub(super) fn parse_alfalfa(texture: &Texture) -> Alfalfa { + let mut bits = Vec::new(); + for (x, y) in ALFALFA_REGIONS.into_iter().flat_map(columns) { + let alpha = texture.get(x, y)[3]; + if alpha == 0 { + continue; + } + let value = 0x7f - (alpha & 0x7f); + bits.extend((0..7).map(|bit| (value >> bit) & 1 == 1)); + } + + let mut bytes: Vec = bits + .chunks(8) + .map(|byte| { + byte.iter() + .enumerate() + .fold(0, |acc, (bit, &set)| acc | (u8::from(set) << bit)) + }) + .collect(); + while bytes.last() == Some(&0) { + bytes.pop(); + } + bytes.reverse(); + + read_alfalfa_entries(&bytes).unwrap_or_default() +} + +fn read_alfalfa_entries(bytes: &[u8]) -> Option { + let mut remaining = bytes.iter().copied(); + let mut alfalfa = Alfalfa::default(); + if bytes.is_empty() { + return Some(alfalfa); + } + + let magic = u32::from_be_bytes([ + remaining.next()?, + remaining.next()?, + remaining.next()?, + remaining.next()?, + ]); + if magic != ALFALFA_MAGIC || remaining.next()? != 1 { + return Some(alfalfa); + } + + while let Some(first) = remaining.next() { + let name = if first < 64 { + ALFALFA_KEYS + .get(usize::from(first)) + .map_or_else(Vec::new, |key| key.to_vec()) + } else { + let mut name = vec![first]; + while name[name.len() - 1] & 0x80 == 0 { + name.push(remaining.next()?); + } + let last = name.len() - 1; + name[last] &= 0x7f; + name + }; + let mut unknown = None; + let slot = match name.as_slice() { + b"END" => break, + b"wing" => &mut alfalfa.wing, + b"erase" => &mut alfalfa.erase, + b"cape" => &mut alfalfa.cape, + _ => &mut unknown, + }; + + let mut value = Vec::new(); + loop { + let length = remaining.next()?; + for _ in 0..length { + value.push(remaining.next()?); + } + if length != 255 { + break; + } + } + *slot = Some(value); + } + + Some(alfalfa) +} + +pub(super) fn apply_erase_data(texture: &mut Texture, erase: &[u8]) { + let mut reader = BitReader::new(erase); + while reader.remaining_bits() >= 22 { + let (Some(x), Some(y), Some(width), Some(height)) = ( + reader.read(6), + reader.read(6), + reader.read(5), + reader.read(5), + ) else { + return; + }; + let region = ( + x, + y, + (x + width + 1).min(SKIN_SIZE), + (y + height + 1).min(SKIN_SIZE), + ); + for (x, y) in columns(region) { + texture.set(x, y, [0; 4]); + } + } +} + +pub(super) fn force_opaque_regions(texture: &mut Texture, leg_mode: LegMode) { + let regions = match leg_mode { + LegMode::DigitigradeFull => FORCED_OPAQUE_WITHOUT_LEGS, + LegMode::DigitigradePartial => FORCED_OPAQUE_WITHOUT_LEG_BOTTOM, + LegMode::Plantigrade => FORCED_OPAQUE, + }; + for (x, y) in regions.iter().copied().flat_map(columns) { + let mut pixel = texture.get(x, y); + pixel[3] = 255; + texture.set(x, y, pixel); + } +} + +/// Moves the leg pixels that digitigrade legs redraw out of `texture` into a new one. +pub(super) fn displace_digitigrade_legs( + texture: &mut Texture, + leg_mode: LegMode, +) -> Option { + let regions = match leg_mode { + LegMode::Plantigrade => return None, + LegMode::DigitigradePartial => LEG_BOTTOM_HALF_REGIONS, + LegMode::DigitigradeFull => LEG_REGIONS, + }; + + let mut displaced = Texture::new(SKIN_SIZE, SKIN_SIZE); + for (region, force_opaque) in regions { + for (x, y) in columns(region) { + let mut pixel = texture.get(x, y); + if force_opaque { + pixel[3] = 255; + } + displaced.set(x, y, pixel); + texture.set(x, y, [0; 4]); + } + } + Some(displaced) +} + +pub(super) fn swap_jacket_back_and_tail(texture: &mut Texture) { + let mut tail = [[0; 4]; 8 * 12]; + for x in 0..8 { + for y in 0..12 { + tail[(y * 8 + x) as usize] = texture.get(56 + x, 16 + y); + let jacket = texture.get(32 + x, 36 + (11 - y)); + texture.set(56 + x, 16 + y, jacket); + } + } + for x in 0..8 { + for y in 0..12 { + texture.set(32 + x, 36 + y, tail[(y * 8 + x) as usize]); + } + } +} + +pub(super) fn emissive_palette(texture: &Texture) -> HashSet { + columns((52, 32, 56, 36)) + .map(|(x, y)| texture.get(x, y)) + .filter(|pixel| pixel[3] > 0) + .map(rgb) + .collect() +} + +/// Returns `(base, emissive)`. +pub(super) fn split_emissive( + texture: &Texture, + palette: &HashSet, +) -> (Texture, Texture) { + let mut base = texture.clone(); + let mut emissive = texture.clone(); + for (base, emissive) in + base.pixels_mut().iter_mut().zip(emissive.pixels_mut()) + { + if palette.contains(&rgb(*base)) { + base[3] = 0; + } else { + emissive[3] = 0; + } + } + (base, emissive) +} + +fn decode_embedded(png: &[u8]) -> Option { + Texture::from_png_with_limit(png, SKIN_SIZE).ok() +} + +pub(super) fn wing_texture(png: &[u8]) -> Option { + let image = decode_embedded(png)?; + match (image.width(), image.height()) { + (20, 16) => Some(image), + (12, 12) => { + let mut canvas = Texture::new(20, 16); + for y in 0..12 { + for x in 0..12 { + canvas.set(x, y + 2, image.get(x, y)); + } + } + Some(canvas) + } + _ => None, + } +} + +pub(super) fn cape_texture(png: &[u8]) -> Option { + decode_embedded(png) + .filter(|image| (image.width(), image.height()) == (20, 16)) +} + +#[cfg(test)] +pub(super) mod tests { + use super::*; + + pub(in crate::ears) fn write_alfalfa(texture: &mut Texture, bytes: &[u8]) { + let mut little_endian = bytes.to_vec(); + little_endian.reverse(); + let bits: Vec = little_endian + .iter() + .flat_map(|byte| (0..8).map(move |bit| (byte >> bit) & 1 == 1)) + .collect(); + let mut values = bits.chunks(7).map(|chunk| { + chunk + .iter() + .enumerate() + .fold(0_u8, |acc, (bit, &set)| acc | (u8::from(set) << bit)) + }); + + for (x, y) in ALFALFA_REGIONS.into_iter().flat_map(columns) { + let value = values.next().unwrap_or(0); + let mut pixel = texture.get(x, y); + pixel[3] = 0x80 | (0x7f - value); + texture.set(x, y, pixel); + } + assert!(values.next().is_none(), "alfalfa payload does not fit"); + } + + pub(in crate::ears) fn alfalfa_payload(entries: &[(u8, &[u8])]) -> Vec { + let mut bytes = ALFALFA_MAGIC.to_be_bytes().to_vec(); + bytes.push(1); + for (key, value) in entries { + bytes.push(*key); + let mut chunks = value.chunks(255).peekable(); + while let Some(chunk) = chunks.next() { + bytes.push(chunk.len() as u8); + bytes.extend_from_slice(chunk); + if chunk.len() == 255 && chunks.peek().is_none() { + bytes.push(0); + } + } + if value.is_empty() { + bytes.push(0); + } + } + bytes.push(0); + bytes + } + + fn opaque_skin() -> Texture { + Texture::from_pixels(64, 64, vec![[9, 9, 9, 255]; 64 * 64]).unwrap() + } + + #[test] + fn a_fully_opaque_skin_has_no_alfalfa_data() { + assert_eq!(parse_alfalfa(&opaque_skin()), Alfalfa::default()); + } + + #[test] + fn alfalfa_entries_round_trip_through_alpha_values() { + let long_value: Vec = (0..300).map(|i| (i % 251) as u8).collect(); + let mut texture = opaque_skin(); + write_alfalfa( + &mut texture, + &alfalfa_payload(&[(2, &[1, 2, 3]), (1, &long_value)]), + ); + + assert_eq!( + parse_alfalfa(&texture), + Alfalfa { + wing: Some(long_value), + erase: Some(vec![1, 2, 3]), + cape: None, + } + ); + } + + #[test] + fn alfalfa_with_the_wrong_magic_is_ignored() { + let mut payload = alfalfa_payload(&[(2, &[1])]); + payload[1] ^= 0xff; + let mut texture = opaque_skin(); + write_alfalfa(&mut texture, &payload); + assert_eq!(parse_alfalfa(&texture), Alfalfa::default()); + } + + #[test] + fn truncated_alfalfa_yields_nothing() { + let mut payload = alfalfa_payload(&[(2, &[1, 2, 3, 4])]); + payload.truncate(payload.len() - 3); + let mut texture = opaque_skin(); + write_alfalfa(&mut texture, &payload); + assert_eq!(parse_alfalfa(&texture), Alfalfa::default()); + } + + #[test] + fn erase_rectangles_clear_pixels_and_clip_to_the_skin() { + let mut texture = opaque_skin(); + let rectangles: [(u32, u32, u32, u32); 2] = + [(2, 3, 1, 0), (62, 62, 7, 7)]; + let mut bits = Vec::new(); + for (x, y, width, height) in rectangles { + for (value, size) in [(x, 6), (y, 6), (width, 5), (height, 5)] { + bits.extend((0..size).rev().map(|bit| (value >> bit) & 1 == 1)); + } + } + let erase: Vec = bits + .chunks(8) + .map(|byte| { + byte.iter().enumerate().fold(0, |acc, (index, &set)| { + acc | (u8::from(set) << (7 - index)) + }) + }) + .collect(); + + apply_erase_data(&mut texture, &erase); + assert_eq!(texture.get(2, 3), [0; 4]); + assert_eq!(texture.get(3, 3), [0; 4]); + assert_eq!(texture.get(4, 3)[3], 255); + assert_eq!(texture.get(2, 4)[3], 255); + assert_eq!(texture.get(63, 63), [0; 4]); + assert_eq!(texture.get(61, 63)[3], 255); + } + + #[test] + fn full_digitigrade_legs_move_every_leg_pixel() { + let mut texture = + Texture::from_pixels(64, 64, vec![[7, 7, 7, 100]; 64 * 64]) + .unwrap(); + let displaced = + displace_digitigrade_legs(&mut texture, LegMode::DigitigradeFull) + .unwrap(); + + assert_eq!(displaced.get(0, 20), [7, 7, 7, 255]); + assert_eq!(displaced.get(0, 36), [7, 7, 7, 100]); + assert_eq!(displaced.get(40, 20), [0; 4]); + assert_eq!(texture.get(0, 20), [0; 4]); + assert_eq!(texture.get(40, 20), [7, 7, 7, 100]); + assert!( + displace_digitigrade_legs(&mut texture, LegMode::Plantigrade) + .is_none() + ); + } + + #[test] + fn swapping_moves_the_tail_and_flips_the_jacket_back() { + let mut texture = Texture::new(64, 64); + texture.set(56, 16, [1, 0, 0, 255]); + texture.set(32, 47, [2, 0, 0, 255]); + swap_jacket_back_and_tail(&mut texture); + assert_eq!(texture.get(32, 36), [1, 0, 0, 255]); + assert_eq!(texture.get(56, 16), [2, 0, 0, 255]); + } + + #[test] + fn emissive_split_keeps_each_pixel_in_exactly_one_texture() { + let mut texture = opaque_skin(); + for (x, y) in columns((52, 32, 56, 36)) { + texture.set(x, y, [0; 4]); + } + texture.set(52, 32, [200, 0, 0, 255]); + texture.set(53, 32, [0, 200, 0, 0]); + texture.set(10, 10, [200, 0, 0, 255]); + + let palette = emissive_palette(&texture); + assert_eq!(palette, HashSet::from([0xc80000])); + + let (base, emissive) = split_emissive(&texture, &palette); + assert_eq!(base.get(10, 10)[3], 0); + assert_eq!(emissive.get(10, 10), [200, 0, 0, 255]); + assert_eq!(base.get(11, 10), [9, 9, 9, 255]); + assert_eq!(emissive.get(11, 10)[3], 0); + } + + #[test] + fn legacy_wings_are_drawn_two_pixels_down() { + let mut wing = Texture::new(12, 12); + wing.set(0, 0, [5, 6, 7, 255]); + + let canvas = wing_texture(&wing.to_png().unwrap()).unwrap(); + assert_eq!((canvas.width(), canvas.height()), (20, 16)); + assert_eq!(canvas.get(0, 2), [5, 6, 7, 255]); + assert_eq!(canvas.get(0, 0), [0; 4]); + } + + #[test] + fn embedded_textures_of_the_wrong_size_or_format_are_ignored() { + assert!(wing_texture(b"not a png").is_none()); + let odd = Texture::new(16, 16).to_png().unwrap(); + assert!(wing_texture(&odd).is_none()); + assert!(cape_texture(&odd).is_none()); + } +} diff --git a/packages/modrinth-skin-rendering/src/error.rs b/packages/modrinth-skin-rendering/src/error.rs new file mode 100644 index 00000000000..183d42a44cd --- /dev/null +++ b/packages/modrinth-skin-rendering/src/error.rs @@ -0,0 +1,19 @@ +#[derive(Debug, thiserror::Error)] +pub enum Error { + #[error("pixel buffer length does not match {width}x{height}")] + PixelBufferSize { width: u32, height: u32 }, + #[error("skin textures must be 64x64 or 64x32, got {width}x{height}")] + SkinDimensions { width: u32, height: u32 }, + #[error("invalid PNG: {0}")] + PngDecode(#[from] png::DecodingError), + #[error("could not encode PNG: {0}")] + PngEncode(#[from] png::EncodingError), + #[error("image is too large to decode")] + ImageTooLarge, + #[error("invalid glTF: {0}")] + Gltf(#[from] gltf::Error), + #[error("invalid glTF model: {0}")] + InvalidModel(&'static str), +} + +pub type Result = std::result::Result; diff --git a/packages/modrinth-skin-rendering/src/lib.rs b/packages/modrinth-skin-rendering/src/lib.rs new file mode 100644 index 00000000000..56e8f3a1014 --- /dev/null +++ b/packages/modrinth-skin-rendering/src/lib.rs @@ -0,0 +1,20 @@ +//! CPU rendering of Minecraft player skins. +#![doc = include_str!("../README.md")] + +pub mod ears; +mod error; +mod model; +mod raster; +mod render; +mod scene; +mod texture; + +pub use error::{Error, Result}; +pub use glam::{self, Mat4, Vec3}; +pub use model::{BodyPart, Bounds, Mesh, Model, Node, Primitive}; +pub use render::{Camera, Lighting, RenderOptions, render, render_face}; +pub use scene::{Material, Scene, Triangle}; +pub use texture::{ArmModel, SkinTexture, Texture, normalize_skin_pixels}; + +/// Bump when rendered output changes. Cache keys include it. +pub const RENDERER_VERSION: u32 = 1; diff --git a/packages/modrinth-skin-rendering/src/model/gltf.rs b/packages/modrinth-skin-rendering/src/model/gltf.rs new file mode 100644 index 00000000000..dcc4a70e338 --- /dev/null +++ b/packages/modrinth-skin-rendering/src/model/gltf.rs @@ -0,0 +1,103 @@ +use glam::Mat4; +use gltf::buffer::Data; +use gltf::mesh::Mode; + +use super::{Mesh, Model, Node, Primitive}; +use crate::error::{Error, Result}; + +impl Model { + /// Takes `.gltf` JSON or `.glb` bytes with embedded buffers. Reads geometry and node + /// transforms only. + pub fn from_gltf(data: &[u8]) -> Result { + let gltf::Gltf { document, blob } = gltf::Gltf::from_slice(data)?; + let buffers = gltf::import_buffers(&document, None, blob)?; + + let meshes = document + .meshes() + .map(|mesh| { + let mut primitives = Vec::new(); + for primitive in mesh.primitives() { + if primitive.mode() == Mode::Triangles + && let Some(primitive) = + read_primitive(&primitive, &buffers)? + { + primitives.push(primitive); + } + } + Ok(Mesh { primitives }) + }) + .collect::>>()?; + + let nodes: Vec = document + .nodes() + .map(|node| Node { + name: node.name().unwrap_or_default().to_owned(), + transform: Mat4::from_cols_array_2d(&node.transform().matrix()), + children: node.children().map(|child| child.index()).collect(), + mesh: node.mesh().map(|mesh| mesh.index()), + }) + .collect(); + + let scene = document + .default_scene() + .or_else(|| document.scenes().next()) + .ok_or(Error::InvalidModel("no scene"))?; + let roots = scene.nodes().map(|node| node.index()).collect(); + + Ok(Self { + nodes, + roots, + meshes, + }) + } +} + +fn read_primitive( + primitive: &gltf::Primitive<'_>, + buffers: &[Data], +) -> Result> { + let reader = primitive.reader(|buffer| Some(&buffers[buffer.index()])); + if primitive.get(&gltf::Semantic::Positions).is_none() { + return Ok(None); + } + + let out_of_range = || Error::InvalidModel("accessor out of range"); + let positions: Vec<[f32; 3]> = + reader.read_positions().ok_or_else(out_of_range)?.collect(); + let uvs: Vec<[f32; 2]> = match primitive.get(&gltf::Semantic::TexCoords(0)) + { + Some(_) => reader + .read_tex_coords(0) + .ok_or_else(out_of_range)? + .into_f32() + .collect(), + None => vec![[0.0; 2]; positions.len()], + }; + let indices: Vec = match primitive.indices() { + Some(_) => reader + .read_indices() + .ok_or_else(out_of_range)? + .into_u32() + .collect(), + None => (0..positions.len() as u32).collect(), + }; + + if uvs.len() != positions.len() { + return Err(Error::InvalidModel( + "texture coordinate count differs from vertex count", + )); + } + if indices + .iter() + .any(|&index| index as usize >= positions.len()) + { + return Err(Error::InvalidModel("index out of range")); + } + + Ok(Some(Primitive { + positions, + uvs, + indices, + material: primitive.material().name().map(str::to_owned), + })) +} diff --git a/packages/modrinth-skin-rendering/src/model/mod.rs b/packages/modrinth-skin-rendering/src/model/mod.rs new file mode 100644 index 00000000000..db6520c6cb6 --- /dev/null +++ b/packages/modrinth-skin-rendering/src/model/mod.rs @@ -0,0 +1,210 @@ +use glam::{Mat4, Vec3}; + +mod gltf; + +#[derive(Clone, Debug, Default)] +pub struct Model { + pub nodes: Vec, + pub roots: Vec, + pub meshes: Vec, +} + +#[derive(Clone, Debug, Default)] +pub struct Node { + pub name: String, + pub transform: Mat4, + pub children: Vec, + pub mesh: Option, +} + +#[derive(Clone, Debug, Default)] +pub struct Mesh { + pub primitives: Vec, +} + +#[derive(Clone, Debug, Default)] +pub struct Primitive { + pub positions: Vec<[f32; 3]>, + pub uvs: Vec<[f32; 2]>, + pub indices: Vec, + pub material: Option, +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] +#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] +#[cfg_attr(feature = "serde", serde(rename_all = "snake_case"))] +pub enum BodyPart { + Head, + Torso, + LeftArm, + RightArm, + LeftLeg, + RightLeg, +} + +impl BodyPart { + pub const ALL: [Self; 6] = [ + Self::Head, + Self::Torso, + Self::LeftArm, + Self::RightArm, + Self::LeftLeg, + Self::RightLeg, + ]; + + pub const fn node_name(self) -> &'static str { + match self { + Self::Head => "Head", + Self::Torso => "Body", + Self::LeftArm => "Left_Arm", + Self::RightArm => "Right_Arm", + Self::LeftLeg => "Left_Leg", + Self::RightLeg => "Right_Leg", + } + } +} + +const BASE_MESH_SUFFIX: &str = "_2"; +pub(crate) const OVERLAY_MESH_SUFFIX: &str = "_Layer"; +pub(crate) const CAPE_MATERIAL: &str = "cape"; +/// Skin pixels per model unit. A 32 pixel tall player that is two units tall uses 16. +pub(crate) const PIXELS_PER_UNIT: f32 = 16.0; + +#[derive(Clone, Copy, Debug, PartialEq)] +pub struct Bounds { + pub min: Vec3, + pub max: Vec3, +} + +impl Model { + pub fn find_node(&self, name: &str) -> Option { + self.nodes.iter().position(|node| node.name == name) + } + + /// Indexed like [`Model::nodes`]. + pub fn world_transforms(&self) -> Vec { + let mut transforms = vec![Mat4::IDENTITY; self.nodes.len()]; + let mut pending: Vec<(usize, Mat4)> = self + .roots + .iter() + .map(|&root| (root, Mat4::IDENTITY)) + .collect(); + let mut visited = vec![false; self.nodes.len()]; + + while let Some((index, parent)) = pending.pop() { + let Some(node) = self.nodes.get(index) else { + continue; + }; + if std::mem::replace(&mut visited[index], true) { + continue; + } + let world = parent * node.transform; + transforms[index] = world; + pending.extend(node.children.iter().map(|&child| (child, world))); + } + + transforms + } + + /// Relative to the model root. + pub fn node_position(&self, part: BodyPart) -> Option { + let index = self.find_node(part.node_name())?; + Some(self.world_transforms()[index].w_axis.truncate()) + } + + /// In the body part node's own space. + pub fn base_mesh_bounds(&self, part: BodyPart) -> Option { + let node = &self.nodes[self.find_node(part.node_name())?]; + let base_name = format!("{}{BASE_MESH_SUFFIX}", part.node_name()); + let mesh_node = node.children.iter().find_map(|&child| { + self.nodes + .get(child) + .filter(|child| child.mesh.is_some() && child.name == base_name) + })?; + let mesh = self.meshes.get(mesh_node.mesh?)?; + + let mut bounds: Option = None; + for position in mesh + .primitives + .iter() + .flat_map(|primitive| &primitive.positions) + { + let point = + mesh_node.transform.transform_point3((*position).into()); + bounds = Some(bounds.map_or( + Bounds { + min: point, + max: point, + }, + |bounds| Bounds { + min: bounds.min.min(point), + max: bounds.max.max(point), + }, + )); + } + bounds + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn world_transforms_accumulate_down_the_hierarchy() { + let model = Model { + nodes: vec![ + Node { + name: "Root".into(), + transform: Mat4::from_translation(Vec3::Y), + children: vec![1], + mesh: None, + }, + Node { + name: "Head".into(), + transform: Mat4::from_translation(Vec3::new(2.0, 0.0, 0.0)), + children: vec![], + mesh: None, + }, + ], + roots: vec![0], + meshes: vec![], + }; + assert_eq!( + model.node_position(BodyPart::Head), + Some(Vec3::new(2.0, 1.0, 0.0)) + ); + } + + #[test] + fn base_mesh_bounds_include_the_mesh_node_offset() { + let model = Model { + nodes: vec![ + Node { + name: "Head".into(), + transform: Mat4::IDENTITY, + children: vec![1], + mesh: None, + }, + Node { + name: "Head_2".into(), + transform: Mat4::from_translation(Vec3::new( + 0.0, -1.5, 0.0, + )), + children: vec![], + mesh: Some(0), + }, + ], + roots: vec![0], + meshes: vec![Mesh { + primitives: vec![Primitive { + positions: vec![[-0.25, 1.5, -0.25], [0.25, 2.0, 0.25]], + ..Primitive::default() + }], + }], + }; + let bounds = model.base_mesh_bounds(BodyPart::Head).unwrap(); + assert_eq!(bounds.min, Vec3::new(-0.25, 0.0, -0.25)); + assert_eq!(bounds.max, Vec3::new(0.25, 0.5, 0.25)); + } +} diff --git a/packages/modrinth-skin-rendering/src/raster.rs b/packages/modrinth-skin-rendering/src/raster.rs new file mode 100644 index 00000000000..319f7f166d3 --- /dev/null +++ b/packages/modrinth-skin-rendering/src/raster.rs @@ -0,0 +1,305 @@ +use std::collections::HashMap; +use std::sync::LazyLock; + +use glam::{Mat4, Vec3}; + +use crate::render::Lighting; +use crate::scene::{Scene, Triangle}; +use crate::texture::Texture; + +const ALPHA_TEST: u8 = 26; + +static SRGB_TO_LINEAR: LazyLock<[f32; 256]> = LazyLock::new(|| { + std::array::from_fn(|value| { + let c = value as f32 / 255.0; + if c <= 0.04045 { + c / 12.92 + } else { + ((c + 0.055) / 1.055).powf(2.4) + } + }) +}); + +fn linear_to_srgb(value: f32) -> f32 { + let c = value.clamp(0.0, 1.0); + if c <= 0.003_130_8 { + c * 12.92 + } else { + 1.055 * c.powf(1.0 / 2.4) - 0.055 + } +} + +#[derive(Clone, Copy)] +struct Vertex { + x: f32, + y: f32, + depth: f32, + inverse_w: f32, + u_over_w: f32, + v_over_w: f32, +} + +/// Color is premultiplied by alpha. +pub(crate) struct Framebuffer { + width: usize, + height: usize, + color: Vec<[u8; 4]>, + depth: Vec, +} + +type ShadeTable = [f32; 256]; + +fn shade_table(light: f32) -> ShadeTable { + std::array::from_fn(|value| linear_to_srgb(SRGB_TO_LINEAR[value] * light)) +} + +impl Framebuffer { + pub(crate) fn new(width: u32, height: u32) -> Self { + let size = width as usize * height as usize; + Self { + width: width as usize, + height: height as usize, + color: vec![[0; 4]; size], + depth: vec![f32::INFINITY; size], + } + } + + /// Opaque triangles are drawn first, then blended ones from back to front. + pub(crate) fn draw( + &mut self, + scene: &Scene, + view_projection: &Mat4, + lighting: &Lighting, + ) { + let light_direction = lighting.direction.normalize_or_zero(); + let mut shade_tables: HashMap = HashMap::new(); + let mut shade_for = |prepared: &Prepared, emissive: bool| { + let diffuse = lighting.ambient + + lighting.directional + * prepared.normal.dot(light_direction).max(0.0); + let light = diffuse + if emissive { 1.0 } else { 0.0 }; + *shade_tables + .entry(light.to_bits()) + .or_insert_with(|| shade_table(light)) + }; + + let mut blended = Vec::new(); + for triangle in &scene.triangles { + let Some(texture) = scene.textures.get(triangle.texture) else { + continue; + }; + let Some(prepared) = self.prepare(triangle, view_projection) else { + continue; + }; + if triangle.material.blend { + let depth = + prepared.vertices.iter().map(|v| v.depth).sum::(); + blended.push((triangle, texture, prepared, depth)); + } else { + let shade = shade_for(&prepared, triangle.material.emissive); + self.fill(triangle, texture, &prepared, &shade); + } + } + + blended.sort_by(|a, b| { + a.0.material + .order + .cmp(&b.0.material.order) + .then(b.3.total_cmp(&a.3)) + }); + for (triangle, texture, prepared, _) in blended { + let shade = shade_for(&prepared, triangle.material.emissive); + self.fill(triangle, texture, &prepared, &shade); + } + } + + fn prepare( + &self, + triangle: &Triangle, + view_projection: &Mat4, + ) -> Option { + let mut vertices = [Vertex { + x: 0.0, + y: 0.0, + depth: 0.0, + inverse_w: 0.0, + u_over_w: 0.0, + v_over_w: 0.0, + }; 3]; + for (vertex, (position, uv)) in vertices + .iter_mut() + .zip(triangle.positions.iter().zip(triangle.uvs)) + { + let [x, y, z, w] = + (*view_projection * position.extend(1.0)).to_array(); + if w <= 1e-6 || z < -w { + return None; + } + let inverse_w = 1.0 / w; + *vertex = Vertex { + x: (x * inverse_w * 0.5 + 0.5) * self.width as f32, + y: (0.5 - y * inverse_w * 0.5) * self.height as f32, + depth: z * inverse_w, + inverse_w, + u_over_w: uv[0] * inverse_w, + v_over_w: uv[1] * inverse_w, + }; + } + + let [a, b, c] = vertices; + let area = edge(a, b, c.x, c.y); + if area == 0.0 { + return None; + } + let front_facing = area < 0.0; + if !front_facing && !triangle.material.double_sided { + return None; + } + + let mut normal = (triangle.positions[1] - triangle.positions[0]) + .cross(triangle.positions[2] - triangle.positions[0]) + .normalize_or_zero(); + if !front_facing { + normal = -normal; + } + + Some(Prepared { + vertices, + area, + normal, + }) + } + + fn fill( + &mut self, + triangle: &Triangle, + texture: &Texture, + prepared: &Prepared, + shade: &ShadeTable, + ) { + let [a, b, c] = prepared.vertices; + let material = triangle.material; + + let min_x = a.x.min(b.x).min(c.x).floor().max(0.0) as usize; + let min_y = a.y.min(b.y).min(c.y).floor().max(0.0) as usize; + let max_x = (a.x.max(b.x).max(c.x).ceil() as usize).min(self.width); + let max_y = (a.y.max(b.y).max(c.y).ceil() as usize).min(self.height); + let inverse_area = 1.0 / prepared.area; + + let edges = [(b, c), (c, a), (a, b)]; + let covers_boundary = edges.map(|(from, to)| { + let (dx, dy) = (to.x - from.x, to.y - from.y); + let (dx, dy) = if prepared.area < 0.0 { + (dx, dy) + } else { + (-dx, -dy) + }; + dy > 0.0 || (dy == 0.0 && dx < 0.0) + }); + + for y in min_y..max_y { + let sample_y = y as f32 + 0.5; + for x in min_x..max_x { + let sample_x = x as f32 + 0.5; + let mut weights = [0.0; 3]; + let mut inside = true; + for (index, (from, to)) in edges.into_iter().enumerate() { + let weight = + edge(from, to, sample_x, sample_y) * inverse_area; + if weight < 0.0 + || (weight == 0.0 && !covers_boundary[index]) + { + inside = false; + break; + } + weights[index] = weight; + } + if !inside { + continue; + } + let [wa, wb, wc] = weights; + + let depth = wa * a.depth + wb * b.depth + wc * c.depth; + let index = y * self.width + x; + if depth > self.depth[index] { + continue; + } + + let inverse_w = + wa * a.inverse_w + wb * b.inverse_w + wc * c.inverse_w; + let u = (wa * a.u_over_w + wb * b.u_over_w + wc * c.u_over_w) + / inverse_w; + let v = (wa * a.v_over_w + wb * b.v_over_w + wc * c.v_over_w) + / inverse_w; + let texel = texture.sample(u, v); + if texel[3] < ALPHA_TEST { + continue; + } + + let alpha = if material.blend { + f32::from(texel[3]) / 255.0 + } else { + 1.0 + }; + let source = [ + shade[texel[0] as usize] * alpha, + shade[texel[1] as usize] * alpha, + shade[texel[2] as usize] * alpha, + alpha, + ]; + + let destination = &mut self.color[index]; + for (destination, source) in destination.iter_mut().zip(source) + { + let blended = source * 255.0 + + f32::from(*destination) * (1.0 - alpha); + *destination = blended.round().clamp(0.0, 255.0) as u8; + } + self.depth[index] = depth; + } + } + } + + pub(crate) fn resolve(&self, factor: u32) -> Texture { + let factor = factor as usize; + let (width, height) = (self.width / factor, self.height / factor); + let mut output = Texture::new(width as u32, height as u32); + + for (index, pixel) in output.pixels_mut().iter_mut().enumerate() { + let (x, y) = (index % width, index / width); + let mut sum = [0_u32; 4]; + for sample_y in 0..factor { + let row = (y * factor + sample_y) * self.width + x * factor; + for sample in &self.color[row..row + factor] { + for (total, channel) in sum.iter_mut().zip(sample) { + *total += u32::from(*channel); + } + } + } + + if sum[3] == 0 { + continue; + } + let channel = |total: u32| { + (total as f32 / sum[3] as f32 * 255.0).round().min(255.0) as u8 + }; + *pixel = [ + channel(sum[0]), + channel(sum[1]), + channel(sum[2]), + (sum[3] as f32 / (factor * factor) as f32).round() as u8, + ]; + } + output + } +} + +struct Prepared { + vertices: [Vertex; 3], + area: f32, + normal: Vec3, +} + +fn edge(from: Vertex, to: Vertex, x: f32, y: f32) -> f32 { + (to.x - from.x) * (y - from.y) - (to.y - from.y) * (x - from.x) +} diff --git a/packages/modrinth-skin-rendering/src/render.rs b/packages/modrinth-skin-rendering/src/render.rs new file mode 100644 index 00000000000..2c6c1f99ab6 --- /dev/null +++ b/packages/modrinth-skin-rendering/src/render.rs @@ -0,0 +1,376 @@ +use glam::Vec3; +use glam::camera::rh::{proj, view}; + +use crate::raster::Framebuffer; +use crate::scene::Scene; +use crate::texture::{SkinTexture, Texture}; + +#[derive(Clone, Copy, Debug, PartialEq)] +pub struct Camera { + pub position: Vec3, + pub target: Vec3, + pub up: Vec3, + pub fov_y_degrees: f32, + /// Triangles that cross the near plane are not drawn. + pub near: f32, + pub far: f32, +} + +/// Each face is lit by `ambient + directional * max(0, normal · direction)` in linear color. +#[derive(Clone, Copy, Debug, PartialEq)] +pub struct Lighting { + pub ambient: f32, + pub directional: f32, + /// Points from the scene towards the light. + pub direction: Vec3, +} + +impl Default for Lighting { + fn default() -> Self { + Self { + ambient: 2.0 / std::f32::consts::PI, + directional: 1.2 / std::f32::consts::PI, + direction: Vec3::new(2.0, 4.0, 3.0), + } + } +} + +#[derive(Clone, Copy, Debug, PartialEq)] +pub struct RenderOptions { + pub width: u32, + pub height: u32, + /// Samples per pixel along each axis. Clamped to `1..=4`. + pub supersampling: u32, + pub lighting: Lighting, +} + +impl Default for RenderOptions { + fn default() -> Self { + Self { + width: 360, + height: 504, + supersampling: 3, + lighting: Lighting::default(), + } + } +} + +pub fn render( + scene: &Scene, + camera: &Camera, + options: &RenderOptions, +) -> Texture { + let factor = options.supersampling.clamp(1, 4); + let (width, height) = (options.width.max(1), options.height.max(1)); + + let view_projection = + proj::opengl::perspective( + camera.fov_y_degrees.to_radians(), + width as f32 / height as f32, + camera.near, + camera.far, + ) * view::look_at_mat4(camera.position, camera.target, camera.up); + + let mut framebuffer = Framebuffer::new(width * factor, height * factor); + framebuffer.draw(scene, &view_projection, &options.lighting); + framebuffer.resolve(factor) +} + +pub fn render_face(skin: &SkinTexture, size: u32) -> Texture { + let texture = skin.normalized(); + let mut output = Texture::new(size, size); + for y in 0..size { + for x in 0..size { + let (source_x, source_y) = (x * 8 / size, y * 8 / size); + let face = texture.get(8 + source_x, 8 + source_y); + let hat = texture.get(40 + source_x, 8 + source_y); + output.set(x, y, over(hat, face)); + } + } + output +} + +fn over(top: [u8; 4], bottom: [u8; 4]) -> [u8; 4] { + let top_alpha = f32::from(top[3]) / 255.0; + let bottom_alpha = f32::from(bottom[3]) / 255.0 * (1.0 - top_alpha); + let alpha = top_alpha + bottom_alpha; + if alpha <= 0.0 { + return [0; 4]; + } + let channel = |index: usize| { + ((f32::from(top[index]) * top_alpha + + f32::from(bottom[index]) * bottom_alpha) + / alpha) + .round() as u8 + }; + [ + channel(0), + channel(1), + channel(2), + (alpha * 255.0).round() as u8, + ] +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::scene::tests::test_model; + use crate::scene::{Material, Triangle}; + + fn solid(pixel: [u8; 4]) -> Texture { + Texture::from_pixels(1, 1, vec![pixel]).unwrap() + } + + const CAMERA: Camera = Camera { + position: Vec3::new(0.0, 0.0, 4.0), + target: Vec3::ZERO, + up: Vec3::Y, + fov_y_degrees: 60.0, + near: 0.1, + far: 100.0, + }; + + fn options(size: u32) -> RenderOptions { + RenderOptions { + width: size, + height: size, + supersampling: 1, + lighting: Lighting { + ambient: 1.0, + directional: 0.0, + direction: Vec3::Y, + }, + } + } + + fn quad( + z: f32, + half: f32, + texture: usize, + material: Material, + ) -> [Triangle; 2] { + let corners = [ + Vec3::new(-half, -half, z), + Vec3::new(half, -half, z), + Vec3::new(half, half, z), + Vec3::new(-half, half, z), + ]; + [[0, 1, 2], [0, 2, 3]].map(|indices| Triangle { + positions: indices.map(|index| corners[index]), + uvs: [[0.5, 0.5]; 3], + texture, + material, + }) + } + + #[test] + fn an_empty_scene_is_fully_transparent() { + let image = render(&Scene::default(), &CAMERA, &options(8)); + assert!(image.pixels().iter().all(|pixel| *pixel == [0; 4])); + } + + #[test] + fn full_ambient_light_reproduces_the_texture_color() { + let scene = Scene { + textures: vec![solid([200, 100, 50, 255])], + triangles: quad(0.0, 10.0, 0, Material::default()).to_vec(), + }; + let image = render(&scene, &CAMERA, &options(8)); + assert!(image.pixels().iter().all(|p| *p == [200, 100, 50, 255])); + } + + #[test] + fn nearer_opaque_triangles_hide_farther_ones_in_any_order() { + let near = quad(1.0, 10.0, 0, Material::default()); + let far = quad(0.0, 10.0, 1, Material::default()); + for triangles in [[near, far].concat(), [far, near].concat()] { + let scene = Scene { + textures: vec![ + solid([255, 0, 0, 255]), + solid([0, 0, 255, 255]), + ], + triangles, + }; + assert_eq!( + render(&scene, &CAMERA, &options(4)).get(2, 2), + [255, 0, 0, 255] + ); + } + } + + #[test] + fn back_faces_are_culled_unless_double_sided() { + let mut triangles = quad(0.0, 10.0, 0, Material::default()); + for triangle in &mut triangles { + triangle.positions.swap(1, 2); + } + let mut scene = Scene { + textures: vec![solid([9, 9, 9, 255])], + triangles: triangles.to_vec(), + }; + assert_eq!(render(&scene, &CAMERA, &options(4)).get(2, 2), [0; 4]); + + for triangle in &mut scene.triangles { + triangle.material.double_sided = true; + } + assert_eq!( + render(&scene, &CAMERA, &options(4)).get(2, 2), + [9, 9, 9, 255] + ); + } + + #[test] + fn texels_below_the_alpha_cutoff_are_discarded() { + let scene = Scene { + textures: vec![solid([255, 255, 255, 20])], + triangles: quad(0.0, 10.0, 0, Material::default()).to_vec(), + }; + assert_eq!(render(&scene, &CAMERA, &options(4)).get(2, 2), [0; 4]); + } + + #[test] + fn blended_triangles_mix_with_what_is_behind_them() { + let blend = Material { + blend: true, + ..Material::default() + }; + let scene = Scene { + textures: vec![solid([255, 255, 255, 128]), solid([0, 0, 0, 255])], + triangles: [ + quad(1.0, 10.0, 0, blend), + quad(0.0, 10.0, 1, Material::default()), + ] + .concat(), + }; + let pixel = render(&scene, &CAMERA, &options(4)).get(2, 2); + assert_eq!(pixel[3], 255); + assert!((127..=129).contains(&pixel[0]), "{pixel:?}"); + } + + #[test] + fn emissive_triangles_are_brighter_than_lit_ones() { + let lit = Scene { + textures: vec![solid([100, 100, 100, 255])], + triangles: quad(0.0, 10.0, 0, Material::default()).to_vec(), + }; + let mut glowing = lit.clone(); + for triangle in &mut glowing.triangles { + triangle.material.emissive = true; + } + let dim = Lighting { + ambient: 0.5, + ..options(4).lighting + }; + let render_with = |scene| { + render( + scene, + &CAMERA, + &RenderOptions { + lighting: dim, + ..options(4) + }, + ) + .get(2, 2)[0] + }; + assert!(render_with(&lit) < 100); + assert!(render_with(&glowing) > 100); + } + + #[test] + fn faces_turned_towards_the_light_are_brighter() { + let scene = Scene { + textures: vec![solid([200, 200, 200, 255])], + triangles: quad(0.0, 10.0, 0, Material::default()).to_vec(), + }; + let render_lit_from = |direction| { + render( + &scene, + &CAMERA, + &RenderOptions { + lighting: Lighting { + ambient: 0.2, + directional: 0.6, + direction, + }, + ..options(4) + }, + ) + .get(2, 2)[0] + }; + assert!(render_lit_from(Vec3::Z) > render_lit_from(Vec3::NEG_Z)); + } + + #[test] + fn supersampling_softens_edges() { + let scene = Scene { + textures: vec![solid([255, 255, 255, 255])], + triangles: vec![Triangle { + positions: [ + Vec3::new(-1.0, -1.0, 0.0), + Vec3::new(1.0, -1.0, 0.0), + Vec3::new(-1.0, 1.0, 0.0), + ], + uvs: [[0.5, 0.5]; 3], + texture: 0, + material: Material::default(), + }], + }; + let partial = |supersampling| { + render( + &scene, + &CAMERA, + &RenderOptions { + supersampling, + ..options(16) + }, + ) + .pixels() + .iter() + .filter(|pixel| pixel[3] != 0 && pixel[3] != 255) + .count() + }; + assert_eq!(partial(1), 0); + assert!(partial(3) > 0); + } + + #[test] + fn a_player_fills_the_middle_of_the_frame() { + let skin = SkinTexture::new( + Texture::from_pixels(64, 64, vec![[120, 80, 40, 255]; 64 * 64]) + .unwrap(), + ) + .unwrap(); + let scene = Scene::build(&test_model(), &skin, None); + let camera = Camera { + position: Vec3::new(-1.6, 1.2, 5.4), + target: Vec3::new(0.0, 1.0, 0.0), + up: Vec3::Y, + fov_y_degrees: 24.0, + near: 0.1, + far: 100.0, + }; + let image = render(&scene, &camera, &RenderOptions::default()); + assert_eq!((image.width(), image.height()), (360, 504)); + assert_eq!(image.get(180, 252)[3], 255); + assert_eq!(image.get(2, 2)[3], 0); + assert_eq!(image.get(357, 501)[3], 0); + } + + #[test] + fn faces_show_the_hat_layer_over_the_head() { + let mut texture = Texture::new(64, 64); + for y in 8..16 { + for x in 8..16 { + texture.set(x, y, [10, 20, 30, 255]); + } + } + texture.set(40, 8, [200, 0, 0, 255]); + let face = render_face(&SkinTexture::new(texture).unwrap(), 16); + + assert_eq!((face.width(), face.height()), (16, 16)); + assert_eq!(face.get(0, 0), [200, 0, 0, 255]); + assert_eq!(face.get(1, 1), [200, 0, 0, 255]); + assert_eq!(face.get(2, 0), [10, 20, 30, 255]); + assert_eq!(face.get(15, 15), [10, 20, 30, 255]); + } +} diff --git a/packages/modrinth-skin-rendering/src/scene.rs b/packages/modrinth-skin-rendering/src/scene.rs new file mode 100644 index 00000000000..595c60b5816 --- /dev/null +++ b/packages/modrinth-skin-rendering/src/scene.rs @@ -0,0 +1,429 @@ +use glam::{Mat4, Vec3}; + +use crate::ears::{Ears, EarsTextureSlot, QUAD_INDICES, TexturePair}; +use crate::model::{ + BodyPart, CAPE_MATERIAL, Model, OVERLAY_MESH_SUFFIX, PIXELS_PER_UNIT, +}; +use crate::texture::{SkinTexture, Texture}; + +#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)] +pub struct Material { + /// Back faces are drawn too, lit as if they faced the viewer. + pub double_sided: bool, + pub blend: bool, + /// The texture color is added to the lit color. + pub emissive: bool, + /// Blended triangles with a higher order are drawn later. + pub order: u8, +} + +#[derive(Clone, Copy, Debug, PartialEq)] +pub struct Triangle { + /// Counter-clockwise when seen from the front. + pub positions: [Vec3; 3], + pub uvs: [[f32; 2]; 3], + /// An index into [`Scene::textures`]. + pub texture: usize, + pub material: Material, +} + +/// Triangles are in the model's root space. +#[derive(Clone, Debug, Default)] +pub struct Scene { + pub textures: Vec, + pub triangles: Vec, +} + +const BODY: Material = Material { + double_sided: false, + blend: false, + emissive: false, + order: 0, +}; +const OVERLAY: Material = Material { + double_sided: true, + blend: true, + emissive: false, + order: 0, +}; +const CAPE: Material = Material { + double_sided: true, + blend: false, + emissive: false, + order: 0, +}; +const FEATURE: Material = Material { + double_sided: false, + blend: true, + emissive: false, + order: 0, +}; + +const fn glowing(order: u8) -> Material { + Material { + double_sided: false, + blend: true, + emissive: true, + order, + } +} + +impl Scene { + /// Uses the model's rest pose. + pub fn build( + model: &Model, + skin: &SkinTexture, + cape: Option<&Texture>, + ) -> Self { + let slim = + model + .base_mesh_bounds(BodyPart::RightArm) + .is_some_and(|bounds| { + (bounds.max.x - bounds.min.x) * PIXELS_PER_UNIT < 3.5 + }); + let ears = Ears::build(skin, slim); + + let mut scene = Self::default(); + let (skin, skin_glow) = match &ears { + Some(ears) => scene.add_pair(&ears.skin), + None => (scene.add_texture(skin.normalized()), None), + }; + let cape = cape.map(|cape| scene.add_texture(cape.clone())); + + let transforms = model.world_transforms(); + for (node, transform) in model.nodes.iter().zip(&transforms) { + let Some(mesh) = node.mesh.and_then(|mesh| model.meshes.get(mesh)) + else { + continue; + }; + let overlay = node.name.ends_with(OVERLAY_MESH_SUFFIX); + + for primitive in &mesh.primitives { + let is_cape = + primitive.material.as_deref() == Some(CAPE_MATERIAL); + let (texture, material) = match (is_cape, cape) { + (true, Some(cape)) => (cape, CAPE), + (true, None) => continue, + (false, _) if overlay => (skin, OVERLAY), + (false, _) => (skin, BODY), + }; + + for corners in primitive.indices.chunks_exact(3) { + let corners = [corners[0], corners[1], corners[2]] + .map(|index| index as usize); + let triangle = Triangle { + positions: corners.map(|index| { + transform.transform_point3( + primitive.positions[index].into(), + ) + }), + uvs: corners.map(|index| primitive.uvs[index]), + texture, + material, + }; + scene.triangles.push(triangle); + if let (false, Some(glow)) = (is_cape, skin_glow) { + scene.triangles.push(Triangle { + texture: glow, + material: glowing(2), + ..triangle + }); + } + } + } + } + + if let Some(ears) = &ears { + scene.add_ears(model, &transforms, ears, (skin, skin_glow)); + } + scene + } + + pub fn transform(&mut self, matrix: &Mat4) { + for triangle in &mut self.triangles { + triangle.positions = triangle + .positions + .map(|point| matrix.transform_point3(point)); + } + } + + fn add_texture(&mut self, texture: Texture) -> usize { + self.textures.push(texture); + self.textures.len() - 1 + } + + fn add_pair(&mut self, pair: &TexturePair) -> (usize, Option) { + ( + self.add_texture(pair.base.clone()), + pair.emissive + .as_ref() + .map(|emissive| self.add_texture(emissive.clone())), + ) + } + + fn add_ears( + &mut self, + model: &Model, + transforms: &[Mat4], + ears: &Ears, + skin: (usize, Option), + ) { + let slots = [ + EarsTextureSlot::Skin, + EarsTextureSlot::DisplacedSkin, + EarsTextureSlot::Wing, + EarsTextureSlot::Cape, + ] + .map(|slot| match slot { + EarsTextureSlot::Skin => Some(skin), + _ => ears.texture(slot).map(|pair| self.add_pair(pair)), + }); + + let unit = 1.0 / PIXELS_PER_UNIT; + let anchors = BodyPart::ALL.map(|part| { + let node = model.find_node(part.node_name())?; + let bounds = model.base_mesh_bounds(part)?; + Some( + transforms[node] + * Mat4::from_translation(Vec3::new( + bounds.max.x, + bounds.min.y, + bounds.min.z, + )) + * Mat4::from_scale(Vec3::splat(unit)), + ) + }); + + for quad in &ears.quads { + let Some(anchor) = anchors[quad.part as usize] else { + continue; + }; + let Some((texture, glow)) = slots[quad.texture as usize] else { + continue; + }; + let positions = quad + .positions + .map(|position| anchor.transform_point3(position.into())); + + for corners in QUAD_INDICES.chunks_exact(3) { + let corners = [corners[0], corners[1], corners[2]]; + let triangle = Triangle { + positions: corners.map(|index| positions[index]), + uvs: corners.map(|index| quad.uvs[index]), + texture, + material: FEATURE, + }; + self.triangles.push(triangle); + if let Some(glow) = glow { + self.triangles.push(Triangle { + texture: glow, + material: glowing(1), + ..triangle + }); + } + } + } + } +} + +#[cfg(test)] +pub(crate) mod tests { + use super::*; + use crate::model::{Mesh, Node, Primitive}; + + fn cuboid(min: [f32; 3], max: [f32; 3], material: Option<&str>) -> Mesh { + let corner = |x: bool, y: bool, z: bool| { + [ + if x { max[0] } else { min[0] }, + if y { max[1] } else { min[1] }, + if z { max[2] } else { min[2] }, + ] + }; + let faces = [ + [ + (true, false, false), + (false, false, false), + (false, true, false), + (true, true, false), + ], + [ + (false, false, true), + (true, false, true), + (true, true, true), + (false, true, true), + ], + [ + (false, false, false), + (true, false, false), + (true, false, true), + (false, false, true), + ], + [ + (false, true, true), + (true, true, true), + (true, true, false), + (false, true, false), + ], + [ + (false, false, false), + (false, false, true), + (false, true, true), + (false, true, false), + ], + [ + (true, false, true), + (true, false, false), + (true, true, false), + (true, true, true), + ], + ]; + let mut primitive = Primitive { + material: material.map(str::to_owned), + ..Primitive::default() + }; + for face in faces { + let base = primitive.positions.len() as u32; + for (x, y, z) in face { + primitive.positions.push(corner(x, y, z)); + primitive.uvs.push([0.2, 0.2]); + } + primitive + .indices + .extend([0, 1, 2, 0, 2, 3].map(|index| base + index)); + } + Mesh { + primitives: vec![primitive], + } + } + + pub(crate) fn test_model() -> Model { + let parts: [(&str, [f32; 3], [f32; 3]); 6] = [ + ("Head", [-0.25, 1.5, -0.25], [0.25, 2.0, 0.25]), + ("Body", [-0.25, 0.75, -0.125], [0.25, 1.5, 0.125]), + ("Right_Arm", [0.25, 0.75, -0.125], [0.5, 1.5, 0.125]), + ("Left_Arm", [-0.5, 0.75, -0.125], [-0.25, 1.5, 0.125]), + ("Right_Leg", [0.0, 0.0, -0.125], [0.25, 0.75, 0.125]), + ("Left_Leg", [-0.25, 0.0, -0.125], [0.0, 0.75, 0.125]), + ]; + + let mut model = Model { + nodes: vec![Node { + name: "Root".into(), + ..Node::default() + }], + roots: vec![0], + meshes: Vec::new(), + }; + fn add( + model: &mut Model, + parent: usize, + name: String, + mesh: Option, + ) -> usize { + let mesh = mesh.map(|mesh| { + model.meshes.push(mesh); + model.meshes.len() - 1 + }); + model.nodes.push(Node { + name, + mesh, + ..Node::default() + }); + let index = model.nodes.len() - 1; + model.nodes[parent].children.push(index); + index + } + + for (name, min, max) in parts { + let part = add(&mut model, 0, name.to_owned(), None); + add( + &mut model, + part, + format!("{name}_2"), + Some(cuboid(min, max, None)), + ); + let grow = 1.0 / 32.0; + add( + &mut model, + part, + format!("{name}_Layer"), + Some(cuboid( + min.map(|value| value - grow), + max.map(|value| value + grow), + None, + )), + ); + } + add( + &mut model, + 0, + "Cape".to_owned(), + Some(cuboid([-0.3, 0.5, 0.13], [0.3, 1.5, 0.19], Some("cape"))), + ); + model + } + + fn opaque_skin() -> SkinTexture { + SkinTexture::new( + Texture::from_pixels(64, 64, vec![[90, 90, 90, 255]; 64 * 64]) + .unwrap(), + ) + .unwrap() + } + + #[test] + fn the_cape_is_only_drawn_when_a_cape_texture_is_given() { + let model = test_model(); + let skin = opaque_skin(); + + let without = Scene::build(&model, &skin, None); + assert_eq!(without.triangles.len(), 12 * 12); + assert_eq!(without.textures.len(), 1); + + let cape = Texture::new(64, 32); + let with = Scene::build(&model, &skin, Some(&cape)); + assert_eq!(with.triangles.len(), 13 * 12); + let cape_triangles: Vec<_> = + with.triangles.iter().filter(|t| t.texture == 1).collect(); + assert_eq!(cape_triangles.len(), 12); + assert!(cape_triangles.iter().all(|t| t.material == CAPE)); + } + + #[test] + fn overlay_meshes_blend_and_base_meshes_do_not() { + let scene = Scene::build(&test_model(), &opaque_skin(), None); + let blended = + scene.triangles.iter().filter(|t| t.material.blend).count(); + assert_eq!(blended, 6 * 12); + } + + #[test] + fn ears_quads_are_placed_from_the_body_part_anchor() { + let skin = + SkinTexture::new(crate::ears::test_support::default_ears_skin()) + .unwrap(); + let model = test_model(); + + let plain = Scene::build(&model, &opaque_skin(), None); + let scene = Scene::build(&model, &skin, None); + assert_eq!(scene.triangles.len(), plain.triangles.len() + 8); + + let ear = scene.triangles[plain.triangles.len()]; + assert_eq!(ear.material, FEATURE); + let top = ear.positions.iter().map(|p| p.y).fold(f32::MIN, f32::max); + let left = ear.positions.iter().map(|p| p.x).fold(f32::MAX, f32::min); + let right = ear.positions.iter().map(|p| p.x).fold(f32::MIN, f32::max); + assert!((top - 2.5).abs() < 1e-5); + assert!((left + 0.5).abs() < 1e-5); + assert!((right - 0.5).abs() < 1e-5); + assert!(ear.positions.iter().all(|p| p.z.abs() < 1e-5)); + } + + #[test] + fn transforming_a_scene_moves_its_triangles() { + let mut scene = Scene::build(&test_model(), &opaque_skin(), None); + let before = scene.triangles[0].positions[0]; + scene.transform(&Mat4::from_translation(Vec3::Y)); + assert_eq!(scene.triangles[0].positions[0], before + Vec3::Y); + } +} diff --git a/packages/modrinth-skin-rendering/src/texture.rs b/packages/modrinth-skin-rendering/src/texture.rs new file mode 100644 index 00000000000..9f67d767c68 --- /dev/null +++ b/packages/modrinth-skin-rendering/src/texture.rs @@ -0,0 +1,355 @@ +use crate::error::{Error, Result}; + +pub type Rgba = [u8; 4]; + +/// A straight-alpha sRGB image. +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct Texture { + width: u32, + height: u32, + pixels: Vec, +} + +impl Texture { + pub fn new(width: u32, height: u32) -> Self { + Self { + width, + height, + pixels: vec![[0; 4]; width as usize * height as usize], + } + } + + pub fn from_pixels( + width: u32, + height: u32, + pixels: Vec, + ) -> Result { + if pixels.len() != width as usize * height as usize { + return Err(Error::PixelBufferSize { width, height }); + } + Ok(Self { + width, + height, + pixels, + }) + } + + pub const fn width(&self) -> u32 { + self.width + } + + pub const fn height(&self) -> u32 { + self.height + } + + pub fn pixels(&self) -> &[Rgba] { + &self.pixels + } + + pub fn pixels_mut(&mut self) -> &mut [Rgba] { + &mut self.pixels + } + + pub fn as_rgba8(&self) -> &[u8] { + self.pixels.as_flattened() + } + + pub fn get(&self, x: u32, y: u32) -> Rgba { + self.pixels[self.index(x, y)] + } + + pub fn set(&mut self, x: u32, y: u32, pixel: Rgba) { + let index = self.index(x, y); + self.pixels[index] = pixel; + } + + /// Nearest texel. Coordinates outside `0..1` clamp to the edge. + pub fn sample(&self, u: f32, v: f32) -> Rgba { + let x = ((u * self.width as f32).floor() as i64) + .clamp(0, i64::from(self.width) - 1); + let y = ((v * self.height as f32).floor() as i64) + .clamp(0, i64::from(self.height) - 1); + self.pixels[y as usize * self.width as usize + x as usize] + } + + fn index(&self, x: u32, y: u32) -> usize { + assert!(x < self.width && y < self.height); + y as usize * self.width as usize + x as usize + } + + pub fn from_png(data: &[u8]) -> Result { + Self::from_png_with_limit(data, 4096) + } + + pub(crate) fn from_png_with_limit( + data: &[u8], + max_dimension: u32, + ) -> Result { + let mut decoder = png::Decoder::new(std::io::Cursor::new(data)); + decoder + .set_transformations(png::Transformations::normalize_to_color8()); + let mut reader = decoder.read_info()?; + let (width, height) = (reader.info().width, reader.info().height); + if width > max_dimension || height > max_dimension { + return Err(Error::ImageTooLarge); + } + + let mut buffer = + vec![0; reader.output_buffer_size().ok_or(Error::ImageTooLarge)?]; + reader.next_frame(&mut buffer)?; + let pixels = match reader.output_color_type().0 { + png::ColorType::Grayscale => { + buffer.iter().map(|&v| [v, v, v, 255]).collect() + } + png::ColorType::GrayscaleAlpha => buffer + .chunks_exact(2) + .map(|c| [c[0], c[0], c[0], c[1]]) + .collect(), + png::ColorType::Rgb => buffer + .chunks_exact(3) + .map(|c| [c[0], c[1], c[2], 255]) + .collect(), + png::ColorType::Rgba => buffer + .chunks_exact(4) + .map(|c| [c[0], c[1], c[2], c[3]]) + .collect(), + png::ColorType::Indexed => { + unreachable!("normalize_to_color8 expands palettes") + } + }; + Self::from_pixels(width, height, pixels) + } + + pub fn to_png(&self) -> Result> { + let mut encoded = Vec::new(); + let mut encoder = + png::Encoder::new(&mut encoded, self.width, self.height); + encoder.set_color(png::ColorType::Rgba); + encoder.set_depth(png::BitDepth::Eight); + let mut writer = encoder.write_header()?; + writer.write_image_data(self.as_rgba8())?; + writer.finish()?; + Ok(encoded) + } +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] +pub enum ArmModel { + Classic, + Slim, +} + +pub(crate) const SKIN_SIZE: u32 = 64; +const LEGACY_SKIN_HEIGHT: u32 = 32; + +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct SkinTexture { + raw: Texture, +} + +impl SkinTexture { + pub fn new(raw: Texture) -> Result { + if raw.width() != SKIN_SIZE + || ![SKIN_SIZE, LEGACY_SKIN_HEIGHT].contains(&raw.height()) + { + return Err(Error::SkinDimensions { + width: raw.width(), + height: raw.height(), + }); + } + Ok(Self { raw }) + } + + pub fn from_png(data: &[u8]) -> Result { + Self::new(Texture::from_png_with_limit(data, SKIN_SIZE)?) + } + + pub const fn raw(&self) -> &Texture { + &self.raw + } + + pub const fn is_legacy(&self) -> bool { + self.raw.height() == LEGACY_SKIN_HEIGHT + } + + /// The 64x64 texture the vanilla client draws. See [`normalize_skin_pixels`]. + pub fn normalized(&self) -> Texture { + let mut texture = Texture::new(SKIN_SIZE, SKIN_SIZE); + texture.pixels_mut()[..self.raw.pixels().len()] + .copy_from_slice(self.raw.pixels()); + normalize_skin_pixels(texture.pixels_mut(), self.is_legacy()); + texture + } + + /// Slim if the arm columns that only classic skins use are transparent. + pub fn detect_arm_model(&self) -> ArmModel { + let painted = (20..32) + .flat_map(|y| (54..56).map(move |x| (x, y))) + .any(|(x, y)| self.raw.get(x, y)[3] != 0); + if painted { + ArmModel::Classic + } else { + ArmModel::Slim + } + } +} + +/// Converts legacy skins and makes the base layer opaque, as +/// `SkinTextureDownloader#processLegacySkin` does in Minecraft 25w16a. +/// +/// `pixels` is a 64x64 buffer. A legacy skin goes in the top half and the bottom half is +/// overwritten. +pub fn normalize_skin_pixels(pixels: &mut [Rgba], legacy: bool) { + assert_eq!(pixels.len(), (SKIN_SIZE * SKIN_SIZE) as usize); + + if legacy { + set_alpha(pixels, 0, 32, 64, 64, 0); + convert_legacy_skin(pixels); + apply_notch_transparency_hack(pixels); + } + for (x1, y1, x2, y2) in [(0, 0, 32, 16), (0, 16, 64, 32), (16, 48, 48, 64)] + { + set_alpha(pixels, x1, y1, x2, y2, 255); + } +} + +fn convert_legacy_skin(pixels: &mut [Rgba]) { + const FACE_COPIES: [(usize, usize, isize, isize, usize, usize); 12] = [ + (4, 16, 16, 32, 4, 4), + (8, 16, 16, 32, 4, 4), + (0, 20, 24, 32, 4, 12), + (4, 20, 16, 32, 4, 12), + (8, 20, 8, 32, 4, 12), + (12, 20, 16, 32, 4, 12), + (44, 16, -8, 32, 4, 4), + (48, 16, -8, 32, 4, 4), + (40, 20, 0, 32, 4, 12), + (44, 20, -8, 32, 4, 12), + (48, 20, -16, 32, 4, 12), + (52, 20, -8, 32, 4, 12), + ]; + + for (x, y, off_x, off_y, width, height) in FACE_COPIES { + for row in 0..height { + for col in 0..width { + let dst_x = (x as isize + off_x) as usize + (width - 1 - col); + let dst_y = (y as isize + off_y) as usize + row; + pixels[dst_x + dst_y * SKIN_SIZE as usize] = + pixels[x + col + (y + row) * SKIN_SIZE as usize]; + } + } + } +} + +fn apply_notch_transparency_hack(pixels: &mut [Rgba]) { + let (x1, y1, x2, y2) = (32, 0, 64, 32); + let has_transparency = (y1..y2) + .flat_map(|y| (x1..x2).map(move |x| (x, y))) + .any(|(x, y)| pixels[x + y * SKIN_SIZE as usize][3] < 128); + if !has_transparency { + set_alpha(pixels, x1, y1, x2, y2, 0); + } +} + +fn set_alpha( + pixels: &mut [Rgba], + x1: usize, + y1: usize, + x2: usize, + y2: usize, + alpha: u8, +) { + for y in y1..y2 { + for x in x1..x2 { + pixels[x + y * SKIN_SIZE as usize][3] = alpha; + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn filled(width: u32, height: u32, pixel: Rgba) -> Texture { + Texture::from_pixels( + width, + height, + vec![pixel; (width * height) as usize], + ) + .unwrap() + } + + #[test] + fn rejects_textures_that_are_not_skin_sized() { + assert!(SkinTexture::new(Texture::new(64, 64)).is_ok()); + assert!(SkinTexture::new(Texture::new(64, 32)).is_ok()); + assert!(SkinTexture::new(Texture::new(32, 32)).is_err()); + assert!(SkinTexture::new(Texture::new(128, 128)).is_err()); + } + + #[test] + fn normalizing_makes_the_base_layer_opaque_and_keeps_overlays() { + let skin = SkinTexture::new(filled(64, 64, [10, 20, 30, 40])).unwrap(); + let normalized = skin.normalized(); + assert_eq!(normalized.get(8, 8), [10, 20, 30, 255]); + assert_eq!(normalized.get(20, 50), [10, 20, 30, 255]); + assert_eq!(normalized.get(40, 8), [10, 20, 30, 40]); + assert_eq!(normalized.get(0, 40), [10, 20, 30, 40]); + } + + #[test] + fn legacy_skins_gain_mirrored_left_limbs_and_lose_an_opaque_hat() { + let mut raw = filled(64, 32, [0, 0, 0, 255]); + raw.set(4, 20, [200, 0, 0, 255]); + let skin = SkinTexture::new(raw).unwrap(); + assert!(skin.is_legacy()); + + let normalized = skin.normalized(); + assert_eq!(normalized.width(), 64); + assert_eq!(normalized.height(), 64); + assert_eq!(normalized.get(23, 52), [200, 0, 0, 255]); + assert_eq!(normalized.get(40, 8)[3], 0); + assert_eq!(normalized.get(0, 40)[3], 0); + } + + #[test] + fn a_legacy_hat_with_transparency_is_kept() { + let mut raw = filled(64, 32, [5, 5, 5, 255]); + raw.set(33, 1, [0, 0, 0, 0]); + let normalized = SkinTexture::new(raw).unwrap().normalized(); + assert_eq!(normalized.get(40, 8), [5, 5, 5, 255]); + } + + #[test] + fn detects_slim_arms_from_the_unpainted_arm_columns() { + let classic = SkinTexture::new(filled(64, 64, [1, 1, 1, 255])).unwrap(); + assert_eq!(classic.detect_arm_model(), ArmModel::Classic); + + let mut raw = filled(64, 64, [1, 1, 1, 255]); + for y in 20..32 { + for x in 54..56 { + raw.set(x, y, [0, 0, 0, 0]); + } + } + let slim = SkinTexture::new(raw).unwrap(); + assert_eq!(slim.detect_arm_model(), ArmModel::Slim); + } + + #[test] + fn sampling_clamps_to_the_texture_edges() { + let mut texture = Texture::new(2, 2); + texture.set(0, 0, [1, 0, 0, 255]); + texture.set(1, 1, [2, 0, 0, 255]); + assert_eq!(texture.sample(-0.5, -0.5), [1, 0, 0, 255]); + assert_eq!(texture.sample(1.5, 1.5), [2, 0, 0, 255]); + assert_eq!(texture.sample(0.75, 0.75), [2, 0, 0, 255]); + } + + #[test] + fn png_round_trips() { + let mut texture = Texture::new(3, 2); + texture.set(2, 1, [9, 8, 7, 6]); + let decoded = Texture::from_png(&texture.to_png().unwrap()).unwrap(); + assert_eq!(decoded, texture); + } +} diff --git a/packages/ui/package.json b/packages/ui/package.json index e1d61773f7e..0e444227427 100644 --- a/packages/ui/package.json +++ b/packages/ui/package.json @@ -67,9 +67,6 @@ "@modrinth/blog": "workspace:*", "@modrinth/utils": "workspace:*", "@tanstack/vue-query": "5.101.4", - "@tresjs/cientos": "^4.3.0", - "@tresjs/core": "^4.3.4", - "@tresjs/post-processing": "^2.4.0", "@types/dompurify": "^3.0.5", "@types/markdown-it": "^14.1.1", "@types/three": "^0.172.0", @@ -96,7 +93,6 @@ "motion-v": "^2.2.1", "obscenity": "^0.4.6", "overlayscrollbars": "^2.15.1", - "postprocessing": "^6.37.6", "qrcode.vue": "^3.4.1", "three": "^0.172.0", "vue-i18n": "^10.0.0", diff --git a/packages/ui/src/components/skin/SkinButton.vue b/packages/ui/src/components/skin/SkinButton.vue index 1d6d248097c..cec61fed8a4 100644 --- a/packages/ui/src/components/skin/SkinButton.vue +++ b/packages/ui/src/components/skin/SkinButton.vue @@ -95,15 +95,15 @@ watch( -
-
-
+ +
+