From 6cc82ac5a6554d13beecf2233d4706f9cfed52eb Mon Sep 17 00:00:00 2001 From: jpecquais <48678018+jpecquais@users.noreply.github.com> Date: Wed, 15 Nov 2023 15:20:31 +0100 Subject: [PATCH] add new features --- en_US/spat-revolution/Files_&_folders.qmd | 11 +++++++++++ en_US/spat-revolution/Items_Page.qmd | 3 ++- .../Spat_Environment_Global_Bars.qmd | 16 +++++++++++++++- en_US/spat-revolution/Spat_Environment_Rooms.qmd | 12 ++++++++++++ .../Spat_Environment_Setup_Page.qmd | 4 ++++ .../Spat_Environment_Snapshot_Page.qmd | 9 +++++---- 6 files changed, 49 insertions(+), 6 deletions(-) diff --git a/en_US/spat-revolution/Files_&_folders.qmd b/en_US/spat-revolution/Files_&_folders.qmd index 628f3c72..a03dab26 100644 --- a/en_US/spat-revolution/Files_&_folders.qmd +++ b/en_US/spat-revolution/Files_&_folders.qmd @@ -50,6 +50,17 @@ The Ircam Folder contains a subfolder called *sofa* which contains the sofa.cata *When backing up a system, make sure to copy all these folders to secure the complete software configuration.* ::: +## Path for Recorded Audio Files + +Audio files are recorded in the directory of your session, in a folder named "SessionName_media", SessionName replaced by the name of the SPAT session name. +To be noted, if the session is in a folder of the same name, the folder for the audio is "Media" (no need to be documented, only for internal information). +Audio is recorded in wave Riff64, 32-bit float, interleaved. All inputs will be recorded in one unique file. For the other blocks, a single file will be created for each block, with the following name convention: "Blocktype blockname (format) - recordNumber.wav". For example, for a room named "WFS" in the format "Frontal Line 5", it will be "Room WFS (Frontal Line 5) - 0001.wav" +This is not a broadcast wave for now, the recording has no timestamp. + +:::{.callout-note} +A first file is created when arming a file to prevent CPU spike at the recording start. It will be deleted when de-arming the blocks or closing the session. +::: + ## Paths for python script ```Users/.../Desktop``` diff --git a/en_US/spat-revolution/Items_Page.qmd b/en_US/spat-revolution/Items_Page.qmd index f999320b..9c3a4ece 100644 --- a/en_US/spat-revolution/Items_Page.qmd +++ b/en_US/spat-revolution/Items_Page.qmd @@ -25,6 +25,7 @@ For all items, the items' page allows quick edition of: - **Number**: the item number order of the list. - **Name**: edit this field to change the name of the item. - **Active**: define if the item is computed or not. _If the item is inactive due to license restriction, the field cannot be edited._ +- **Record**: arm the block for recording. ### Input specific parameters @@ -74,7 +75,7 @@ In addition to the common parameters, when the _Room_ item's type is selected, t - **Reverb enable**: define if the reverb is enabled in this room. - **Protection zone width**: define the width of the [protection zone -@sec-about3dview-protectionzone]. - **Efficiency zone**: select the wanted behavior when a source is out of the [efficiency zone -@sec-about3dview-efficiencyzone] of the room. -- **Scaling distance**: define the [scaling distance -@#sec-room-parameter-distancescaling] of the room in meters. +- **Scaling distance**: define the [scaling distance -@sec-room-parameter-distancescaling] of the room in meters. - **Tracking scaling**: define the tracking scaling of the room in meters. - **Invert phase**: invert the phase of the selected item. diff --git a/en_US/spat-revolution/Spat_Environment_Global_Bars.qmd b/en_US/spat-revolution/Spat_Environment_Global_Bars.qmd index c0c5ecaf..d439fb18 100644 --- a/en_US/spat-revolution/Spat_Environment_Global_Bars.qmd +++ b/en_US/spat-revolution/Spat_Environment_Global_Bars.qmd @@ -76,4 +76,18 @@ _This bar can be hidden on the snapshot panel of the __Preference__ page._ :::{.callout-note} More information about snapshots can be found on the **[snapshots page -@snapshot]**. -::: \ No newline at end of file +::: + +## Transport bar + +The transport bar allows to access to the recording feature of SPAT Revolution. It is possible to write the audio stream going through any blocs (except for the sources) to audio files. + +It is possible to launch the recording by clicking on the "*Record*" button in the transport bar, located at the bottom of the user interface, or using the shortcut "Cmd/Ctrl+Shift+R". +The session must have been saved to enable the recording. Otherwise, a popup will appear asking to save the session. +Closing the session, deleting a block, or dearming a block will automatically stopped the recording. + +## Media stream bar + +This bar provides information about the recording blocks, the file names and path, the elapsed time of recording, the number of channels recorded, and more. +It will be automatically displayed when arming a block. +Also, it can be shown/hidden via the menu "View/Show media stream", or via the shortcut "Cmd/Ctrl+Alt+Shift+O". \ No newline at end of file diff --git a/en_US/spat-revolution/Spat_Environment_Rooms.qmd b/en_US/spat-revolution/Spat_Environment_Rooms.qmd index 5922c211..d3dbeedd 100644 --- a/en_US/spat-revolution/Spat_Environment_Rooms.qmd +++ b/en_US/spat-revolution/Spat_Environment_Rooms.qmd @@ -59,6 +59,10 @@ Display the name of the source even if it is not selected. Display the name of the speakers. +**Auto-hide sources** + +Automatically hide sources depending on their input level. + **Scale:** Make the elements bigger or smaller to adjust ease of sight. @@ -89,6 +93,10 @@ Configure the quality factor of the Nebula. Changing this factor will significantly change the performance. ::: +**Nebula Scale:** + +Allows to scale the Nebula "behind" the speakers. + **Speaker Alpha:** Change the transparency of the speakers. @@ -97,6 +105,10 @@ Change the transparency of the speakers. Change the transparency of the listener's head. +**Zone Alpha:** + +Change the transparency of the efficiency zone. + **Grid type:** Toggle between polar or cartesian grids. diff --git a/en_US/spat-revolution/Spat_Environment_Setup_Page.qmd b/en_US/spat-revolution/Spat_Environment_Setup_Page.qmd index 129b2e48..aad6b0e2 100644 --- a/en_US/spat-revolution/Spat_Environment_Setup_Page.qmd +++ b/en_US/spat-revolution/Spat_Environment_Setup_Page.qmd @@ -146,3 +146,7 @@ The shortcut ```Ctrl + click``` will route one per one all the following channel ::: Master transcoder and master matrix support summing, thus, one input can be connected to several outputs, or the opposite. + +### Record arm + +Arm the block for recording. \ No newline at end of file diff --git a/en_US/spat-revolution/Spat_Environment_Snapshot_Page.qmd b/en_US/spat-revolution/Spat_Environment_Snapshot_Page.qmd index ad1fb803..17f36685 100644 --- a/en_US/spat-revolution/Spat_Environment_Snapshot_Page.qmd +++ b/en_US/spat-revolution/Spat_Environment_Snapshot_Page.qmd @@ -68,6 +68,8 @@ It is possible to generate new indexes for all the snapshots according to list o Last, the index can be manually edited, by right-clicking on a snapshot and selecting ```Edit snapshot index```. +The action ```Reindex Snapshots```, found in the upper ```Snapshot``` menu reindex all the snapshots, starting from 1 and by their order in the snapshot list. + ### Recall options Recalling a snapshot will use four different options: @@ -79,10 +81,7 @@ Recalling a snapshot will use four different options: :::{.callout-note} By default, only sources' properties are recalled from snapshots. If only some parameters are recalled, the whole session is stored on the creation of a snapshot. -::: - -:::{.callout-note} -On a room, the setup parameters like distance scaling, protection zone parameters, etc. are deactivated from snapshot recall. +For rooms, the setup parameters like distance scaling, protection zone parameters, etc. are deactivated from snapshot recall. ::: ### Using global options or overriding them @@ -120,6 +119,8 @@ A set of actions is presented at the top: - Versions can be deleted, by clicking on ```Delete```. - All versions excluding the selected one(s) can be deleted, clicking on ```Delete all other versions```. +The action ```Consolidate Snapshots```, found in the upper ```Snapshot``` menu remove all the unused snapshot version to lighten the weigth of the session file. + ## Inspector The inspector lets you visualize the difference between the current state of your session and the selected snapshot, and the selected version of a snapshot.