V1.1 feature branches combined

CHANGELOG.md

@@ -1,3 +1,15 @@
+Version 1.1.0
+
+* Support for 128 channels when using REAPER >=v7.0 [#244](https://github.com/ebu/ear-production-suite/issues/244) [#254](https://github.com/ebu/ear-production-suite/pull/254) [#267](https://github.com/ebu/ear-production-suite/pull/267)
+* Improve import support from third-party tools [#259](https://github.com/ebu/ear-production-suite/pull/259)
+* Support HRTF switching in Binaural Monitoring plugin [#266](https://github.com/ebu/ear-production-suite/pull/266)
+* Fix monitoring plugins not properly supporting shared inputs [#257](https://github.com/ebu/ear-production-suite/issues/257) [#258](https://github.com/ebu/ear-production-suite/pull/258)
+* Apply "version" attribute to ADM as required by ITU-R BS.2076-2 [#248](https://github.com/ebu/ear-production-suite/issues/248) [#255](https://github.com/ebu/ear-production-suite/pull/255)
+* Performance fix for envelope creation [#252](https://github.com/ebu/ear-production-suite/pull/252) 
+* Update BW64 lib for performance fixes [#260](https://github.com/ebu/ear-production-suite/issues/260)
+* Allow user to opt-out of update-checking during setup [#256](https://github.com/ebu/ear-production-suite/pull/256)
+* Warn user of impending FB360 and VISR support deprecation since these plugin suites are no longer maintained [#265](https://github.com/ebu/ear-production-suite/pull/265)
+
 Version 1.0.0
 
 * Setup Application included

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.14)
-set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)

COPYRIGHT.TXT

@@ -1,6 +1,6 @@
 The content of this repository is
 
-Copyright (C) 2019-2023 British Broadcasting Corporation (BBC)
+Copyright (C) 2019-2024 British Broadcasting Corporation (BBC)
 Copyright (C) 2020-2021 European Broadcasting Union (EBU)
 Copyright (C) 2019-2021 Institut für Rundfunktechnik GmbH (IRT)
 

ear-production-suite-plugins/lib/CMakeLists.txt

@@ -52,7 +52,8 @@ set(EAR_BASE_SOURCES
   src/communication/metadata_thread.cpp
   src/pending_store.cpp
   src/auto_mode_controller.cpp
-  ${EPS_SHARED_DIR}/helper/common_definition_helper.cpp
+  ${EPS_SHARED_DIR}/helper/adm_preset_definitions_helper.cpp
+  ${EPS_SHARED_DIR}/helper/cartesianspeakerlayouts.cpp
   ${EAR_PROTO_SRC} src/restored_pending_store.cpp
   )
 
@@ -133,6 +134,7 @@ set(EAR_BASE_HEADERS
 	include/auto_mode_controller.hpp
 	include/reaper_integration.hpp
 	include/reaper_vst3_interfaces.h
+	${EPS_SHARED_DIR}/helper/adm_preset_definitions_helper.h
 	${EPS_SHARED_DIR}/helper/container_helpers.hpp
 	${EPS_SHARED_DIR}/speaker_setups.hpp
 	)

ear-production-suite-plugins/lib/include/binaural_monitoring_audio_processor.hpp

@@ -1,6 +1,7 @@
 #pragma once
 
 #include <vector>
+#include <string>
 #include <../src/dynamic_renderer.hpp>
 #include "variable_block_adapter.hpp"
 #include <chrono>
@@ -9,6 +10,20 @@
 namespace ear {
 namespace plugin {
 
+enum BearStatusStates {
+  NOT_ATTEMPTED = 0,
+  FAILED,
+  SUCCEEDED
+};
+
+struct BearStatus {
+  bear::Config startupConfig;
+  BearStatusStates startupSuccess{NOT_ATTEMPTED};
+  std::string startupErrorDesc;
+  BearStatusStates listenerDataSetSuccess{NOT_ATTEMPTED};
+  std::string listenerDataSetErrorDesc;
+};
+
 /**
  * @brief Binaural monitoring plugin dsp implementation
  *
@@ -47,6 +62,8 @@ class BinauralMonitoringAudioProcessor {
   BinauralMonitoringAudioProcessor& operator=(
       BinauralMonitoringAudioProcessor&&) = delete;
 
+  BearStatus getBearStatus() { return bearStatus; }
+
   template <typename InBuffer, typename OutBuffer>
   void process(const InBuffer& in, OutBuffer& out) {
     using InTraits = BufferTraits<InBuffer>;
@@ -67,7 +84,7 @@ class BinauralMonitoringAudioProcessor {
   void setListenerOrientation(float quatW, float quatX, float quatY,
                               float quatZ);
 
-  bool rendererError() { return !bearRenderer; }
+  bool rendererStarted() { return bearRenderer && bearStatus.startupSuccess == SUCCEEDED; }
 
   void setIsPlaying(bool state) { isPlaying = state; }
   bool getIsPlaying() { return isPlaying; }
@@ -84,6 +101,7 @@ class BinauralMonitoringAudioProcessor {
   std::shared_ptr<bear::DynamicRenderer> bearRenderer;  // TODO - why shared?
   std::mutex bearListenerMutex_;
   bear::Listener bearListener;
+  BearStatus bearStatus;
 
   bool listenerQuatsDirty{false};
   std::array<double, 4> listenerQuats{1.0, 0.0, 0.0, 0.0};

ear-production-suite-plugins/lib/include/binaural_monitoring_backend.hpp

@@ -6,7 +6,6 @@
 #include "ear-plugin-base/export.h"
 #include "scene_gains_calculator.hpp"
 #include "listener_orientation.hpp"
-#include "helper/common_definition_helper.h"
 
 #include <string>
 #include <memory>
@@ -103,9 +102,6 @@ class BinauralMonitoringBackend {
   std::unique_ptr<communication::MonitoringMetadataReceiver> metadataReceiver_;
   communication::MonitoringControlConnection controlConnection_;
 
-  std::mutex commonDefinitionHelperMutex_;
-  AdmCommonDefinitionHelper commonDefinitionHelper{};
-
   bool isExporting_{ false };
 };
 

ear-production-suite-plugins/lib/include/communication/direct_speakers_metadata_sender.hpp

@@ -23,7 +23,7 @@ class DirectSpeakersMetadataSender {
   void name(const std::string& value);
   void inputInstanceId(int value);
   void colour(int value);
-  void speakerSetupIndex(int value);
+  void packFormatIdValue(int value);
 
   ConnectionId getConnectionId() { return sender_.connectionId(); }
 

ear-production-suite-plugins/lib/include/helper/eps_to_ear_metadata_converter.hpp

@@ -1,7 +1,10 @@
 #pragma once
 
 #include "helper/protobuf_utilities.hpp"
-#include "helper/common_definition_helper.h"
+#include "helper/adm_preset_definitions_helper.h"
+#include <string>
+#include <memory>
+#include <adm/detail/id_parser.hpp>
 
 namespace ear {
 namespace plugin {
@@ -26,12 +29,16 @@ struct EpsToEarMetadataConverter {
 
   static std::vector<ear::DirectSpeakersTypeMetadata> convert(
       const proto::DirectSpeakersTypeMetadata &epsMetadata) {
-    auto packFormatId =
-        proto::SpeakerLayoutTranslator::proto2ear(epsMetadata.layout());
+
+    adm::AudioPackFormatId audioPackFormatID(
+        adm::TypeDefinition::DIRECT_SPEAKERS,
+        adm::AudioPackFormatIdValue(epsMetadata.packformatidvalue()));
+    auto audioPackFormatIDstr = adm::formatId(audioPackFormatID);
+
     std::vector<ear::DirectSpeakersTypeMetadata> earMetadata;
     for (auto epsSpeaker : epsMetadata.speakers()) {
       ear::DirectSpeakersTypeMetadata earSpeaker;
-      earSpeaker.audioPackFormatID = packFormatId;
+      earSpeaker.audioPackFormatID = audioPackFormatIDstr;
       earSpeaker.position = ear::PolarSpeakerPosition(
           epsSpeaker.position().azimuth(), epsSpeaker.position().elevation(),
           epsSpeaker.position().distance());
@@ -48,11 +55,9 @@ struct EpsToEarMetadataConverter {
     return earMetadata;
   }
   static ear::HOATypeMetadata convert(
-      const proto::HoaTypeMetadata &epsMetadata,
-      AdmCommonDefinitionHelper &commonDefinitionHelper) {
-    auto pfData = commonDefinitionHelper.getPackFormatData(
+      const proto::HoaTypeMetadata &epsMetadata) {
+    auto pfData = AdmPresetDefinitionsHelper::getSingleton().getPackFormatData(
         4, epsMetadata.packformatidvalue());
-
     ear::HOATypeMetadata earMetadata;
 
     if (pfData) {

ear-production-suite-plugins/lib/include/helper/protobuf_utilities.hpp

@@ -1,37 +1,13 @@
 #pragma once
 
-#include <map>
 #include "type_metadata.pb.h"
-#include <speaker_setups.hpp>
 
 namespace ear {
 namespace plugin {
 namespace proto {
 
-class SpeakerLayoutTranslator {
- public:
-  static std::string proto2ear(const SpeakerLayout& layout);
-  static SpeakerLayout ear2proto(const std::string& layout);
-
- private:
-  static std::map<SpeakerLayout, std::string> SpeakerLayoutProtoToEarLUT_;
-  static std::map<std::string, SpeakerLayout> SpeakerLayoutEarToProtoLUT_;
-};
-
-inline proto::DirectSpeakersTypeMetadata* convertSpeakerSetupToEpsMetadata(
-    int setupIndex) {
-  auto ds_metadata = new proto::DirectSpeakersTypeMetadata();
-
-  ds_metadata->set_layout(proto::SpeakerLayout(setupIndex));
-  for (auto speaker : speakerSetupByIndex(setupIndex).speakers) {
-    auto newSpeaker = ds_metadata->add_speakers();
-    newSpeaker->set_is_lfe(speaker.isLfe);
-    newSpeaker->add_labels(speaker.label);
-    newSpeaker->mutable_position()->set_azimuth(speaker.azimuth);
-    newSpeaker->mutable_position()->set_elevation(speaker.elevation);
-  }
-  return ds_metadata;
-}
+proto::DirectSpeakersTypeMetadata* convertPackFormatToEpsMetadata(
+    int packFormatIdValue);
 
 }  // namespace proto
 }  // namespace plugin

ear-production-suite-plugins/lib/include/programme_store_adm_serializer.hpp

@@ -7,7 +7,6 @@
 #include <bw64/bw64.hpp>
 #include <vector>
 #include <map>
-#include <helper/common_definition_helper.h>
 
 namespace ear {
 namespace plugin {
@@ -49,8 +48,6 @@ class ProgrammeStoreAdmSerializer {
   void setInteractivity(adm::AudioObject& object, const proto::Object& object1);
   void setImportance(adm::AudioObject& object, const proto::Object& object1);
   bool isSerializedWithDifferentObjectSettings(const proto::Object& object);
-
-  AdmCommonDefinitionHelper admCommonDefinitionHelper;
 };
 
 }  // namespace plugin

ear-production-suite-plugins/lib/include/scene_gains_calculator.hpp

@@ -9,7 +9,6 @@
 #include <map>
 #include <string>
 #include <vector>
-#include "helper/common_definition_helper.h"
 
 namespace ear {
 namespace plugin {
@@ -44,9 +43,6 @@ class SceneGainsCalculator {
   ear::GainCalculatorHOA hoaCalculator_;
 
   std::map<communication::ConnectionId, ItemGains> routingCache_;
-
-  std::mutex commonDefinitionHelperMutex_;
-  AdmCommonDefinitionHelper commonDefinitionHelper_{};
 };
 
 }  // namespace plugin

ear-production-suite-plugins/lib/messages/type_metadata.proto

@@ -4,33 +4,6 @@ package ear.plugin.proto;
 
 import "common_types.proto";
 
-// XXX: the numbers directly correspond to the indicies in the speaker layout  combobox
-enum SpeakerLayout {
-  ITU_BS_2051_UNKNOWN = -1;
-  ITU_BS_2051_0_1_0 = 0;
-  ITU_BS_2051_0_2_0 = 1;
-  ITU_BS_755_0_3_0 = 2;
-  ITU_BS_755_0_4_0 = 3;
-  ITU_BS_2051_0_5_0_NO_LFE = 4;
-  ITU_BS_2051_0_5_0 = 5;
-  ITU_BS_2051_0_6_0 = 6;
-  ITU_BS_2094_0_7_0_FRONT = 7;
-  ITU_BS_2051_0_7_0_BACK = 8;
-  ITU_BS_2051_2_5_0 = 9;
-  ITU_BS_2094_0_7_0_SIDE = 10;
-  ITU_BS_2094_2_5_0 = 11;
-  ITU_BS_2094_2_7_0_SCREEN = 12;
-  ITU_BS_2094_2_7_0 = 13;
-  ITU_BS_2051_4_5_0 = 14;
-  ITU_BS_2051_4_5_1 = 15;
-  ITU_BS_2051_3_7_0 = 16;
-  ITU_BS_2094_4_7_0 = 17;
-  ITU_BS_2051_4_7_0 = 18;
-  ITU_BS_2051_4_9_0 = 19;
-  ITU_BS_2051_9_10_3 = 20;
-  ITU_BS_2094_9_9_0 = 21;
-}
-
 message Speaker {
   optional int32 id = 1 [default = 0];
   repeated string labels = 2;
@@ -40,7 +13,7 @@ message Speaker {
 }
 
 message DirectSpeakersTypeMetadata {
-  optional SpeakerLayout layout = 1 [default = ITU_BS_2051_UNKNOWN];
+  optional int32 packFormatIdValue = 1 [default = 0];
   repeated Speaker speakers = 2;
 }
 

ear-production-suite-plugins/lib/src/binaural_monitoring_audio_processor.cpp

@@ -37,19 +37,25 @@ BinauralMonitoringAudioProcessor::BinauralMonitoringAudioProcessor(
 
   bearListener.set_position_cart(std::array<double, 3>{0.0, 0.0, 0.0});
 
+  bearStatus.startupConfig = bearConfig;
   try {
     bearRenderer = std::make_shared<bear::DynamicRenderer>(
         blockSize,
         std::max(std::max(maxObjChannels, maxDsChannels), maxHoaChannels));
+    bearRenderer->set_config_blocking(bearConfig);
+    bearStatus.startupSuccess = BearStatusStates::SUCCEEDED;
     try {
       bearRenderer->set_listener(bearListener);
+      bearStatus.listenerDataSetSuccess = BearStatusStates::SUCCEEDED;
     } catch (std::exception &e) {
+      bearStatus.listenerDataSetSuccess = BearStatusStates::FAILED;
+      bearStatus.listenerDataSetErrorDesc = e.what();
       bearRenderer.reset();
-      assert(false);
     }
   } catch (std::exception &e) {
+    bearStatus.startupSuccess = BearStatusStates::FAILED;
+    bearStatus.startupErrorDesc = e.what();
     bearRenderer.reset();
-    assert(false);
   }
 }
 
@@ -218,6 +224,7 @@ bool BinauralMonitoringAudioProcessor::updateChannelCounts(
     // Do immediate update
     bearRenderer->set_config_blocking(bearConfig);
   }
+  return true;
 }
 
 }  // namespace plugin

ear-production-suite-plugins/lib/src/binaural_monitoring_backend.cpp

@@ -38,9 +38,6 @@ BinauralMonitoringBackend::BinauralMonitoringBackend(
   activeObjectIds.reserve(inputChannelCount);
   activeHoaIds.reserve(inputChannelCount);
 
-  commonDefinitionHelper
-      .getElementRelationships();  // Save doing it later in time-critical calls
-
   allActiveIds.reserve(inputChannelCount);
 
   controlConnection_.logger(logger_);
@@ -153,15 +150,12 @@ BinauralMonitoringBackend::getLatestHoaTypeMetadata(ConnId id) {
   if (!epsMD || !epsMD->has_hoa_metadata()) {
     return std::optional<HoaEarMetadataAndRouting>();
   }
-  {
-    std::lock_guard<std::mutex> lock(commonDefinitionHelperMutex_);
-    setInMap<ConnId, HoaEarMetadataAndRouting>(
-        latestHoaTypeMetadata, id,
-        HoaEarMetadataAndRouting{
-            epsMD->has_routing() ? epsMD->routing() : -1,
-            EpsToEarMetadataConverter::convert(epsMD->hoa_metadata(),
-                                               commonDefinitionHelper)});
-  }
+
+  setInMap<ConnId, HoaEarMetadataAndRouting>(
+      latestHoaTypeMetadata, id,
+      HoaEarMetadataAndRouting{
+          epsMD->has_routing() ? epsMD->routing() : -1,
+          EpsToEarMetadataConverter::convert(epsMD->hoa_metadata())});
 
   earMD = getValuePointerFromMap<ConnId, HoaEarMetadataAndRouting>(
       latestHoaTypeMetadata, id);
@@ -229,15 +223,14 @@ void BinauralMonitoringBackend::onSceneReceived(proto::SceneStore store) {
     }
     if (item.has_hoa_metadata()) {
       auto hoaId = item.hoa_metadata().packformatidvalue();
-      {
-        std::lock_guard<std::mutex> lock(commonDefinitionHelperMutex_);
-        // TODO: May need to revisit later -
-        //       this is a high-frequency call but may be slow to to execute
-        auto pfData = commonDefinitionHelper.getPackFormatData(4, hoaId);
-        if (pfData) {
-          auto cfCount = pfData->relatedChannelFormats.size();
-          totalHoaChannels += cfCount;
-        }
+      // TODO: May need to revisit later -
+      //       this is a high-frequency call but may be slow to to execute
+      auto pfData =
+          AdmPresetDefinitionsHelper::getSingleton().getPackFormatData(4,
+                                                                       hoaId);
+      if (pfData) {
+        auto cfCount = pfData->relatedChannelFormats.size();
+        totalHoaChannels += cfCount;
       }
     }
   }

ear-production-suite-plugins/lib/src/communication/direct_speakers_metadata_sender.cpp

@@ -39,10 +39,10 @@ void DirectSpeakersMetadataSender::inputInstanceId(int value)
 void DirectSpeakersMetadataSender::colour(int value) {
   setData([value](auto data) { data->set_colour(value); });
 }
-void DirectSpeakersMetadataSender::speakerSetupIndex(int value) {
+void DirectSpeakersMetadataSender::packFormatIdValue(int value) {
   setData([value](auto data) {
     data->set_allocated_ds_metadata(
-        proto::convertSpeakerSetupToEpsMetadata(value));
+        proto::convertPackFormatToEpsMetadata(value));
   });
 }