From a07c33bd66fdf23c1b284d8ef8cdc22c63646f21 Mon Sep 17 00:00:00 2001
From: Vladimir Sadovnikov <sadko4u@gmail.com>
Date: Mon, 2 Dec 2024 22:21:59 +0300
Subject: [PATCH] Added shared memory links for signal analysis

---
 CHANGELOG                                     |  1 +
 include/private/plugins/spectrum_analyzer.h   |  2 +
 res/main/ui/analyzer/spectrum/x1.xml          |  1 +
 res/main/ui/analyzer/spectrum/x12.xml         |  7 +-
 res/main/ui/analyzer/spectrum/x16.xml         |  5 +-
 res/main/ui/analyzer/spectrum/x2.xml          |  5 +-
 res/main/ui/analyzer/spectrum/x4.xml          |  7 +-
 res/main/ui/analyzer/spectrum/x8.xml          |  7 +-
 src/doc/manuals/plugins/spectrum_analyzer.php |  1 +
 src/main/meta/spectrum_analyzer.cpp           | 93 ++++++++++---------
 src/main/plug/spectrum_analyzer.cpp           | 53 +++++++----
 11 files changed, 113 insertions(+), 69 deletions(-)

diff --git a/CHANGELOG b/CHANGELOG
index 7bbef99..7fa1c21 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -3,6 +3,7 @@
 *******************************************************************************
 
 === 1.0.29 ===
+* Added shared memory links for signal analysis.
 * Removed the unused 'Hue' parameter for channels.
 
 === 1.0.28 ===
diff --git a/include/private/plugins/spectrum_analyzer.h b/include/private/plugins/spectrum_analyzer.h
index 988d77c..20df740 100644
--- a/include/private/plugins/spectrum_analyzer.h
+++ b/include/private/plugins/spectrum_analyzer.h
@@ -47,11 +47,13 @@ namespace lsp
                     float           fGain;              // Makeup gain
                     float          *vIn;                // Input buffer pointer
                     float          *vOut;               // Output buffer pointer
+                    float          *vRet;               // Return buffer
                     float          *vBuffer;            // Temporary buffer
 
                     // Port references
                     plug::IPort    *pIn;                // Input samples
                     plug::IPort    *pOut;               // Output samples
+                    plug::IPort    *pRet;               // Return
                     plug::IPort    *pMSSwitch;          // Mid/Side switch
                     plug::IPort    *pOn;                // FFT on
                     plug::IPort    *pSolo;              // Soloing flag
diff --git a/res/main/ui/analyzer/spectrum/x1.xml b/res/main/ui/analyzer/spectrum/x1.xml
index 7133cc3..2955572 100644
--- a/res/main/ui/analyzer/spectrum/x1.xml
+++ b/res/main/ui/analyzer/spectrum/x1.xml
@@ -256,6 +256,7 @@
 						</cell>
 
 						<vbox padding="6">
+							<shmlink id="ret_0" value.maxlen="6" text.clip="true" hfill="true" />
 							<button ui:inject="Button_cyan" id="frz_0" text="labels.chan.hold" size="16" width="60"/>
 						</vbox>
 
diff --git a/res/main/ui/analyzer/spectrum/x12.xml b/res/main/ui/analyzer/spectrum/x12.xml
index 49efe02..f5e81b3 100644
--- a/res/main/ui/analyzer/spectrum/x12.xml
+++ b/res/main/ui/analyzer/spectrum/x12.xml
@@ -398,13 +398,16 @@
 
 					<ui:if test=":i % 2 ieq 0">
 						<cell cols="3" pad.h="6" pad.v="4" bg.color="bg_schema">
