From Resound-wiki

Contents 1 Resound GUI 1.1 Matrix Tab 1.1.1 Inputs, Outputs and Cross-points 1.1.2 Audio Matrix Parameter Addresses 1.1.3 Locking and Unlocking Parameters 1.2 Master Tab 1.3 Collectives 1.3.1 Collective Builder 1.3.2 Working with Collectives 1.3.3 Parameter Scaling Factors 1.4 Behaviours Tab

Resound GUI

• The Resound GUI is where all the configuration and control of spatialisation takes place. The interface consists of three views: the Master Tab, Matrix Tab and Behaviour Tab, described below.

Matrix Tab

• The state of the Resound Server matrix can be viewed using the Matrix Tab.
• Matrix nodes can also be set manually on this page.
• The Matrix Tab is shown below (here, a 4-in 8-out matrix is shown: the actual size of the graphical matrix will depend on the number of inputs and outputs specified on the command line when resound_gui was started).

Matrix image - coming soon!

Inputs, Outputs and Cross-points

• The matrix inputs are coloured green and arranged vertically from top to bottom.
• Outputs are coloured red and arranged from left to right.
• Input-to-output cross-point nodes are coloured blue.
• The black-coloured node in the top-left is the matrix master parameter. If the master parameter is at zero, the overall amplitude of all the matrix nodes will also be zero. Fairly self explanatory.

Audio Matrix Parameter Addresses

• Audio Matrix Parameter Addresses (in effect, node numbers) can be viewed by hovering the mouse pointer over a node.
• For example the cross-point node between input 1 and output 7 is /am/att/1/7. In plain English, am stands for 'audio matrix,' 'att' for 'attenuator,' followed by the input number, then the output number. Input node 1 would be /am/att/1/0 (no output) and output node 24 would be /am/att/0/24 (no input), and so on.
• This is also the OSC address used to send information about the value of that parameter to the server. In other words, you could bypass the GUI and send matrix parameters directly to the Resound Server machine by sending values to OSC addresses in this format.

Locking and Unlocking Parameters

• The value of matrix nodes can be set manually (i.e. without making any fader assignments) by dragging the graphical matrix node in question. The set value will then be indicated in the node's value graph. In the diagram above it can be seen that some matrix nodes have had their values set manually in this way.
• When a matrix node is set manually in the Matrix Tab, it becomes locked, as indicated by a small white square in the node's value graph.
• While a parameter is locked in this way, it's value cannot be changed, even if the locked parameter has been assigned to a fader or behaviour. In other words, the locked parameter value takes precedence.
• A locked parameter can be unlocked by right-clicking on the locked node. The white square will then disappear and the value of the parameter can be adjusted by assigned controllers.

Master Tab

• The Master tab shows each of the thirty-two controls (represented graphically as faders) that are available for remotely controlling the audio matrix.

[Master Tab image - coming soon]

• Each Fader can control multiple parameters, which could mean Matrix parameters or the parameters of pre-defined Behaviours.
• You can assign parameters to a Fader by clicking the Fader's Assign button. This will allow you to build a Collective that contains all the different parameters to be controlled by the Fader. See the section on Collectives.

Collectives

• A Collective is a way of grouping parameters together in a specific order.
• A Collective can contain any number of elements, and each element can contain any number of parameters. Thus, the Collective is basically a two-dimensional array.

Collective Builder

• The Collective Builder dialog appears whenever you click on an Assign button. This could be a Fader's Assign button, or a Behaviour's Assign button. Here, you are effectively being asked to specify which parameters are to be controlled by that Fader or Behaviour. (Technically, the Fader or Behaviour actually controls the Collective, and the parameters are contained inside the Collective.)

[Collective Builder dialog image - coming soon]

• The top portion of the Collective Builder shows the parameters that are already contained within that Collective (in effect, the parameters that are already assigned to that Fader or Behaviour). If you have just clicked 'Assign' for the first time, the Collective will be empty.
• Matrix parameters can be assigned to the Collective by clicking on the required node(s) in the Matrix tab of the Collective Builder dialog. Behaviour parameters can be selected from the Behaviours tab. It is possible to assign a mixture of Matrix and Behaviour parameters to a Collective.

Working with Collectives

• If you left-click a parameter, that parameter will be added to a new element of the Collective.
• If you right-click a parameter, it will be added to the currently-selected element of the Collective.
• The currently-selected element is indicated by a red square above the element and can be chosen by clicking. New elements are added to the right of the currently-selected element. To add an element at the beginning of the Collective, select the very left-most of these boxes.
• Right-clicking on an element select box reveals a pop-up menu, allowing you to delete individual elements or shift them left or right within the Collective.
• If you are assigning parameters directly to faders, none of the above really make any difference, but it is important in the operation of certain Behaviours, which we will come to later.

Parameter Scaling Factors

• Each parameter contained within a Collective has a scaling factor associated with it. This can be seen in the Collective Builder Dialog.
• By default, the scaling factor is 1, but can be manually set to any floating point value between -2.0 and +2.0. This is done by dragging the scaling factor value graph of a parameter in the Collective Builder Dialog.
• Each parameter scaling factor acts as a multiplier between source (controller) value and target parameter value. As a simple example, consider a Collective containing only one parameter. The Collective is assigned to a fader. The fader value is effectively multiplied by the scaling factor, then mapped on to the parameter. If the scaling factor is 1.0, then the value of the fader will effectively be mapped directly on to the parameter. If the scaling factor is set to 0.5, then the full range of the fader will equate to 0.5 of the full range of the target parameter.
• The effects of scaling factors can be visualised in the Master Tab, by looking at the small VU meter widgets below each fader with parameters assigned. The effects can also be visualised in the Matrix Tab.

Behaviours Tab

• We have already seen that a Collective can be controlled directly by a Fader. A Behaviour is a different way of interpreting a Collective.
• The Behaviours Tab shows you the Behaviours that have already been defined within the system. If you are looking at it for the first time, it will be empty.
• A Behaviour can be created by clicking the Create Behaviour button. This will pop-up the Select Behaviour dialog, from which you can choose one of several Behaviours.
• Once created, it can be seen that a Behaviour has a number of parameters and an Assign button.