schema_version: 7.0
type: filter
identifier: ambisonic-decoder
title: Ambisonic Decoder
version: 1
copyright: Meltytech, LLC
license: LGPL
language: en
url: https://github.com/videolabs/libspatialaudio
tags:
  - Audio
description: Decode, rotate (pan), and zoom Ambisonic audio.
notes: >
  This only supports first order for now. It can render to stereo, quad
  surround, and 5.1 surround depending on the number of channels
  configured on the consumer (2, 4, or 6, respectively).

parameters:
  - identifier: yaw
    title: Yaw
    type: float
    default: 0
    unit: degrees
    mutable: yes
    animation: yes

  - identifier: pitch
    title: Pitch
    type: float
    default: 0
    unit: degrees
    mutable: yes
    animation: yes

  - identifier: roll
    title: Roll
    type: float
    default: 0
    unit: degrees
    mutable: yes
    animation: yes

  - identifier: zoom
    title: Zoom
    type: float
    default: 0
    minimum: -1
    maximum: 1
    unit: percent
    mutable: yes
    animation: yes

  - identifier: ambisonic
    title: Keep Ambisonic
    description: >
      This indicates whether to keep the Ambisonics or render to speakers.
      This only works at the moment when the channel count is 4 for first order.
    type: boolean
    default: 0
    mutable: yes

  - identifier: binaural
    title: Binaural Output
    description: >
      This indicates whether to render as binaural instead of stereo.
      This property overrides the "ambisonic" property.
    type: boolean
    default: 0
    mutable: no
