Update versions, readmes, etc

ebu · Feb 8, 2023 · 458860a · 458860a
1 parent c844111
commit 458860a
Show file tree

Hide file tree

Showing 4 changed files with 89 additions and 56 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,19 @@
+Version 1.0.0
+
+* Setup Application included
+* Support for ADM "Importance" parameter
+* Fix bug in render dialog when using language packs [#215](https://github.com/ebu/ear-production-suite/issues/215)
+* Experimental Linux build [#222](https://github.com/ebu/ear-production-suite/pull/222)
+* Silence unused monitoring output channels (prevents pass-through of object audio) [#224](https://github.com/ebu/ear-production-suite/issues/224)
+* Fix alignment of monitoring meters [#206](https://github.com/ebu/ear-production-suite/issues/206)
+* Fix blank audioProgrammeLanguage on export [#213](https://github.com/ebu/ear-production-suite/issues/213)
+* Export uses 2076-2 structures (omitting AudioTrackFormat and AudioStreamFormat)
+* MacOS build fixes [#220](https://github.com/ebu/ear-production-suite/issues/220) [#221](https://github.com/ebu/ear-production-suite/issues/221)
+* Include additional project templates
+* Fix bus config when Input plug-ins on wide track [#228](https://github.com/ebu/ear-production-suite/issues/228)
+* Fix Size param not updating [#229](https://github.com/ebu/ear-production-suite/issues/229)
+* Fix plugin crash on other DAWs [#232](https://github.com/ebu/ear-production-suite/issues/232)
+
 Version 0.8.0
 
 * Support custom object names rather than using track names [#214](https://github.com/ebu/ear-production-suite/pull/214)

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -4,7 +4,7 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
-set(EPS_VERSION_BASE 0.8.0) # This is used as fallback if getting from git fails. Must be only numeric.
+set(EPS_VERSION_BASE 1.0.0) # This is used as fallback if getting from git fails. Must be only numeric.
 # NOTE: also update hard-coded version number in
 # - vcpkg.json
 

diff --git a/packaging/README.md.in b/packaging/README.md.in
@@ -1,24 +1,27 @@
-# EAR Production Suite (Beta 0.8.0 release)
+# EAR Production Suite (1.0.0 release)
 
-The latest builds are available under [Releases](https://github.com/ebu/ear-production-suite/releases).
-Please download the files from there. The EAR Production Suite (EPS) download bundle comprises of multiple components:
+The latest builds are available under [GitHub Releases](https://github.com/ebu/ear-production-suite/releases) or from the [EAR Production Suite website.](https://ear-production-suite.ebu.io/)
+Please download the files from there. The EAR Production Suite (EPS) download package comprises of multiple components:
 
 - EPS VST® Plugins
 - EPS REAPER Extension
 - ADM Export Source VST® Plugin
-- REAPER session template
+- REAPER project templates
+- Project Upgrade Utility for REAPER projects created with EPS v0.6.0 beta
+- Setup application
 
 ## Release notes
-0.8.0 introduces support for sharing of audio assets between objects on import, during authoring, and in exports. Audio Objects which use the same underlying audio can be represented by simply placing multiple input plugins with matching "Routing" parameter settings on one track. Additionally, support for custom object names is provided, rather than always using the track name.
-
-0.8.0 also includes various bug fixes. Please see detailed changelog below.
+1.0.0 is the first public non-beta release of the EAR Production Suite.
+This release includes a Setup application for ease of installation/uninstallation and an experimental Linux build. It also includes various bug fixes. Please see detailed changelog below.
 
 ### Known issues
-Please note that the EPS currently outputs ADM using egocentric, polar coordinates and conforming to the [EBU Broadcast Production Profile](https://tech.ebu.ch/publications/tech3392).
-While the EPS can import files that have been authored using the [Dolby Atmos ADM](https://professionalsupport.dolby.com/s/article/Dolby-Atmos-ADM-Profile-specification?language=en_US) profile, coordinates and directspeakers pack formats are converted on import and exported files will no longer conform to this profile.
+Please note that the EPS exports ADM using egocentric, polar coordinates and conforming to the [EBU Broadcast Production Profile](https://tech.ebu.ch/publications/tech3392).
+It is very tolerant in the ADM it will import meaning it can import files that conform to other profiles.
+ADM authored using the [Dolby Atmos ADM](https://professionalsupport.dolby.com/s/article/Dolby-Atmos-ADM-Profile-specification?language=en_US) profile can be imported, but coordinates and directspeakers pack formats are converted on import and exported files will instead conform to the Production Profile.
+To import Production Profile ADM in to third-party tools which do not support this profile, the ADM must be converted. BBC R&D along with the EBU have developed the [EBU ADM Toolkit]() to assist with this task.  
 
-To fix a problem using the plugins with some hosts, the ID for all plugins changed with the 0.7.0 release.
-This change will break any projects that use the 0.6.0 plugins. See tools/upgrade_project to upgrade existing REAPER projects.
+To fix a problem using the plugins with some hosts, the ID for all plugins changed with the 0.7.0 release. This change will break any REAPER projects created using the 0.6.0 plugins. 
+Please use the Project Upgrade Utility to convert these. There is a command-line tool available in the `Tools` directory of the download package, and a GUI tool available either in the download package or via the `Extensions > Browse tools and templates...` menu option in REAPER once the EPS is installed.
 
 For an up-to-date list of known issues, please refer to [GitHub](https://github.com/ebu/ear-production-suite/issues)
 
@@ -27,62 +30,77 @@ For an up-to-date list of known issues, please refer to [GitHub](https://github.
 @CHANGELOG@
 
 ### 0.6.0
-* Initial release
+* Initial beta release
 
 ## Installation
 
-The EPS is designed for REAPER 64-bit, on a 64-bit OS (macOS or Windows)
+The EPS is designed for REAPER 64-bit, on a 64-bit OS (macOS, Windows or Linux (experimental))
+
+### Automatic Installation
+
+For MacOS or Windows, the easiest way to install the software is to use the included Setup application.
+
+1. Install REAPER from https://www.reaper.fm/download.php if you don't already have it.
+2. Extract the release package (Windows only - Mac will install directly from the DMG).
+3. Ensure REAPER is not running.
+4. Run the `Setup EAR Production Suite` application in the package and follow on-screen instructions.
 
-1. Install REAPER from https://www.reaper.fm/download.php
-2. Copy / install the **VST plugins** into your common VST folder. 
-    - Windows: `C:\Program Files\Common Files\VST3`
-    - macOS: `~/Library/Audio/Plug-Ins/VST3`
-3. Open REAPER and go to Options -> Preferences -> Plug-Ins -> VST and click Rescan
-4. Copy / install REAPER ADM **Extension** into the REAPER plugins folder. Ensure you include the ADMPresets subdirectory.
-    - Windows: `C:\Users\(username)\AppData\Roaming\REAPER\UserPlugins`
+### Manual Installation
+
+You may install the EPS manually if you prefer (note that this is the only option for Linux currently).
+
+1. Install REAPER from https://www.reaper.fm/download.php if you don't already have it.
+2. Ensure REAPER is not running.
+3. From the release package, copy the **VST plugins** from the `VST` directory of the package into your common VST folder. 
+    - Windows: `C:\Program Files\Common Files\VST3\`
+    - macOS: `~/Library/Audio/Plug-Ins/VST3/`
+	- Linux: `~/.vst3/`
+4. From the release package, copy the REAPER ADM **Extension** into the REAPER UserPlugins folder. Ensure you include the ADMPresets subdirectory.
+    - Windows: `C:\Users\(username)\AppData\Roaming\REAPER\UserPlugins\`
           Note: If you have a previous version of the REAPER Extension installed to `C:\Program Files\REAPER (x64)\Plugins\reaper_adm.dll`, then this should be deleted on installation of the latest version.
-    - macOS: `~/Library/Application Support/REAPER/UserPlugins`
-5. Restart REAPER
-6. You should see a new menu option **File -> Create Project from ADM file** now.
-If you don't see this option and you are using Windows, it might be necessary to download and install the [Visual C++ 2015 redistributable](https://support.microsoft.com/en-gb/help/2977003/the-latest-supported-visual-c-downloads) ("vc_redist.x64.exe") from Microsoft.
-
-On macOS Catalina or above you may experience plugin load errors due to the new Gatekeeper feature.
-You can disable Gatekeeper globally as per [this site](https://cronotek.net/blog/how-to-disable-gatekeeper-on-macos-mojave-and-catalina)
-using this command:
-
-```bash
-sudo spctl --master-disable 
-```
-
-You can also manually validate the files after install with
-```bash
-sudo xattr -rd com.apple.quarantine \
-~/Library/Application\ Support/REAPER/UserPlugins/reaper_adm.dylib \
-~/Library/Audio/Plug-Ins/VST3/ADM\ Export\ Source.vst3 \
-~/Library/Audio/Plug-Ins/VST3/ear-production-suite/
-```
-Substituting paths as needed if you have not installed to the default locations.
+    - macOS: `~/Library/Application Support/REAPER/UserPlugins/`
+	- Linux: `~/.config/REAPER/`
+5. (Optional) From the release package, copy the **Tools** and **Templates** directories of the package into an `EAR Production Suite extras` subfolder of your REAPER UserPlugins folder. This is the folder used by the "Browse tools and templates..." function of the EPS.
+    - Windows: `C:\Users\(username)\AppData\Roaming\REAPER\EAR Production Suite extras\`
+    - macOS: `~/Library/Application Support/REAPER/UserPlugins/EAR Production Suite extras/`
+	- Linux: `~/.config/REAPER/EAR Production Suite extras/`
+
+### Confirming Installation and Troubleshooting
+
+#### REAPER Extension
+
+Open REAPER and select "Extensions" from the menu bar. Under this menu should be a new option labelled "EAR Production Suite". This confirms that the extension was installed and loaded successfully. 
+Check the version number of the extension by going to "Extensions > EAR Production Suite > About EAR Production Suite".
+
+If the extension is not present and you are using Windows, it might be necessary to download and install the [Visual C++ redistributable](https://support.microsoft.com/en-gb/help/2977003/the-latest-supported-visual-c-downloads) ("vc_redist.x64.exe") from Microsoft.
+
+#### VST Plug-ins
+
+Open REAPER and select a blank FX slot on a track to open the plugin selection dialog. The EAR Production Suite plugins should now be listed in the dialog. 
+For all plugins, the version number is stated in the bottom right-hand corner of the GUIs.
+
+If any plugins are missing, you can force REAPER to update its plugin lists by going to "Options > Preferences > Plug-Ins > VST" and clicking "Rescan".
 
 ## How to use (short version)
 ### Import ADM Files
 1. Select in the menu **File -> Create Project from ADM file -> Create from ADM using EAR**
 2. Wait while all ADM elements are being created as tracks and automation curves along with metadata input plugins for each object or channel bed. There will be also tracks and plugins created for the Scene and the Monitoring.
-3. Disable "Master send" for the **Monitoring** track routing and add your hardware output there
 3. Enjoy :)
 
 ### Create from scratch
-1. Add an "EAR Object" Plugin for each audio object track or an "EAR DirectSpeakers" Plugin for a channel bed. Make sure to 
-increase the track mapping parameter value +1 for each new audio object input plugin (or + the number of your channel bed). So the first audio object track in the REAPER session should be one, the next two, ...
-2. Create a new track for the "EAR Scene" plugin and add it there.
+1. Add an "EAR Object" Plugin for each audio object track or an "EAR DirectSpeakers" Plugin for a channel bed. Disable Master Send on the track. Make sure to increase the track mapping parameter value +1 for each new audio object input plugin (or + the number of your channel bed). So the first audio object track in the REAPER project should be one, the next two, ...
+2. Create a new track for the "EAR Scene" plugin and add it there. Change the bus size to 64 and disable Master Send on the track.
 3. Connect all audio objects tracks to the "EAR Scene" track as "Receives" in the I/O option. Make sure to choose the correct bus size (i.e. Mono).
-4. Create a new track for the EAR Monitoring Plugin and add it there.
-5. Connect the Scene track to the Monitoring track as "Receives" in the I/O option. Change the bus size to 64 (which is currently the limit for one Renderer plugin).
-6. Add the hardware output for the Monitoring track in the I/O options.
+4. Create a new track for the EAR Monitoring Plugin and add it there. Change the bus size to 64.
+5. Connect the Scene track to the Monitoring track as "Receives" in the I/O option.
+6. Add the hardware output for the Monitoring track in the I/O options or allow it to send via Master.
 7. Enter and author your ADM parameters in Object, DirectSpeakers and Scene Plugins. **Please note that the Scene Plugin is steering what you hear. So any items which are not added to a programme there, will not be rendered!**
 8. Enjoy :)
 
-### Start with session template
-1. Open template in REAPER
+### Start with project template
+We have provided a project template and several example projects in the download package. To begin with the simple template;
+
+1. Open the templates in REAPER
 2. You will find a number of tracks with plugins for further usage
     - Two object tracks
     - One channel-based track
@@ -92,11 +110,12 @@ increase the track mapping parameter value +1 for each new audio object input pl
 4. All metadata connections between the plugins and I/O routings are set. You can start by importing your audio files into the tracks.
 5. Switch between the different renderings by exclusive-soloing (CMD+Alt+Click (MacOS) / Ctrl+Alt+Click (Win)) the monitoring tracks.
 
+The other projects provide examples of a broader range of use cases and some test audio so you can try the example projects straight away.
+
 ## How to use (long version)
 Have a look at this [video](https://youtu.be/u7P5mEFY76k) where these points are explained:
 
 - [Introduction](https://youtu.be/u7P5mEFY76k)
-- [Installation](https://youtu.be/u7P5mEFY76k?t=81)
 - [Tutorial 1](https://youtu.be/u7P5mEFY76k?t=162): Understanding the EAR Production Suite Plugins
 - [Tutorial 2](https://youtu.be/u7P5mEFY76k?t=462): Creating an ADM Project from scratch with the EAR Production Suite Plugins
 - [Tutorial 3](https://youtu.be/u7P5mEFY76k?t=824): Using an Existing ADM File with the EAR Production Suite Plugins
@@ -105,7 +124,7 @@ Have a look at this [video](https://youtu.be/u7P5mEFY76k) where these points are
 
 [Watch the video](https://irt-a.akamaihd.net/EAR-Production-Suite/Intro_Beta-release.mp4)
 
-Please note: The tutorial video advises to install the REAPER extension to the REAPER directory of `Program Files` on Windows. Although this will be functional, it is now advised to install to your user directory instead. Please see the [installation](#installation) instructions in this file.
+Please note: The tutorial video covers manual installation of the EPS. With v1.0.0+, it is must easier to use the included Setup application. Additionally, the video advises to install the REAPER extension to the REAPER directory of `Program Files` on Windows. Although this will be functional, it is now advised to install to your user directory instead. Please see the [installation](#installation) instructions in this file.
 
 ## Use of Binaural Monitoring plug-in
 
@@ -128,8 +147,6 @@ The Binaural Monitoring plug-in supports 3DoF (three degrees-of-freedom). That i
 The [nvsonic Head Tracker](https://github.com/trsonic/nvsonic-head-tracker) provides a cheap, compatible and tested head-tracker which can output all of the above formats, and can therefore drive the Binaural Monitoring plug-in. 
 
 ## What's still missing
-You are testing a beta version of the EAR Production Suite and some features are still under development or missing in this version:
-
 - No support for Binaural and Matrix typeDefinition.
 - Only currently supporting DirectSpeakers pack formats that are specified in the ADM common definitions.
 - No support for "nested" Objects - on import, ADM Programmes are currently flattened to a single tier of Objects.

diff --git a/vcpkg.json b/vcpkg.json
@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/microsoft/vcpkg/master/scripts/vcpkg.schema.json",
   "name": "ear-production-suite",
-  "version": "0.8.0",
+  "version": "1.0.0",
   "dependencies": [
     "protobuf",
     "nng",