Effects: Add support for GUIs and reference implementation for Audio Unit

CMakeLists.txt

@@ -1073,6 +1073,7 @@ add_library(
   src/effects/chains/pergroupeffectchain.cpp
   src/effects/chains/quickeffectchain.cpp
   src/effects/chains/standardeffectchain.cpp
+  src/effects/dlgeffect.cpp
   src/effects/effectbuttonparameterslot.cpp
   src/effects/effectchain.cpp
   src/effects/effectchainmixmode.cpp
@@ -1875,10 +1876,14 @@ if(APPLE)
         src/effects/backends/audiounit/audiounitmanager.mm
         src/effects/backends/audiounit/audiouniteffectprocessor.mm
         src/effects/backends/audiounit/audiounitmanifest.mm
+        src/effects/backends/audiounit/dlgaudiounit.mm
     )
     target_link_libraries(
       mixxx-lib
-      PRIVATE "-weak_framework AudioToolbox" "-weak_framework AVFAudio"
+      PRIVATE
+        "-weak_framework AudioToolbox"
+        "-weak_framework AVFAudio"
+        "-weak_framework CoreAudioKit"
     )
     target_compile_definitions(mixxx-lib PUBLIC __AU_EFFECTS__)
   endif()

res/skins/LateNight/fx/slot_controls.xml

@@ -39,6 +39,34 @@
             <SetVariable name="ConfigKey">[<Variable name="FxRack_FxUnit_FxNum"/>],enabled</SetVariable>
           </Template>
 
+          <WidgetGroup>
+            <Layout>vertical</Layout>
+            <SizePolicy>min,min</SizePolicy>
+            <Children>
+              <WidgetGroup>
+                <Layout>vertical</Layout>
+                <SizePolicy>min,min</SizePolicy>
+                <Children>
+                  <Template src="skins:LateNight/controls/button_2state.xml">
+                    <SetVariable name="TooltipId">EffectSlot_ui_shown</SetVariable>
+                    <SetVariable name="ObjectName">FxUiButton</SetVariable>
+                    <SetVariable name="BtnSize">square</SetVariable>
+                    <SetVariable name="Size">26f,26f</SetVariable>
+                    <SetVariable name="ConfigKey">[<Variable name="FxRack_FxUnit_FxNum"/>],ui_shown</SetVariable>
+                  </Template>
+                </Children>
+                <Connection>
+                  <ConfigKey persist="true">[<Variable name="FxRack_FxUnit_FxNum"/>],uibutton_shown</ConfigKey>
+                  <BindProperty>visible</BindProperty>
+                </Connection>
+              </WidgetGroup>
+            </Children>
+            <Connection>
+              <ConfigKey persist="true">[Skin],show_effectuibuttons</ConfigKey>
+              <BindProperty>visible</BindProperty>
+            </Connection>
+          </WidgetGroup>
+
           <Template src="skins:LateNight/fx/meta_knob.xml"/>
 
           <EffectSelector>

res/skins/LateNight/skin.xml

@@ -82,6 +82,7 @@
     <!-- Effects -->
       <attribute persist="true" config_key="[Skin],show_effectrack">1</attribute>
       <attribute persist="true" config_key="[Skin],show_4effectunits">0</attribute>
+      <attribute persist="true" config_key="[Skin],show_effectuibuttons">1</attribute>
       <attribute persist="true" config_key="[Skin],show_superknobs">0</attribute>
     <!-- Samplers -->
       <attribute persist="true" config_key="[Skin],show_samplers">0</attribute>

res/skins/LateNight/skin_settings.xml

@@ -428,10 +428,22 @@ Description:
                         <SetVariable name="Setting">[Skin],show_effectrack</SetVariable>
                       </Template>
 
-                      <Template src="skins:LateNight/helpers/skin_settings_button_2state.xml">
-                        <SetVariable name="Text">Super Knobs</SetVariable>
-                        <SetVariable name="Setting">[Skin],show_superknobs</SetVariable>
-                      </Template>
+                      <WidgetGroup>
+                        <ObjectName>SkinSettingsCategory</ObjectName>
+                        <SizePolicy>me,min</SizePolicy>
+                        <Layout>vertical</Layout>
+                        <Children>
+                          <Template src="skins:LateNight/helpers/skin_settings_button_2state.xml">
+                            <SetVariable name="Text">Effect UI Buttons</SetVariable>
+                            <SetVariable name="Setting">[Skin],show_effectuibuttons</SetVariable>
+                          </Template>
+
+                          <Template src="skins:LateNight/helpers/skin_settings_button_2state.xml">
+                            <SetVariable name="Text">Super Knobs</SetVariable>
+                            <SetVariable name="Setting">[Skin],show_superknobs</SetVariable>
+                          </Template>
+                        </Children>
+                      </WidgetGroup>
                     </Children>
                   </WidgetGroup>
                 </Children>

res/skins/LateNight/style_palemoon.qss

@@ -1602,6 +1602,7 @@ WPushButton#LoopActivate[displayValue="0"],
 #EQKillButtonBox WPushButton[displayValue="0"],
 WPushButton#StemMuteButton[displayValue="0"],
 WPushButton#QuickEffectButton[displayValue="0"],
+WPushButton#FxUiButton[displayValue="0"],
 WPushButton#FxToggleButton[displayValue="0"],
 #MicAuxUnit WPushButton[displayValue="0"],
 #MicDuckingContainer WPushButton[displayValue="0"],
@@ -1723,6 +1724,8 @@ QPushButton#pushButtonRecording:checked,
 }
 
 /* Green for Fx toggles, QuickEffect + Fx12 */
