Device Operations

This section explains the device operation features available at the bottom of the Device Designer workspace.

Load Device Config

When there are no core objects in the cores, the Load Device Config option is enabled. The Physical Cores and Virtual Cores (available within a Physical Core) as well as their connection points that were fetched from the target during device discovery are visible after the device has been loaded. Since they are read from the device, the number of virtual cores and their connection points cannot be changed.
You can connect core objects by dragging them onto the virtual cores. Alternatively, you can select the “Load Device Config” option, which will read the target’s device routing information as well as the layout and routing between core objects and display it on the GUI.

In the device view, a property section has been added to display and change the properties of chosen Core or Core Objects. When the virtual core or core object is selected, their respective properties are shown on the screen.

If you don’t clear the device view first, you won’t be able to save or access SFD.

The device identification feature is enabled for audio libraries version 13 and higher.

Connect Blocks

You can auto-connect selected devices, cores, and core objects using Connect Blocks.
A screenshot of a computer Description automatically generated with medium confidence

Choose at least two cores and click Connect Blocks.

You can auto-connect the following components.

  • Device – Virtual Core(s)
  • Virtual Core(s) – Virtual Core(s)
  • Virtual Core – Core Objects (within selected Virtual Core)
  • Core Object(s) (within same Virtual Core)

Edit Device

In Device File Editor you can modify the device configuration, then perform “Save Device Template” or “Update Device” operation.

Send Device Config

You can create your own configuration and write this configuration to the target device. The Send Device Config option sends the device configuration (Core Objects, Device Routing, and Virtual Core routing) to the target device.
Before sending the device configuration, all the input and output connection points of the core objects must be connected. If any of the pins are not connected, an error message is displayed.
Graphical user interface Description automatically generated

The Device view (number of Cores, Physical Cores, Connection points, Sample Rate, and Block Length) inside GTT and the data inside the Device. The flash file on the target should match before Sending the Device configuration. If the data doesn’t match then the below transmission error is seen

The data in the device view (number of cores, physical cores, connection points, sample rate, and block length) and the data in the device. The flash file on the target device should match before the device configuration is sent. If the data doesn’t match, you will see the transmission error.
Graphical user interface, text, application Description automatically generated

If any changes are made to the configuration, the send device config must be completed before sending the signal flow.

The device identification feature is enabled for audio libraries version 13 and higher.

Feedback Loop

In the device view, feedback connections are allowed. You can connect the output of any core object as input to any other core object.

Core object Id defines the order of execution of core objects. Execution order of any core object depends on the IO dependency. IO side dependency is not considered when there are feedback loops.

Self-loop is not supported as feedback.

In the image, connection highlighted in green color is a feedback connection.

Send Signal Flow

The Send Signal Flow option sends the configuration of the signal flow design to the target device. You can also use this to test how the target device responds to specific test signals. In a test scenario, you can configure specific test signals and send them to the amplifier.
Graphical user interface Description automatically generated

Export

Using the Export option in the device view, you can export the device configuration data and the signal flow design details.

*.Core files would be created for each Virtual Core available in the device. One *.route file will be created for Device routing data. One .mcd file will be generated for master control data and one .SFD file will be generated per instance per core.
Graphical user interface Description automatically generated

  • One core file per virtual core in the signal flow.
  • The core objects within the virtual core.
  • The routing within those objects.
  • The destination of the output pins of the virtual core.
  • One signal flow file per xAF instance.
  • This is the same legacy file.
  • One input device routing file.
  • This basically describes how the device input buffers are connected to the virtual cores and/or the device outputs.

Control IDs

The Control IDs are used to configure Custom Control IDs. You can add, edit, export, and import Custom Control IDs data. For more details, refer to Configure Control IDS.
Graphical user interface Description automatically generated

Device View

The Device View is used to view and modify detailed information and settings for a specific device. Double-click on the desired device from the list to open a device template in the Device View.

Related Topics

Device Object Properties

