Author: Debanka

The Help tab provides quick access to information on AudioworX which include GTT and other modules, as well as detailed descriptions of its features and functionalities.

• Keyboard Shortcuts: A link to keyboard shortcuts for RTA module that can be used to perform various actions quickly and efficiently.
• Release Notes: A summary of changes, improvements, and bug fixes included in recent software updates.
• View Help: Explore AudioworX and how to use the AudioworX and its modules to fine-tune audio signal and many more.

Clicking on any of the options within the Help tab will redirect you to a dedicated documentation page that provides detailed information on the selected topic.

When GTT project is open, press the F1 key on your keyboard to open AudioworX documentation page.

When the “Load Slot” command is sent to the device, the device can respond with the following options.

Option 1

1. Slot loading in progress > Slot can be loaded > Loading in progress
2. Slot loaded successfully.

Two responses one after the other.

Option 2

1. Slot loading in progress > Slot can be loaded > Loading in progress >
2. Slot loading failed.

Single Error response – Slot loading failed.

In the first two cases, between the first response and the second response, you will be blocked from taking any action in GTT.
The following progress dialogue box will be displayed.

If the second reply is not received within 15 seconds, GTT will unblock itself and report an error.

If a set of files and slot map files are already available on the device.

1. Click on the column header of the slot and select the slot, which has to be loaded to the device. Selected Slot Id is displayed in a text box under the DSP commands section.
2. Click on the Load Slot button.

   By default, the first valid slot in the table is loaded. If the device is offline, it will be automatically connected to it.

   

The GTT sends a slot load request to the device and waits for a response. If the device is successfully loaded into the slot, a success message is displayed on the screen.
An error message will be displayed on the screen if the device has failed to load into the slot.

If a slot does not exist in the table but is present on the device, it is also possible to load it. In this case, the user can manually enter the slot ID and click on the “Load slot” button.

When the “Maintain Folder Structure” option is checked, then all the set files will be generated within a folder named after the Presets Group name, using the format “Presets Group name_SetNamePresetIds”. This applies when performing operations such as Export Set Files, Export All Files, and Export Slot. On the other hand, if this option is unchecked, all the set files will be stored in the chosen path directly.

So for above Preset Group (Set Group 1) and sets (Set 1[0], Set2[1]) below folders and file will be created under selected path.

Maintain Folder Structure flag will be persisted while exporting/importing projects and reopening the preset controller window.

You can export Preset Configuration using the following methods:

• Export Slot Map: To save the flash files of the slot map in the selected path with the provided name.
• Export Set Files: To save all the set files of the map in the selected path.
• Export All Files: To save all the set files of the map, along with the flash file and preset size information file in the selected path.

Right-click or click on “Export Options” to select the type of export.

To export a slot map set file, all files should contain at least one valid slot; otherwise, the options Export Slot Map, Export Set Files, Export All Files, and Export Slot will be disabled.

Exporting human readable flash file: The exported flash file can be helpful in case any slot gets accidentally deleted. You can reconfigure Preset Controller values using the slot map table details mentioned in the exported flash file.

Once you have configured all parameters of the Preset Controllers, it is recommended that you export the flash file.

Steps to export human human-readable flash file:

1. Open Preset Controller, add and configure the slots.
2. Click on the Configure and enable or disable “Ramp Setting”.
   
3. Click on Export All Files, browse the desired location, and click Ok.                                                                 
   This action creates a set map file, human-readable set map file in the CSV format, a preset size information file, and set files at the specified path.
   The name of the CSV file is determined by the name of the flash file, which is the original file.
   Example: The flash file name in the example below screenshot is Map.flash, so the created readable CSV file name is Map.flashr.
   
4. Click on Export Slot Map, browse the desired location, enter the file name, and click Save.
   
   
   This action creates two files, one human-readable CSV file and another flash file with the specified name at the specified path.
   
   Open the CSV file to see the slot details.
   In the below image, the Ramp Setting details for “1: Core 0” column is “0:0 Disabled 1:0 Enabled 1:1 Enabled”, which is “Core Id : Instance ID : State” .
   
   The image below explains the “Ramp Setting” configuration for “0:0 Enabled 0:1 Enabled 0:1 Disabled” in the GTT.
   Similarly, all ramp settings details will be exported in this format.
   
5. Click on Export Set Files, browse the desired location, and click Ok.                                                                 
   This action automatically creates folder(s) with the set group name at the specified path.
   
   This set group folder contains exported set files.
   

