diff --git a/.dockerignore b/.dockerignore index b98ee7d..036dd2c 100644 --- a/.dockerignore +++ b/.dockerignore @@ -3,7 +3,9 @@ dist/ input/ output/ temp/ +vapoursynth-user/ *.log .git/ .gitignore README.md +ffmpeg-dist/ \ No newline at end of file diff --git a/.gitignore b/.gitignore index 17332f1..af78f92 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ dist/ input/ output/ temp/ +vapoursynth-user/ *.log bun.lock ffmpeg-dist/ \ No newline at end of file diff --git a/Dockerfile b/Dockerfile index 5089efa..2721514 100644 --- a/Dockerfile +++ b/Dockerfile @@ -18,6 +18,7 @@ USER root ENV DEBIAN_FRONTEND=noninteractive ENV RUSTICL_ENABLE=radeonsi,iris,nouveau +ENV OCL_ICD_VENDORS=/etc/OpenCL/vendors # Base packages RUN apt-get update && apt-get install -y --no-install-recommends \ @@ -45,15 +46,15 @@ EOF RUN apt-get update && apt-get install -y --no-install-recommends \ python3 \ python3-pip \ - vapoursynth \ - python3-vapoursynth-jetpack \ - vapoursynth-akarin \ - vapoursynth-ffms2 \ + python3-venv \ + python3-dev \ + libpython3-dev \ ffmpeg \ mediainfo \ opus-tools \ mkvtoolnix \ zstd \ + p7zip-full \ \ # OpenCL ocl-icd-libopencl1 \ @@ -152,10 +153,48 @@ RUN apt-get update && apt-get install -y --no-install-recommends \ libegl1 \ libgles2 \ libglu1-mesa \ - && pip3 install --no-cache-dir --break-system-packages --no-deps vstools \ && rm -f /etc/OpenCL/vendors/mesa.icd \ && rm -rf /var/lib/apt/lists/* +# Create venv, install vsrepo, and symlink it for convenience +RUN python3 -m venv /opt/vs-venv \ + && /opt/vs-venv/bin/pip install --no-cache-dir --upgrade pip setuptools wheel \ + && /opt/vs-venv/bin/pip install --no-cache-dir \ + VapourSynth \ + vsrepo \ + vsjetpack \ + vstools \ + vsutil \ + vapoursynth-adaptivegrain \ + vapoursynth-akarin \ + vapoursynth-awarp \ + vapoursynth-resize2 \ + vapoursynth-vszip \ + vapoursynth-zsmooth \ + vapoursynth-mvtools \ + vapoursynth-eedi3 \ + vapoursynth-znedi3 \ + vapoursynth-descale \ + vapoursynth-deblock \ + vapoursynth-hysteresis \ + ffms2 \ + && /opt/vs-venv/bin/vapoursynth config \ + && ln -sf /opt/vs-venv/bin/python /usr/local/bin/python \ + && ln -sf /opt/vs-venv/bin/python3 /usr/local/bin/python3 \ + && ln -sf /opt/vs-venv/bin/vapoursynth /usr/local/bin/vapoursynth \ + && ln -sf /opt/vs-venv/bin/vspipe /usr/local/bin/vspipe \ + && ln -sf /opt/vs-venv/bin/vsrepo /usr/local/bin/vsrepo + +# Use the venv's vsrepo to install required scripts +RUN mkdir -p /root/.config/vsrepo \ + && vsrepo update \ + && vsrepo install ffms2 fmtc nnedi3 knlm + +# Make the venv's Python the default for any 'python3' call +ENV PATH="/opt/vs-venv/bin:${PATH}" + +COPY vapoursynth/ /app/vapoursynth/ + # Copy bundled binaries and custom FFmpeg archives COPY binaries/ /app/binaries/ @@ -167,16 +206,6 @@ RUN chmod +x \ && if [ -f /app/binaries/x86_64_v4/SvtAv1EncApp ]; then chmod +x /app/binaries/x86_64_v4/SvtAv1EncApp; fi # Extract custom FFmpeg builds. -# -# Expected archive contents: -# ffmpeg-x86-64-v2/ -# ffmpeg-x86-64-v3/ -# ffmpeg-x86-64-v4/ -# -# Final locations: -# /opt/ffmpeg-x86-64-v2 -# /opt/ffmpeg-x86-64-v3 -# /opt/ffmpeg-x86-64-v4 RUN mkdir -p /opt \ && tar --zstd -xpf /app/binaries/x86_64_v2/ffmpeg.tar.zst -C /opt \ && tar --zstd -xpf /app/binaries/x86_64_v3/ffmpeg.tar.zst -C /opt \ @@ -190,7 +219,6 @@ RUN mkdir -p /opt \ /opt/ffmpeg-x86-64-v4/bin/ffprobe # Verify all custom FFmpeg builds can resolve shared libraries. -# This catches missing runtime packages during docker build. RUN set -eux; \ for level in x86-64-v2 x86-64-v3 x86-64-v4; do \ echo "Checking /opt/ffmpeg-$level/bin/ffmpeg"; \ diff --git a/README.md b/README.md index cce5fa0..c9cea7a 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ Drop media files into the `input` folder and get optimally encoded MKV files in - **Auto-Boost-Essential** integration for optimal per-scene CRF zones - **Opus** audio encoding with configurable per-channel bitrates - **HDR10 metadata** preservation (PQ, BT.2020, mastering display, content light) +- **VapourSynth filter chain** stackable per-job filters (FineDehalo, DehaloAlpha...) with `light` / `medium` / `heavy` presets, full per-parameter overrides, and a hot-reloadable user preset directory for dropping in your own `.vpy` scripts - **Web dashboard** for monitoring progress and configuring per-file settings - **File watcher** auto-detects new files in the input directory - **Queue system** processes files sequentially, with drag-and-drop reordering and pause/resume @@ -35,100 +36,54 @@ cp movie.mkv input/ All settings are configurable via environment variables in `docker-compose.yml`: -| Variable | Default | Description | -| --------------------------------------- | --------------- | ------------------------------------------------------------------------------------------------------ | -| `PORT` | `3000` | Web dashboard port | -| `PASSWORD` | `rabbitencoder` | Password to access web dashboard | -| `FILE_COOLDOWN` | `30` | Seconds the file size must stay unchanged before encoding starts | -| `ENCODER_QUALITY` | `medium` | Default video quality (`low`, `medium`, `high`) | -| `ENCODER_SPEED` | `slow` | Default encode speed (`slower`, `slow`, `medium`, `fast`, `faster`) | -| `ENCODER_DENOISE` | `off` | Default denoise level (`off`, `auto`, `light`, `medium`, `heavy`) | -| `ENCODER_DENOISE_BACKEND` | `auto` | Denoise backend: `cpu`, `auto`, `vulkan`, `opencl`. `cpu` forces software nlmeans. | -| `ENCODER_DENOISE_GPU_DEVICE` | `0.0` | GPU device id (ignored when backend is `cpu`). `0` for vulkan, `.` for opencl. | -| `ENCODER_DENOISE_AUTO_THRESHOLD_LIGHT` | `0.5` | Y bitplane-4 threshold above which scenes get `light` denoise (only used when `ENCODER_DENOISE=auto`). | -| `ENCODER_DENOISE_AUTO_THRESHOLD_MEDIUM` | `0.7` | Y bitplane-4 threshold above which scenes get `medium` denoise. | -| `ENCODER_DENOISE_AUTO_THRESHOLD_HEAVY` | `0.9` | Y bitplane-4 threshold above which scenes get `heavy` denoise. | -| `ENCODER_DENOISE_LIGHT_S` | `1.0` | NLMeans strength `s` for `light` level (float [1.0 – 30.0]). | -| `ENCODER_DENOISE_LIGHT_P` | `3` | NLMeans patch size `p` for `light` level (odd int [1 – 99]). | -| `ENCODER_DENOISE_LIGHT_R` | `7` | NLMeans research size `r` for `light` level (odd int [1 – 99]). | -| `ENCODER_DENOISE_MEDIUM_S` | `1.5` | NLMeans `s` for `medium` level. | -| `ENCODER_DENOISE_MEDIUM_P` | `3` | NLMeans `p` for `medium` level. | -| `ENCODER_DENOISE_MEDIUM_R` | `9` | NLMeans `r` for `medium` level. | -| `ENCODER_DENOISE_HEAVY_S` | `2.0` | NLMeans `s` for `heavy` level. | -| `ENCODER_DENOISE_HEAVY_P` | `3` | NLMeans `p` for `heavy` level. | -| `ENCODER_DENOISE_HEAVY_R` | `11` | NLMeans `r` for `heavy` level. | -| `ENCODER_DEBAND` | `off` | Default deband level (`off`, `light`, `medium`, `heavy`). | -| `ENCODER_DEBAND_LIGHT_STRENGTH` | `0.8` | Gradfun strength for `light` level (float [0.51 – 64]). | -| `ENCODER_DEBAND_LIGHT_RADIUS` | `8` | Gradfun radius for `light` level (int [8 – 32]). | -| `ENCODER_DEBAND_MEDIUM_STRENGTH` | `1.4` | Gradfun strength for `medium` level. | -| `ENCODER_DEBAND_MEDIUM_RADIUS` | `16` | Gradfun radius for `medium` level. | -| `ENCODER_DEBAND_HEAVY_STRENGTH` | `2.8` | Gradfun strength for `heavy` level. | -| `ENCODER_DEBAND_HEAVY_RADIUS` | `24` | Gradfun radius for `heavy` level. | -| `ENCODER_DOWNSCALE` | `false` | Downscale 4K sources to 1080p before encoding. | -| `ENCODER_SKIP_BOOSTING` | `false` | Skip boosting — bypass per-scene CRF zone analysis. | -| `ENCODER_DEDUPE_SUBTITLES` | `false` | Keep only one subtitle per language + type. | -| `AUDIO_NO_PHASE_INV` | `false` | Disable phase inversion (`--no-phase-inv`) for AV1 encoding. | -| `AUDIO_LANGUAGES` | _(empty)_ | Comma-separated audio language codes to keep (empty = keep all). | -| `SUBTITLE_LANGUAGES` | _(empty)_ | Comma-separated subtitle language codes to keep (empty = keep all). | -| `ORGANIZATION` | `RabbitCompany` | Tag appended to encoded filenames (e.g. `-RabbitCompany`). | -| `AUDIO_BITRATE_MONO` | `64` | Opus bitrate for mono audio (kbps). | -| `AUDIO_BITRATE_STEREO` | `128` | Opus bitrate for stereo audio. | -| `AUDIO_BITRATE_2_1` | `160` | Opus bitrate for 2.1 audio. | -| `AUDIO_BITRATE_5_1` | `256` | Opus bitrate for 5.1 audio. | -| `AUDIO_BITRATE_6_1` | `320` | Opus bitrate for 6.1 audio. | -| `AUDIO_BITRATE_7_1` | `384` | Opus bitrate for 7.1 audio. | -| `AUDIO_BITRATE_7_1_4` | `448` | Opus bitrate for 7.1.4 Atmos audio. | - -## Web Dashboard - -The dashboard at `http://localhost:3000` shows: - -- **Job queue** with file info, status, and progress -- **Per-file settings** (quality, speed, audio bitrates) editable while queued -- **Live progress** tracking through all encoding stages -- **Results** showing output file size and encode time -- **Preview** generate a small set of comparison samples for any queued job and toggle between source and encode -- **Library browser** for navigating and encoding mounted media folders - -## Library Encoding - -Library encoding lets you browse your media folders directly from the dashboard and encode entire series or movie collections in-place. This is designed for use with **Sonarr**, **Radarr**, and **Jellyfin**. You can download remuxes through Sonarr, then select the series folder in Rabbit Encoder to re-encode everything. - -### How it works - -1. Mount your media folders into the container as volumes -2. Set `LIBRARY_DIRS` to point to those mounted paths -3. Click **Library** in the dashboard header to browse your folders -4. Navigate into a series folder (e.g. `Blue Exorcist (2011)`) and click **Encode Folder** -5. All video files in the folder (and subfolders like Season 01, Season 02, Specials) are queued for encoding - -### What happens when a library file is encoded - -- The encoded file is placed **in the same directory** as the source file -- The **original source file is deleted** -- Associated **`.nfo` and thumbnail files** (`.jpg`, `.png`) matching the source filename are removed so Jellyfin regenerates fresh metadata -- Files that are **already encoded** (filename ends with `-{ORGANIZATION}.mkv`) are automatically skipped - -### Example setup - -```yaml -services: - rabbit-encoder: - image: rabbitcompany/rabbit-encoder:latest - volumes: - - ./input:/data/input - - ./output:/data/output - - ./temp:/data/temp - - /mnt/HDD/media/Animes:/Animes - - /mnt/HDD/media/Shows:/Shows - - /mnt/HDD/media/Movies:/Movies - environment: - - LIBRARY_DIRS=/Animes,/Shows,/Movies -``` - -### Already-encoded detection - -The encoder recognizes files it has already processed by checking the filename suffix. If `ORGANIZATION` is set to `RabbitCompany` (the default), then any file ending with `-RabbitCompany.mkv` is treated as already encoded and will be: +| Variable | Default | Description | +| --------------------------------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `PORT` | `3000` | Web dashboard port | +| `PASSWORD` | `rabbitencoder` | Password to access web dashboard | +| `FILE_COOLDOWN` | `30` | Seconds the file size must stay unchanged before encoding starts | +| `ENCODER_QUALITY` | `medium` | Default video quality (`low`, `medium`, `high`) | +| `ENCODER_SPEED` | `slow` | Default encode speed (`slower`, `slow`, `medium`, `fast`, `faster`) | +| `ENCODER_DENOISE` | `off` | Default denoise level (`off`, `auto`, `light`, `medium`, `heavy`) | +| `ENCODER_DENOISE_BACKEND` | `auto` | Denoise backend: `cpu`, `auto`, `vulkan`, `opencl`. `cpu` forces software nlmeans. | +| `ENCODER_DENOISE_GPU_DEVICE` | `0.0` | GPU device id (ignored when backend is `cpu`). `0` for vulkan, `.` for opencl. | +| `ENCODER_DENOISE_AUTO_THRESHOLD_LIGHT` | `0.5` | Y bitplane-4 threshold above which scenes get `light` denoise (only used when `ENCODER_DENOISE=auto`). | +| `ENCODER_DENOISE_AUTO_THRESHOLD_MEDIUM` | `0.7` | Y bitplane-4 threshold above which scenes get `medium` denoise. | +| `ENCODER_DENOISE_AUTO_THRESHOLD_HEAVY` | `0.9` | Y bitplane-4 threshold above which scenes get `heavy` denoise. | +| `ENCODER_DENOISE_LIGHT_S` | `1.0` | NLMeans strength `s` for `light` level (float [1.0 – 30.0]). | +| `ENCODER_DENOISE_LIGHT_P` | `3` | NLMeans patch size `p` for `light` level (odd int [1 – 99]). | +| `ENCODER_DENOISE_LIGHT_R` | `7` | NLMeans research size `r` for `light` level (odd int [1 – 99]). | +| `ENCODER_DENOISE_MEDIUM_S` | `1.5` | NLMeans `s` for `medium` level. | +| `ENCODER_DENOISE_MEDIUM_P` | `3` | NLMeans `p` for `medium` level. | +| `ENCODER_DENOISE_MEDIUM_R` | `9` | NLMeans `r` for `medium` level. | +| `ENCODER_DENOISE_HEAVY_S` | `2.0` | NLMeans `s` for `heavy` level. | +| `ENCODER_DENOISE_HEAVY_P` | `3` | NLMeans `p` for `heavy` level. | +| `ENCODER_DENOISE_HEAVY_R` | `11` | NLMeans `r` for `heavy` level. | +| `ENCODER_DEBAND` | `off` | Default deband level (`off`, `light`, `medium`, `heavy`). | +| `ENCODER_DEBAND_LIGHT_STRENGTH` | `0.8` | Gradfun strength for `light` level (float [0.51 – 64]). | +| `ENCODER_DEBAND_LIGHT_RADIUS` | `8` | Gradfun radius for `light` level (int [8 – 32]). | +| `ENCODER_DEBAND_MEDIUM_STRENGTH` | `1.4` | Gradfun strength for `medium` level. | +| `ENCODER_DEBAND_MEDIUM_RADIUS` | `16` | Gradfun radius for `medium` level. | +| `ENCODER_DEBAND_HEAVY_STRENGTH` | `2.8` | Gradfun strength for `heavy` level. | +| `ENCODER_DEBAND_HEAVY_RADIUS` | `24` | Gradfun radius for `heavy` level. | +| `ENCODER_DOWNSCALE` | `false` | Downscale 4K sources to 1080p before encoding. | +| `ENCODER_SKIP_BOOSTING` | `false` | Skip boosting — bypass per-scene CRF zone analysis. | +| `ENCODER_DEDUPE_SUBTITLES` | `false` | Keep only one subtitle per language + type. | +| `AUDIO_NO_PHASE_INV` | `false` | Disable phase inversion (`--no-phase-inv`) for AV1 encoding. | +| `AUDIO_LANGUAGES` | _(empty)_ | Comma-separated audio language codes to keep (empty = keep all). | +| `SUBTITLE_LANGUAGES` | _(empty)_ | Comma-separated subtitle language codes to keep (empty = keep all). | +| `ORGANIZATION` | `RabbitCompany` | Tag appended to encoded filenames (e.g. `-RabbitCompany`). | +| `AUDIO_BITRATE_MONO` | `64` | Opus bitrate for mono audio (kbps). | +| `AUDIO_BITRATE_STEREO` | `128` | Opus bitrate for stereo audio. | +| `AUDIO_BITRATE_2_1` | `160` | Opus bitrate for 2.1 audio. | +| `AUDIO_BITRATE_5_1` | `256` | Opus bitrate for 5.1 audio. | +| `AUDIO_BITRATE_6_1` | `320` | Opus bitrate for 6.1 audio. | +| `AUDIO_BITRATE_7_1` | `384` | Opus bitrate for 7.1 audio. | +| `AUDIO_BITRATE_7_1_4` | `448` | Opus bitrate for 7.1.4 Atmos audio. | +| `VS_PRESETS_STOCK_DIR` | `/app/vapoursynth/presets` | Directory the built-in VapourSynth presets are loaded from. Override only if you mount a custom stock set. | +| `VS_PRESETS_USER_DIR` | `/config/vapoursynth/presets` | Directory scanned for user-provided VapourSynth presets. Mounted from the host via `./vapoursynth-user:/config/vapoursynth`. | +| `VS_RABBIT_MODULE_DIR` | `/app/vapoursynth` | Path added to `PYTHONPATH` so preset scripts can `import rabbit_vs`. | + +If `ORGANIZATION` is set to `RabbitCompany` (the default), then any file ending with `-RabbitCompany.mkv` is treated as already encoded and will be: - Shown with a green **encoded** badge and dimmed in the library browser - Completely **skipped** when you click Encode Folder @@ -140,7 +95,7 @@ This means you can safely run Encode Folder on the same series multiple times (o For each file, the engine runs: 1. **Probe** - Extract media info (resolution, audio layout, HDR metadata) -2. **Prepare** - Extract the best video stream into a clean container +2. **Prepare** - Extract the best video stream into a clean container, then run any configured **VapourSynth filter chain** (each enabled filter is piped through `vspipe` -> FFmpeg as its own pass, before the FFmpeg filter chain) 3. **Auto-Boost-Essential** - 4-stage video encoding: - Fast pass for scene analysis - Quality metric calculation (XPSNR) @@ -150,6 +105,39 @@ For each file, the engine runs: 5. **Mux** - Merge video + audio into MKV with metadata tags 6. **HDR** - Apply HDR10 metadata via mkvpropedit (if source is HDR) +## VapourSynth Filters + +Rabbit Encoder ships with a VapourSynth filter system that lets you stack arbitrary preprocessing passes in front of the main encode. Each filter runs as its own `vspipe` pass. + +### Stock presets + +Built-in presets live under `/app/vapoursynth/presets` inside the container and are namespaced as `stock:`: + +| Preset ID | Name | Description | +| -------------------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| `stock:finedehalo` | FineDehalo | Reduces dark/bright halos around high-contrast edges. Best for anime and DVD upscales. | +| `stock:dehalo_alpha` | Dehalo Alpha | Classic halo reduction via `vs-jetpack`'s `dehalo_alpha`. | +| `stock:f3k_deband` | F3K Deband | Removes color banding in smooth gradients while preserving detail. Wraps `vszip.Deband` (modern f3kdb successor) and can re-grain after debanding. | + +Every preset declares its own `levels` (typically `light`, `medium`, `heavy`) and a set of tunable parameters. You can pick a level per job and override individual params per-level in the dashboard's **Advanced Settings -> VapourSynth Filters** panel. + +### User custom presets + +To add your own filter, drop a matching pair of files into the host-mounted user directory (`./vapoursynth-user/presets` by default, exposed inside the container at `/config/vapoursynth/presets`): + +``` +myfilter.vpy # the VapourSynth script +myfilter.json # the manifest (id, levels, params, defaults) +``` + +Both files must share the same stem. The `.vpy` script reads its input path from the `SRC` argument and any tunable parameter via `rabbit_vs.arg_int / arg_float / arg_str / arg_bool`. See [**Examples**](https://github.com/Rabbit-Company/RabbitEncoder/tree/main/vapoursynth/presets). + +User presets are namespaced as `user:` and override nothing (stock and user presets coexist). After editing or adding presets, click **Reload presets** in the Advanced Settings panel (or `POST /api/vs-presets/reload`); no container restart is required. + +### Per-job behavior + +The VapourSynth chain is stored per job, so different files in the same queue can use different filter stacks. Each entry has a `level` (or `"off"` to disable without removing it from the chain) and a per-level param map, letting you switch intensity without losing your tweaks at other levels. The active chain is also baked into the output MKV's `SETTINGS` tag (e.g. `VS finedehalo/medium+dehalo_alpha/light`) for traceability. + ## Output Naming Files are named following the pattern: @@ -172,36 +160,39 @@ Source tags are detected from the input filename: `Bluray`, `WEBDL`, `WEBRip`, ` ## API Endpoints -| Method | Endpoint | Description | -| -------- | ------------------------------------------- | --------------------------------------------------------------------------- | -| `GET` | `/api/jobs` | List all jobs | -| `GET` | `/api/jobs/:id` | Get job details | -| `PATCH` | `/api/jobs/:id` | Update job settings (queued only) | -| `DELETE` | `/api/jobs/:id` | Remove a job | -| `POST` | `/api/jobs/:id/retry` | Retry a failed job | -| `POST` | `/api/jobs/:id/cancel` | Cancel an actively encoding job | -| `POST` | `/api/jobs/:id/move` | Move a queued job in the queue (`direction`: `up`, `down`, `top`, `bottom`) | -| `POST` | `/api/jobs/reorder` | Set the entire queue order from a JSON `{ ids: [...] }` body | -| `GET` | `/api/jobs/:id/audio-preview` | Preview audio reorder/filter/dedup for a job | -| `GET` | `/api/jobs/:id/subtitle-preview` | Preview subtitle reorder/rename for a job | -| `GET` | `/api/jobs/:id/mediainfo` | Run `mediainfo` on the source file and return the report | -| `GET` | `/api/jobs/:id/preview` | Get preview-encode state for a job (`idle`, running, or completed samples) | -| `POST` | `/api/jobs/:id/preview` | Start a preview encode (6 short comparison clips spread across the source) | -| `DELETE` | `/api/jobs/:id/preview` | Cancel a running preview, or clear completed preview artifacts | -| `GET` | `/api/jobs/:id/preview/sample/:index/:kind` | Fetch a preview artifact. `kind`: `source` / `encode` (PNG) or `clip` (MKV) | -| `GET` | `/api/config` | Get default settings | -| `PATCH` | `/api/config` | Update default settings | -| `GET` | `/api/library` | List configured library root directories | -| `GET` | `/api/library/browse` | Browse a library folder (`?path=/data/library/Animes`) | -| `POST` | `/api/library/encode` | Queue all videos in a folder for in-place encoding | -| `GET` | `/api/queue` | Get queue state (paused or running) | -| `POST` | `/api/queue/pause` | Pause encoding - stops current encode, preserves queue | -| `POST` | `/api/queue/resume` | Resume encoding from where it was paused | -| `GET` | `/api/opencl-devices` | List available OpenCL devices | -| `GET` | `/api/vulkan-devices` | List available Vulkan devices | -| `GET` | `/api/benchmark` | Get current benchmark state | -| `POST` | `/api/benchmark` | Start a denoise benchmark run | -| `DELETE` | `/api/benchmark` | Cancel a running benchmark | +| Method | Endpoint | Description | +| -------- | ------------------------------------------- | ----------------------------------------------------------------------------- | +| `GET` | `/api/jobs` | List all jobs | +| `GET` | `/api/jobs/:id` | Get job details | +| `PATCH` | `/api/jobs/:id` | Update job settings (queued only) | +| `DELETE` | `/api/jobs/:id` | Remove a job | +| `POST` | `/api/jobs/:id/retry` | Retry a failed job | +| `POST` | `/api/jobs/:id/cancel` | Cancel an actively encoding job | +| `POST` | `/api/jobs/:id/move` | Move a queued job in the queue (`direction`: `up`, `down`, `top`, `bottom`) | +| `POST` | `/api/jobs/reorder` | Set the entire queue order from a JSON `{ ids: [...] }` body | +| `GET` | `/api/jobs/:id/audio-preview` | Preview audio reorder/filter/dedup for a job | +| `GET` | `/api/jobs/:id/subtitle-preview` | Preview subtitle reorder/rename for a job | +| `GET` | `/api/jobs/:id/mediainfo` | Run `mediainfo` on the source file and return the report | +| `GET` | `/api/jobs/:id/preview` | Get preview-encode state for a job (`idle`, running, or completed samples) | +| `POST` | `/api/jobs/:id/preview` | Start a preview encode (6 short comparison clips spread across the source) | +| `DELETE` | `/api/jobs/:id/preview` | Cancel a running preview, or clear completed preview artifacts | +| `GET` | `/api/jobs/:id/preview/sample/:index/:kind` | Fetch a preview artifact. `kind`: `source` / `encode` (PNG) or `clip` (MKV) | +| `GET` | `/api/config` | Get default settings | +| `PATCH` | `/api/config` | Update default settings | +| `GET` | `/api/library` | List configured library root directories | +| `GET` | `/api/library/browse` | Browse a library folder (`?path=/data/library/Animes`) | +| `POST` | `/api/library/encode` | Queue all videos in a folder for in-place encoding | +| `GET` | `/api/queue` | Get queue state (paused or running) | +| `POST` | `/api/queue/pause` | Pause encoding - stops current encode, preserves queue | +| `POST` | `/api/queue/resume` | Resume encoding from where it was paused | +| `GET` | `/api/opencl-devices` | List available OpenCL devices | +| `GET` | `/api/vulkan-devices` | List available Vulkan devices | +| `GET` | `/api/benchmark` | Get current benchmark state | +| `POST` | `/api/benchmark` | Start a denoise benchmark run | +| `DELETE` | `/api/benchmark` | Cancel a running benchmark | +| `GET` | `/api/vs-presets` | List all VapourSynth presets (stock + user) with their manifests | +| `POST` | `/api/vs-presets/reload` | Rescan stock and user preset directories from disk and reload the registry | +| `GET` | `/api/vs-presets/:id/default-entry` | Build a fresh filter-chain entry for `:id`, pre-filled with manifest defaults | All API endpoints require authentication via `Authorization: Bearer ` header, where the token is the BLAKE2b-512 hash of `rabbitencoder-{PASSWORD}`. diff --git a/binaries/x86_64_v2/libvszip.so b/binaries/x86_64_v2/libvszip.so deleted file mode 100755 index 8f1cd8c..0000000 Binary files a/binaries/x86_64_v2/libvszip.so and /dev/null differ diff --git a/binaries/x86_64_v3/libvszip.so b/binaries/x86_64_v3/libvszip.so deleted file mode 100755 index e3dbfa6..0000000 Binary files a/binaries/x86_64_v3/libvszip.so and /dev/null differ diff --git a/binaries/x86_64_v4/libvszip.so b/binaries/x86_64_v4/libvszip.so deleted file mode 100755 index 13278c1..0000000 Binary files a/binaries/x86_64_v4/libvszip.so and /dev/null differ diff --git a/docker-compose.override.yml b/docker-compose.override.yml index 841cb89..098727e 100644 --- a/docker-compose.override.yml +++ b/docker-compose.override.yml @@ -11,6 +11,7 @@ services: - ./input:/data/input - ./output:/data/output - ./temp:/data/temp + - ./vapoursynth-user:/config/vapoursynth # Mount your media library folders for in-place encoding # - /mnt/HDD/media/Animes:/Animes # - /mnt/HDD/media/Shows:/Shows diff --git a/docker-compose.yml b/docker-compose.yml index 794bd38..f6fa380 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -11,6 +11,7 @@ services: - ./input:/data/input - ./output:/data/output - ./temp:/data/temp + - ./vapoursynth-user:/config/vapoursynth # Mount your media library folders for in-place encoding # - /mnt/HDD/media/Animes:/Animes # - /mnt/HDD/media/Shows:/Shows diff --git a/docker/entrypoint.sh b/docker/entrypoint.sh index 5b2b508..82dd593 100644 --- a/docker/entrypoint.sh +++ b/docker/entrypoint.sh @@ -1,13 +1,14 @@ #!/bin/sh set -e +export PATH="/opt/vs-venv/bin:${PATH}" + BIN_DIR="/app/binaries" TARGET_SVT="/usr/local/bin/SvtAv1EncApp" TARGET_FFMPEG="/usr/local/bin/ffmpeg" TARGET_FFPROBE="/usr/local/bin/ffprobe" -TARGET_LIB="/usr/lib/x86_64-linux-gnu/vapoursynth/libvszip.so" # Always expose the arch-independent language-detector if ! command -v language-detector >/dev/null 2>&1; then @@ -75,9 +76,8 @@ if [ -x "$ARCH_DIR/SvtAv1EncApp" ]; then ln -sf "$ARCH_DIR/SvtAv1EncApp" "$TARGET_SVT" fi -# Expose VapourSynth zip plugin -if [ -f "$ARCH_DIR/libvszip.so" ]; then - ln -sf "$ARCH_DIR/libvszip.so" "$TARGET_LIB" +if [ -x /opt/vs-venv/bin/vapoursynth ]; then + export VSSCRIPT_PATH="$("/opt/vs-venv/bin/vapoursynth" get-vsscript)" fi # Expose custom FFmpeg @@ -98,10 +98,27 @@ fi # Make matching FFmpeg shared libs visible export LD_LIBRARY_PATH="$FFMPEG_DIR/lib${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}" -# Refresh the dynamic linker cache so libvszip.so is findable +# Refresh linker cache where possible ldconfig 2>/dev/null || true echo "[entrypoint] Using FFmpeg: $("$TARGET_FFMPEG" -hide_banner -version | head -n1)" echo "[entrypoint] Using FFprobe: $("$TARGET_FFPROBE" -hide_banner -version | head -n1)" +USER_VS_DIR="/config/vapoursynth/presets" +if [ ! -d "$USER_VS_DIR" ]; then + mkdir -p "$USER_VS_DIR" + cat > "$USER_VS_DIR/README.md" <<'EOF' +Drop your custom VapourSynth presets in this directory. + +Each preset needs two files with the same stem: + myfilter.vpy - the script + myfilter.json - the manifest (id, levels, params, defaults) + +See https://github.com/Rabbit-Company/RabbitEncoder/tree/main/vapoursynth/presets for working examples. + +After adding a preset, hit "Reload presets" in the dashboard's Advanced +Settings panel (or POST /api/vs-presets/reload). +EOF +fi + exec "$@" \ No newline at end of file diff --git a/package.json b/package.json index 6072bcc..9e1ce9a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "rabbit-encoder", - "version": "4.0.0", + "version": "5.0.0", "type": "module", "scripts": { "dev": "bun run --watch src/index.ts", diff --git a/public/app.js b/public/app.js index 0345a40..1c06ba5 100644 --- a/public/app.js +++ b/public/app.js @@ -10,6 +10,7 @@ let currentEditJobId = null; let authToken = localStorage.getItem("authToken") || ""; let pollTimer = null; let benchmarkPollTimer = null; +let vsPresets = null; const QUALITIES = ["low", "medium", "high"]; const SPEEDS = ["slower", "slow", "medium", "fast", "faster"]; @@ -63,6 +64,7 @@ function previewSettingsFingerprintFE(s) { nlmeansParams: s.nlmeansParams, gradfunParams: s.gradfunParams, autoDenoiseThresholds: s.autoDenoiseThresholds, + vsFilters: s.vsFilters ?? [], }); } @@ -290,6 +292,228 @@ async function cancelPreviewRequest(jobId) { return res.json(); } +async function fetchVsPresets(force = false) { + if (vsPresets !== null && !force) return vsPresets; + const res = await authFetch(`${API}/api/vs-presets`); + const data = await res.json(); + vsPresets = data.presets || []; + return vsPresets; +} + +async function reloadVsPresets() { + await authFetch(`${API}/api/vs-presets/reload`, { method: "POST" }); + return fetchVsPresets(true); +} + +async function fetchVsDefaultEntry(presetId) { + const res = await authFetch(`${API}/api/vs-presets/${encodeURIComponent(presetId)}/default-entry`); + return res.json(); +} + +function renderVsChainEditor(container, settings) { + container.innerHTML = ""; + settings.vsFilters = settings.vsFilters || []; + + fetchVsPresets().then((presets) => { + if (presets.length === 0) { + const empty = document.createElement("div"); + empty.className = "vs-empty"; + empty.textContent = "No VapourSynth presets found."; + container.appendChild(empty); + return; + } + + settings.vsFilters.forEach((entry, idx) => { + const manifest = presets.find((p) => p.id === entry.presetId); + if (!manifest) return; + container.appendChild(renderVsChainEntry(manifest, entry, idx, settings)); + }); + + const addRow = document.createElement("div"); + addRow.className = "vs-add-row"; + + const select = document.createElement("select"); + const placeholder = document.createElement("option"); + placeholder.value = ""; + placeholder.textContent = "+ Add filter…"; + select.appendChild(placeholder); + for (const p of presets) { + const opt = document.createElement("option"); + opt.value = p.id; + opt.textContent = `${p.name} · ${p.source}`; + select.appendChild(opt); + } + select.onchange = async () => { + if (!select.value) return; + const fresh = await fetchVsDefaultEntry(select.value); + settings.vsFilters.push(fresh); + renderVsChainEditor(container, settings); + }; + + addRow.appendChild(select); + container.appendChild(addRow); + }); +} + +function renderVsChainEntry(manifest, entry, idx, settings) { + const card = document.createElement("div"); + card.className = "vs-entry-card"; + + const header = document.createElement("div"); + header.className = "vs-entry-header"; + + const name = document.createElement("span"); + name.className = "vs-entry-name"; + name.textContent = manifest.name; + header.appendChild(name); + + const badge = document.createElement("span"); + badge.className = `vs-entry-source ${manifest.source === "user" ? "user" : ""}`; + badge.textContent = manifest.source; + header.appendChild(badge); + + const removeBtn = document.createElement("button"); + removeBtn.className = "btn btn-ghost btn-small btn-remove"; + removeBtn.textContent = "Remove"; + removeBtn.onclick = () => { + settings.vsFilters.splice(idx, 1); + renderVsChainEditor(card.parentElement, settings); + }; + header.appendChild(removeBtn); + card.appendChild(header); + + if (manifest.description) { + const desc = document.createElement("div"); + desc.className = "vs-entry-description"; + desc.textContent = manifest.description; + card.appendChild(desc); + } + + const levelOptions = ["off", ...manifest.levels]; + const levelEl = document.createElement("div"); + levelEl.className = "radio-group"; + renderRadioPills(levelEl, levelOptions, entry.level || "off", (v) => { + entry.level = v; + }); + card.appendChild(levelEl); + + const editBtn = document.createElement("button"); + editBtn.className = "vs-entry-edit-btn"; + editBtn.type = "button"; + editBtn.textContent = "Edit values per level"; + + const paramPanel = document.createElement("div"); + paramPanel.className = "vs-param-panel"; + paramPanel.style.display = "none"; + renderVsParamPanel(paramPanel, manifest, entry); + + editBtn.onclick = () => { + const open = paramPanel.style.display !== "none"; + paramPanel.style.display = open ? "none" : ""; + editBtn.classList.toggle("open", !open); + }; + + card.appendChild(editBtn); + card.appendChild(paramPanel); + return card; +} + +function renderVsParamPanel(container, manifest, entry) { + container.innerHTML = ""; + + const grid = document.createElement("div"); + grid.className = "vs-param-grid"; + grid.style.gridTemplateColumns = `minmax(80px, auto) repeat(${manifest.levels.length}, 1fr)`; + + const corner = document.createElement("div"); + corner.className = "vs-param-header vs-param-header-corner"; + corner.textContent = "param"; + grid.appendChild(corner); + for (const lvl of manifest.levels) { + const h = document.createElement("div"); + h.className = "vs-param-header"; + h.textContent = lvl; + grid.appendChild(h); + } + + for (const spec of manifest.params) { + const label = document.createElement("div"); + label.className = "vs-param-row-label"; + label.textContent = spec.label || spec.key; + label.title = spec.key; + grid.appendChild(label); + + for (const lvl of manifest.levels) { + const cell = document.createElement("div"); + cell.className = "vs-param-cell"; + cell.appendChild(renderVsParamInput(spec, lvl, entry)); + grid.appendChild(cell); + } + + if (spec.help) { + const help = document.createElement("div"); + help.className = "vs-param-help"; + help.textContent = spec.help; + grid.appendChild(help); + } + } + + container.appendChild(grid); +} + +function renderVsParamInput(spec, level, entry) { + entry.params = entry.params || {}; + entry.params[level] = entry.params[level] || {}; + const cur = entry.params[level][spec.key]; + + if (spec.type === "bool") { + const cb = document.createElement("input"); + cb.type = "checkbox"; + cb.checked = !!cur; + cb.onchange = () => { + entry.params[level][spec.key] = cb.checked; + }; + return cb; + } + + if (spec.type === "enum") { + const sel = document.createElement("select"); + for (const v of spec.enum) { + const opt = document.createElement("option"); + opt.value = v; + opt.textContent = v; + if (v === cur) opt.selected = true; + sel.appendChild(opt); + } + sel.onchange = () => { + entry.params[level][spec.key] = sel.value; + }; + return sel; + } + + const input = document.createElement("input"); + input.type = "number"; + if (spec.min !== undefined) input.min = String(spec.min); + if (spec.max !== undefined) input.max = String(spec.max); + input.step = spec.step !== undefined ? String(spec.step) : spec.type === "int" ? "1" : "0.01"; + input.value = String(cur ?? spec.defaults[level]); + input.onchange = () => { + const n = parseFloat(input.value); + if (!Number.isFinite(n)) return; + const v = spec.type === "int" ? Math.round(n) : n; + const clamped = clampToRange(v, spec.min, spec.max); + entry.params[level][spec.key] = clamped; + input.value = String(clamped); + }; + return input; +} + +function clampToRange(v, min, max) { + if (typeof min === "number" && v < min) v = min; + if (typeof max === "number" && v > max) v = max; + return v; +} + async function fetchPreviewArtifactBlob(jobId, idx, kind) { const cacheKey = `${jobId}:${idx}:${kind}`; const cached = previewBlobCache.get(cacheKey); @@ -407,10 +631,23 @@ function renderPreviewState(state) { clearBtn.style.display = !isRunning && hasResults ? "" : "none"; } +function buildPreviewSampleViews(sample) { + const views = [{ id: "source", label: "Source", role: "source" }]; + for (const f of sample.vsFrames || []) { + views.push({ + id: `vs:${f.index}`, + label: f.label || `VS step ${f.index + 1}`, + role: "vs", + }); + } + views.push({ id: "encode", label: "Encode", role: "encode" }); + return views; +} + function renderPreviewSamples(jobId, samples) { const container = document.getElementById("preview-samples"); - const desiredKey = samples.map((s) => s.index).join(","); + const desiredKey = samples.map((s) => `${s.index}:${(s.vsFrames || []).length}`).join(","); if (container.dataset.renderedKey === desiredKey) return; container.dataset.renderedKey = desiredKey; container.innerHTML = ""; @@ -419,13 +656,18 @@ function renderPreviewSamples(jobId, samples) { const card = document.createElement("div"); card.className = "preview-sample"; card.dataset.idx = String(sample.index); - card.dataset.viewing = "source"; + + const views = buildPreviewSampleViews(sample); + card._views = views; + card._viewIdx = 0; const ts = formatTimestamp(sample.timestampSec); const projected = sample.projectedTotalHuman || "—"; const sizeStr = sample.encodedSizeHuman || "—"; const bitrate = formatBitrate2(sample.encodedBitrateKbps); + const hint = views.length > 2 ? `Click — ${views.length} views` : "Click to toggle"; + card.innerHTML = `
Loading…
@@ -434,7 +676,7 @@ function renderPreviewSamples(jobId, samples) { - Click to toggle + ${hint}
@@ -460,12 +702,20 @@ function renderPreviewSamples(jobId, samples) { (async () => { try { + // Show source immediately. const sourceUrl = await fetchPreviewArtifactBlob(jobId, sample.index, "source"); - await fetchPreviewArtifactBlob(jobId, sample.index, "encode"); // warm cache const img = card.querySelector("img"); img.src = sourceUrl; img.style.display = ""; card.querySelector(".preview-img-loading").style.display = "none"; + + // Warm-cache every other view so cycling/arrow keys are instant. + for (const v of views) { + if (v.id === "source") continue; + fetchPreviewArtifactBlob(jobId, sample.index, v.id).catch(() => { + // Per-view fetch can fail, just ignore. + }); + } } catch (e) { card.querySelector(".preview-img-loading").textContent = `Failed to load: ${e.message || e}`; } @@ -482,24 +732,29 @@ function formatTimestamp(sec) { return h > 0 ? `${h}:${pad(m)}:${pad(s)}` : `${m}:${pad(s)}`; } -async function setPreviewSampleView(card, view) { +async function setPreviewSampleViewByIdx(card, idx) { const jobId = currentPreviewJobId; - const idx = parseInt(card.dataset.idx, 10); - if (!jobId || !Number.isFinite(idx)) return; + const sampleIdx = parseInt(card.dataset.idx, 10); + if (!jobId || !Number.isFinite(sampleIdx)) return; + + const views = card._views || []; + if (views.length === 0) return; + const wrapped = ((idx % views.length) + views.length) % views.length; + const view = views[wrapped]; try { - const url = await fetchPreviewArtifactBlob(jobId, idx, view); + const url = await fetchPreviewArtifactBlob(jobId, sampleIdx, view.id); const img = card.querySelector("img"); - if (img) img.src = url; - card.dataset.viewing = view; + card._viewIdx = wrapped; + card.dataset.viewing = view.id; - const label = view === "source" ? "Source" : "Encode"; const tag = card.querySelector(".preview-sample-tag"); if (tag) { - tag.textContent = label; - tag.classList.toggle("is-source", view === "source"); - tag.classList.toggle("is-encode", view === "encode"); + tag.textContent = view.label; + tag.classList.toggle("is-source", view.role === "source"); + tag.classList.toggle("is-encode", view.role === "encode"); + tag.classList.toggle("is-vs", view.role === "vs"); } if (currentPreviewFullscreenCard === card) { @@ -507,9 +762,10 @@ async function setPreviewSampleView(card, view) { const fsTag = document.getElementById("preview-fullscreen-tag"); if (fsImg) fsImg.src = url; if (fsTag) { - fsTag.textContent = label; - fsTag.classList.toggle("is-source", view === "source"); - fsTag.classList.toggle("is-encode", view === "encode"); + fsTag.textContent = view.label; + fsTag.classList.toggle("is-source", view.role === "source"); + fsTag.classList.toggle("is-encode", view.role === "encode"); + fsTag.classList.toggle("is-vs", view.role === "vs"); } } } catch (e) { @@ -517,16 +773,25 @@ async function setPreviewSampleView(card, view) { } } +function cyclePreviewSampleView(card, direction) { + const views = card._views || []; + if (views.length === 0) return; + const cur = typeof card._viewIdx === "number" ? card._viewIdx : 0; + return setPreviewSampleViewByIdx(card, cur + direction); +} + async function togglePreviewSampleView(card) { - const next = card.dataset.viewing === "source" ? "encode" : "source"; - await setPreviewSampleView(card, next); + return cyclePreviewSampleView(card, +1); } async function openPreviewFullscreen(card) { if (!card) return; currentPreviewFullscreenCard = card; const idx = parseInt(card.dataset.idx, 10); - const view = card.dataset.viewing || "source"; + const views = card._views || []; + const cur = typeof card._viewIdx === "number" ? card._viewIdx : 0; + const view = views[cur] || { id: "source", label: "Source", role: "source" }; + const modal = document.getElementById("preview-fullscreen-modal"); const title = document.getElementById("preview-fullscreen-title"); const img = document.getElementById("preview-fullscreen-img"); @@ -541,11 +806,11 @@ async function openPreviewFullscreen(card) { modal.style.display = ""; try { - const url = await fetchPreviewArtifactBlob(currentPreviewJobId, idx, view); + const url = await fetchPreviewArtifactBlob(currentPreviewJobId, idx, view.id); img.src = url; img.style.display = ""; loading.style.display = "none"; - await setPreviewSampleView(card, view); + await setPreviewSampleViewByIdx(card, cur); } catch (e) { loading.textContent = `Failed to load: ${e.message || e}`; } @@ -1689,6 +1954,7 @@ async function openSettings() { autoDenoiseThresholds: { ...(defaults.autoDenoiseThresholds || DEFAULT_AUTO_THRESHOLDS) }, nlmeansParams: defaults.nlmeansParams ? JSON.parse(JSON.stringify(defaults.nlmeansParams)) : JSON.parse(JSON.stringify(DEFAULT_NLMEANS_PARAMS)), gradfunParams: defaults.gradfunParams ? JSON.parse(JSON.stringify(defaults.gradfunParams)) : JSON.parse(JSON.stringify(DEFAULT_GRADFUN_PARAMS)), + vsFilters: Array.isArray(defaults.vsFilters) ? JSON.parse(JSON.stringify(defaults.vsFilters)) : [], }; window._tempDefaults = tempDefaults; @@ -1784,6 +2050,8 @@ async function openAdvancedModal(target /* "default" | "job" */) { renderGradfunParamsEditor(document.getElementById("advanced-gradfun-params"), settings.gradfunParams, (v) => (settings.gradfunParams = v)); + renderVsChainEditor(document.getElementById("advanced-vs-chain"), settings); + document.getElementById("advanced-modal").style.display = ""; } @@ -2094,6 +2362,7 @@ async function openJobSettings(jobId) { autoDenoiseThresholds: { ...(job.settings.autoDenoiseThresholds || DEFAULT_AUTO_THRESHOLDS) }, nlmeansParams: job.settings.nlmeansParams ? JSON.parse(JSON.stringify(job.settings.nlmeansParams)) : JSON.parse(JSON.stringify(DEFAULT_NLMEANS_PARAMS)), gradfunParams: job.settings.gradfunParams ? JSON.parse(JSON.stringify(job.settings.gradfunParams)) : JSON.parse(JSON.stringify(DEFAULT_GRADFUN_PARAMS)), + vsFilters: Array.isArray(job.settings.vsFilters) ? JSON.parse(JSON.stringify(job.settings.vsFilters)) : [], }; window._tempJobSettings = tempSettings; @@ -2749,6 +3018,11 @@ function initEventListeners() { document.getElementById("close-advanced-done-btn").addEventListener("click", closeAdvancedModal); document.getElementById("advanced-modal").addEventListener("click", closeAdvancedModalIfOutside); + document.getElementById("vs-reload-btn").onclick = async () => { + await reloadVsPresets(); + renderVsChainEditor(document.getElementById("advanced-vs-chain"), getCurrentSettings()); + }; + document.getElementById("sub-preview-modal").addEventListener("click", closeSubPreviewIfOutside); document.getElementById("logout-btn").addEventListener("click", logout); @@ -2855,8 +3129,27 @@ function initEventListeners() { document.getElementById("preview-fullscreen-stage").addEventListener("click", () => { if (currentPreviewFullscreenCard) togglePreviewSampleView(currentPreviewFullscreenCard); }); + document.addEventListener("keydown", (e) => { - if (e.key === "Escape") closePreviewFullscreen(); + if (e.key === "Escape") { + closePreviewFullscreen(); + return; + } + + // Arrow / Space navigation only fires when fullscreen preview is open. + if (!currentPreviewFullscreenCard) return; + + // Don't hijack typing in inputs. + const t = e.target; + if (t && (t.tagName === "INPUT" || t.tagName === "TEXTAREA" || t.isContentEditable)) return; + + if (e.key === "ArrowRight" || e.code === "Space") { + e.preventDefault(); + cyclePreviewSampleView(currentPreviewFullscreenCard, +1); + } else if (e.key === "ArrowLeft") { + e.preventDefault(); + cyclePreviewSampleView(currentPreviewFullscreenCard, -1); + } }); document.getElementById("open-library-btn").addEventListener("click", openLibrary); diff --git a/public/index.html b/public/index.html index bfbf1fa..acb6a64 100644 --- a/public/index.html +++ b/public/index.html @@ -260,6 +260,16 @@

Advanced Settings

strength = max change per pixel [0.51 – 64], radius = neighbourhood size [8 – 32].
+ +
+ +
+
+ Each filter runs as its own pass before the FFmpeg filter chain. VapourSynth filters are CPU-bound and slower than FFmpeg filters – expect + noticeably longer prepare times. +
+ +
@@ -418,7 +428,7 @@

Preview Encode

@@ -452,7 +462,7 @@

Preview Encode

Preview sample

- Click image to toggle source / encode + Click or ← → / Space to step through views · Esc to close
diff --git a/public/style.css b/public/style.css index 2346c29..eb0bdbb 100644 --- a/public/style.css +++ b/public/style.css @@ -1917,6 +1917,11 @@ code { color: var(--bg-0); } +.preview-sample-tag.is-vs { + background: var(--purple); + color: white; +} + .preview-sample-hint { position: absolute; bottom: 8px; @@ -2103,3 +2108,232 @@ code { border-radius: 4px; pointer-events: none; } + +#advanced-vs-chain { + display: flex; + flex-direction: column; + gap: 10px; +} + +.vs-entry-card { + background: var(--bg-2); + border: 1px solid var(--border-subtle); + border-radius: var(--radius-sm); + padding: 12px 14px; + display: flex; + flex-direction: column; + gap: 10px; +} + +.vs-entry-header { + display: flex; + align-items: center; + gap: 10px; +} + +.vs-entry-name { + font-size: 0.85rem; + font-weight: 600; + color: var(--text-0); +} + +.vs-entry-source { + font-family: var(--font-mono); + font-size: 0.6rem; + font-weight: 600; + text-transform: uppercase; + letter-spacing: 0.08em; + color: var(--text-2); + padding: 2px 7px; + border-radius: 10px; + border: 1px solid var(--border); + background: var(--bg-1); + line-height: 1.4; +} + +.vs-entry-source.user { + color: var(--accent); + border-color: var(--accent); + background: var(--accent-glow); +} + +.vs-entry-header .btn-remove { + margin-left: auto; +} + +.vs-entry-description { + font-size: 0.72rem; + color: var(--text-2); + line-height: 1.4; + margin-top: -4px; +} + +.vs-entry-edit-btn { + align-self: flex-start; + font-family: var(--font-mono); + font-size: 0.7rem; + color: var(--text-2); + background: none; + border: none; + padding: 0; + cursor: pointer; + text-decoration: underline; + text-decoration-color: var(--border); + text-underline-offset: 3px; + transition: color 0.15s; +} +.vs-entry-edit-btn:hover { + color: var(--text-0); + text-decoration-color: var(--text-2); +} +.vs-entry-edit-btn::before { + content: "▸ "; + display: inline-block; + transition: transform 0.15s; +} +.vs-entry-edit-btn.open::before { + transform: rotate(90deg); +} + +.vs-param-panel { + margin-top: 2px; + padding: 12px; + background: var(--bg-1); + border: 1px solid var(--border-subtle); + border-radius: var(--radius-sm); +} + +.vs-param-grid { + display: grid; + gap: 6px 8px; + align-items: center; +} + +.vs-param-header { + font-family: var(--font-mono); + font-size: 0.65rem; + font-weight: 600; + color: var(--text-2); + text-transform: uppercase; + letter-spacing: 0.04em; + padding-bottom: 4px; + text-align: center; +} + +.vs-param-header.vs-param-header-corner { + text-align: left; +} + +.vs-param-row-label { + font-family: var(--font-mono); + font-size: 0.78rem; + color: var(--text-1); + text-transform: lowercase; + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; +} + +.vs-param-cell { + display: flex; + align-items: center; + justify-content: stretch; +} + +.vs-param-cell input[type="number"], +.vs-param-cell select { + font-family: var(--font-mono); + font-size: 0.82rem; + padding: 6px 8px; + background: var(--bg-2); + border: 1px solid var(--border); + border-radius: var(--radius-sm); + color: var(--text-0); + width: 100%; + outline: none; + transition: border-color 0.15s; + box-sizing: border-box; +} +.vs-param-cell input[type="number"]:focus, +.vs-param-cell select:focus { + border-color: var(--accent); +} + +.vs-param-cell input[type="checkbox"] { + width: 16px; + height: 16px; + margin: 0 auto; + accent-color: var(--accent); + cursor: pointer; +} + +.vs-param-help { + grid-column: 1 / -1; + font-size: 0.68rem; + color: var(--text-2); + line-height: 1.4; + margin-top: -2px; + margin-bottom: 4px; + padding-left: 2px; +} + +.vs-param-help code { + font-family: var(--font-mono); + color: var(--text-1); + font-size: 0.95em; +} + +.vs-add-row { + display: flex; + gap: 8px; +} + +.vs-add-row select { + flex: 1; + font-family: var(--font-mono); + font-size: 0.8rem; + padding: 8px 10px; + background: var(--bg-2); + border: 1px solid var(--border); + border-radius: var(--radius-sm); + color: var(--text-0); + cursor: pointer; + outline: none; + transition: border-color 0.15s; +} +.vs-add-row select:hover { + border-color: var(--text-2); +} +.vs-add-row select:focus { + border-color: var(--accent); +} + +.vs-empty { + font-family: var(--font-mono); + font-size: 0.75rem; + color: var(--text-2); + padding: 16px; + text-align: center; + border: 1px dashed var(--border-subtle); + border-radius: var(--radius-sm); +} + +#vs-reload-btn { + margin-top: 8px; + font-size: 0.72rem; + font-family: var(--font-mono); +} + +@media (max-width: 540px) { + .vs-param-grid { + font-size: 0.95em; + } + .vs-param-row-label { + font-size: 0.72rem; + } + .vs-param-cell input[type="number"], + .vs-param-cell select { + font-size: 0.76rem; + padding: 5px 6px; + } +} diff --git a/scripts/Auto-Boost-Essential.py b/scripts/Auto-Boost-Essential.py index 54683e3..a0543b3 100644 --- a/scripts/Auto-Boost-Essential.py +++ b/scripts/Auto-Boost-Essential.py @@ -35,7 +35,7 @@ # 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 +# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER # DEALINGS IN THE SOFTWARE. from vstools import vs, core, depth, DitherType, clip_async_render @@ -263,7 +263,7 @@ def emit_json_throttled(event: str, **kwargs): raise SystemExit(1) if os.path.exists(tmp_dir): - if resume and os.path.exists(stage_file): + if resume and os.path.exists(stage_file): with open(stage_file, "r") as file: lines = file.readlines() stage_resume = int(lines[0].strip()) @@ -280,7 +280,7 @@ def emit_json_throttled(event: str, **kwargs): os.makedirs(tmp_dir) if not os.path.exists(vpy_file): - with open(vpy_file, 'w') as file: + with open(vpy_file, 'w') as file: file.write( f""" from vstools import vs, core, depth, DitherType, set_output @@ -1062,7 +1062,7 @@ def calculate_zones(ranges: list[float], hr: bool, nframe: int) -> None: file.write(f"Zones : {ranges[index]},{end_range-1},{new_crf};") else: file.write(f"{ranges[index]},{end_range-1},{new_crf};") - + emit_json("stage_complete", stage=3, label="Computed zones", total_zones=len(ranges)) if not json_stream: console.print("[cyan]Successfully computed zones.") @@ -1093,7 +1093,7 @@ def calculate_zones(ranges: list[float], hr: bool, nframe: int) -> None: raise SystemExit(1) with open(stage_file, "w") as file: file.write("3") - if not json_stream: + if not json_stream: print('Stage 2 complete!') if stage_resume < 4: try: @@ -1106,7 +1106,7 @@ def calculate_zones(ranges: list[float], hr: bool, nframe: int) -> None: raise SystemExit(1) with open(stage_file, "w") as file: file.write("4") - if not json_stream: + if not json_stream: print('Stage 3 complete!') if stage_resume < 5: final_pass() diff --git a/src/config.ts b/src/config.ts index 653272b..18d390a 100644 --- a/src/config.ts +++ b/src/config.ts @@ -186,6 +186,7 @@ export async function loadConfig(): Promise { dedupeSubtitles, audioLanguages, subtitleLanguages, + vsFilters: [], }, }; } diff --git a/src/encoder.ts b/src/encoder.ts index 9031aa0..5c4727c 100644 --- a/src/encoder.ts +++ b/src/encoder.ts @@ -20,6 +20,7 @@ import { detectSourceTag, detectReleaseGroup, getResolutionTag, extractBaseTitle import pkg from "../package.json"; import { buildPrepareFilterConfig } from "./filters"; import { FFV1_ENCODE_ARGS, runAnalysisPass, runSegmentedAutoDenoiseGpu, type DenoisePlan } from "./auto-denoise"; +import { formatVsProgressDetail, runVsPass, vsRegistry } from "./vs-filters"; export { CancelledError } from "./process"; @@ -162,11 +163,69 @@ export async function encodeJob(job: Job, config: AppConfig, updateJob: (partial throw new Error(`Failed to extract video stream: ${extractRes.stderr || extractRes.stdout}`); } + // VapourSynth filter chain + const activeVsEntries = (job.settings.vsFilters ?? []).filter((e) => e.level !== "off"); + + if (activeVsEntries.length > 0) { + const totalFrames = Math.round(probe.duration * probe.videoStreamFps); + let currentInput = preparedVideo; + + for (let i = 0; i < activeVsEntries.length; i++) { + checkCancelled(); + const entry = activeVsEntries[i]!; + const manifest = vsRegistry.get(entry.presetId); + if (!manifest) { + Logger.warn(`[prepare] Skipping unknown VS preset: ${entry.presetId}`); + continue; + } + + const outPath = join(tempDir, `vs_${i}_${manifest.bareId}.mkv`); + const label = `${manifest.name} (${entry.level})`; + const passBaseProgress = (i / activeVsEntries.length) * 4.5; + const passShare = 4.5 / activeVsEntries.length; + + setStep(S_PREPARE, { progress: passBaseProgress, detail: `${label} — ${fmtFrames(0, totalFrames)}` }); + Logger.info(`[prepare] VS pass ${i + 1}/${activeVsEntries.length}: ${manifest.id} level=${entry.level}`); + + await runVsPass({ + manifest, + entry, + inputPath: currentInput, + outputPath: outPath, + totalFrames, + signal, + onProgress: (current, fps) => { + const passFrac = totalFrames > 0 ? current / totalFrames : 0; + setStep(S_PREPARE, { + progress: passBaseProgress + passShare * passFrac, + detail: formatVsProgressDetail(manifest.name, entry.level, current, totalFrames, fps), + }); + }, + }); + + if (currentInput !== preparedVideo) { + try { + unlinkSync(currentInput); + } catch {} + } + currentInput = outPath; + } + + if (currentInput !== preparedVideo) { + try { + unlinkSync(preparedVideo); + } catch {} + renameSync(currentInput, preparedVideo); + } + + Logger.info(`[prepare] VapourSynth chain complete (${activeVsEntries.length} pass(es))`); + } + // Prepare filter pass (downscale + deband + denoise) let autoPlan: DenoisePlan | null = null; if (job.settings.denoise === "auto") { checkCancelled(); - setStep(S_PREPARE, { progress: 2, detail: "Analyzing noise..." }); + setStep(S_PREPARE, { progress: 4.7, detail: "Analyzing noise..." }); try { autoPlan = await runAnalysisPass(preparedVideo, tempDir, probe.duration, job.settings.autoDenoiseThresholds, signal); } catch (err) { @@ -624,6 +683,17 @@ export async function encodeJob(job: Job, config: AppConfig, updateJob: (partial const outputFilename = `${baseTitle} [${sourceTag}-${resTag}][${audioLabel}][AV1]-${config.organization}.mkv`; const finalOutput = join(tempDir, "final.mkv"); + const vsTagSegment = + activeVsEntries.length > 0 + ? ", VS " + + activeVsEntries + .map((e) => { + const m = vsRegistry.get(e.presetId); + return m ? `${m.bareId}/${e.level}` : e.presetId; + }) + .join("+") + : ""; + const xmlTags = [ '', "", @@ -638,7 +708,8 @@ export async function encodeJob(job: Job, config: AppConfig, updateJob: (partial `Quality ${job.settings.quality}, Speed ${job.settings.finalSpeed}` + `${job.settings.downscale && probe.height > 1080 ? ", Downscale 1080p" : ""}` + `${job.settings.deband !== "off" ? ", Deband " + job.settings.deband : ""}` + - `${job.settings.denoise !== "off" ? ", Denoise " + job.settings.denoise : ""}`, + `${job.settings.denoise !== "off" ? ", Denoise " + job.settings.denoise : ""}` + + vsTagSegment, )}`, "", diff --git a/src/index.ts b/src/index.ts index bfd8bd5..bf39209 100644 --- a/src/index.ts +++ b/src/index.ts @@ -35,9 +35,17 @@ import { cancelBenchmark, getBenchmarkState, startBenchmark } from "./benchmark" import { listOpenClDevices } from "./opencl"; import { listVulkanDevices } from "./vulkan"; import { resolvePreviewArtifact } from "./preview-encoder"; +import { makeDefaultVsFilterEntry, vsRegistry } from "./vs-filters"; export const config = await loadConfig(); +vsRegistry.configure( + process.env.VS_PRESETS_STOCK_DIR ?? "/app/vapoursynth/presets", + process.env.VS_PRESETS_USER_DIR ?? "/config/vapoursynth/presets", + process.env.VS_RABBIT_MODULE_DIR ?? "/app/vapoursynth", +); +vsRegistry.reload(); + const hashedPassword = new Bun.CryptoHasher("blake2b512").update(`rabbitencoder-${process.env.PASSWORD || "rabbitencoder"}`).digest("hex"); mkdirSync(config.inputDir, { recursive: true }); @@ -233,9 +241,13 @@ app.delete("/api/jobs/:id/preview", (c) => { app.get("/api/jobs/:id/preview/sample/:index/:kind", (c) => { const jobId = c.params.id!; const idx = parseInt(c.params.index!, 10); - const kind = c.params.kind as "source" | "encode" | "clip"; + const kind = c.params.kind!; + + if (Number.isNaN(idx)) return c.json({ error: "Bad request" }, 400); - if (Number.isNaN(idx) || !["source", "encode", "clip"].includes(kind)) { + const isStandard = kind === "source" || kind === "encode" || kind === "clip"; + const isVsStep = /^vs:\d+$/.test(kind); + if (!isStandard && !isVsStep) { return c.json({ error: "Bad request" }, 400); } @@ -360,6 +372,21 @@ app.post("/api/library/encode", async (c) => { return c.json({ ok: true, added: totalAdded, skipped: totalSkipped, alreadyEncoded: totalAlreadyEncoded }); }); +app.get("/api/vs-presets", (c) => { + return c.json({ presets: vsRegistry.list() }); +}); + +app.post("/api/vs-presets/reload", (c) => { + vsRegistry.reload(); + return c.json({ ok: true, count: vsRegistry.list().length }); +}); + +app.get("/api/vs-presets/:id/default-entry", (c) => { + const entry = makeDefaultVsFilterEntry(c.params.id!); + if (!entry) return c.json({ error: "Unknown preset" }, 404); + return c.json(entry); +}); + Logger.info(`Rabbit Encoder started on http://0.0.0.0:${config.port}`); if (config.libraryDirs.length > 0) { diff --git a/src/preview-encoder.ts b/src/preview-encoder.ts index e755e6f..1bdbfc4 100644 --- a/src/preview-encoder.ts +++ b/src/preview-encoder.ts @@ -1,11 +1,12 @@ import { existsSync, mkdirSync, renameSync, rmSync, statSync } from "fs"; import { join, parse as parsePath } from "path"; -import type { AppConfig, Job, JobSettings, PreviewSample, PreviewState, ProbeResult } from "./types"; +import type { AppConfig, Job, JobSettings, PreviewSample, PreviewSampleVsFrame, PreviewState, ProbeResult } from "./types"; import { probeFile } from "./probe"; import { CancelledError, describeExitCode, humanSize, run } from "./process"; import { Logger } from "./logger"; import { buildPrepareFilterConfig } from "./filters"; import { FFV1_ENCODE_ARGS, runAnalysisPass, runSegmentedAutoDenoiseGpu } from "./auto-denoise"; +import { formatVsProgressDetail, runVsPass, vsRegistry } from "./vs-filters"; export interface PreviewEncodeOptions { sampleCount: number; @@ -34,6 +35,7 @@ export function previewSettingsFingerprint(s: JobSettings): string { nlmeansParams: s.nlmeansParams, gradfunParams: s.gradfunParams, autoDenoiseThresholds: s.autoDenoiseThresholds, + vsFilters: s.vsFilters ?? [], }); } @@ -163,6 +165,9 @@ async function encodeSample( if (signal.aborted) throw new CancelledError(); }; + const frameOffset = (ctx.windowSec / 2).toFixed(3); + const vsFrames: PreviewSampleVsFrame[] = []; + // 1. Extract source window with FFV1 (lossless, frame-accurate). checkCancelled(); onProgress(0.05, "Extracting source clip"); @@ -191,6 +196,82 @@ async function encodeSample( throw new Error(`Source clip extraction failed: ${extractRes.stderr.slice(-500)}`); } + // 1a. Capture the source PNG NOW, before any VS pass touches source + checkCancelled(); + const sourceFrameRes = await run(buildPreviewPngExtractArgs(sourceClip, frameOffset, sourceFrame, colorInfo, probe), { signal }); + if (sourceFrameRes.code !== 0) { + throw new Error(`Source frame extraction failed: ${sourceFrameRes.stderr.slice(-500)}`); + } + + // 1.5. VapourSynth filter chain + const activeVsEntries = (job.settings.vsFilters ?? []).filter((e) => e.level !== "off"); + + if (activeVsEntries.length > 0) { + const totalFrames = Math.max(1, Math.round(ctx.windowSec * probe.videoStreamFps)); + let currentInput = sourceClip; + + for (let i = 0; i < activeVsEntries.length; i++) { + checkCancelled(); + const entry = activeVsEntries[i]!; + const manifest = vsRegistry.get(entry.presetId); + if (!manifest) { + Logger.warn(`[preview] Skipping unknown VS preset: ${entry.presetId}`); + continue; + } + + const outPath = join(ctx.dir, `vs_${i}_${manifest.bareId}.mkv`); + const passBaseFrac = i / activeVsEntries.length; + const passShareFrac = 1 / activeVsEntries.length; + + Logger.info(`[preview] Sample ${ctx.index} VS pass ${i + 1}/${activeVsEntries.length}: ` + `${manifest.id} level=${entry.level}`); + onProgress(0.05 + 0.05 * passBaseFrac, formatVsProgressDetail(manifest.name, entry.level, 0, totalFrames, null)); + + await runVsPass({ + manifest, + entry, + inputPath: currentInput, + outputPath: outPath, + totalFrames, + signal, + onProgress: (current, fps) => { + const passFrac = totalFrames > 0 ? current / totalFrames : 0; + onProgress(0.05 + 0.05 * (passBaseFrac + passShareFrac * passFrac), formatVsProgressDetail(manifest.name, entry.level, current, totalFrames, fps)); + }, + }); + + // Snapshot a PNG from this pass's output BEFORE we delete/rename the .mkv. + checkCancelled(); + const vsPng = join(ctx.dir, `vs_${i}.png`); + const vsFrameRes = await run(buildPreviewPngExtractArgs(outPath, frameOffset, vsPng, colorInfo, probe), { signal }); + if (vsFrameRes.code !== 0) { + Logger.warn(`[preview] VS snapshot failed for sample ${ctx.index} pass ${i + 1} ` + `(${manifest.id}): ${vsFrameRes.stderr.slice(-300)}`); + } else { + vsFrames.push({ + index: i, + presetId: manifest.id, + bareId: manifest.bareId, + label: `${manifest.name} (${entry.level})`, + }); + } + + if (currentInput !== sourceClip) { + try { + rmSync(currentInput); + } catch {} + } + currentInput = outPath; + } + + if (currentInput !== sourceClip) { + try { + rmSync(sourceClip); + } catch {} + renameSync(currentInput, sourceClip); + } + + Logger.info(`[preview] Sample ${ctx.index}: VS chain complete (${activeVsEntries.length} pass(es))`); + } + // 2. Optional per-clip auto-denoise analysis. let autoPlan = null; if (job.settings.denoise === "auto") { @@ -325,7 +406,7 @@ async function encodeSample( abeLastError = evt.message; } } catch { - // Non-JSON line; ignore — only the JSON events matter here. + // Non-JSON line, just ignore } } } @@ -361,24 +442,11 @@ async function encodeSample( throw new Error(`mkvmerge failed: ${muxRes.stderr || muxRes.stdout}`); } - // 6. Pull a representative frame out of both clips at the centre of the - // window. Seek before -i for speed; both clips were re-encoded as keyframe - // every-frame (FFV1 / ABE output) so seek is exact. + // 6. Pull the encode frame checkCancelled(); - onProgress(0.98, "Extracting comparison frames"); - - const frameOffset = (ctx.windowSec / 2).toFixed(3); + onProgress(0.98, "Extracting comparison frame"); - const sourceFrameRes = await run(buildPreviewPngExtractArgs(sourceClip, frameOffset, sourceFrame, colorInfo, probe), { - signal, - }); - if (sourceFrameRes.code !== 0) { - throw new Error(`Source frame extraction failed: ${sourceFrameRes.stderr.slice(-500)}`); - } - - const encodeFrameRes = await run(buildPreviewPngExtractArgs(encodedClip, frameOffset, encodeFrame, colorInfo, probe), { - signal, - }); + const encodeFrameRes = await run(buildPreviewPngExtractArgs(encodedClip, frameOffset, encodeFrame, colorInfo, probe), { signal }); if (encodeFrameRes.code !== 0) { throw new Error(`Encode frame extraction failed: ${encodeFrameRes.stderr.slice(-500)}`); } @@ -405,6 +473,7 @@ async function encodeSample( projectedTotalBytes, projectedTotalHuman: humanSize(projectedTotalBytes), encodedBitrateKbps, + vsFrames, }; } @@ -476,22 +545,25 @@ export async function runPreviewEncode(args: RunPreviewArgs): Promise(); let paused = false; @@ -74,6 +75,8 @@ function migrateJobSettings(s: any, defaults: JobSettings): JobSettings { // Audio bitrates merge out.audioBitrates = { ...defaults.audioBitrates, ...(s?.audioBitrates ?? {}) }; + out.vsFilters = normalizeVsFilterChain(s?.vsFilters ?? defaults.vsFilters); + return out; } @@ -202,6 +205,9 @@ export function updateDefaults(settings: Partial): JobSettings { if (settings.gradfunParams) { appConfig.defaults.gradfunParams = normalizeGradfunLevelParams(settings.gradfunParams, appConfig.defaults.gradfunParams); } + if (Array.isArray(settings.vsFilters)) { + appConfig.defaults.vsFilters = normalizeVsFilterChain(settings.vsFilters); + } if (settings.audioBitrates) { appConfig.defaults.audioBitrates = { ...appConfig.defaults.audioBitrates, @@ -406,6 +412,11 @@ export function updateJobSettings(id: string, settings: Partial): J if (settings.gradfunParams) { job.settings.gradfunParams = normalizeGradfunLevelParams(settings.gradfunParams, job.settings.gradfunParams); } + + if (Array.isArray(settings.vsFilters)) { + job.settings.vsFilters = normalizeVsFilterChain(settings.vsFilters); + } + if (settings.audioBitrates) { job.settings.audioBitrates = { ...job.settings.audioBitrates, diff --git a/src/types.ts b/src/types.ts index f350b08..7151a5e 100644 --- a/src/types.ts +++ b/src/types.ts @@ -94,6 +94,13 @@ export interface JobSettings { dedupeSubtitles: boolean; audioLanguages: string[]; subtitleLanguages: string[]; + /** + * Ordered list of VapourSynth filter passes to apply during the prepare + * stage, before the FFmpeg -vf chain. Each entry references a preset by + * namespaced id ("stock:finedehalo" or "user:my_dehalo"), selects an + * active level, and stores per-level param values. + */ + vsFilters: VsFilterEntry[]; } export interface AudioStreamInfo { @@ -239,6 +246,17 @@ export interface AudioPreviewResult { output: AudioPreviewTrack[]; } +export interface PreviewSampleVsFrame { + /** Zero-based index in the active VS chain. */ + index: number; + /** Namespaced preset id (e.g. "stock:f3k_deband"). */ + presetId: string; + /** Bare preset id, useful for filenames or download labels. */ + bareId: string; + /** Human-readable label like "F3K Deband (heavy)". */ + label: string; +} + export interface PreviewSample { index: number; timestampSec: number; @@ -248,6 +266,7 @@ export interface PreviewSample { projectedTotalBytes: number; projectedTotalHuman: string; encodedBitrateKbps: number; + vsFrames: PreviewSampleVsFrame[]; } export interface PreviewState { @@ -263,3 +282,56 @@ export interface PreviewState { sampleCount: number; windowSeconds: number; } + +export type VsParamType = "float" | "int" | "bool" | "enum"; +export type VsParamValue = number | boolean | string; +export type VsPresetSource = "stock" | "user"; + +export interface VsParamSpec { + key: string; + label: string; + type: VsParamType; + min?: number; + max?: number; + step?: number; + enum?: string[]; + help?: string; + /** Per-level default values. Keys must match the preset's `levels` array. */ + defaults: Record; +} + +export interface VsPresetManifest { + /** Namespaced id: "stock:finedehalo" or "user:my_dehalo". */ + id: string; + /** Bare id from the manifest file (without source prefix). */ + bareId: string; + name: string; + description: string; + category?: string; + supports: { bitDepth: number[]; hdr: boolean }; + /** Ordered list of level names this preset offers (e.g. ["light","medium","heavy"]). */ + levels: string[]; + params: VsParamSpec[]; + source: VsPresetSource; + /** Absolute path to the .vpy script. */ + scriptPath: string; + /** Absolute path to the .json manifest. */ + manifestPath: string; +} + +/** + * One entry in a job's VapourSynth filter chain. + * + * presetId : namespaced id of the preset to run. + * level : "off" disables this entry without removing it; otherwise must + * be one of the preset's declared levels. + * params : per-level override map. Pre-populated from manifest defaults + * when the entry is created; users can edit individual values + * in Advanced settings without losing other levels' tweaks. + * Shape: { [level]: { [paramKey]: value } } + */ +export interface VsFilterEntry { + presetId: string; + level: string; + params: Record>; +} diff --git a/src/vs-filters.ts b/src/vs-filters.ts new file mode 100644 index 0000000..6920e2c --- /dev/null +++ b/src/vs-filters.ts @@ -0,0 +1,554 @@ +import { existsSync, readFileSync, readdirSync, statSync } from "fs"; +import { join, parse as parsePath, basename } from "path"; +import { Logger } from "./logger"; +import { CancelledError, computeFps, fmtFrames } from "./process"; +import { FFV1_ENCODE_ARGS } from "./auto-denoise"; +import type { VsFilterEntry, VsParamSpec, VsParamType, VsParamValue, VsPresetManifest, VsPresetSource } from "./types"; + +const STOCK_DIR_DEFAULT = "/app/vapoursynth/presets"; +const USER_DIR_DEFAULT = "/config/vapoursynth/presets"; +const RABBIT_VS_DIR_DEFAULT = "/app/vapoursynth"; + +class VsRegistry { + private presets = new Map(); + private stockDir = STOCK_DIR_DEFAULT; + private userDir = USER_DIR_DEFAULT; + private rabbitVsDir = RABBIT_VS_DIR_DEFAULT; + + configure(stockDir: string, userDir: string, rabbitVsDir: string): void { + this.stockDir = stockDir; + this.userDir = userDir; + this.rabbitVsDir = rabbitVsDir; + } + + /** Path that must be on PYTHONPATH so `import rabbit_vs` resolves. */ + getRabbitVsDir(): string { + return this.rabbitVsDir; + } + + reload(): void { + this.presets.clear(); + this.scanDir(this.stockDir, "stock"); + this.scanDir(this.userDir, "user"); + Logger.info(`[vs] Loaded ${this.presets.size} preset(s)`); + } + + private scanDir(dir: string, source: VsPresetSource): void { + if (!existsSync(dir)) { + Logger.debug(`[vs] Preset dir does not exist: ${dir}`); + return; + } + + let entries: string[]; + try { + entries = readdirSync(dir); + } catch (err: any) { + Logger.warn(`[vs] Failed to read preset dir ${dir}: ${err?.message || err}`); + return; + } + + for (const entry of entries) { + if (!entry.endsWith(".json")) continue; + + const manifestPath = join(dir, entry); + const stem = parsePath(entry).name; + const scriptPath = join(dir, `${stem}.vpy`); + + if (!existsSync(scriptPath)) { + Logger.warn(`[vs] Manifest ${manifestPath} has no matching .vpy script — skipping`); + continue; + } + + try { + const raw = readFileSync(manifestPath, "utf-8"); + const parsed = JSON.parse(raw); + const manifest = validateManifest(parsed, source, scriptPath, manifestPath); + if (this.presets.has(manifest.id)) { + Logger.warn(`[vs] Duplicate preset id ${manifest.id} — keeping first definition`); + continue; + } + this.presets.set(manifest.id, manifest); + Logger.debug(`[vs] Registered ${manifest.id} (${manifest.params.length} params, levels: ${manifest.levels.join(",")})`); + } catch (err: any) { + Logger.warn(`[vs] Failed to load preset ${manifestPath}: ${err?.message || err}`); + } + } + } + + get(id: string): VsPresetManifest | undefined { + return this.presets.get(id); + } + + list(): VsPresetManifest[] { + return Array.from(this.presets.values()).sort((a, b) => { + // stock first, then user; alphabetical within each group + if (a.source !== b.source) return a.source === "stock" ? -1 : 1; + return a.name.localeCompare(b.name); + }); + } +} + +export const vsRegistry = new VsRegistry(); + +// --------------------------------------------------------------------------- +// Manifest validation +// --------------------------------------------------------------------------- + +function validateManifest(raw: any, source: VsPresetSource, scriptPath: string, manifestPath: string): VsPresetManifest { + const where = `manifest ${manifestPath}`; + + if (typeof raw?.id !== "string" || !/^[a-z0-9_-]+$/i.test(raw.id)) { + throw new Error(`${where}: invalid or missing "id" (must be [a-z0-9_-]+)`); + } + if (typeof raw?.name !== "string") throw new Error(`${where}: missing "name"`); + if (!Array.isArray(raw?.levels) || raw.levels.length === 0) { + throw new Error(`${where}: "levels" must be a non-empty array of strings`); + } + const levels: string[] = raw.levels.map((l: any) => String(l)); + const levelSet = new Set(levels); + if (levelSet.size !== levels.length) { + throw new Error(`${where}: duplicate level names`); + } + + if (!Array.isArray(raw?.params)) throw new Error(`${where}: "params" must be an array`); + const params: VsParamSpec[] = raw.params.map((p: any, i: number) => validateParam(p, levels, `${where} params[${i}]`)); + + const seenKeys = new Set(); + for (const p of params) { + if (seenKeys.has(p.key)) throw new Error(`${where}: duplicate param key "${p.key}"`); + seenKeys.add(p.key); + } + + const supports = { + bitDepth: Array.isArray(raw?.supports?.bitDepth) + ? raw.supports.bitDepth.map((n: any) => Number(n)).filter((n: number) => Number.isInteger(n)) + : [8, 10, 16], + hdr: !!raw?.supports?.hdr, + }; + + const bareId = String(raw.id); + + return { + id: `${source}:${bareId}`, + bareId, + name: String(raw.name), + description: typeof raw.description === "string" ? raw.description : "", + category: typeof raw.category === "string" ? raw.category : undefined, + supports, + levels, + params, + source, + scriptPath, + manifestPath, + }; +} + +function validateParam(raw: any, levels: string[], where: string): VsParamSpec { + if (typeof raw?.key !== "string" || !/^[a-zA-Z_][a-zA-Z0-9_]*$/.test(raw.key)) { + throw new Error(`${where}: invalid or missing "key"`); + } + const type: VsParamType = raw.type; + if (!["float", "int", "bool", "enum"].includes(type)) { + throw new Error(`${where}: "type" must be one of float|int|bool|enum`); + } + + if (type === "enum" && (!Array.isArray(raw.enum) || raw.enum.length === 0)) { + throw new Error(`${where}: enum param requires a non-empty "enum" array`); + } + + if (typeof raw?.defaults !== "object" || raw.defaults === null) { + throw new Error(`${where}: "defaults" must be an object keyed by level name`); + } + const defaults: Record = {}; + for (const lvl of levels) { + if (!(lvl in raw.defaults)) { + throw new Error(`${where}: missing default for level "${lvl}"`); + } + defaults[lvl] = coerceValue(raw.defaults[lvl], type, raw.enum); + } + + return { + key: raw.key, + label: typeof raw.label === "string" ? raw.label : raw.key, + type, + min: typeof raw.min === "number" ? raw.min : undefined, + max: typeof raw.max === "number" ? raw.max : undefined, + step: typeof raw.step === "number" ? raw.step : undefined, + enum: type === "enum" ? raw.enum.map((s: any) => String(s)) : undefined, + help: typeof raw.help === "string" ? raw.help : undefined, + defaults, + }; +} + +function coerceValue(v: unknown, type: VsParamType, enumValues?: string[]): VsParamValue { + if (type === "bool") return !!v; + if (type === "int") { + const n = Number(v); + if (!Number.isFinite(n)) throw new Error(`expected int, got ${JSON.stringify(v)}`); + return Math.round(n); + } + if (type === "float") { + const n = Number(v); + if (!Number.isFinite(n)) throw new Error(`expected float, got ${JSON.stringify(v)}`); + return n; + } + // enum + const s = String(v); + if (enumValues && !enumValues.includes(s)) { + throw new Error(`enum value "${s}" not in [${enumValues.join(", ")}]`); + } + return s; +} + +// --------------------------------------------------------------------------- +// Param normalization (for incoming entries from the API / queue.json) +// --------------------------------------------------------------------------- + +function clampNum(v: number, min?: number, max?: number): number { + if (typeof min === "number" && v < min) v = min; + if (typeof max === "number" && v > max) v = max; + return v; +} + +function normalizeOne(raw: unknown, spec: VsParamSpec): VsParamValue { + switch (spec.type) { + case "bool": + return typeof raw === "boolean" ? raw : raw === "true" || raw === 1; + case "int": { + const n = typeof raw === "number" ? raw : parseFloat(String(raw)); + return Number.isFinite(n) ? clampNum(Math.round(n), spec.min, spec.max) : 0; + } + case "float": { + const n = typeof raw === "number" ? raw : parseFloat(String(raw)); + return Number.isFinite(n) ? clampNum(n, spec.min, spec.max) : 0; + } + case "enum": { + const s = String(raw); + return spec.enum && spec.enum.includes(s) ? s : (spec.enum?.[0] ?? ""); + } + } +} + +/** + * Normalize a (possibly partial / legacy) VsFilterEntry against its manifest. + * + * - Fills in any missing per-level defaults from the manifest. + * - Clamps every value to its declared range. + * - Forces `level` to be either "off" or one of the manifest's levels. + * + * Returns null if the manifest can't be found (preset deleted/renamed). + */ +export function normalizeVsFilterEntry(entry: Partial | undefined | null): VsFilterEntry | null { + if (!entry || typeof entry.presetId !== "string") return null; + const manifest = vsRegistry.get(entry.presetId); + if (!manifest) { + Logger.warn(`[vs] Dropping entry with unknown preset: ${entry.presetId}`); + return null; + } + + const params: Record> = {}; + const incoming = (entry.params ?? {}) as Record>; + + for (const lvl of manifest.levels) { + const lvlIn = incoming[lvl] ?? {}; + const lvlOut: Record = {}; + for (const spec of manifest.params) { + const provided = lvlIn[spec.key]; + lvlOut[spec.key] = provided === undefined ? spec.defaults[lvl]! : normalizeOne(provided, spec); + } + params[lvl] = lvlOut; + } + + const requestedLevel = String(entry.level ?? "off"); + const level = requestedLevel === "off" || manifest.levels.includes(requestedLevel) ? requestedLevel : "off"; + + return { + presetId: manifest.id, + level, + params, + }; +} + +export function normalizeVsFilterChain(entries: Partial[] | undefined | null): VsFilterEntry[] { + if (!Array.isArray(entries)) return []; + const out: VsFilterEntry[] = []; + for (const e of entries) { + const n = normalizeVsFilterEntry(e); + if (n) out.push(n); + } + return out; +} + +/** + * Build a fresh entry for a preset, filling all levels with manifest defaults. + * Used by the UI when the user adds a new filter to the chain. + */ +export function makeDefaultVsFilterEntry(presetId: string): VsFilterEntry | null { + const manifest = vsRegistry.get(presetId); + if (!manifest) return null; + const params: Record> = {}; + for (const lvl of manifest.levels) { + const lvlOut: Record = {}; + for (const spec of manifest.params) lvlOut[spec.key] = spec.defaults[lvl]!; + params[lvl] = lvlOut; + } + return { + presetId: manifest.id, + level: manifest.levels[0]!, // default to first declared level + params, + }; +} + +// --------------------------------------------------------------------------- +// Color metadata probing +// --------------------------------------------------------------------------- + +interface SourceColorTags { + pixFmt: string; + colorRange?: string; + colorPrimaries?: string; + colorTrc?: string; + colorSpace?: string; +} + +async function probeSourceColor(inputPath: string): Promise { + const proc = Bun.spawn( + [ + "ffprobe", + "-v", + "error", + "-select_streams", + "v:0", + "-show_entries", + "stream=pix_fmt,color_range,color_primaries,color_trc,color_space", + "-of", + "json", + inputPath, + ], + { stdout: "pipe", stderr: "pipe" }, + ); + const out = await new Response(proc.stdout).text(); + await proc.exited; + + let s: any = {}; + try { + s = JSON.parse(out)?.streams?.[0] ?? {}; + } catch {} + + const clean = (v: unknown): string | undefined => { + if (typeof v !== "string") return undefined; + const t = v.trim(); + if (!t || t === "unknown" || t === "N/A") return undefined; + return t; + }; + + return { + pixFmt: clean(s.pix_fmt) ?? "yuv420p", + colorRange: clean(s.color_range), + colorPrimaries: clean(s.color_primaries), + colorTrc: clean(s.color_trc), + colorSpace: clean(s.color_space), + }; +} + +function buildColorPassthroughArgs(c: SourceColorTags): string[] { + const args: string[] = []; + if (c.colorRange) args.push("-color_range", c.colorRange); + if (c.colorPrimaries) args.push("-color_primaries", c.colorPrimaries); + if (c.colorTrc) args.push("-color_trc", c.colorTrc); + if (c.colorSpace) args.push("-colorspace", c.colorSpace); + return args; +} + +// --------------------------------------------------------------------------- +// Command construction +// --------------------------------------------------------------------------- + +/** + * Build the vspipe argv that runs `manifest`'s script with the params for the + * selected level. + * + * The convention every preset must follow is: read `SRC` and the named params + * via `rabbit_vs.arg_*`. We pass them as -a key=value pairs. + */ +export function buildVsCommand(manifest: VsPresetManifest, entry: VsFilterEntry, inputPath: string): string[] { + if (entry.level === "off" || !manifest.levels.includes(entry.level)) { + throw new Error(`buildVsCommand called for inactive entry (level=${entry.level})`); + } + + const lvlParams = entry.params[entry.level] ?? {}; + + const args: string[] = ["vspipe", manifest.scriptPath, "-", "-p", "-c", "y4m", "--arg", `SRC=${inputPath}`]; + + for (const spec of manifest.params) { + const v = lvlParams[spec.key] ?? spec.defaults[entry.level]; + args.push("--arg", `${spec.key}=${formatArg(v!, spec)}`); + } + + return args; +} + +function formatArg(v: VsParamValue, spec: VsParamSpec): string { + if (spec.type === "bool") return v ? "true" : "false"; + return String(v); +} + +// --------------------------------------------------------------------------- +// Runner: vspipe → ffmpeg(FFV1) with progress + cancel +// --------------------------------------------------------------------------- + +export interface VsPassResult { + /** Final output path (same as the one passed in). */ + outputPath: string; + /** Frames written to the output. */ + frames: number; + /** Tail of stderr from both processes, concatenated, for diagnostics. */ + stderrTail: string; +} + +export interface RunVsPassOptions { + manifest: VsPresetManifest; + entry: VsFilterEntry; + inputPath: string; + outputPath: string; + totalFrames: number; + onProgress?: (currentFrames: number, fpsStr: string | null) => void; + signal?: AbortSignal; +} + +/** + * Run a single VapourSynth pass on `inputPath`, writing FFV1 to `outputPath`. + * + * Internally: `vspipe -c y4m ... script.vpy -` | `ffmpeg -i pipe:0 ... FFV1` + * + * Color metadata is probed from the source and re-applied on the ffmpeg side + * because the y4m container does not carry full HDR signalling. + */ +export async function runVsPass(opts: RunVsPassOptions): Promise { + const { manifest, entry, inputPath, outputPath, totalFrames, onProgress, signal } = opts; + + if (signal?.aborted) throw new CancelledError(); + + const colorTags = await probeSourceColor(inputPath); + const colorArgs = buildColorPassthroughArgs(colorTags); + + const vsArgs = buildVsCommand(manifest, entry, inputPath); + + const env: Record = { ...process.env } as Record; + const existingPyPath = env.PYTHONPATH ? `:${env.PYTHONPATH}` : ""; + env.PYTHONPATH = `${vsRegistry.getRabbitVsDir()}${existingPyPath}`; + + Logger.debug(`[vs] ${manifest.id} level=${entry.level} cmd: ${vsArgs.join(" ")}`); + + const vspipe = Bun.spawn(vsArgs, { + stdout: "pipe", + stderr: "pipe", + env, + }); + + const ffmpegArgs = ["ffmpeg", "-y", "-f", "yuv4mpegpipe", "-i", "pipe:0", ...colorArgs, ...FFV1_ENCODE_ARGS, "-an", "-sn", outputPath]; + + const ffmpeg = Bun.spawn(ffmpegArgs, { + stdin: vspipe.stdout, + stdout: "pipe", + stderr: "pipe", + }); + + // Cancellation: kill both, ffmpeg first so vspipe sees SIGPIPE on its stdout. + const onAbort = () => { + try { + ffmpeg.kill("SIGTERM"); + } catch {} + try { + vspipe.kill("SIGTERM"); + } catch {} + setTimeout(() => { + try { + ffmpeg.kill("SIGKILL"); + } catch {} + try { + vspipe.kill("SIGKILL"); + } catch {} + }, 3000); + }; + if (signal) { + if (signal.aborted) onAbort(); + else signal.addEventListener("abort", onAbort, { once: true }); + } + + // vspipe progress goes to stderr as "Frame: X/Y (Z fps)". + const startedAt = Date.now(); + let currentFrames = 0; + + const vsStderrTask = readStderrLines(vspipe.stderr, (line) => { + const m = line.match(/Frame:\s*(\d+)\s*\/\s*(\d+)/); + if (m) { + currentFrames = parseInt(m[1]!, 10); + const fps = computeFps(currentFrames, startedAt); + onProgress?.(currentFrames, fps); + } + }); + + const ffStderrTask = readStderrLines(ffmpeg.stderr, () => { + // We rely on vspipe for progress; ffmpeg's frame= can lag. + }); + + const [vsStderr, ffStderr] = await Promise.all([vsStderrTask, ffStderrTask]); + const vsCode = await vspipe.exited; + const ffCode = await ffmpeg.exited; + + if (signal && !signal.aborted) signal.removeEventListener("abort", onAbort); + if (signal?.aborted) throw new CancelledError(); + + if (vsCode !== 0 || ffCode !== 0) { + const tail = [ + vsCode !== 0 ? `vspipe exited ${vsCode}:\n${vsStderr.trim().split("\n").slice(-15).join("\n")}` : "", + ffCode !== 0 ? `ffmpeg exited ${ffCode}:\n${ffStderr.trim().split("\n").slice(-15).join("\n")}` : "", + ] + .filter(Boolean) + .join("\n---\n"); + throw new Error(`VapourSynth pass failed (preset=${manifest.id}, level=${entry.level}):\n${tail}`); + } + + return { + outputPath, + frames: currentFrames || totalFrames, + stderrTail: `${vsStderr}\n${ffStderr}`.slice(-2000), + }; +} + +async function readStderrLines(stream: ReadableStream | undefined | null, onLine: (line: string) => void): Promise { + if (!stream) return ""; + const reader = stream.getReader(); + const decoder = new TextDecoder(); + let buffer = ""; + const collected: string[] = []; + + while (true) { + const { done, value } = await reader.read(); + if (done) break; + buffer += decoder.decode(value, { stream: true }); + const parts = buffer.split(/[\r\n]/); + buffer = parts.pop() || ""; + for (const part of parts) { + if (part) { + collected.push(part); + onLine(part); + } + } + } + if (buffer) { + collected.push(buffer); + onLine(buffer); + } + return collected.join("\n"); +} + +// --------------------------------------------------------------------------- +// Pretty progress string for the encoder UI +// --------------------------------------------------------------------------- + +export function formatVsProgressDetail(presetName: string, level: string, current: number, total: number, fpsStr: string | null): string { + const base = `${presetName} (${level}) — ${fmtFrames(current, total)}`; + return fpsStr ? `${base} @ ${fpsStr} fps` : base; +} diff --git a/vapoursynth/presets/dehalo_alpha.json b/vapoursynth/presets/dehalo_alpha.json new file mode 100644 index 0000000..8b45caf --- /dev/null +++ b/vapoursynth/presets/dehalo_alpha.json @@ -0,0 +1,104 @@ +{ + "id": "dehalo_alpha", + "name": "Dehalo Alpha", + "description": "Reduces halos around high-contrast edges using vs-jetpack dehalo_alpha.", + "category": "Dehalo", + "levels": ["light", "medium", "heavy"], + "supports": { + "bitDepth": [8, 10, 16], + "hdr": true + }, + "params": [ + { + "key": "blur", + "label": "Blur sigma", + "type": "float", + "min": 0.5, + "max": 3.0, + "step": 0.1, + "defaults": { + "light": 1.2, + "medium": 1.4, + "heavy": 1.6 + } + }, + { + "key": "darkstr", + "label": "Dark halo strength", + "type": "float", + "min": 0, + "max": 1, + "step": 0.05, + "defaults": { + "light": 0.0, + "medium": 0.0, + "heavy": 0.1 + } + }, + { + "key": "brightstr", + "label": "Bright halo strength", + "type": "float", + "min": 0, + "max": 1, + "step": 0.05, + "defaults": { + "light": 0.5, + "medium": 0.75, + "heavy": 1.0 + } + }, + { + "key": "lowsens", + "label": "Low sensitivity", + "type": "float", + "min": -1, + "max": 100, + "step": 1, + "defaults": { + "light": 40, + "medium": 50, + "heavy": 60 + } + }, + { + "key": "highsens", + "label": "High sensitivity", + "type": "float", + "min": -1, + "max": 100, + "step": 1, + "defaults": { + "light": 40, + "medium": 50, + "heavy": 60 + } + }, + { + "key": "ss", + "label": "Supersampling", + "type": "float", + "min": 1, + "max": 2, + "step": 0.1, + "defaults": { + "light": 1.0, + "medium": 1.25, + "heavy": 1.5 + } + }, + { + "key": "planes", + "label": "Planes", + "type": "int", + "min": 0, + "max": 2, + "step": 1, + "defaults": { + "light": 0, + "medium": 0, + "heavy": 0 + } + } + ] +} diff --git a/vapoursynth/presets/dehalo_alpha.vpy b/vapoursynth/presets/dehalo_alpha.vpy new file mode 100644 index 0000000..7f2d7c4 --- /dev/null +++ b/vapoursynth/presets/dehalo_alpha.vpy @@ -0,0 +1,38 @@ +""" +DehaloAlpha - vs-jetpack dehalo_alpha implementation. + +API: https://jaded-encoding-thaumaturgy.github.io/vs-jetpack/api/vsdehalo/alpha/#vsdehalo.alpha.dehalo_alpha +""" + +import vapoursynth as vs +from vsdehalo import dehalo_alpha + +import rabbit_vs + +core = vs.core + +src_path = rabbit_vs.arg_str("SRC") + +blur = rabbit_vs.arg_float("blur", 1.4) +lowsens = rabbit_vs.arg_float("lowsens", 50.0) +highsens = rabbit_vs.arg_float("highsens", 50.0) +ss = rabbit_vs.arg_float("ss", 1.5) +darkstr = rabbit_vs.arg_float("darkstr", 0.0) +brightstr = rabbit_vs.arg_float("brightstr", 1.0) +planes = rabbit_vs.arg_int("planes", 0) + +src = rabbit_vs.load_source(src_path) + +work = dehalo_alpha( + src, + blur=blur, + lowsens=lowsens, + highsens=highsens, + ss=ss, + darkstr=darkstr, + brightstr=brightstr, + planes=planes, +) + +out = rabbit_vs.match_format(work, src) +out.set_output(0) \ No newline at end of file diff --git a/vapoursynth/presets/f3k_deband.json b/vapoursynth/presets/f3k_deband.json new file mode 100644 index 0000000..cdf4156 --- /dev/null +++ b/vapoursynth/presets/f3k_deband.json @@ -0,0 +1,127 @@ +{ + "id": "f3k_deband", + "name": "F3K Deband", + "description": "Removes color banding in smooth gradients while preserving detail. Wraps vszip.Deband (modern f3kdb successor) via vs-jetpack. Raise thr/radius and add grain for stubborn bands; use sparingly on detailed sources.", + "category": "Deband", + "supports": { + "bitDepth": [8, 10, 12, 16], + "hdr": true + }, + "levels": ["light", "medium", "heavy"], + "params": [ + { + "key": "radius", + "label": "Radius", + "type": "int", + "min": 1, + "max": 255, + "step": 1, + "defaults": { + "light": 12, + "medium": 16, + "heavy": 20 + }, + "help": "Banding detection radius. Larger values catch wider bands but blur more detail." + }, + { + "key": "thr", + "label": "Threshold", + "type": "float", + "min": 1, + "max": 255, + "step": 1, + "defaults": { + "light": 48, + "medium": 96, + "heavy": 128 + }, + "help": "Banding detection threshold. A pixel is considered banded if the difference with its reference is below this value. Higher = more aggressive but more risk to detail." + }, + { + "key": "grain", + "label": "Grain", + "type": "float", + "min": 0, + "max": 256, + "step": 1, + "defaults": { + "light": 0, + "medium": 0, + "heavy": 24 + }, + "help": "Grain to add after debanding. Useful for masking residual banding and matching natural film grain. 0 disables." + }, + { + "key": "planes", + "label": "Planes", + "type": "enum", + "enum": ["all", "luma", "chroma"], + "defaults": { + "light": "all", + "medium": "all", + "heavy": "all" + }, + "help": "Which planes to process. Banding usually shows in luma but can affect chroma too on heavily compressed sources." + }, + { + "key": "sample_mode", + "label": "Sample mode", + "type": "enum", + "enum": ["COLUMN", "SQUARE", "ROW", "COL_ROW_MEAN", "MEAN_DIFF_INT", "MEAN_DIFF_FLOAT", "MEAN_DIFF_GRADIENT"], + "defaults": { + "light": "SQUARE", + "medium": "SQUARE", + "heavy": "SQUARE" + }, + "help": "Strategy for sampling reference pixels. SQUARE (4 points) is the default; MEAN_DIFF modes use additional thresholds for stronger detail preservation." + }, + { + "key": "dynamic_grain", + "label": "Dynamic grain", + "type": "bool", + "defaults": { + "light": false, + "medium": false, + "heavy": true + }, + "help": "Generate a unique grain pattern per frame. Looks more natural in motion but adds temporal noise that can hurt encoder efficiency." + }, + { + "key": "blur_first", + "label": "Blur first", + "type": "bool", + "defaults": { + "light": true, + "medium": true, + "heavy": true + }, + "help": "If true, compares the current pixel against the mean of references. If false, compares against each reference individually (stricter — pixel only marked banded when ALL pairwise differences are below threshold)." + }, + { + "key": "seed", + "label": "Random seed", + "type": "int", + "min": -1, + "max": 2147483647, + "step": 1, + "defaults": { + "light": -1, + "medium": -1, + "heavy": -1 + }, + "help": "Seed for grain RNG. -1 picks a random seed each run (varies between encodes); set to a fixed positive integer for reproducible output." + }, + { + "key": "random", + "label": "Random algorithm", + "type": "enum", + "enum": ["OLD", "UNIFORM", "GAUSSIAN"], + "defaults": { + "light": "UNIFORM", + "medium": "UNIFORM", + "heavy": "UNIFORM" + }, + "help": "RNG strategy used for both reference positions and grain. UNIFORM is the default; OLD is the legacy algorithm; GAUSSIAN gives a normal distribution." + } + ] +} diff --git a/vapoursynth/presets/f3k_deband.vpy b/vapoursynth/presets/f3k_deband.vpy new file mode 100644 index 0000000..0285682 --- /dev/null +++ b/vapoursynth/presets/f3k_deband.vpy @@ -0,0 +1,85 @@ +""" +F3KDeband - vs-jetpack f3k_deband implementation. + +Wrapper around the vszip.Deband plugin (modern f3kdb successor) for removing +color banding in smooth gradients while preserving detail. Particularly useful +for animation, low-bitrate sources, and 8-bit content with quantization bands. + +Backed by `vsdeband.f3k_deband` (vs-jetpack). +API reference: https://jaded-encoding-thaumaturgy.github.io/vs-jetpack/api/vsdeband/debanders/#vsdeband.debanders.f3k_deband + +Tunables exposed by this preset: + radius - banding detection radius (1 - 255) + thr - banding detection threshold (1 - 255) + grain - grain to add after debanding (0 - 256) + planes - which planes to process (all | luma | chroma) + sample_mode - reference pixel sampling strategy + dynamic_grain - generate unique grain per frame (bool) + blur_first - compare against mean of refs vs each ref individually (bool) + seed - grain RNG seed; -1 picks a random seed each run + random - RNG algorithm for reference positions and grain +""" + +import vapoursynth as vs +from vsdeband import f3k_deband + +import rabbit_vs + +core = vs.core + +src_path = rabbit_vs.arg_str("SRC") + +radius = rabbit_vs.arg_int("radius", 16) +thr = rabbit_vs.arg_float("thr", 96.0) +grain = rabbit_vs.arg_float("grain", 0.0) +planes_s = rabbit_vs.arg_str("planes", "all") +sample_mode_s = rabbit_vs.arg_str("sample_mode", "SQUARE") +dynamic_grain = rabbit_vs.arg_bool("dynamic_grain", False) +blur_first = rabbit_vs.arg_bool("blur_first", True) +seed = rabbit_vs.arg_int("seed", -1) +random_s = rabbit_vs.arg_str("random", "UNIFORM") + +SAMPLE_MODES = { + "COLUMN": f3k_deband.SampleMode.COLUMN, + "SQUARE": f3k_deband.SampleMode.SQUARE, + "ROW": f3k_deband.SampleMode.ROW, + "COL_ROW_MEAN": f3k_deband.SampleMode.COL_ROW_MEAN, + "MEAN_DIFF_INT": f3k_deband.SampleMode.MEAN_DIFF_INT, + "MEAN_DIFF_FLOAT": f3k_deband.SampleMode.MEAN_DIFF_FLOAT, + "MEAN_DIFF_GRADIENT": f3k_deband.SampleMode.MEAN_DIFF_GRADIENT, +} + +RANDOM_ALGOS = { + "OLD": f3k_deband.RandomAlgo.OLD, + "UNIFORM": f3k_deband.RandomAlgo.UNIFORM, + "GAUSSIAN": f3k_deband.RandomAlgo.GAUSSIAN, +} + +PLANES = { + "all": None, + "luma": 0, + "chroma": [1, 2], +} + +sample_mode = SAMPLE_MODES.get(sample_mode_s, f3k_deband.SampleMode.SQUARE) +random_algo = RANDOM_ALGOS.get(random_s, f3k_deband.RandomAlgo.UNIFORM) +planes = PLANES.get(planes_s, None) + +src = rabbit_vs.load_source(src_path) +work = rabbit_vs.to_working_depth(src, 16) + +work = f3k_deband( + work, + radius=radius, + thr=thr, + grain=grain, + planes=planes, + sample_mode=sample_mode, + dynamic_grain=dynamic_grain, + blur_first=blur_first, + seed=seed if seed >= 0 else None, + random=random_algo, +) + +out = rabbit_vs.match_format(work, src) +out.set_output(0) \ No newline at end of file diff --git a/vapoursynth/presets/finedehalo.json b/vapoursynth/presets/finedehalo.json new file mode 100644 index 0000000..ece96a6 --- /dev/null +++ b/vapoursynth/presets/finedehalo.json @@ -0,0 +1,105 @@ +{ + "id": "finedehalo", + "name": "FineDehalo", + "description": "Reduces dark and bright halos around high-contrast edges. Best for anime and DVD upscales. Powered by vs-jetpack.", + "category": "dehalo", + "supports": { "bitDepth": [8, 10, 12, 16], "hdr": false }, + "levels": ["light", "medium", "heavy"], + "params": [ + { + "key": "rx", + "label": "Horizontal radius", + "type": "int", + "min": 1, + "max": 4, + "step": 1, + "defaults": { "light": 1, "medium": 2, "heavy": 3 }, + "help": "Halo width in pixels. Set as low as possible — the docs note that values too high will start missing small halos." + }, + { + "key": "ry", + "label": "Vertical radius", + "type": "int", + "min": 1, + "max": 4, + "step": 1, + "defaults": { "light": 1, "medium": 2, "heavy": 3 } + }, + { + "key": "darkstr", + "label": "Dark halo strength", + "type": "float", + "min": 0.0, + "max": 1.0, + "step": 0.05, + "defaults": { "light": 0.0, "medium": 0.0, "heavy": 0.4 }, + "help": "0 by default — affecting dark halos often does more damage than people want." + }, + { + "key": "brightstr", + "label": "Bright halo strength", + "type": "float", + "min": 0.0, + "max": 1.0, + "step": 0.05, + "defaults": { "light": 0.6, "medium": 1.0, "heavy": 1.0 } + }, + { + "key": "thmi", + "label": "Edge threshold (min)", + "type": "float", + "min": 0, + "max": 255, + "defaults": { "light": 80, "medium": 80, "heavy": 60 }, + "help": "Minimum sharp-edge threshold. Below this, edges are not considered for dehalo." + }, + { + "key": "thma", + "label": "Edge threshold (max)", + "type": "float", + "min": 0, + "max": 255, + "defaults": { "light": 128, "medium": 128, "heavy": 128 } + }, + { + "key": "lowsens", + "label": "Sensitivity (low)", + "type": "float", + "min": 0.0, + "max": 100.0, + "step": 1.0, + "defaults": { "light": 50.0, "medium": 50.0, "heavy": 40.0 }, + "help": "Below this sensitivity, dehalo is fully applied." + }, + { + "key": "highsens", + "label": "Sensitivity (high)", + "type": "float", + "min": 0.0, + "max": 100.0, + "step": 1.0, + "defaults": { "light": 50.0, "medium": 50.0, "heavy": 60.0 }, + "help": "Above this sensitivity, dehalo is fully skipped." + }, + { + "key": "ss", + "label": "Supersampling", + "type": "float", + "min": 1.0, + "max": 2.0, + "step": 0.05, + "defaults": { "light": 1.25, "medium": 1.5, "heavy": 1.75 }, + "help": "Internal supersampling factor to reduce aliasing. Higher = better quality, slower." + }, + { + "key": "contra", + "label": "Contra-sharpening", + "type": "float", + "min": 0.0, + "max": 2.0, + "step": 0.1, + "defaults": { "light": 0.0, "medium": 0.0, "heavy": 0.5 }, + "help": "Restore some edge contrast lost to dehalo. 0 disables." + } + ] +} diff --git a/vapoursynth/presets/finedehalo.vpy b/vapoursynth/presets/finedehalo.vpy new file mode 100644 index 0000000..9552421 --- /dev/null +++ b/vapoursynth/presets/finedehalo.vpy @@ -0,0 +1,56 @@ +""" +FineDehalo - modern vs-jetpack implementation. + +Reduces dark and bright halos around high-contrast edges. Particularly useful +for anime, DVD upscales, and any source where ringing or oversharpening has +introduced visible halos. + +Backed by `vsdehalo.fine_dehalo` (vs-jetpack). +API reference: https://jaded-encoding-thaumaturgy.github.io/vs-jetpack/api/vsdehalo/ + +Tunables exposed by this preset: + rx - horizontal halo radius (1 - 4) + ry - vertical halo radius (1 - 4) + darkstr - dark halo removal strength (0.0 - 1.0) + brightstr - bright halo removal strength (0.0 - 1.0) + thmi - minimum sharp-edge threshold (0 - 255) + thma - maximum sharp-edge threshold (0 - 255) + lowsens - sensitivity threshold lower bound (0 - 100) + highsens - sensitivity threshold upper bound (0 - 100) + ss - supersampling factor (1.0 - 2.0) - reduces aliasing, higher values are more expensive + contra - contra-sharpening to restore edge contrast (0.0 - 2.0) +""" +import vapoursynth as vs +from vsdehalo import fine_dehalo + +import rabbit_vs + +core = vs.core + +src_path = rabbit_vs.arg_str("SRC") +rx = rabbit_vs.arg_int("rx", 2) +ry = rabbit_vs.arg_int("ry", 2) +darkstr = rabbit_vs.arg_float("darkstr", 0.0) +brightstr = rabbit_vs.arg_float("brightstr", 1.0) +thmi = rabbit_vs.arg_float("thmi", 80.0) +thma = rabbit_vs.arg_float("thma", 128.0) +lowsens = rabbit_vs.arg_float("lowsens", 50.0) +highsens = rabbit_vs.arg_float("highsens", 50.0) +ss = rabbit_vs.arg_float("ss", 1.5) +contra = rabbit_vs.arg_float("contra", 0.0) + +src = rabbit_vs.load_source(src_path) +work = rabbit_vs.to_working_depth(src, 16) + +work = fine_dehalo( + work, + rx=rx, ry=ry, + darkstr=darkstr, brightstr=brightstr, + thmi=thmi, thma=thma, + lowsens=lowsens, highsens=highsens, + ss=ss, + contra=contra, +) + +out = rabbit_vs.match_format(work, src) +out.set_output(0) \ No newline at end of file diff --git a/vapoursynth/presets/knlmeanscl.json-dis b/vapoursynth/presets/knlmeanscl.json-dis new file mode 100644 index 0000000..54ab17e --- /dev/null +++ b/vapoursynth/presets/knlmeanscl.json-dis @@ -0,0 +1,135 @@ +{ + "id": "knlmeanscl", + "name": "KNLMeansCL", + "description": "GPU-accelerated Non-Local Means denoising via OpenCL. Effective on grain, sensor noise, and compression artifacts. Works on SDR and HDR.", + "category": "Denoise", + "supports": { + "bitDepth": [8, 9, 10, 12, 14, 16], + "hdr": true + }, + "levels": ["light", "medium", "heavy"], + "params": [ + { + "key": "h", + "label": "Strength (h)", + "type": "float", + "min": 0.1, + "max": 10.0, + "step": 0.1, + "defaults": { + "light": 0.8, + "medium": 1.2, + "heavy": 2.0 + }, + "help": "Filter strength. Larger values remove more noise but also more detail. The plugin default is 1.2." + }, + { + "key": "d", + "label": "Temporal radius (d)", + "type": "int", + "min": 0, + "max": 4, + "step": 1, + "defaults": { + "light": 1, + "medium": 1, + "heavy": 2 + }, + "help": "Past/future frames used per output frame: total = (2*d+1). Larger usually denoises better but is slower and uses more memory." + }, + { + "key": "a", + "label": "Search window (a)", + "type": "int", + "min": 1, + "max": 5, + "step": 1, + "defaults": { + "light": 2, + "medium": 2, + "heavy": 3 + }, + "help": "Spatial search radius. Each frame is searched in a (2*a+1)^2 px window. Larger = better quality, slower." + }, + { + "key": "s", + "label": "Similarity radius (s)", + "type": "int", + "min": 1, + "max": 5, + "step": 1, + "defaults": { + "light": 4, + "medium": 4, + "heavy": 4 + }, + "help": "Similarity-neighborhood radius: (2*s+1)^2. Performance impact is low — adjust based on noise nature." + }, + { + "key": "channels", + "label": "Channels", + "type": "enum", + "enum": ["auto", "Y", "UV", "YUV", "RGB"], + "defaults": { + "light": "auto", + "medium": "auto", + "heavy": "auto" + }, + "help": "Which channels to denoise. 'auto' = Y for YUV sources, RGB for RGB sources." + }, + { + "key": "wmode", + "label": "Weight mode", + "type": "int", + "min": 0, + "max": 3, + "step": 1, + "defaults": { + "light": 0, + "medium": 0, + "heavy": 0 + }, + "help": "Weighting function. 0 = Welsch (original NLMeans, default). 1/3 = Modified Bisquare (more robust). 2 = Bisquare with hard threshold." + }, + { + "key": "wref", + "label": "Reference weight (wref)", + "type": "float", + "min": 0.0, + "max": 1.0, + "step": 0.05, + "defaults": { + "light": 1.0, + "medium": 1.0, + "heavy": 1.0 + }, + "help": "How much of the original pixel to mix back into the result, relative to the most-similar match found." + }, + { + "key": "device_type", + "label": "OpenCL device type", + "type": "enum", + "enum": ["auto", "gpu", "cpu", "accelerator"], + "defaults": { + "light": "auto", + "medium": "auto", + "heavy": "auto" + }, + "help": "OpenCL device class. 'auto' tries accelerator → GPU → CPU." + }, + { + "key": "device_id", + "label": "OpenCL device ID", + "type": "int", + "min": 0, + "max": 8, + "step": 1, + "defaults": { + "light": 0, + "medium": 0, + "heavy": 0 + }, + "help": "Index of the device of the chosen type (0 = first)." + } + ] +} diff --git a/vapoursynth/presets/knlmeanscl.vpy-dis b/vapoursynth/presets/knlmeanscl.vpy-dis new file mode 100644 index 0000000..08a3991 --- /dev/null +++ b/vapoursynth/presets/knlmeanscl.vpy-dis @@ -0,0 +1,58 @@ +""" +KNLMeansCL - OpenCL-accelerated Non-Local Means denoising. + +Effective on a wide range of noise: film grain, sensor noise, low-bitrate +compression artifacts. Works on SDR and HDR sources, and runs on GPU when +available (much faster than CPU NLMeans). + +Backed by the `knlm.KNLMeansCL` VapourSynth plugin +(https://github.com/Khanattila/KNLMeansCL). + +Tunables exposed by this preset: + h - filter strength; larger removes more noise (and detail) + d - temporal radius; (2*d+1) frames are used per output frame + a - spatial search-window radius; window is (2*a+1)^2 pixels + s - similarity-neighborhood radius; (2*s+1)^2 pixels + channels - which channels to denoise: auto, Y, UV, YUV, RGB + wmode - weighting function (0=Welsch, 1/3=Mod. Bisquare, 2=Bisquare) + wref - amount of original pixel to mix back into the result + device_type - OpenCL device class: auto, gpu, cpu, accelerator + device_id - which device of that type to use (0 = first) +""" +import vapoursynth as vs + +import rabbit_vs + +core = vs.core + +rabbit_vs.check_plugin("knlm", "install via 'vsrepo install knlm'") + +src_path = rabbit_vs.arg_str("SRC") + +h = rabbit_vs.arg_float("h", 1.2) +d = rabbit_vs.arg_int("d", 1) +a = rabbit_vs.arg_int("a", 2) +s = rabbit_vs.arg_int("s", 4) +channels = rabbit_vs.arg_str("channels", "auto") +wmode = rabbit_vs.arg_int("wmode", 0) +wref = rabbit_vs.arg_float("wref", 1.0) +device_type = rabbit_vs.arg_str("device_type", "auto") +device_id = rabbit_vs.arg_int("device_id", 0) + +src = rabbit_vs.load_source(src_path) + +work = core.knlm.KNLMeansCL( + src, + d=d, + a=a, + s=s, + h=h, + channels=channels, + wmode=wmode, + wref=wref, + device_type=device_type, + device_id=device_id, +) + +out = rabbit_vs.match_format(work, src) +out.set_output(0) diff --git a/vapoursynth/rabbit_vs.py b/vapoursynth/rabbit_vs.py new file mode 100644 index 0000000..386dc79 --- /dev/null +++ b/vapoursynth/rabbit_vs.py @@ -0,0 +1,196 @@ +""" +Rabbit Encoder - VapourSynth helper module. + +This module is imported by every preset script and centralizes the boilerplate +that would otherwise be repeated everywhere: argument parsing, source loading, +bit-depth conversion, and frame-property preservation. + +Conventions +----------- +The encoder invokes presets via: + + vspipe -c y4m -a SRC=/path/to/source.mkv -a rx=2.0 -a darkstr=1.0 ... preset.vpy - + +so every parameter arrives as a *string* in the script's `__main__` globals. +The `arg_*` helpers below read those values with a typed cast and a default. + +Output contract +--------------- +Each preset must end with `clip.set_output(0)` where `clip` has the SAME format +(pixel format, bit depth, color family) as the source clip. `match_format()` +makes that easy after high-bit-depth filter work. + +Frame properties carrying color metadata (_Matrix, _Transfer, _Primaries, +_ColorRange) are populated by the source filter and passed through transparently; +the y4m header alone does NOT carry HDR metadata, so the encoder also passes the +probed color tags as ffmpeg muxing flags on the receiving end. +""" + +from __future__ import annotations + +import sys +from typing import Optional, Union + +import vapoursynth as vs + +core = vs.core + +def _raw_arg(name: str) -> Optional[str]: + """ + Read an argument injected by `vspipe -a name=value`. + + In VSPipe R75, the .vpy script executes with __name__ == "__vapoursynth__", + and -a/--arg values are inserted into that script's globals. They are not + present in sys.modules["__main__"], and "__vapoursynth__" may not exist in + sys.modules either. + + So we inspect the caller's globals: edgecleaner.vpy -> rabbit_vs.arg_* -> + _raw_arg(). + """ + import inspect + + frame = inspect.currentframe() + try: + # _raw_arg -> arg_str/arg_int/etc -> preset .vpy + caller = frame.f_back.f_back if frame and frame.f_back else None + if caller is not None and name in caller.f_globals: + return caller.f_globals[name] + + # Fallbacks for interactive/manual usage. + for module_name in ("__main__",): + mod = sys.modules.get(module_name) + if mod is not None and name in mod.__dict__: + return mod.__dict__[name] + + return None + finally: + del frame + + +class MissingArgError(RuntimeError): + """Raised when a required vspipe -a argument is absent.""" + + +def arg_str(name: str, default: Optional[str] = None) -> str: + v = _raw_arg(name) + if v is None: + if default is None: + raise MissingArgError(f"Missing required vspipe arg: {name}") + return default + return str(v) + + +def arg_int(name: str, default: Optional[int] = None) -> int: + v = _raw_arg(name) + if v is None: + if default is None: + raise MissingArgError(f"Missing required vspipe arg: {name}") + return int(default) + return int(float(v)) # tolerate "2.0" strings for ints + + +def arg_float(name: str, default: Optional[float] = None) -> float: + v = _raw_arg(name) + if v is None: + if default is None: + raise MissingArgError(f"Missing required vspipe arg: {name}") + return float(default) + return float(v) + + +def arg_bool(name: str, default: Optional[bool] = None) -> bool: + v = _raw_arg(name) + if v is None: + if default is None: + raise MissingArgError(f"Missing required vspipe arg: {name}") + return bool(default) + return str(v).strip().lower() in ("1", "true", "yes", "on") + + +def load_source(path: str, prefer: str = "ffms2") -> vs.VideoNode: + """ + Load a video file with the best available source filter. + + Order of preference: ffms2 (robust, widely tested) -> lsmas (faster but + occasionally finicky on weird containers). Both populate _Matrix / + _Transfer / _Primaries / _ColorRange frame properties when the source + has them tagged. + """ + have_ffms2 = hasattr(core, "ffms2") + have_lsmas = hasattr(core, "lsmas") + + if prefer == "lsmas" and have_lsmas: + return core.lsmas.LWLibavSource(path) + if have_ffms2: + return core.ffms2.Source(path) + if have_lsmas: + return core.lsmas.LWLibavSource(path) + raise RuntimeError( + "No VapourSynth source filter available (need vapoursynth-ffms2 or vapoursynth-lsmashsource)" + ) + + +def _format_for_depth(clip: vs.VideoNode, bits: int) -> vs.VideoFormat: + """Look up the VS format with the same family/subsampling at a different depth.""" + return core.query_video_format( + clip.format.color_family, + clip.format.sample_type, + bits, + clip.format.subsampling_w, + clip.format.subsampling_h, + ) + + +def to_working_depth(clip: vs.VideoNode, bits: int = 16) -> vs.VideoNode: + """ + Convert to a high bit depth for filter work, preserving family/subsampling. + + Most modern VS filters (FineDehalo, BM3D, dfttest, etc.) want 16-bit input + for clean math; converting back to source depth at the end keeps the + rest of the pipeline happy. + """ + if clip.format.bits_per_sample == bits: + return clip + target = _format_for_depth(clip, bits) + return core.resize.Bicubic(clip, format=target.id) + + +def match_format(clip: vs.VideoNode, source_clip: vs.VideoNode) -> vs.VideoNode: + """ + Convert `clip` back to `source_clip`'s exact format. + + Call this immediately before set_output so downstream FFmpeg receives the + same pixel format it would have seen without VapourSynth in the chain. + """ + if clip.format.id == source_clip.format.id: + return clip + return core.resize.Bicubic(clip, format=source_clip.format.id) + + +def is_hdr(clip: vs.VideoNode) -> bool: + """ + Best-effort HDR detection from frame properties on the first frame. + + Returns True for PQ (transfer 16) or HLG (transfer 18). Only used by + presets that want to gate behavior on HDR - most presets don't need this. + """ + try: + frame = clip.get_frame(0) + transfer = frame.props.get("_Transfer", 0) + return transfer in (16, 18) # SMPTE2084 (PQ), ARIB STD-B67 (HLG) + except Exception: + return False + + +def check_plugin(plugin_attr: str, hint: str = "") -> None: + """ + Fail loudly with a clear message if a required plugin is missing. + + Usage in a preset: + rabbit_vs.check_plugin("knlm", "install vapoursynth-jetpack") + """ + if not hasattr(core, plugin_attr): + msg = f"Required VapourSynth plugin not loaded: core.{plugin_attr}" + if hint: + msg += f" ({hint})" + raise RuntimeError(msg) \ No newline at end of file