nativeres 0.1.0__tar.gz

nativeres-0.1.0/.gitignore

@@ -0,0 +1,219 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# vsjet files
+.vsjet

nativeres-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jaded Encoding Thaumaturgy
+
+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 notice 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.

nativeres-0.1.0/PKG-INFO

@@ -0,0 +1,363 @@
+Metadata-Version: 2.4
+Name: nativeres
+Version: 0.1.0
+Summary: Descale analysis tools for VapourSynth
+Project-URL: Documentation, https://github.com/Jaded-Encoding-Thaumaturgy/nativeres/blob/master/README.md
+Project-URL: Source Code, https://github.com/Jaded-Encoding-Thaumaturgy/nativeres
+Project-URL: Bug Tracker, https://github.com/Jaded-Encoding-Thaumaturgy/nativeres/issues
+Project-URL: Contact, https://discord.gg/XTpc6Fa9eB
+Author-email: Vardë <ichunjo.le.terrible@gmail.com>
+Maintainer-email: Vardë <ichunjo.le.terrible@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 Jaded Encoding Thaumaturgy
+        
+        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 notice 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.
+License-File: LICENSE
+Keywords: encoding,native,resolution,vapoursynth,video,video-processing
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: jetpytools
+Requires-Dist: numpy>=2.0.0
+Requires-Dist: pyside6>=6.10.1
+Requires-Dist: rich
+Requires-Dist: scipy>=1.16.0
+Requires-Dist: typer>=0.24.0
+Requires-Dist: vsjetengine>=1.2.0
+Requires-Dist: vsjetpack>=1.3.0
+Provides-Extra: plugin
+Requires-Dist: vsview-nativeres; extra == 'plugin'
+Description-Content-Type: text/markdown
+
+# nativeres
+
+`nativeres` is a set of descale analysis tools for VapourSynth.
+
+It combines and supersedes the following tools:
+
+- Original **getscaler** by **cN3rd** https://gist.github.com/cN3rd/51077b6abf45b684bf9a3c657d859b43
+- Original **getnative** by **Infiziert90** https://github.com/Infiziert90/getnative
+- **GetFnative** by **YomikoR** https://github.com/YomikoR/GetFnative
+- **getfscaler** https://github.com/Jaded-Encoding-Thaumaturgy/getscaler
+
+The package provides:
+
+- A CLI for frame analysis
+- A Python API for VapourSynth scripts and tooling
+- An optional **[VSView](https://github.com/Jaded-Encoding-Thaumaturgy/vs-view)** plugin
+
+## What it does
+
+`nativeres` helps answer three common descale questions:
+
+- `getnative`: What native resolution was this frame likely upscaled from?
+- `getscaler`: Which scaler most likely produced this upscale?
+- `getfreq`: Does the frame's frequency distribution show likely scaling artifacts or native-resolution clues?
+
+## Installation
+
+```bash
+# Install the package with `pip`
+pip install nativeres
+# Or with `uv`
+uv tool install nativeres
+```
+
+### VSView plugin
+
+This repository also contains a **[VSView](https://github.com/Jaded-Encoding-Thaumaturgy/vs-view)** plugin package.
+
+```bash
+pip install nativeres[plugin]
+# Or with uv
+uv tool install nativeres[plugin]
+```
+
+The plugin registers as a VSView tool panel and tool dock under `Native Resolution`.
+
+Usage can be found in the **[plugin README](https://github.com/Jaded-Encoding-Thaumaturgy/nativeres/blob/master/src/plugin/README.md)**.
+
+## Usage
+
+### CLI
+
+`nativeres` accepts regular media files, images, and VapourSynth scripts (`.vpy` / `.py`). For scripts, the first VapourSynth output is used.
+
+- Displays a plot to determine the native resolution height for the frame 15000 with the Bilinear kernel:
+
+  ```bash
+  nativeres getnative file.m2ts --frame 15000 --dim-mode height --kernel bilinear
+  ```
+
+  ![`nativeres getnative`](/assets/getnative_plot.svg)
+
+  Right-click the plot to open the context menu, where you can reset zoom and copy or export the plot as `PNG`, `SVG`, `JSON`, or `CSV`.
+
+- Displays a table showing the errors of the inverse scalers at height 800 for frame 15000.
+
+  ```bash
+  nativeres getscaler file.m2ts 800 --frame 15000 --dim-mode height
+  ```
+
+  ![`nativeres getscaler`](/assets/getscaler_table.svg)
+
+- Compute and display a DCT-based frequency plot for the selected frame.
+
+  ```bash
+  nativeres getfreq file.m2ts --frame 15000
+  ```
+
+  ![`nativeres getfreq`](/assets/getfreq_plot.svg)
+
+  The frequency plot uses the same right-click context menu for reset zoom plus copy/export actions.
+
+### Python
+
+```python
+from nativeres import getnative
+from vskernels import Bilinear
+
+clip = ...  # Your VapourSynth clip
+
+results = getnative(
+    clip,
+    frame_num=15000,
+    dimensions=((clip.width, h) for h in range(540, 901)),
+    kernel=Bilinear(),
+)
+
+best = min(results, key=lambda result: result.error)
+print(best.dim.height, best.error)
+```
+
+## CLI Reference
+
+Main help:
+
+![`nativeres --help`](/assets/nativeres_help.svg)
+
+`getnative` help:
+
+![`nativeres getnative --help`](/assets/getnative_help.svg)
+
+`getscaler` help:
+
+![`nativeres getscaler --help`](/assets/getscaler_help.svg)
+
+`getfreq` help:
+
+![`nativeres getfreq --help`](/assets/getfreq_help.svg)
+
+## Python API
+
+<!-- markdownlint-disable -->
+
+<a href="src/nativeres/funcs.py#L70"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>function</kbd> `getnative`
+
+```python
+getnative(
+    clip: VideoNode,
+    frame_num: int,
+    dimensions: Iterable[tuple[float, float]],
+    kernel: ComplexKernelLike,
+    crop: tuple[LeftCrop, RightCrop, TopCrop, BottomCrop] | None = None,
+    shift: tuple[TopShift, LeftShift] = (0, 0),
+    metric_mode: MetricMode = 'MAE',
+    borders_aware: bool | int | tuple[LeftCrop, RightCrop, TopCrop, BottomCrop] = 8,
+    progress_cb: Callable[[int, int], None] | None = None,
+    func: FuncExcept | None = None,
+    **kwargs: Any
+) -> list[GetNativeResult]
+```
+
+Determine the best (fractional) native resolution for a selected frame.
+
+This checks a list of candidate resolutions by descaling the selected frame using `kernel` and comparing the result to the source frame using `metric_mode`.
+
+**Args:**
+
+- <b>`clip`</b>: Source clip.
+- <b>`frame_num`</b>: Frame index in `clip` to evaluate.
+- <b>`dimensions`</b>: Iterable of candidate resolutions to test. Each item may be a `(width, height)` tuple.
+- <b>`kernel`</b>: Kernel used to perform each descale attempt.
+- <b>`crop`</b>: Optional crop to apply before descaling. Aspect ratio is preserved.
+- <b>`shift`</b>: Optional pixel shift applied during descaling: `(top_shift, left_shift)`.
+- <b>`metric_mode`</b>: Error metric to use: `"MSE"`, `"MAE"`, or `"RMSE"`.
+- <b>`borders_aware`</b>: Amount (or crop tuple) to ignore at image borders to avoid edge noise when computing the metric.
+- <b>`progress_cb`</b>: Optional progress callback called as `progress_cb(current, total)`.
+- <b>`func`</b>: Function returned for custom error handling.
+- <b>`kwargs`</b>: Additional arguments passed to the Rescale class.
+
+**Returns:**
+A list of `GetNativeResult` items. Each item contains the tested fractional resolution (`dim`) and its associated `error`.
+
+---
+
+<a href="src/nativeres/funcs.py#L160"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>function</kbd> `getscaler`
+
+```python
+getscaler(
+    clip: VideoNode,
+    frame_num: int,
+    width: float,
+    height: float,
+    kernels: ComplexKernelLike | Sequence[ComplexKernelLike],
+    base_width: int | None = None,
+    base_height: int | None = None,
+    crop: tuple[LeftCrop, RightCrop, TopCrop, BottomCrop] | None = None,
+    shift: tuple[TopShift, LeftShift] = (0, 0),
+    metric_mode: MetricMode = 'MAE',
+    mask: MaskLike | None = None,
+    borders_aware: bool | int | tuple[LeftCrop, RightCrop, TopCrop, BottomCrop] = 8,
+    func: FuncExcept | None = None,
+    **kwargs: Any
+) → list[GetScalerResult]
+```
+
+Find the best inverse scaler (kernel) for a given frame of a clip.
+
+Each supplied kernel is tested by descaling the selected frame to the provided `(width, height)` and computing an error metric.
+
+**Args:**
+
+- <b>`clip`</b>: Source clip.
+- <b>`frame_num`</b>: Frame index in `clip` to evaluate.
+- <b>`width`</b>: Width to be descaled to. If passed as a float, a fractional descale is performed.
+- <b>`height`</b>: Height to be descaled to. If passed as a float, a fractional descale is performed.
+- <b>`kernels`</b>: A single kernel or a sequence of kernels to evaluate.
+- <b>`base_width`</b>: Optional integer height to contain the clip within.
+- <b>`base_height`</b>: Optional integer width to contain the clip within.
+- <b>`crop`</b>: Optional crop to apply before descaling. Aspect ratio is preserved.
+- <b>`shift`</b>: Pixel shifts applied during descaling: `(top_shift, left_shift)`.
+- <b>`metric_mode`</b>: Error metric to use: `"MSE"`, `"MAE"`, or `"RMSE"`.
+- <b>`mask`</b>: Optional edge-detection mask to reduce noise influence on the metric.
+- <b>`borders_aware`</b>: Amount (or crop tuple) to ignore at image borders to avoid edge noise when computing the metric.
+- <b>`func`</b>: Function returned for custom error handling.
+- <b>`kwargs`</b>: Additional arguments passed to the Rescale class.
+
+**Returns:**
+A list of `GetScalerResult` items. Each item contains the evaluated `kernel` and its associated `error`.
+
+---
+
+<a href="src/nativeres/funcs.py#L234"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>function</kbd> `get_descale_error`
+
+```python
+get_descale_error(
+    clip: VideoNode,
+    frame_num: int,
+    width: float,
+    height: float,
+    kernel: ComplexKernelLike,
+    base_width: int | None = None,
+    base_height: int | None = None,
+    crop: tuple[LeftCrop, RightCrop, TopCrop, BottomCrop] | None = None,
+    shift: tuple[TopShift, LeftShift] = (0, 0),
+    metric_mode: MetricMode = 'MAE',
+    mask: MaskLike | None = None,
+    borders_aware: bool | int | tuple[LeftCrop, RightCrop, TopCrop, BottomCrop] = 8,
+    func: FuncExcept | None = None,
+    **kwargs: Any
+) → float
+```
+
+Compute the descale error for a selected frame using a specific kernel.
+
+**Args:**
+
+- <b>`clip`</b>: Source clip.
+- <b>`frame_num`</b>: Frame index in `clip` to evaluate.
+- <b>`width`</b>: Width to be descaled to. If passed as a float, a fractional descale is performed.
+- <b>`height`</b>: Height to be descaled to. If passed as a float, a fractional descale is performed.
+- <b>`kernel`</b>: Kernel used for the descale operation.
+- <b>`base_width`</b>: Optional integer height to contain the clip within.
+- <b>`base_height`</b>: Optional integer width to contain the clip within.
+- <b>`crop`</b>: Optional crop to apply before descaling. Aspect ratio is preserved.
+- <b>`shift`</b>: Pixel shifts applied during descaling: `(top_shift, left_shift)`.
+- <b>`metric_mode`</b>: Error metric to use: `"MSE"`, `"MAE"`, or `"RMSE"`.
+- <b>`mask`</b>: Optional edge-detection mask to reduce noise influence on the metric.
+- <b>`borders_aware`</b>: Amount (or crop tuple) to ignore at image borders to avoid edge noise when computing the metric.
+- <b>`func`</b>: Function returned for custom error handling.
+- <b>`kwargs`</b>: Additional arguments passed to the Rescale class.
+
+**Returns:**
+The computed error as a `float`. Lower values indicate a better descale match.
+
+---
+
+<a href="src/nativeres/funcs.py#L328"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>function</kbd> `get_dct_distribution`
+
+```python
+get_dct_distribution(
+    clip: VideoNode,
+    frame_num: int,
+    cull_rate: float = 3.0,
+    func: FuncExcept | None = None
+) → tuple[NpFloatArray1D, NpFloatArray1D]
+```
+
+Calculate DCT frequency distribution for both horizontal and vertical dimensions of a selected frame.
+
+**Args:**
+
+- <b>`clip`</b>: Source clip.
+- <b>`frame_num`</b>: Frame index in `clip` to analyze.
+- <b>`cull_rate`</b>: Cull rate for DCT coefficients.
+- <b>`func`</b>: Function returned for custom error handling.
+
+**Returns:**
+A tuple of (dct_h, dct_v).
+
+---
+
+## <kbd>class</kbd> `GetNativeResult`
+
+Result for `getnative`, pairing a fractional resolution with an error metric.
+
+---
+
+## <kbd>class</kbd> `GetScalerResult`
+
+Result for `getscaler`, pairing a kernel with its error.
+
+---
+
+## <kbd>class</kbd> `ResolutionFrac`
+
+Fractional resolution expressed as floating-point width and height.
+
+## Notes
+
+- You should always visually verify the results on multiple frames before committing to a descale setup.