Skip to content

armgit / nota

Public Imported from GitHub
0

Nota — a free DAW for macOS, Windows and Linux. No subscription, no account — just open it and make music.

(docs) Update readme

Egor Khindikaynenbe0b6020ce2b
diff --git a/Nota.sln b/Nota.sln
index 850dbea2..5ebeaea8 100644
--- a/Nota.sln
+++ b/Nota.sln
@@ -39,7 +39,6 @@ EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "assets", "assets", "{BCB3042B-3AFA-4988-8B69-8663C3C49020}"
ProjectSection(SolutionItems) = preProject
assets\icons\logo.png = assets\icons\logo.png
- assets\screenshots\screenshot_001.png = assets\screenshots\screenshot_001.png
EndProjectSection
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "solution items", "solution items", "{B3D44776-BD66-4C5B-BDDC-853B9BB27BF0}"
diff --git a/README.md b/README.md
index 102146b1..3cdeda9b 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,7 @@
<img src="https://img.shields.io/badge/platform-macOS%20%7C%20Windows%20%7C%20Linux-D9A13F" alt="Platforms: macOS, Windows, Linux">
</p>
-![Nota — arrangement view with device chain](assets/screenshots/screenshot_001.png)
+![Nota playing a song in the Arrangement view, with the piano roll open below](assets/screenshots/playback.gif)
## Why Nota
@@ -40,6 +40,26 @@
the mixer — over Wi-Fi or USB, nothing to install.
- **Works where you do.** The same app on macOS, Windows and Linux, on Intel/AMD and ARM.
+## Screenshots
+
+<table>
+ <tr>
+ <td width="50%"><img src="assets/screenshots/arrangement.webp" alt="Arrangement view with a song and its device chain"><br><sub><b>Arrangement</b> — the song, with the selected track's devices below</sub></td>
+ <td width="50%"><img src="assets/screenshots/modular.webp" alt="Modular view: LFOs and math nodes patched into effects with cables"><br><sub><b>Modular</b> — patch LFOs and modulators onto any parameter</sub></td>
+ </tr>
+ <tr>
+ <td width="50%"><img src="assets/screenshots/piano-roll.gif" alt="Drawing notes in the piano roll and applying a transform"><br><sub><b>Piano roll</b> — draw, then arpeggiate, strum or ornament in one click</sub></td>
+ <td width="50%"><img src="assets/screenshots/filter.gif" alt="Sweeping the cutoff of Nota Auto Filter over a live spectrum"><br><sub><b>Built-in devices</b> — every one draws what it does to the sound</sub></td>
+ </tr>
+ <tr>
+ <td width="50%"><img src="assets/screenshots/mixer.gif" alt="Mixer with faders and live meters"><br><sub><b>Mixer</b> — faders, sends and live meters</sub></td>
+ <td width="50%"><img src="assets/screenshots/plugin-downloads.webp" alt="Settings → Downloads: a catalogue of open-source plugins to install"><br><sub><b>Downloads</b> — 200+ free open-source plugins, one click to install</sub></td>
+ </tr>
+ <tr>
+ <td colspan="2"><img src="assets/screenshots/arrangement-light.webp" alt="Arrangement view in the light theme"><br><sub>…and a light theme, for daytime sessions.</sub></td>
+ </tr>
+</table>
+
## Features
A quick digest — see [`FEATURES.md`](FEATURES.md) for the full, categorised list.
diff --git a/assets/screenshots/arrangement-light.webp b/assets/screenshots/arrangement-light.webp
new file mode 100644
index 00000000..4e9be941
Binary files /dev/null and b/assets/screenshots/arrangement-light.webp differ
diff --git a/assets/screenshots/arrangement.webp b/assets/screenshots/arrangement.webp
new file mode 100644
index 00000000..75aa0c79
Binary files /dev/null and b/assets/screenshots/arrangement.webp differ
diff --git a/assets/screenshots/filter.gif b/assets/screenshots/filter.gif
new file mode 100644
index 00000000..04671936
Binary files /dev/null and b/assets/screenshots/filter.gif differ
diff --git a/assets/screenshots/mixer.gif b/assets/screenshots/mixer.gif
new file mode 100644
index 00000000..4cc70f74
Binary files /dev/null and b/assets/screenshots/mixer.gif differ
diff --git a/assets/screenshots/mixer.webp b/assets/screenshots/mixer.webp
new file mode 100644
index 00000000..0ddd0933
Binary files /dev/null and b/assets/screenshots/mixer.webp differ
diff --git a/assets/screenshots/modular.webp b/assets/screenshots/modular.webp
new file mode 100644
index 00000000..fcf97a96
Binary files /dev/null and b/assets/screenshots/modular.webp differ
diff --git a/assets/screenshots/piano-roll.gif b/assets/screenshots/piano-roll.gif
new file mode 100644
index 00000000..b45887c0
Binary files /dev/null and b/assets/screenshots/piano-roll.gif differ
diff --git a/assets/screenshots/piano-roll.webp b/assets/screenshots/piano-roll.webp
new file mode 100644
index 00000000..6be3bf40
Binary files /dev/null and b/assets/screenshots/piano-roll.webp differ
diff --git a/assets/screenshots/playback.gif b/assets/screenshots/playback.gif
new file mode 100644
index 00000000..e936f8f5
Binary files /dev/null and b/assets/screenshots/playback.gif differ
diff --git a/assets/screenshots/plugin-downloads.webp b/assets/screenshots/plugin-downloads.webp
new file mode 100644
index 00000000..c0ca6a2d
Binary files /dev/null and b/assets/screenshots/plugin-downloads.webp differ
diff --git a/assets/screenshots/screenshot_001.png b/assets/screenshots/screenshot_001.png
deleted file mode 100644
index e48df23e..00000000
Binary files a/assets/screenshots/screenshot_001.png and /dev/null differ
diff --git a/docs/session-view-requirements.md b/docs/session-view-requirements.md
new file mode 100644
index 00000000..75c438b9
--- /dev/null
+++ b/docs/session-view-requirements.md
@@ -0,0 +1,212 @@
+# Session View — требования
+
+Цель: довести Session View до уровня рабочего инструмента для джема, набросков и живых
+выступлений, ориентируясь на Ableton Live Session View. Документ: сначала что есть сейчас,
+затем требования по приоритетам (P0 → P2) с критериями приёмки, затем порядок работ.
+
+---
+
+## 1. Что реализовано сейчас
+
+**Движок** (`Engine_Session.cpp`, `SessionPlayer.h`, `Engine_Render.cpp`)
+- Сетка «треки × сцены»; у каждого трека вектор `SessionSlot { hasClip, midi, audio, lengthBeats }`.
+- Один `SessionPlayer` на трек: `playing` / `pending`, квантованный запуск и стоп
+ (глобальный `launchQuant`), при запуске клип всегда стартует с 0.
+- Запуск слота и сцены, стоп слота, сцены и всего; пустой слот в сцене останавливает трек.
+- «Session-only jam»: запуск клипа запускает часы, Arrangement при этом не играет;
+ кнопка Back to Arrangement.
+- MIDI-слоты: цикл по `lengthBeats`, MIDI FX работают на часах слота.
+- Аудио-слоты: цикл по сэмплу с исходной скоростью, без варпа; `sourceOffsetFrames`
+ и `lengthFrames` при рендере **не учитываются**.
+- Запись: MIDI — только овердаб в слот (пустой слот сначала превращается в клип на 4 доли);
+ аудио — запись входа в слот.
+- Перенос: слот → Arrangement (только MIDI, вставка в позицию плейхеда);
+ Arrangement → слот (MIDI и аудио; у аудио берётся весь сэмпл, обрезка клипа теряется).
+- Сцены: добавить в конец, удалить; минимум одна сцена.
+
+**UI** (`SessionView.cs`, `SessionAudioSlotEditor.cs`)
+- Рельс сцен с кнопками запуска и стопа, колонки треков, колонка Master, мини-микшер
+ (pan / sends / volume / M-S-Arm / метр), кнопки Stop All и + Scene.
+- Состояния слота: пусто / заполнен / в очереди (мигает) / играет / запись; полоска прогресса.
+- Клик запускает клип; двойной клик открывает редактор (piano roll или аудио-редактор:
+ длина и gain); клик по пустому слоту создаёт MIDI-клип на 4 доли; ПКМ — длина цикла
+ 1–16 долей, копирование в Arrangement, удаление; drag & drop из браузера и Finder.
+- Follow actions — заглушка с бейджем N/A.
+
+**Сохранение, MCP, Remote**: слоты (ноты и аудио) и число сцен сохраняются в проекте.
+У MCP есть инструменты запуска, стопа, записи, нот и длины. Remote умеет запускать
+слот и сцену и делать Stop All.
+
+### Замеченные дефекты и пробелы
+1. В заголовке колонки написано `Inst 7` / `Audio 3` вместо имени трека; цвет назначается
+ по счётчику колонок, а не берётся из цвета трека.
+2. На каждом клипе написано просто «Clip»: у клипов нет имён, цвета и превью нот или волны.
+3. Полоска прогресса считается как `globalPos % len`, а не от локальных часов слота. Если
+ клип длиннее шага квантования, полоска расходится с реальной позицией.
+4. Аудио-слоты не варпаются: после смены темпа луп рассинхронизируется с сеткой (обрезается
+ или оставляет тишину). Trim из Arrangement теряется.
+5. Слот → Arrangement работает только для MIDI.
+6. Групповые треки в сетке не отображаются, групповой запуск и стоп невозможны.
+7. Сцены нельзя назвать, вставить в середину, дублировать или переставить.
+8. Нет выделения, копирования, вставки, дублирования, перетаскивания слотов и навигации
+ с клавиатуры.
+9. Запись в слот не задаёт длину по факту записи: всегда 4 доли плюс овердаб.
+
+---
+
+## 2. Требования
+
+Обозначения: **[E]** движок (C++ и C ABI), **[I]** interop/`IAudioEngine`, **[P]** формат проекта,
+**[U]** UI, **[M]** MCP, **[R]** Remote. Каждое изменение слота или сцены — один шаг undo.
+
+### P0 — базовая полноценность (без этого Session бесполезен для работы)
+
+**S-01. Идентичность трека в колонке** [U]
+- В заголовке колонки — имя трека и его цвет (тот же, что в Arrangement и Mixer).
+- Клик по заголовку выбирает трек (девайсы внизу, синхронизация выбора с Arrangement);
+ двойной клик — переименование.
+- Приёмка: после переименования или перекраски в Arrangement колонка показывает то же самое.
+
+**S-02. Свойства клипа: имя, цвет, превью** [E][I][P][U]
+- У слота есть `name` и `color` (по умолчанию — цвет трека); редактирование через ПКМ
+ и через F2 / ⌘R.
+- В ячейке: имя, мини-превью нот (MIDI) или волны (аудио), длина в тактах (`2 bars`, а не `8b`).
+- Приёмка: имя и цвет переживают save/load и копирование в Arrangement и обратно.
+
+**S-03. Корректный прогресс и позиция клипа** [E][I][U]
+- Движок отдаёт локальную позицию играющего слота (`nota_session_slot_position`).
+- Прогресс в UI берётся из неё; в ячейке играющего клипа видно положение внутри цикла
+ (прогресс-бар или «пирог» как в Live).
+- Приёмка: клип на 4 такта, запущенный с квантом 1 такт на 3-м такте, показывает 0% в момент старта.
+
+**S-04. Редактирование сетки** [E][I][U]
+- Выделение слота кликом по краю или с модификатором (выделение отделено от запуска);
+ прямоугольное выделение; стрелки двигают выделение; Enter запускает выделенный слот.
+- ⌘C / ⌘V / ⌘D / Delete / ⌘X для слотов и диапазонов; drag слота в другой слот
+ (Alt+drag — копия); перенос между треками совместимого типа.
+- Drag слота на Arrangement и клипа Arrangement на слот (в дополнение к пунктам меню).
+- Приёмка: всё это — один шаг undo; горячие клавиши добавлены в Preferences → Shortcuts.
+
+**S-05. Сцены как сущность** [E][I][P][U]
+- Имя сцены (двойной клик), вставка сцены ниже выбранной (⌘I), дублирование сцены (⌘D
+ на сцене копирует все её слоты), перестановка drag-ом, удаление.
+- «Capture and Insert Scene»: создать новую сцену из играющих сейчас клипов.
+- Приёмка: удаление или вставка сцены не останавливает клипы на других сценах:
+ `playing` и `pending` переиндексируются, а не сбрасываются.
+
+**S-06. Аудио-слоты с варпом** [E][P][U]
+- Аудио-слот использует ту же модель, что клип Arrangement: start offset, length, warp
+ (тот же алгоритм и те же маркеры), transpose, gain.
+- При смене темпа луп остаётся синхронным с сеткой.
+- Arrangement → слот сохраняет обрезку и варп клипа; слот → Arrangement работает для аудио.
+- Редактор аудио-слота — тот же клип-редактор, что у Arrangement (а не отдельный урезанный).
+- Приёмка: луп на 120 BPM, проект переключён на 90 BPM — луп остаётся 1 такт и попадает в сетку.
+
+**S-07. Запись клипа «как в Live»** [E][I][U]
+- Запись в пустой слот длится, пока её не остановят. Длина при остановке округляется
+ до ближайшего такта (по кванту запуска), затем клип зацикливается.
+- Опция *Fixed Length* (1, 2, 4, 8 тактов) в тулбаре Session: запись останавливается сама
+ и клип продолжает играть.
+- Начало записи квантуется по launch quant; счёт-ин учитывается.
+- Овердаб — только для слота, который уже содержит клип (через Session Record).
+ Record quantize для MIDI — опция.
+- Кнопка **Session Record** в тулбаре: записывает в выбранную сцену на всех armed-треках.
+- Приёмка: запись 3 тактов без Fixed Length даёт клип длиной 3 такта, который сразу играет.
+
+**S-08. Групповые треки** [U][E]
+- Колонка группы показывает в каждой сцене «групповой слот»: он подсвечивается, если в
+ группе играет что-то из этой сцены, и по клику запускает все слоты детей в этой сцене.
+- Стоп-кнопка группы останавливает всех детей; групповую колонку можно свернуть, как в Arrangement.
+
+### P1 — производительность и live
+
+**S-10. Свойства запуска клипа** [E][I][P][U]
+- Launch mode: *Trigger* (по умолчанию), *Gate*, *Toggle*, *Repeat*.
+- Per-clip quantize (Global / None / 1/16 … 8 bars), переопределяет глобальный.
+- *Legato*: новый клип стартует с позиции предыдущего на этом треке, а не с 0.
+- Velocity amount: громкость запуска зависит от velocity MIDI-ноты, которой запустили клип.
+- Loop on/off: незацикленный клип играет один раз и останавливается.
+- Loop start/end и start marker отдельно от длины клипа.
+
+**S-11. Follow actions** [E][P][U]
+- Две действия A/B с вероятностями; время срабатывания (такты:доли); действия:
+ Stop, Again, Previous, Next, First, Last, Any, Other, Jump (к слоту N).
+- Follow actions для сцен (scene follow action: «следующая сцена через N тактов»).
+- Глобальный тумблер включения follow actions (как в Live 11+).
+- Заглушка «Follow actions N/A» в тулбаре заменяется на этот тумблер.
+
+**S-12. Свойства сцены** [E][P][U]
+- Темп и размер в сцене: при запуске сцены они применяются по кванту.
+- Цвет сцены; кнопка запуска сцены показывает, что сцена играет.
+- Опция «Select next scene on launch» (в настройках), чтобы проходить сцены одной клавишей.
+
+**S-13. Запись Session-выступления в Arrangement** [E][U]
+- Arrangement Record во время джема записывает запуски клипов в таймлайн как клипы
+ (как Live при Arrangement Record + Session).
+- Подсветка «Back to Arrangement» уже есть: нужно ещё помечать каждый трек, который
+ перекрыт сессией (в Arrangement и в Session), и давать вернуть отдельный трек.
+
+**S-14. Управление с контроллеров и клавиатуры** [U][R]
+- MIDI Learn для слотов, сцен, стоп-кнопок трека, Stop All, Session Record и навигации по сценам.
+- Красная рамка («session ring») показывает, какой участок сетки сейчас видит
+ подключённый контроллер.
+- Клавиатурные действия: запуск выбранной сцены, следующая/предыдущая сцена, стоп трека.
+- Remote: сетка с именами и цветами клипов, состояния и прогресс, стоп трека, имена сцен.
+
+**S-15. Мини-микшер и маршрутизация в Session** [U]
+- Show/hide секций (I/O, sends, mixer, crossfader) как в Live.
+- Секция I/O: вход трека, monitor (In/Auto/Off), выход.
+- Колонки return-треков (с микшером, без слотов) и master с громкостью и cue.
+- Crossfader с назначением треков A/B (P2, если кроссфейдера ещё нет в микшере).
+
+**S-16. Стоп-кнопки слотов** [E][P][U]
+- В пустом слоте можно убрать стоп-кнопку (Remove Stop Button): тогда запуск сцены
+ не останавливает этот трек. Это нужно, чтобы держать бочку, пока сцены переключаются.
+
+### P2 — паритет и полировка
+
+- **S-20. Клип-огибающие и модуляция в слотах**: огибающие громкости, pan и параметров
+ девайсов внутри клипа, зацикленные вместе с клипом (unlinked-длина — опционально).
+- **S-21. Capture MIDI**: кнопка, которая превращает сыгранное без записи в клип
+ в выбранном слоте (буфер последних N тактов armed-трека).
+- **S-22. Consolidate / Crop / Duplicate loop** для слота (удвоение длины с копией нот).
+- **S-23. Freeze/Flatten в Session**: замороженный трек играет слоты как аудио.
+- **S-24. Отдельный Arrangement ↔ Session «Tab view»** (переключение одной клавишей, как Tab в Live)
+ с сохранением выделения трека.
+- **S-25. Zoom сетки**: высота слотов и ширина колонок (компакт / норма), «сворачивание»
+ треков до узкой колонки.
+- **S-26. Scale/Key у клипа** (связка с Project key): транспонирование клипа при запуске.
+- **S-27. MPE/CC в слотах**, если в piano roll есть CC-лейны.
+
+---
+
+## 3. Нефункциональные требования
+
+- **Realtime**: все запуски и стопы — через атомики и lock-free очереди, как сейчас;
+ в аудиопотоке нет аллокаций. Состояние «сколько играет и где» читается без блокировок.
+- **Точность**: запуск по кванту попадает в сэмпл; переход клипа внутри блока
+ (а не на границе блока) — сэмплово точный, без щелчков: хвосты нот отпускаются
+ через noteOff, аудио — через короткий фейд (≤ 5 мс).
+- **Масштаб**: 32 трека × 128 сцен без заметных лагов UI. Ячейки должны
+ виртуализироваться или перерисовываться адресно, а не через `Refresh()` всей сетки.
+- **Undo**: каждое структурное изменение — один шаг; запуск и стоп клипа в undo не попадают.
+- **Формат проекта**: новые поля добавляются через версионирование DTO
+ (`[JsonExtensionData]` уже есть); старые проекты открываются без потерь.
+- **Дизайн**: Ember (skill `nota-design`), состояния в цветах almanac (playing — success,
+ queued — warning с миганием, recording — record red).
+- **MCP / Remote** получают те же возможности, что и UI (имена, цвета, свойства запуска,
+ сцены, follow actions), иначе ИИ-сценарии отстанут.
+
+---
+
+## 4. Предлагаемый порядок работ
+
+1. **Быстрые исправления** — S-01, прогресс из S-03, аудио слот → Arrangement из S-06.
+2. **Модель слота** — S-02 (имя, цвет), S-10 (свойства запуска) и переход аудио-слотов
+ на модель клипа Arrangement (S-06). Это одна миграция формата и движка, поэтому её
+ лучше делать одним этапом.
+3. **Редактирование сетки и сцены** — S-04, S-05, S-16.
+4. **Запись** — S-07, затем S-13.
+5. **Групповые треки** — S-08.
+6. **Live-слой** — S-11, S-12, S-14.
+7. **Микшер** — S-15, затем P2.