Metadata-Version: 2.4
Name: ezbeq
Version: 2.7.0
Summary: A webapp which can send beqcatalogue filters to a DSP device
License-Expression: MIT
License-File: LICENSE
Author: 3ll3d00d
Author-email: mattkhan+ezbeq@gmail.com
Requires-Python: >=3.13, <3.15
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: Flask-Compress (>=1.13,<2.0)
Requires-Dist: PyYAML (>=6.0,<7.0)
Requires-Dist: Twisted (>=24.3.0,<26.0)
Requires-Dist: autobahn[twisted] (>=24.4.2,<26.0)
Requires-Dist: flask-restx (>=1.3.0,<2.0)
Requires-Dist: ijson (>=3.2.3,<4.0)
Requires-Dist: plumbum (>=1.8.1,<2.0)
Requires-Dist: prometheus-client (>=0.17.1,<1.0)
Requires-Dist: psutil (>=5.9.5,<8.0)
Requires-Dist: python-dateutil (>=2.8.2,<3.0)
Requires-Dist: requests (>=2.30.0,<3.0)
Requires-Dist: semver (>=3.0.0,<4.0)
Description-Content-Type: text/markdown

# ezbeq

A simple web browser for [beqcatalogue](https://beqcatalogue.readthedocs.io/en/latest/) which integrates
with [minidsp-rs](https://github.com/mrene/minidsp-rs)
for local remote control of a minidsp or HTP-1.

# Setup

## Windows / MacOS

Python is required so use an appropriate package manager to install it.

[chocolatey](https://chocolatey.org/) is a convenient choice for Windows
[homebrew](https://docs.brew.sh/Installation) is the equivalent for MacOS

## Linux

Use your distro package manager to install python.

## Installation

Example is provided for rpi users

    $ ssh pi@myrpi
    $ sudo apt install python3 python3-venv python3-pip libyaml-dev
    $ mkdir python
    $ cd python
    $ python3 -m venv ezbeq
    $ cd ezbeq
    $ . bin/activate
    $ pip install ezbeq

### Example Config Files

See [examples](examples)

| Type                        | File                                                                                                                                                                        |
|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Camilla DSP                 | [for CamillaDSP v3](examples/ezbeq_camilladsp3.yml)                                                                                                                         |
| J River Media Center        | [ezbeq_mc.yml](examples/ezbeq_mc.yml)                                                                                                                                       |
| Minidsp 2x4HD               | [ezbeq_md.yml](examples/ezbeq_md.yml), [using multiple devices](examples/ezbeq_md2.yml) or [with custom slot names](examples/ezbeq_named.yml)                               |
| Minidsp 4x10                | [ezbeq_4x10.yml](examples/ezbeq_4x10.yml)                                                                                                                                   |
| Minidsp 10x10               | [without use of XO](examples/ezbeq_10x10.yml), [with](examples/ezbeq_10x10_xo.yml) or [using a custom mapping across input, output and xo](examples/ezbeq_10x10_custom.yml) |
| Minidsp DDRC-24             | [ezbeq_ddrc24.yml](examples/ezbeq_ddrc24.yml)                                                                                                                               |
| Minidsp DDRC-88             | [ezbeq_ddrc88.yml](examples/ezbeq_ddrc88.yml)                                                                                                                               |
| Minidsp HTx                 | [ezbeq_htx.yml](examples/ezbeq_htx.yml)                                                                                                                                     |
| Minidsp SHD                 | [ezbeq_shd.yml](examples/ezbeq_shd.yml)                                                                                                                                     |
| Monolith HTP-1              | [ezbeq_htp1.yml](examples/ezbeq_htp1.yml)                                                                                                                                   |
| Q-Sys                       | [ezbeq_qsys.yml](examples/ezbeq_qsys.yml)                                                                                                                                   |
| Multiple, different devices | [ezbeq_multi.yml](examples/ezbeq_multi.yml)                                                                                                                                 |

### Using with a Minidsp

Install minidsp-rs as per the [provided instructions](https://github.com/mrene/minidsp-rs#installation)

### Using with a Monolith HTP-1

See the configuration section below

## Upgrade

    $ ssh pi@myrpi
    $ cd python/ezbeq
    $ . bin/activate
    $ pip install --upgrade --force-reinstall ezbeq

then restart the app

## Running the app manually

    $ ssh pi@myrpi
    $ cd python/ezbeq
    $ . bin/activate
    $ ./bin/ezbeq
      Loading config from /home/pi/.ezbeq/ezbeq.yml
      2021-01-16 08:43:15,374 - twisted - INFO - __init__ - Serving ui from /home/pi/python/ezbeq/lib/python3.8/site-packages/ezbeq/ui

Now open http://youripaddress:8080/index.html in your browser

## Configuration

See `$HOME/.ezbeq/ezbeq.yml`

The only intended option for override is the port option which sets the port the UI and API is accessible on. This
defaults to 8080.

### Using a custom catalogue

If `catalogueUrl` is added to the configuration, e.g.

    catalogueUrl: http://localhost:9999

ezbeq will instead load the catalogue from `http://localhost:9999/database.json`

This provides the ability to run ezbeq against a custom, or locally provided, catalogue.

### Configuring Devices

The devices section contains a list of supported device, the format varies by the type of device and each item is a
named device with the name subsequently appearing the UI (if multiple devices are listed)

#### Minidsp

Default values are shown, the only required value is the type field

```
  minidsp:
    cmdTimeout: 10
    exe: minidsp
    ignoreRetcode: false
    options: ''
    slotChangeDelay: false
    type: minidsp
```

* cmdTime: default timeout in seconds for a command sent to minidsp-rs to complete
* exe: location of the minidsp-rs executable
* ignoreRetcode: if true, errors generated by minidsp-rs will be ignored (for debugging/local testing only)
* options: additional command line switches to pass to minidsp-rs (refer to minidsp-rs docs for details)
* type: minidsp
* slotChangeDelay: if true, the command to change the slot is always sent to minidsp-rs as a separate command. If a
  positive integer or float, it represents an additional delay (in seconds) that will separate each command.

By default, it is assumed the Minidsp 2x4HD is in use. To use a different model, specify via the device_type option. For
example:

```
  minidsp:
    cmdTimeout: 10
    exe: minidsp
    ignoreRetcode: false
    options: ''
    type: minidsp
    device_type: 4x10
```

In order for the ezbeq ui to update when the device status is updated outside of ezbeq (e.g. using minidsp remote
control), additional configuration is required to enable
the [minidsp rs websocket interface](https://minidsp-rs.pages.dev/daemon/http#websocket-streaming)

This requires 2 optional additional values in the configuration

```
  wsDeviceId: 0
  wsIp: 127.0.0.1:5380
```

`wsIp` is the address of the `[http_server]` from `/etc/minidsp/config.toml`
`wsDeviceId` is the device id provided by `minidsp probe`, in this example 2 device ids (0 and 1) are available

```
$ minidsp probe                                                                                                                                                                                
Found 2x4HD with serial 911111 at ws://localhost/devices/0/ws [hw_id: 10, dsp_version: 100]
Found 2x4HD with serial 911112 at ws://localhost/devices/1/ws [hw_id: 10, dsp_version: 100]
```

Using, and controlling, multiple devices independently is supported but does require use of the `options` key in order
to direct commands to the right device. Precise configuration of this option depends on the minidsp-rs setup so is out
of scope of this readme. Typical configuration would involve use of the `--tcp` option combined with changes to
`minidsp.toml` as mentioned in the [minidsp-rs docs](https://minidsp-rs.pages.dev/daemon/tcp#multiple-devices).

For reference, a community provided example configuration guide can be found
via [avs](https://www.avsforum.com/threads/ezbeq-use-and-development-discussion.3181732/page-170#post-62257128)

##### Naming Slots

By default, the slots are numbered 1-4 as per the minidsp console.

To override, extend the device configuration with the `slotNames` key as illustrated
in [this example](examples/ezbeq_named.yml). It is not necessary to list every slot, just those that require an explicit
name.

##### Minidsp Variants

Device support largely tracks [minidsp-rs device support](https://minidsp-rs.pages.dev/devices).

BEQ MV adjustments are applied to input peq channels only.

###### [2x4HD](https://www.minidsp.com/products/minidsp-in-a-box/minidsp-2x4-hd)

set `device_type: 24HD`

BEQ filters are written to both input channels.

##### [Flex](https://www.minidsp.com/products/minidsp-in-a-box/flex)

configure as per 2x4HD

add `slotChangeDelay: true` to workaround issues with slow slot changing. If it remains unstable, use
`slotChangeDelay: 1.5` (or some other number, experiment to find the smallest value that enables a reliable experience).

Dirac mode (PEQ on output) is only supported at present via a custom configuration.

###### [DDRC-24](https://www.minidsp.com/products/dirac-series/ddrc-24)

set `device_type: DDRC24`

BEQ filters are written to all output channels.

###### [DDRC-88](https://www.minidsp.com/products/dirac-series/ddrc-88a)

set `device_type: DDRC88`

BEQ filters are written to output channel 3 by default.

Add the `sw_channels` config key to override this, provide a list of channel indexes (0 based) to which the filters
should be written. For example to write to the last two output channels:

    device_type: DDRC88
    sw_channels:
    - 6
    - 7

###### [HTx](https://www.minidsp.com/products/ht-series/flex-htx)

set `device_type: HTx`

If using [minidsp-rs 0.1.12](https://github.com/mrene/minidsp-rs/releases/tag/v0.1.12)

* BEQ filters are written to output channel 3 by default.
* Add the `sw_channels` config key to override this, provide a list of channel indexes (0 based) to which the filters
  should be written. For example to write to the last two output channels:

  device_type: HTx
  sw_channels:
    - 6
    - 7

If using a build of minidsp-rs that contains [this PR](https://github.com/mrene/minidsp-rs/pull/767):

* BEQ filters are written to input channel 3 by default.
* Add the `channels` config key to override this, provide a list of channel indexes (0 based) to which the filters
  should be written. For example to write to the last two input channels:

  device_type: HTx
  channels:
    - 6
    - 7

###### [4x10](https://www.minidsp.com/products/plugins/4x10-plug-in-detail)

set `device_type: 4x10`

The limited biquad capacity (5 per channel) means that filters are split across input and output channels and there is
no capacity for user filters.

###### [10x10](https://www.minidsp.com/products/plugins/4x10-10x10-plug-ins/10x10-plug-in-detail)

set `device_type: 10x10`

The limited biquad capacity (6 per channel) means that filters are split across input and output channels and the last 2
biquads per output channel are left under user control.

To avoid this, use the crossover biquads to hold the remaining beq biquads. This leaves the output PEQ untouched. Set
`use_xo` to one of the following values to activate this mode:

* all : apply beq to both crossover groups
* 0 (or true) : apply beq to crossover group 0
* 1 : apply beq to crossover group 1

###### [SHD](https://www.minidsp.com/products/streaming-hd-series/shd)

set `device_type: SHD`

BEQ filters are written to all output channels.

###### [8x12 CDSP](https://www.minidsp.com/products/car-audio-dsp/c-dsp-8x12)

set `device_type: 8x12CDSP`

BEQ filters are written to all 6 input channels.

##### Custom Layouts

This is intended for advanced users only and requires a detailed understanding of the target device's capabilities and
configuration.

This option allows for bespoke mapping of beq filters to biquad slots. This requires the user to specify

* the capabilities of the device (channel counts, biquad slots per channel)
* the biquad slots the beq filters should be written to.

10 slots *must* be reserved for BEQ filters. These slots can be allocated via any combination of input, xo and output
but there must be exactly 10 slots allocated.

The main characteristics of the custom layout are defined in the `descriptor` section of the config. The descriptor is made up of the following keys:

* name: a name for the device, this is only used for display purposes in the UI
* fs: the sample rate at which the device is configured to operate, this is dictated the minidsp plugin.
* routes: must contain 3 entries (input, crossover, output)
* each entry in routes must contain the following keys:
  * name: must be input, crossover or output
  * biquads: the number of biquads per channel
  * channels: a list of channel indexes (0 based) that are part of this route 
  * slots: a list of slot indexes (0 based) that are allocated to beq filters in this route, these slots will be used in order so the first slot in the list will be used for BEQ filter 0, the second for BEQ filter 1 and so on.
  * groups: specified by the crossover route only, all known minidsp devices that support crossover filters have 2 groups.

Only the channels/biquads specified in the descriptor are addressable via the minidsp command loader screen in the UI. In practical terms, this means if a channel is not included in the BEQ config (e.g. you only write to 1 input channel), the command loader will not be able to address the missing channel(s).

Some example configurations are shown below.

* 2x4HD physical device with BEQ filters applied to the 1st input channel only.

```
accessLogging: false
debugLogging: true
devices:
  dsp1:
    cmdTimeout: 10
    exe: minidsp
    options: ''
    type: minidsp
    descriptor:
      name: 2x4
      fs: 96000
      routes:
      - name: input
        biquads: 10
        channels: [0]
        slots: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
      - name: crossover
        biquads: 4
        channels: [0, 1, 2, 3]
        slots: []
        groups: [0, 1]
      - name: output
        biquads: 10
        channels: [0, 1, 2, 3]
        slots: []
port: 8080
```

* 2x4HD physical device with the BEQ filters applied to the 1st 4 slots of both input channels and the 1st 6 slots of every output channel.

```
accessLogging: false
debugLogging: true
devices:
  dsp1:
    cmdTimeout: 10
    exe: minidsp
    options: ''
    type: minidsp
    descriptor:
      name: 2x4
      fs: 96000
      routes:
      - name: input
        biquads: 10
        channels: [0]
        slots: [0, 1, 2, 3]
      - name: crossover
        biquads: 4
        channels: [0, 1, 2, 3]
        slots: []
        groups: [0, 1]
      - name: output
        biquads: 10
        channels: [0, 1, 2, 3]
        slots: [0, 1, 2, 3, 4, 5]
port: 8080
```

#### Monolith HTP1

```
  htp1:
    ip: 192.168.1.181
    channels:
    - sub1
    autoclear: true
```

BEQ filters are loaded into the bottom 10 slots of the specified channels only.

* ip: ip address of the HTP1
* channels: list of channels to apply filters to (sub1, sub2 and sub3 are the standard subwoofer channels in the HTP1)
* autoclear: if set to true, BEQ filters will be reset on power state or input change

#### JRiver Media Center

Media Network must be enabled

```
  jriver:
    address: 192.168.1.181:52199
    auth:
      user: foo
      pass: thisismypass
    secure: true  
    channels:
    - SW
    - C9
    - C10
    block: 2
```

* address: the ip and port on which the Media Center media network is listening
* auth is optional, leave this out if MCWS is not secured
* secure is optional, leave this out if SSL is not used
* supported channels are L R C SW SL SR RL RR and C9 upto C32 (if more than 8 channel output is used)
* block is 1 or 2 and refers to the dsp slots Parametric Equalizer and Parametric Equalizer 2 respectively

This information is **not** validated, it is left to the user to configure the output format on the zone to match the
supplied configuration.

#### Q-Sys

[Q-Sys Designer](https://www.qsc.com/resources/software-and-firmware/q-sys-designer-software/) is supported via
the [QRC](https://q-syshelp.qsc.com/Content/External_Control_APIs/QRC/QRC_Overview.htm) protocol

```
  qsys:
    ip: 192.168.1.181
    port: 1710
    timeout_secs: 2
    components: 
    - beq
    content_info:
    - beq_movie_info:
        text.1: title
        text.2: genres
        text.3: audio_types
        text.4: mv_adjust
        text.5: overview
        text.6: images[0]
        text.7: images[1]
    type: qsys
```

Configuration of the audio pipeline in Q-Sys Designer is left as an exercise for the user.

2 alternative implementations are possible.

One uses a [IIR Custom Filter](https://q-syshelp.qsc.com/Index.htm#Schematic_Library/filter_IIR.htm) component which
must be connected to component which provides a text field.

This can be implemented using either
a [Text Controller](https://q-syshelp.qsc.com/Index.htm#Schematic_Library/device_controller_script.htm?TocPath=Design%257CSchematic%2520Elements%257CComponents%257CScripting%2520Components%257C_____3)
or a [Custom Control](https://q-syshelp.qsc.com/Index.htm#Schematic_Library/custom_controls.htm).

This component allows for a mapping of a text field control key to a `CatalogueEntry` field name.

Two fields have special treatment:

* filters: will be set in a format that can be linked to a IIR Custom Filter and feeds it with the required biquad
  coefficients.
* images: there can be a variable number of images so each individual image can be specified in a separate field

The alternative approach uses
a [Parametric Equaliser](https://q-syshelp.qsc.com/Content/Schematic_Library/equalizer_parametric.htm) component which
should be configured with:

* at least 10 bands
* q factor

The component name should be supplied in the configuration above.

Note that this format does not support variable Q shelf filters.

#### CamillaDSP

[CamillaDSP v3](https://github.com/HEnquist/camilladsp) is supported via
its [websocket](https://github.com/HEnquist/camilladsp/blob/master/websocket.md) api which means CamillaDSP must be
started with additional options:

* `-p` to specify the port
* `-a` to specify the listen address (required if ezbeq runs on a different host to camilladsp)

```
  camilla:
    ip: 192.168.1.181
    port: 1710
    timeout_secs: 2
    channels: 
    - 4
    - 7
    type: camilladsp
```

* ip: the ip on which camilladsp is listening
* port: the port on which camilladsp is listening
* channels: a list of channel numbers to which BEQ filters will be appended

On load, the camilladsp configuration will be updated as follows:

* each filter will be added to the `Filters` section in [IIR](https://github.com/HEnquist/camilladsp#iir) format using
  one of the Peaking, HighShelf or LowShelf filter types. Filter names will be BEQ_0 to BEQ_9, the number corresponds to
  the filter index in the loaded BEQ filter. If a filter with the same name already exists, it will be overwritten with
  the new settings. This means that if you load a different BEQ filter, the existing filters will be updated rather than
  new filters being added.
* each filter will be appended to the [Pipeline](https://github.com/HEnquist/camilladsp#pipeline) for the specified
  channel, an entry of type `Filter` will be added if not already present for that channel

Note that if the named filter (BEQ_0 for example) is already present in the camilladsp configuration, only the filter
parameters will be updated on load or remove.
i.e. this enables the user to define where to put the filters in the pipeline rather than always appending to the end of
the pipeline.

On unload, the camilladsp configuration will be updated as follows:

* the filters will reset to 0 gain filters in the `Filters` section

User controlled master volume adjustments are supported using
the [Volume](https://github.com/HEnquist/camilladsp/blob/master/README.md#volume) filter if that filter has been
configured in the pipeline.

BEQ specific input gain adjustments are supported via the use of a [Gain](https://github.com/HEnquist/camilladsp#gain)
filter which is inserted into the pipeline ahead of the BEQ filters themselves.

## Starting ezbeq on bootup

This is optional but recommended, it ensures the app starts automatically whenever the rpi boots up and makes
sure it restarts automatically if it ever crashes.

We will achieve this by creating and enabling a `systemd` service.

1) Create a file ezbeq.service in the appropriate location for your distro (e.g. ``/etc/systemd/system/`` for debian)::

```
[Unit]
Description=ezbeq
After=network.target

[Service]
Type=simple
User=pi
WorkingDirectory=/home/pi
ExecStart=/home/pi/python/ezbeq/bin/ezbeq
Restart=always
RestartSec=1

[Install]
WantedBy=multi-user.target
```

2) enable the service and start it up::

```
$ sudo systemctl enable ezbeq.service
$ sudo service ezbeq start
$ sudo journalctl -u ezbeq.service
-- Logs begin at Sat 2019-08-17 12:17:02 BST, end at Sun 2019-08-18 21:58:43 BST. --
Aug 18 21:58:36 swoop systemd[1]: Started ezbeq.
```

3) reboot and repeat step 2 to verify the recorder has automatically started

## Verifying MiniDSP Response

As noted in
the [setup guide](https://ezbeq.readthedocs.io/en/latest/#suggested-interaction-of-ezbeq-and-official-minidsp-plugin),
minidsp devices do not provide any mechanism to read the currently loaded DSP configuration. This means it is impossible
to see exactly how the DSP is configured, it's only possible to measure the resulting response.

From an ezbeq perspective, there are 2 ways to do this

### Quick & Crude

* Clear filters
* Open the levels tab
* Start playback of a scene that is known to have content boosted by the beq filter (use
  the [beqcatalogue](https://beqcatalogue.readthedocs.io/) heatmap to find one)
* Make note of the displayed levels
* Load the filter
* Restart playback of the same scene
* Compare the reported levels

The measured output level should be increased with the filter in place.

### Slower but Accurate

* Clear filters
* Switch to USB input
* Connect the minidsp dsp to a PC running [REW](https://www.roomeqwizard.com/), configure REW to use the minidsp as both
  input and output device
* Measure a full bandwidth (2-20000 Hz) sweep (call this A)
* Load a filter (switch connection to the ezbeq host if necessary)
* Measure a full bandwidth (2-20000 Hz) sweep (call this B)
* Use the [trace arithmetic](https://www.roomeqwizard.com/betahelp/help_en-GB/html/arithmetic.html) `A / B` function (
  call the result C), the result should look like the inverse of the BEQ filter (i.e. it will go into negative values,
  it shows the supposed rolloff in the original source that is to be corrected by the BEQ filter)
* With C selected, open the EQ window, select your minidsp device as the dsp type and manually input the individual
  filters in the loaded BEQ
* The predicted response should now be a flat line (i.e. the beq filter has "corrected" this back to flat)

