refactor(capture): expose offline tail as docked-panel toggle

Replace the ...-with-tail variant actions with a pure tail_control module +
a docked-panel footer toggle (Off/Auto/Manual) read by CAPTURE_ITEM/TRACK.
Default None (byte-identical); Manual fixed 2s, in-memory session lifetime.
Tail mechanism unchanged; retired the variant ids.
This commit is contained in:
2026-07-23 17:32:19 -04:00
parent 2d225258b4
commit 9a9339b90b
11 changed files with 363 additions and 90 deletions
+98 -5
View File
@@ -42,6 +42,7 @@
#include "mode_switch.h"
#include "peaks.h"
#include "persist.h"
#include "tail_control.h" // TailSetting, cycleTailMode, tailToggleLabel (pure)
#include "view.h" // applyMode — the D2/D4 mode-activation entrypoint the switch fires
// SWELL / LICE. On macOS/Linux SWELL is provided by the host (SWELL_PROVIDED_BY_APP);
@@ -134,6 +135,20 @@ const LICE_pixel kColSegBorder = LICE_RGBA(70, 70, 76, 255); // segment di
const COLORREF kRgbSegText = RGB(170, 170, 176); // inactive label
const COLORREF kRgbSegActiveText = RGB(220, 235, 228); // active label
// --- Tail-mode footer (T1 exposure) -------------------------------------------
// A fixed-height strip at the BOTTOM of the client area holding the tail-mode
// toggle ("Tail: Off / Auto / Manual"). Clicking anywhere in it cycles the mode
// (None -> Auto -> Manual -> None). Display/settings only: it mutates the panel's
// in-memory tail setting the plain capture actions read — NEVER the project/bank/
// arrange. The cycle/label logic is the pure tail_control module; only the draw +
// click routing is here. The grid viewport is shortened by this strip's height so
// cells never draw under it.
constexpr int kFooterHeight = 26; // px; fixed strip at the bottom
const LICE_pixel kColFooterBg = LICE_RGBA(20, 20, 22, 255); // footer strip fill
const LICE_pixel kColFooterBorder = LICE_RGBA(70, 70, 76, 255); // top divider
const COLORREF kRgbFooterText = RGB(190, 205, 198); // toggle label
// --- Panel state --------------------------------------------------------------
// A computed thumbnail: the per-channel envelope at a known width. Held in the
@@ -173,6 +188,12 @@ struct PanelState {
// clear the selection rather than risk indices pointing past the new count.
int selItemCount = 0;
// --- Tail-mode toggle (T1 exposure) ---------------------------------------
// The current tail setting the plain capture actions read (bankPanelTailSetting).
// Default None (exact bounds). In-memory only — resets on panel teardown; project
// persistence is a noted follow-on. Mutated ONLY by a click in the footer strip.
TailSetting tail;
// --- Audition preview (Wave B) --------------------------------------------
//
// The stock preview register we hand to PlayPreview/StopPreview. Its cs/mutex
@@ -424,6 +445,45 @@ void drawModeSwitch(LICE_IBitmap* bmp, int w) {
}
}
// The tail-toggle footer rect for a client of width `w` and height `h`: the
// full-width strip of fixed height pinned to the BOTTOM. A RECT (not HeaderRect)
// since the whole strip is one hit target — a click anywhere in it cycles the mode.
// Shared by paint and click routing so both agree on the band. Degenerate (empty)
// when the client is too short to host it above the header.
RECT panelFooter(int w, int h) {
RECT rc{};
rc.left = 0;
rc.right = w;
rc.top = h - kFooterHeight;
rc.bottom = h;
// Clamp so the footer never rides up into (or above) the header band on a very
// short panel — it collapses to empty rather than overlapping the mode switch.
if (rc.top < kHeaderHeight) rc.top = rc.bottom; // empty: top == bottom
return rc;
}
// Draws the tail-mode toggle into the footer strip: a filled band, a top divider,
// and the current mode's label ("Tail: Off / Auto / Manual") from the pure
// tail_control module. READ-ONLY: reads g_panel.tail; the click handler mutates it.
void drawTailFooter(LICE_IBitmap* bmp, int w, int h) {
const RECT f = panelFooter(w, h);
if (f.top >= f.bottom) return; // no room — skip (short panel)
LICE_FillRect(bmp, f.left, f.top, w, kFooterHeight, kColFooterBg, 1.0f, 0);
// Top divider so the strip reads as distinct from the grid above it.
LICE_Line(bmp, f.left, f.top, f.right, f.top, kColFooterBorder, 1.0f, 0, false);
HDC dc = bmp->getDC();
if (!dc) return;
const std::string label = tailToggleLabel(g_panel.tail);
RECT rc = f;
rc.left += 8; // small left pad so the label is not flush against the edge
SetTextColor(dc, kRgbFooterText);
SetBkMode(dc, TRANSPARENT);
DrawText(dc, label.c_str(), -1, &rc,
DT_LEFT | DT_VCENTER | DT_SINGLELINE | DT_END_ELLIPSIS);
}
// The cell rects for the panel's CURRENT client width and bank size, translated
// DOWN by the header height so the grid sits below the mode switch. Both paint and
// mouse hit-testing call this so they share identical geometry (no drift between
@@ -469,11 +529,15 @@ void paintPanel(HWND hwnd, HDC hdc) {
// Draw each cell's thumbnail. Inner drawable width == cell width - inset;
// compute the envelope at the cell's inner column count so bins map 1:1.
const int binWidth = kGrid.cellWidth - 4;
// Cells must not draw under the footer strip: the visible grid stops at the
// footer top (or the client bottom when the panel is too short for a footer).
const RECT footer = panelFooter(w, h);
const int gridBottom = footer.top < footer.bottom ? footer.top : h;
for (std::size_t i = 0; i < rects.size(); ++i) {
const CellRect& rect = rects[i];
// Skip cells entirely below the viewport (Wave A has no scroll; this
// just avoids computing thumbnails that cannot be seen).
if (rect.y >= h) continue;
// Skip cells entirely below the visible grid area (Wave A has no scroll;
// this just avoids computing thumbnails that cannot be seen).
if (rect.y >= gridBottom) continue;
const int idx = static_cast<int>(i);
const bool selected = g_panel.selection.contains(idx);
const bool focused = g_panel.selection.focus == idx;
@@ -482,9 +546,10 @@ void paintPanel(HWND hwnd, HDC hdc) {
}
}
// The mode switch draws LAST so its header band overlays the top of the grid /
// empty-state area regardless of which branch ran above.
// The mode switch and tail footer draw LAST so their bands overlay the top/bottom
// of the grid / empty-state area regardless of which branch ran above.
drawModeSwitch(&bmp, w);
drawTailFooter(&bmp, w, h);
BitBlt(hdc, 0, 0, w, h, bmp.getDC(), 0, 0, SRCCOPY);
}
@@ -675,6 +740,23 @@ void handleClick(int x, int y) {
}
}
// Tail-mode footer: a click anywhere in the bottom strip cycles the tail mode
// (None -> Auto -> Manual -> None) and repaints. Settings-only — it mutates the
// panel's in-memory tail setting the capture actions read, and NOTHING in the
// project/bank/arrange. Checked before the grid so a footer click never selects.
{
RECT cr{};
GetClientRect(g_panel.hwnd, &cr);
const int w = cr.right - cr.left;
const int h = cr.bottom - cr.top;
const RECT f = panelFooter(w, h);
if (f.top < f.bottom && x >= f.left && x < f.right && y >= f.top && y < f.bottom) {
g_panel.tail.mode = cycleTailMode(g_panel.tail.mode);
invalidatePanel();
return; // footer click consumed; do NOT fall through to grid selection
}
}
const std::vector<CellRect> rects = panelRects();
const int hit = hitTestCell(x, y, rects);
const int count = bankItemCount();
@@ -906,6 +988,17 @@ void bankPanelRefresh() {
InvalidateRect(g_panel.hwnd, nullptr, FALSE);
}
TailSetting bankPanelTailSetting() {
// In-memory for the extension's lifetime (g_panel is static): the toggle's mode
// survives panel open/close and bank changes, and resets to the default None only
// on extension unload. Persistence across project reload is a noted follow-on.
// manualMs is clamped here so a caller always receives a within-cap length, even
// if a future fine-adjust UI stored an over-cap value.
TailSetting s = g_panel.tail;
s.manualMs = clampManualMs(s.manualMs);
return s;
}
void bankPanelShutdown() {
closePanel(); // stops audition + destroys the window
deinitPreview(); // destroy the preview lock (after the last stop)
+13
View File
@@ -13,6 +13,8 @@
#include <string>
#include <vector>
#include "tail_control.h" // TailSetting — the panel's tail-mode toggle state
namespace reasampler {
class ReaSamplerSession;
@@ -48,6 +50,17 @@ std::vector<std::string> bankPanelSelectedSampleIds();
// reflected without the panel diffing the bank itself.
void bankPanelRefresh();
// The panel's current tail-mode setting (mode + Manual length), read by the plain
// CAPTURE_ITEM / CAPTURE_TRACK actions when building a CaptureRequest so a capture
// applies whatever the panel toggle is set to. Default None (exact bounds) — a
// capture with no explicit choice stays byte-identical to today. Extension-session
// setting: persists across project loads and panel open/close within a REAPER session;
// resets to None only when the extension unloads (fresh REAPER session). Project
// persistence across REAPER restarts is a noted follow-on.
// Safe to call before the panel has ever opened (returns the default). READ of panel
// state only; the toggle is mutated by a click inside the panel, never here.
TailSetting bankPanelTailSetting();
// Tears the panel down on extension unload: destroys the window and releases any
// cached thumbnails / PCM handles. Mirror of bankPanelInit; safe if never opened.
void bankPanelShutdown();
+13 -2
View File
@@ -69,12 +69,17 @@ static std::vector<gaccel_register_t> g_captureAccels;
// * CAPTURE_MASTER and CAPTURE_MASTER_REALTIME — the master offline scope and the
// master realtime action are REMOVED (capture is now item + track only; realtime
// taps the selected track). Their shipped ids are retired so old keybindings clear.
// * CAPTURE_ITEM_TAIL and CAPTURE_TRACK_TAIL — the former per-action tail variants
// are REMOVED; tail is now a panel-setting toggle, not a paired action. Retired so
// old keybindings clear.
static const char* const kRetiredCaptureCmdStrings[] = {
"CEREBELLUM_REASAMPLER_CAPTURE_TRACKS_WET",
"CEREBELLUM_REASAMPLER_CAPTURE_ITEMS_WET",
"CEREBELLUM_REASAMPLER_CAPTURE_RAZOR_WET",
"CEREBELLUM_REASAMPLER_CAPTURE_MASTER",
"CEREBELLUM_REASAMPLER_CAPTURE_MASTER_REALTIME",
"CEREBELLUM_REASAMPLER_CAPTURE_ITEM_TAIL",
"CEREBELLUM_REASAMPLER_CAPTURE_TRACK_TAIL",
};
// Command id for "ReaSampler: toggle bank panel" (M5). FOREVER-STABLE string.
@@ -505,13 +510,19 @@ static void RunCapture(const reasampler::CaptureActionDef& def)
return;
}
// The tail mode is a PANEL SETTING (docked bank panel's toggle), not a per-action
// variant: the plain capture actions apply whatever the panel is set to. Default
// is None (exact bounds / byte-identical to today) until the user opts in via the
// toggle. tailMs is meaningful only for Manual and is pre-clamped by the panel.
const reasampler::TailSetting tail = reasampler::bankPanelTailSetting();
reasampler::CaptureRequest req;
req.sourceMode = reasampler::sourceModeForScope(def.scope);
req.startSeconds = src.startSeconds; // exact bounds — no rounding
req.endSeconds = src.endSeconds;
req.wetDry = 1.0; // wet post the FX left enabled by the scope
req.tailMode = def.tailMode; // None (exact bounds) or Auto ("…with tail" variant)
req.tailMs = 0.0; // Manual-only; no Manual action yet (future config/UI)
req.tailMode = tail.mode; // None / Auto / Manual, from the panel toggle
req.tailMs = tail.manualMs; // Manual-only (clamped); ignored for None/Auto
req.sampleRate = 0; // follow project rate
req.channelCount = 2;
req.bitDepth = reasampler::WavBitDepth::Float32; // deterministic, no dither
+13 -26
View File
@@ -179,38 +179,25 @@ RazorRange razorUnionBounds(const std::vector<RazorRange>& ranges) {
}
const std::vector<CaptureActionDef>& captureActionTable() {
// Built once (function-local static): two SCOPE actions x two tail variants.
// The None rows are exact bounds (byte-identical to today); the …_TAIL rows are
// the paired TailMode::Auto "…with tail" variants (Daniel's lean over silently
// flipping the exact-bounds default — spec §Open questions). Ids are FOREVER-
// STABLE — never edit a shipped string. Each action infers its range
// (razor-else-time) at fire time and enforces its FX-scope invariant via
// fxBypassPlanFor. The M7 CAPTURE_TRACKS_WET / CAPTURE_ITEMS_WET /
// CAPTURE_RAZOR_WET ids are RETIRED (mirror-unregistered in main.cpp); the
// CAPTURE_MASTER scope action is REMOVED (its id is likewise mirror-
// unregistered) — to capture the master you render a track.
// Built once (function-local static): two SCOPE actions, item + track. Both
// exact bounds by default; the tail mode a capture applies is read from the
// docked-panel setting at fire time (tail_control + bank_panel), so tail is NOT
// a per-action variant. Ids are FOREVER-STABLE — never edit a shipped string.
// Each action infers its range (razor-else-time) at fire time and enforces its
// FX-scope invariant via fxBypassPlanFor. The M7 CAPTURE_TRACKS_WET /
// CAPTURE_ITEMS_WET / CAPTURE_RAZOR_WET ids are RETIRED (mirror-unregistered in
// main.cpp); the CAPTURE_MASTER scope action is REMOVED (its id is likewise
// mirror-unregistered) — to capture the master you render a track.
static const std::vector<CaptureActionDef> table = {
// Item scope, exact bounds — item/take FX only.
// Item scope — item/take FX only.
{"CEREBELLUM_REASAMPLER_CAPTURE_ITEM",
"ReaSampler: capture selected item(s)", "item",
CaptureScope::Item, TailMode::None},
CaptureScope::Item},
// Track scope, exact bounds — item FX + the track's own FX.
// Track scope — item FX + the track's own FX.
{"CEREBELLUM_REASAMPLER_CAPTURE_TRACK",
"ReaSampler: capture selected track(s)", "track",
CaptureScope::Track, TailMode::None},
// Item scope with Auto tail — captures the take-FX decay past the range end,
// trimmed to -72 dB. NEW forever-stable id.
{"CEREBELLUM_REASAMPLER_CAPTURE_ITEM_TAIL",
"ReaSampler: capture selected item(s) with tail", "item",
CaptureScope::Item, TailMode::Auto},
// Track scope with Auto tail — captures the track's own reverb/delay decay
// past the range end, trimmed to -72 dB. NEW forever-stable id.
{"CEREBELLUM_REASAMPLER_CAPTURE_TRACK_TAIL",
"ReaSampler: capture selected track(s) with tail", "track",
CaptureScope::Track, TailMode::Auto},
CaptureScope::Track},
};
return table;
}
+10 -13
View File
@@ -89,7 +89,7 @@ double autoTrimEndRatio();
// None — exact bounds, no tail. Byte-identical to the pre-tail capture. The
// default and the ONLY mode for null-test / verify captures.
// Auto — generous 8 s tail then trim trailing silence to -72 dB (surgical
// normalize). The user-facing "…with tail" default.
// normalize). The user-facing tail-on option (panel toggle).
// Manual — a fixed tail length (clamped to the 8 s cap), no trim.
enum class TailMode {
None,
@@ -213,13 +213,11 @@ RazorRange razorUnionBounds(const std::vector<RazorRange>& ranges);
// --- Capture-action taxonomy (the bindable set main.cpp registers) -----------
//
// One row per bindable SCOPE action. Two scopes (item / track), each in two tail
// variants: an exact-bounds row (TailMode::None) and a paired "…with tail" row
// (TailMode::Auto). The range each captures (razor-else-time) is inferred at fire
// time, not a mode. The tail variants are additive — the None rows keep their
// documented exact-bounds contract byte-for-byte; the Auto variants are a separate
// opt-in action rather than a silent default flip (Daniel's lean, spec §Open
// questions). Bounded, discoverable, NO dialogs (the tool's no-clutter ethos).
// One row per bindable SCOPE action: item and track. The range each captures
// (razor-else-time) is inferred at fire time, not a mode. TAIL is NOT a per-action
// variant — the tail MODE (None/Auto/Manual) is a panel SETTING the capture reads
// at fire time (see tail_control + bank_panel), so a single pair of actions covers
// every tail state. Bounded, discoverable, NO dialogs (the tool's no-clutter ethos).
//
// commandString is FOREVER-STABLE (user keybindings key off it) — never change a
// shipped value. baseName feeds the file stem (sanitized by capture_paths).
@@ -228,17 +226,16 @@ struct CaptureActionDef {
const char* description; // Actions-list label
const char* baseName; // file-stem base for this capture
CaptureScope scope; // FX scope (item / track)
TailMode tailMode; // None (exact bounds) or Auto ("…with tail")
};
// The capture-action table. Iterated by main.cpp to register the family and route
// each fired command back to its definition. Kept here (pure) so the taxonomy is
// one testable list, not scattered registration code.
//
// Four rows: CAPTURE_ITEM / CAPTURE_TRACK (exact bounds, TailMode::None) plus the
// paired CAPTURE_ITEM_TAIL / CAPTURE_TRACK_TAIL variants (TailMode::Auto). There is
// no master capture — to capture the master you render a track. Razor is an inferred
// range, not a mode, and each scope enforces its FX-scope invariant via fxBypassPlanFor.
// Two rows: CAPTURE_ITEM / CAPTURE_TRACK. There is no master capture — to capture
// the master you render a track. Razor is an inferred range, not a mode, and each
// scope enforces its FX-scope invariant via fxBypassPlanFor. The tail mode each
// capture applies is read from the docked-panel setting, not baked into the row.
const std::vector<CaptureActionDef>& captureActionTable();
} // namespace reasampler
+33
View File
@@ -0,0 +1,33 @@
// tail_control — pure implementation. See tail_control.h. NO REAPER / SWELL / vendor.
#include "tail_control.h"
#include <algorithm>
namespace reasampler {
TailMode cycleTailMode(TailMode current) {
switch (current) {
case TailMode::None: return TailMode::Auto;
case TailMode::Auto: return TailMode::Manual;
case TailMode::Manual: return TailMode::None;
}
return TailMode::None; // unreachable for a valid enum; fail to the safe default
}
double clampManualMs(double manualMs) {
// Same runaway guard the pure tailRenderSettingsFor applies to Manual: floor a
// negative request to 0, cap at the 8 s ceiling.
return std::clamp(manualMs, 0.0, kMaxTailMs);
}
std::string tailToggleLabel(const TailSetting& setting) {
switch (setting.mode) {
case TailMode::None: return "Tail: Off";
case TailMode::Auto: return "Tail: Auto";
case TailMode::Manual: return "Tail: Manual";
}
return "Tail: Off"; // unreachable for a valid enum; fail to the safe default
}
} // namespace reasampler
+49
View File
@@ -0,0 +1,49 @@
#pragma once
// tail_control — the REAPER-free logic behind the docked bank_panel's tail-mode
// toggle. The panel shell (bank_panel.cpp) owns the SWELL window, LICE drawing, and
// click hit-testing; what is NOT DAW-bound — the cycle order, the manual-length
// clamp, and the toggle's label text — lives here so it is unit-tested outside the
// DAW (CLAUDE.md §load-bearing split). Mirror of bank_grid / mode_switch.
//
// PURE MODULE: NO REAPER types, NO SWELL, NO vendor/ includes. Standard library
// only (plus render_settings for the pure TailMode enum). Builds and unit-tests
// without REAPER.
#include <string>
#include "render_settings.h" // TailMode (pure enum) — the three-state tail contract
namespace reasampler {
// The Manual-mode starting length. 2 s is a musically useful default tail (a bar of
// reverb throw at a moderate tempo) that is well under the 8 s cap. A fine-adjust UI
// (+/- click zones or scroll) is a noted follow-on; this pass ships a fixed default.
inline constexpr double kDefaultManualTailMs = 2000.0;
// The panel's current tail setting: the mode plus the length used ONLY when the
// mode is Manual. Held as in-memory panel/session state (bank_panel.cpp), default
// None so a capture with no explicit choice stays exact-bounds / byte-identical to
// today. `manualMs` is a stored default a future fine-adjust UI can tune; it is
// clamped to the 8 s cap (kMaxTailMs) before it ever reaches a CaptureRequest.
struct TailSetting {
TailMode mode = TailMode::None;
double manualMs = kDefaultManualTailMs;
};
// Cycles the tail mode: None -> Auto -> Manual -> None. Pure so the wrap order is
// pinned by a test and the panel's click handler owns no enum arithmetic of its own.
// An out-of-range value (unreachable for a valid enum) cycles back to None.
TailMode cycleTailMode(TailMode current);
// The effective manual length a Manual capture uses: `manualMs` clamped to
// [0, kMaxTailMs] (the runaway guard the pure tailRenderSettingsFor also applies).
// Exposed so the panel can show the clamped value and main.cpp hands a pre-clamped
// tailMs into the CaptureRequest. Meaningful only for TailMode::Manual.
double clampManualMs(double manualMs);
// The toggle's label for a setting, e.g. "Tail: Off", "Tail: Auto", "Tail: Manual".
// (Manual omits the length here — the panel is unobtrusive; a length readout can be
// added with the fine-adjust follow-on.) Pure so the exact strings are test-pinned.
std::string tailToggleLabel(const TailSetting& setting);
} // namespace reasampler