jmod.sur.ambi.decode~

Decoding ambisonic signal to multispeaker setup. NOTE: The positions of the speakers are not maintained by this module.

Table of Contents | Index of Modules | Credits | Donate | Jamoma.org

Configuration

Module Type: control
Algorithm Type: default

Interface Size: 300x70 pixels

Number of signal inlets: 0
Number of signal outlets: 0

Parameters

/name /type /range/bounds /range/clipmode /ramp/drive /ramp/function /dataspace /dataspace/unit /repetitions/filter /description
audio/gain decimal 0 127 none scheduler linear gain midi 1 Set gain (as MIDI value by default).
audio/mute boolean 0 1 none none linear none none 1 When active, this attribute turns off the module's processing algorithm to save CPU
flavor string 0 1 none none linear none none 1 Ambisonics type of decoding and encoding. Furse-Malham, N3D or SN3D
numSpeakers integer 1 32 both none linear none none 1 The number of audio channels that the ambisonic signal is diffused to. Changes only take effect when audio is off.
order integer 1 3 both none linear none none 1 Order of decoding for ambisonic signal. Changes only take effect when audio is off.
orderWeights decimalArray 0 1 none scheduler linear none none 1 manually set weights for given number of orders.
view/freeze boolean 0 1 none none linear none none 1 Turn off the updating of user interface elements when parameters change. This may be done to conserve CPU resources.
view/highlight string 0 1 none none linear none none 1 Highlight the module with a color tint such as red, green, or similar.

 

Messages

/name /type /range/bounds /range/clipmode /ramp/drive /ramp/function /dataspace /dataspace/unit /repetitions/filter /description
documentation/generate generic 0 1 none none linear none none 1 Generate a html documentation page for this module and save it to disk. The argument 'tex' creates a Latex document.
init none 0 1 none none linear none none 1 Initialize a module completely to the original state.
preset/clear none 0 1 none none linear none none 1 Clears all presets, providing a blank slate for saving new presets.
preset/copy generic 0 1 none none linear none none 1 Create a new preset (2nd argument) by copying the contents of another preset (1st argument)
preset/default none 0 1 none none linear none none 1 Open the default preset file and recall the first preset in that file.
preset/dump none 0 1 none none linear none none 1 Dump all preset names.
preset/interpolate generic 0 1 none none linear none none 1 Interpolate between two named presets (argument 1 and 2) using a ratio (float in the range [0.0, 1.0]) specified as the third argument.
preset/mix generic 0 1 none none linear none none 1 Mix list of pairs of (preset name, mix value) using a ratio (float).
preset/post none 0 1 none none linear none none 1 Post all presets to the Max window.
preset/read generic 0 1 none none linear none none 1 Open an xml-preset file and recall the first preset in that file. An optional argument defines the file to open.
preset/recall generic 0 1 none none linear none none 1 Recall a preset by number - you can also choose presets from the module menu.
preset/store generic 0 1 none none linear none none 1 Store a preset by number in memory. All presets present in memory will be written to disk when you send a /preset/write message to the module.
preset/storecurrent none 0 1 none none linear none none 1 Store on the last recalled or stored preset
preset/storenext none 0 1 none none linear none none 1 Store a preset in the next preset slot. Handy so that you do not need to specify a preset number manually.
preset/write generic 0 1 none none linear none none 1 Write an xml-preset file to disk. An optional argument defines the file to open.
preset/writeagain none 0 1 none none linear none none 1 Write on same xml-preset file.
report generic 0 1 none none linear none none 1 reports the state of the ambiencode external in the max window
speaker.1/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.1/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.1/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.10/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.10/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.10/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.11/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.11/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.11/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.12/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.12/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.12/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.13/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.13/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.13/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.14/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.14/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.14/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.15/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.15/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.15/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.16/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.16/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.16/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.17/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.17/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.17/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.18/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.18/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.18/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.19/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.19/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.19/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.2/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.2/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.2/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.20/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.20/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.20/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.21/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.21/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.21/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.22/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.22/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.22/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.23/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.23/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.23/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.24/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.24/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.24/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.25/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.25/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.25/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.26/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.26/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.26/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.27/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.27/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.27/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.28/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.28/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.28/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.29/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.29/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.29/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.3/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.3/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.3/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.30/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.30/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.30/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.31/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.31/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.31/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.32/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.32/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.32/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.4/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.4/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.4/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.5/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.5/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.5/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.6/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.6/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.6/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.7/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.7/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.7/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.8/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.8/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.8/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
speaker.9/active boolean 0 1 none none linear none none 1 active 0 will mute the Nth speaker.
speaker.9/gain decimal 0 1 none none linear none none 1 gain value of loudspeaker channel
speaker.9/position decimalArray 0 1 none none linear position xyz 1 Position of the Nth speaker. In cartesian coordinates (xyz) by default
view/color/border decimalArray 0 1 both none linear none none 1 The border color of the module in the format RGBA where values range.
view/color/contentBackground decimalArray 0 1 both none linear none none 1 The background color of the module in the format RGBA where values range.
view/color/toolbarBackground decimalArray 0 1 both none linear none none 1 The background color of the module's toolbar in the format RGBA where values range.
view/color/toolbarText decimalArray 0 1 both none linear none none 1 The color of the module's toolbar text in the format RGBA where values range.
view/internals none 0 1 none none linear none none 1 Attempts to open the internal algorithm for viewing. This works for most modules. Some modules may choose to cloak the algorithms - preventing this message from functioning.
view/panel none 0 1 none none linear none none 1 Open an a module's control panel (inspector) if one is present.
view/refresh none 0 1 none none linear none none 1 Update displayed values for module to reflect current state.
view/script generic 0 1 none none linear none none 1 Low-level module hacking. Any arguments arguments to this message will be interpreted as patcher scripting for the top-level patcher of the module.
view/size generic 0 1 none none linear none none 1 The size of the module's UI: [Width Height]

 

Return

/name /type /range/bounds /range/clipmode /ramp/drive /ramp/function /dataspace /dataspace/unit /repetitions/filter /enable /description

 

About Jamoma

Jamoma is a system for creating and exchanging structured Max patches. It consists of both a set of guidelines and an implementation of those guidelines. For more information please visit jamoma.org.