The Preset Controller allows you to configure a “Custom Action” option. Choosing this option opens a dedicated configuration window where you can define custom actions, as shown in the below image.

In Preset controller, there is an option to configure what actions have to be performed when a slot is loaded.  Currently this feature supports the following actions.

• Custom xTP command
• Custom xTP command (External)
• Set master control pin
• Set Audio object processing state
• Set control pin refresh.

These custom actions can be configured at different stages of slot load.  There are 4 stage that can be configured as listed below.

1. Before slot load
2. After fade out but before preset load
3. After preset load but before fade in
4. After slot load

Steps to configure custom actions:

1. On the Custom action configuration window, click Add to add an action that you can configure.
2. Once the action is added, select the “Stage” from the drop-down options.
   
3. Similarly, select the “Action” from the drop-down actions.
   
4. Click on Configure to configure the Action.
   

The data configuration option depend on the type of “Action” you choose from the drop-down. Below are the configurations for each supported action type.

Custom xTP command		This action sends an xTP message of your choice into the device (as if it received it from GTT). The commands which go to the core may send a response to the network after processing.  These responses may not cause a GTT update depending on the command.  The same limitation applies to read commands, for example reading a control value won’t cause GTT to update the value in the explorer. You can select a xTP command from the drop-down. If the command is not available (perhaps in that case you are using a custom command), you can enter command Id in the text box.  Then you can enter the command data in the box provided. This window lets you enter data in hexadecimal format. As you enter the data, the count at the bottom keeps track of the characters, helping you ensure the correct length. To prevent mistakes, the system checks if the data is valid when you click “OK.” For your reference, the window also shows the current slot, stage, and specific action you are configuring. The system automatically generates a clear description to help you understand the configured custom action.
Custom xTP command (External)		This sends a command from the system to the extrenal device or any connected tool from the context of the xTP Interpreter. You can select a xTP command from the drop-down. If the command is not available, you can enter command Id in the text box.  Then you can enter the command data in the box provided. This window lets you enter data in hexadecimal format. As you enter the data, the count at the bottom keeps track of the characters, helping you ensure the correct length. To prevent mistakes, the system checks if the data is valid when you click “OK.” For your reference, the window also shows the current slot, stage, and specific action you are configuring. The system automatically generates a clear description to help you understand the configured custom action.
Set master control pin		This is equivalent to sending the control and value from GTT or from any other xTP source. This window appears when you choose “Set master control pin” as the action in the main custom action configuration window. It will list the control pins configured in the signal flow.  You can select a control pin and enter value for the control pin. Click “Ok” to save the configuration.The system automatically generates a clear description to help you understand the configured custom action.
Set Audio object processing state (beta)		Sets the selected audio object to the chosen state. This window appears when you choose “Set audio object processing state” as the action in the main custom action configuration window. This window will show where you can configure the processing state of the audio object. Once the values are selected, Click “Ok” to save the processing state information. The system automatically generates a clear description to help you understand the configured custom action.
Set control pin refresh		Select the action -> Set control pin refresh in the action dropdown. When the slot is loaded, select the control pin that needs to be refreshed. This data will be sent to device as part of slot map. When the slot with this data is loaded, the configured custom action will be executed on the set control pin.

Once all the slots are configured with set of actions, the custom action window will appear as per below image.  You can override the default descriptions yourself after you configure the action.

The custom action data configured will be saved only when “Save and close” button is clicked in main custom action window.

The “Core Object Settings” window is used to control core object transitions and target states.  Any core object can be added here optionally, but instances with active set groups for the slot are automatically added.

You can specify which processing state the core object should transition to during the slot load, and if that transition should involve ramping or an instant change.
Core Object Settings includes following processing states:

• Normal Processing state
• Bypass without processing
• Mute with processing
• Mute without processing

You can change Ramping state for each instance in a core using drop down option. There are three type of ramping state you can configure.

• Ramping
• No Ramping
• Swoosh Mode

By default, Ramping is enabled for all instances if not configured.

No Ramping
– There is no rampdown to mute phase before applying preset data (but calc is momentarily disabled during the actual load to protect data).
– There is no ramping between processing state changes.

Swoosh Mode: This mode describes as a seamless preset application, which means in this case no fade-out, mute and fade-in steps are performed. The preset(s) are loaded onto the core objects while calc is running, with a request to tune XTP to attempt ramping.