A device is a combination of four layers: Device Layer, Physical Layer, Virtual Core Layer, and Core Object Layer. When you select any of the layers, you will see the properties of the selected layer on the right side.

Device Layer: Device layer properties include Device Name, Hardware, and Software version.

Device layer properties are not editable.

Graphical user interface Description automatically generated

Physical Core Layer: Physical Core layer properties include Physical Core Name, Physical Core Type, and MIPS.

The “Physical Core Name” property in the Physical Core layer properties can be changed, but the “Physical Core Type” and “MIPS” properties are non-editable.

By default, the “Physical Core Name” property value is the same as the “Physical Core Type”. If you want to change the physical core name, enter the value for “Physical Core Name”, the updated Physical Core layer value will be reflected in the device view, then click on the save button to save the changes.

Only from the Device File editor window, you can update the Physical Core Type.

If you keep the Physical Core Name field empty, GTT will ask you to enter the valid name for “Physical Core Name”.

Virtual Core Layer: Virtual Core layer includes the following properties:

  • Core ID: Display the core ID.
  • Core Name: Display the core name.
  • Data Format: Display the date format type.
  • Task Priority: Display the date priority value.
  • Queue Size: Size of message queue
  • Guard Time: Time to avoid message processing as a percentage of interrupt time.
  • Ramp Time (ms): Duration between two processing states (in ms), when the Core Object processing state is enabled.
  • Core Object Processing State: Enable or disable the processing state for Core objects in the core.
  • Streaming: Enable or disable streaming. Enabling the streaming option allows you to set “State Variables”, “Probe Points “, and “Level Meters”.

Queue Size and Guard Time will be supported only for Devices with audio library version “O” release and above or “M+2” release and above.

Enable Core Object Processing State and Ramp Time will be supported only for Devices with audio library version “O” release and above.

Processing state for Core objects will be applied only if Enable Core Object Processing State was enabled before Send Device Configuration.

Enable Probe Points and the Number of Probe Points will be supported only for Devices with audio library version S release and above.

Core Object Layer: Each core object has different properties. For more details refer to the ToolBox.

Magnifier Options

A picture containing graphical user interface Description automatically generated

  1. Fit to Window: Click on this button will change the current view to the size of your device view window.
  2. Zoom to 100%: Click on this button will return the view to 100% zoom.
  3. Zoom In: Click on this button (+) to zoom in for gradual increments.
  4. Zoom Slider: Slide to the desired percentage zoom setting.
  5. Zoom Out: Click on this button (-) to zoom out for gradual decrement.

Undo and Redo Operation

The undo and redo feature allows you to reverse or redo previous actions.

  • Undo: The undo feature allows you to reverse the previous action by restoring the design state to a previous design state.
  • Redo: The redo feature allows you to perform the action that is undone.

Undo/Redo operation is supported for the following actions:

  • Adding/ Removing core objects.
  • Adding, removing, and changing connections.
  • Changing core and core object position.
  • Changing core and core object properties.

The scope of undo/redo is within the selected device.

Undo/redo action will not restore the tuning data state.

This feature is limited to 1000 actions.

When a new manual action (dragging new object, changing connection or position etc) is performed, all existing redo records will be cleared. As a result, it will not be possible to redo any previous actions.

Properties Panel

Graphical user interface, application, chat or text message Description automatically generated

  • Class Name: Display type of device and this property is read-only,
  • Audio Library Version: Display the audio library version used in the selected device. You can change the audio library version. On the property panel, click on the audio library version, select the desired audio library version, and click save.

    If a device has a signal flow with audio objects created in an older version, compatible audio objects will upgrade automatically. Non-compatible audio objects in Signal Flow Designer will be highlighted in blue or displayed as a warning in the compiler; these audio objects can be upgraded using the audio object context menu.In the following cases device association with a dll cannot be changed.

    • If a device’s signal flow is open.
    • If you have a monitoring window open, such as a streaming or profiler window.

    A change in dll association for one device has no effect on other device instances.

  • Device Id: Enter the ID of the selected device. Make sure the device ID should be unique.
  • Node Address: The Node address of the selected device. Each device has a unique node address assigned to it.
  • Name: Name of the device.
  • MaxTuningDataSize: Maximum tuning data.
  • System Context: Set the system context Init or Runtime.