-							<button bg.color="bg_schema" text="labels.chan.mid_side" id="ms_${:i idiv 2}" height="19" hfill="true"/>
+							<vbox>
+								<shmlink id="ret_${:i idiv 2}" value.maxlen="6" text.clip="true" hfill="true" />
+								<button bg.color="bg_schema" text="labels.chan.mid_side" id="ms_${:i idiv 2}" height="19" hfill="true"/>
+							</vbox>
 						</cell>
 						<cell cols="3" pad.h="6" pad.v="4" bg.color="bg_schema">
 							<hbox>
 								<label text="-1" font.size="8" hfill="true" text.halign="-1" pad.t="2" pad.r="1"/>
 								<ledchannel
-									id="cm_${:i / 2}"
+									id="cm_${:i idiv 2}"
 									width.min="13"
 									width.max="13"
 									min="-100"
diff --git a/res/main/ui/analyzer/spectrum/x16.xml b/res/main/ui/analyzer/spectrum/x16.xml
index a82aa8e..335eb3d 100644
--- a/res/main/ui/analyzer/spectrum/x16.xml
+++ b/res/main/ui/analyzer/spectrum/x16.xml
@@ -397,7 +397,10 @@
 
 					<ui:if test=":i % 2 ieq 0">
 						<cell cols="3" pad.h="6" pad.v="4" bg.color="bg_schema">
-							<button bg.color="bg_schema" text="labels.chan.mid_side" id="ms_${:i idiv 2}" height="19" hfill="true"/>
+							<vbox>
+								<shmlink id="ret_${:i idiv 2}" value.maxlen="6" text.clip="true" hfill="true" />
+								<button bg.color="bg_schema" text="labels.chan.mid_side" id="ms_${:i idiv 2}" height="19" hfill="true"/>
+							</vbox>
 						</cell>
 						<cell cols="3" pad.h="6" pad.v="4" bg.color="bg_schema">
 							<hbox>
diff --git a/res/main/ui/analyzer/spectrum/x2.xml b/res/main/ui/analyzer/spectrum/x2.xml
index 47064ff..d0296c5 100644
--- a/res/main/ui/analyzer/spectrum/x2.xml
+++ b/res/main/ui/analyzer/spectrum/x2.xml
@@ -355,7 +355,10 @@
 					</grid>
 				</group>
 
-				<button bg.color="bg_schema" text="labels.chan.mid_side" id="ms_0" height="19" hfill="true" pad.v="4" pad.h="6"/>
+				<vbox>
+					<shmlink id="ret_0" value.maxlen="6" text.clip="true" hfill="true" />
+					<button bg.color="bg_schema" text="labels.chan.mid_side" id="ms_0" height="19" hfill="true" pad.v="4" pad.h="6"/>
+				</vbox>
 
 				<vbox vfill="false" bg.color="bg_schema" pad.v="4" pad.h="6">
 					<label text="labels.chan.correlation" pad.v="0"/>
diff --git a/res/main/ui/analyzer/spectrum/x4.xml b/res/main/ui/analyzer/spectrum/x4.xml
index 48348af..e5f5b61 100644
--- a/res/main/ui/analyzer/spectrum/x4.xml
+++ b/res/main/ui/analyzer/spectrum/x4.xml
@@ -338,13 +338,16 @@
 
 						<ui:if test=":i % 2 ieq 0">
 							<cell cols="3" pad.h="6" pad.v="4" bg.color="bg_schema">
-								<button bg.color="bg_schema" text="labels.chan.mid_side" id="ms_${:i idiv 2}" height="19" hfill="true"/>
+								<vbox>
+									<shmlink id="ret_${:i idiv 2}" value.maxlen="6" text.clip="true" hfill="true" />
+									<button bg.color="bg_schema" text="labels.chan.mid_side" id="ms_${:i idiv 2}" height="19" hfill="true"/>
+								</vbox>
 							</cell>
 							<cell cols="3" pad.h="6" pad.v="4" bg.color="bg_schema">
 								<hbox>
 									<label text="-1" font.size="8" hfill="true" text.halign="-1" pad.t="2" pad.r="1"/>
 									<ledchannel
