local-upscaler 0.1.0__tar.gz

local_upscaler-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

local_upscaler-0.1.0/PKG-INFO

@@ -0,0 +1,269 @@
+Metadata-Version: 2.4
+Name: local-upscaler
+Version: 0.1.0
+Summary: Local, open-source image upscaling + sharpening. Wraps pretrained Real-ESRGAN weights.
+Author: Upscaler contributors
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/Maty3k/Upscaler
+Project-URL: Issues, https://github.com/Maty3k/Upscaler/issues
+Keywords: super-resolution,upscaling,real-esrgan,image-enhancement,sharpening
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: torch>=2.0
+Requires-Dist: numpy>=1.23
+Requires-Dist: Pillow>=9.0
+Requires-Dist: tqdm>=4.64
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: gradio>=6.0; extra == "dev"
+Requires-Dist: onnxruntime>=1.16; extra == "dev"
+Requires-Dist: onnx>=1.15; extra == "dev"
+Requires-Dist: onnxscript>=0.1; extra == "dev"
+Requires-Dist: pypdfium2>=4; extra == "dev"
+Requires-Dist: pillow-heif>=0.13; extra == "dev"
+Requires-Dist: imageio-ffmpeg>=0.4; extra == "dev"
+Provides-Extra: gui
+Requires-Dist: gradio>=6.0; extra == "gui"
+Requires-Dist: pypdfium2>=4; extra == "gui"
+Requires-Dist: pillow-heif>=0.13; extra == "gui"
+Requires-Dist: onnxruntime>=1.16; extra == "gui"
+Provides-Extra: pdf
+Requires-Dist: pypdfium2>=4; extra == "pdf"
+Provides-Extra: onnx
+Requires-Dist: onnxruntime>=1.16; extra == "onnx"
+Requires-Dist: onnx>=1.15; extra == "onnx"
+Requires-Dist: onnxscript>=0.1; extra == "onnx"
+Provides-Extra: directml
+Requires-Dist: onnxruntime-directml>=1.17; extra == "directml"
+Requires-Dist: onnx>=1.15; extra == "directml"
+Requires-Dist: onnxscript>=0.1; extra == "directml"
+Provides-Extra: video
+Requires-Dist: imageio-ffmpeg>=0.4; extra == "video"
+Provides-Extra: face
+Requires-Dist: spandrel>=0.4; extra == "face"
+Requires-Dist: spandrel_extra_arches>=0.2; extra == "face"
+Requires-Dist: opencv-python-headless>=4.9; extra == "face"
+Dynamic: license-file
+
+# Upscaler
+
+Local, open-source image **upscaling + sharpening**. Runs entirely on your
+machine (CPU, NVIDIA CUDA, or Apple-Silicon MPS) on top of pretrained
+[Real-ESRGAN](https://github.com/xinntao/Real-ESRGAN) weights — no cloud, no API keys.
+
+> Upscaling, deblur, a Gradio GUI, and an ONNX backend all work end-to-end.
+> See [`docs/PROJECT_NOTES.md`](docs/PROJECT_NOTES.md) for full planning, design
+> decisions, the "why it can make photos worse" lesson, and the
+> train-your-own-model playbook (incl. AMD/Windows/ROCm).
+
+## Install
+
+Python **3.9–3.12** recommended (PyTorch wheels).
+
+> **On a Windows PC with an AMD GPU?** See
+> [`docs/SETUP-WINDOWS-AMD.md`](docs/SETUP-WINDOWS-AMD.md) for a full
+> GPU-accelerated setup (WSL2 + ROCm) — dramatically faster than CPU/MPS for video.
+
+```bash
+pip install "local-upscaler[gui]"
+```
+
+That's it — the `upscaler` command is now available, and model weights download
+automatically (with checksum verification) the first time you use them.
+Extras: `[gui]` (GUI), `[onnx]` (ONNX backend), `[face]` (face restore),
+`[video]` (bundled ffmpeg).
+
+<details>
+<summary>Install from source instead (development)</summary>
+
+```bash
+git clone https://github.com/Maty3k/Upscaler.git && cd Upscaler
+python -m venv .venv && source .venv/bin/activate   # .venv\Scripts\activate on Windows
+pip install -e ".[gui]"     # or ".[dev]" for tests
+```
+
+</details>
+
+## Usage
+
+### CLI
+
+```bash
+# 4x upscale (default model)
+upscaler photo.jpg -o photo_4x.png
+
+# 2x, and apply a sharpening pass afterwards
+upscaler photo.jpg --scale 2 --sharpen
+
+# deblur motion blur (NAFNet) before upscaling
+upscaler blurry.jpg --deblur --scale 4
+
+# stronger sharpen, explicit device
+upscaler photo.jpg --sharpen 1.5 --device mps
+
+# batch a whole folder
+upscaler ./input_dir -o ./output_dir --scale 4
+
+# anime / illustration model
+upscaler art.png --model realesrgan-x4plus-anime
+
+# restore faces after upscaling (GFPGAN; needs the [face] extra)
+upscaler portrait.jpg --scale 4 --face --face-strength 0.8
+
+# upscale a video frame-by-frame (offline, keeps audio; needs ffmpeg)
+upscaler video clip.mp4 -o clip_2x.mp4 --scale 2
+
+# ONNX Runtime backend (exports once from the .pth, then torch-free + often
+# faster on CPU). Works with --deblur and batching too.
+upscaler photo.jpg --scale 4 --onnx
+
+upscaler --list-models
+```
+
+#### Convert formats (no AI)
+
+```bash
+upscaler convert photo.png -o photo.webp        # format from extension
+upscaler convert photo.png -f JPEG -q 80        # explicit format + quality
+upscaler convert photo.png -o out.webp --lossless
+upscaler convert ./folder -o ./out -f WebP      # batch a directory
+```
+
+Supports PNG / JPEG / WebP / AVIF / HEIC / JPEG 2000 / TIFF / GIF / BMP / ICO /
+ICNS / TGA / PCX / DIB / SGI / PPM (AVIF needs Pillow ≥ 11.2 or pillow-heif;
+HEIC needs pillow-heif). Alpha is flattened onto a white background for formats
+that can't store it (JPEG/BMP/PPM/PCX).
+
+#### Remove background & batch
+
+```bash
+upscaler removebg photo.jpg -o cutout.png          # transparent PNG (needs [onnx])
+upscaler removebg ./folder -o ./out --feather 2     # batch a directory
+upscaler batch ./folder -o ./out --op upscale --scale 2     # upscale every image
+upscaler batch ./folder -o ./out --op convert -f WebP       # convert every image
+upscaler batch ./folder -o ./out --op removebg              # cut out every image
+```
+
+`batch` runs one operation over many images and skips unreadable files without
+aborting. The GUI also has **Colorize** (DDColor) and **Inpaint / object removal**
+(LaMa) tabs — both fully local; Colorize needs the `[face]` extra, Inpaint needs
+only torch.
+
+### Video (frame-by-frame)
+
+```bash
+upscaler video clip.mp4 -o clip_2x.mp4 --scale 2          # keeps audio
+upscaler video clip.mp4 -o clip_2x_60.mp4 --scale 2 --fps 60   # + smooth to 60fps
+upscaler video clip.mp4 -o clip_4k.mp4 --scale 4 --size 3840    # fit longest edge to 4K
+upscaler video clip.mp4 -o test.mp4 --scale 2 --start 0 --end 5  # trim: first 5s only
+upscaler video ./clips -o ./out --scale 2                 # batch a whole folder
+```
+
+Offline frame-by-frame upscaling (split → upscale each frame → re-encode + mux
+audio). `--fps` adds motion-interpolated frames (ffmpeg `minterpolate`) for
+smoother motion — duration unchanged, audio stays in sync, but it's slow. Needs
+**ffmpeg** (system install, or `pip install -e ".[video]"` for a bundled binary). It's a render-and-wait feature — minutes per minute of footage —
+and since frames are upscaled independently, very fine detail can shimmer slightly
+between frames (a temporal model would be needed to fully remove that).
+
+#### Image ⇄ PDF
+
+```bash
+upscaler pdf build a.png b.png c.png -o out.pdf   # images → multi-page PDF
+upscaler pdf build ./folder -o out.pdf            # all images in a directory
+upscaler pdf extract in.pdf -o ./pages --dpi 200  # PDF pages → PNGs
+upscaler pdf extract in.pdf                        # → ./in_pages/ next to the PDF
+```
+
+Weights download automatically on first use and are cached under
+`upscaler/weights/` (override with `UPSCALER_WEIGHTS_DIR`).
+
+### GUI (drag-and-drop)
+
+```bash
+pip install -e ".[gui]"
+python app.py            # opens a local web UI at http://127.0.0.1:7860
+```
+
+A full local web app with a tab per tool: **Upscale & Enhance** (with deblur /
+denoise, JPEG de-blocking, face restore), **Colorize** (DDColor), **Remove
+Objects** (LaMa inpainting), **Remove BG**, **Video** upscaling, **Convert &
+Documents** (formats + image ⇄ PDF), **Batch**, a **Lian Li Screen** composer
+for the 8.8″ case panel, and a **Library** of everything you export. Runs
+entirely on your machine — nothing is uploaded anywhere. (PDF support uses
+`pypdfium2`, included in the `.[gui]` extra or installable on its own via
+`.[pdf]`.)
+
+### Library
+
+```python
+from PIL import Image
+from upscaler import Upscaler, enhance
+
+# reuse one loaded model across many images
+up = Upscaler(scale=4, device="auto")
+up.upscale_file("in.jpg", "out.png")
+
+# one-shot upscale + sharpen
+result = enhance(Image.open("in.jpg"), scale=2, sharpen=1.0)
+result.save("out.png")
+```
+
+## How it works
+
+- `upscaler/models/rrdbnet.py` — the RRDBNet generator, vendored so we don't
+  depend on the fragile `basicsr`/`realesrgan` stack. Layer names match the
+  official checkpoints, which load with `strict=True`.
+- `upscaler/models/registry.py` + `weights.py` — model registry and lazy,
+  integrity-checked weight download.
+- `upscaler/engine.py` — device selection and **tiled inference** (large images
+  are processed in padded tiles to bound memory and avoid seams).
+- `upscaler/models/nafnet.py` + `deblur.py` — vendored **NAFNet** and the deblur
+  stage. NAFNet's channel attention pools globally, so it runs on the whole image
+  (not tiled) and is applied at native resolution before upscaling.
+- `upscaler/pipeline.py` + `sharpen.py` — `enhance()`: optional deblur → upscale
+  → optional unsharp mask.
+- `upscaler/onnx_export.py` + `onnx_engine.py` — export each model to ONNX with
+  dynamic shapes (one-time, needs torch) and run it via ONNX Runtime. The engines
+  import only `onnxruntime`/`numpy`/`Pillow`, so cached `.onnx` files run
+  torch-free. Verified to match the torch output (≤1/255 per pixel).
+
+## Performance notes
+
+- **CPU works** but is slow on large images; keep `--tile` at 512 or lower.
+- **Apple Silicon:** `--device mps` is much faster than CPU.
+- **CUDA:** add `--fp16` for a speed/memory win.
+- **AMD / Intel GPU on native Windows:** torch can't reach these, but the ONNX
+  engine can via DirectML — `pip uninstall onnxruntime` then
+  `pip install -e ".[directml]"`, and add `--onnx` (CLI) or tick the ONNX
+  checkbox (GUI Upscale/Video → Advanced). For maximum AMD speed use WSL2 +
+  ROCm instead: see `docs/SETUP-WINDOWS-AMD.md`.
+
+## Testing
+
+```bash
+pip install -e ".[dev]"
+pytest        # architecture + tiling tests; run on CPU, no weights download
+```
+
+## Roadmap
+
+- [x] Phase 0 — scaffold, packaging, license
+- [x] Phase 1 — Real-ESRGAN upscaling (lib + CLI), tiling, lazy weights, unsharp sharpen
+- [x] Phase 2 — model-based deblur stage (NAFNet) for genuinely blurry input
+- [x] Phase 3 — Gradio drag-and-drop GUI (`app.py`)
+- [x] Phase 4 — ONNX Runtime path for faster, PyTorch-free CPU inference (`--onnx`)
+
+## Licensing
+
+This project is **Apache-2.0** (see `LICENSE`). Pretrained weights are
+downloaded at runtime and never redistributed in this repo; each carries its own
+upstream terms. The core Real-ESRGAN weights are BSD-3-Clause, but several
+optional models are **not**: the community upscalers (4x-UltraSharp, Remacri,
+NMKD) and the CodeFormer face restorer are non-commercial — their dropdown
+entries say so; check upstream terms before commercial use. Credit to
+Xintao Wang et al. for Real-ESRGAN and to BasicSR for the RRDBNet architecture,
+and to Chen et al. / megvii-research for NAFNet (MIT). NAFNet deblur weights are
+mirrored on Hugging Face (`nyanko7/nafnet-models`); the upstream originals are on
+the official NAFNet Google Drive.