index :: spat

hoa.3d.decoder~

hoa 3d decoder

available since version: 0.9.7

---

information

Decodes an ambisonics soundfield for several loudspeakers configuration or for headphones.

arguments:

• ORDER the order of decomposition
  type: int
  

• MODE decoding mode
  type: symbol
  

• NCH number of loud speakers
  type: int
  

properties:

• @order (initonly) Get/set the order of decomposition
  type: int
  range: 1..10
  default: 1
  

• @mode Get/set decoding mode
  type: symbol
  enum: regular, binaural
  default: regular
  

• @regular Get/set alias for @mode regular
  type: alias
  

• @binaural Get/set alias for @mode binaural
  type: alias
  

• @offset Get/set rotation of loudspeakers. Only available for @regular and @irregular mode.
  type: list
  units: deg
  default: 0 0 0
  

• @angles Get/set angles of loudspeakers.
  type: list
  units: deg
  default: 0 90 0 340.5288 120 340.5288 240 340.5288
  

• @pw_x (readonly) Get list of plain wave x-coordinates (abscissas). -1 is the left of the soundfield, 0 is the center of the soundfield and 1 is the right of the soundfield.
  type: list
  units: rad
  range: -1..1
  default: 0.0 -0.0 -0.8165 0.8165
  

• @pw_y (readonly) Get list of plain wave y-coordinates (ordinatas). -1 is the back of the soundfield, 0 is the center of the soundfield and 1 is the front of the soundfield.
  type: list
  units: rad
  range: -1..1
  default: -0.0 0.9428 -0.4714 -0.4714
  

• @pw_z (readonly) Get list of plain wave z-coordinates (heights). -1 is the bottom of the soundfield, 0 is the center of the soundfield and 1 is the top of the soundfield.
  type: list
  units: rad
  range: -1..1
  default: 1 -0.3333 -0.3333 -0.3333
  

• @nharm (readonly) Get number of circular harmonics.
  type: int
  min value: 1
  default: 4
  

• @nch (initonly) Get/set number of plain waves.
  type: int
  min value: 1
  default: 0
  

inlets:

• first input harmonic
  type: audio
• … input harmonic
  type: audio
• n-th input harmonic
  type: audio

outlets:

• first loudspeaker output
  type: audio
• … loudspeaker output
  type: audio
• n-th loudspeaker output
  type: audio

keywords:

hoa decoder

See also: [hoa.3d.encoder~] [hoa.2d.decoder~]

Authors: Serge Poltavsky, Pierre Guillot, Eliott Paris, Thomas Le Meur

License: GPL3 or later