depth2normal 2.0.0__tar.gz → 2.0.1__tar.gz

{depth2normal-2.0.0 → depth2normal-2.0.1}/PKG-INFO

@@ -1,10 +1,11 @@
 Metadata-Version: 2.5
 Name: depth2normal
-Version: 2.0.0
+Version: 2.0.1
 Summary: Convert depth maps to normal maps, from a photo if you have no depth map
-Project-URL: Homepage, https://github.com/cobanov/depth2normal
+Project-URL: Homepage, https://depth2normal.cobanov.dev
 Project-URL: Repository, https://github.com/cobanov/depth2normal
 Project-URL: Issues, https://github.com/cobanov/depth2normal/issues
+Project-URL: Changelog, https://github.com/cobanov/depth2normal/releases
 Author: Mert Cobanov
 License-Expression: MIT
 License-File: LICENSE
@@ -37,7 +38,7 @@ Requires-Dist: onnx; extra == 'onnx'
 Description-Content-Type: text/markdown
 
 <p align="center">
-  <img src="assets/hero.webp" alt="A Mars photograph next to the normal map depth2normal produced from it" width="700">
+  <img src="https://raw.githubusercontent.com/cobanov/depth2normal/main/assets/hero.webp" alt="A Mars photograph next to the normal map depth2normal produced from it" width="700">
 </p>
 
 <p align="center">
@@ -48,9 +49,9 @@ Description-Content-Type: text/markdown
 <p align="center">
   <a href="https://pypi.org/project/depth2normal/"><img alt="pypi" src="https://img.shields.io/pypi/v/depth2normal?color=8c8cff&labelColor=1a1a1a"></a>
   <a href="https://github.com/cobanov/depth2normal/actions/workflows/ci.yml"><img alt="ci" src="https://img.shields.io/github/actions/workflow/status/cobanov/depth2normal/ci.yml?branch=main&color=8c8cff&labelColor=1a1a1a"></a>
-  <img alt="tests" src="https://img.shields.io/badge/tests-71-8c8cff?labelColor=1a1a1a">
+  <img alt="tests" src="https://img.shields.io/badge/tests-87-8c8cff?labelColor=1a1a1a">
   <img alt="python" src="https://img.shields.io/badge/python-3.10%2B-8c8cff?labelColor=1a1a1a">
-  <a href="LICENSE"><img alt="licence" src="https://img.shields.io/badge/licence-MIT-8c8cff?labelColor=1a1a1a"></a>
+  <a href="https://github.com/cobanov/depth2normal/blob/main/LICENSE"><img alt="licence" src="https://img.shields.io/badge/licence-MIT-8c8cff?labelColor=1a1a1a"></a>
 </p>
 
 ---
@@ -123,7 +124,7 @@ depth2normal.export_onnx("depth2normal.onnx")        # needs [onnx]
 ## From a photo
 
 <p align="center">