+#FxUnit1 #FxUiButton[displayValue="1"],
+#FxUnit2 #FxUiButton[displayValue="1"],
 #FxUnit1 #FxToggleButton[displayValue="1"],
 #FxUnit2 #FxToggleButton[displayValue="1"],
 WPushButton#VinylStatus[displayValue="1"], /* enabled, OK */
@@ -1736,6 +1739,8 @@ WPushButton#VinylStatus[displayValue="1"], /* enabled, OK */
     background-color: #236b00;
   }
 /* Blue for Fx buttons 3/4 */
+#FxUnit3 #FxUiButton[displayValue="1"],
+#FxUnit4 #FxUiButton[displayValue="1"],
 #FxUnit3 #FxToggleButton[displayValue="1"],
 #FxUnit4 #FxToggleButton[displayValue="1"]
 WBeatSpinBox::up-button:pressed,
@@ -2297,6 +2302,13 @@ WPushButton#PlayDeck[value="0"] {
     image: url(skins:LateNight/palemoon/buttons/btn__fx_mixmode_d+w.svg) no-repeat center center;
   }
 
+#FxUiButton[value="0"] {
+  image: url(skins:LateNight/palemoon/buttons/btn__fx_ui.svg) no-repeat center center;
+  }
+  #FxUiButton[value="1"] {
+    image: url(skins:LateNight/palemoon/buttons/btn__fx_ui_active.svg) no-repeat center center;
+  }
+
 #FxToggleButton[value="0"] {
   image: url(skins:LateNight/palemoon/buttons/btn__fx_toggle.svg) no-repeat center center;
   }

src/effects/backends/audiounit/audiouniteffectprocessor.h

@@ -1,15 +1,18 @@
 #pragma once
 
 #import <AVFAudio/AVFAudio.h>
+#import <AppKit/AppKit.h>
 #import <AudioToolbox/AudioToolbox.h>
 #import <CoreAudioTypes/CoreAudioTypes.h>
 
 #include <QList>
 #include <atomic>
+#include <memory>
 
 #include "audio/types.h"
 #include "effects/backends/audiounit/audiounitmanager.h"
 #include "effects/backends/effectprocessor.h"
+#include "effects/dlgeffect.h"
 #include "engine/engine.h"
 
 class AudioUnitEffectGroupState final : public EffectState {
@@ -54,6 +57,8 @@ class AudioUnitEffectProcessor final : public EffectProcessorImpl<AudioUnitEffec
             const EffectEnableState enableState,
             const GroupFeatureState& groupFeatures) override;
 
+    std::unique_ptr<DlgEffect> createUI() override;
+
   private:
     AudioUnitManagerPointer m_pManager;
 

src/effects/backends/audiounit/audiouniteffectprocessor.mm

@@ -1,13 +1,20 @@
 #import <AVFAudio/AVFAudio.h>
+#import <AppKit/AppKit.h>
 #import <AudioToolbox/AudioToolbox.h>
+#import <CoreAudioKit/CoreAudioKit.h>
 #import <CoreAudioTypes/CoreAudioBaseTypes.h>
-#include <CoreAudioTypes/CoreAudioTypes.h>
+#import <CoreAudioTypes/CoreAudioTypes.h>
 
+#include <QLabel>
 #include <QMutex>
+#include <QVBoxLayout>
 #include <QtGlobal>
 #include <algorithm>
+#include <memory>
 
 #include "effects/backends/audiounit/audiouniteffectprocessor.h"
+#include "effects/backends/audiounit/audiounitmanager.h"
+#include "effects/backends/audiounit/dlgaudiounit.h"
 #include "engine/effects/engineeffectparameter.h"
 #include "engine/engine.h"
 #include "util/assert.h"
@@ -251,3 +258,7 @@
         }
     }
 }
+
+std::unique_ptr<DlgEffect> AudioUnitEffectProcessor::createUI() {
+    return std::make_unique<DlgAudioUnit>(m_pManager);
+}

src/effects/backends/audiounit/audiounitmanager.h

@@ -45,6 +45,9 @@ class AudioUnitManager {
     /// the timeout was reached instead.
     bool waitForAudioUnit(int timeoutMs) const;
 
+    /// Fetches the audio unit's name.
+    QString getName() const;
+
   private:
     QString m_name;
     std::atomic<bool> m_isInstantiated;

src/effects/backends/audiounit/audiounitmanager.mm

@@ -145,3 +145,7 @@
     m_audioUnit = audioUnit;
     m_isInstantiated.store(true);
 }
+
+QString AudioUnitManager::getName() const {
+    return m_name;
+}

src/effects/backends/audiounit/audiounitmanifest.mm

@@ -20,6 +20,11 @@
     setDescription(QString::fromNSString([component typeName]));
     setAuthor(QString::fromNSString([component manufacturerName]));
 
+    // All audio units provide a UI (not just if [component hasCustomView] is
+    // set) since they provide a generic fallback UI, which may be useful for
+    // effects with many different parameters.
+    setHasUI(true);
+
     // Instantiate audio unit (out-of-process) to load parameters
     AudioUnitManagerPointer pManager = AudioUnitManager::create(component);
 

src/effects/backends/audiounit/dlgaudiounit.h

@@ -0,0 +1,16 @@
+#pragma once
+
+#include "effects/backends/audiounit/audiounitmanagerpointer.h"
+#include "effects/dlgeffect.h"
+
+/// A dialog hosting the UI of an Audio Unit.
+class DlgAudioUnit : public DlgEffect {
+    Q_OBJECT
+
+  public:
+    DlgAudioUnit(AudioUnitManagerPointer pManager);
+    virtual ~DlgAudioUnit();
+
+  private:
+    id m_resizeObserver;
+};