Core Objects Toolbox

The Toolbox contains the core objects that were retrieved from the xAF dll. The objects that can be used within the core to create the device signal flow are called core objects. Each core object has its own purpose and solves parametric issues which block routing within the core.

Core Objects are classes that are part of the Audio Core (virtual core) class and operate at a higher level than audio objects. The audio processing class itself is a core object. The relationship between core objects and Audio core is similar to that of audio objects and the Audio Processing class.
Graphical user interface Description automatically generated

The execution order (or index) of the core object is displayed by Core Object Id. Routing determines the order in which core objects are executed within a core. The core objects that are connected to the core input will be executed first, and the core objects that are connected to the root object after that will be given the next execution order.

The device identification feature is enabled for audio libraries version 13 and higher.

Xaf Instance

The Xaf Instance is the core object inside which the signal flow for that instance can be created.
Graphical user interface, text Description automatically generated

  • Core Object Id (execution order of core-object with-in core) and Instance Id (index of xAF instance with-in core, based on execution order) will be displayed as read-only fields.
  • The sample rate and block length of the instance will control signal flow within the instance. You can change the sample rate and block length of the instance in the properties section.
    Graphical user interface, application Description automatically generated

Further information on signal flow creation is available in the GTT Signal Flow Designer guide.

Buffer

Buffer core object is used to convert the input block length into the required output block length. The buffer core object has an equal number of input and output channels. It can be used as a pass through core object OR it can be used to, as its name suggests, buffer samples from the input to the output. The object does not change the sample rate (it is the same at the input and the output).
Text Description automatically generated with low confidence

If you want to connect two core objects with different block lengths, you can use a buffer core object. As a result, the input block length will be the Block Length of the first core object, and the output block length should be the Block Length of the other core object.
Graphical user interface, application Description automatically generated

It can be configured as follows:

  • If the input block length is equal to the output block length, then it behaves as a pass through object (so you could have an audio core with a buffer object to connect the core input to the output)
  • Input and output block lengths must be integer multiple of each other
  • When input and output block lengths are not equal, the object handles taking in input at a lower block length and outputting it at a higher one and vice versa. For example, it facilitates the connection of an object at block length 32 to an object at block length 64

Introducing this object into your signal flow for any case but pass through WILL result in latency at the output.

Splitter

Splitter core object is used to convert one input to multiple outputs of the same sample rate and block length.
Text Description automatically generated

  • This core object always has a single input.
  • In order to make routing from any core object to the splitter both the source core object and splitter core objects sample rate and block length should match.
  • Number of output channels for the splitter is configurable.
    Graphical user interface, text, application Description automatically generated

It is not to be confused with the Splitter audio object.

This object operates in parallel to an xAF instance NOT within it.

Merger

Merger core object is used to merge multiple inputs into a single output of the same block length and sample rate.
Text Description automatically generated

  • This core object always has a single output.
  • In order to make routing from any core object to merger both the source core object and merger core objects sample rate and block length should match.
  • Number of input channels for the merger is configurable.
    Graphical user interface, application Description automatically generated

It is not to be confused with the Merger audio object.

This object operates in parallel to an xAF instance NOT within it.

Ssrc lir Int

Synchronous Sample Rate Converter (SSRCs) is used to convert the input sample rate to the required output sample rate.
SSRCs are core objects that can operate within an audio core. Currently there is one implementation of SRCs in Awx.
Text Description automatically generated

Two options are provided to convert the sample rate. Both these options are mutually exclusive.
Graphical user interface Description automatically generated

IIR Integer Multiple SSRC