-  <img src="assets/pipeline.webp" alt="A photograph, the depth map estimated from it, and the resulting normal map" width="700">
+  <img src="https://raw.githubusercontent.com/cobanov/depth2normal/main/assets/pipeline.webp" alt="A photograph, the depth map estimated from it, and the resulting normal map" width="700">
 </p>
 
 `--estimate` runs [Depth Anything V2 Small](https://huggingface.co/onnx-community/depth-anything-v2-small)
@@ -263,9 +264,10 @@ uv run pytest
 uv run ruff check .
 uv run ruff format --check .
 uv run python tools/build_web_models.py
+wrangler pages deploy web --project-name depth2normal   # the demo
 ```
 
 ## Licence
 
 MIT. The depth model is Apache-2.0 and is downloaded, not vendored. Image
-credits are in [assets/CREDITS.md](assets/CREDITS.md).
+credits are in [assets/CREDITS.md](https://github.com/cobanov/depth2normal/blob/main/assets/CREDITS.md).

{depth2normal-2.0.0 → depth2normal-2.0.1}/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="assets/hero.webp" alt="A Mars photograph next to the normal map depth2normal produced from it" width="700">
+  <img src="https://raw.githubusercontent.com/cobanov/depth2normal/main/assets/hero.webp" alt="A Mars photograph next to the normal map depth2normal produced from it" width="700">
 </p>
 
 <p align="center">
@@ -10,9 +10,9 @@
 <p align="center">
   <a href="https://pypi.org/project/depth2normal/"><img alt="pypi" src="https://img.shields.io/pypi/v/depth2normal?color=8c8cff&labelColor=1a1a1a"></a>
   <a href="https://github.com/cobanov/depth2normal/actions/workflows/ci.yml"><img alt="ci" src="https://img.shields.io/github/actions/workflow/status/cobanov/depth2normal/ci.yml?branch=main&color=8c8cff&labelColor=1a1a1a"></a>
-  <img alt="tests" src="https://img.shields.io/badge/tests-71-8c8cff?labelColor=1a1a1a">
+  <img alt="tests" src="https://img.shields.io/badge/tests-87-8c8cff?labelColor=1a1a1a">
   <img alt="python" src="https://img.shields.io/badge/python-3.10%2B-8c8cff?labelColor=1a1a1a">
-  <a href="LICENSE"><img alt="licence" src="https://img.shields.io/badge/licence-MIT-8c8cff?labelColor=1a1a1a"></a>
+  <a href="https://github.com/cobanov/depth2normal/blob/main/LICENSE"><img alt="licence" src="https://img.shields.io/badge/licence-MIT-8c8cff?labelColor=1a1a1a"></a>
 </p>
 
 ---
@@ -85,7 +85,7 @@ depth2normal.export_onnx("depth2normal.onnx")        # needs [onnx]
 ## From a photo
 
 <p align="center">
-  <img src="assets/pipeline.webp" alt="A photograph, the depth map estimated from it, and the resulting normal map" width="700">
+  <img src="https://raw.githubusercontent.com/cobanov/depth2normal/main/assets/pipeline.webp" alt="A photograph, the depth map estimated from it, and the resulting normal map" width="700">
 </p>
 
 `--estimate` runs [Depth Anything V2 Small](https://huggingface.co/onnx-community/depth-anything-v2-small)
@@ -225,9 +225,10 @@ uv run pytest
 uv run ruff check .
 uv run ruff format --check .
 uv run python tools/build_web_models.py
+wrangler pages deploy web --project-name depth2normal   # the demo
 ```
 
 ## Licence
 
 MIT. The depth model is Apache-2.0 and is downloaded, not vendored. Image
-credits are in [assets/CREDITS.md](assets/CREDITS.md).
+credits are in [assets/CREDITS.md](https://github.com/cobanov/depth2normal/blob/main/assets/CREDITS.md).

{depth2normal-2.0.0 → depth2normal-2.0.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "depth2normal"
-version = "2.0.0"
+version = "2.0.1"
 description = "Convert depth maps to normal maps, from a photo if you have no depth map"
 readme = "README.md"
 license = "MIT"
@@ -53,9 +53,10 @@ all = ["onnx", "onnxruntime>=1.20; python_version >= '3.11'"]
 depth2normal = "depth2normal.cli:cli"
 
 [project.urls]
-Homepage = "https://github.com/cobanov/depth2normal"
+Homepage = "https://depth2normal.cobanov.dev"
 Repository = "https://github.com/cobanov/depth2normal"
 Issues = "https://github.com/cobanov/depth2normal/issues"
+Changelog = "https://github.com/cobanov/depth2normal/releases"
 
 [tool.ruff]
 target-version = "py310"

{depth2normal-2.0.0 → depth2normal-2.0.1}/src/depth2normal/__init__.py

@@ -11,7 +11,7 @@ from depth2normal.converter import (
 from depth2normal.estimate import estimate_depth
 from depth2normal.onnx_export import build_model, export_onnx
 
-__version__ = "2.0.0"
+__version__ = "2.0.1"
 __all__ = [
     "METHODS",
     "RANGES",

{depth2normal-2.0.0 → depth2normal-2.0.1}/tests/test_cli.py

@@ -59,6 +59,9 @@ def test_export_writes_a_model(tmp_path):
 
 
 def test_version_flag():
+    """The CLI reports the installed version, whatever it is."""
+    from importlib.metadata import version
+
     result = CliRunner().invoke(cli, ["--version"])
     assert result.exit_code == 0
-    assert "2.0.0" in result.output
+    assert version("depth2normal") in result.output

{depth2normal-2.0.0 → depth2normal-2.0.1}/uv.lock

@@ -31,7 +31,7 @@ wheels = [
 
 [[package]]
 name = "depth2normal"
-version = "2.0.0"
+version = "2.0.1"
 source = { editable = "." }
 dependencies = [
     { name = "click" },

depth2normal-2.0.1/web/_headers

@@ -0,0 +1,18 @@
+# Cloudflare Pages serves static assets with `max-age=14400` and ignores any
+# Cache-Control set here, which was measured rather than assumed: the CSP below
+# arrives on every response, the cache header does not. So the lever for
+# style.css and app.js is the version query on their links in index.html, which
+# is bumped whenever either file changes. index.html itself is served with
+# max-age=0, so a bumped query is picked up on the next visit.
+
+/*
+  X-Content-Type-Options: nosniff
+  Referrer-Policy: no-referrer
+  X-Frame-Options: SAMEORIGIN
+  Permissions-Policy: geolocation=(), camera=(), microphone=(), payment=(), usb=()
+  # Everything the page runs is either its own or from one of three hosts:
+  # jsdelivr for ONNX Runtime and its WebAssembly, Google Fonts for the two
+  # typefaces, and Hugging Face for the depth model, fetched only when the
+  # visitor asks for depth estimation. Nothing is ever sent anywhere: there is
+  # no form action and no endpoint to post an image to.
+  Content-Security-Policy: default-src 'self'; script-src 'self' 'wasm-unsafe-eval' https://cdn.jsdelivr.net; worker-src 'self' blob:; style-src 'self' https://fonts.googleapis.com; font-src https://fonts.gstatic.com; img-src 'self' blob: data:; connect-src 'self' https://cdn.jsdelivr.net https://huggingface.co https://*.hf.co; form-action 'none'; frame-ancestors 'self'; base-uri 'none'; object-src 'none'

{depth2normal-2.0.0 → depth2normal-2.0.1}/web/app.js

@@ -22,7 +22,9 @@ const ui = {
   sample: el("sample"),
   source: el("source"),
   sourceLabel: el("source-label"),
+  sourceMeta: el("source-meta"),
   output: el("output"),
+  outputMeta: el("output-meta"),
   controls: el("controls"),
   method: el("method"),
   strength: el("strength"),
@@ -39,13 +41,14 @@ const conversionSessions = new Map();
 let depthSession = null;
 let state = { depth: null, photo: null };
 
-const status = (text) => {
+const status = (text, busy = false) => {
   ui.status.textContent = text;
+  ui.status.dataset.busy = String(busy);
 };
 
 async function conversionSession(name) {
   if (!conversionSessions.has(name)) {
-    status(`Loading ${name}.onnx`);
+    status(`Loading ${name}.onnx`, true);
     conversionSessions.set(
       name,
       await ort.InferenceSession.create(`models/${name}.onnx`),
@@ -166,13 +169,15 @@ async function render() {
     image.data.set([rgb[i * 3], rgb[i * 3 + 1], rgb[i * 3 + 2], 255], i * 4);
   }
   paint(ui.output, image);
-  status(`${width} x ${height}, converted in ${elapsed} ms`);
+  ui.sourceMeta.textContent = `${width} \u00d7 ${height}`;
+  ui.outputMeta.textContent = `${elapsed} ms`;
+  status("");
 }
 
 async function loadDepthSession() {
   if (depthSession) return depthSession;
 
-  status("Downloading the depth model (27 MB, once)");
+  status("Downloading the depth model (27 MB, once)", true);
   const response = await fetch(DEPTH_MODEL_URL);
   if (!response.ok) throw new Error(`model download failed: ${response.status}`);
 
@@ -185,7 +190,10 @@ async function loadDepthSession() {
     if (done) break;
     chunks.push(value);
     received += value.length;
-    status(`Downloading the depth model: ${Math.round((100 * received) / total)}%`);
+    status(
+      `Downloading the depth model: ${Math.round((100 * received) / total)}%`,
+      true,
+    );
   }
 
   const bytes = new Uint8Array(received);
@@ -194,7 +202,7 @@ async function loadDepthSession() {
     bytes.set(chunk, at);
     at += chunk.length;
   }
-  status("Starting the depth model");
+  status("Starting the depth model", true);
   depthSession = await ort.InferenceSession.create(bytes);
   return depthSession;
 }
@@ -231,7 +239,7 @@ async function estimate() {
       }
     }
 
-    status("Estimating depth");
+    status("Estimating depth", true);
     const started = performance.now();
     const results = await session.run({
       pixel_values: new ort.Tensor("float32", input, [1, 3, height, width]),
@@ -259,7 +267,7 @@ async function estimate() {
     target.drawImage(source, 0, 0, scaled.width, scaled.height);
 
     state.depth = toDepth(pixelsOf(scaled));
-    ui.sourceLabel.textContent = "Depth (estimated)";
+    ui.sourceLabel.textContent = "Depth, estimated";
     await render();
     status(`Depth estimated in ${elapsed} ms`);
   } catch (error) {
@@ -334,5 +342,7 @@ ui.reset.addEventListener("click", () => {
   ui.stage.classList.add("empty");
   ui.controls.hidden = true;
   ui.file.value = "";
+  ui.sourceMeta.textContent = "";
+  ui.outputMeta.textContent = "";
   status("");
 });

depth2normal-2.0.1/web/index.html

@@ -0,0 +1,215 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover" />
+    <title>depth2normal: a depth map goes in, a normal map comes out</title>
+    <meta
+      name="description"
+      content="Turn a depth map into a normal map in your browser, or estimate the depth of a photograph first. Runs on a 1.7 KB ONNX graph in your own tab; nothing is uploaded."
+    />
+    <meta name="theme-color" content="#0c0c0e" />
+    <meta name="robots" content="index, follow, max-image-preview:large" />
+    <link rel="canonical" href="https://depth2normal.cobanov.dev/" />
+
+    <meta property="og:type" content="website" />
+    <meta property="og:site_name" content="depth2normal" />
+    <meta property="og:title" content="depth2normal: a depth map goes in, a normal map comes out" />
+    <meta
+      property="og:description"
+      content="Drop a depth map, get a normal map. No depth map? It estimates one from a photograph. Everything runs in your browser, nothing is uploaded."
+    />
+    <meta property="og:url" content="https://depth2normal.cobanov.dev/" />
+    <meta property="og:locale" content="en_US" />
+    <meta property="og:image" content="https://depth2normal.cobanov.dev/assets/og.png" />
+    <meta property="og:image:type" content="image/png" />
+    <meta property="og:image:width" content="1200" />
+    <meta property="og:image:height" content="630" />
+    <meta property="og:image:alt" content="A photograph of Mars beside the normal map depth2normal produced from it" />
+    <meta name="twitter:card" content="summary_large_image" />
+    <meta name="twitter:site" content="@mertcobanov" />
+    <meta name="twitter:creator" content="@mertcobanov" />
+    <meta name="twitter:title" content="depth2normal: a depth map goes in, a normal map comes out" />
+    <meta
+      name="twitter:description"
+      content="Drop a depth map, get a normal map. No depth map? It estimates one from a photograph. Everything runs in your browser."
+    />
+    <meta name="twitter:image" content="https://depth2normal.cobanov.dev/assets/og.png" />
+
+    <!-- The favicon is the page's own subject: a normal map of a sphere. -->
+    <link
+      rel="icon"
+      href="data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 32 32'%3E%3Cdefs%3E%3CradialGradient id='n' cx='30%25' cy='28%25'%3E%3Cstop offset='0' stop-color='%23d7ffbe'/%3E%3Cstop offset='.46' stop-color='%238c8cff'/%3E%3Cstop offset='.78' stop-color='%235b5bd6'/%3E%3Cstop offset='1' stop-color='%233a3aa8'/%3E%3C/radialGradient%3E%3C/defs%3E%3Crect width='32' height='32' rx='8' fill='%230c0c0e'/%3E%3Ccircle cx='16' cy='16' r='10' fill='url(%23n)'/%3E%3C/svg%3E"
+    />
+
+    <link rel="preconnect" href="https://fonts.googleapis.com" />
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
+    <link
+      href="https://fonts.googleapis.com/css2?family=Geist:wght@400;500;600&family=JetBrains+Mono:wght@400;500&display=swap"
+      rel="stylesheet"
+    />
+    <!-- Bump ?v= when either file changes: Pages caches assets for four
+         hours and ignores the Cache-Control in _headers. -->
+    <link rel="stylesheet" href="style.css?v=2" />
+
+    <script type="application/ld+json">
+      {
+        "@context": "https://schema.org",
+        "@type": "SoftwareApplication",
+        "name": "depth2normal",
+        "url": "https://depth2normal.cobanov.dev/",
+        "applicationCategory": "MultimediaApplication",
+        "operatingSystem": "Any browser",
+        "description": "Convert a depth map to a normal map in the browser, or estimate depth from a photograph first. Nothing is uploaded.",
+        "offers": { "@type": "Offer", "price": "0", "priceCurrency": "USD" },
+        "license": "https://opensource.org/licenses/MIT"
+      }
+    </script>
+  </head>
+
+  <body>
+    <a class="skip-link" href="#main">Skip to the tool</a>
+
+    <header class="masthead">
+      <div class="shell masthead-inner">
+        <a class="wordmark" href="/">
+          <span class="wordmark-mark" aria-hidden="true"></span>
+          depth2normal
+        </a>
+        <nav>
+          <a href="https://github.com/cobanov/depth2normal">GitHub</a>
+          <a href="https://pypi.org/project/depth2normal/">PyPI</a>
+          <code class="install">pip install depth2normal</code>
+        </nav>
+      </div>
+    </header>
+
+    <main id="main">
+      <section class="hero shell">
+        <h1>A depth map goes in, a normal map comes out.</h1>
+        <p class="lead">
+          The graph doing the work is <strong>1.7 KB of ONNX</strong> and it runs
+          in this tab, so your image never leaves the browser. No depth map?
+          Drop a photograph and it will estimate one first.
+        </p>
+      </section>
+
+      <section class="stage shell empty" id="stage">
+        <div class="dropzone" id="dropzone">
+          <h2>Drop a depth map here</h2>
+          <p>
+            or <button type="button" id="pick" class="link-button">choose a file</button>,
+            or <button type="button" id="sample" class="link-button">use the sample</button>
+          </p>
+          <p>A photograph works too: its depth can be estimated in the tab.</p>
+          <input id="file" type="file" accept="image/*" hidden />
+        </div>
+
+        <figure class="panel">
+          <figcaption>
+            <span id="source-label">Depth</span>
+            <span class="value mono" id="source-meta"></span>
+          </figcaption>
+          <canvas id="source"></canvas>
+        </figure>
+
+        <figure class="panel">
+          <figcaption>
+            <span>Normal</span>
+            <span class="value mono" id="output-meta"></span>
+          </figcaption>
+          <canvas id="output"></canvas>
+        </figure>
+      </section>
+
+      <section class="controls shell" id="controls" hidden>
+        <div class="field">
+          <span class="label">Method</span>
+          <select id="method">
+            <option value="gaussian-0.5">gaussian, sigma 0.5</option>
+            <option value="gaussian-1">gaussian, sigma 1</option>
+            <option value="gaussian-2" selected>gaussian, sigma 2</option>
+            <option value="gaussian-3">gaussian, sigma 3</option>
+            <option value="sobel">sobel</option>
+            <option value="scharr">scharr</option>
+          </select>
+        </div>
+
+        <div class="field">
+          <label class="label" for="strength">
+            Strength <output id="strength-value">1.0</output>
+          </label>
+          <input id="strength" type="range" min="0.1" max="10" step="0.1" value="1" />
+        </div>
+
+        <div class="field">
+          <label class="label" for="range">Depth range</label>
+          <select id="range">
+            <option value="auto">auto</option>
+            <option value="minmax">minmax</option>
+            <option value="raw">raw</option>
+          </select>
+        </div>
+
+        <div class="field">
+          <span class="label">Direction</span>
+          <label class="toggle">
+            <input id="invert" type="checkbox" />
+            Invert, if bright means far
+          </label>
+        </div>
+
+        <div class="actions">
+          <button type="button" id="download" class="primary">Download PNG</button>
+          <button type="button" id="estimate">Estimate depth from photo</button>
+          <button type="button" id="reset" class="quiet">Start over</button>
+        </div>
+      </section>
+
+      <p class="status shell" id="status" role="status"></p>
+
+      <section class="notes shell">
+        <article class="note">
+          <h2>What it does</h2>
+          <p>
+            Two gradients, one vector per pixel, normalised to unit length. The
+            depth is rescaled to a fixed range first, so an 8-bit and a 16-bit
+            copy of one map give the same normals.
+          </p>
+        </article>
+        <article class="note">
+          <h2>Rings in the output</h2>
+          <p>
+            Those are the source depth map's 8-bit steps, amplified by the
+            derivative. Raise sigma until they go, or feed a 16-bit depth map,
+            where the steps are 256 times smaller.
+          </p>
+        </article>
+        <article class="note">
+          <h2>Same thing offline</h2>
+          <p>
+            <code>pip install depth2normal</code> gives you the CLI, the ONNX
+            export and camera intrinsics for metric depth. The models on this
+            page come from <code>depth2normal export</code>.
+          </p>
+        </article>
+      </section>
+    </main>
+
+    <footer>
+      <div class="shell">
+        <p>
+          Depth estimation, when you ask for it, fetches Depth Anything V2 Small
+          (27 MB, Apache-2.0) and runs it here as well. Nothing is uploaded
+          either way.
+        </p>
+        <p>
+          <a href="https://github.com/cobanov/depth2normal">MIT</a> ·
+          <a href="https://cobanov.dev">cobanov.dev</a>
+        </p>
+      </div>
+    </footer>
+
+    <script type="module" src="app.js?v=2"></script>
+  </body>
+</html>