Barrido largo, con sus tamaños de FFT y su retardo

Acción Settings: Long Sweep on / off y variable settings_long_sweep. Al
cambiarlo se releen settings y generator, porque RiTA mueve el tamaño de FFT
al apagarlo y sube la duración del barrido al encenderlo.

El desplegable de FFT ya trae 128 FPPO y 65536, en el orden de RiTA, y el
aviso de un tamaño rechazado da las tres razones posibles: Long Sweep,
Spectrum o un find puesto. El retardo de canal llega a 1360 ms.

La ayuda cuenta también que Sum y AVG son excluyentes desde la 2.8.1.

Sin comprobar, porque el doble no puede encender Long Sweep (le faltan
measureValues, measureSuma y DialogOptions): que se acepten los dos tamaños
nuevos y el retardo por encima de 680 ms. Las pruebas lo dicen.

Author: telecomario93

companion/HELP.md

@@ -14,7 +14,7 @@ Requires **RiTA 2.8.0 or later**. With an older RiTA the module still connects a
 ### Actions
 
 - **Generator**: Spectrum on/off, signal, gain, duration, outputs.
-- **Settings**: FFT size, window, smoothing, spectrum averages, averaging, sum, plot style, coherence threshold, DSP type, DSP model, DSP mode, reference mode, measurement mode.
+- **Settings**: FFT size, window, smoothing, spectrum averages, averaging, sum, plot style, coherence threshold, Long Sweep, DSP type, DSP model, DSP mode, reference mode, measurement mode.
 - **Measurement**: capture, activate engine, find delay, set delay, set inputs, rename, sync all, clear find, clear delays, clear everything, export all.
 - **Memory**: store the trace of an engine, show/hide, rename, delete.
 - **AVG**: on/off, export impulse.
@@ -30,7 +30,11 @@ When RiTA would have shown a message box, it answers anyway and puts the text in
 
 **Spectrum on/off** selects Spectrum if needed and measures it on the chosen engine; off stops it. It can run on several engines: deactivate one with **Measurement: activate engine**.
 
-From RiTA 2.8.1 the **Spectrum** signal has no `64 FPPO` FFT size: choosing Spectrum moves the size to 32768 on its own, writing `64 FPPO` while it is selected is refused, and leaving Spectrum brings the size back. The module reads the settings again after every change of signal, so what the buttons show is what RiTA has.
+From RiTA 2.8.1 the **Spectrum** signal has no `64 FPPO` FFT size, nor `128 FPPO` or `65536`: choosing Spectrum moves the size to 32768 on its own, writing one of those while it is selected is refused, and leaving Spectrum brings the size back. The module reads the settings again after every change of signal, so what the buttons show is what RiTA has.
+
+**Settings: Long Sweep on / off** is the Normal / Long Sweep switch of Preferences, off by default. On, each engine keeps 65536 samples instead of 32768, the FFT size list gains `128 FPPO` and `65536`, the sweep goes up to at least 2 s (1 s at 96 kHz) and the delay of a DSP channel reaches 1360 ms instead of 680. Off, the measurements are cut back to 32768 and a delay above 680 ms stays at 680. RiTA says in the log what it had to change, and the module reads the settings and the generator again afterwards, because switching it moves the FFT size and can raise the sweep duration. `$(rita:settings_long_sweep)` says whether it is on.
+
+The FFT size dropdown offers every size RiTA can have, so it also lists the two that need Long Sweep. Asking for one RiTA is not offering at that moment is refused and the module says in the log which of the three reasons it is.
 
 **Live TF** is not offered by RiTA 2.8.0: it is not in the signal list and the generator has no pink noise switch.
 
@@ -64,7 +68,7 @@ The mode decides how much of the channel there is: how many EQ filters, which cr
 
 **Mute groups** are the 4 assignable mute buttons of the external processor (DAP0408F, GALAXY, Marani…). Which channels belong to each group is set in RiTA, not from here, and a group can mix channels of several processors. *Toggle* does what the button does: it unmutes the group when every channel is muted, and mutes it otherwise. Feedbacks: **Mute group is muted** (red) and **Mute group has channels**; the name given in RiTA is in `$(rita:mute_group_N_name)`, so it can be the button text. A group with no channels on a connected processor answers "no channels", and a channel the processor did not take is written to the log.
 