This core object implements a synchronous sample rate converter whose input sample rate / input block length and output sample rate / output block length are integer multiple of each others. This is also an infinite impulse response implementation (IIR).

The object operates in one of 2 modes:

  • User Coefficients mode
  • Predefined Coefficients mode

Before we get into the details, there are some common configuration parameters between the two.

  • The input block length needs to be set by the user.
  • The Biquad filter topology. Currently 2 topologies are exposed.
    • Direct Form I
    • Direct Form II

User Coefficients mode: In this mode, the user has to provide the input and output sample rate. Input and output sample rates should not be equal. The Number of Biquads field is read-only.
User has to import the coefficients by clicking on the button “Import Co-efficients”. Based on the number of coefficients in the file, the Number of Biquads is updated.

Validations for User Coefficients mode: The Input and Output sample rates cannot be the same. Validation is shown when the same values are entered.
A screenshot of a computer Description automatically generated with medium confidence

After adding a new “Ssrc lir Int” object and selecting “User Coefficients Mode”, if the coefficients are not imported, the following message will be displayed on various operations such as “Save”, “Edit Device”, “Copy Core Objects” and “Paste Core Objects”. After importing coefficients, the user can perform the required operation.
Graphical user interface, text, application Description automatically generated

Predefined Coefficients mode: In this mode, the xAF dll is used to read the input sample rate, output sample rate, and the number of biquads. When a value in the combo box is selected, the xAF dll is also used to fetch the corresponding coefficients.

Biquad Co-efficient has to be re-imported whenever the mode is switched between Predefined Co- efficient mode to User Co-efficient mode.
A screenshot of a computer Description automatically generated with medium confidence

For these pre-defined coefficients, the quality measures are as follows:

  • Signal to noise ratio: 80 dB
  • Total harmonic distortion: 2e-3f
  • Spurious free dynamic Range: 59 dB
  • Total harmonic distortion plus noise: -60 dB
  • Frequency response flatness: 3 dB

Output block length (Displayed as a read-only field) = (Output sample rate /Input sample rate) * Input block length.

Float to Fixed

Float to Fixed core object accepts audio buffers that are in floating point format and outputs buffers that are in fixed point format (16-bit, 24-bit, 32-bit etc).
Graphical user interface, text Description automatically generated

  • # of Channels is configurable. No of Input channels = No of Output channels
  • The user can configure the scalar value to indicate what fixed point format is required. This scalar value is multiplied by the floating point input samples to convert them to fixed point.
    For example, to convert from float to 32 bit fixed point, this scalar value must be:
    (1 << (32-1) – 1) = 2,147,483,647
  • In order to make routing from any core object to Float2Fixed object both the source core object and Float2Fixed core objects sample rate and block length should match.

Float To Fixed core object is enabled for audio libraries version 16 and greater.
Graphical user interface, application Description automatically generated

Fixed to Float

Fixed to Float core object accepts audio buffers that are in fixed point format (16-bit, 24-bit, 32-bit, etc) and outputs buffers that are in floating point format.
Graphical user interface, text Description automatically generated

  • # of Channels is configurable. No of Input channels = No of Output channels.
  • The user can configure the scalar value to suit the fixed point format of the input samples. The reciprocal of this scalar value is multiplied by the fixed point input samples to convert them to floating point.
    For example, to convert from 32 bit fixed point to float, this scalar value must be:
    (1 << (32-1) – 1) = 2,147,483,647
  • In order to make routing from any core object to Fixed2Float object both the source core object and Fixed2Float core objects sample rate and block length should match.

Fixed To Float core object is enabled for audio libraries version 16 and greater.
Graphical user interface, application Description automatically generated

Nan Detector