This mode should be used very carefully, as not all audio objects support ramping during runtime tuning, and not all tunings are guaranteed to be applied without artifacts (audible and/or measurable).

The swoosh mode is stored in the slot map on a per core object basis, meaning that in general the user could apply one preset to an xAF instance in a swooshed manner and another in the normal fade out, mute, fade in manner. This only makes sense if the core objects are running independently, otherwise it could interfere with the swoosh effect in an unexpected and unwanted way.  Note: It is possible to select processing states in swoosh mode, but they will not be applied.

Things to know about Ramp state configuration window and how objects transitions will function.

• The ramp time used is configured in the slot, it overrides default core object ramp times.
• Automatically added core objects (instances with active set groups) cannot be deleted from the list.
  
• You can also manually add and remove other core instances and objects.
  

 If performing control set custom actions or other non preset object tuning – you may end up with multiple ramps (once from core object and once from AO tuning) multiplying against each other.
– When loading a preset though – the tuning method is called with ramping disabled so the object should not ramp.

• Ramp Setting for instances, which load presets function differently than ramp settings for core object switches or instances which do not load presets.
  • With Ramping on:
    • Core objects and Instances which do not load will use only one ramp if possible.
      1. example: going from normal to mute we do not need to ramp back up after the mute.
      2. example: going from normal to bypass we have to ramp down to mute and then up to bypass.
    • Instances that load presets will always go to mute for loading the preset and then transition to whatever proper state after.
  • With Ramping off:
    • During the ‘muted’ phase which occurs after any rampdowns are finished (if there are indeed rampdowns in the slot) all non-ramping core objects (whether loading presets or not) will instantly switch state to the target state.

Instances which load presets are disabled during the load even if they are unmuted.

The user interface will remain unchanged for Ramp state configuration for audio library versions (S+2).

Steps to configure preset controller slot:

1. Go to the Standard toolbar and open Preset Controller.
   
   On the Preset Controller window you can see the following details:
   • In the Slot Id, the serial number starting from 1 (or the next available slot) will be displayed.
   • The Slot Name, Fade In, and Fade Out will be filled in with default values.
   • All the Set groups created in parameter sets screen containing the parameters of the device are displayed as rows in set map table.
2. Enter the values in Slot Id, Slot Name, Fade In, and Fade Out, and click Add Slot.
   
   A new slot column added with entered details and default value (None) for set groups available in the table.
3. Enter the Pipeline Delay in the text box. The pipeline delay is used as a delay after applying the preset to the Load Slot operation and before starting to ramp up. The pipeline delay is the time required for the history buffers (which have already been cleared) to be filled with valid data before the start of the ramp-up. The value can be set from 0 to 65535 ms.
   
4. In the Core object Setting row, click Configure. This opens the Core state configuration window.
   
5. On the Core object configuration window, Enable or Disable ramping for individual core objects using the toggle button.
   Instances which have active set groups in this slot will automatically be added to this window and cannot be removed.
   For more details about Core object configuration, refer to Core Object Settings
   
6. (Optional) If you want to add custom actions, in the Custom actions row, click Configure. This opens the Custom action configuration window.
   On this window you define custom actions.  For more details about Core object configuration, refer to Custom Actions Settings
   
7. In the Set Group row, click on the drop-down to set a group created in the parameter sets screen.
   
   If the “None” value is selected for any set group no parameter set from that group is loaded for this slot.
8. Click on the Single to see the core and instance.
   The instances associated with the set group are shown next to the set group. If the group contains parameters of only one instance, the instance info is “Single”, otherwise it will display “Multiple”.
   
9. Double-click on the table column header to edit the slot name.
   

   Ramp Settings configuration is supported from S+2 device library version.

10. Click on the “X” icon available on any column to delete the slot.

Slot Options

Retrieve Slot: The Retrieve Slot option in the generic sets window reads the state variable values of all the sets in a slot and updates them in the in the corresponding sets of Parameter Sets. Retrieve Slot button is available in the header of each slot.

Apply Delta Slot:  The Apply Delta Slot feature only send tuning parameter present in the selected slot which are differing for the State variable tree.  The tuning values of the presets are send to the device via XTP Tuning write messages. Apply Delta Slot option is available in the header of each slot.

Apply All Slot:The Apply All Slot feature sends all tuning values of the parameter irrespective of modified or not in the slot. The tuning values of the presets are send to the device via XTP Tuning write messages. Apply All Slot option is available in the header of each slot.