-**AVG** is RiTA's average of the **selected** engines (not the active ones). **AVG: on / off** is the same control as *Settings: averaging on/off*. **AVG: export impulse** writes the impulse response of the average to the Memory Bank folder, in the format chosen in RiTA; the export runs in the background and its result (or error, such as no export folder or AVG off) is written to the log.
+**AVG** is RiTA's average of the **selected** engines (not the active ones). **AVG: on / off** is the same control as *Settings: averaging on/off*. From RiTA 2.8.1 **AVG and Sum exclude each other**, like their buttons in RiTA: switching one on switches the other off, and the module follows both. **AVG: export impulse** writes the impulse response of the average to the Memory Bank folder, in the format chosen in RiTA; the export runs in the background and its result (or error, such as no export folder or AVG off) is written to the log.
 
 **Measurement: sync all** is RiTA's Sync All (button and Y shortcut): it aligns with each other the engines that already have a measurement, without touching AVG. The new delays show up on the buttons at once and are written to the log. With no measured engine it answers "no active measurements".
 
@@ -95,7 +99,7 @@ Connected, Mute group is muted, Mute group has channels, Sync All is set, Sync A
 ### Variables
 
 - `$(rita:generator_running)`, `generator_signal`, `generator_gain`, `generator_duration`, `generator_output1`, `generator_output2`
-- `$(rita:settings_fft_size)`, `settings_window`, `settings_smoothing`, `settings_spectrum_averages`, `settings_averaging`, `settings_sum`, `settings_coherence_threshold`, `settings_dsp_type`, `settings_dsp_model`, `settings_dsp_mode`, `settings_reference_mode`, `settings_measurement_mode`
+- `$(rita:settings_fft_size)`, `settings_window`, `settings_smoothing`, `settings_spectrum_averages`, `settings_averaging`, `settings_sum`, `settings_coherence_threshold`, `settings_dsp_type`, `settings_dsp_model`, `settings_dsp_mode`, `settings_long_sweep`, `settings_reference_mode`, `settings_measurement_mode`
 - `$(rita:sync_active)`, `sync_count`, `sync_possible`
 - `$(rita:mute_group_N_name)`, `mute_group_N_muted`, `mute_group_N_available` for N = 1..4
 - `$(rita:average_active)`, `average_has_data`, `average_count`, `average_engines`, `average_mode`, `average_name`

src/actions.ts