The NaN (Not a Number) detector core object detects NaN from input samples and informs the platform using an xTP command if NaN is found. The xTP command will inform about the core id, core object instance id and channel index, so that platform can react accordingly by muting or resetting states. The input samples are copied to the output without doing any other processing. The number of output channel(s) is always same as the number of input channel(s).
Graphical user interface, text Description automatically generated

  • # of Channels is configurable. No of Input channels = No of Output channels.
  • Block length and Sample rate are configurable.
  • The number of input channels is user configurable and ranges from 1 to 255.
  • This core objects’ block length and sampling rate are the same at both input and output side.
  • Block length is configurable in the range of 4 to 4096 samples.
  • Sample rate is configurable in the range of 8 kHz to 192kHz.

In order to make routing from any core object to NaN Detector, both the source core object and NaN Detector core objects sample rate and block length should match.

NaN Detector core object is enabled for audio libraries version 19 and greater.
A screenshot of a computer Description automatically generated with medium confidence

Core Objects Validation

When the GTT is loaded with a version of the xAF library lower than 13. If a user tries to open a device view that contains core objects other than a XAF instance, they will see the following error message.
Graphical user interface, diagram Description automatically generated

Aside from the Xaf instance, every other core object will be red.
Graphical user interface Description automatically generated

MIPS

The MIPS window presents the CPU load of cores, core objects and audio objects of the connected device.

MIPS profiling data is fetched from the device (hardware) using xTP Commands and the user can optimize signal flow based on this information.

MIPS window is enabled only when the device xAF dll version is 18.x.x.xxx or higher.

Signal flow should be flashed before launching MIPS.

MIPS profiling data of non-xAF instance core objects (Buffer,Splitter…etc) is available only from X release(24.x.x.xxxx) audio library onwards.

Launch MIPS Profiling

Steps to launch MIPS profiling:

  1. Select the device node and click MIPS. This opens the MIPS window for the selected device.
    MIPS measurement on (0x64000501) and Audio Object level MIPS measurement off command (0x64000504) will be sent while opening the MIPS window and a progress window will be seen as per the below screenshot.

The following command will be displayed in the xTP Log Viewer.

Summary Tab

  • Present virtual core and core object MIPS data (Average MIPS and Maximum MIPS) retrieved from the device using the xTP Command.
  • MIPS data displayed on the physical core are the aggregated values of its virtual cores.
  • Audio Object level MIPS measurement off command (0x64000504) will be sent while switching to the Summary tab from the Instance tab and a progress window will be seen as per the below screenshot.

Below command will be seen in xTP Log Viewer.

Instance Tabs

  • A new tab corresponding to the selected instance will be loaded, displaying audio-object MIPS data retrieved via the xTP Command.
  • Inner audio objects will be displayed alongside compound audio objects for compound audio objects.
  • Audio Object level MIPS measurement on command (0x64000503) will be sent while opening a new Instance tab or switching to the Instance tab from the Summary tab and a progress window will be seen as per the below screenshot.

Below command will be seen in xTP Log Viewer.

Reset

When you click the Reset option, the MIPS number for the device will get reset for the selected tab and Reset command (0x64000500) will be sent and a progress window will be displayed as per the below screenshot.

Below command will be seen in xTP Log Viewer.

Refresh MIPS: When you click the Refresh Mips option, the MIPS data for the current tab will be refreshed.

Export to CSV: When you select the Export option, the Mips data for the current tab will be exported to a CSV file. The CSV format is shown below.

Summary Tab
Instance Tab

Closing MIPS Window: When you click on cross (x) to close the MIPS window, the MIPS measurement off command (0x64000502) will be sent and a progress window will be displayed as per the below screenshot.

Below command will be seen in xTP Log Viewer.

Link Window

The Linking Window is designed to assist you by reducing the number of audio parameter configurations. It enables you to organize the filters and channels. When you set one item in a group, the remaining items in the group will have the same value.

By default, all the groups link are enabled. If you want to disable the specific group link, click on the toggle button to disable it.  GTT will store the group linking status in project file.

If you want to disable all the groups link, select the Disable Linking checkbox.

Create a New Group

Steps to create a new group:

  1. Open Linking Window, expand the task, and drag-drop the object to the right-side section under Groups. A new group is created, expand the new group. Under the new group, you can view the added object.