Export Slot: Once you have created a Set Map, click on the “Export Slot” option, and browse the desired path.

Flash file created in binary format. For virtual devices, use the file name as “sect262144.flash”.

Generic sets are persisted in the database, just like any other data in GTT.

Generic sets are also persisted in the .gttd file when the project is exported, and the same is available after importing. The selection of the default slots is dynamic and will not be persisted.

Verify Slot: This functionality is designed to compare the presets loaded on a device with those available in the GTT  in order to ensure their accuracy.

This feature is available only in online mode. i.e. only when the device is connected.

To verify preset values, select a slot and then click the ‘Verify slot’ option. A read command is sent to the device for each state variable within of all presets under a slot. Once the value has been read, it will be compared with the corresponding value in the preset. If all values match, the verification process is considered successful. However, if any values do not match, an error message will be displayed, and an error report will be generated.

Sample error report is as attached here Set 1[2].

The Tools group allows you to monitor all services running on GTT, view the event and xTP logs, and perform the sound card configuration.

• Service Monitor
• Event Log
• xTp Log
• Soundcard Setup
• Microphone Setup

Service Monitor

Global Tuning Tool provides a comprehensive set of tools for monitoring the following services:

• SQL Server Service
• Measurement Service
• Harman Audio Library 32
• Harman Audio Library 64
• AI Module

The choice of tool depends on the type of monitoring or tuning to be done and the events to be monitored.

Event Log Viewer

The Event Log window tab shows events that have occurred within the Global Tuning Tool and on connected devices. The log may be utilized by individual devices to perform certain operations. You can also use the logs for troubleshooting.

The Event Log Indicator will notify you in real-time as events occur.

xTP Log Viewer

Any error on the device is displayed in GTT in the XTP viewer and Event log.

The xTP-Viewer has two sections:

• Left side section: Display message flow view and show raw data of several messages.
• Right side section: Detailed view of a selected message on the right side (is empty if message interpretation is not implemented up to now for the specific message).

Sound Card Configuration

The Sound Card Setting allows you to configure the host API (audio driver), device, sample rate, block length, and the master output for the audio processing. Based on device selection, input and output channels are available for configuration.
Using “Master Output” you can set master and device output modes for speaker configuration in the Measurement Module.
The configured sound card configuration is used throughout the RTA and Measurement Acquisition features.

Before you start the Measurement wizard or set the “Sound In” and “Sound Out” devices in the RTA, make sure you have configured sound card settings like Host API (Driver Protocol), Device, Sample Rate, and Block length of the sound card.

On the “Streams” section list of available channels for input and outputs is displayed. Those can be routed to any physical sound card channels. All devices are available as two-channel devices. The stream area displayed the Channel column, indicating the mapping of Sound In or Sound Out devices to specific channel pairs.

In the example above, the mapping is configured as follows:

• SoundIn1, SoundIn2: Analog (1 + 2)
• SoundIn3, SoundIn4: Analog (3 + 4)
• SoundIn5, SoundIn6: Analog (5 + 6)
• SoundOut1, SoundOut2: Analog (1 + 2)

GTT supports four host APIs: MME, Windows DirectSound, ASIO™, and Windows WASAPI.

Host API	Description
MME	This is the standard Windows audio API. It allows the operation of multiple audio devices at the same time. Sample rates are handled by the operating system. Can be set to any sample rate. If the sample rate of the physical audio device is different, then the OS takes care of the sample rate conversion. This mode is recommended if multiple devices are running at the same time, e.g measuring with a USB microphone while playing back generator signals with an internal sound card. For MME, it’s required to select input and output devices separately, and all selected input and output devices support a maximum of 2 channels.  Recommendation: Keep the block length at the maximum value of 4096 and the sample rate at 44.1 kHz or 48 kHz.
ASIO™	This API is used with multi-channel sound cards. It enables low latencies and ensures that all input and output channels are in sync. Depending on the latency requirements of the audio signal processing provided by a loaded plugin (future feature) the block length can be reduced down to 64 samples. The RTA sample rate setting has to be equal to the audio device driver sample rate. It’s not required to select separate input and output devices for ASIO™.
Windows Direct Sound	This Windows API has improved latency compared to MME as it has more precise buffer control. Sample rate mismatches are handled by the operating system, similar to MME. Input and Output devices are to be selected separately, and they support a maximum of 2 channels.
Windows WASAPI	Is Microsoft’s most recent API. Latency has improved compared to MME and Direct Sound. This API does not support an output-only selection, as it requires a clock signal from the input. The operating system does not handle sample rate mismatches; instead, the user is responsible for ensuring that the sample rate of the physical device aligns with the RTA sample rate. Input and output devices must be selected separately, and both support a maximum of two channels. The following are the limitations of Windows WASAPI Bluetooth devices are not supported. For loopback devices, please ensure that the input device and output device are the same, with the input device name appended with ‘Loopback’.

 – It is recommended to use an ASIO™ sound card instead of Windows drivers if possible.