-										id="cm_${:i / 2}"
+										id="cm_${:i idiv 2}"
 										width.min="13"
 										width.max="13"
 										min="-100"
diff --git a/res/main/ui/analyzer/spectrum/x8.xml b/res/main/ui/analyzer/spectrum/x8.xml
index 5fb302d..41bf56e 100644
--- a/res/main/ui/analyzer/spectrum/x8.xml
+++ b/res/main/ui/analyzer/spectrum/x8.xml
@@ -334,13 +334,16 @@
 
 						<ui:if test=":i % 2 ieq 0">
 							<cell cols="3" pad.h="6" pad.v="4" bg.color="bg_schema">
-								<button bg.color="bg_schema" text="labels.chan.mid_side" id="ms_${:i idiv 2}" height="19" hfill="true"/>
+								<vbox>
+									<shmlink id="ret_${:i idiv 2}" value.maxlen="6" text.clip="true" hfill="true" />
+									<button bg.color="bg_schema" text="labels.chan.mid_side" id="ms_${:i idiv 2}" height="19" hfill="true"/>
+								</vbox>
 							</cell>
 							<cell cols="3" pad.h="6" pad.v="4" bg.color="bg_schema">
 								<hbox>
 									<label text="-1" font.size="8" hfill="true" text.halign="-1" pad.t="2" pad.r="1"/>
 									<ledchannel
-										id="cm_${:i / 2}"
+										id="cm_${:i idiv 2}"
 										width.min="13"
 										width.max="13"
 										min="-100"
diff --git a/src/doc/manuals/plugins/spectrum_analyzer.php b/src/doc/manuals/plugins/spectrum_analyzer.php
index dffccd8..3cce008 100644
--- a/src/doc/manuals/plugins/spectrum_analyzer.php
+++ b/src/doc/manuals/plugins/spectrum_analyzer.php
@@ -73,6 +73,7 @@
 	<li><b>Hold</b> - forces the frequency graph of the channel to freeze.</li>
 	<li><b>Shift</b> - allows to adjust the gain of the channel.</li>
 	<li><b>Preamp</b> - allows to adjust the overall gain of the analysis.</li>