Renaming Groups: Double-click on a group name to rename it.

Only groups can be renamed; Audio objects cannot be renamed.

Removing Objects: Click on the remove icon to remove the object. This will also delete all child objects.

Removing Groups: Click the remove icon to the right of the group. This will also delete all child objects.

Add Object to Existing Group

Steps to add object to an existing group:

  1. Open Linking Window, expand the task, and drag-drop the object to the right-side section under target group. A new group is created, expand the new group. Under the new group, you can view the added object.

If an object cannot be added to a specific group, the color of that group will change to grey.

If the object is added to the group, the color of the group will change to blue.

Linking Rules

  • Each of the audio objects can be part of only one group.
  • If a child audio object is part of a group, the parent element cannot be part of that group.
  • Groups can contain only one type of audio object. For example, you cannot link a Biquad with a Delay. Each group can contain more than one AO.
  • Objects in groups are linked according to their order. For example, if you link two EQ channels, the first Biquad from the first channel will be linked with the first Biquad from the second channel.
  • Changing links is done live. You do not need to close the window for the changes to be working.

Controller

The controller window is used to send instance commands.

The controller feature is enabled only when the device xAF dll version is lower than 18.x.x.xxx.

Steps to setup controller:

  1. Enter a valid Core Id and Instance Id and click on Get Status to get the current available slot of the device. The response from the device will be displayed in the Response section.
  2. Click Save to save the current instance data on the device to the memory slot entered.
  3. Click Load to load the data from the memory slot to the device RAM.

If there is any error in the device connection or if any invalid Core Id and/or Instance Id were entered, the error message “Request failed!!!! Please make sure […]” will be displayed.

Default Control-Ids

The Configure Default Controls option allows you to specify which default control ids should appear in the “Control In” control list.

To Configure the Configure Default Controls:

  1. Click on Default Control-Ids. This opens the Configure Default Controls window.
    If no configuration is defined, all Control IDs are selected in the Configure Default Controls window.

    In the Configure Default Controls window, you can select or unselect control IDs.

    You cannot deselect the Control ID used in the Signal Flow Designer.

  2. Select or deselect the required control Ids and click Save to update the configuration.

Use the search text box to search and filter the control Ids.

Once you have modified the Configure Default Controls data, you can verify the changes.

Go to the Signal flow designer window and open the Control In property window to verify the configured default control IDs along with custom control IDs.

Sort Control In Pin Data

The Control In panel shows all user-configured control pins data.

You can click on any of the column headings to sort the data. Clicking alternately will change the sorting direction from ascending to descending or vice-versa.

The ascending order of the Pin column is the default sort order for the Control In panel.

Click on any column header to sort the respective data on the Control In panel.

State Variable

The State Variable Explorer window allows you to view the memory layout of each device instance. It can also be used to send and receive tuning data.

To copy values of FloatArraySV type state variable to the Windows clipboard, press CTRL+ C in the table . The float values are located in the clipboard. The same can be achieved by using the context menu (Copy All) of the table.

File: Using the file options you can load and save the set file.

  • Load Set: To load a set file, click on “Load Set”. Browse the location of .set or .setr file and click “Open”. This loads the set or .setr file in State Variables explorer.
  • Save Set As: To save a set file, click on “Save Set As”. A dialog box will appear, where you can choose the folder to store the files (.set/.setr). Enter a file name and click on the “Save” button.

Target: Using target options you can send or receive tuning data from the connected device. When the device is connected you will get the following options.

  • Send Tuning Data
  • Receive Tuning Data
  • Receive State Data

Sort by: Using sort options you can sort the state variables and audio objects in the state variable explorer.

  • Name: To sort the audio objects or state variables based on their names
  • Block Id: To sort the audio objects or state variables based on audio objects block Id.
  • Object Type: To sort the audio objects or state variables based on audio object types.
  • HiQnet Id: To sort the audio objects or state variables based on audio object HiQNetIds.

