index :: spat

hoa.2d.decoder~

aliases: [hoa.decoder~]

hoa 2d decoder

available since version: 0.8

---

information

Decodes an ambisonics soundfield for several loudspeakers configuration or for headphones. Mode: • regular for a regular loudspeakers repartition over a circle. • irregular if the loudspeakers are not equally spaced on a circle. • binaural for headphones The default mode is regular for an array of 2 * order + 2 loudspeakers. The default irregular configuration is 5.1 standard multichannel configuration.

arguments:

• ORDER the order of decomposition
  type: int
  

• MODE decoding mode
  type: symbol
  

• NCH number of loud speakers (minimum 2*ORDER+1 for ambisonic mode)
  type: int
  

properties:

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

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

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

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

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

• @crop Get/set crop HRIR response. Only for @binaural mode.
  type: int
  units: samp
  range: 0..512
  default: 16
  

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

• @angles Get/set angles of loudspeakers. Only available for @irregular mode.
  type: list
  units: deg
  default: 0 90 180 270
  

• @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 -1 0 1
  

• @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: 1 0 -1 0
  

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

• @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.encoder~]

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

License: GPL3 or later