+	<li><b>Link</b> - stereo link, allows to add signal to the input channel <?php if ($nc > 1) { ?>pair<?php } ?> passed from the shared memory link.</li>
 	<?php if ($nc > 1) { ?>
 	<li><b>Channel</b> - allows to select the channel for level metering.</li>
 	<li><b>Mid/Side</b> - allows to switch the channel pair (which consists of two near subsequent channels) to the Mid/Side analysis mode.</li>
diff --git a/src/main/meta/spectrum_analyzer.cpp b/src/main/meta/spectrum_analyzer.cpp
index 62283a7..50e2d40 100644
--- a/src/main/meta/spectrum_analyzer.cpp
+++ b/src/main/meta/spectrum_analyzer.cpp
@@ -150,7 +150,7 @@ namespace lsp
         #define SA_CORRMETER(id, label) \
             METER(id, label, U_PERCENT, spectrum_analyzer::CORRELATION)
 
-        #define SA_INPUT(x, total, active) \
+        #define SA_INPUT(x, active) \
             AUDIO_INPUT_N(x), \
             AUDIO_OUTPUT_N(x), \
             SWITCH("on_" #x, "Analyse " #x, active), \
@@ -183,7 +183,11 @@ namespace lsp
             { "lvl", "Level", U_GAIN_AMP, R_METER, F_UPPER | F_LOWER, 0, 10000, 0, 0, NULL }, \
             MESH("spd", "Spectrum Data", c + 2, spectrum_analyzer::MESH_POINTS + 4)
 
+        #define SA_MGROUP(id) \
+            OPT_RETURN_MONO("ret_" #id, "rin_" #id, "Audio return group " #id)
+
         #define SA_SGROUP(id) \
+            OPT_RETURN_STEREO("ret_" #id, "rin_" #id, "Audio return group " #id), \
             SWITCH("ms_" #id, "Mid/Side switch for channel pair " #id, 0), \
             SA_CORRMETER("cm_" #id, "Correlometer for stereo channel pair " #id)
 
@@ -192,7 +196,8 @@ namespace lsp
 
         static const port_t spectrum_analyzer_x1_ports[] =
         {
-            SA_INPUT(0, 1, 1),
+            SA_INPUT(0, 1),
+            SA_MGROUP(0),
             SA_COMMON(1, SA_SKIP),
             FBUFFER("fb", "Spectralizer buffer", spectrum_analyzer::FB_ROWS, spectrum_analyzer::MESH_POINTS),
             PORTS_END
@@ -200,8 +205,8 @@ namespace lsp
 
         static const port_t spectrum_analyzer_x2_ports[] =
         {
-            SA_INPUT(0, 2, 1),
-            SA_INPUT(1, 2, 1),
+            SA_INPUT(0, 1),
+            SA_INPUT(1, 1),
             SA_SGROUP(0),
             SA_COMMON(2, SA_CHANNEL),
             SWITCH("ms", "Stereo analysis Mid/Side mode", 0),
@@ -213,10 +218,10 @@ namespace lsp
 
         static const port_t spectrum_analyzer_x4_ports[] =
         {
-            SA_INPUT(0, 4, 1),
-            SA_INPUT(1, 4, 1),
-            SA_INPUT(2, 4, 0),
-            SA_INPUT(3, 4, 0),
+            SA_INPUT(0, 1),
+            SA_INPUT(1, 1),
+            SA_INPUT(2, 0),
+            SA_INPUT(3, 0),
             SA_SGROUP(0),
             SA_SGROUP(1),
             SA_COMMON(4, SA_CHANNEL),
@@ -231,14 +236,14 @@ namespace lsp
 
         static const port_t spectrum_analyzer_x8_ports[] =
         {
-            SA_INPUT(0, 8, 1),
-            SA_INPUT(1, 8, 1),
-            SA_INPUT(2, 8, 0),
-            SA_INPUT(3, 8, 0),
-            SA_INPUT(4, 8, 0),
-            SA_INPUT(5, 8, 0),
-            SA_INPUT(6, 8, 0),
-            SA_INPUT(7, 8, 0),
+            SA_INPUT(0, 1),
+            SA_INPUT(1, 1),
+            SA_INPUT(2, 0),
+            SA_INPUT(3, 0),
+            SA_INPUT(4, 0),
+            SA_INPUT(5, 0),
+            SA_INPUT(6, 0),
+            SA_INPUT(7, 0),
             SA_SGROUP(0),
             SA_SGROUP(1),
             SA_SGROUP(2),
@@ -255,18 +260,18 @@ namespace lsp
 
         static const port_t spectrum_analyzer_x12_ports[] =
         {
-            SA_INPUT(0, 12, 1),
-            SA_INPUT(1, 12, 1),
-            SA_INPUT(2, 12, 0),
-            SA_INPUT(3, 12, 0),
-            SA_INPUT(4, 12, 0),
-            SA_INPUT(5, 12, 0),
-            SA_INPUT(6, 12, 0),
-            SA_INPUT(7, 12, 0),
-            SA_INPUT(8, 12, 0),
-            SA_INPUT(9, 12, 0),
-            SA_INPUT(10, 12, 0),
-            SA_INPUT(11, 12, 0),
+            SA_INPUT(0, 1),
+            SA_INPUT(1, 1),
+            SA_INPUT(2, 0),
+            SA_INPUT(3, 0),
+            SA_INPUT(4, 0),
+            SA_INPUT(5, 0),
+            SA_INPUT(6, 0),
+            SA_INPUT(7, 0),
+            SA_INPUT(8, 0),
+            SA_INPUT(9, 0),
+            SA_INPUT(10, 0),
+            SA_INPUT(11, 0),
             SA_SGROUP(0),
             SA_SGROUP(1),
             SA_SGROUP(2),
@@ -285,22 +290,22 @@ namespace lsp
 
         static const port_t spectrum_analyzer_x16_ports[] =
         {
-            SA_INPUT(0, 16, 1),
-            SA_INPUT(1, 16, 1),
-            SA_INPUT(2, 16, 0),
-            SA_INPUT(3, 16, 0),
-            SA_INPUT(4, 16, 0),
-            SA_INPUT(5, 16, 0),
-            SA_INPUT(6, 16, 0),
-            SA_INPUT(7, 16, 0),
-            SA_INPUT(8, 16, 0),
-            SA_INPUT(9, 16, 0),
-            SA_INPUT(10, 16, 0),
-            SA_INPUT(11, 16, 0),
-            SA_INPUT(12, 16, 0),
-            SA_INPUT(13, 16, 0),
-            SA_INPUT(14, 16, 0),
-            SA_INPUT(15, 16, 0),
+            SA_INPUT(0, 1),
+            SA_INPUT(1, 1),
+            SA_INPUT(2, 0),
+            SA_INPUT(3, 0),
+            SA_INPUT(4, 0),
+            SA_INPUT(5, 0),
+            SA_INPUT(6, 0),
+            SA_INPUT(7, 0),
+            SA_INPUT(8, 0),
+            SA_INPUT(9, 0),
+            SA_INPUT(10, 0),
+            SA_INPUT(11, 0),
+            SA_INPUT(12, 0),
+            SA_INPUT(13, 0),
+            SA_INPUT(14, 0),
+            SA_INPUT(15, 0),
             SA_SGROUP(0),
             SA_SGROUP(1),
             SA_SGROUP(2),
diff --git a/src/main/plug/spectrum_analyzer.cpp b/src/main/plug/spectrum_analyzer.cpp
index 60a72f7..7d353e9 100644
--- a/src/main/plug/spectrum_analyzer.cpp
+++ b/src/main/plug/spectrum_analyzer.cpp
@@ -21,13 +21,15 @@
 
 #include <private/meta/spectrum_analyzer.h>
 #include <private/plugins/spectrum_analyzer.h>
+
+#include <lsp-plug.in/common/alloc.h>
+#include <lsp-plug.in/common/debug.h>
+#include <lsp-plug.in/dsp/dsp.h>
 #include <lsp-plug.in/dsp-units/units.h>
+#include <lsp-plug.in/plug-fw/core/AudioBuffer.h>
 #include <lsp-plug.in/plug-fw/meta/ports.h>
 #include <lsp-plug.in/plug-fw/meta/func.h>
-#include <lsp-plug.in/common/alloc.h>
-#include <lsp-plug.in/common/debug.h>
 #include <lsp-plug.in/stdlib/math.h>
-#include <lsp-plug.in/dsp/dsp.h>
 
 #include <lsp-plug.in/shared/debug.h>
 #include <lsp-plug.in/shared/id_colors.h>
@@ -200,11 +202,13 @@ namespace lsp
                 c->fGain            = 1.0f;
                 c->vIn              = NULL;
                 c->vOut             = NULL;
+                c->vRet             = NULL;
                 c->vBuffer          = advance_ptr_bytes<float>(ptr, BUFFER_SIZE * sizeof(float));
 
                 // Port references
                 c->pIn              = NULL;
                 c->pOut             = NULL;
+                c->pRet             = NULL;
                 c->pMSSwitch        = NULL;
                 c->pOn              = NULL;
                 c->pFreeze          = NULL;
@@ -300,12 +304,20 @@ namespace lsp
                     sa_channel_t *r         = &vChannels[i+1];
                     sa_correlometer_t *cm   = &vCorrelometers[i >> 1];
 
+                    SKIP_PORT("Return name");
+                    BIND_PORT(l->pRet);
+                    BIND_PORT(r->pRet);
                     BIND_PORT(l->pMSSwitch);
                     r->pMSSwitch        = l->pMSSwitch;
 
                     BIND_PORT(cm->pCorrelometer);
                 }
             }
+            else
+            {
+                SKIP_PORT("Return name");
+                BIND_PORT(vChannels[0].pRet);
+            }
 
             // Initialize basic ports
             BIND_PORT(pBypass);
@@ -788,6 +800,19 @@ namespace lsp
 
         void spectrum_analyzer::prepare_buffers(size_t count)
         {
+            // Mix with return if it is routed
+            for (size_t i=0; i<nChannels; ++i)
+            {
+                sa_channel_t *c     = &vChannels[i];
+
+                vAnalyze[i]         = c->vIn;
+                if (c->vRet != NULL)
+                {
+                    dsp::add3(c->vBuffer, c->vIn, c->vRet, count);
+                    vAnalyze[i]         = c->vBuffer;
+                }
+            }
+
             if (nChannels > 1)
             {
                 if (!bMSSwitch)
@@ -799,23 +824,14 @@ namespace lsp
 
                         if ((l->bMSSwitch) || (r->bMSSwitch))
                         {
-                            dsp::lr_to_ms(l->vBuffer, r->vBuffer, l->vIn, r->vIn, count);
+                            dsp::lr_to_ms(l->vBuffer, r->vBuffer, vAnalyze[i], vAnalyze[i+1], count);
                             vAnalyze[i]         = l->vBuffer;
                             vAnalyze[i+1]       = r->vBuffer;
                         }
-                        else
-                        {
-                            vAnalyze[i]     = l->vIn;
-                            vAnalyze[i+1]   = r->vIn;
-                        }
                     }
                 }
                 else
                 {
-                    // Copy pointers to all buffers as is
-                    for (size_t i=0; i<nChannels; ++i)
-                        vAnalyze[i]         = vChannels[i].vIn;
-
                     // Special case: do MS convert for two (or one) channels
                     ssize_t l_id        = vSpc[0].nPortId;
                     ssize_t r_id        = vSpc[1].nPortId;
@@ -827,19 +843,17 @@ namespace lsp
 
                     if (l_id != r_id)
                     {
-                        dsp::lr_to_ms(l->vBuffer, r->vBuffer, l->vIn, r->vIn, count);
+                        dsp::lr_to_ms(l->vBuffer, r->vBuffer, vAnalyze[l_id], vAnalyze[r_id], count);
                         vAnalyze[l_id]      = l->vBuffer;
                         vAnalyze[r_id]      = r->vBuffer;
                     }
                     else
                     {
-                        dsp::lr_to_mid(l->vBuffer, l->vIn, r->vIn, count);
+                        dsp::lr_to_mid(l->vBuffer, vAnalyze[l_id], vAnalyze[r_id], count);
                         vAnalyze[l_id]      = l->vBuffer;
                     }
                 }
             }
-            else
-                vAnalyze[0]     = vChannels[0].vIn;
         }
 
         void spectrum_analyzer::process(size_t samples)
@@ -858,6 +872,9 @@ namespace lsp
                 sa_channel_t *c     = &vChannels[i];
                 c->vIn              = c->pIn->buffer<float>();
                 c->vOut             = c->pOut->buffer<float>();
+
+                core::AudioBuffer *ret  = c->pRet->buffer<core::AudioBuffer>();
+                c->vRet             = ((ret!= NULL) && (ret->active())) ? ret->buffer() : NULL;
             }
 
             // Cleanup correlometers
@@ -976,6 +993,8 @@ namespace lsp
                     sa_channel_t *c     = &vChannels[i];
                     c->vIn             += count;
                     c->vOut            += count;
+                    if (c->vRet != NULL)
+                        c->vRet            += count;
                 }
 
                 // Synchronize buffer state