When you click it the first time, it will sort in ascending order; the next time, it will sort in descending order, and so on.

Search: Using the search option, you can locate and highlight a matching record and move on to the next or previous matching data set.
It will search audio objects and state variables based on Name, Block Id and HiQnet Id.

Reset: The Reset option will clear all search and sort data and reset state variable explorer to default state.

Devices List

The Devices section allows you to perform the following actions:

  • Add a new device to the project.
  • The Discover Device option allows you to discover connected physical or virtual devices and GTT will interact with the target device to obtain the device information available on the device.
  • Display lists all the devices in a project.
  • Provides options to remove the device from the project.
    Graphical user interface, application Description automatically generated

On the Device Designer tab, click on the (+) icon to add the device. This opens the Add Device dialog box.

On the Add Device, you can perform the following operations.

  • The Add Device dialog box lists existing device templates available in GTT.
  • You can add new device templates using any of the methods; Discover Device, Create Light Device, or Create Device File options.
  • You can delete existing device templates if they are not used in a project.
  • Custom Device is also listed in the Device template list as the first template. You can select a custom device and add it to the project like other templates.

GTT supports 1 custom device at a time as per the current design.

You can use any of the options to add a device template to the project.

  • Discover Device: Click on Discover Device, if you have the preconfigured device template available and connected to the physical or virtual device.
  • Create Light Device: Click on Create Light Device, if you want to create a new template.
  • Create Device File: Click on the Device file, if you want to create a device file.
  • Device Template Rename: Rename the selected device template post creating a light device, discover the device template, create a device file, or any existing device template.

Discover Device

The Discover Device feature allows you to read and write the device configuration from or to the device.

This function allows you to read information from a device that is connected to the Global Tuning Tool. This information is used to create a device template that reflects the internal layout structure of the device, which includes its physical cores, virtual cores, and routing information from device input to virtual cores between virtual cores and core objects.

You can also write (download) your configuration to the device using this feature.

Below are the few details that GTT will get from the device to construct the inner layout.

  • Physical cores information.
  • Core information.
  • Core objects information.
  • Device and Virtual Core Routing (For more details refer to Device Routing)

Below are the prerequisites to start a Discover a Device.

  • Copy the flash file (device.flash) and the audio library xAFVirtualAmp.dll file available in AWXInstalledLocation/HarmanAudioworX/AudioFrameworkDLLs to your working folder.
  • Launch IVP, open to “Advanced” settings, go to the “Plugins” tab and select the correct path to the xAFVirtualAmp64.dll.

Before using this feature, delete all the *.flash files from the working folder. IVP may crash, if it has the old tuning flash files.

Follow the below steps to discover a device:

  1. On the Add Device window, click on Discover Device. The GTT will start to communicate with the target device, gather the device information, and add the device to the device templates.

The device identification feature is enabled for audio libraries version 13 and higher.

Only after you have completed the prerequisites the Discover Device feature function will work properly.

Create Light Device

Using the Create Light Device option, you can create a new template.

Follow the below steps to create a device template:

  1. On the Add Device window, click Create Light Device. This opens the Add Device dialog box.
  2. Enter the details in the following fields and configure the device core type.

    • Reference ID: Enter the reference ID of the template.
    • Device ID: Enter the initial value of the Device ID field for the first device instance created out of that template Device template name.
    • Device Name: Enter the device name.
    • Brand: Enter the brand name required for legacy AA infrastructure.
    • Family: Enter the family name required for legacy AA infrastructure.
    • Number of Channels: Enter the number of channels supported by the device.
    • Max Tuning Data Size: Enter the maximum count of bytes included in a single tuning data message.
    • Communication Type: Select ID-based tuning or address-based tuning.
      • IdBasedTuning –
      • AddressBasedTuning –
    • Core(s): Each device template exposes one or more physical cores.

    For the xAF library before the O release: multiple cores from the given list can be selected.
    Graphical user interface Description automatically generated
    For the xAF library from O release: Cores can be added/removed. Core types and Data-formats supported by xAF will be listed for configuring the core.
    Graphical user interface Description automatically generated

  3. Click Add Core, select core type and date format from the drop-down list, and then click Ok.
    When the default xAF library version is < 15 (O dll), GTT displays a static set of core types with corresponding data formats.
    Based on the default xAF library selected, you can add multiple cores, and two modes of core selections (Core Type and Date Formate) are available. Below is the example showing the available core type supported by respective xAF dll versions.
    Graphical user interface, application Description automatically generated  Graphical user interface Description automatically generated
    While configuring the core type of the device, if you want to remove any core, select the core, and click Remove Core.
  4. Click OK. The new template is added to the device templates list.

