From 4099b4ed4bfa439a15044818f5238ba4239124b6 Mon Sep 17 00:00:00 2001
From: Matt Firth <matt.firth@bbc.co.uk>
Date: Wed, 11 Oct 2023 16:13:48 +0100
Subject: [PATCH] Routing info tooltip on REAPER <v7 (DS plugin)

---
 .../src/direct_speakers_component.hpp         | 16 ++++++++++--
 .../direct_speakers/src/value_box_main.hpp    | 26 ++++++++++++++++++-
 2 files changed, 39 insertions(+), 3 deletions(-)

diff --git a/ear-production-suite-plugins/plugins/direct_speakers/src/direct_speakers_component.hpp b/ear-production-suite-plugins/plugins/direct_speakers/src/direct_speakers_component.hpp
index 79d910cd9..44aaaa4bc 100644
--- a/ear-production-suite-plugins/plugins/direct_speakers/src/direct_speakers_component.hpp
+++ b/ear-production-suite-plugins/plugins/direct_speakers/src/direct_speakers_component.hpp
@@ -2,6 +2,7 @@
 
 #include "JuceHeader.h"
 
+#include "components/look_and_feel/tooltips.hpp"
 #include "components/ear_combo_box.hpp"
 #include "components/onboarding.hpp"
 #include "components/overlay.hpp"
@@ -42,6 +43,10 @@ class DirectSpeakersComponent : public Component,
         propertiesFileLock(
             std::make_unique<InterProcessLock>("EPS_preferences")),
         propertiesFile(getPropertiesFile(propertiesFileLock.get())) {
+
+    tooltipWindow.setLookAndFeel(&tooltipLookAndFeel);
+    tooltipWindow.setOpaque(false);
+
     header->setText(" Direct Speakers");
 
     onBoardingButton->setButtonText("?");
@@ -68,6 +73,7 @@ class DirectSpeakersComponent : public Component,
     addChildComponent(onBoardingOverlay.get());
 
     //addAndMakeVisible(metadataValueBox.get());
+    mainValueBox->showRoutingTooltip(p->getNumDawChannels() < 128);
     addAndMakeVisible(mainValueBox.get());
     addAndMakeVisible(channelMetersBox.get());
 
@@ -110,8 +116,10 @@ class DirectSpeakersComponent : public Component,
         headingArea.removeFromRight(39).removeFromBottom(39));
     header->setBounds(headingArea);
 
-    auto leftColumn = area.withTrimmedRight(area.getWidth() / 2);
-    auto rightColumn = area.withTrimmedLeft(area.getWidth() / 2);
+    auto leftColumnWidth = area.getWidth() / 2;
+    if (leftColumnWidth < 385) leftColumnWidth = 385;
+    auto leftColumn = area.removeFromLeft(leftColumnWidth);
+    auto rightColumn = area;
 
     // left column
     mainValueBox->setBounds(leftColumn.removeFromTop(223).reduced(5, 5));
@@ -161,6 +169,10 @@ class DirectSpeakersComponent : public Component,
 
  private:
   DirectSpeakersAudioProcessor* p_;
+
+  TooltipWindow tooltipWindow{this};
+  TooltipLookAndFeel tooltipLookAndFeel;
+
   JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(DirectSpeakersComponent)
 };
 
diff --git a/ear-production-suite-plugins/plugins/direct_speakers/src/value_box_main.hpp b/ear-production-suite-plugins/plugins/direct_speakers/src/value_box_main.hpp
index 938d05417..0b3b5cde9 100644
--- a/ear-production-suite-plugins/plugins/direct_speakers/src/value_box_main.hpp
+++ b/ear-production-suite-plugins/plugins/direct_speakers/src/value_box_main.hpp
@@ -20,6 +20,7 @@ class ValueBoxMain : public Component {
         speakerSetupLabel_(std::make_unique<Label>()),
         speakerSetupsComboBox_(std::make_shared<EarComboBox>()),
         routingLabel_(std::make_unique<Label>()),
+        routingInfoIcon_(std::make_unique<ImageComponent>()),
         routingComboBox_(std::make_shared<EarComboBox>()) {
     name_->setLabelText("Object Name");
     name_->setText("Object_1");
@@ -38,6 +39,16 @@ class ValueBoxMain : public Component {
     routingLabel_->setJustificationType(Justification::right);
     addAndMakeVisible(routingLabel_.get());
 
+    routingInfoIcon_->setImage(ImageFileFormat::loadFrom(
+        binary_data::infologo_png, binary_data::infologo_pngSize));
+    routingInfoIcon_->setImagePlacement(RectanglePlacement::centred +
+                                        RectanglePlacement::doNotResize);
+    routingInfoIcon_->setAlpha(0.8);
+    routingInfoIcon_->setMouseCursor(MouseCursor::PointingHandCursor);
+    routingInfoIcon_->setTooltip(
+        "128 channel support requires REAPER v7 or later.");
+    addChildComponent(routingInfoIcon_.get());
+
     routingComboBox_->setDefaultText("Select Scene channel range");
     addAndMakeVisible(routingComboBox_.get());
 
@@ -92,13 +103,25 @@ class ValueBoxMain : public Component {
 
     auto routingArea = area.removeFromTop(rowHeight_);
     auto routingLabelArea = routingArea.withWidth(labelWidth_);
+    routingLabel_->setBounds(routingLabelArea);
+    if (routingInfoIcon_->isVisible()) {
+      auto routingInfoArea = routingArea.removeFromRight(13).withTrimmedTop(
+          1);  // Trimming 1 to get an odd height. Icon is odd height too, so
+               // ensures an integer number of pixels padding top and bottom to
+               // avoid blurring through anti-aliasing.
+      routingInfoIcon_->setBounds(routingInfoArea);
+      routingArea.removeFromRight(marginSmall_);
+    }
     auto routingComboBoxArea =
         routingArea.withTrimmedLeft(labelWidth_ + marginBig_)
             .reduced(0, marginSmall_);
-    routingLabel_->setBounds(routingLabelArea);
     routingComboBox_->setBounds(routingComboBoxArea);
   }
 
+  void showRoutingTooltip(bool visible) {
+    routingInfoIcon_->setVisible(visible);
+  }
+
   std::shared_ptr<EarNameTextEditor> getNameTextEditor() { return name_; }
   std::shared_ptr<ToggleButton> getUseTrackNameCheckbox() { return useTrackNameCheckbox_; }
   std::shared_ptr<EarComboBox> getRoutingComboBox() { return routingComboBox_; }
@@ -119,6 +142,7 @@ class ValueBoxMain : public Component {
   std::shared_ptr<EarComboBox> speakerSetupsComboBox_;
   std::unique_ptr<Label> routingLabel_;
   std::shared_ptr<EarComboBox> routingComboBox_;
+  std::shared_ptr<ImageComponent> routingInfoIcon_;
   std::shared_ptr<ToggleButton> useTrackNameCheckbox_;
 
   JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(ValueBoxMain)