# Audion VS Engine — руководство

[English](USER_GUIDE_EN.md) · [О программе](README_RU.md) · [Консольная команда](CLI_RU.md) · [Пресеты](tools/VapourWiki_RU.md) · [Каждое поле](OPERATIONS_RU.md)

**Содержание**

- [Запуск](#запуск)
- [Дополнительные компоненты](#дополнительные-компоненты)
- [Окно](#окно)
- [Пути](#пути)
- [Форма пресета](#форма-пресета)
- [Превью](#превью)
- [Прогон](#прогон)
- [Профили](#профили)
- [СЕРВИС](#сервис)
- [SETTINGS и ABOUT](#settings-и-about)
- [Командная строка под журналом](#командная-строка-под-журналом)
- [Меню на FZF](#меню-на-fzf)
- [Если что-то не так](#если-что-то-не-так)

## Запуск

`Start.exe` в папке программы открывает окно. Папку можно положить на любой диск и скопировать на другую машину: всё нужное
программе лежит в ней, в Windows ничего не ставится. Второй `Start.exe` выводит вперёд уже открытое окно, а не открывает
новое.

## Дополнительные компоненты

Движок обработки не входит в программу: у VapourSynth, его плагинов, FFmpeg и, при видеокарте NVIDIA RTX, MLRT свои
лицензии, и они ставятся отдельно, с сайтов авторов, в папку программы — `system_core\vapoursynth\` и `Tools\ffmpeg\`;
в Windows ничего не пишется.

- **При каждом запуске**, пока какой-то из них не установлен, окно спрашивает: **«Установка дополнительных компонентов»**
  — каждый компонент с тем, для чего он и что будет скачано (файлы, размер), и общий объём. **УСТАНОВИТЬ** ставит их по
  порядку — VapourSynth, плагины, FFmpeg, MLRT; ход виден в терминале справа. Галочка **«Установить позже»** говорит, где
  их найти: кнопка **SETUP** в шапке; **ПОНЯТНО** закрывает вопрос. **ОТКРЫТЬ SETUP** закрывает вопрос и сразу
  открывает лист SETUP.
- **SETUP** в шапке, отдельно от кнопок самого окна, открывает лист компонентов: у каждого версия, состояние и
  **УСТАНОВИТЬ** или **ОБНОВИТЬ**; **УСТАНОВИТЬ ВСЁ** ставит по порядку всё, чего ещё нет; **ПРОВЕРИТЬ СЕЙЧАС** спрашивает
  GitHub о новом VapourSynth (сама программа — не чаще раза в сутки). Красная точка на SETUP — какой-то компонент не
  установлен. Там же — машина: процессор, видеокарта, память, кодеры FFmpeg, диск программы — и **СКОПИРОВАТЬ**, чтобы
  приложить их к сообщению о проблеме, а ещё **«Удалить VapourSynth»**: движок с плагинами и MLRT — в Корзину, спросив
  перед этим.
- Пока движка нет, страница пресета вместо формы показывает установщики в том же порядке.

**MLRT.** Если программа нашла видеокарту NVIDIA RTX, в РЕСТАВРАЦИИ стоят нейросетевые пресеты — DPIR, Real-ESRGAN 2x,
пересборка мягкого HD 2x, — а MLRT среди компонентов (около 3,5 ГБ под эту карту); пока он не установлен, их
страница показывает карточку MLRT с планом закачки. Без карты RTX этих пресетов в окне нет. Первый прогон каждой модели
собирает её движок TensorRT 30–120 с, дальше прогоны начинаются сразу.

## Окно

- **Шапка** — имя и версия; бейджи движка: VapourSynth, плагины (сколько из набора загружает движок), MLRT при карте RTX,
  FFmpeg, драйвер видеокарты. Зелёная точка — свежая версия, оранжевая — вышла новее; что именно — в подсказке. Справа:
  **СЕРВИС** и **SETUP**, за ними кнопки самого окна — язык RU / EN, тема, **SETTINGS**, **ABOUT**.
- **Палитры** — ТОЧНОСТЬ, ПЛЁНКА, РЕТРО, РЕСТАВРАЦИЯ, ПРОФИЛИ — крупные кнопки со строкой «для чего».
- **Пресеты палитры** — группами по виду обработки: подпись и её переключатели. ТОЧНОСТЬ: Шумодав · Дебанд · Мастер;
  ПЛЁНКА: Плёнка · Образ; РЕТРО: Видео · Фото; РЕСТАВРАЦИЯ: Чересстрочность · Шум · Артефакты · Масштаб · Движение. На
  переключателе — короткое имя; полное и что делает пресет — в подсказке и над формой.
- **Слева** — страница пресета: имя, **СОХРАНИТЬ ПРОФИЛЬ**, **КОМАНДА**, **ЗАПУСТИТЬ**, «к умолчаниям»; под ними строка о
  том, что делает пресет, форма, а внизу — превью.
- **Справа** — пути (ИСТОЧНИК, НАЗНАЧЕНИЕ и их кнопки), журнал, командная строка.
- **Внизу** — строка состояния, полоса хода, часы и **СТОП**, пока идёт прогон.

Границу между левой и правой частью можно двигать, ширина запоминается. Кнопка **«развернуть»** у журнала отдаёт ему всё
окно и возвращает обратно.

## Пути

- **ИСТОЧНИК** — что обрабатывать: папка (все видео в ней и в её подпапках) или один файл. Путь вписывают, выбирают (папка,
  **«Добавить файл…»**), берут из истории или перетаскивают в окно. Пустое поле — папка `input\` программы.
- **НАЗНАЧЕНИЕ** — куда кладётся результат; пустое — `output\`.
- У каждого поля: выбрать, история (закреплённые первыми), закрепить, открыть в Проводнике.
- Окно открывается на `input\` и `output\`; путь прошлого раза возвращается, только если он закреплён.
- **СБРОСИТЬ** — оба пути обратно на `input\` и `output\`; история очищается, закреплённые остаются; файлы не трогаются.
- **СПИСОК** — видео Источника, которые возьмёт прогон, с их папками, в журнале.
- **СВЕДЕНИЯ** — что ffprobe знает о каждом видео Источника: размер, частота, длина, кодек, диапазон, цвет.
- **В ИСТОЧНИК** — результат становится Источником следующей операции: Источник очищается в Корзину, затем содержимое
  Назначения переносится в него. Окно спрашивает и называет обе папки.
- **ОЧИСТИТЬ** — содержимое Источника, Назначения или обоих — в Корзину; сами папки остаются. Окно спрашивает.

## Форма пресета

- **ПАРАМЕТРЫ** — поля пресета. Число — ползунок и его значение рядом: тянуть ползунок или вписать значение и нажать Enter;
  стрелки клавиатуры шагают. Выбор — ряд переключателей. Подсказка каждого поля говорит, что оно делает и его диапазон.
- **ОБРАБОТКА** — где идёт тяжёлая часть: **Авто**, **Процессор**, **Видеокарта**. Блок стоит только у пресетов, где он
  что-то меняет: BM3D (Шумодав теней SOTA, Плёночная пересборка — Vulkan на видеокарте любого производителя, иначе
  процессор) и нейросетевые (TensorRT на RTX, DirectML на другой карте или процессор).
- **КОДИРОВАНИЕ** — четыре карточки: x264, x265, ProRes, DNxHR. Выбранная карточка подсвечена окантовкой; внутри — кодер
  (процессор, NVIDIA, QuickSync, AMF), качество 14 / 17 / 21, контейнер, либо профиль и обёртка ProRes, профиль DNxHR.
  Аппаратный кодер, который эта машина не прошла, серый, причина — в подсказке.
- **ЗАПУСК** — **«Перезаписать»**: сделать результат заново, даже если он уже есть.

Что стояло на странице, запоминается до следующего запуска; «к умолчаниям» возвращает её. ОБРАБОТКА и карточки кодера —
одни на всё окно: заданные на одной странице, они заданы на всех.

## Превью

Под формой — кадр из середины видео Источника до и после пресета со значениями формы.

- **До** — кадр исходника, как его загружают пресеты; **После** — с пресетом; **Рядом** — оба.
- **‹ 1 / 5 ›** — видео Источника по очереди.
- Считается само примерно через секунду после последнего изменения формы, страницы или Источника; ставший ненужным
  расчёт гасится. Кнопка «посчитать снова» считает сейчас; «свернуть» отдаёт всё место форме.
- Под кнопками: размер и частота исходника, номер кадра; размер результата, если пресет его меняет (пресеты 2x);
  у шумодава — измеренный шум и выбранная сила.
- Если форма выше места над превью, прокручивается форма, а превью стоит на месте.

## Прогон

1. Выберите палитру и пресет, настройте форму, посмотрите превью.
2. **КОМАНДА** — команды vspipe и FFmpeg, которые запустит прогон, для каждого файла Источника, в журнал; ничего не
   запускается.
3. **ЗАПУСТИТЬ** — пресет проходит по всем видео Источника. Первая строка журнала — тот же прогон командой `vs_cli.cmd`.
   Под журналом живая строка: доля, сделанные кадры и их число, скорость, остаток времени, файл; полоса внизу — весь
   прогон.
4. **СТОП** — vspipe и FFmpeg гаснут, недописанный файл удаляется, готовые остаются. Повторное нажатие через несколько
   секунд завершает прогон сразу. Закрытие окна во время прогона сначала спрашивает, потом останавливает его так же.

Куда ложится результат: `<Назначение>\<Палитра>\<пресет>_<кодер>\<папки Источника>\<имя>.<расш>`, имя исходника
сохраняется — например `output\Precision\mild_denoise_h264_crf14\clip.mp4`. Готовый результат пропускается (`[SKIP]` в
журнале), если не включено «Перезаписать», так что остановленный прогон просто запускают снова. Журнал прогона — в `logs\`,
отчёт — в `report\`; **LOGS** и **REPORT** над журналом открывают их.

Прогон получает отказ до начала, если начаться не может — нет движка, нет видео в Источнике, нейросетевой пресет без MLRT;
причина — в журнале, ничего не пишется.

## Профили

Профиль — пресет со значениями и кодером, сохранённый под именем.

- **СОХРАНИТЬ ПРОФИЛЬ** на странице пресета спрашивает имя (латинские буквы, цифры, `-`, `_`) и сохраняет пресет со
  значениями страницы и кодером карточек в `config\profiles\<имя>.json`.
- **ПРОФИЛИ → «Запустить профиль»**: выберите профиль — его кодер встаёт на карточки — и **ЗАПУСТИТЬ**. Результаты ложатся в
  `<Назначение>\Profiles\<профиль>_<кодер>\`.

С программой приходят пять профилей: `shadow_clean_quick`, `filmic_warm_35mm`, `archival_master`, `resolve_handoff`,
`vhs_dreamy`.

## СЕРВИС

| Пункт | Что делает |
|---|---|
| Доктор | проверяет весь движок: оба Python, VapourSynth, каждый плагин, FFmpeg, BM3D на видеокарте |
| Список файлов | видео Источника, которые возьмёт следующий прогон |
| Возможности оборудования | короткие кодирования через NVENC, QuickSync и AMF: какие аппаратные кодеры работают на этой машине |
| Проверка всех пресетов | каждый пресет на тестовом ролике по кадру: что здесь работает и как быстро |
| BM3D: видеокарта или процессор | BM3D через Vulkan против BM3D на процессоре на первом видео Источника |

Компоненты ставит **SETUP** (выше).

## SETTINGS и ABOUT

- **SETTINGS** — вид окна: тема (Audion Code Dark, Audion Vault Dark, Audion Dark, Audion Light), шрифты и их размеры
  (**К УМОЛЧАНИЯМ** возвращает их).
- **ABOUT** — версия, папки программы, из чего она состоит и под какими лицензиями.

## Командная строка под журналом

**PS** — PowerShell 7 программы (`App\AudionPs.exe`), **CMD** — cmd.exe. Enter запускает команду; её строки идут в журнал,
СТОП её завершает. История хранит команды, закреплённые первыми; кнопки файла и папки дописывают путь.

## Меню на FZF

Та же работа без окна — в консоли с быстрым выбором:

- `launcher_project.cmd` / `launcher_project_ru.cmd` — палитры, профили, инструменты;
- `cli\launcher_<палитра>.cmd` / `_ru.cmd` — пресеты палитры: вопросы пресета, затем `vs_cli.cmd run`;
- `launcher_tools.cmd` — проверки;
- `builder_main.cmd` — установщики движка, MLRT, чистка кэша установки, доктор.

## Если что-то не так

- **Вместо формы — установщики** — нет движка: поставьте его сверху вниз.
- **Нейросетевого пресета нет в РЕСТАВРАЦИИ** — программа не нашла видеокарту NVIDIA RTX, и MLRT не установлен.
- **«отказ до начала»** — причину называет строка `[PREFLIGHT] FAIL` в журнале: нет видео в Источнике, нет движка, нет MLRT,
  обратный телесин на источнике меньше 29 к/с, RAW камер.
- **RAW камер** (ProRes RAW, ARRIRAW, Sony RAW и X-OCN, RED R3D, Nikon N-RAW, Blackmagic RAW, Canon Cinema RAW) — движок
  его не читает: VapourSynth не видит в нём картинки. Строка называет программу, которая его открывает, и её страницу:
  переведите его там в ProRes 4444 или DNxHR 444 и запустите пресет на результате. Источник только из RAW получает
  отказ до начала; среди других видео такие файлы проваливаются по одному с этой строкой, остальные делаются. Окно
  называет такие файлы один раз, отдельным окном, когда Источник выбран, и не показывает их в превью. Таблица программ — в [README](README_RU.md).
- **Кодер серый** — эта машина его не прошла: СЕРВИС → «Возможности оборудования» проверит снова.
- **Превью пишет, что не посчиталось** — дальше идёт причина; та же причина остановит и прогон, её стоит прочитать.
- **Папку перенесли** — следующий запуск программы сам чинит запускатели своих Python.
- **Доктор** в СЕРВИСЕ говорит о состоянии всего стека.