– When using Windows drivers, it is advised to use a block length greater than 1024 in order to avoid the noise distortion effect and high cpu load issues.
– The setting for the sample rate does not change the actual setting in the sound card driver. The alignment of the sample rate setting has to be ensured by the user.

Supported Soundcards
 -Fireface® UCXII
– TASCAM® US16-08
– Fireface® UC
– Ultralite® AVB, 18 x 18 USB/AVB Audio Interface (Motu)
– Focusrite® – Scarlett 2i4, 2nd Gen
– Creative Soundblaster® X4

During sound card configuration, channel streams should be automatically assigned with available input and output devices if the user has not already assigned any sound input or output devices to RTA Channel streams.

If the user attempts to unassign all sound card channels, a toast message should be displayed with a message like “You have unassigned all sound card channels. This will disable the internal IVP processing, because no lock master is available. Please assign at least one channel pair to re-enable the processing”.

If there are any modifications to the Sample Rate, Block Length, or Host API, it is necessary to reconnect the device Sound card settings impact in RTA

Microphone Setup

The Microphone Setup allows the calibration of microphones and assigns a mic compensation file for each microphone. The configured values will be applied across the GTT wherever microphones are involved, such as in the RTA and measurement modules.  This view can be accessed from the “Microphone Setup” button in the “Design” ribbon tab.

Every microphone element (1 or 6 microphone array) must be calibrated separately. The central element of the calibration menu is the list of microphones contained in the current microphone element.

The list has the following columns:

• Microphone: The number of the microphone within the element.
• Sound-In: The stream channel number is configured with the physical channel of the sound card in the Sound Card Setup view. Duplicate channel assignments to microphones are indicated in orange.
• Previous value: Offset measured during the previous calibration, displayed as a comparison.
• Current value: The offset measured during this calibration.
• Compensation File: This is the File provided by the mic manufacturer, which will be used for magnitude curve correction. The current supported format is a .txt file. The supported file format is attached here: M4261-Microphone-4881.
  

The type of the microphone element and the currently selected microphone within the element are indicated using an icon (green rectangle).
The soundcard and the selected microphone is displayed (yellow rectangle).
The reference sound pressure level of the calibrator can be selected in the upper right (red rectangle).

Multiple microphone carriers can be added or removed (purple rectangle). The currently selected/configurable microphone carrier is highlighted in blue.

To calibrate a microphone:

1. Choose the Microphone carrier and select the microphone you want to calibrate.
2. Assign the channel number. Auto-completion will assist in assigning available incremented channels.
3. Attach the microphone to the designated channel on the calibration device. This will connect the calibrator to the microphone itself.
4. Select the appropriate reference sound pressure level (SPL) for your calibration.
5. Click on Calibrate. The calibration process should take approximately 2 seconds.
   While calibration is running, observe the level meter (indicated as a black rectangle) for activity on the chosen input channel.
   The calibration will result in an offset value (displayed in red in the “current value” column).
6. Click on Apply to accept the value (which will turn the value green) or repeat the calibration process if the value is not satisfactory.
7. Click Apply confirms the calibration value, turns it green, and automatically selects the next microphone that needs calibration (if applicable).

Repeat the procedure for all microphones in the array.

Individual microphones can be recalibrated at any time. Once all calibration offsets are applied, the menu can be closed using “Ok”.

When configuring multiple microphone carriers, you can easily switch between them, and any changes you have previously configured will be automatically applied.

For any changes in the mic row, the user must click Apply to save the changes before clicking OK.

Import: The “Import” option allows you to import an existing calibration and compensation file path. This sets the current value for all microphones to the stored offsets. The values must be applied. Settings will be imported to the selected microphone carrier.

Export: Using “Export,” you can export a full set of applied calibrations along with the compensation file path to disk. Settings will be exported from the selected microphone carrier. The exported JSON files will contain the Channel Number, Offset, and mic compensation file of the calibrated microphones.