@@ -35,7 +35,7 @@ const FIND_HINT = {
 // to 32768 by itself.
 const FFT_SIZE_HINT = {
 	'unknown value':
-		'RiTA refused the FFT size: with the Spectrum signal there is no 64 FPPO. And if a find is in place, a size that does not fit its delay is refused too: clear it with Measurement: clear find',
+		'RiTA refused the FFT size. 128 FPPO and 65536 need Long Sweep on; the Spectrum signal has none of those three and no 64 FPPO either; and if a find is in place, a size that does not fit its delay is refused too: clear it with Measurement: clear find',
 }
 
 // DSP Type reached the API after RiTA 2.8.0, and the list of processors can grow.
@@ -57,6 +57,11 @@ const XOVER_HINT = {
 		'RiTA refused it. With a processor as DSP type, the crossover type and its order have to be ones that model and mode have; NXF only exists on some of them',
 }
 
+// Long Sweep arrived with RiTA 2.8.1 as well.
+const LONG_SWEEP_HINT = {
+	'unknown property': 'This RiTA has no Long Sweep (Preferences): it needs 2.8.1 or later',
+}
+
 // The position of the exported files also arrived with 2.8.1, and before that it was a field
 // on RiTA's own screen that the API could not write.
 const POSITION_HINT = {
@@ -372,6 +377,22 @@ export function UpdateActions(self: ModuleInstance): void {
 				await send('set', 'settings', { dspMode: mode }, DSP_MODEL_HINT)
 			},
 		},
+		settings_long_sweep: {
+			name: 'Settings: Long Sweep on / off',
+			description:
+				'The Normal / Long Sweep switch of Preferences. On, each engine keeps 65536 samples instead of 32768, the FFT ' +
+				'size list gains 128 FPPO and 65536, the sweep goes up to at least 2 s (1 s at 96 kHz) and the channel delay ' +
+				'reaches 1360 ms instead of 680. Off, the measurements are cut back to 32768. RiTA says in the log what it had ' +
+				'to change. Needs RiTA 2.8.1 or later.',
+			options: [modeOption],
+			callback: async ({ options }) => {
+				const wanted = resolveBool(options.mode, self.state.settings.longSweep)
+				if (!(await send('set', 'settings', { longSweep: wanted }, LONG_SWEEP_HINT))) return
+				// Switching it moves the FFT size and can raise the sweep duration, so both are read again.
+				await self.refreshSettings()
+				await self.refresh('generator')
+			},
+		},
 		settings_export_position: {
 			name: 'Settings: export position',
 			description:
@@ -769,7 +790,15 @@ export function UpdateActions(self: ModuleInstance): void {
 			name: 'DSP: set channel delay',
 			options: [
 				channelOption,
-				{ type: 'number', id: 'delay', label: 'Delay (ms)', default: 0, min: 0, max: 680, step: 0.01 },
+				{
+					type: 'number',
+					id: 'delay',
+					label: 'Delay (ms). Over 680 needs Long Sweep',
+					default: 0,
+					min: 0,
+					max: 1360,
+					step: 0.01,
+				},
 			],
 			callback: async ({ options }) => {
 				await send('set', `dsp/out/${options.channel}`, { delay: Number(options.delay) })

src/choices.ts

@@ -22,7 +22,23 @@ export const ON_OFF_TOGGLE_CHOICES: Choice[] = [
 export const SIGNAL_CHOICES = same(['Sweep', 'Multi Sweep', 'Pink', 'External', 'Spectrum'])
 export const DURATION_CHOICES: Choice[] = ['1', '2', '4', '8', '16'].map((v) => ({ id: v, label: `${v} s` }))
 
-export const FFT_SIZE_CHOICES = same(['64 FPPO', '32768', '16384', '8192', '4096', '2048', '1024', '512', '256', '128'])
+// The sizes of RiTA's FFT dropdown, in its own order. 128 FPPO and 65536 are only there with
+// Long Sweep on, and the Spectrum signal has neither those nor 64 FPPO: anything RiTA is not
+// offering at that moment answers "unknown value".
+export const FFT_SIZE_CHOICES = same([
+	'128 FPPO',
+	'64 FPPO',
+	'65536',
+	'32768',
+	'16384',
+	'8192',
+	'4096',
+	'2048',
+	'1024',
+	'512',
+	'256',
+	'128',
+])
 export const WINDOW_CHOICES = same([
 	'Rectangular',
 	'Hamming',

src/state.ts

@@ -49,6 +49,8 @@ export interface SettingsState {
 	measurementMode?: string
 	// From RiTA 2.8.1 the position of the exported files lives only in the API.
 	exportPosition?: string
+	// Long Sweep: 65536 samples per engine instead of 32768.
+	longSweep?: boolean
 	fftSize?: string
 	window?: string
 	smoothing?: string
@@ -104,6 +106,7 @@ export const OPTIONAL_SETTINGS_PROPS = [
 	'referenceMode',
 	'measurementMode',
 	'exportPosition',
+	'longSweep',
 ]
 export const OPTIONAL_SETTINGS_LABELS: Record<string, string> = {
 	dspType: 'DSP Type',
@@ -112,6 +115,7 @@ export const OPTIONAL_SETTINGS_LABELS: Record<string, string> = {
 	referenceMode: 'reference mode',
 	measurementMode: 'measurement mode',
 	exportPosition: 'export position',
+	longSweep: 'Long Sweep',
 }
 
 // RiTA changes fftSize on its own when Live TF starts with smoothing on, so it is followed, never restored.

src/variables.ts

@@ -23,6 +23,7 @@ export function UpdateVariableDefinitions(self: ModuleInstance): void {
 		settings_dsp_model: { name: 'DSP model' },
 		settings_dsp_mode: { name: 'DSP mode' },
 		settings_export_position: { name: 'Export position' },
+		settings_long_sweep: { name: 'Long Sweep on' },
 		settings_reference_mode: { name: 'Reference mode' },
 		settings_measurement_mode: { name: 'Measurement mode' },
 		settings_fft_size: { name: 'FFT size' },
@@ -82,6 +83,7 @@ export function UpdateVariableValues(self: ModuleInstance): void {
 		settings_dsp_model: self.state.settings.dspModel ?? '',
 		settings_dsp_mode: self.state.settings.dspMode ?? '',
 		settings_export_position: self.state.settings.exportPosition ?? '',
+		settings_long_sweep: onOff(self.state.settings.longSweep, 'ON', 'OFF'),
 		settings_reference_mode: self.state.settings.referenceMode ?? '',
 		settings_measurement_mode: self.state.settings.measurementMode ?? '',
 		settings_fft_size: self.state.settings.fftSize ?? '',