vsview-split-planes 0.1.0__tar.gz

vsview_split_planes-0.1.0/.gitignore

@@ -0,0 +1,220 @@
+# 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
+.vsjet/
+src/vsview/global_settings.json

vsview_split_planes-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.

vsview_split_planes-0.1.0/PKG-INFO

@@ -0,0 +1,55 @@
+Metadata-Version: 2.4
+Name: vsview-split-planes
+Version: 0.1.0
+Summary: A vsview plugin displaying video clips' constituent planes
+Project-URL: Source Code, https://github.com/Jaded-Encoding-Thaumaturgy/vs-view/tree/main/src/plugins/split-planes
+Project-URL: Bug Tracker, https://github.com/Jaded-Encoding-Thaumaturgy/vs-view/issues
+Project-URL: Contact, https://discord.gg/XTpc6Fa9eB
+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
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: vsjetpack>=1.1.0
+Requires-Dist: vsview
+Description-Content-Type: text/markdown
+
+# vsview-split-planes
+
+A [vsview](https://github.com/Jaded-Encoding-Thaumaturgy/vs-view) plugin displaying video clips' constituent planes.
+
+## Requirements
+
+- [vsview](https://github.com/Jaded-Encoding-Thaumaturgy/vs-view)
+- [vsjetpack](https://github.com/Jaded-Encoding-Thaumaturgy/vs-jetpack) 1.1.0 or later
+
+## Installation
+
+```bash
+pip install vsview-split-planes
+```

vsview_split_planes-0.1.0/README.md

@@ -0,0 +1,14 @@
+# vsview-split-planes
+
+A [vsview](https://github.com/Jaded-Encoding-Thaumaturgy/vs-view) plugin displaying video clips' constituent planes.
+
+## Requirements
+
+- [vsview](https://github.com/Jaded-Encoding-Thaumaturgy/vs-view)
+- [vsjetpack](https://github.com/Jaded-Encoding-Thaumaturgy/vs-jetpack) 1.1.0 or later
+
+## Installation
+
+```bash
+pip install vsview-split-planes
+```

vsview_split_planes-0.1.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["hatchling", "versioningit"]
+build-backend = "hatchling.build"
+
+[project]
+name = "vsview-split-planes"
+dynamic = ["version"]
+description = "A vsview plugin displaying video clips' constituent planes"
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.12"
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
+    "Typing :: Typed",
+]
+dependencies = ["vsview", "vsjetpack>=1.1.0"]
+
+[project.entry-points.vsview]
+vsview_split_planes = "vsview_split_planes"
+
+[project.urls]
+"Source Code" = "https://github.com/Jaded-Encoding-Thaumaturgy/vs-view/tree/main/src/plugins/split-planes"
+"Bug Tracker" = "https://github.com/Jaded-Encoding-Thaumaturgy/vs-view/issues"
+"Contact" = "https://discord.gg/XTpc6Fa9eB"
+
+[tool.uv.sources]
+vsview = { workspace = true }
+
+[tool.hatch.version]
+source = "versioningit"
+
+[tool.versioningit.vcs]
+match = ["split-planes/v*"]
+default-tag = "split-planes/v0.0.0"
+
+[tool.versioningit.tag2version]
+rmprefix = "split-planes/v"

vsview_split_planes-0.1.0/src/vsview_split_planes/__init__.py

@@ -0,0 +1,246 @@
+from math import copysign
+from typing import Annotated, Any, Literal, assert_never
+
+from jetpytools import fallback
+from pydantic import BaseModel
+from PySide6.QtWidgets import QBoxLayout, QDoubleSpinBox, QHBoxLayout, QLabel, QVBoxLayout, QWidget, QWidgetAction
+from vapoursynth import VideoNode
+from vstools import scale_mask, stack_planes
+
+from vsview.api import (
+    Checkbox,
+    Dropdown,
+    LocalSettingsModel,
+    PluginAPI,
+    PluginGraphicsView,
+    PluginSettings,
+    SegmentedControl,
+    Spin,
+    WidgetPluginBase,
+    hookimpl,
+)
+
+
+class GlobalSettings(BaseModel):
+    autofit: Annotated[
+        bool,
+        Checkbox(
+            label="Auto fit",
+            text="Enable autofit by default",
+            tooltip="Enable autofit by default when opening the plugin tab",
+        ),
+    ] = False
+
+    shift_float_chroma: Annotated[
+        bool,
+        Checkbox(
+            label="Shift float chroma",
+            text="",
+            tooltip="If checked, shift U and V by +0.5 when working in float YUV formats",
+        ),
+    ] = True
+    offset_chroma: Annotated[
+        float | Literal["min", "max"],
+        Dropdown(
+            label="Offset chroma",
+            items=[("Fixed", 0.0), ("Min", "min"), ("Max", "max")],
+            tooltip="Apply chroma plane offseting\n"
+            '- "min": match luma minimum\n'
+            '- "max": match luma maximum\n'
+            "- Fixed: use a custom float value",
+        ),
+    ] = 0.0
+    mode: Annotated[
+        Literal["h", "v"],
+        Dropdown(
+            label="Mode",
+            items=[("Horizontal", "h"), ("Vertical", "v")],
+            tooltip="Stacking direction",
+        ),
+    ] = "h"
+    write_plane_name: Annotated[
+        bool,
+        Checkbox(
+            label="Write plane name",
+            text="",
+            tooltip='If checked, overlays the short plane name ("Y", "U", "V", "R", "G", ...) on each plane.',
+        ),
+    ] = True
+    alignment: Annotated[
+        int,
+        Spin(
+            label="Alignment",
+            min=1,
+            max=9,
+            tooltip='Text alignment for plane labels (only used if "Write plane name" is checked`).',
+        ),
+    ] = 7
+    scale: Annotated[
+        int,
+        Spin(
+            label="Scale",
+            min=1,
+            tooltip='Font scale for plane labels (only used if "Write plane name" is checked`).',
+        ),
+    ] = 1
+
+
+class LocalSettings(LocalSettingsModel):
+    autofit: bool | None = None
+    offset_chroma: float | Literal["min", "max"] | None = None
+
+
+class SplitPlanesPlugin(WidgetPluginBase[GlobalSettings, LocalSettings]):
+    identifier = "jet_vsview_split_planes"
+    display_name = "Split Planes"
+
+    def __init__(self, parent: QWidget, api: PluginAPI) -> None:
+        super().__init__(parent, api)
+
+        self.view = SplitPlanesView(self, self.api, self.settings)
+        self.current_layout = QHBoxLayout(self)
+        self.current_layout.setContentsMargins(0, 0, 0, 0)
+        self.current_layout.setSpacing(0)
+        self.current_layout.addWidget(self.view)
+
+        self.api.globalSettingsChanged.connect(self.on_settings_changed)
+
+    def on_settings_changed(self) -> None:
+        self.view.autofit = fallback(self.settings.local_.autofit, self.settings.global_.autofit)
+        self.view.refresh()
+        self.view.sync_offset_controls_from_settings()
+
+
+class SplitPlanesView(PluginGraphicsView):
+    def __init__(
+        self, parent: QWidget, api: PluginAPI, settings: PluginSettings[GlobalSettings, LocalSettings]
+    ) -> None:
+        super().__init__(parent, api)
+        self.settings = settings
+
+        self.context_menu.addSeparator()
+
+        # Container widget for the offset chroma controls
+        self._offset_container = QWidget(self.context_menu)
+        layout = QVBoxLayout(self._offset_container)
+        layout.setContentsMargins(8, 4, 8, 4)
+        layout.setSpacing(4)
+
+        # Label
+        label = QLabel("Offset Chroma", self._offset_container)
+        layout.addWidget(label)
+
+        # Segmented control for Min/Max/Fixed
+        self.offset_segment = SegmentedControl(
+            ["Fixed", "Min", "Max"],
+            self._offset_container,
+            QBoxLayout.Direction.LeftToRight,
+        )
+        layout.addWidget(self.offset_segment)
+
+        # Spinbox for "Fixed" mode
+        self.fixed_spinbox_container = QWidget(self._offset_container)
+        spinbox_layout = QHBoxLayout(self.fixed_spinbox_container)
+        spinbox_layout.setContentsMargins(0, 0, 0, 0)
+        spinbox_layout.setSpacing(4)
+
+        self.offset_spinbox = QDoubleSpinBox(self.fixed_spinbox_container)
+        self.offset_spinbox.setRange(-1.0, 1.0)
+        self.offset_spinbox.setSingleStep(0.1)
+        self.offset_spinbox.setDecimals(3)
+        self.offset_spinbox.setValue(0.0)
+        self.offset_spinbox.setToolTip("Fixed offset value for chroma planes")
+        spinbox_layout.addWidget(self.offset_spinbox)
+
+        layout.addWidget(self.fixed_spinbox_container)
+
+        # Add container to context menu via QWidgetAction
+        action = QWidgetAction(self.context_menu)
+        action.setDefaultWidget(self._offset_container)
+        self.context_menu.addAction(action)
+
+        # Connect signals
+        self.offset_segment.segmentChanged.connect(self.on_offset_segment_changed)
+        self.offset_spinbox.valueChanged.connect(self.on_offset_spinbox_changed)
+
+        # Set initial state from global settings
+        self.sync_offset_controls_from_settings()
+
+        if self.settings.local_.autofit:
+            self.autofit_action.trigger()
+
+    def parent(self) -> SplitPlanesPlugin:
+        if isinstance(parent := super().parent(), SplitPlanesPlugin):
+            return parent
+
+        raise NotImplementedError
+
+    def get_node(self, clip: VideoNode) -> VideoNode:
+        if (offset_chroma := self.settings.local_.offset_chroma) is None:
+            offset = False
+        elif isinstance(offset_chroma, (float, int)):
+            offset = scale_mask(abs(offset_chroma), 32, clip)
+            offset = copysign(offset, offset_chroma)
+        else:
+            offset = offset_chroma
+
+        return stack_planes(
+            clip,
+            self.settings.global_.shift_float_chroma,
+            offset,
+            self.settings.global_.mode,
+            self.settings.global_.write_plane_name,
+            self.settings.global_.alignment,
+            self.settings.global_.scale,
+        )
+
+    def sync_offset_controls_from_settings(self) -> None:
+        match offset := self.settings.local_.offset_chroma:
+            case int() | float() | None:
+                self.offset_segment.index = 0
+                self.fixed_spinbox_container.setEnabled(True)
+                self.offset_spinbox.setValue(float(offset or 0))
+            case "min":
+                self.offset_segment.index = 1
+                self.fixed_spinbox_container.setEnabled(False)
+            case "max":
+                self.offset_segment.index = 2
+                self.fixed_spinbox_container.setEnabled(False)
+            case _:
+                assert_never(offset)
+
+    def on_offset_segment_changed(self, index: int) -> None:
+        self.fixed_spinbox_container.setEnabled(index == 0)
+        parent = self.parent()
+
+        match index:
+            case 0:
+                parent.update_local_settings(offset_chroma=self.offset_spinbox.value())
+            case 1:
+                parent.update_local_settings(offset_chroma="min")
+            case 2:
+                parent.update_local_settings(offset_chroma="max")
+            case _:
+                raise NotImplementedError
+
+        self.refresh()
+
+    def on_offset_spinbox_changed(self, value: float) -> None:
+        if self.offset_segment.index == 0:
+            self.parent().update_local_settings(offset_chroma=value)
+            self.refresh()
+
+    def _on_autofit_action(self) -> None:
+        super()._on_autofit_action()
+
+        self.parent().update_local_settings(autofit=self.autofit)
+
+
+@hookimpl
+def vsview_register_toolpanel() -> type[WidgetPluginBase[Any, Any]]:
+    return SplitPlanesPlugin
+
+
+@hookimpl
+def vsview_register_tooldock() -> type[WidgetPluginBase[Any, Any]]:
+    return SplitPlanesPlugin