Skip to content

Commit

Permalink
FA-602: Release v1.2 (#35)
Browse files Browse the repository at this point in the history
This commit provides documentation updates, release notes and updated
download links for the upcoming v1.2.0 release.
  • Loading branch information
p--b authored Aug 30, 2024
1 parent 3fb2f38 commit df1103e
Show file tree
Hide file tree
Showing 161 changed files with 3,103 additions and 75 deletions.
45 changes: 45 additions & 0 deletions .github/workflows/deploy_pascal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@

name: Deploy Docs to Doc (Pascal)

on:
push:
branches:
- main_pascal

workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
BuildAndMakeLive:
name: Build
runs-on: ubuntu-latest
steps:
- name: Fetch repo
uses: actions/checkout@v2

- name: Install docusaurus
run: yarn install

- name: Build docusaurus
run: yarn build

- name: Send build to doc
uses: appleboy/scp-action@master
with:
host: doc.net.fourieraudio.com
username: fourier
port: 22
key: ${{ secrets.SSH_DOC_FOURIER }}
source: "/home/runner/work/pascal/pascal/build"
target: "/home/fourier"

- name: Copy to staging docusaurus directory
uses: appleboy/ssh-action@master
with:
host: doc.net.fourieraudio.com
username: fourier
key: ${{ secrets.SSH_DOC_FOURIER }}
port: 22
script: |
sudo cp -r /home/fourier/github/workspace/build/* /var/www/docusaurus_staging/live
File renamed without changes.
11 changes: 6 additions & 5 deletions info/downloads/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ sidebar_position: 4

Here you can find the latest **transform**.client:

<a class="button button--lg button--primary" href="https://downloads.fourieraudio.com/transform/latest/FourierTransform-Release-1.1.1-win32.exe">Windows v1.1.1</a>
<a class="button button--lg button--primary" href="https://downloads.fourieraudio.com/transform/latest/FourierTransform-Release-1.2.0-win32.exe">Windows v1.2.0</a>
<br/><br/>
<a class="button button--lg button--primary" href="https://downloads.fourieraudio.com/transform/latest/FourierTransform-Release-1.1.1-arm64.zip">macOS (ARM) v1.1.1</a>
<a class="button button--lg button--primary" href="https://downloads.fourieraudio.com/transform/latest/FourierTransform-Release-1.2.0-arm64.zip">macOS (ARM) v1.2.0</a>
<br/><br/>
<a class="button button--lg button--primary" href="https://downloads.fourieraudio.com/transform/latest/FourierTransform-Release-1.1.1-x64.zip">macOS (x86-64) v1.1.1</a>
<a class="button button--lg button--primary" href="https://downloads.fourieraudio.com/transform/latest/FourierTransform-Release-1.2.0-x64.zip">macOS (x86-64) v1.2.0</a>
<br/><br/>

:::info
Expand All @@ -35,8 +35,9 @@ compatibility ranges at any time.</small>

| Engine Version | Client Version | Release Date | Latest | |
| -------------- | ------------------------- | ------------ | ------- | -------------------- |
| | **1.1.1** | 04/07/2024 | **Yes** | [Release notes](v1-1-1.md) |
| **1.1.0** | 1.1.0 | 24/06/2024 | | [Release notes](v1-1-0.md) |
| 1.2.0 | **1.2.0** | 30/08/2024 | **Yes** | [Release notes](v1-2-0.md) |
| | 1.1.1 | 04/07/2024 | | [Release notes](v1-1-1.md) |
| 1.1.0 | 1.1.0 | 24/06/2024 | | [Release notes](v1-1-0.md) |
| | 1.0.1 | 22/04/2024 | | [Release notes](v1-0-1.md) |
| 1.0.0 | 1.0.0 | 22/04/2024 | | [Release notes](v1-0-0.md) |

Expand Down
98 changes: 98 additions & 0 deletions info/downloads/v1-2-0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
---
sidebar_label: Release Notes v1.2.0
---

# transform.engine v1.2.0 release notes

- **Engine Version**: `1.2.0`
- **Windows Client Version**: `1.2.0`
- **macOS Client Version**: `1.2.0`

## Summary

We’re excited to release **transform**.engine v1.2, featuring:

* **🔥 Store and recall plugin data in Cuelists:** store and recall Cues, which snapshot the entire state of all currently loaded plugins
* **🤖 MIDI Control:** use MIDI to fire Cues
* **⏰ 512-sample periods:** for latency-hungry plugins

…as well as a number of other goodies and bugfixes.

We encourage all users to update to this fully backwards-compatible release as soon as possible.

## New In This Release

- **TF-90: Record and Fire Cues**: It is now possible to record and fire Cues, which snapshot the
entire state of all currently loaded plugins. [read more](../../manual/transform.client/cuelists)
- **TF-70, TF-156: Create Cuelists with Recall Filters**: It is now possible to create multiple
Cuelists, each of which can be filtered to affect different chains when Cues in the list are
recalled by different clients. [read more](../../manual/transform.client/cuelists/filters)
- **TF-98: Copy & paste plugin states**: there are now buttons in the detail pane for a plugin
instance which allow you to copy and paste the state of a plugin between instances of the same
plugin type
- **TF-100: Fire Cues via MIDI**: You can now send MIDI messages to the transform.engine which will
cause a Cue to be fired. [read more](../../manual/transform.engine/midi)
- TF-944: Link-Local IP addressing is now supported on the Dante Secondary interface
- TF-1946: 512-sample periods are now available, supporting processing of plugins which require that much latency
- TF-2093: Maximised plugin view mode, helping you see more plugin on small screens
- TF-2113: Delete operations now require confirmation
- TF-2029: Move chains left and right
- TF-2048: Re-number chains
- TF-1804: Rename showfiles
- TF-1897, TF-2075: Bypass and Smite buttons are now more obvious when selected, along with other toggle buttons

## Bugs Fixed In This Release

- TF-1893: Plugins could show as offline for extended periods of time when loading chains when different chains were previously loaded
- TF-1810: Plugin scanner can show endless spinner
- TF-1919: Improve chain startup times
- TF-1902: Selecting current period size causes renderer to restart
- TF-2139: Plugin host access handshake is now unique per-device
- TF-2232: After loading hundreds of showfiles, further loads could have no effect
- TF-2212: Latency group changes made by one client not shown on others
- TF-2181: **transform**.client: Disconnection warning could occasionally flicker into view
- TF-1970: **transform**.client: Improve performance by fiddling with scrollbar implementation

## Compatibility Notes
This release introduces no compatibility changes from [v1.1.0](v1-1-0.md).

Showfiles are fully backwards- and forwards-compatible with transform.engine v1.1.

transform.engine v1.2 is fully backwards compatible with transform.client v1.0-v1.1, and vice-versa;
you can connect to an engine running v1.1 from a client running v1.2, and to an engine running v1.2
from a client running v1.1.

## Known Issues

Users should be aware of the following [known issues](/manual/known-issues) in this release, which
we hope to address in a future update:

- TF-1891: DSP load meter can occasionally jump to 100% load, before returning to normal. We believe
these occasional jumps are spurious and can be safely ignored.
- TF-2148: When **transform**.engine is the PTP clock leader, changing the sample rate from 96 kHz
to 48 kHz in Dante Controller can result in the Dante audio transport stalling if transform.engine
is the PTP clock leader. Restarting the **transform**.engine after changing sample rate resolves
the issue.

For more details and workarounds for these issues, see the [known issues list](/manual/known-issues).

A small number of plugins may experience compatibility issues running on transform.engine.
For details, see our plugin compatibility database at https://plugins.fourieraudio.com .

## Docs, Support & Bug Requests

We would warmly welcome any bug reports you may have on our discussion site:
https://discourse.fourieraudio.com . We’ll also be happy to chat and answer any questions you may
have there!

To learn more about how to use transform.engine, please check out our docs at
https://docs.fourieraudio.com , where you can also find handy walkthrough videos showing how to get
started.

If you need support with transform.engine, please feel free to reach out to your local dealer or
distributor, or contact us directly at support@fourieraudio.com .

## Upcoming Release Schedule

We are hoping to release transform.engine v1.3 later this year. For information on what’s
coming up, see our product roadmap here: https://go.fourieraudio.com/future .
1 change: 1 addition & 0 deletions info/intro/hardware-specifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ sidebar_position: 1
### Remote Client (for control / configuration)

* Compatible OS: macOS (11 onwards - M1/Intel), Windows (10 onwards)
* Minimum resolution: 1366 x 768 px

### Warranty

Expand Down
3 changes: 2 additions & 1 deletion info/intro/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ feedback we receive from our ~~adoring fans~~ users.

| Feature Ref. | Feature Details | Planned For |
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| TF-172 | Snapshots - be able to have a series of snapshots that allow you to recall different plugin settings and configurations during your show. | Summer 2024 |
| TF-157 | Chain Groups - ways to slice and dice your chains. | End of 2024 |
| FA-598 | Initial console integration - control your plugins from a console! | End of 2024 |
| TF-1659 | Network Redundancy - mirror two **transform**.engines so that they can be used in a redundant configuration. | 2025 |

Can't see a feature you'd love to add? Be sure to request it on our [Discourse
Expand Down
6 changes: 4 additions & 2 deletions manual/known-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ We intend on resolving all known issues in a future release, but until then, her

| Issue Ref. | Issue Details | Workaround |
| ---------- | ------------- | ---------- |
| TF-944 | Dante Secondary Link-Local IP addresses are not supported. If the Secondary network port is set to use Link Local addressing, it will be assigned an IP address in the `169.254/16` range rather than the `172.31/16` range as required for Dante Secondary functionality. | Only use Static or DHCP IP addressing for Dante Secondary. At your own peril, you could set a static IP in the `172.31/16` subnet, however this is **not recommended** as you may experience network issues with IP conflicts in such a configuration. | - |
| TF-1810 | DSP load meter occasionally temporarily jumps to 100% with some plugins, before returning to a much lower, more believable value. Audio processing is not affected. | We are investigating the cause of these jumps but currently believe they are spurious and can be safely ignored; this can be validated by checking that the `DSP Overruns` count is not going up and that output audio is clean. | - |
| TF-1810 | Plugin scanner can stall showing spinner: occasionally, during plugin scan, the scanner dialog can get stuck displaying "Scanning for new and updated plugins" and a spinner forever. | Taking the system to `Offline` mode and then back to `Edit` mode should cause the plugin scan functionality to be available again. | - |
| TF-2148 | When **transform**.engine is the PTP clock leader, changing the sample rate from 96 kHz to 48 kHz in Dante Controller can result in the Dante audio transport stalling if **transform**.engine is the PTP clock leader. Restarting the **transform**.engine after changing sample rate resolves the issue. | Restart the engine after changing sample rate if **transform**.engine is the PTP clock leader. |


While we strive to support as many plugins as possible on the **transform**.engine, as the engine is
an open platform running third-party plugins, there may occasionally be compatibility issues between
Expand All @@ -32,7 +32,9 @@ report on our [discourse site](https://discourse.fourieraudio.com).
## Previously-resolved issues
| Issue Ref. | Issue Details | Workaround | Fixed in version |
| ---------- | ------------- | ---------- | ---------------- |
| TF-944 **[fixed]** | Dante Secondary Link-Local IP addresses are not supported. If the Secondary network port is set to use Link Local addressing, it will be assigned an IP address in the `169.254/16` range rather than the `172.31/16` range as required for Dante Secondary functionality. | Only use Static or DHCP IP addressing for Dante Secondary. At your own peril, you could set a static IP in the `172.31/16` subnet, however this is **not recommended** as you may experience network issues with IP conflicts in such a configuration. | [v1.2.0](/downloads) |
| TF-1345 **[fixed]** | While a chain restarts, metering freezes on that chain. | This is purely cosmetic: you can see that a chain is restarting if all plugins have a lightning bolt next to them. The metering should resume normal service once all plugins have restarted. | [v1.1.0](/downloads) |
| TF-1673 **[fixed]** | Engine service status indicators are occasionally inaccurate. In certain circumstances, the engine status indicators can show a service being offline when it is actually online, or vice versa. | This is purely cosmetic. Support can obtain accurate details about engine status by inspecting the logs. | [v1.1.0](/downloads) |
| TF-1686 **[fixed]** | Connecting the client to the **transform**.engine using a link-local address results in the client not functioning as expected. | Please only connect the **transform**.client to the **transform**.engine using static or DHCP IP addresses. If you are using Dante in link-local mode, please connect the client to the engine using the control port, configured to either a static or DHCP address. | [v1.1.0](/downloads) |
| TF-1696 **[fixed]** | Certain plugins may lead to incorrectly excessive DSP load being displayed. | For some CPU-intensive plugins, the system may report abnormally (and incorrectly) high DSP load. This can be validated by checking if the audio is clean on the output of all chains in the system. | [v1.1.0](/downloads) |
| TF-1810 **[fixed]** | Plugin scanner can stall showing spinner: occasionally, during plugin scan, the scanner dialog can get stuck displaying "Scanning for new and updated plugins" and a spinner forever. | Taking the system to `Offline` mode and then back to `Edit` mode should cause the plugin scan functionality to be available again. | [v1.2.0](/downloads) |
2 changes: 2 additions & 0 deletions manual/transform.client/cuelists/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
label: 'Cuelists'
collapsed: true
35 changes: 35 additions & 0 deletions manual/transform.client/cuelists/cuelists.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebar_position: 3
---

# Cuelists

Cuelists each contain multiple Cues, and can be found in the Cuelists tab at the top left of the **transform**.client.
![Cuelist MIDI Configuration](@site/static/img/transformclient/cuelists-nofilter.png)

Cuelists have the following key features:
* It is possible to have multiple Cuelists, all containing multiple Cues.
* Each Cuelist can be triggered by a different MIDI personality and channel, enabling you to trigger **transform**.engine Cues remotely.
* Each Cuelist can have a recall filter, enabling you to select which chains you wish each Cuelist to target.

Each Cuelist has two special Cues:
* The **Active Cue** is the Cue that was most recently fired in that Cuelist. It is shown in green.
* The **Pending Cue** is the Cue that will be fired if you execute a "Fire" operation on this
Cuelist. It is shown in orange.

Click a Cue to select it, or double click a Cue to set it as pending.

## Primary Cuelist

The Primary Cuelist serves two key functions:

* It is the Cuelist that is displayed at all times in the Transport Control (in the bottom right-hand
corner of the UI). Pushing the "Fire" button will always fire the Pending Cue on the Primary
Cuelist.
* If the system is in Auto-Update mode and there is no Live Cue loaded on a given Plugin Instance
(so the system has no way of knowing where the change should be saved), the change will be saved
into the currently loaded Cue of the Primary Cuelist.

You can change the Primary Cuelist using the drop-down selector in the Transport Control (in the
bottom right-hand corner of the UI), or by selecting the Cuelist and choosing "Set As Primary" in
the action menu.
40 changes: 40 additions & 0 deletions manual/transform.client/cuelists/cues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
sidebar_position: 1
---

import autoupdate from '/static/img/transformclient/auto-update.png';
import pendingchanges from '/static/img/transformclient/pending-changes.png';
import recordCue from '/static/img/transformclient/record-cue.png';


# Cues

Cues store the state of every Instance in the system at the point at which they are recorded, including:

* **Plugin Data** - the configuration of all of the Plugin Instance's parameters.
* **Bypass** - the state of the Bypass toggle for the Plugin Instance.

Cues do not store anything about the "structure" of the Showfile: the configured Chains, or which
Plugin Instances are loaded into which Chain.

By selecting a Cuelist in the left-hand pane, you will be presented with all of the Cues in that Cuelist.
![Cuelist MIDI Configuration](@site/static/img/transformclient/cuelists-nofilter.png)

You can add a new Cue after the currently active Cue (or the first in the Cuelist) by clicking on the Record Cue button:

<img src={recordCue} alt="Record Cue Button" width="250" />

This will record all currently-live Cue data into that Cue.

## Cue Actions

Click on a Cue to select it. Once selected, the Action Menu on the right hand side of the UI
presents various exciting possibilities:

* **Fire Cue** - fire the selected Cue.
* **Set As Pending** - set the selected Cue as the Pending Cue (i.e. the Cue fired when you push
"Fire")
* **Rename Cue** - rename the currently selected Cue with a text string.
* **Renumber Cue** - change the number of the currently selected Cue with format #.#
* **Delete** - delete the currently selected Cue.

22 changes: 22 additions & 0 deletions manual/transform.client/cuelists/filters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
sidebar_position: 3
---

# Recall Filters

Cuelist Recall Filters can be set in the Detail Pane of a Cuelist:

![Cuelist with Filter](@site/static/img/transformclient/cuelists-filter.png)

You can add a Recall Filter to any Cuelist by picking a filter mode and selecting zero or more
Chains. The filter mode options are:

* **No Filter**: The Cuelist will apply to all Chains when a cue is fired.
* **Include Targets**: The Cuelist will **only** apply to the selected Chains when a Cue is fired.
* **Exclude Targets**: The Cuelist will **not** apply to the selected Chains when a Cue is fired.
:::tip

The filters are **recall filters**: in *exclude targets* mode, they act similarly to "recall safe"
in other products.

:::
Loading

0 comments on commit df1103e

Please sign in to comment.