Create Device File

The GTT allows you to create a device flash file using Device File Editor (DFE) in a project. The device file is a combination of Physical Cores, Input Groups, and Output Groups.

Follow the below steps to create a device file:

  1. On the Add Device window, click Create Device File.

    This opens the Device File Editor window. The editor interface uses a tree-like structure to display items at each level and this structure is defined in the xTP specification. Furthermore, a Virtual Core will have Input and Output Groups as defined by the xTP specification. Each Input Group and Output Group have one group added by default.
    By right-clicking on each item, a context menu will appear that will allow you to add or remove subtree items.
  2. Select Physical Cores and enter the hardware and software version.
    There could be one or more Physical cores under a Device and each Physical core can have more than one virtual core inside it.
  3. Right-click Physical Cores and select Add Physical Core.
    A screenshot of a computer screen Description automatically generated with medium confidence
  4. Select Physical Cores 0You must specify the Core Type of Physical Core. When the default xAF library is set to O release or above, the supported xAF core-types will be listed or set the default value to ‘0’.
    Text Description automatically generated with medium confidence
  5. Right-click on Physical Cores 0 and select Add Virtual Core.
    A screenshot of a computer Description automatically generated with medium confidence
  6. Select Virtual Core 0, enter the Task Priority, and select the Date Format.
    A picture containing treemap chart Description automatically generated
    A Virtual Core is made up of Input and Output Groups. You can add one or more Physical Cores, and each Physical Core can have many Virtual Cores.

    It is important that you should specify the Core-type of the Physical Core, Data Format of the Virtual Core, Device Input, or Output Group.

    When the selected default xAF library is “O” release or above, the xAF supported data formats will be listed or the default value set to ‘2’.

  7. Expand Input Groups, select Group 0, and configure the respective properties. Similarly, expand Output Groups, and configure Group 0. In order to allow routing from Device Input/Virtual Core to other Virtual Cores or Device Output Groups, select Connectable Cores and Connectable Device Output Groups.
    You can add multiple Groups inside an Input Group.
  8. Once all the configuration is done, click Save Device File. A save file dialog box appears, enabling you to save the flash file.
    The flash file contains the information related to the  structure of the device like Device ID, hardware version, software version, input groups count (No. of input pins), output groups count (No. of output pins), physical cores count,
    Graphical user interface, application Description automatically generated
    To view or modify an existing flash file, click Load Device File. The Device File Editor displays an Open file dialog box, selects the flash file, and clicks Open.
    Graphical user interface, application Description automatically generated

Device Template Rename

You can rename the selected device template post creating a light device, discovered device, or any existing device template.

Custom devices would not have the option to rename the template name.

Device name once edited, any device created using this template will have the appropriate name reflected in Class Name, reflecting the template on which the device is based.

To Edit the name, press the edit button, which will show an editable section with the selected device name in it.

Upon editing the name click on “Ok” and the template name will be applied. The device name allows only alphabet, numeric, and hyphen (-) and has a limit of min 1 character and max 55 characters.

When there is a validation error in the name, the “Ok” option will be disabled, and the edit box will be shown as red.

Device template name is also retained when exporting or importing the project. Name of imported device template would be based on existing uniqueness naming rules.