Improve ADM import support from 3rd party tools

[firthm01]

Need to be able to support supplementary packformats within the software for DS layouts.

• Factor out the remaining code which uses the fixed speaker layout list and references them by index
  • Use a PF ID thoughout to improve robustness and maintainability
  • Can use the common definition helper class to provide the info required to replace this. Follow a similar workflow as the HOA plugin. This doesn't have fixed options - it uses the common definition helper to query available HOA configs. Use a similar process to work out supported speaker layouts
• Turn the common definition helper in to a more generic "preset definitions" helper which supports the common definitions as well as any other supplementary definitions we want to stick in there
  • Figure out and add the necessary PF/CF definitions to support import of ADM from third-party tools
• Update import code - currently it will only look for packformats by their ID. Third-party tools don't use consistent IDs for custom PFs - need to match by contained CFs instead
• Update export code - currently it expects all non-Obj types to use common defs. This means it cuts out a whole load of ADM authoring work (I.e, from PF down). All that will need implementing for non-common-def DS audioobjects

[firthm01]

Force push was for rebase (CI fixes on base branch)

[firthm01]

Force push was for rebase (since other PRs now on main)

[firthm01]

Code review notes;

The EPS already had a helper class for querying common definitions (AdmCommonDefinitionHelper) which would be extended to support additional "supplementary" definitions too.

AdmCommonDefinitionHelper was used mainly by the HOA plugin to populate available configurations in the user interface and pass the selected configuration throughout the rest of the suite by it's AudioPackFormatIDValue. This was quite a neat solution as it avoided the need for hard-coded configurations and would allow the EPS to support new common definitions without any major changes if any more are added at a later date. By passing an AudioPackFormatIDValue around, we also avoid the potential pitfalls and bugs of using an index to refer to a particular configuration.

The DS plugin did not use this workflow as it was developed before the HOA plugin (and therefore the AdmCommonDefinitionHelper) was implemented. The DS plugin used hard-coded layouts (speaker_layouts.hpp), as did the extension, Scene plugin, and Monitoring plugins. These hard-coded layouts were stripped out and the rest of the code modified to make use of AdmCommonDefinitionHelper in place of it.

Since The AdmCommonDefinitionHelper class was to be extended to support supplementary definitions on top of the common definitions, it was eventually renamed AdmPresetDefinitionsHelper. It was also improved to provide more information on definitions and more functionality as required.

---

Stripping out hard-coded layouts: https://github.com/ebu/ear-production-suite/compare/ff1c4d8ec03976abb626ddf75205159ac66085b2%5E...95e83e8764661ea9b85627c838b634d5960dff1a

• EPS <v0.7.0 stored the selected DS speaker layout by index, so we still needed some method to get the appropriate AudioPackFormatIDValue for a given index to support older saved projects - this is getPackFormatIdValueFromLegacySpeakerSetupsIndex.
• The original SpeakerLayout structs provided position, speaker label and LFE information for UI, so the AdmCommonDefinitionHelper was adapted to pull this info too
• protobuf_utilities.cpp/hpp provided code to do speaker layout lookups for (de)serialisation which would no longer be required and so they were removed. We will pass the AudioPackFormatIDValue using protobuf, as we do with HOA.
  • Note we still make use of the protobuf messages DirectSpeakersTypeMetadata::Speaker array to list the speakers in the pack format. Although a lookup could be done from the AudioPackFormatIDValue at the receiving end, leaving this in at the transmitting end allows us to support user-customised layouts in future if we want. Q: Should we just accept user-customisable layouts will never happen so simplify the code now?
• PluginSuites updated to use AdmCommonDefinitionHelper instead of the SpeakerLayout structs (used during import).
• ProgrammeStoreAdmSerializer updated to use AdmCommonDefinitionHelper instead of the SpeakerLayout structs (used during export).
• DS UI updated to use AdmCommonDefinitionHelper to populate meters and speaker positions. Frontend Connector passes around int representing AudioPackFormatIDValue rather than SpeakerSetup indexes.
• Monitoring UIs updated to use AdmCommonDefinitionHelper to populate meters.
• Scene plugin updated to use AdmCommonDefinitionHelper to pull info for DS items.
• Tests updated to use AdmCommonDefinitionHelper instead of the SpeakerLayout structs.

---

AdmCommonDefinitionHelper improvements: https://github.com/ebu/ear-production-suite/compare/4d952eb97a60544d2fc7ac794fbdf4168450ce38%5E...ad7383f0f4eb06cece07acb6ca1728cdc479009d

• Making nice names from ITU URN-style Speaker Labels
• Putting structs in to self-managing classes
• The old hard-coded layouts made it easy to define nice labels for speakers. This has been replaced with a Map. For a given AudioChannelFormatID, you can define a default speaker label. Sometimes the speaker label to use for a given AudioChannelFormat depends upon the AudioPackFormat it has been referenced from (usually due to the differing naming conventions of the standards that the AudioPackFormats have been derived from.) Therefore, you can also specify exceptions to the default label in this map.

---

Rename AdmCommonDefinitionHelper to AdmPresetDefinitionsHelper: https://github.com/ebu/ear-production-suite/pull/259/commits/3cf3a4ca68dbac1fb71edc5afb33c67f053c599d

---

DS UI Speaker Labelling improvements: https://github.com/ebu/ear-production-suite/compare/44a7ce5e151351f62113e4b95e4d99f098f89781%5E...c7c83a65a44e1a97947e4ba746265733db21ffa0

• General tidying of existing code
• The new supplementary definitions would include some layouts with speakers very close to each other, causing label overlap in the UI, so; -- Better spacing of UI elements and graphics in speaker views -- Logic to decide whether a label should be placed on the inside or outside of the ring of speakers based on how close it is to other speakers. Labels "nudged" to make it more obvious which dot on the ring they're labelling.

---

Import supplementary definitions in to AdmPresetDefinitionsHelper (Part 1): https://github.com/ebu/ear-production-suite/compare/2732d3be7b5424b265e75a8a301a0d768d502d2e%5E...7afabb01de98bc971754b7b18999ab3618ebee81

• Stored in a seperate header
• Funcs to differentiate between common and non-common defs - made all existing code use these funcs rather than the multiple impls of this same check all over the place.
• Use singleton rather than seperate instances
• getPackFormatDataByMatchingChannels so we can find a matching PF in AdmPresetDefinitionsHelper from a set of CF's (e.g, during import). This is because third-party tools don't use consistent ID's for thier custom PFs, so we must match by contained CFs
• getBestSpeakerLabel func so we don't have to do checks elsewhere in code
• cartesianspeakerlayouts.h/cpp moved to shared helpers dir and used within AdmPresetDefinitionsHelper to find an appropriate PF in the presets from a give PF on import. This consolidates all of the "maybe common def, maybe cart layout, maybe custom def without consistent id" checks in one place

---

Support supplementary definitions in Plugin Suites: https://github.com/ebu/ear-production-suite/compare/37f66b3860d2289a864c8add572db2bfcce985bf%5E...37f66b3860d2289a864c8add572db2bfcce985bf

• Mainly just correction of terminology
• We don't need to do the isCommonDefinition checks in FB360. If it's in AdmPresetDefinitionsHelper, we can support it.

---

Export support: https://github.com/ebu/ear-production-suite/compare/4b248ab915e5d83843356931f846a21cd0e263b2%5E...1d9a66f1a67d4edb32b2e60ee968d4f38b59ca09

• Simplification/refactoring of the serializer helpers and move to within AdmPresetDefinitionsHelper
• Function to copy ADM element trees for non-common defs from AdmPresetDefinitionsHelper in to a target document. This is then called via the serialiser code.
• EarVstExportSources checks if preset def, rather than common def.
• Update ADM Export Source export code to use 2076-2 structures too

---

Import supplementary definitions in to AdmPresetDefinitionsHelper (Part 2): https://github.com/ebu/ear-production-suite/compare/4e01fbd1697e21ecb369379f67f9d1f5e1939f7d%5E...a09c793b92f3e7b7b2cf0de2f46735ba686d9bb7

• Two of the custom PF's from third-party tools use custom CF's (all of the others are custom PF's containing only common def CF's). These custom CF's also do not have consistent ID's. Therefore we can't necessarily match PF's by the ID's of their contained CF's. If there are custom CF's (which we know they are custom by the ID > 0xFFFF) the CF's should be matched to CF's in the preset definitions by matching their properties.
• Call reassignId's on final doc - neatens up XML output and makes easier to follow
• (note, two unrelated minor fix commits in this range(12da... and 8056...)

---

UI bits: https://github.com/ebu/ear-production-suite/compare/3810fc97e9fb2b145c79a47fe0dadf5fcd73b93d%5E...8eba33e915a0246b56c3e7975b0bd1b1d6fd0c58

• UI's to prioritise Common Def options over custom defs. Common defs to top of list and in bold font. All defs ordered by channel count.