diff --git a/.gitea/workflows/ci.yaml b/.gitea/workflows/ci.yaml new file mode 100644 index 0000000..2141fc8 --- /dev/null +++ b/.gitea/workflows/ci.yaml @@ -0,0 +1,47 @@ +name: CI +on: + push: + branches: [main] + pull_request: + branches: [main] + +jobs: + build: + name: Rust CI + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Install Rust + uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: stable + override: true + components: rustfmt, clippy + + - name: Cache Cargo registry + uses: actions/cache@v3 + with: + path: | + ~/.cargo/registry + ~/.cargo/git + key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }} + restore-keys: | + ${{ runner.os }}-cargo- + + - name: Run tests + env: + SQLX_OFFLINE: true + run: cargo test --workspace --verbose --all + + - name: Run Clippy (linter) + run: cargo clippy --all-targets --all-features -- -D warnings + + - name: Run fmt check + run: cargo fmt --all -- --check + + - name: Build project + run: cargo build --workspace --verbose diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..0e38bac --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,41 @@ +repos: + - repo: local + hooks: + # ─────────────── PRE-COMMIT ─────────────── + + - id: fmt + name: rustfmt + entry: cargo fmt -- --check + language: system + pass_filenames: false + stages: [pre-commit] + + - id: clippy + name: clippy + entry: cargo clippy -- -D warnings + language: system + pass_filenames: false + stages: [pre-commit] + + # ─────────────── PRE-PUSH ─────────────── + + - id: test + name: cargo test + entry: cargo test --all + language: system + pass_filenames: false + stages: [pre-push] + + - id: build + name: cargo build release + entry: cargo build --release + language: system + pass_filenames: false + stages: [pre-push] + + - id: audit + name: cargo audit + entry: cargo audit + language: system + pass_filenames: false + stages: [pre-push] diff --git a/.readme.md b/.readme.md deleted file mode 100644 index 61bccd3..0000000 --- a/.readme.md +++ /dev/null @@ -1 +0,0 @@ -# verify import order diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..dff66e1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,73 @@ +Apache License +Version 2.0, January 2004 +http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + +"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. + +"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. + +"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. + +"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. + +"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. + +"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. + +"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). + +"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. + +"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." + +"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: + + (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. + + You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + +To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. + +Copyright 2026 Iceberg + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/dsp408-protocol.md.md b/dsp408-protocol.md.md new file mode 100644 index 0000000..1de5817 --- /dev/null +++ b/dsp408-protocol.md.md @@ -0,0 +1,1892 @@ +# DSP 408 Protocol Documentation + +# TODO + +- Existing but not implemented commands: 0x19, 0x25, 0x28, 0x2E, 0x50, 0x51, 0x52, 0x53 +- Commands 0x2E, 0x50, 0x51, 0x52, 0x53 seem to be used for firmware update: DO NOT SEND THEM WITHOUT KNOWLEDGE - RISK OF DEVICE BRICK (I brick my device) +- Commands: 0x19, 0x24, 0x28 are triggered by upload preset +- Identify: 0x2C parameters +- Implement: if 2 DSP with same ip, they need to share same socket since dsp dont accept multiples connections +- In unlock check if first byte is device id +- Dsp and python code allow to send commands even if dsp is locked +- Convert back data as in 0x38 to display real value + +# Tables of Content + +## Encoding Index + +| Encoding | Used by | Description | +|---|---|---| +| [Preset Name](#21-preset-name) | Preset save/load | 14-byte fixed string | +| [Channel Name](#22-channel-name) | Channel labeling | 8-byte fixed string | +| [Password](#23-password) | Login/lock | 4-byte fixed string | +| [Preset Index](#31-preset-index) | Preset select | 1-byte index (21 presets) | +| [Channel Index](#32-channel-index) | Gain, Mute, Delay, PEQ, GEQ | 1-byte index (12 channels) | +| [PEQ Band Index](#33-peq-band-index) | PEQ | 1-byte index (9 bands) | +| [Frequency Band Index](#34-frequency-band-index) | GEQ | 1-byte index (31 bands) | +| [Delay Unit](#35-delay-unit) | Channel Delay | 1-byte unit selector | +| [Compressor Ratio](#36-compressor-ratio) | Compressor | 1-byte index (16 ratios) | +| [Input Source Type](#37-input-source-type) | Input select | 1-byte index (4 sources) | +| [PEQ Filter Type](#38-peq-filter-type) | PEQ | 1-byte index (9 filter types) | +| [Crossover Slope](#39-crossover-slope) | Crossover | 1-byte index (21 slopes) | +| [Matrix Input Mask](#41-matrix-input-mask) | Input routing | 1-byte bitmask | +| [Channel Gain](#51-channel-gain) | Gain | 16-bit dB value (-60 to +12 dB) | +| [GEQ / PEQ Gain](#52-geq--peq-gain) | GEQ, PEQ | 8-bit ±12 dB value | +| [PEQ Q Factor](#53-peq-q-factor) | PEQ | 8-bit logarithmic Q value | +| [Hold](#61-hold-gate) | Gate | 16-bit ms value | +| [Attack](#62-attack-compressor) | Compressor | 16-bit ms value | +| [Release](#63-release-compressor) | Compressor | 16-bit ms value | +| [Knee](#64-knee-compressor) | Compressor | 8-bit dB value | +| [Sidechain Frequency](#65-sidechain-frequency-compressor) | Compressor | 16-bit logarithmic Hz value | +| [Gate Threshold](#66-gate-threshold) | Gate | 16-bit dB value | +| [Compressor Threshold](#67-compressor-threshold) | Compressor | 8-bit dB value | +| [Channel Delay](#71-channel-delay) | Delay | 8-bit linear value | +| [Meter Level](#81-meter-level) | Metering | Float16 level + peak byte | + +--- + +## Commands Index + +| Command | Category | Description | +|---|---|---| +| `0x01` — [Acknowledgement](#0x01--acknowledgement) | Connection & Session | Signals the device finished loading/processing and is ready | +| `0x02` — [Not Implemented](#0x02--not-implemented) | Connection & Session | Signals that the command just sent is invalid/unimplemented | +| `0x10` — [Start](#0x10--start) | Connection & Session | Initiates a session with the device | +| `0x11` — [Disconnect](#0x11--disconnect) | Connection & Session | Terminates the session | +| `0x12` — [Acknowledgement (Client → Device)](#0x12--acknowledgement-client--device) | Connection & Session | Client-side confirmation after loading parameters | +| `0x13` — [Device Name](#0x13--device-name) | Device Info | Reads the device's display name | +| `0x14` — [Current Preset Index](#0x14--current-preset-index) | Preset Management | Reads the currently active preset | +| `0x15` — [Set Delay Unit](#0x15--set-delay-unit) | Channel Processing | Changes the display unit used for delay values | +| `0x20` — [Recall Preset](#0x20--recall-preset) | Preset Management | Recalls (loads) a stored preset | +| `0x21` — [Store Preset](#0x21--store-preset) | Preset Management | Saves the current live settings into a preset slot | +| `0x22` — [Get Preset Modification Status](#0x22--get-preset-modification-status) | Preset Management | Reports which presets have unsaved/modified state | +| `0x23` — [Factory Reset](#0x23--factory-reset) | Preset Management | Restores factory defaults | +| `0x27 / 0x24` — [Config Chunk (Request / Response)](#0x27--0x24--config-chunk-request--response) | Preset Management | Streams the full device configuration in indexed chunks | +| `0x26` — [Store Preset Name](#0x26--store-preset-name) | Preset Management | Sets the working preset name prior to saving | +| `0x29` — [Get Preset Name](#0x29--get-preset-name) | Preset Management | Reads the name of a given preset | +| `0x2A` — [Copy Channel](#0x2a--copy-channel) | Channel Configuration | Copies one channel's settings onto another | +| `0x2C` — [Device Flags](#0x2c--device-flags) | Device Info | Reads device status flags, including lock state | +| `0x2D` — [Unlock Device](#0x2d--unlock-device) | Security | Authenticates with a password to unlock the device | +| `0x2F` — [Lock Device](#0x2f--lock-device) | Security | Locks the device behind a password | +| `0x30` — [Set Compressor](#0x30--set-compressor) | Dynamics | Sets compressor parameters for a channel | +| `0x31` — [Set Low-Pass Filter](#0x31--set-low-pass-filter) | Filters & EQ | Sets the low-pass filter for a channel | +| `0x32` — [Set High-Pass Filter](#0x32--set-high-pass-filter) | Filters & EQ | Sets the high-pass filter for a channel | +| `0x33` — [Set PEQ Band](#0x33--set-peq-band) | Filters & EQ | Sets one parametric EQ band (input channels only) | +| `0x34` — [Set Gain](#0x34--set-gain) | Channel Processing | Sets a channel's gain | +| `0x35` — [Set Mute](#0x35--set-mute) | Channel Processing | Mutes or unmutes a channel | +| `0x36` — [Invert Gain](#0x36--invert-gain) | Channel Processing | Inverts polarity on a channel | +| `0x38` — [Set Delay](#0x38--set-delay) | Channel Processing | Sets a channel's delay value | +| `0x39` — [Set Input Source](#0x39--set-input-source) | Input & Routing | Selects the analog/test signal source | +| `0x3A` — [Matrix Routing](#0x3a--matrix-routing) | Input & Routing | Sets which inputs feed a given output channel | +| `0x3B` — [Link Channel](#0x3b--link-channel) | Channel Configuration | Groups channels so they move together | +| `0x3C` — [Bypass EQ](#0x3c--bypass-eq) | Channel Processing | Enables or bypasses all EQ processing on a channel | +| `0x3D` — [Set Channel Name](#0x3d--set-channel-name) | Channel Configuration | Sets the display name of an output channel | +| `0x3E` — [Set Gate Parameters](#0x3e--set-gate-parameters) | Dynamics | Sets noise-gate parameters for a channel | +| `0x3F` — [Set Output Limiter](#0x3f--set-output-limiter) | Dynamics | Sets output-limiter parameters (output channels only) | +| `0x40` — [Get Level Meters](#0x40--get-level-meters) | Metering | Reads current level-meter and clip-indicator values for all channels | +| `0x41` — [Set Matrix Gain](#0x41--set-matrix-gain) | Input & Routing | Sets the send gain from one input to one output | +| `0x48` — [Set GEQ Band](#0x48--set-geq-band) | Filters & EQ | Sets one band of a 31-band graphic EQ (input channels only) | +| `0x49` — [Set GEQ Bypass](#0x49--set-geq-bypass) | Filters & EQ | Enables or bypasses the graphic EQ on an input channel (input channels only) | + +--- + +# Encoding / Decoding Specification + +## 1. Overview & Conventions + +- All multi-byte numeric fields are **little-endian**: the low-order byte (`LO`) is transmitted/stored first, the high-order byte (`HI`) second. + ```text + LO = raw & 0xFF + HI = (raw >> 8) & 0xFF + ``` + ```text + raw = LO | (HI << 8) + ``` +- Quantized parameters (e.g. gain, threshold) are rounded to the nearest valid step **before** encoding. The decoding formula always reverses the encoding formula exactly. +- All lookup-table fields (enums, indices) are 1 byte unless otherwise noted. + +--- + +## 2. Fixed-Length Strings + +All string fields share one encoding model: write the text as ASCII bytes, then pad up to the fixed length with a pad byte. Decoding reverses this: read the fixed length, then strip trailing pad bytes. + +### 2.1 Preset Name + +| Field | Value | +|---|---| +| **Purpose** | Human-readable preset name | +| **Size** | 14 bytes | +| **Pad byte** | `0x20` (space) | + +**Encoding (value → raw):** +```text +bytes = ASCII(name)[0:14] +bytes = bytes + 0x20 × (14 - len(bytes)) +``` + +**Decoding (raw → value):** +```text +name = ASCII(bytes).rstrip(0x20) +``` + +### 2.2 Channel Name + +| Field | Value | +|---|---| +| **Purpose** | Human-readable channel name | +| **Size** | 8 bytes | +| **Pad byte** | `0x00` | + +**Encoding (value → raw):** +```text +bytes = ASCII(name)[0:8] +bytes = bytes + 0x00 × (8 - len(bytes)) +``` + +**Decoding (raw → value):** +```text +name = ASCII(bytes).rstrip(0x00) +``` + +### 2.3 Password + +| Field | Value | +|---|---| +| **Purpose** | Password value | +| **Size** | 4 bytes | +| **Pad byte** | `0x00` | + +**Encoding (value → raw):** +```text +bytes = ASCII(password)[0:4] +bytes = bytes + 0x00 × (4 - len(bytes)) +``` + +**Decoding (raw → value):** +```text +password = ASCII(bytes).rstrip(0x00) +``` + +--- + +## 3. Enumerated & Index Values + +All fields in this section are 1 byte and work as a direct lookup table. + +**Encoding (value → raw):** find the desired option in the table and use its byte value. +**Decoding (raw → value):** look up the byte value in the table to get the option. + +### 3.1 Preset Index + +**Range:** `0x00`–`0x14` (21 presets) + +| Index | Preset | +|---|---| +| `0x00` | Preset 0 | +| `0x01` | Preset 1 | +| … | … | +| `0x14` | Preset 20 | + +### 3.2 Channel Index + +**Range:** `0x00`–`0x0B` (12 channels) + +| Index | Channel | Index | Channel | +|---|---|---|---| +| `0x00` | IN_A | `0x06` | OUT_3 | +| `0x01` | IN_B | `0x07` | OUT_4 | +| `0x02` | IN_C | `0x08` | OUT_5 | +| `0x03` | IN_D | `0x09` | OUT_6 | +| `0x04` | OUT_1 | `0x0A` | OUT_7 | +| `0x05` | OUT_2 | `0x0B` | OUT_8 | + +### 3.3 PEQ Band Index + +**Range:** `0x00`–`0x08` (9 bands) + +**Band limit by channel type:** + +| Channel Type | Maximum Band | +|---|---| +| Input | B7 (`0x07`) | +| Output | B8 (`0x08`) | + +| Index | Band | Index | Band | +|---|---|---|---| +| `0x00` | B0 | `0x05` | B5 | +| `0x01` | B1 | `0x06` | B6 | +| `0x02` | B2 | `0x07` | B7 | +| `0x03` | B3 | `0x08` | B8 | +| `0x04` | B4 | | | + +### 3.4 Frequency Band Index + +**Range:** `0x00`–`0x1E` (31 bands, ISO 1/3-octave centers) + +| Index | Frequency | Index | Frequency | Index | Frequency | Index | Frequency | +|---|---|---|---|---|---|---|---| +| `0x00` | 20 Hz | `0x08` | 125 Hz | `0x10` | 800 Hz | `0x18` | 5 kHz | +| `0x01` | 25 Hz | `0x09` | 160 Hz | `0x11` | 1 kHz | `0x19` | 6.3 kHz | +| `0x02` | 31.5 Hz | `0x0A` | 200 Hz | `0x12` | 1.25 kHz | `0x1A` | 8 kHz | +| `0x03` | 40 Hz | `0x0B` | 250 Hz | `0x13` | 1.6 kHz | `0x1B` | 10 kHz | +| `0x04` | 50 Hz | `0x0C` | 315 Hz | `0x14` | 2 kHz | `0x1C` | 12.5 kHz | +| `0x05` | 63 Hz | `0x0D` | 400 Hz | `0x15` | 2.5 kHz | `0x1D` | 16 kHz | +| `0x06` | 80 Hz | `0x0E` | 500 Hz | `0x16` | 3.15 kHz | `0x1E` | 20 kHz | +| `0x07` | 100 Hz | `0x0F` | 630 Hz | `0x17` | 4 kHz | | | + +### 3.6 Compressor Ratio + +**Range:** `0x0000`–`0x0F00` (16 values) + +| Value | Ratio | Value | Ratio | +|---|---|---|---| +| `0x0000` | 1:1 | `0x0800` | 3.5:1 | +| `0x0100` | 1.1:1 | `0x0900` | 4:1 | +| `0x0200` | 1.3:1 | `0x0A00` | 5:1 | +| `0x0300` | 1.5:1 | `0x0B00` | 6:1 | +| `0x0400` | 1.7:1 | `0x000C` | 8:1 | +| `0x0500` | 2:1 | `0x0D00` | 10:1 | +| `0x0600` | 2.5:1 | `0x0E00` | 20:1 | +| `0x0700` | 3:1 | `0x0F00` | LIMIT | + +### 3.7 Input Source Type + +**Range:** `0x00`–`0x03` (4 types) + +| Value | Input Source | +|---|---| +| `0x00` | Analog | +| `0x01` | Pink Noise | +| `0x02` | White Noise | +| `0x03` | Sine Wave | + +### 3.8 PEQ Filter Type + +**Range:** `0x00`–`0x08` (9 types) + +| Value | Filter | Value | Filter | +|---|---|---|---| +| `0x00` | Peak | `0x05` | HP 6dB | +| `0x01` | Low Shelf | `0x06` | HP 12dB | +| `0x02` | High Shelf | `0x07` | All Pass 1 | +| `0x03` | LP 6dB | `0x08` | All Pass 2 | +| `0x04` | LP 12dB | | | + +### 3.9 Crossover Slope + +**Range:** `0x00`–`0x14` (21 values) + +| Value | Slope | Value | Slope | +|---|---|---|---| +| `0x00` | Bypass | `0x0B` | BW 30 | +| `0x01` | BW 6 | `0x0C` | BL 30 | +| `0x02` | BL 6 | `0x0D` | BW 36 | +| `0x03` | BW 12 | `0x0E` | BL 36 | +| `0x04` | BL 12 | `0x0F` | LR 36 | +| `0x05` | LR 12 | `0x10` | BW 42 | +| `0x06` | BW 18 | `0x11` | BL 42 | +| `0x07` | BL 18 | `0x12` | BW 48 | +| `0x08` | BW 24 | `0x13` | BL 48 | +| `0x09` | BL 24 | `0x14` | LR 48 | +| `0x0A` | LR 24 | | | + +--- + +## 4. Bit Mask Values + +### 4.1 Matrix Input Mask + +| Field | Value | +|---|---| +| **Purpose** | Which inputs are active/routed | +| **Size** | 1 byte | +| **Range** | `0x00`–`0x0F` | + +| Input | Bit mask | +|---|---| +| IN_A | `0x01` | +| IN_B | `0x02` | +| IN_C | `0x04` | +| IN_D | `0x08` | + +**Encoding (value → raw):** OR together the bit mask of every active input. +```text +raw = (IN_A ? 0x01 : 0) | (IN_B ? 0x02 : 0) | (IN_C ? 0x04 : 0) | (IN_D ? 0x08 : 0) +``` + +**Decoding (raw → value):** AND the raw byte with each bit mask to test whether that input is active. +```text +IN_A_active = (raw & 0x01) != 0 +IN_B_active = (raw & 0x02) != 0 +IN_C_active = (raw & 0x04) != 0 +IN_D_active = (raw & 0x08) != 0 +``` + +--- + +## 5. Gain & Equalizer Parameters + +### 5.1 Channel Gain + +| Field | Value | +|---|---| +| **Purpose** | Per-channel input/output gain | +| **Size** | 2 bytes, little-endian | +| **Range** | -60 dB to +12 dB | + +**Quantization:** + +| dB Range | Resolution | +|---|---| +| `[-60, -20)` | 0.5 dB | +| `[-20, +12]` | 0.1 dB | + +**Encoding (value → raw):** +```text +if -60 <= dB < -20: + raw = round((dB + 60) / 0.5) +if -20 <= dB <= 12: + raw = round(80 + (dB + 20) / 0.1) + +LO = raw & 0xFF +HI = (raw >> 8) & 0xFF +``` + +**Decoding (raw → value):** +```text +raw = LO | (HI << 8) + +if 0 <= raw <= 79: + dB = raw × 0.5 - 60 +if 80 <= raw <= 320: + dB = (raw - 80) × 0.1 - 20 +``` + +### 5.2 GEQ / PEQ Gain + +| Field | Value | +|---|---| +| **Purpose** | Graphic/parametric EQ band gain | +| **Size** | 2 bytes | +| **Range** | -12 dB to +12 dB | +| **Resolution** | 0.1 dB | + +**Encoding (value → raw):** +```text +raw = round(dB × 10 + 120) +LO = raw & 0xFF +HI = (raw >> 8) & 0xFF +``` + +**Decoding (raw → value):** +```text +dB = (raw - 120) / 10 +``` + +| Raw | Gain | +|---|---| +| `0x00` | -12 dB | +| `0x78` | 0 dB | +| `0xF0` | +12 dB | + +### 5.3 PEQ Q Factor + +| Field | Value | +|---|---| +| **Purpose** | Parametric EQ bandwidth (Q) | +| **Size** | 1 byte, logarithmic index | +| **Range** | 0.40 to 128.00 | +| **Raw range** | `0x00`–`0x64` (0–100) | + +**Encoding (value → raw):** +```text +raw = round(log(Q / 0.40) / log(128 / 0.40) × 100) +``` + +**Decoding (raw → value):** +```text +Q = 0.40 × (128 / 0.40) ^ (raw / 100) +``` + +--- + +## 6. Dynamics Processing Parameters + +### 6.1 Hold (Gate) + +| Field | Value | +|---|---| +| **Purpose** | Gate hold time | +| **Size** | 2 bytes, little-endian | +| **Range** | 10 ms to 999 ms | + +**Encoding (value → raw):** +```text +raw = hold_ms - 1 +LO = raw & 0xFF +HI = (raw >> 8) & 0xFF +``` + +**Decoding (raw → value):** +```text +raw = LO | (HI << 8) +hold_ms = raw + 1 +``` + +### 6.2 Attack (Compressor) + +| Field | Value | +|---|---| +| **Purpose** | Compressor attack time | +| **Size** | 2 bytes, little-endian | +| **Range** | 1 ms to 999 ms | + +**Encoding (value → raw):** +```text +raw = attack_ms - 1 +LO = raw & 0xFF +HI = (raw >> 8) & 0xFF +``` + +**Decoding (raw → value):** +```text +raw = LO | (HI << 8) +attack_ms = raw + 1 +``` + +### 6.3 Release + +| Field | Value | +|---|---| +| **Purpose** | Release time | +| **Size** | 2 bytes, little-endian | +| **Range** | 10 ms to 3000 ms | + +**Encoding (value → raw):** +```text +raw = release_ms - 1 +LO = raw & 0xFF +HI = (raw >> 8) & 0xFF +``` + +**Decoding (raw → value):** +```text +raw = LO | (HI << 8) +release_ms = raw + 1 +``` + +### 6.4 Knee (Compressor) + +| Field | Value | +|---|---| +| **Purpose** | Compressor knee width | +| **Size** | 2 bytes | +| **Range** | 0 dB to 12 dB | +| **Resolution** | 1 dB | + +**Encoding (value → raw):** +```text +raw = round(knee_db) +LO = raw & 0xFF +HI = (raw >> 8) & 0xFF +``` + +**Decoding (raw → value):** +```text +knee_db = LO | (HI << 8) +``` + +### 6.5 Sidechain Frequency (Compressor) + +| Field | Value | +|---|---| +| **Purpose** | Compressor sidechain filter frequency | +| **Size** | 2 bytes, little-endian | +| **Range** | 19.70 Hz to 20160 Hz | +| **Raw range** | `0x0000`–`0x012C` | + +**Encoding (value → raw):** +```text +raw = round(log(Hz / 19.70) / log(20160 / 19.70) × 300) +LO = raw & 0xFF +HI = (raw >> 8) & 0xFF +``` + +**Decoding (raw → value):** +```text +raw = LO | (HI << 8) +Hz = 19.70 × (20160 / 19.70) ^ (raw / 300) +``` + +### 6.6 Gate Threshold Encoding + +Gate threshold uses a **16-bit little-endian** value. + +| Field | Value | +|---|---| +| **Purpose** | Gate open/close threshold | +| **Size** | 2 bytes, little-endian | +| **Range** | `-90.0 dB` to `0.0 dB` | +| **Raw range** | `0x0000`–`0x00B4` (0–180) | +| **Resolution** | `0.5 dB` | + +**Encoding (dB → raw):** + +```text +raw = round((dB - (-90.0)) × 2) + +LO = raw & 0xFF +HI = (raw >> 8) & 0xFF +``` + +**Decoding (raw → dB):** + +```text +raw = LO | (HI << 8) +dB = -90.0 + (raw / 2) +``` + +### 6.7 Compressor Threshold + +| Field | Value | +|---|---| +| **Purpose** | Compressor threshold | +| **Size** | 2 bytes | +| **Range** | -110 dB to 0 dB | +| **Resolution** | 0.5 dB | + +**Encoding (value → raw):** +```text +raw = round((dB - (-110)) × 2) +LO = raw & 0xFF +HI = (raw >> 8) & 0xFF +``` + +**Decoding (raw → value):** +```text +raw = LO | (HI << 8) +dB = (raw / 2) - 110 +``` + +--- + +## 7. Delay + +### 7.1 Channel Delay + +| Field | Value | +|---|---| +| **Purpose** | Per-channel delay | +| **Size** | 1 byte | +| **Raw range** | `0x00`–`0xFF` (0–255) | + +**Range by selected unit** (see [Delay Unit](#35-delay-unit)): + +| Unit | `delay_min` | `delay_max` | +|---|---|---| +| Millisecond | 0.000 ms | 680.000 ms | +| Meter | 0.000 m | 233.580 m | +| Feet | 0.000 ft | 766.329 ft | + +**Encoding (value → raw):** +```text +raw = round((delay - delay_min) / (delay_max - delay_min) × 255) +``` + +**Decoding (raw → value):** +```text +delay = delay_min + (raw / 255) × (delay_max - delay_min) +``` + +### 7.2 Delay Unit + +**Range:** `0x00`–`0x02` (3 units) + +| Value | Unit | +|---|---| +| `0x00` | Millisecond | +| `0x01` | Meter | +| `0x02` | Feet | + +--- + +## 8. Metering + +### 8.1 Meter Level + +| Field | Value | +|---|---| +| **Purpose** | Per-channel level + peak metering | +| **Size** | 3 bytes per channel | +| **Total** | 12 channels × 3 bytes = 36 bytes | + +| Byte offset | Field | Format | +|---|---|---| +| 0–1 | Level | IEEE754 float16, little-endian | +| 2 | Peak | 1-byte peak value (format not specified in source) | + +**Encoding (value → raw):** +```text +level_bytes = float16_encode(level) // 2 bytes, little-endian +peak_byte = peak_encode(peak) // format undefined — see note below +raw = level_bytes + peak_byte +``` + +**Decoding (raw → value):** +```text +level = float16_decode(raw[0:2]) // little-endian +peak = peak_decode(raw[2]) // format undefined — see note below +``` + +--- + +# Command Specification + +## 1. Frame Structure + +Every command — query or response — shares one frame layout. Colors match the highlighted examples throughout this document: + +| Field | Size | Color | Description | +|---|---|---|---| +| `STX` | 2 bytes | ■ | Fixed start marker: `10 02` | +| `DIR` | 2 bytes | ■ | Direction (see below) | +| `LEN` | 1 byte | ■ | Byte count of `CMD + DATA` | +| `CMD` | 1 byte | ■ | Command code | +| `DATA` | `LEN - 1` bytes | ■ | Command payload (may be 0 bytes) | +| `ETX` | 2 bytes | ■ | Fixed end marker: `10 03` | +| `CS` | 1 byte | ■ | Checksum (see below) | + +Example skeleton: + +10 02 DIR DIR LEN CMD DATA... 10 03 CS + +### Direction (`DIR`) + +| Value | Direction | +|---|---| +| `00 XX` | Host → Device (Query) | +| `XX 00` | Device → Host (Response) | + +XX represents the device Id + +### Length (`LEN`) + +```text +LEN = size(CMD) + size(DATA) = 1 + size(DATA) +``` + +### Checksum (`CS`) + +The checksum is the **XOR of every byte in the frame from `DIR` through `DATA`, inclusive, with an initial seed of `0x01`**. + +**Encoding (value → raw):** +```text +CS = DIR[0] ^ DIR[1] ^ LEN ^ CMD ^ DATA[0] ^ ... ^ DATA[N-1] ^ 0x01 +``` + +**Decoding / verification (raw → check):** +```text +computed_CS = DIR[0] ^ DIR[1] ^ LEN ^ CMD ^ DATA[0] ^ ... ^ DATA[N-1] ^ 0x01 +valid = (computed_CS == received_CS) +``` + +--- + +## 2. Command Template + +Every command in this document uses the same shape: + +**`0xXX` — Name** +**Direction:** Host→Device / Device→Host / Both +**Category:** ... +**Purpose:** one-line description +**Sequencing:** what must precede/follow this command, if anything +**Payload Fields** — table of `Offset | Field | Size | Encoding Reference | Value/Range` +**Example** — annotated, color-coded hex frame + +--- + +## 3. Connection & Session + +### `0x01` — Acknowledgement +**Direction:** Device → Host +**Category:** Connection & Session +**Purpose:** Signals the device finished loading/processing and is ready. +**Sequencing:** Sent after any state-changing command. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| — | (none) | 0 bytes | Command has no payload | + +**Example** + +10 02 +01 00 +01 +01 +10 03 +00 + +--- + +### `0x02` — Not Implemented +**Direction:** Device → Host +**Category:** Connection & Session +**Purpose:** Signals that the command just sent is invalid/unimplemented. +**Sequencing:** Sent in place of `0x01` when a command fails to parse or is unsupported. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| — | (none) | 0 bytes | Command has no payload | + +**Example** + +10 02 +01 00 +01 +02 +10 03 +00 + +--- + +### `0x10` — Start +**Direction:** Host → Device (Query), Device → Host (Response) +**Category:** Connection & Session +**Purpose:** Initiates a session with the device. +**Sequencing:** First command sent on connect. + +**Payload Fields (Response only)** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Status | 1 byte | `0x13` = OK | + +**Example — Query** + +10 02 +00 01 +01 +10 +10 03 +11 + +**Example — Response** + +10 02 +01 00 +02 +10 +13 +10 03 +01 + +--- + +### `0x11` — Disconnect +**Direction:** Host → Device +**Category:** Connection & Session +**Purpose:** Terminates the session. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| — | (none) | 0 bytes | Command has no payload | + +**Example** + +10 02 +00 01 +01 +11 +10 03 +10 + +--- + +### `0x12` — Acknowledgement (Client → Device) +**Direction:** Host → Device +**Category:** Connection & Session +**Purpose:** Client-side confirmation after loading parameters (mirrors `0x01` but in the opposite direction). +**Sequencing:** Followed by `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| — | (none) | 0 bytes | Command has no payload | + +**Example** + +10 02 +00 01 +01 +12 +10 03 +13 + +--- + +## 4. Device Info + +### `0x13` — Device Name +**Direction:** Host → Device (Query), Device → Host (Response) +**Category:** Device Info +**Purpose:** Reads the device's display name. + +**Payload Fields (Response only)** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` – `Byte N-1` | Device name | 13 bytes | [Enc §2.2 Channel Name](#22-channel-name)| + +**Example — Query** + +10 02 +00 01 +01 +13 +10 03 +12 + +**Example — Response** + +10 02 +01 00 +0E +13 +44 53 50 34 30 38 20 56 30 31 30 34 50 +10 03 +45 + +--- + +### `0x2C` — Device Flags +**Direction:** Host → Device (Query), Device → Host (Response) +**Category:** Device Info +**Purpose:** Reads device status flags, including lock state. Not fully reverse-engineered. + +**Payload Fields (Response only)** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Unknown | 1 byte | `00` observed | +| `Byte 2-3` | Unknown | 2 bytes | `27 0F` observed | +| `Byte 4-5` | Unknown | 2 bytes | `00 00` observed | +| `Byte 6` | Lock state | 1 byte | `01` = Locked, `00` = Unlocked | + +**Example — Query** + +10 02 +00 01 +01 +2C +10 03 +2D + +**Example — Response** + +10 02 +01 00 +07 +2C +00 27 0F 00 00 00 +10 03 +03 + +--- + +## 5. Preset Management + +### `0x14` — Current Preset Index +**Direction:** Host → Device (Query), Device → Host (Response) +**Category:** Preset Management +**Purpose:** Reads the currently active preset. + +**Payload Fields (Response only)** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Preset index | 1 byte | [Enc §3.1 Preset Index](#31-preset-index)| + +**Example — Query** + +10 02 +00 01 +01 +14 +10 03 +15 + +**Example — Response** + +10 02 +01 00 +02 +14 +06 +10 03 +10 + +--- + +### `0x20` — Recall Preset +**Direction:** Host → Device +**Category:** Preset Management +**Purpose:** Recalls (loads) a stored preset. +**Sequencing:** Followed by `0x01` (Acknowledgement) once loading finishes. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Preset index | 1 byte | [Enc §3.1 Preset Index](#31-preset-index) | + +**Example** + +10 02 +00 01 +02 +20 +10 +10 03 +32 + +--- + +### `0x21` — Store Preset +**Direction:** Host → Device +**Category:** Preset Management +**Purpose:** Saves the current live settings into a preset slot. +**Sequencing:** Call `0x26` (Store Preset Name) first to set the name being saved. Must be followed by `0x12`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Preset slot | 1 byte | [Enc §3.1 Preset Index](#31-preset-index), no 0x00| + +**Example** + +10 02 +00 01 +02 +21 +01 +10 03 +CS + +--- + +### `0x22` — Get Preset Modification Status +**Direction:** Host → Device (Query), Device → Host (Response) +**Category:** Preset Management +**Purpose:** Reports which presets have unsaved/modified state. + +**Payload Fields (Response only)** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1`–`Byte 20` | Per-preset modified flag | 1 byte each | `0xFF` = modified, `0x00` = unmodified | + +**Example — Query** + +10 02 +00 01 +01 +22 +10 03 +23 + +**Example — Response** + +10 02 +01 00 +15 +22 +FF 00 FF FF FF 00 00 00 00 00 00 00 00 00 00 00 00 00 00 +10 03 +37 + +--- + +### `0x23` — Factory Reset +**Direction:** Host → Device +**Category:** Preset Management +**Purpose:** Restores factory defaults. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| — | (none) | 0 bytes | Command has no payload | + +**Example** + +10 02 +00 01 +01 +23 +10 03 +CS + +--- + +### `0x27` / `0x24` — Config Chunk (Request / Response) +**Direction:** `0x27` Host→Device (Request), `0x24` Device→Host (Response) +**Category:** Preset Management +**Purpose:** Streams the full device configuration in indexed chunks. +**Sequencing:** Request `0x27` is followed by response `0x24`. Must be followed by `0x12`, after full batch request. + +**Payload Fields — Request (`0x27`)** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Chunk index | 1 byte | `0x00`–`0x1C` | + +**Payload Fields — Response (`0x24`)** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Sub-index | 1 bytes | `0x00`–`0x1C` | +| `Byte 2`–`Byte 51` | Configuration data | 50 bytes | binary/ASCII mixed | + +**Example — Request** + +10 02 +00 01 +03 +27 +INDEX +10 03 +CS + +**Example — Response** + +10 02 +01 00 +34 +24 +00 FF 00 44 65 66 61 75 6C 74 20 50 72 65 73 65 74 49 6E 41 00 00 00 00 00 00 00 63 00 63 00 00 00 78 00 78 00 78 00 78 00 78 00 78 00 78 00 78 00 +10 03 +BF + +--- + +### Config Data — Reassembled Payload Layout + +The 50-byte pages from chunks `0x00`–`0x1C` are concatenated in index order into a single buffer before parsing. Below is that buffer's field layout, byte-for-byte, in the order fields are consumed. + +**Legend (protocol constants used below)** + +| Symbol | Meaning | +|---|---| +| `PNL` | `PRESET_NAME_LENGTH` | +| `CNL` | `CHANNEL_NAME_LENGTH` | +| `N_IN` | number of input channels (`len(INPUT_ORDER)`) | +| `N_OUT` | number of output channels (`len(OUTPUT_ORDER)`) | +| `N_FREQ` | number of GEQ bands (`len(list(FrequencyValue))`) | +| `N_PEQ_IN` | number of input PEQ bands (`len(PEQ_INPUT_BANDS)`) | +| `N_PEQ_OUT` | number of output PEQ bands (`len(PEQ_OUTPUT_BANDS)`) | + +**Header** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `0x00` | Flags (unused) | 2 bytes | reserved | +| `0x02` | Preset name | `PNL` bytes | ASCII, raw → `raw_to_preset_name` | + +**Per Input Channel — repeats `N_IN` times** + +| Offset (within block) | Field | Size | Encoding | +|---|---|---|---| +| `+0x00` | Channel name | `CNL` bytes | ASCII, raw → `raw_to_channel_name` | +| `+CNL` | Gate: attack | 2 bytes | `u16` → `raw_to_attack_ms` | +| `+CNL+2` | Gate: release | 2 bytes | `u16` → `raw_to_release_ms` | +| `+CNL+4` | Gate: hold | 2 bytes | `u16` → `raw_to_hold_ms` | +| `+CNL+6` | Gate: threshold | 2 bytes | `u16` → `raw_to_threshold_db` | +| `+CNL+8` | GEQ gains | `2 × N_FREQ` bytes | `N_FREQ` × `u16` → `raw_to_eq_gain` | +| `+CNL+8+2·N_FREQ` | PEQ chain | `6 × N_PEQ_IN` bytes | `N_PEQ_IN` bands, each: `u16` gain, `u16` freq, `u8` Q, `u8` filter type | +| … | Crossover: HP freq | 2 bytes | `u16` → `raw_to_frequency_hz` | +| … | Crossover: LP freq | 2 bytes | `u16` → `raw_to_frequency_hz` | +| … | Crossover: HP slope | 1 byte | `u8` → `raw_to_crossover_filter` | +| … | Crossover: LP slope | 1 byte | `u8` → `raw_to_crossover_filter` | +| … | Channel gain | 2 bytes | `u16` → `raw_to_channel_gain` | +| … | Phase inverted | 1 byte | `u8` bool | +| … | Reserved | 2 bytes | skipped | +| … | Delay (raw) | 1 byte | `u8`, resolved via `raw_to_delay(value, delay_unit)` once the header-level delay unit is parsed | +| … | Linked channels | 2 bytes | `u16` bitmap → `raw_to_link_channels` | + +Per-channel block size: `CNL + 2·N_FREQ + 6·N_PEQ_IN + 22` bytes. + +**Per Output Channel — repeats `N_OUT` times** (immediately follows the last input channel block) + +| Offset (within block) | Field | Size | Encoding | +|---|---|---|---| +| `+0x00` | Channel name | `CNL` bytes | ASCII, raw → `raw_to_channel_name` | +| … | Matrix: connected | 2 bytes | `u16` bitmap → `raw_to_matrix` | +| … | Matrix: gains | 8 bytes | 4 × `u16` → `raw_to_matrix_gain` | +| … | Crossover (HP/LP freq + slope) | 6 bytes | same layout as input crossover | +| … | PEQ chain | `6 × N_PEQ_OUT` bytes | `N_PEQ_OUT` bands, same per-band layout as input | +| … | Compressor: ratio | 2 bytes | `u16` → `raw_to_ratio` | +| … | Compressor: attack | 2 bytes | `u16` → `raw_to_attack_ms` | +| … | Compressor: release | 2 bytes | `u16` → `raw_to_release_ms` | +| … | Compressor: knee | 2 bytes | `u16` → `raw_to_knee_db` | +| … | Compressor: threshold | 2 bytes | `u16` → `raw_to_threshold_db` | +| … | Limiter: attack | 2 bytes | `u16` → `raw_to_attack_ms` | +| … | Limiter: release | 2 bytes | `u16` → `raw_to_release_ms` | +| … | Reserved | 2 bytes | skipped | +| … | Limiter: threshold | 2 bytes | `u16` → `raw_to_threshold_db` | +| … | Channel gain | 2 bytes | `u16` → `raw_to_channel_gain` | +| … | Phase inverted | 1 byte | `u8` bool | +| … | Reserved | 2 bytes | skipped | +| … | Delay (raw) | 1 byte | `u8`, resolved via `raw_to_delay(value, delay_unit)` | +| … | Linked channels | 2 bytes | `u16` bitmap → `raw_to_link_channels` | + +Per-channel block size: `CNL + 6·N_PEQ_OUT + 42` bytes. + +**Global Flags** (immediately follows the last output channel block) + +| Offset (within section) | Field | Size | Encoding | +|---|---|---|---| +| `+0x00` | Input mute bitmap | 2 bytes | `u16`, bit *i* = `INPUT_ORDER[i]` muted | +| `+0x02` | Output mute bitmap | 2 bytes | `u16`, bit *i* = `OUTPUT_ORDER[i]` muted | +| `+0x04` | Input PEQ band mute | `2 × N_IN` bytes | one `u16` per input channel, bit *j* = `PEQ_INPUT_BANDS[j]` bypassed | +| `+0x04+2·N_IN` | Output PEQ band mute | `2 × N_OUT` bytes | one `u16` per output channel, bit *j* = `PEQ_OUTPUT_BANDS[j]` bypassed | + +**Input Source & Delay Unit** (immediately follows Global Flags) + +| Offset (within section) | Field | Size | Encoding | +|---|---|---|---| +| `+0x00` | Input source type | 2 bytes | `u16` → `raw_to_input_source` | +| `+0x02` | Input source frequency | 2 bytes | `u16` → `raw_to_frequency_value` | +| `+0x04` | Delay unit | 2 bytes | `u16` → `raw_to_delay_unit` (applies to all previously-read raw delay bytes) | + +**Trailing Bypass Flags** (immediately follows Input Source & Delay Unit) + +| Offset (within section) | Field | Size | Encoding | +|---|---|---|---| +| `+0x00` | Input PEQ chain bypass bitmap | 2 bytes | `u16`, bit *i* = `INPUT_ORDER[i]`'s PEQ chain bypassed | +| `+0x02` | Output PEQ chain bypass bitmap | 2 bytes | `u16`, bit *i* = `OUTPUT_ORDER[i]`'s PEQ chain bypassed | +| `+0x04` | Input GEQ bypass bitmap | 2 bytes | `u16`, bit *i* = `INPUT_ORDER[i]`'s GEQ bypassed | + +**Total reassembled payload size:** +`2 + PNL + N_IN·(CNL + 2·N_FREQ + 6·N_PEQ_IN + 22) + N_OUT·(CNL + 6·N_PEQ_OUT + 42) + 4 + 2·N_IN + 2·N_OUT + 4 + 2 + 6` bytes. + +--- + +### `0x26` — Store Preset Name +**Direction:** Host → Device +**Category:** Preset Management +**Purpose:** Sets the working preset name prior to saving. +**Sequencing:** Call before `0x21` (Store Preset). + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1`–`Byte 14` | Preset name | 14 bytes | [Enc §2.1 Preset Name](#21-preset-name) | + +**Example** + +10 02 +00 01 +0F +26 +50 72 65 73 65 74 20 4E 61 6D 65 20 20 20 +10 03 +CS + +--- + +### `0x29` — Get Preset Name +**Direction:** Host → Device (Query), Device → Host (Response) +**Category:** Preset Management +**Purpose:** Reads the name of a given preset. + +**Payload Fields — Query** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Preset index | 1 byte | [Enc §3.1 Preset Index](#31-preset-index) | + +**Payload Fields — Response** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1`–`Byte N` | Preset name | 14 bytes | [Enc §2.1 Preset Name](#21-preset-name) | + +**Example — Query** + +10 02 +00 01 +02 +29 +00 +10 03 +2B + +**Example — Response** + +10 02 +01 00 +10 +29 +4D 61 69 6E 20 70 72 65 73 65 74 20 20 20 +10 03 +17 + +--- + +## 6. Security + +### `0x2D` — Unlock Device +**Direction:** Host → Device (Query), Device → Host (Response) +**Category:** Security +**Purpose:** Authenticates with a password to unlock the device. + +**Payload Fields — Query** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Unknown | 1 byte | `00` observed | +| `Byte 2`–`Byte N` | Password | 4 bytes | [Enc §2.3 Password](#23-password) | + +**Payload Fields — Response** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Status category | 1 byte | `00` observed | +| `Byte 2` | Authentication result | 1 byte | `00` = Failed, `01` = Success | + +**Example — Query (password `1234`)** + +10 02 +00 01 +06 +2D +00 31 32 33 34 +10 03 +2F + +**Example — Response** + +10 02 +01 00 +03 +2D +00 01 +10 03 +2F + +--- + +### `0x2F` — Lock Device +**Direction:** Host → Device +**Category:** Security +**Purpose:** Locks the device behind a password. +**Sequencing:** Followed by `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1`–`Byte N` | Password | 4 bytes | [Enc §2.3 Password](#23-password) | + +**Example (password `1234`)** + +10 02 +00 01 +05 +2F +31 32 33 34 +10 03 +2E + +--- + +## 7. Channel Configuration + +### `0x2A` — Copy Channel +**Direction:** Host → Device +**Category:** Channel Configuration +**Purpose:** Copies one channel's settings onto another. +**Sequencing:** Followed by `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Source channel | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2` | Destination channel | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | + +**Example** + +10 02 +00 01 +03 +2A +00 01 +10 03 +28 + +--- + +### `0x3B` — Link Channel +**Direction:** Host → Device +**Category:** Channel Configuration +**Purpose:** Groups channels so they move together. +**Sequencing:** Followed by `0x01`. Use `0x2A` (Copy Channel) before linking channels with `0x3B`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2` | Link mask | 1 byte | Bitmask — same OR pattern as [Enc §4.1 Matrix Input Mask](#41-matrix-input-mask), generalized to the channel's own bit position | + +**Link mask rule:** bit `N` set → channel `N` is linked to this channel. + +| Value | Meaning | +|---|---| +| `0x00` | No linked channels | +| `0x01`–`0x0F` | Valid range for input channels (bits 0–3 only) | +| `0x01`–`0xFF` | Valid range for output channels (bits 0–7) | + +**Example** + +10 02 +00 01 +03 +3B +03 08 +10 03 +33 + +(Channel `0x03`, link mask `0x08` → linked to channel 3) + +--- + +### `0x3D` — Set Channel Name +**Direction:** Host → Device +**Category:** Channel Configuration +**Purpose:** Sets the display name of an output channel. +**Sequencing:** Followed by `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Output channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2`–`Byte 9` | Channel name | 8 bytes | [Enc §2.2 Channel Name](#22-channel-name) | + +**Example** + +10 02 +00 01 +0A +3D +CH NAME[8] +10 03 +CS + +--- + +## 8. Channel Processing + +### `0x15` — Set Delay Unit +**Direction:** Host → Device +**Category:** Channel Processing +**Purpose:** Changes the display unit used for delay values. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Delay unit | 1 byte | [Enc §3.5 Delay Unit](#72-delay-unit) | + +**Example** + +10 02 +00 01 +02 +15 +01 +10 03 +CS + +--- + +### `0x34` — Set Gain +**Direction:** Host → Device +**Category:** Channel Processing +**Purpose:** Sets a channel's gain. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2-3` | Gain | 2 bytes, little-endian | [Enc §5.1 Channel Gain](#51-channel-gain) | + +**Example** + +10 02 +00 01 +04 +34 +CH LO HI +10 03 +CS + +--- + +### `0x35` — Set Mute +**Direction:** Host → Device +**Category:** Channel Processing +**Purpose:** Mutes or unmutes a channel. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2` | Mute state | 1 byte | `0x00` = Unmuted, `0x01` = Muted | + +**Example** + +10 02 +00 01 +03 +35 +CH MUTE +10 03 +CS + +--- + +### `0x36` — Invert Gain +**Direction:** Host → Device +**Category:** Channel Processing +**Purpose:** Inverts polarity on a channel. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2` | Invert state | 1 byte | `0x00` = Normal, `0x01` = Inverted | + +**Example** + +10 02 +00 01 +03 +36 +CH INVERT +10 03 +CS + +--- + +### `0x38` — Set Delay +**Direction:** Host → Device +**Category:** Channel Processing +**Purpose:** Sets a channel's delay value. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2` | Reserved | 1 byte | Always `0x00` | +| `Byte 3` | Delay | 1 byte | [Enc §7.1 Channel Delay](#71-channel-delay) | + +**Example** + +10 02 +00 01 +04 +38 +CH 00 DELAY +10 03 +CS + +--- + +### `0x3C` — Bypass EQ +**Direction:** Host → Device +**Category:** Channel Processing +**Purpose:** Enables or bypasses all EQ processing on a channel. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2` | EQ bypass state | 1 byte | `0x00` = Active, `0x01` = Bypassed | + +**Example** + +10 02 +00 01 +03 +3C +CH BYPASS +10 03 +CS + +--- + +## 9. Dynamics + +### `0x30` — Set Compressor +**Direction:** Host → Device +**Category:** Dynamics +**Purpose:** Sets compressor parameters for a channel. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2-3` | Ratio | 2 bytes, little-endian | [Enc §3.6 Compressor Ratio](#36-compressor-ratio) | +| `Byte 4-5` | Attack | 2 bytes, little-endian | [Enc §6.2 Attack](#62-attack-compressor) | +| `Byte 6-7` | Release | 2 bytes, little-endian | [Enc §6.3 Release](#63-release-compressor) | +| `Byte 8-9` | Knee | 2 bytes, little-endian | [Enc §6.4 Knee](#64-knee-compressor) | +| `Byte 10-11` | Threshold | 2 bytes, little-endian | [Enc §6.7 Compressor Threshold](#67-compressor-threshold) | + +**Example** + +10 02 +00 01 +0C +30 +CH RA 00 AT_LO AT_HI RE_LO RE_HI KN 00 TH 00 +10 03 +CS + +--- + +### `0x3E` — Set Gate Parameters +**Direction:** Host → Device +**Category:** Dynamics +**Purpose:** Sets noise-gate parameters for a channel. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2-3` | Attack | 2 bytes, little-endian | [Enc §6.2 Attack](#62-attack-compressor) | +| `Byte 4-5` | Release | 2 bytes, little-endian | [Enc §6.3 Release](#63-release-compressor) | +| `Byte 6-7` | Hold | 2 bytes, little-endian | [Enc §6.1 Hold](#61-hold-gate) | +| `Byte 8-9` | Threshold | 2 bytes, little-endian | [Enc §6.6 Gate Threshold](#66-gate-threshold) | + +**Example** + +10 02 +00 01 +0A +3E +CH AT 00 RE_LO RE_HI HO_LO HO_HI GA 00 +10 03 +82 + +--- + +### `0x3F` — Set Output Limiter +**Direction:** Host → Device +**Category:** Dynamics +**Purpose:** Sets output-limiter parameters. Output channels only. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Output channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2-3` | Attack | 2 bytes, little-endian | [Enc §6.2 Attack](#62-attack-compressor) | +| `Byte 4-5` | Release | 2 bytes, little-endian | [Enc §6.3 Release](#63-release-compressor) | +| `Byte 6-7` | Reserved | 2 bytes | Always `0000` | +| `Byte 8-9` | Threshold | 2 bytes, little-endian | [Enc §6.7 Compressor Threshold](#67-compressor-threshold) | + +**Example** + +10 02 +00 01 +0A +3F +CH AT_LO AT_HI RE_LO RE_HI 00 00 TH 00 +10 03 +CS + +--- + +## 10. Filters & EQ + +### `0x31` — Set Low-Pass Filter +**Direction:** Host → Device +**Category:** Filters & EQ +**Purpose:** Sets the low-pass filter for a channel. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2-3` | Cutoff frequency | 2 bytes, little-endian | [Enc §6.5 Sidechain Frequency](#65-sidechain-frequency-compressor) | +| `Byte 4` | Filter type | 1 byte | [Enc §3.9 Crossover Slope](#39-crossover-slope) | + +**Example** + +10 02 +00 01 +04 +31 +CH FREQ_LO FREQ_HI TYPE +10 03 +CS + +--- + +### `0x32` — Set High-Pass Filter +**Direction:** Host → Device +**Category:** Filters & EQ +**Purpose:** Sets the high-pass filter for a channel. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2-3` | Cutoff frequency | 2 bytes, little-endian | [Enc §6.5 Sidechain Frequency](#65-sidechain-frequency-compressor) | +| `Byte 4` | Filter type | 1 byte | [Enc §3.9 Crossover Slope](#39-crossover-slope) | + +**Example** + +10 02 +00 01 +04 +32 +CH FREQ_LO FREQ_HI TYPE +10 03 +CS + +--- + +### `0x33` — Set PEQ Band +**Direction:** Host → Device +**Category:** Filters & EQ +**Purpose:** Sets one parametric EQ band. Input channels only. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2` | PEQ band index | 1 byte | [Enc §3.3 PEQ Band Index](#33-peq-band-index) | +| `Byte 3-4` | Gain | 2 bytes, little-endian | [Enc §5.2 GEQ/PEQ Gain](#52-geq--peq-gain) | +| `Byte 5-6` | Frequency | 2 bytes, little-endian | [Enc §6.5 Sidechain Frequency](#65-sidechain-frequency-compressor) +| `Byte 7` | Q factor | 1 byte | [Enc §5.3 PEQ Q Factor](#53-peq-q-factor) | `0x00`–`0x64` | +| `Byte 8` | Filter type | 1 byte | [Enc §3.8 PEQ Filter Type](#38-peq-filter-type) | `0x00`–`0x08` | +| `Byte 9` | Bypass | 1 byte | `0x00` = Enabled, `0x01` = Bypassed | + +**Example** + +10 02 +00 01 +0A +33 +CH BAND GAIN 00 FREQ_LO FREQ_HI Q TYPE BYPASS +10 03 +CS + +--- + +### `0x48` — Set GEQ Band +**Direction:** Host → Device +**Category:** Filters & EQ +**Purpose:** Sets one band of a 31-band graphic EQ. Input channels only. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2` | GEQ band index | 1 byte | [Enc §3.4 Frequency Band Index](#34-frequency-band-index) | +| `Byte 3-4` | Gain | 2 bytes, little-endian | [Enc §5.2 GEQ/PEQ Gain](#52-geq--peq-gain) | + +**Example** + +10 02 +00 01 +05 +48 +CH BAND DB 00 +10 03 +CS + +--- + +### `0x49` — Set GEQ Bypass +**Direction:** Host → Device +**Category:** Filters & EQ +**Purpose:** Enables or bypasses the graphic EQ on an input channel. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2` | Bypass | 1 byte | `0x00` = GEQ enabled, `0x01` = GEQ bypassed | + +**Example** + +10 02 +00 01 +02 +49 +CH BP +10 03 +CS + +--- + +## 11. Input & Routing + +### `0x39` — Set Input Source +**Direction:** Host → Device +**Category:** Input & Routing +**Purpose:** Selects the analog/test signal source. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Source type | 1 byte | [Enc §3.7 Input Source Type](#37-input-source-type) | +| `Byte 2` | Sine wave frequency (only meaningful when `Byte 1 = 0x03`) | 1 byte | [Enc §3.4 Frequency Band Index](#34-frequency-band-index) | + +**Examples** + +Analog: +10 02 00 01 03 39 00 00 10 03 3A + +Pink Noise: +10 02 00 01 03 39 01 00 10 03 3B + +White Noise: +10 02 00 01 03 39 02 00 10 03 38 + +Sine Wave: +10 02 00 01 03 39 03 XX 10 03 YY + +--- + +### `0x3A` — Matrix Routing +**Direction:** Host → Device +**Category:** Input & Routing +**Purpose:** Sets which inputs feed a given output channel. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Output channel | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2` | Input routing mask | 1 byte | [Enc §4.1 Matrix Input Mask](#41-matrix-input-mask) | + +**Example** + +10 02 +00 01 +03 +3A +OUT INPUT_MASK +10 03 +CS + +--- + +### `0x41` — Set Matrix Gain +**Direction:** Host → Device +**Category:** Input & Routing +**Purpose:** Sets the send gain from one input to one output. +**Sequencing:** Device acknowledges with `0x01`. + +**Payload Fields** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1` | Output channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 2` | Input channel index | 1 byte | [Enc §3.2 Channel Index](#32-channel-index) | +| `Byte 3-4` | Gain | 2 bytes, little-endian | [Enc §5.1 Channel Gain](#51-channel-gain) | + +**Example** + +10 02 +00 01 +05 +41 +CH_OUT CH_IN GAIN_LO GAIN_HI +10 03 +CS + +--- + +## 12. Metering + +### `0x40` — Get Level Meters +**Direction:** Host → Device (Query), Device → Host (Response) +**Category:** Metering +**Purpose:** Reads current level-meter and clip-indicator values for all channels. + +**Payload Fields (Response only)** + +| Offset | Field | Size | Encoding | +|---|---|---|---| +| `Byte 1-36` | 12 meter channels | 3 bytes × 12 | [Enc §8.1 Meter Level](#81-meter-level) | +| `Byte 37` | Input clip indicator | 1 byte bitmask | Same OR bitmask pattern as [Enc §4.1](#41-matrix-input-mask) | +| `Byte 38` | Output clip indicator | 1 byte bitmask | Same OR bitmask pattern as [Enc §4.1](#41-matrix-input-mask) | + +**Example — Query** + +10 02 +00 01 +01 +40 +10 03 +41 + +**Example — Response** + +10 02 +01 00 +27 +40 +A2 36 A5 A0 36 A0 ... 39 00 00 +10 03 +75 + +--- diff --git a/rust-toolchain.toml b/rust-toolchain.toml new file mode 100644 index 0000000..02d090f --- /dev/null +++ b/rust-toolchain.toml @@ -0,0 +1,3 @@ +[toolchain] +channel = "stable" +components = ["rustfmt", "clippy"] \ No newline at end of file diff --git a/src/common/mod.rs b/src/common/mod.rs index b0f995d..ae30249 100644 --- a/src/common/mod.rs +++ b/src/common/mod.rs @@ -1,2 +1,2 @@ pub mod errors; -pub(crate) mod validator; \ No newline at end of file +pub(crate) mod validator; diff --git a/src/common/validator.rs b/src/common/validator.rs index 7689a70..dda0bb1 100644 --- a/src/common/validator.rs +++ b/src/common/validator.rs @@ -66,79 +66,39 @@ mod tests { #[test] fn validate_range_rejects_out_of_range() { - let err = validate_range(11u8, 0..=10, || "bad value".into()) - .unwrap_err(); + let err = validate_range(11u8, 0..=10, || "bad value".into()).unwrap_err(); assert!(err.to_string().contains("bad value")); } #[test] fn validate_ascii_padded_accepts_ascii_and_padding() { - assert!(validate_ascii_padded( - b"ABC ", - 4, - b' ', - "name", - ) - .is_ok()); + assert!(validate_ascii_padded(b"ABC ", 4, b' ', "name",).is_ok()); - assert!(validate_ascii_padded( - &[b'A', 0, 0, 0], - 4, - 0, - "password", - ) - .is_ok()); + assert!(validate_ascii_padded(&[b'A', 0, 0, 0], 4, 0, "password",).is_ok()); } #[test] fn validate_ascii_padded_rejects_wrong_length() { - assert!(validate_ascii_padded( - b"ABC", - 4, - b' ', - "name", - ) - .is_err()); + assert!(validate_ascii_padded(b"ABC", 4, b' ', "name",).is_err()); } #[test] fn validate_ascii_padded_rejects_non_ascii() { - assert!(validate_ascii_padded( - &[0xFF, b'A', b'B', b'C'], - 4, - b' ', - "name", - ) - .is_err()); + assert!(validate_ascii_padded(&[0xFF, b'A', b'B', b'C'], 4, b' ', "name",).is_err()); } #[test] fn validate_bitmask_accepts_valid_bits() { - assert!(validate_bitmask( - 0b0101, - 0b1111, - || "".into(), - ) - .is_ok()); + assert!(validate_bitmask(0b0101, 0b1111, || "".into(),).is_ok()); - assert!(validate_bitmask( - 0, - 0b1111, - || "".into(), - ) - .is_ok()); + assert!(validate_bitmask(0, 0b1111, || "".into(),).is_ok()); } #[test] fn validate_bitmask_rejects_invalid_bits() { - let err = validate_bitmask( - 0b10000, - 0b01111, - || "invalid mask".into(), - ) - .unwrap_err(); + let err = validate_bitmask(0b10000, 0b01111, || "invalid mask".into()).unwrap_err(); assert!(err.to_string().contains("invalid mask")); } -} \ No newline at end of file +} diff --git a/src/dsp408/client/dsp408.rs b/src/dsp408/client/dsp408.rs index ad8d99e..e50a4f6 100644 --- a/src/dsp408/client/dsp408.rs +++ b/src/dsp408/client/dsp408.rs @@ -14,14 +14,10 @@ use crate::{ dsp408::{ mapper::{ self, - constants::{PRESET_INDEX_MAX, CONFIG_CHUNK_INDEX_MAX}, + constants::{CONFIG_CHUNK_INDEX_MAX, PRESET_INDEX_MAX}, response::map_response, }, - protocol::{ - commands, - config::decode_config, - frame::extract_frame, - }, + protocol::{commands, config::decode_config, frame::extract_frame}, types, }, }; @@ -44,33 +40,21 @@ pub struct DSP408 { } impl DSP408 { - - pub fn new( - host: IpAddr, - port: u16, - device_id: u8, - ) -> Result { - + pub fn new(host: IpAddr, port: u16, device_id: u8) -> Result { if matches!(host, IpAddr::V6(_)) { - return Err(DSPError::InvalidHost( - "DSP doesn't support IPv6" - )); + return Err(DSPError::InvalidHost("DSP doesn't support IPv6")); } if port == 0 { - return Err(DSPError::InvalidPort( - "Port must be between 1 and 65535" - )); + return Err(DSPError::InvalidPort("Port must be between 1 and 65535")); } - if device_id == 0 || device_id > 254 { return Err(DSPError::InvalidDeviceId( - "Device ID must be between 1 and 254" + "Device ID must be between 1 and 254", )); } - Ok(Self { connection: types::DeviceConnection { host, @@ -88,83 +72,43 @@ impl DSP408 { }) } - fn send_raw( - &mut self, - data: &[u8], - ) -> Result<(), DSPError> { - - - let _guard = - self.lock.lock().unwrap(); - - - let socket = - self.socket - .as_mut() - .ok_or( - DSPError::NotConnected - )?; + fn send_raw(&mut self, data: &[u8]) -> Result<(), DSPError> { + let _guard = self.lock.lock().unwrap(); + let socket = self.socket.as_mut().ok_or(DSPError::NotConnected)?; socket.write_all(data)?; Ok(()) } - fn recv_raw( - &mut self - ) -> Result, DSPError> { - - let socket = - self.socket - .as_mut() - .ok_or( - DSPError::NotConnected - )?; - - - let mut buffer = - vec![0u8; RECV_BUFSIZE]; + fn recv_raw(&mut self) -> Result, DSPError> { + let socket = self.socket.as_mut().ok_or(DSPError::NotConnected)?; + let mut buffer = vec![0u8; RECV_BUFSIZE]; match socket.read(&mut buffer) { - - Ok(0) => - Err(DSPError::ConnectionClosed), + Ok(0) => Err(DSPError::ConnectionClosed), Ok(size) => { buffer.truncate(size); Ok(buffer) - }, + } - Err(e) - if e.kind() - == - std::io::ErrorKind::TimedOut => - { - Err(DSPError::Timeout) - }, + Err(e) if e.kind() == std::io::ErrorKind::TimedOut => Err(DSPError::Timeout), - Err(e) => - Err(DSPError::Io(e)), + Err(e) => Err(DSPError::Io(e)), } } - pub fn send_recv( - &mut self, - command: &[u8], - ) -> Result { - + pub fn send_recv(&mut self, command: &[u8]) -> Result { self.send_raw(command)?; - let raw = - self.recv_raw()?; + let raw = self.recv_raw()?; - let frame = - extract_frame(&raw)?; + let frame = extract_frame(&raw)?; - let response = - map_response(&frame)?; + let response = map_response(&frame)?; Ok(response) } @@ -174,46 +118,29 @@ impl DSP408 { } pub fn state(&self) -> Result<&types::DSPState, DSPError> { - self.state - .as_ref() - .ok_or(DSPError::NotConnected) + self.state.as_ref().ok_or(DSPError::NotConnected) } fn state_mut(&mut self) -> Result<&mut types::DSPState, DSPError> { - self.state - .as_mut() - .ok_or(DSPError::NotConnected) + self.state.as_mut().ok_or(DSPError::NotConnected) } // ---------- Commands ---------- // Command `0x10` pub fn connect(&mut self) -> Result<(), DSPError> { - - let key = ( - self.connection.host, - self.connection.device_id - ); + let key = (self.connection.host, self.connection.device_id); { - let map = instances() - .lock() - .unwrap(); + let map = instances().lock().unwrap(); if map.contains_key(&key) { return Err(DSPError::AlreadyConnected); } } - let addr = SocketAddr::new( - self.connection.host, - self.connection.port - ); + let addr = SocketAddr::new(self.connection.host, self.connection.port); - let stream = - TcpStream::connect_timeout( - &addr, - SOCKET_TIMEOUT - )?; + let stream = TcpStream::connect_timeout(&addr, SOCKET_TIMEOUT)?; stream.set_read_timeout(Some(SOCKET_TIMEOUT))?; @@ -226,18 +153,12 @@ impl DSP408 { let start = std::time::Instant::now(); while start.elapsed() < SOCKET_TIMEOUT { - let raw = self.recv_raw()?; let frame = extract_frame(&raw)?; let response = map_response(&frame)?; if matches!(response, types::DeviceResponseType::HandshakeAck(_)) { - - instances() - .lock() - .unwrap() - .insert(key, ()); - + instances().lock().unwrap().insert(key, ()); self.connected = true; @@ -248,9 +169,7 @@ impl DSP408 { let mut preset_names = Vec::with_capacity(PRESET_INDEX_MAX); for i in 0..PRESET_INDEX_MAX { - preset_names.push( - self.get_preset_name(i + 1)? - ); + preset_names.push(self.get_preset_name(i + 1)?); } let state = self.read_config_state()?; @@ -277,31 +196,15 @@ impl DSP408 { // Command `0x11` pub fn disconnect(&mut self) { - - let key = ( - self.connection.host, - self.connection.device_id - ); + let key = (self.connection.host, self.connection.device_id); if let Some(mut socket) = self.socket.take() { + let _ = socket.write_all(&commands::build_disconnect()); - let _ = - socket.write_all( - &commands::build_disconnect() - ); - - let _ = - socket.shutdown( - std::net::Shutdown::Both - ); + let _ = socket.shutdown(std::net::Shutdown::Both); } - - instances() - .lock() - .unwrap() - .remove(&key); - + instances().lock().unwrap().remove(&key); self.connected = false; } @@ -309,9 +212,9 @@ impl DSP408 { // Command `0x12` fn request_acknowledgement(&mut self) -> Result { let request = commands::build_acknowledgement(); - + let resp = self.send_recv(&request)?; - + match resp { types::DeviceResponseType::Acknowledgement(ack) => Ok(ack.success), other => Err(DSPError::UnexpectedResponse(format!( @@ -428,7 +331,7 @@ impl DSP408 { if !self.request_acknowledgement()? { return Err(DSPError::OperationFailed( - "Store Configuration fails".into() + "Store Configuration fails".into(), )); } @@ -470,9 +373,7 @@ impl DSP408 { let resp = self.send_recv(&request)?; match resp { - types::DeviceResponseType::Acknowledgement(ack) => { - Ok(ack.success) - } + types::DeviceResponseType::Acknowledgement(ack) => Ok(ack.success), other => Err(DSPError::UnexpectedResponse(format!( "Expected Acknowledgement, got {:?}", other @@ -516,9 +417,7 @@ impl DSP408 { let resp = self.send_recv(&request)?; match resp { - types::DeviceResponseType::ConfigChunk(config) => { - Ok(config) - } + types::DeviceResponseType::ConfigChunk(config) => Ok(config), other => Err(DSPError::UnexpectedResponse(format!( "Expected ConfigChunk, got {:?}", other @@ -549,20 +448,14 @@ impl DSP408 { channel_1: types::Channel, channel_2: types::Channel, ) -> Result { - let (raw_channel_1, raw_channel_2) = mapper::copy_channel_to_raw(channel_1, channel_2)?; - let request = commands::build_copy_channel( - raw_channel_1, - raw_channel_2, - )?; + let request = commands::build_copy_channel(raw_channel_1, raw_channel_2)?; let resp = self.send_recv(&request)?; match resp { - types::DeviceResponseType::Acknowledgement(ack) => { - Ok(ack.success) - } + types::DeviceResponseType::Acknowledgement(ack) => Ok(ack.success), other => Err(DSPError::UnexpectedResponse(format!( "Expected Acknowledgement, got {:?}", other @@ -647,7 +540,6 @@ impl DSP408 { knee: u16, threshold: f32, ) -> Result { - let raw_channel = mapper::output_channel_to_raw(channel)?; let raw_ratio = mapper::ratio_to_raw(ratio)?; let raw_attack = mapper::attack_ms_to_raw(attack)?; @@ -674,16 +566,13 @@ impl DSP408 { let state = self.state_mut()?; - state - .current_config - .output_state_mut(channel) - .compressor = types::Compressor { - threshold, - ratio, - attack, - release, - knee, - }; + state.current_config.output_state_mut(channel).compressor = types::Compressor { + threshold, + ratio, + attack, + release, + knee, + }; Ok(true) } @@ -701,16 +590,11 @@ impl DSP408 { freq: f32, filter_type: types::CrossoverFilter, ) -> Result { - let raw_channel = mapper::channel_to_raw(channel)?; let raw_freq = mapper::frequency_hz_to_raw(freq)?; let raw_filter = mapper::crossover_filter_to_raw(filter_type)?; - let request = commands::build_low_pass( - raw_channel, - raw_freq, - raw_filter, - )?; + let request = commands::build_low_pass(raw_channel, raw_freq, raw_filter)?; let resp = self.send_recv(&request)?; @@ -729,9 +613,9 @@ impl DSP408 { .input_state_mut(input) .crossover .low_pass = types::Crossover { - frequency: freq, - slope: filter_type, - }; + frequency: freq, + slope: filter_type, + }; } types::Channel::Output(output) => { @@ -740,9 +624,9 @@ impl DSP408 { .output_state_mut(output) .crossover .low_pass = types::Crossover { - frequency: freq, - slope: filter_type, - }; + frequency: freq, + slope: filter_type, + }; } } @@ -763,16 +647,11 @@ impl DSP408 { freq: f32, filter_type: types::CrossoverFilter, ) -> Result { - let raw_channel = mapper::channel_to_raw(channel)?; let raw_freq = mapper::frequency_hz_to_raw(freq)?; let raw_filter = mapper::crossover_filter_to_raw(filter_type)?; - let request = commands::build_high_pass( - raw_channel, - raw_freq, - raw_filter, - )?; + let request = commands::build_high_pass(raw_channel, raw_freq, raw_filter)?; let resp = self.send_recv(&request)?; @@ -791,9 +670,9 @@ impl DSP408 { .input_state_mut(input) .crossover .high_pass = types::Crossover { - frequency: freq, - slope: filter_type, - }; + frequency: freq, + slope: filter_type, + }; } types::Channel::Output(output) => { @@ -802,9 +681,9 @@ impl DSP408 { .output_state_mut(output) .crossover .high_pass = types::Crossover { - frequency: freq, - slope: filter_type, - }; + frequency: freq, + slope: filter_type, + }; } } @@ -830,7 +709,6 @@ impl DSP408 { filter_type: types::PEQFilter, bypass: bool, ) -> Result { - let raw_channel = mapper::channel_to_raw(channel)?; let raw_band = mapper::peq_band_to_raw(band, channel)?; let raw_gain = mapper::eq_gain_db_to_raw(gain_db)?; @@ -868,11 +746,8 @@ impl DSP408 { match channel { types::Channel::Input(input) => { - state - .current_config - .input_state_mut(input) - .peq_chain - .bands[band as usize] = peq; + state.current_config.input_state_mut(input).peq_chain.bands + [band as usize] = peq; } types::Channel::Output(output) => { @@ -895,19 +770,11 @@ impl DSP408 { } // Command `0x34` (Set Gain) - pub fn set_channel_gain( - &mut self, - channel: types::Channel, - db: f32, - ) -> Result { - + pub fn set_channel_gain(&mut self, channel: types::Channel, db: f32) -> Result { let raw_channel = mapper::channel_to_raw(channel)?; let raw_db = mapper::gain_db_to_raw(db)?; - let request = commands::build_gain( - raw_channel, - raw_db, - )?; + let request = commands::build_gain(raw_channel, raw_db)?; let resp = self.send_recv(&request)?; @@ -921,17 +788,11 @@ impl DSP408 { match channel { types::Channel::Input(input) => { - state - .current_config - .input_state_mut(input) - .gain = db; + state.current_config.input_state_mut(input).gain = db; } types::Channel::Output(output) => { - state - .current_config - .output_state_mut(output) - .gain = db; + state.current_config.output_state_mut(output).gain = db; } } @@ -946,18 +807,10 @@ impl DSP408 { } // Command `0x35` (Set Mute) - pub fn set_mute( - &mut self, - channel: types::Channel, - muted: bool, - ) -> Result { - + pub fn set_mute(&mut self, channel: types::Channel, muted: bool) -> Result { let raw_channel = mapper::channel_to_raw(channel)?; - let request = commands::build_mute( - raw_channel, - muted as u8, - )?; + let request = commands::build_mute(raw_channel, muted as u8)?; let resp = self.send_recv(&request)?; @@ -971,17 +824,11 @@ impl DSP408 { match channel { types::Channel::Input(input) => { - state - .current_config - .input_state_mut(input) - .mute = muted; + state.current_config.input_state_mut(input).mute = muted; } types::Channel::Output(output) => { - state - .current_config - .output_state_mut(output) - .mute = muted; + state.current_config.output_state_mut(output).mute = muted; } } @@ -1001,13 +848,9 @@ impl DSP408 { channel: types::Channel, inverted: bool, ) -> Result { - let raw_channel = mapper::channel_to_raw(channel)?; - let request = commands::build_inverted_gain( - raw_channel, - inverted as u8, - )?; + let request = commands::build_inverted_gain(raw_channel, inverted as u8)?; let resp = self.send_recv(&request)?; @@ -1021,17 +864,11 @@ impl DSP408 { match channel { types::Channel::Input(input) => { - state - .current_config - .input_state_mut(input) - .phase_inverted = inverted; + state.current_config.input_state_mut(input).phase_inverted = inverted; } types::Channel::Output(output) => { - state - .current_config - .output_state_mut(output) - .phase_inverted = inverted; + state.current_config.output_state_mut(output).phase_inverted = inverted; } } @@ -1052,14 +889,10 @@ impl DSP408 { delay: f32, unit: types::DelayUnit, ) -> Result { - let raw_channel = mapper::channel_to_raw(channel)?; let raw_delay = mapper::delay_to_raw(delay, unit)?; - let request = commands::build_set_delay( - raw_channel, - raw_delay, - )?; + let request = commands::build_set_delay(raw_channel, raw_delay)?; let resp = self.send_recv(&request)?; @@ -1075,17 +908,11 @@ impl DSP408 { match channel { types::Channel::Input(input) => { - state - .current_config - .input_state_mut(input) - .delay = delay; + state.current_config.input_state_mut(input).delay = delay; } types::Channel::Output(output) => { - state - .current_config - .output_state_mut(output) - .delay = delay; + state.current_config.output_state_mut(output).delay = delay; } } @@ -1100,18 +927,11 @@ impl DSP408 { } // Command `0x39` (Set Input Source) - pub fn set_input_source( - &mut self, - input_source: types::InputSource, - ) -> Result { - + pub fn set_input_source(&mut self, input_source: types::InputSource) -> Result { let raw_source = mapper::input_source_to_raw(input_source.r#type)?; let raw_frequency = mapper::frequency_value_to_raw(input_source.frequency)?; - let request = commands::build_set_input_source( - raw_source, - raw_frequency, - )?; + let request = commands::build_set_input_source(raw_source, raw_frequency)?; let resp = self.send_recv(&request)?; @@ -1140,14 +960,10 @@ impl DSP408 { output: types::OutputChannel, inputs: Vec, ) -> Result { - let raw_output = mapper::output_channel_to_raw(output)?; let raw_inputs = mapper::matrix_to_raw(&inputs)?; - let request = commands::build_matrix_routing( - raw_output, - raw_inputs, - )?; + let request = commands::build_matrix_routing(raw_output, raw_inputs)?; let resp = self.send_recv(&request)?; @@ -1181,7 +997,6 @@ impl DSP408 { source: types::Channel, destinations: Vec, ) -> Result { - let raw_source = mapper::channel_to_raw(source)?; let bitmask = mapper::link_channels_to_raw(source, &destinations)?; @@ -1197,10 +1012,7 @@ impl DSP408 { } // Link source - let request = commands::build_link_channel( - raw_source, - bitmask, - )?; + let request = commands::build_link_channel(raw_source, bitmask)?; let resp = self.send_recv(&request)?; @@ -1219,7 +1031,6 @@ impl DSP408 { } } - // Clear destination links for destination in &destinations { if *destination == source { @@ -1228,10 +1039,7 @@ impl DSP408 { let raw_destination = mapper::channel_to_raw(*destination)?; - let request = commands::build_link_channel( - raw_destination, - 0x00, - )?; + let request = commands::build_link_channel(raw_destination, 0x00)?; let resp = self.send_recv(&request)?; @@ -1268,13 +1076,9 @@ impl DSP408 { channel: types::Channel, bypass: bool, ) -> Result { - let raw_channel = mapper::channel_to_raw(channel)?; - let request = commands::build_bypass_peq( - raw_channel, - bypass as u8, - )?; + let request = commands::build_bypass_peq(raw_channel, bypass as u8)?; let resp = self.send_recv(&request)?; @@ -1288,13 +1092,13 @@ impl DSP408 { match channel { types::Channel::Input(input) => { - state.current_config.input_state_mut(input) - .peq_chain - .bypass = bypass; + state.current_config.input_state_mut(input).peq_chain.bypass = bypass; } types::Channel::Output(output) => { - state.current_config.output_state_mut(output) + state + .current_config + .output_state_mut(output) .peq_chain .bypass = bypass; } @@ -1316,14 +1120,10 @@ impl DSP408 { channel: types::Channel, name: &str, ) -> Result { - let raw_channel = mapper::channel_to_raw(channel)?; let raw_name = mapper::channel_name_to_raw(name)?; - let request = commands::build_store_channel_name( - raw_channel, - &raw_name, - )?; + let request = commands::build_store_channel_name(raw_channel, &raw_name)?; let resp = self.send_recv(&request)?; @@ -1337,13 +1137,11 @@ impl DSP408 { match channel { types::Channel::Input(input) => { - state.current_config.input_state_mut(input) - .name = name.to_string(); + state.current_config.input_state_mut(input).name = name.to_string(); } types::Channel::Output(output) => { - state.current_config.output_state_mut(output) - .name = name.to_string(); + state.current_config.output_state_mut(output).name = name.to_string(); } } @@ -1366,7 +1164,6 @@ impl DSP408 { hold: u16, release: u16, ) -> Result { - let raw_channel = mapper::input_channel_to_raw(channel)?; let raw_threshold = mapper::gate_threshold_db_to_raw(threshold)?; let raw_attack = mapper::attack_ms_to_raw(attack)?; @@ -1391,15 +1188,12 @@ impl DSP408 { let state = self.state_mut()?; - state - .current_config - .input_state_mut(channel) - .gate = types::Gate { - attack, - release, - hold, - threshold, - }; + state.current_config.input_state_mut(channel).gate = types::Gate { + attack, + release, + hold, + threshold, + }; Ok(true) } @@ -1419,18 +1213,13 @@ impl DSP408 { attack: u16, release: u16, ) -> Result { - let raw_channel = mapper::output_channel_to_raw(channel)?; let raw_threshold = mapper::threshold_db_to_raw(threshold)?; let raw_attack = mapper::attack_ms_to_raw(attack)?; let raw_release = mapper::release_ms_to_raw(release)?; - let request = commands::build_set_limiter( - raw_channel, - raw_threshold, - raw_attack, - raw_release, - )?; + let request = + commands::build_set_limiter(raw_channel, raw_threshold, raw_attack, raw_release)?; let resp = self.send_recv(&request)?; @@ -1442,14 +1231,11 @@ impl DSP408 { let state = self.state_mut()?; - state - .current_config - .output_state_mut(channel) - .limiter = types::Limiter { - threshold, - attack, - release, - }; + state.current_config.output_state_mut(channel).limiter = types::Limiter { + threshold, + attack, + release, + }; Ok(true) } @@ -1462,10 +1248,7 @@ impl DSP408 { } // Command `0x40` (Get Level Meters) - pub fn get_meter_levels( - &mut self, - ) -> Result { - + pub fn get_meter_levels(&mut self) -> Result { let request = commands::build_get_meter_levels(); let resp = self.send_recv(&request)?; @@ -1487,16 +1270,11 @@ impl DSP408 { output_channel: types::OutputChannel, gain: f32, ) -> Result { - let raw_input_channel = mapper::input_channel_to_raw(input_channel)?; let raw_output_channel = mapper::output_channel_to_raw(output_channel)?; let raw_gain = mapper::matrix_gain_db_to_raw(gain)?; - let request = commands::build_matrix_gain( - raw_input_channel, - raw_output_channel, - raw_gain, - )?; + let request = commands::build_matrix_gain(raw_input_channel, raw_output_channel, raw_gain)?; let resp = self.send_recv(&request)?; @@ -1510,9 +1288,11 @@ impl DSP408 { let index = types::InputChannel::iter() .position(|x| x == input_channel) - .ok_or_else(|| DSPError::Validation(ValidationError::Value( - "Invalid input channel".to_string() - )))?; + .ok_or_else(|| { + DSPError::Validation(ValidationError::Value( + "Invalid input channel".to_string(), + )) + })?; state .current_config @@ -1537,16 +1317,12 @@ impl DSP408 { frequency_band: types::DiscreteFrequency, gain: f32, ) -> Result { - let raw_input_channel = mapper::input_channel_to_raw(input_channel)?; let raw_frequency_band = mapper::frequency_value_to_raw(frequency_band)?; let raw_gain = mapper::eq_gain_db_to_raw(gain)?; - let request = commands::build_set_geq_band( - raw_input_channel, - raw_frequency_band, - raw_gain, - )?; + let request = + commands::build_set_geq_band(raw_input_channel, raw_frequency_band, raw_gain)?; let resp = self.send_recv(&request)?; @@ -1560,17 +1336,19 @@ impl DSP408 { let index = types::DiscreteFrequency::iter() .position(|x| x == frequency_band) - .ok_or_else(|| DSPError::Validation(ValidationError::Value( - "Invalid GEQ frequency band".to_string() - )))?; + .ok_or_else(|| { + DSPError::Validation(ValidationError::Value( + "Invalid GEQ frequency band".to_string(), + )) + })?; state .current_config .input_state_mut(input_channel) .geq .gains[index] = gain; - Ok(true) - } + Ok(true) + } other => Err(DSPError::UnexpectedResponse(format!( "Expected Acknowledgement, got {:?}", @@ -1585,13 +1363,9 @@ impl DSP408 { input_channel: types::InputChannel, bypass: bool, ) -> Result { - let raw_input_channel = mapper::input_channel_to_raw(input_channel)?; - let request = commands::build_set_geq_bypass( - raw_input_channel, - bypass as u8, - )?; + let request = commands::build_set_geq_bypass(raw_input_channel, bypass as u8)?; let resp = self.send_recv(&request)?; @@ -1630,14 +1404,11 @@ impl DSP408 { let config = decode_config(&raw)?; if !self.request_acknowledgement()? { - return Err(DSPError::OperationFailed( - "DSP initialization".into() - )); + return Err(DSPError::OperationFailed("DSP initialization".into())); } Ok(config) } - } impl Drop for DSP408 { diff --git a/src/dsp408/client/mod.rs b/src/dsp408/client/mod.rs index 13ae338..2115262 100644 --- a/src/dsp408/client/mod.rs +++ b/src/dsp408/client/mod.rs @@ -1,2 +1,2 @@ mod dsp408; -pub use dsp408::DSP408; \ No newline at end of file +pub use dsp408::DSP408; diff --git a/src/dsp408/mapper/channel.rs b/src/dsp408/mapper/channel.rs index 194411a..f9cce25 100644 --- a/src/dsp408/mapper/channel.rs +++ b/src/dsp408/mapper/channel.rs @@ -2,30 +2,16 @@ use strum::IntoEnumIterator; use crate::{ common::{ - errors::{ - DecodingError, - MapperError, - ValidationError, - }, - validator::{ - validate_ascii_padded, - validate_range, - }, + errors::{DecodingError, MapperError, ValidationError}, + validator::{validate_ascii_padded, validate_range}, }, dsp408::{ - protocol::{ - constants as protocol_constants, - validators, - }, + protocol::{constants as protocol_constants, validators}, types, }, }; -use super::{ - constants as mapper_constants, - decode_ascii, - encode_ascii, -}; +use super::{constants as mapper_constants, decode_ascii, encode_ascii}; // ------ CHANNEL ------ @@ -71,14 +57,12 @@ pub fn channel_to_raw(channel: types::Channel) -> Result { pub fn raw_to_channel(value: u8) -> Result { validators::validate_raw_channel(value)?; - raw_to_channel_value(value) - .ok_or_else(|| { - MapperError::Decoding( - DecodingError::new( - format!("Unknown channel value: {:#04x}", value) - ) - ) - }) + raw_to_channel_value(value).ok_or_else(|| { + MapperError::Decoding(DecodingError::new(format!( + "Unknown channel value: {:#04x}", + value + ))) + }) } pub fn input_channel_to_raw(channel: types::InputChannel) -> Result { @@ -99,7 +83,11 @@ pub fn channel_name_to_raw(name: &str) -> Result, MapperError> { "Channel name", )?; - Ok(encode_ascii(name, protocol_constants::CHANNEL_NAME_LENGTH, protocol_constants::CHANNEL_NAME_PADDING)?) + Ok(encode_ascii( + name, + protocol_constants::CHANNEL_NAME_LENGTH, + protocol_constants::CHANNEL_NAME_PADDING, + )?) } pub fn raw_to_channel_name(raw_name: &[u8]) -> Result { @@ -111,30 +99,26 @@ pub fn raw_to_channel_name(raw_name: &[u8]) -> Result { // ------ ATTACK ------ pub fn attack_ms_to_raw(value: u16) -> Result { - validate_range( - value, - mapper_constants::ATTACK_MS_RANGE, - || format!("Invalid attack: {:#06x}", value), - )?; - + validate_range(value, mapper_constants::ATTACK_MS_RANGE, || { + format!("Invalid attack: {:#06x}", value) + })?; + Ok(value - 1) } pub fn raw_to_attack_ms(value: u16) -> Result { validators::validate_raw_attack(value)?; - + Ok(value + 1) } // ------ RELEASE ------ pub fn release_ms_to_raw(value: u16) -> Result { - validate_range( - value, - mapper_constants::RELEASE_MS_RANGE, - || format!("Invalid release: {:#06x}", value), - )?; - + validate_range(value, mapper_constants::RELEASE_MS_RANGE, || { + format!("Invalid release: {:#06x}", value) + })?; + Ok(value - 1) } @@ -147,11 +131,9 @@ pub fn raw_to_release_ms(value: u16) -> Result { // ------ HOLD ------ pub fn hold_ms_to_raw(hold: u16) -> Result { - validate_range( - hold, - mapper_constants::HOLD_MS_RANGE, - || format!("Invalid hold: {:#06x}", hold), - )?; + validate_range(hold, mapper_constants::HOLD_MS_RANGE, || { + format!("Invalid hold: {:#06x}", hold) + })?; Ok(hold - 1) } @@ -165,11 +147,9 @@ pub fn raw_to_hold_ms(hold: u16) -> Result { // ------ GATE THRESHOLD ------ pub fn gate_threshold_db_to_raw(db: f32) -> Result { - validate_range( - db, - mapper_constants::GATE_THRESHOLD_DB_RANGE, - || format!("Invalid gate threshold: {db}"), - )?; + validate_range(db, mapper_constants::GATE_THRESHOLD_DB_RANGE, || { + format!("Invalid gate threshold: {db}") + })?; let db = (db * 2.0).round() / 2.0; @@ -185,13 +165,12 @@ pub fn raw_to_gate_threshold_db(value: u16) -> Result { // ------ EQ GAIN ------ fn eq_gain_raw_steps() -> f32 { - (*protocol_constants::EQ_GAIN_RAW_RANGE.end() - - *protocol_constants::EQ_GAIN_RAW_RANGE.start()) as f32 + (*protocol_constants::EQ_GAIN_RAW_RANGE.end() - *protocol_constants::EQ_GAIN_RAW_RANGE.start()) + as f32 } fn eq_gain_step_db() -> f32 { - (*mapper_constants::EQ_GAIN_DB_RANGE.end() - - *mapper_constants::EQ_GAIN_DB_RANGE.start()) + (*mapper_constants::EQ_GAIN_DB_RANGE.end() - *mapper_constants::EQ_GAIN_DB_RANGE.start()) / eq_gain_raw_steps() } @@ -200,29 +179,21 @@ fn eq_quantize(db: f32) -> f32 { } pub fn eq_gain_db_to_raw(gain: f32) -> Result { - validate_range( - gain, - mapper_constants::EQ_GAIN_DB_RANGE, - || format!("Invalid EQ gain: {gain}"), - )?; + validate_range(gain, mapper_constants::EQ_GAIN_DB_RANGE, || { + format!("Invalid EQ gain: {gain}") + })?; let gain = eq_quantize(gain); - Ok( - *protocol_constants::EQ_GAIN_RAW_RANGE.start() - + ((gain - *mapper_constants::EQ_GAIN_DB_RANGE.start()) - / eq_gain_step_db()) - .round() as u16 - ) + Ok(*protocol_constants::EQ_GAIN_RAW_RANGE.start() + + ((gain - *mapper_constants::EQ_GAIN_DB_RANGE.start()) / eq_gain_step_db()).round() as u16) } pub fn raw_to_eq_gain(value: u16) -> Result { validators::validate_raw_eq_gain(value)?; - let gain = - *mapper_constants::EQ_GAIN_DB_RANGE.start() - + (value - *protocol_constants::EQ_GAIN_RAW_RANGE.start()) as f32 - * eq_gain_step_db(); + let gain = *mapper_constants::EQ_GAIN_DB_RANGE.start() + + (value - *protocol_constants::EQ_GAIN_RAW_RANGE.start()) as f32 * eq_gain_step_db(); Ok(eq_quantize(gain)) } @@ -248,7 +219,7 @@ pub fn peq_band_to_raw(band: types::PEQBand, channel: types::Channel) -> Result< types::Channel::Input(_) => { if matches!(band, types::PEQBand::B9) { return Err(MapperError::Validation(ValidationError::Value( - "PEQ Band B9 is not available on input channels".to_string() + "PEQ Band B9 is not available on input channels".to_string(), ))); } } @@ -264,7 +235,9 @@ pub fn peq_band_to_raw(band: types::PEQBand, channel: types::Channel) -> Result< // ------ GAIN ------ fn gain_split_raw() -> u16 { - ((mapper_constants::GAIN_SPLIT_DB - mapper_constants::GAIN_DB_RANGE.start()) / mapper_constants::GAIN_LOW_STEP_DB).round() as u16 + ((mapper_constants::GAIN_SPLIT_DB - mapper_constants::GAIN_DB_RANGE.start()) + / mapper_constants::GAIN_LOW_STEP_DB) + .round() as u16 } fn quantize_gain(db: f32) -> f32 { @@ -276,18 +249,21 @@ fn quantize_gain(db: f32) -> f32 { } pub fn gain_db_to_raw(gain: f32) -> Result { - validate_range( - gain, - mapper_constants::GAIN_DB_RANGE, - || format!("Invalid channel gain: {gain}"), - )?; + validate_range(gain, mapper_constants::GAIN_DB_RANGE, || { + format!("Invalid channel gain: {gain}") + })?; let gain = quantize_gain(gain); if gain < mapper_constants::GAIN_SPLIT_DB { - Ok(((gain - mapper_constants::GAIN_DB_RANGE.start()) / mapper_constants::GAIN_LOW_STEP_DB).round() as u16) + Ok( + ((gain - mapper_constants::GAIN_DB_RANGE.start()) / mapper_constants::GAIN_LOW_STEP_DB) + .round() as u16, + ) } else { - Ok(gain_split_raw() + ((gain - mapper_constants::GAIN_SPLIT_DB) / mapper_constants::GAIN_HIGH_STEP_DB).round() as u16) + Ok(gain_split_raw() + + ((gain - mapper_constants::GAIN_SPLIT_DB) / mapper_constants::GAIN_HIGH_STEP_DB) + .round() as u16) } } @@ -295,25 +271,28 @@ pub fn raw_to_gain(raw_gain: u16) -> Result { validators::validate_raw_gain(raw_gain)?; if raw_gain < gain_split_raw() { - Ok(mapper_constants::GAIN_DB_RANGE.start() + raw_gain as f32 * mapper_constants::GAIN_LOW_STEP_DB) + Ok(mapper_constants::GAIN_DB_RANGE.start() + + raw_gain as f32 * mapper_constants::GAIN_LOW_STEP_DB) } else { - Ok(mapper_constants::GAIN_SPLIT_DB + (raw_gain - gain_split_raw()) as f32 * mapper_constants::GAIN_HIGH_STEP_DB) + Ok(mapper_constants::GAIN_SPLIT_DB + + (raw_gain - gain_split_raw()) as f32 * mapper_constants::GAIN_HIGH_STEP_DB) } } // ------ CONTIGUOUS FREQUENCY ------ pub fn frequency_hz_to_raw(hz: f32) -> Result { + validate_range(hz, mapper_constants::FREQUENCY_HZ_RANGE, || { + format!("Invalid frequency: {hz}") + })?; - validate_range( - hz, - mapper_constants::FREQUENCY_HZ_RANGE, - || format!("Invalid frequency: {hz}"), - )?; + let device_steps = (protocol_constants::FREQUENCY_RAW_RANGE.end() + - protocol_constants::FREQUENCY_RAW_RANGE.start()) as f32; - let device_steps = (protocol_constants::FREQUENCY_RAW_RANGE.end() - protocol_constants::FREQUENCY_RAW_RANGE.start()) as f32; - - let raw = ((hz / mapper_constants::FREQUENCY_HZ_RANGE.start()).ln() / (mapper_constants::FREQUENCY_HZ_RANGE.end() / mapper_constants::FREQUENCY_HZ_RANGE.start()).ln() + let raw = ((hz / mapper_constants::FREQUENCY_HZ_RANGE.start()).ln() + / (mapper_constants::FREQUENCY_HZ_RANGE.end() + / mapper_constants::FREQUENCY_HZ_RANGE.start()) + .ln() * device_steps) .round(); @@ -322,11 +301,16 @@ pub fn frequency_hz_to_raw(hz: f32) -> Result { pub fn raw_to_frequency_hz(value: u16) -> Result { validators::validate_raw_frequency(value)?; - - let device_steps = (protocol_constants::FREQUENCY_RAW_RANGE.end() - protocol_constants::FREQUENCY_RAW_RANGE.start()) as f32; - let normalized = (value - protocol_constants::FREQUENCY_RAW_RANGE.start()) as f32 / device_steps; - Ok(mapper_constants::FREQUENCY_HZ_RANGE.start() * (mapper_constants::FREQUENCY_HZ_RANGE.end() / mapper_constants::FREQUENCY_HZ_RANGE.start()).powf(normalized)) + let device_steps = (protocol_constants::FREQUENCY_RAW_RANGE.end() + - protocol_constants::FREQUENCY_RAW_RANGE.start()) as f32; + let normalized = + (value - protocol_constants::FREQUENCY_RAW_RANGE.start()) as f32 / device_steps; + + Ok(mapper_constants::FREQUENCY_HZ_RANGE.start() + * (mapper_constants::FREQUENCY_HZ_RANGE.end() + / mapper_constants::FREQUENCY_HZ_RANGE.start()) + .powf(normalized)) } // ------ DISCRETE FREQUENCY ------ @@ -369,16 +353,16 @@ fn discrete_frequency_to_raw_value(frequency: types::DiscreteFrequency) -> u8 { fn raw_to_discrete_frequency_value(raw: u8) -> Option { Some(match raw { - 0 => types::DiscreteFrequency::F20, - 1 => types::DiscreteFrequency::F25, - 2 => types::DiscreteFrequency::F31_5, - 3 => types::DiscreteFrequency::F40, - 4 => types::DiscreteFrequency::F50, - 5 => types::DiscreteFrequency::F63, - 6 => types::DiscreteFrequency::F80, - 7 => types::DiscreteFrequency::F100, - 8 => types::DiscreteFrequency::F125, - 9 => types::DiscreteFrequency::F160, + 0 => types::DiscreteFrequency::F20, + 1 => types::DiscreteFrequency::F25, + 2 => types::DiscreteFrequency::F31_5, + 3 => types::DiscreteFrequency::F40, + 4 => types::DiscreteFrequency::F50, + 5 => types::DiscreteFrequency::F63, + 6 => types::DiscreteFrequency::F80, + 7 => types::DiscreteFrequency::F100, + 8 => types::DiscreteFrequency::F125, + 9 => types::DiscreteFrequency::F160, 10 => types::DiscreteFrequency::F200, 11 => types::DiscreteFrequency::F250, 12 => types::DiscreteFrequency::F315, @@ -405,21 +389,18 @@ fn raw_to_discrete_frequency_value(raw: u8) -> Option } pub fn frequency_value_to_raw(frequency: types::DiscreteFrequency) -> Result { - Ok(discrete_frequency_to_raw_value(frequency)) } pub fn raw_to_frequency_value(frequency: u8) -> Result { validators::validate_raw_discrete_frequency(frequency)?; - - raw_to_discrete_frequency_value(frequency) - .ok_or_else(|| { - MapperError::Decoding( - DecodingError::new( - format!("Unknown frequency value: {:#04x}", frequency) - ) - ) - }) + + raw_to_discrete_frequency_value(frequency).ok_or_else(|| { + MapperError::Decoding(DecodingError::new(format!( + "Unknown frequency value: {:#04x}", + frequency + ))) + }) } // ------ CROSSOVER ------ @@ -452,16 +433,16 @@ fn crossover_filter_to_raw_value(filter: types::CrossoverFilter) -> u8 { fn raw_to_crossover_filter_value(raw: u8) -> Option { Some(match raw { - 0 => types::CrossoverFilter::Bypass, - 1 => types::CrossoverFilter::Bw6, - 2 => types::CrossoverFilter::Bl6, - 3 => types::CrossoverFilter::Bw12, - 4 => types::CrossoverFilter::Bl12, - 5 => types::CrossoverFilter::Lk12, - 6 => types::CrossoverFilter::Bw18, - 7 => types::CrossoverFilter::Bl18, - 8 => types::CrossoverFilter::Bw24, - 9 => types::CrossoverFilter::Bl24, + 0 => types::CrossoverFilter::Bypass, + 1 => types::CrossoverFilter::Bw6, + 2 => types::CrossoverFilter::Bl6, + 3 => types::CrossoverFilter::Bw12, + 4 => types::CrossoverFilter::Bl12, + 5 => types::CrossoverFilter::Lk12, + 6 => types::CrossoverFilter::Bw18, + 7 => types::CrossoverFilter::Bl18, + 8 => types::CrossoverFilter::Bw24, + 9 => types::CrossoverFilter::Bl24, 10 => types::CrossoverFilter::Lk24, 11 => types::CrossoverFilter::Bw30, 12 => types::CrossoverFilter::Bl30, @@ -484,38 +465,41 @@ pub fn crossover_filter_to_raw(filter: types::CrossoverFilter) -> Result Result { validators::validate_raw_crossover_filter(raw)?; - raw_to_crossover_filter_value(raw) - .ok_or_else(|| { - MapperError::Decoding( - DecodingError::new( - format!("Unknown crossover filter value: {:#04x}", raw) - ) - ) - }) + raw_to_crossover_filter_value(raw).ok_or_else(|| { + MapperError::Decoding(DecodingError::new(format!( + "Unknown crossover filter value: {:#04x}", + raw + ))) + }) } // ------ PEQ Q ------ pub fn peq_q_to_raw(q: f32, filter: types::PEQFilter) -> Result { - validate_range( - q, - mapper_constants::peq_q_range(filter), - || format!("Invalid PEQ Q: {q}"), - )?; + validate_range(q, mapper_constants::peq_q_range(filter), || { + format!("Invalid PEQ Q: {q}") + })?; - let raw_range = (protocol_constants::PEQ_Q_RAW_RANGE.end() - protocol_constants::PEQ_Q_RAW_RANGE.start()) as f32; + let raw_range = (protocol_constants::PEQ_Q_RAW_RANGE.end() + - protocol_constants::PEQ_Q_RAW_RANGE.start()) as f32; - Ok(((q / mapper_constants::PEQ_Q_RANGE.start()).ln() / (mapper_constants::PEQ_Q_RANGE.end() / mapper_constants::PEQ_Q_RANGE.start()).ln() * raw_range).round() as u8 + Ok(((q / mapper_constants::PEQ_Q_RANGE.start()).ln() + / (mapper_constants::PEQ_Q_RANGE.end() / mapper_constants::PEQ_Q_RANGE.start()).ln() + * raw_range) + .round() as u8 + protocol_constants::PEQ_Q_RAW_RANGE.start()) } pub fn raw_to_peq_q(value: u8) -> Result { validators::validate_raw_peq_q(value)?; - let raw_range = (protocol_constants::PEQ_Q_RAW_RANGE.end() - protocol_constants::PEQ_Q_RAW_RANGE.start()) as f32; + let raw_range = (protocol_constants::PEQ_Q_RAW_RANGE.end() + - protocol_constants::PEQ_Q_RAW_RANGE.start()) as f32; let normalized = (value - protocol_constants::PEQ_Q_RAW_RANGE.start()) as f32 / raw_range; - Ok(mapper_constants::PEQ_Q_RANGE.start() * (mapper_constants::PEQ_Q_RANGE.end() / mapper_constants::PEQ_Q_RANGE.start()).powf(normalized)) + Ok(mapper_constants::PEQ_Q_RANGE.start() + * (mapper_constants::PEQ_Q_RANGE.end() / mapper_constants::PEQ_Q_RANGE.start()) + .powf(normalized)) } // ------ FILTER ------ @@ -556,14 +540,12 @@ pub fn peq_filter_to_raw(filter: types::PEQFilter) -> Result { pub fn raw_to_peq_filter(value: u8) -> Result { validators::validate_raw_peq_filter(value)?; - raw_to_peq_filter_value(value) - .ok_or_else(|| { - MapperError::Decoding( - DecodingError::new( - format!("Unknown PEQ filter value: {:#04x}", value) - ) - ) - }) + raw_to_peq_filter_value(value).ok_or_else(|| { + MapperError::Decoding(DecodingError::new(format!( + "Unknown PEQ filter value: {:#04x}", + value + ))) + }) } // ------ RATIO ------ @@ -591,16 +573,16 @@ fn ratio_to_raw_value(ratio: types::Ratio) -> u16 { fn raw_to_ratio_value(value: u16) -> Option { Some(match value { - 0 => types::Ratio::Ratio1_1, - 1 => types::Ratio::Ratio1_1_1, - 2 => types::Ratio::Ratio1_1_3, - 3 => types::Ratio::Ratio1_1_5, - 4 => types::Ratio::Ratio1_1_7, - 5 => types::Ratio::Ratio1_2, - 6 => types::Ratio::Ratio1_2_5, - 7 => types::Ratio::Ratio1_3, - 8 => types::Ratio::Ratio1_3_5, - 9 => types::Ratio::Ratio1_4, + 0 => types::Ratio::Ratio1_1, + 1 => types::Ratio::Ratio1_1_1, + 2 => types::Ratio::Ratio1_1_3, + 3 => types::Ratio::Ratio1_1_5, + 4 => types::Ratio::Ratio1_1_7, + 5 => types::Ratio::Ratio1_2, + 6 => types::Ratio::Ratio1_2_5, + 7 => types::Ratio::Ratio1_3, + 8 => types::Ratio::Ratio1_3_5, + 9 => types::Ratio::Ratio1_4, 10 => types::Ratio::Ratio1_5, 11 => types::Ratio::Ratio1_6, 12 => types::Ratio::Ratio1_8, @@ -618,24 +600,20 @@ pub fn ratio_to_raw(ratio: types::Ratio) -> Result { pub fn raw_to_ratio(value: u16) -> Result { validators::validate_raw_compressor_ratio(value)?; - raw_to_ratio_value(value) - .ok_or_else(|| { - MapperError::Decoding( - DecodingError::new( - format!("Unknown ratio value: {:#04x}", value) - ) - ) - }) + raw_to_ratio_value(value).ok_or_else(|| { + MapperError::Decoding(DecodingError::new(format!( + "Unknown ratio value: {:#04x}", + value + ))) + }) } // ------ KNEE ------ pub fn knee_db_to_raw(db: u16) -> Result { - validate_range( - db, - mapper_constants::KNEE_DB_RANGE, - || format!("Invalid compressor knee: {db}"), - )?; + validate_range(db, mapper_constants::KNEE_DB_RANGE, || { + format!("Invalid compressor knee: {db}") + })?; Ok(db) } @@ -648,11 +626,9 @@ pub fn raw_to_knee_db(value: u16) -> Result { // ------ THRESHOLD ------ pub fn threshold_db_to_raw(db: f32) -> Result { - validate_range( - db, - mapper_constants::THRESHOLD_DB_RANGE, - || format!("Invalid compressor threshold: {db}"), - )?; + validate_range(db, mapper_constants::THRESHOLD_DB_RANGE, || { + format!("Invalid compressor threshold: {db}") + })?; let db = (db * 2.0).round() / 2.0; @@ -670,28 +646,22 @@ pub fn link_channels_to_raw( source: types::Channel, destinations: &[types::Channel], ) -> Result { - let mut mask = 0u8; match source { types::Channel::Input(source_channel) => { for destination in destinations { let types::Channel::Input(destination_channel) = destination else { - return Err(MapperError::Validation( - ValidationError::value( - "Input channel cannot link to output channel" - ), - )); + return Err(MapperError::Validation(ValidationError::value( + "Input channel cannot link to output channel", + ))); }; if *destination_channel < source_channel { - return Err(MapperError::Validation( - ValidationError::value(format!( - "{:?} cannot link to previous channel {:?}", - source_channel, - destination_channel - )), - )); + return Err(MapperError::Validation(ValidationError::value(format!( + "{:?} cannot link to previous channel {:?}", + source_channel, destination_channel + )))); } mask |= 1 << (*destination_channel as u8); @@ -701,21 +671,16 @@ pub fn link_channels_to_raw( types::Channel::Output(source_channel) => { for destination in destinations { let types::Channel::Output(destination_channel) = destination else { - return Err(MapperError::Validation( - ValidationError::value( - "Output channel cannot link to input channel" - ), - )); + return Err(MapperError::Validation(ValidationError::value( + "Output channel cannot link to input channel", + ))); }; if *destination_channel < source_channel { - return Err(MapperError::Validation( - ValidationError::value(format!( - "{:?} cannot link to previous channel {:?}", - source_channel, - destination_channel - )), - )); + return Err(MapperError::Validation(ValidationError::value(format!( + "{:?} cannot link to previous channel {:?}", + source_channel, destination_channel + )))); } mask |= 1 << (*destination_channel as u8); @@ -726,7 +691,10 @@ pub fn link_channels_to_raw( Ok(mask) } -pub fn raw_to_link_channels(source_raw: u8, destination_mask: u8) -> Result, MapperError> { +pub fn raw_to_link_channels( + source_raw: u8, + destination_mask: u8, +) -> Result, MapperError> { validators::validate_raw_link_channel(source_raw, destination_mask)?; let source = raw_to_channel(source_raw)?; @@ -757,7 +725,9 @@ pub fn raw_to_link_channels(source_raw: u8, destination_mask: u8) -> Result u16 { - ((mapper_constants::GAIN_SPLIT_DB - mapper_constants::MATRIX_GAIN_DB_RANGE.start()) / mapper_constants::GAIN_LOW_STEP_DB).round() as u16 + ((mapper_constants::GAIN_SPLIT_DB - mapper_constants::MATRIX_GAIN_DB_RANGE.start()) + / mapper_constants::GAIN_LOW_STEP_DB) + .round() as u16 } fn quantize_matrix_gain(db: f32) -> f32 { @@ -769,19 +739,20 @@ fn quantize_matrix_gain(db: f32) -> f32 { } pub fn matrix_gain_db_to_raw(gain: f32) -> Result { - validate_range( - gain, - mapper_constants::MATRIX_GAIN_DB_RANGE, - || format!("Invalid matrix gain: {gain}"), - )?; + validate_range(gain, mapper_constants::MATRIX_GAIN_DB_RANGE, || { + format!("Invalid matrix gain: {gain}") + })?; let gain = quantize_matrix_gain(gain); if gain < mapper_constants::GAIN_SPLIT_DB { - Ok(((gain - mapper_constants::MATRIX_GAIN_DB_RANGE.start()) / mapper_constants::GAIN_LOW_STEP_DB).round() as u16) + Ok(((gain - mapper_constants::MATRIX_GAIN_DB_RANGE.start()) + / mapper_constants::GAIN_LOW_STEP_DB) + .round() as u16) } else { Ok(matrix_gain_split_raw() - + ((gain - mapper_constants::GAIN_SPLIT_DB) / mapper_constants::GAIN_HIGH_STEP_DB).round() as u16) + + ((gain - mapper_constants::GAIN_SPLIT_DB) / mapper_constants::GAIN_HIGH_STEP_DB) + .round() as u16) } } @@ -789,9 +760,11 @@ pub fn raw_to_matrix_gain(raw_gain: u16) -> Result { validators::validate_raw_matrix_gain(raw_gain)?; if raw_gain < matrix_gain_split_raw() { - Ok(mapper_constants::MATRIX_GAIN_DB_RANGE.start() + raw_gain as f32 * mapper_constants::GAIN_LOW_STEP_DB) + Ok(mapper_constants::MATRIX_GAIN_DB_RANGE.start() + + raw_gain as f32 * mapper_constants::GAIN_LOW_STEP_DB) } else { - Ok(mapper_constants::GAIN_SPLIT_DB + (raw_gain - matrix_gain_split_raw()) as f32 * mapper_constants::GAIN_HIGH_STEP_DB) + Ok(mapper_constants::GAIN_SPLIT_DB + + (raw_gain - matrix_gain_split_raw()) as f32 * mapper_constants::GAIN_HIGH_STEP_DB) } } @@ -819,10 +792,15 @@ pub fn matrix_to_raw(input_channels: &[types::InputChannel]) -> Result Result, MapperError> { validators::validate_raw_matrix_bitmask(raw)?; - Ok([types::InputChannel::InA, types::InputChannel::InB, types::InputChannel::InC, types::InputChannel::InD] - .into_iter() - .filter(|&c| raw & matrix_input_mask(c) != 0) - .collect()) + Ok([ + types::InputChannel::InA, + types::InputChannel::InB, + types::InputChannel::InC, + types::InputChannel::InD, + ] + .into_iter() + .filter(|&c| raw & matrix_input_mask(c) != 0) + .collect()) } // ------ DELAY ------ @@ -832,14 +810,11 @@ fn delay_raw_steps() -> f32 { } pub fn delay_to_raw(delay: f32, unit: types::DelayUnit) -> Result { - let (delay_min, delay_max) = mapper_constants::delay_range(unit); - validate_range( - delay, - delay_min..=delay_max, - || format!("Invalid channel delay: {delay}") - )?; + validate_range(delay, delay_min..=delay_max, || { + format!("Invalid channel delay: {delay}") + })?; let raw = *protocol_constants::DELAY_RAW_RANGE.start() as f32 + ((delay - delay_min) / (delay_max - delay_min) * delay_raw_steps()).round(); @@ -852,37 +827,49 @@ pub fn raw_to_delay(value: u8, unit: types::DelayUnit) -> Result Result<(u8, u8), MapperError> { +pub fn copy_channel_to_raw( + source: types::Channel, + destination: types::Channel, +) -> Result<(u8, u8), MapperError> { if source == destination { - return Err(ValidationError::Value("Source channel and destination channel can't be the same".to_string()).into()) + return Err(ValidationError::Value( + "Source channel and destination channel can't be the same".to_string(), + ) + .into()); } match (&source, &destination) { (types::Channel::Input(_), types::Channel::Output(_)) | (types::Channel::Output(_), types::Channel::Input(_)) => { return Err(ValidationError::Value( - "Channels need to be both inputs or outputs".to_string()).into(), - ); + "Channels need to be both inputs or outputs".to_string(), + ) + .into()); } _ => {} } - Ok((channel_to_raw_value(source), channel_to_raw_value(destination))) + Ok(( + channel_to_raw_value(source), + channel_to_raw_value(destination), + )) } #[cfg(test)] mod tests { use super::*; - + // ------------------------------------------------------------------ // CHANNEL // ------------------------------------------------------------------ - + #[test] fn channel_round_trip_all_inputs() { let channels = [ @@ -897,7 +884,7 @@ mod tests { assert_eq!(decoded, types::Channel::Input(ch)); } } - + #[test] fn channel_round_trip_all_outputs() { let channels = [ @@ -916,19 +903,31 @@ mod tests { assert_eq!(decoded, types::Channel::Output(ch)); } } - + #[test] fn channel_specific_raw_values() { - assert_eq!(channel_to_raw(types::Channel::Input(types::InputChannel::InA)).unwrap(), 0x00); - assert_eq!(channel_to_raw(types::Channel::Input(types::InputChannel::InD)).unwrap(), 0x03); - assert_eq!(channel_to_raw(types::Channel::Output(types::OutputChannel::Out1)).unwrap(), 0x04); - assert_eq!(channel_to_raw(types::Channel::Output(types::OutputChannel::Out8)).unwrap(), 0x0B); + assert_eq!( + channel_to_raw(types::Channel::Input(types::InputChannel::InA)).unwrap(), + 0x00 + ); + assert_eq!( + channel_to_raw(types::Channel::Input(types::InputChannel::InD)).unwrap(), + 0x03 + ); + assert_eq!( + channel_to_raw(types::Channel::Output(types::OutputChannel::Out1)).unwrap(), + 0x04 + ); + assert_eq!( + channel_to_raw(types::Channel::Output(types::OutputChannel::Out8)).unwrap(), + 0x0B + ); } - + // ------------------------------------------------------------------ // NAME // ------------------------------------------------------------------ - + #[test] fn channel_name_round_trip() { let name = "In ABCDE"; @@ -937,17 +936,17 @@ mod tests { let decoded = raw_to_channel_name(&raw).unwrap(); assert_eq!(decoded, name); } - + #[test] fn channel_name_padding_is_applied() { let raw = channel_name_to_raw(" Kick ").unwrap(); assert_eq!(raw.len(), protocol_constants::CHANNEL_NAME_LENGTH); } - + // ------------------------------------------------------------------ // ATTACK / RELEASE / HOLD (simple offset-by-one mappings) // ------------------------------------------------------------------ - + #[test] fn attack_ms_mapping() { assert_eq!(attack_ms_to_raw(1).unwrap(), 0); @@ -955,7 +954,7 @@ mod tests { assert_eq!(raw_to_attack_ms(0).unwrap(), 1); assert_eq!(raw_to_attack_ms(998).unwrap(), 999); } - + #[test] fn attack_ms_round_trip() { for ms in [1u16, 50, 500, 999] { @@ -963,7 +962,7 @@ mod tests { assert_eq!(raw_to_attack_ms(raw).unwrap(), ms); } } - + #[test] fn release_ms_mapping() { assert_eq!(release_ms_to_raw(10).unwrap(), 9); @@ -971,7 +970,7 @@ mod tests { assert_eq!(raw_to_release_ms(9).unwrap(), 10); assert_eq!(raw_to_release_ms(2999).unwrap(), 3000); } - + #[test] fn release_ms_round_trip() { for ms in [10u16, 100, 1500, 3000] { @@ -979,7 +978,7 @@ mod tests { assert_eq!(raw_to_release_ms(raw).unwrap(), ms); } } - + #[test] fn hold_ms_mapping() { assert_eq!(hold_ms_to_raw(10).unwrap(), 9); @@ -987,7 +986,7 @@ mod tests { assert_eq!(raw_to_hold_ms(9).unwrap(), 10); assert_eq!(raw_to_hold_ms(998).unwrap(), 999); } - + #[test] fn hold_ms_round_trip() { for ms in [10u16, 250, 999] { @@ -995,17 +994,17 @@ mod tests { assert_eq!(raw_to_hold_ms(raw).unwrap(), ms); } } - + // ------------------------------------------------------------------ // GATE THRESHOLD // ------------------------------------------------------------------ - + #[test] fn gate_threshold_bounds() { assert_eq!(gate_threshold_db_to_raw(-90.0).unwrap(), 0); assert_eq!(gate_threshold_db_to_raw(0.0).unwrap(), 180); // (0 - -90) * 2 } - + #[test] fn gate_threshold_round_trip() { for db in [-90.0f32, -45.5, -20.25, 0.0] { @@ -1014,11 +1013,11 @@ mod tests { assert!((decoded - (db * 2.0).round() / 2.0).abs() < 1e-4); } } - + // ------------------------------------------------------------------ // EQ GAIN // ------------------------------------------------------------------ - + #[test] fn eq_gain_round_trip_endpoints() { for db in [-12.0f32, 0.0, 12.0] { @@ -1027,7 +1026,7 @@ mod tests { assert!((decoded - db).abs() < 1e-2); } } - + #[test] fn eq_gain_round_trip_arbitrary() { for db in [-7.3f32, 3.9, 11.99] { @@ -1037,41 +1036,52 @@ mod tests { assert!((decoded - db).abs() <= eq_gain_step_db() + 1e-4); } } - + // ------------------------------------------------------------------ // PEQ BAND // ------------------------------------------------------------------ - + #[test] fn peq_band_output_all_bands() { let bands = [ - types::PEQBand::B1, types::PEQBand::B2, types::PEQBand::B3, - types::PEQBand::B4, types::PEQBand::B5, types::PEQBand::B6, - types::PEQBand::B7, types::PEQBand::B8, types::PEQBand::B9, + types::PEQBand::B1, + types::PEQBand::B2, + types::PEQBand::B3, + types::PEQBand::B4, + types::PEQBand::B5, + types::PEQBand::B6, + types::PEQBand::B7, + types::PEQBand::B8, + types::PEQBand::B9, ]; let out_channel = types::Channel::Output(types::OutputChannel::Out1); for (i, band) in bands.into_iter().enumerate() { assert_eq!(peq_band_to_raw(band, out_channel).unwrap(), i as u8); } } - + #[test] fn peq_band_input_allowed_bands() { let bands = [ - types::PEQBand::B1, types::PEQBand::B2, types::PEQBand::B3, - types::PEQBand::B4, types::PEQBand::B5, types::PEQBand::B6, - types::PEQBand::B7, types::PEQBand::B8, + types::PEQBand::B1, + types::PEQBand::B2, + types::PEQBand::B3, + types::PEQBand::B4, + types::PEQBand::B5, + types::PEQBand::B6, + types::PEQBand::B7, + types::PEQBand::B8, ]; let in_channel = types::Channel::Input(types::InputChannel::InA); for (i, band) in bands.into_iter().enumerate() { assert_eq!(peq_band_to_raw(band, in_channel).unwrap(), i as u8); } } - + // ------------------------------------------------------------------ // GAIN (channel gain) // ------------------------------------------------------------------ - + #[test] fn gain_round_trip_low_range() { for db in [-60.0f32, -40.0, -20.5] { @@ -1080,7 +1090,7 @@ mod tests { assert!((decoded - db).abs() < 1e-3); } } - + #[test] fn gain_round_trip_high_range() { for db in [-19.9f32, 0.0, 12.0] { @@ -1089,7 +1099,7 @@ mod tests { assert!((decoded - db).abs() < 1e-3); } } - + #[test] fn gain_split_boundary_is_low_step() { let below = gain_db_to_raw(-20.5).unwrap(); @@ -1097,11 +1107,11 @@ mod tests { assert_eq!(raw_to_gain(below).unwrap(), -20.5); assert!((raw_to_gain(above).unwrap() - (-19.9)).abs() < 1e-3); } - + // ------------------------------------------------------------------ // CONTIGUOUS FREQUENCY // ------------------------------------------------------------------ - + #[test] fn frequency_round_trip_endpoints() { for hz in [19.7f32, 20160.0] { @@ -1111,7 +1121,7 @@ mod tests { assert!((decoded - hz).abs() / hz < 0.01); } } - + #[test] fn frequency_round_trip_mid() { let hz = 1000.0f32; @@ -1119,29 +1129,44 @@ mod tests { let decoded = raw_to_frequency_hz(raw).unwrap(); assert!((decoded - hz).abs() / hz < 0.02); } - + // ------------------------------------------------------------------ // DISCRETE FREQUENCY // ------------------------------------------------------------------ - + #[test] fn discrete_frequency_round_trip_all() { let freqs = [ - types::DiscreteFrequency::F20, types::DiscreteFrequency::F25, - types::DiscreteFrequency::F31_5, types::DiscreteFrequency::F40, - types::DiscreteFrequency::F50, types::DiscreteFrequency::F63, - types::DiscreteFrequency::F80, types::DiscreteFrequency::F100, - types::DiscreteFrequency::F125, types::DiscreteFrequency::F160, - types::DiscreteFrequency::F200, types::DiscreteFrequency::F250, - types::DiscreteFrequency::F315, types::DiscreteFrequency::F400, - types::DiscreteFrequency::F500, types::DiscreteFrequency::F630, - types::DiscreteFrequency::F800, types::DiscreteFrequency::F1000, - types::DiscreteFrequency::F1250, types::DiscreteFrequency::F1600, - types::DiscreteFrequency::F2000, types::DiscreteFrequency::F2500, - types::DiscreteFrequency::F3150, types::DiscreteFrequency::F4000, - types::DiscreteFrequency::F5000, types::DiscreteFrequency::F6300, - types::DiscreteFrequency::F8000, types::DiscreteFrequency::F10000, - types::DiscreteFrequency::F12500, types::DiscreteFrequency::F16000, + types::DiscreteFrequency::F20, + types::DiscreteFrequency::F25, + types::DiscreteFrequency::F31_5, + types::DiscreteFrequency::F40, + types::DiscreteFrequency::F50, + types::DiscreteFrequency::F63, + types::DiscreteFrequency::F80, + types::DiscreteFrequency::F100, + types::DiscreteFrequency::F125, + types::DiscreteFrequency::F160, + types::DiscreteFrequency::F200, + types::DiscreteFrequency::F250, + types::DiscreteFrequency::F315, + types::DiscreteFrequency::F400, + types::DiscreteFrequency::F500, + types::DiscreteFrequency::F630, + types::DiscreteFrequency::F800, + types::DiscreteFrequency::F1000, + types::DiscreteFrequency::F1250, + types::DiscreteFrequency::F1600, + types::DiscreteFrequency::F2000, + types::DiscreteFrequency::F2500, + types::DiscreteFrequency::F3150, + types::DiscreteFrequency::F4000, + types::DiscreteFrequency::F5000, + types::DiscreteFrequency::F6300, + types::DiscreteFrequency::F8000, + types::DiscreteFrequency::F10000, + types::DiscreteFrequency::F12500, + types::DiscreteFrequency::F16000, types::DiscreteFrequency::F20000, ]; for (i, f) in freqs.into_iter().enumerate() { @@ -1150,24 +1175,34 @@ mod tests { assert_eq!(raw_to_frequency_value(raw).unwrap(), f); } } - + // ------------------------------------------------------------------ // CROSSOVER FILTER // ------------------------------------------------------------------ - + #[test] fn crossover_filter_round_trip_all() { let filters = [ - types::CrossoverFilter::Bypass, types::CrossoverFilter::Bw6, - types::CrossoverFilter::Bl6, types::CrossoverFilter::Bw12, - types::CrossoverFilter::Bl12, types::CrossoverFilter::Lk12, - types::CrossoverFilter::Bw18, types::CrossoverFilter::Bl18, - types::CrossoverFilter::Bw24, types::CrossoverFilter::Bl24, - types::CrossoverFilter::Lk24, types::CrossoverFilter::Bw30, - types::CrossoverFilter::Bl30, types::CrossoverFilter::Bw36, - types::CrossoverFilter::Bl36, types::CrossoverFilter::Lk36, - types::CrossoverFilter::Bw42, types::CrossoverFilter::Bl42, - types::CrossoverFilter::Bw48, types::CrossoverFilter::Bl48, + types::CrossoverFilter::Bypass, + types::CrossoverFilter::Bw6, + types::CrossoverFilter::Bl6, + types::CrossoverFilter::Bw12, + types::CrossoverFilter::Bl12, + types::CrossoverFilter::Lk12, + types::CrossoverFilter::Bw18, + types::CrossoverFilter::Bl18, + types::CrossoverFilter::Bw24, + types::CrossoverFilter::Bl24, + types::CrossoverFilter::Lk24, + types::CrossoverFilter::Bw30, + types::CrossoverFilter::Bl30, + types::CrossoverFilter::Bw36, + types::CrossoverFilter::Bl36, + types::CrossoverFilter::Lk36, + types::CrossoverFilter::Bw42, + types::CrossoverFilter::Bl42, + types::CrossoverFilter::Bw48, + types::CrossoverFilter::Bl48, types::CrossoverFilter::Lk48, ]; for (i, f) in filters.into_iter().enumerate() { @@ -1176,11 +1211,11 @@ mod tests { assert_eq!(raw_to_crossover_filter(raw).unwrap(), f); } } - + // ------------------------------------------------------------------ // PEQ Q // ------------------------------------------------------------------ - + #[test] fn peq_q_round_trip_peak_filter() { for q in [0.40f32, 1.0, 10.0, 128.0] { @@ -1190,7 +1225,7 @@ mod tests { assert!((decoded - q).abs() / q < 0.05); } } - + #[test] fn peq_q_round_trip_shelf_filter() { for q in [0.40f32, 1.5, 3.0] { @@ -1199,18 +1234,22 @@ mod tests { assert!((decoded - q).abs() / q < 0.05); } } - + // ------------------------------------------------------------------ // PEQ FILTER // ------------------------------------------------------------------ - + #[test] fn peq_filter_round_trip_all() { let filters = [ - types::PEQFilter::Peak, types::PEQFilter::LowShelf, - types::PEQFilter::HighShelf, types::PEQFilter::Lp6Db, - types::PEQFilter::Lp12Db, types::PEQFilter::Hp6Db, - types::PEQFilter::Hp12Db, types::PEQFilter::AllPass1, + types::PEQFilter::Peak, + types::PEQFilter::LowShelf, + types::PEQFilter::HighShelf, + types::PEQFilter::Lp6Db, + types::PEQFilter::Lp12Db, + types::PEQFilter::Hp6Db, + types::PEQFilter::Hp12Db, + types::PEQFilter::AllPass1, types::PEQFilter::AllPass2, ]; for (i, f) in filters.into_iter().enumerate() { @@ -1219,19 +1258,29 @@ mod tests { assert_eq!(raw_to_peq_filter(raw).unwrap(), f); } } - + // ------------------------------------------------------------------ // RATIO // ------------------------------------------------------------------ - + #[test] fn ratio_round_trip_all() { let ratios = [ - types::Ratio::Ratio1_1, types::Ratio::Ratio1_1_1, types::Ratio::Ratio1_1_3, - types::Ratio::Ratio1_1_5, types::Ratio::Ratio1_1_7, types::Ratio::Ratio1_2, - types::Ratio::Ratio1_2_5, types::Ratio::Ratio1_3, types::Ratio::Ratio1_3_5, - types::Ratio::Ratio1_4, types::Ratio::Ratio1_5, types::Ratio::Ratio1_6, - types::Ratio::Ratio1_8, types::Ratio::Ratio1_10, types::Ratio::Ratio1_20, + types::Ratio::Ratio1_1, + types::Ratio::Ratio1_1_1, + types::Ratio::Ratio1_1_3, + types::Ratio::Ratio1_1_5, + types::Ratio::Ratio1_1_7, + types::Ratio::Ratio1_2, + types::Ratio::Ratio1_2_5, + types::Ratio::Ratio1_3, + types::Ratio::Ratio1_3_5, + types::Ratio::Ratio1_4, + types::Ratio::Ratio1_5, + types::Ratio::Ratio1_6, + types::Ratio::Ratio1_8, + types::Ratio::Ratio1_10, + types::Ratio::Ratio1_20, types::Ratio::Limit, ]; for (i, r) in ratios.into_iter().enumerate() { @@ -1240,11 +1289,11 @@ mod tests { assert_eq!(raw_to_ratio(raw).unwrap(), r); } } - + // ------------------------------------------------------------------ // KNEE // ------------------------------------------------------------------ - + #[test] fn knee_is_identity_mapping() { for db in [0u16, 6, 12] { @@ -1253,11 +1302,11 @@ mod tests { assert_eq!(raw_to_knee_db(raw).unwrap(), db); } } - + // ------------------------------------------------------------------ // THRESHOLD // ------------------------------------------------------------------ - + #[test] fn threshold_round_trip() { for db in [-90.0f32, -35.5, 0.0, 20.0] { @@ -1266,11 +1315,11 @@ mod tests { assert!((decoded - (db * 2.0).round() / 2.0).abs() < 1e-4); } } - + // ------------------------------------------------------------------ // LINK // ------------------------------------------------------------------ - + #[test] fn link_input_channels() { let source = types::Channel::Input(types::InputChannel::InA); @@ -1280,12 +1329,12 @@ mod tests { ]; let mask = link_channels_to_raw(source, &destinations).unwrap(); assert_eq!(mask, 0b0000_0101); - + let source_raw = channel_to_raw(source).unwrap(); let decoded = raw_to_link_channels(source_raw, mask).unwrap(); assert_eq!(decoded, destinations); } - + #[test] fn link_output_channels() { let source = types::Channel::Output(types::OutputChannel::Out2); @@ -1296,16 +1345,16 @@ mod tests { ]; let mask = link_channels_to_raw(source, &destinations).unwrap(); assert_eq!(mask, (1 << 1) | (1 << 4) | (1 << 7)); - + let source_raw = channel_to_raw(source).unwrap(); let decoded = raw_to_link_channels(source_raw, mask).unwrap(); assert_eq!(decoded, destinations); } - + // ------------------------------------------------------------------ // MATRIX GAIN // ------------------------------------------------------------------ - + #[test] fn matrix_gain_round_trip() { for db in [-60.0f32, -30.25, -19.9, 0.0] { @@ -1314,11 +1363,11 @@ mod tests { assert!((decoded - db).abs() < 0.6); } } - + // ------------------------------------------------------------------ // MATRIX // ------------------------------------------------------------------ - + #[test] fn matrix_round_trip_all_inputs() { let all = vec![ @@ -1334,7 +1383,7 @@ mod tests { expected.sort_by_key(|c| format!("{:?}", c)); assert_eq!(decoded, expected); } - + #[test] fn matrix_round_trip_subset() { let subset = vec![types::InputChannel::InB, types::InputChannel::InD]; @@ -1344,18 +1393,18 @@ mod tests { assert!(decoded.contains(&types::InputChannel::InB)); assert!(decoded.contains(&types::InputChannel::InD)); } - + #[test] fn matrix_empty() { let raw = matrix_to_raw(&[]).unwrap(); assert_eq!(raw, 0); assert!(raw_to_matrix(raw).unwrap().is_empty()); } - + // ------------------------------------------------------------------ // DELAY // ------------------------------------------------------------------ - + #[test] fn delay_round_trip_milliseconds() { for ms in [0.0f32, 340.0, 680.0] { @@ -1364,7 +1413,7 @@ mod tests { assert!((decoded - ms).abs() < 5.0); // quantized to 8-bit resolution } } - + #[test] fn delay_round_trip_meters() { for m in [0.0f32, 100.0, 233.58] { @@ -1373,7 +1422,7 @@ mod tests { assert!((decoded - m).abs() < 2.0); } } - + #[test] fn delay_round_trip_feet() { for ft in [0.0f32, 400.0, 766.329] { @@ -1382,11 +1431,11 @@ mod tests { assert!((decoded - ft).abs() < 5.0); } } - + // ------------------------------------------------------------------ // COPY CHANNEL // ------------------------------------------------------------------ - + #[test] fn copy_channel_inputs() { let source = types::Channel::Input(types::InputChannel::InA); @@ -1395,7 +1444,7 @@ mod tests { assert_eq!(raw_source, 0x00); assert_eq!(raw_dest, 0x02); } - + #[test] fn copy_channel_outputs() { let source = types::Channel::Output(types::OutputChannel::Out1); @@ -1404,4 +1453,4 @@ mod tests { assert_eq!(raw_source, 0x04); assert_eq!(raw_dest, 0x0B); } -} \ No newline at end of file +} diff --git a/src/dsp408/mapper/constants.rs b/src/dsp408/mapper/constants.rs index db6878b..8979d33 100644 --- a/src/dsp408/mapper/constants.rs +++ b/src/dsp408/mapper/constants.rs @@ -10,26 +10,20 @@ pub const RELEASE_MS_RANGE: RangeInclusive = 10..=3000; pub const KNEE_DB_RANGE: RangeInclusive = 0..=12; pub const THRESHOLD_DB_RANGE: RangeInclusive = -90.0..=20.0; -pub const FREQUENCY_HZ_RANGE: RangeInclusive = 19.7..=20160.0; +pub const FREQUENCY_HZ_RANGE: RangeInclusive = 19.7..=20160.0; pub const EQ_GAIN_DB_RANGE: RangeInclusive = -12.0..=12.0; pub const PEQ_Q_RANGE: RangeInclusive = 0.40..=128.0; pub fn peq_q_range(filter: PEQFilter) -> RangeInclusive { match filter { - PEQFilter::Peak - | PEQFilter::AllPass1 - | PEQFilter::AllPass2 => { - 0.40..=128.0 - } + PEQFilter::Peak | PEQFilter::AllPass1 | PEQFilter::AllPass2 => 0.40..=128.0, PEQFilter::LowShelf | PEQFilter::HighShelf | PEQFilter::Lp6Db | PEQFilter::Lp12Db | PEQFilter::Hp6Db - | PEQFilter::Hp12Db => { - 0.40..=3.0 - } + | PEQFilter::Hp12Db => 0.40..=3.0, } } @@ -41,8 +35,8 @@ pub const GAIN_HIGH_STEP_DB: f32 = 0.1; pub fn delay_range(unit: DelayUnit) -> (f32, f32) { match unit { DelayUnit::Millisecond => (0.000, 680.000), - DelayUnit::Meter => (0.000, 233.580), - DelayUnit::Feet => (0.000, 766.329), + DelayUnit::Meter => (0.000, 233.580), + DelayUnit::Feet => (0.000, 766.329), } } diff --git a/src/dsp408/mapper/encoding.rs b/src/dsp408/mapper/encoding.rs index f705e49..6d661e6 100644 --- a/src/dsp408/mapper/encoding.rs +++ b/src/dsp408/mapper/encoding.rs @@ -1,17 +1,19 @@ -use crate::common::errors::{ - DecodingError, - EncodingError, -}; +use crate::common::errors::{DecodingError, EncodingError}; // ------ STRING ------ pub fn encode_ascii(value: &str, length: usize, padding: u8) -> Result, EncodingError> { if length == 0 { - return Err(EncodingError::new(format!("Invalid string length: {}", length))); + return Err(EncodingError::new(format!( + "Invalid string length: {}", + length + ))); } if !value.is_ascii() { - return Err(EncodingError::new("String must contain ASCII characters only")); + return Err(EncodingError::new( + "String must contain ASCII characters only", + )); } let raw = value.as_bytes(); @@ -38,7 +40,9 @@ pub fn decode_ascii(raw: &[u8], strip: bool) -> Result { let result = String::from_utf8(raw.to_vec()).expect("raw is ASCII, so always valid UTF-8"); Ok(if strip { - result.trim_end_matches(['\u{0020}', '\u{0000}']).to_string() + result + .trim_end_matches(['\u{0020}', '\u{0000}']) + .to_string() } else { result }) @@ -65,15 +69,10 @@ pub fn decode_float16(lo: u8, hi: u8) -> Result { return Ok(f32::NAN); } } else { - (1.0 + mantissa as f32 / 1024.0) - * 2f32.powi(exponent as i32 - 15) + (1.0 + mantissa as f32 / 1024.0) * 2f32.powi(exponent as i32 - 15) }; - if sign == 1 { - Ok(-result) - } else { - Ok(result) - } + if sign == 1 { Ok(-result) } else { Ok(result) } } #[cfg(test)] @@ -92,10 +91,7 @@ mod tests { fn test_encode_ascii_pads_short_string() { let result = encode_ascii("hi", 5, b'\0'); - assert_eq!( - result.unwrap(), - vec![b'h', b'i', 0, 0, 0] - ); + assert_eq!(result.unwrap(), vec![b'h', b'i', 0, 0, 0]); } #[test] @@ -103,10 +99,7 @@ mod tests { let result = encode_ascii("hello", 0, b' '); assert!(result.is_err()); - assert_eq!( - result.unwrap_err().to_string(), - "Invalid string length: 0" - ); + assert_eq!(result.unwrap_err().to_string(), "Invalid string length: 0"); } #[test] @@ -165,13 +158,9 @@ mod tests { let result = decode_ascii(&raw, false); assert!(result.is_err()); - assert_eq!( - result.unwrap_err().to_string(), - "Invalid ASCII data" - ); + assert_eq!(result.unwrap_err().to_string(), "Invalid ASCII data"); } - // ------ FLOAT TESTS ------ #[test] @@ -256,4 +245,4 @@ mod tests { assert_eq!(result.unwrap(), 65504.0); } -} \ No newline at end of file +} diff --git a/src/dsp408/mapper/global.rs b/src/dsp408/mapper/global.rs index 38224e1..9531031 100644 --- a/src/dsp408/mapper/global.rs +++ b/src/dsp408/mapper/global.rs @@ -1,25 +1,15 @@ use crate::{ common::{ errors::{DecodingError, MapperError}, - validator::{ - validate_ascii_padded, - validate_range, - }, + validator::{validate_ascii_padded, validate_range}, }, dsp408::{ - protocol::{ - constants as protocol_constants, - validators, - }, + protocol::{constants as protocol_constants, validators}, types, }, }; -use super::{ - constants, - decode_ascii, - encode_ascii, -}; +use super::{constants, decode_ascii, encode_ascii}; // ------ DELAY ------ @@ -40,55 +30,43 @@ fn raw_to_delay_unit_value(value: u8) -> Option { } } -pub fn delay_unit_to_raw( - unit: types::DelayUnit, -) -> Result { +pub fn delay_unit_to_raw(unit: types::DelayUnit) -> Result { Ok(delay_unit_to_raw_value(unit)) } -pub fn raw_to_delay_unit( - value: u8, -) -> Result { +pub fn raw_to_delay_unit(value: u8) -> Result { validators::validate_raw_delay_unit(value)?; - raw_to_delay_unit_value(value) - .ok_or_else(|| { - MapperError::Decoding( - DecodingError::new( - format!("Unknown delay unit value: {:#04x}", value), - ), - ) - }) + raw_to_delay_unit_value(value).ok_or_else(|| { + MapperError::Decoding(DecodingError::new(format!( + "Unknown delay unit value: {:#04x}", + value + ))) + }) } // ------ PRESET INDEX ------ -pub fn preset_index_to_raw(index: usize) -> Result { - validate_range( - index, - 0..=constants::PRESET_INDEX_MAX, - || format!("Invalid preset index {}", index) - )?; +pub fn preset_index_to_raw(index: usize) -> Result { + validate_range(index, 0..=constants::PRESET_INDEX_MAX, || { + format!("Invalid preset index {}", index) + })?; Ok(index as u8) } -pub fn preset_index_without_factory_to_raw(index: usize) -> Result { - validate_range( - index, - 1..=constants::PRESET_INDEX_MAX, - || format!("Invalid preset index {}", index) - )?; +pub fn preset_index_without_factory_to_raw(index: usize) -> Result { + validate_range(index, 1..=constants::PRESET_INDEX_MAX, || { + format!("Invalid preset index {}", index) + })?; Ok(index as u8 - 1) } // ------ CONFIG CHUNK ------ pub fn config_chunk_to_raw(index: usize) -> Result { - validate_range( - index, - 0..=constants::CONFIG_CHUNK_INDEX_MAX, - || format!("Invalid config index: {:#04x}", index) - )?; + validate_range(index, 0..=constants::CONFIG_CHUNK_INDEX_MAX, || { + format!("Invalid config index: {:#04x}", index) + })?; Ok(index as u8) } @@ -99,10 +77,14 @@ pub fn preset_name_to_raw(name: &str) -> Result, MapperError> { name.as_bytes(), protocol_constants::PRESET_NAME_LENGTH, protocol_constants::PRESET_NAME_PADDING, - "Preset name" + "Preset name", )?; - Ok(encode_ascii(name, protocol_constants::PRESET_NAME_LENGTH, protocol_constants::PRESET_NAME_PADDING)?) + Ok(encode_ascii( + name, + protocol_constants::PRESET_NAME_LENGTH, + protocol_constants::PRESET_NAME_PADDING, + )?) } pub fn raw_to_preset_name(raw_name: &[u8]) -> Result { @@ -115,10 +97,12 @@ pub fn raw_to_preset_name(raw_name: &[u8]) -> Result { fn input_source_to_raw_value(source: types::InputType) -> u8 { match source { - types::InputType::Analog => *protocol_constants::INPUT_SOURCE_TYPE_RAW_RANGE.start(), - types::InputType::PinkNoise => *protocol_constants::INPUT_SOURCE_TYPE_RAW_RANGE.start() + 1, - types::InputType::WhiteNoise => *protocol_constants::INPUT_SOURCE_TYPE_RAW_RANGE.start() + 2, - types::InputType::SineWave => *protocol_constants::INPUT_SOURCE_TYPE_RAW_RANGE.start() + 3, + types::InputType::Analog => *protocol_constants::INPUT_SOURCE_TYPE_RAW_RANGE.start(), + types::InputType::PinkNoise => *protocol_constants::INPUT_SOURCE_TYPE_RAW_RANGE.start() + 1, + types::InputType::WhiteNoise => { + *protocol_constants::INPUT_SOURCE_TYPE_RAW_RANGE.start() + 2 + } + types::InputType::SineWave => *protocol_constants::INPUT_SOURCE_TYPE_RAW_RANGE.start() + 3, } } @@ -138,15 +122,13 @@ pub fn input_source_to_raw(source: types::InputType) -> Result pub fn raw_to_input_source(value: u8) -> Result { validators::validate_raw_input_source(value)?; - - raw_to_input_source_value(value) - .ok_or_else(|| { - MapperError::Decoding( - DecodingError::new( - format!("Unknown input value: {:#04x}", value) - ) - ) - }) + + raw_to_input_source_value(value).ok_or_else(|| { + MapperError::Decoding(DecodingError::new(format!( + "Unknown input value: {:#04x}", + value + ))) + }) } // ------ PASSWORD ------ @@ -156,10 +138,14 @@ pub fn password_to_raw(password: &str) -> Result, MapperError> { password.as_bytes(), protocol_constants::PASSWORD_LENGTH, protocol_constants::PASSWORD_PADDING, - "Password" + "Password", )?; - Ok(encode_ascii(password, protocol_constants::PASSWORD_LENGTH, protocol_constants::PASSWORD_PADDING)?) + Ok(encode_ascii( + password, + protocol_constants::PASSWORD_LENGTH, + protocol_constants::PASSWORD_PADDING, + )?) } #[cfg(test)] @@ -237,10 +223,7 @@ mod tests { let raw = preset_name_to_raw(name).unwrap(); - assert_eq!( - raw_to_preset_name(&raw).unwrap(), - "DSP408", - ); + assert_eq!(raw_to_preset_name(&raw).unwrap(), "DSP408",); } #[test] @@ -282,4 +265,4 @@ mod tests { assert!(password_to_raw("123").is_err()); assert!(password_to_raw("12345").is_err()); } -} \ No newline at end of file +} diff --git a/src/dsp408/mapper/mod.rs b/src/dsp408/mapper/mod.rs index 9caed11..a42b562 100644 --- a/src/dsp408/mapper/mod.rs +++ b/src/dsp408/mapper/mod.rs @@ -1,9 +1,9 @@ mod channel; +pub(crate) mod constants; mod encoding; mod global; pub(crate) mod response; -pub(crate) mod constants; pub use channel::*; pub use encoding::*; -pub use global::*; \ No newline at end of file +pub use global::*; diff --git a/src/dsp408/mapper/response.rs b/src/dsp408/mapper/response.rs index 32d855e..c3dae5f 100644 --- a/src/dsp408/mapper/response.rs +++ b/src/dsp408/mapper/response.rs @@ -2,28 +2,13 @@ use crate::{ common::errors::ProtocolError, dsp408::{ protocol::{ - constants::{ - METERS_HIGH_STEP, - METERS_LOW_STEP, - METERS_SPLIT, - METERS_SPLIT_LEVEL_DB, - }, + constants::{METERS_HIGH_STEP, METERS_LOW_STEP, METERS_SPLIT, METERS_SPLIT_LEVEL_DB}, frame::Frame, }, types::{ - Acknowledgement, - AuthenticationResult, - ConfigChunk, - CurrentPreset, - DeviceFlags, - DeviceInfo, - DeviceResponseType, - HandshakeAck, - Meters, - ModifiedPreset, - NotImplemented, - PresetName, - UnknownResponse, + Acknowledgement, AuthenticationResult, ConfigChunk, CurrentPreset, DeviceFlags, + DeviceInfo, DeviceResponseType, HandshakeAck, Meters, ModifiedPreset, NotImplemented, + PresetName, UnknownResponse, }, }, }; @@ -66,8 +51,7 @@ pub fn map_response(frame: &Frame) -> Result return Err(ProtocolError::new("Missing device name payload")); } - let name = decode_ascii(payload, false) - .map_err(|e| ProtocolError::new(e.0))?; + let name = decode_ascii(payload, false).map_err(|e| ProtocolError::new(e.0))?; return Ok(DeviceResponseType::DeviceInfo(DeviceInfo { name })); } @@ -131,8 +115,7 @@ pub fn map_response(frame: &Frame) -> Result return Err(ProtocolError::new("Missing preset index")); } - let name = decode_ascii(&payload[1..], false) - .map_err(|e| ProtocolError::new(e.0))?; + let name = decode_ascii(&payload[1..], false).map_err(|e| ProtocolError::new(e.0))?; return Ok(DeviceResponseType::PresetName(PresetName { index: payload[0], @@ -174,9 +157,11 @@ pub fn map_response(frame: &Frame) -> Result ))); } - return Ok(DeviceResponseType::AuthenticationResult(AuthenticationResult { - success: payload[1] == 0x01, - })); + return Ok(DeviceResponseType::AuthenticationResult( + AuthenticationResult { + success: payload[1] == 0x01, + }, + )); } // Command `0x40` (Get Level Meters) @@ -224,9 +209,7 @@ mod tests { assert_eq!( result, - DeviceResponseType::Acknowledgement(Acknowledgement { - success: true - }) + DeviceResponseType::Acknowledgement(Acknowledgement { success: true }) ); } @@ -234,10 +217,7 @@ mod tests { fn not_implemented() { let result = map_response(&frame(0x02, vec![])).unwrap(); - assert_eq!( - result, - DeviceResponseType::NotImplemented(NotImplemented) - ); + assert_eq!(result, DeviceResponseType::NotImplemented(NotImplemented)); } #[test] @@ -246,9 +226,7 @@ mod tests { assert_eq!( result, - DeviceResponseType::HandshakeAck(HandshakeAck { - ack: Some(1) - }) + DeviceResponseType::HandshakeAck(HandshakeAck { ack: Some(1) }) ); } @@ -261,8 +239,7 @@ mod tests { #[test] fn device_name() { - let result = map_response(&frame(0x13, b"TestDevice".to_vec())) - .unwrap(); + let result = map_response(&frame(0x13, b"TestDevice".to_vec())).unwrap(); assert_eq!( result, @@ -274,47 +251,34 @@ mod tests { #[test] fn device_name_missing_payload() { - assert!( - map_response(&frame(0x13, vec![])) - .is_err() - ); + assert!(map_response(&frame(0x13, vec![])).is_err()); } #[test] fn device_name_invalid_ascii() { - assert!( - map_response(&frame(0x13, vec![0xff])) - .is_err() - ); + assert!(map_response(&frame(0x13, vec![0xff])).is_err()); } #[test] fn current_preset() { - let result = map_response(&frame(0x14, vec![5])) - .unwrap(); + let result = map_response(&frame(0x14, vec![5])).unwrap(); assert_eq!( result, - DeviceResponseType::CurrentPreset(CurrentPreset { - index: 5 - }) + DeviceResponseType::CurrentPreset(CurrentPreset { index: 5 }) ); } #[test] fn current_preset_wrong_length_errors() { - assert!( - map_response(&frame(0x14, vec![1, 2])) - .is_err() - ); + assert!(map_response(&frame(0x14, vec![1, 2])).is_err()); } #[test] fn modified_preset() { let payload = vec![0xff; 20]; - let result = map_response(&frame(0x22, payload)) - .unwrap(); + let result = map_response(&frame(0x22, payload)).unwrap(); match result { DeviceResponseType::ModifiedPreset(p) => { @@ -327,19 +291,12 @@ mod tests { #[test] fn modified_preset_invalid_length() { - assert!( - map_response(&frame(0x22, vec![0; 19])) - .is_err() - ); + assert!(map_response(&frame(0x22, vec![0; 19])).is_err()); } #[test] fn config_chunk() { - let result = map_response(&frame( - 0x24, - vec![3, 0xaa, 0xbb], - )) - .unwrap(); + let result = map_response(&frame(0x24, vec![3, 0xaa, 0xbb])).unwrap(); assert_eq!( result, @@ -352,8 +309,7 @@ mod tests { #[test] fn config_chunk_empty_payload_defaults_to_zero() { - let result = map_response(&frame(0x24, vec![])) - .unwrap(); + let result = map_response(&frame(0x24, vec![])).unwrap(); assert_eq!( result, @@ -366,19 +322,12 @@ mod tests { #[test] fn config_chunk_invalid_index() { - assert!( - map_response(&frame(0x24, vec![0x1d])) - .is_err() - ); + assert!(map_response(&frame(0x24, vec![0x1d])).is_err()); } #[test] fn preset_name() { - let result = map_response(&frame( - 0x29, - vec![2, b'A', b'm', b'p'], - )) - .unwrap(); + let result = map_response(&frame(0x29, vec![2, b'A', b'm', b'p'])).unwrap(); assert_eq!( result, @@ -391,18 +340,12 @@ mod tests { #[test] fn preset_name_missing_index() { - assert!( - map_response(&frame(0x29, vec![])) - .is_err() - ); + assert!(map_response(&frame(0x29, vec![])).is_err()); } #[test] fn preset_name_invalid_ascii() { - assert!( - map_response(&frame(0x29, vec![1, 0xff])) - .is_err() - ); + assert!(map_response(&frame(0x29, vec![1, 0xff])).is_err()); } #[test] @@ -410,23 +353,17 @@ mod tests { let mut payload = vec![0; 6]; payload[5] = 1; - let result = map_response(&frame(0x2c, payload)) - .unwrap(); + let result = map_response(&frame(0x2c, payload)).unwrap(); assert_eq!( result, - DeviceResponseType::DeviceFlags(DeviceFlags { - is_locked: true - }) + DeviceResponseType::DeviceFlags(DeviceFlags { is_locked: true }) ); } #[test] fn device_flags_invalid_length() { - assert!( - map_response(&frame(0x2c, vec![0; 5])) - .is_err() - ); + assert!(map_response(&frame(0x2c, vec![0; 5])).is_err()); } #[test] @@ -434,52 +371,32 @@ mod tests { let mut payload = vec![0; 6]; payload[5] = 2; - assert!( - map_response(&frame(0x2c, payload)) - .is_err() - ); + assert!(map_response(&frame(0x2c, payload)).is_err()); } #[test] fn authentication_success() { - let result = map_response(&frame( - 0x2d, - vec![0, 1], - )) - .unwrap(); + let result = map_response(&frame(0x2d, vec![0, 1])).unwrap(); assert_eq!( result, - DeviceResponseType::AuthenticationResult( - AuthenticationResult { - success: true - } - ) + DeviceResponseType::AuthenticationResult(AuthenticationResult { success: true }) ); } #[test] fn authentication_missing_result() { - assert!( - map_response(&frame(0x2d, vec![0])) - .is_err() - ); + assert!(map_response(&frame(0x2d, vec![0])).is_err()); } #[test] fn authentication_invalid_flag() { - assert!( - map_response(&frame(0x2d, vec![0, 2])) - .is_err() - ); + assert!(map_response(&frame(0x2d, vec![0, 2])).is_err()); } #[test] fn meters_invalid_length() { - assert!( - map_response(&frame(0x40, vec![0; 10])) - .is_err() - ); + assert!(map_response(&frame(0x40, vec![0; 10])).is_err()); } #[test] @@ -494,8 +411,7 @@ mod tests { payload[i + 1] = 0x3c; } - let result = map_response(&frame(0x40, payload)) - .unwrap(); + let result = map_response(&frame(0x40, payload)).unwrap(); match result { DeviceResponseType::Meters(m) => { @@ -511,21 +427,14 @@ mod tests { #[test] fn unknown_command_falls_through() { - let result = map_response(&frame( - 0x99, - vec![0xaa], - )) - .unwrap(); + let result = map_response(&frame(0x99, vec![0xaa])).unwrap(); match result { DeviceResponseType::UnknownResponse(r) => { assert_eq!(r.cmd, "0x99"); assert_eq!(r.raw, vec![0xaa]); } - other => panic!( - "expected UnknownResponse, got {:?}", - other - ), + other => panic!("expected UnknownResponse, got {:?}", other), } } } diff --git a/src/dsp408/mod.rs b/src/dsp408/mod.rs index a4e200c..1c1f95f 100644 --- a/src/dsp408/mod.rs +++ b/src/dsp408/mod.rs @@ -1,7 +1,7 @@ -mod protocol; mod client; mod mapper; +mod protocol; pub mod types; -pub use client::DSP408; \ No newline at end of file +pub use client::DSP408; diff --git a/src/dsp408/protocol/commands.rs b/src/dsp408/protocol/commands.rs index 422a3bf..4eaa02f 100644 --- a/src/dsp408/protocol/commands.rs +++ b/src/dsp408/protocol/commands.rs @@ -1,15 +1,9 @@ use crate::common::errors::ValidationError; -use super::{ - frame::build_frame, - validators::*, -}; +use super::{frame::build_frame, validators::*}; fn split_u16(value: u16) -> [u8; 2] { - [ - (value & 0xff) as u8, - (value >> 8) as u8, - ] + [(value & 0xff) as u8, (value >> 8) as u8] } // Command 0x10 Start @@ -38,135 +32,81 @@ pub fn build_get_current_preset() -> Vec { } // Command 0x15 Delay Unit -pub fn build_set_delay_unit( - raw_unit: u8 -) -> Result, ValidationError> { +pub fn build_set_delay_unit(raw_unit: u8) -> Result, ValidationError> { validate_raw_delay_unit(raw_unit)?; - Ok(build_frame( - 0x15, - &[raw_unit] - )) + Ok(build_frame(0x15, &[raw_unit])) } // Command 0x20 Recall -pub fn build_recall( - raw_index:u8 -)->Result,ValidationError>{ - +pub fn build_recall(raw_index: u8) -> Result, ValidationError> { validate_raw_preset_index(raw_index)?; - Ok(build_frame( - 0x20, - &[raw_index] - )) + Ok(build_frame(0x20, &[raw_index])) } // Command 0x21 Store preset -pub fn build_store_current_configuration( - raw_index:u8 -)->Result,ValidationError>{ - +pub fn build_store_current_configuration(raw_index: u8) -> Result, ValidationError> { validate_raw_store_preset_index(raw_index)?; - Ok(build_frame( - 0x21, - &[raw_index] - )) + Ok(build_frame(0x21, &[raw_index])) } // Command 0x22 pub fn build_preset_modification_status() -> Vec { - build_frame(0x22,&[]) + build_frame(0x22, &[]) } // Command 0x23 pub fn build_factory_reset() -> Vec { - build_frame(0x23,&[]) + build_frame(0x23, &[]) } // Command 0x26 -pub fn build_store_current_preset_name( - raw_name:&[u8] -)->Result,ValidationError>{ - +pub fn build_store_current_preset_name(raw_name: &[u8]) -> Result, ValidationError> { validate_raw_preset_name(raw_name)?; - Ok(build_frame( - 0x26, - raw_name - )) + Ok(build_frame(0x26, raw_name)) } // Command 0x27 -pub fn build_config_chunk( - raw_index:u8 -)->Result,ValidationError>{ - +pub fn build_config_chunk(raw_index: u8) -> Result, ValidationError> { validate_raw_config_chunk_index(raw_index)?; - Ok(build_frame( - 0x27, - &[raw_index] - )) + Ok(build_frame(0x27, &[raw_index])) } // Command 0x29 -pub fn build_get_preset_name( - raw_index:u8 -)->Result,ValidationError>{ - +pub fn build_get_preset_name(raw_index: u8) -> Result, ValidationError> { validate_raw_get_preset_index(raw_index)?; - Ok(build_frame( - 0x29, - &[raw_index] - )) + Ok(build_frame(0x29, &[raw_index])) } // Command 0x2A -pub fn build_copy_channel( - source: u8, - destination: u8, -) -> Result, ValidationError> { - +pub fn build_copy_channel(source: u8, destination: u8) -> Result, ValidationError> { validate_raw_copy_channels(source, destination)?; - Ok(build_frame( - 0x2A, - &[source, destination], - )) + Ok(build_frame(0x2A, &[source, destination])) } // Command 0x2C pub fn build_get_device_flags() -> Vec { - build_frame(0x2c,&[]) + build_frame(0x2c, &[]) } // Command 0x2D -pub fn build_unlock_device( - password:&[u8] -)->Result,ValidationError>{ - +pub fn build_unlock_device(password: &[u8]) -> Result, ValidationError> { validate_raw_password(password)?; - Ok(build_frame( - 0x2d, - password - )) + Ok(build_frame(0x2d, password)) } // Command 0x2F -pub fn build_lock_device( - password:&[u8] -)->Result,ValidationError>{ - +pub fn build_lock_device(password: &[u8]) -> Result, ValidationError> { validate_raw_password(password)?; - Ok(build_frame( - 0x2f, - password - )) + Ok(build_frame(0x2f, password)) } // Command 0x30 (Set Compressor) @@ -178,7 +118,6 @@ pub fn build_set_compressor( raw_knee: u16, raw_threshold: u16, ) -> Result, ValidationError> { - validate_raw_output_channel(raw_channel)?; validate_raw_compressor_ratio(raw_ratio)?; validate_raw_attack(raw_attack)?; @@ -216,7 +155,6 @@ pub fn build_low_pass( raw_freq: u16, raw_filter_type: u8, ) -> Result, ValidationError> { - validate_raw_channel(raw_channel)?; validate_raw_frequency(raw_freq)?; validate_raw_crossover_filter(raw_filter_type)?; @@ -225,12 +163,7 @@ pub fn build_low_pass( Ok(build_frame( 0x31, - &[ - raw_channel, - freq[0], - freq[1], - raw_filter_type, - ], + &[raw_channel, freq[0], freq[1], raw_filter_type], )) } @@ -240,7 +173,6 @@ pub fn build_high_pass( raw_freq: u16, raw_filter_type: u8, ) -> Result, ValidationError> { - validate_raw_channel(raw_channel)?; validate_raw_frequency(raw_freq)?; validate_raw_crossover_filter(raw_filter_type)?; @@ -249,12 +181,7 @@ pub fn build_high_pass( Ok(build_frame( 0x32, - &[ - raw_channel, - freq[0], - freq[1], - raw_filter_type, - ], + &[raw_channel, freq[0], freq[1], raw_filter_type], )) } @@ -268,7 +195,6 @@ pub fn build_peq_band( raw_filter_type: u8, bypass: u8, ) -> Result, ValidationError> { - validate_raw_channel(raw_channel)?; validate_raw_peq_band(raw_channel, raw_band)?; validate_raw_eq_gain(raw_gain)?; @@ -297,115 +223,53 @@ pub fn build_peq_band( } // Command 0x34 (Set Gain) -pub fn build_gain( - channel: u8, - raw_gain: u16, -) -> Result, ValidationError> { - +pub fn build_gain(channel: u8, raw_gain: u16) -> Result, ValidationError> { validate_raw_channel(channel)?; validate_raw_gain(raw_gain)?; let gain = split_u16(raw_gain); - Ok(build_frame( - 0x34, - &[ - channel, - gain[0], - gain[1], - ], - )) + Ok(build_frame(0x34, &[channel, gain[0], gain[1]])) } // Command 0x35 (Set Mute) -pub fn build_mute( - channel:u8, - muted:u8, -)->Result,ValidationError>{ - +pub fn build_mute(channel: u8, muted: u8) -> Result, ValidationError> { validate_raw_channel(channel)?; validate_raw_bool(muted)?; - Ok(build_frame( - 0x35, - &[ - channel, - muted, - ] - )) + Ok(build_frame(0x35, &[channel, muted])) } // Command 0x36 (Invert Gain) -pub fn build_inverted_gain( - channel:u8, - inverted:u8, -)->Result,ValidationError>{ - +pub fn build_inverted_gain(channel: u8, inverted: u8) -> Result, ValidationError> { validate_raw_channel(channel)?; validate_raw_bool(inverted)?; - Ok(build_frame( - 0x36, - &[ - channel, - inverted, - ] - )) + Ok(build_frame(0x36, &[channel, inverted])) } // Command 0x38 (Set Delay) -pub fn build_set_delay( - channel:u8, - delay:u8, -)->Result,ValidationError>{ - +pub fn build_set_delay(channel: u8, delay: u8) -> Result, ValidationError> { validate_raw_channel(channel)?; validate_raw_channel_delay(delay)?; - Ok(build_frame( - 0x38, - &[ - channel, - 0x00, - delay - ] - )) + Ok(build_frame(0x38, &[channel, 0x00, delay])) } // Command 0x39 (Set Input Source) -pub fn build_set_input_source( - input_type: u8, - frequency: u8, -) -> Result, ValidationError> { - +pub fn build_set_input_source(input_type: u8, frequency: u8) -> Result, ValidationError> { validate_raw_input_source(input_type)?; validate_raw_discrete_frequency(frequency)?; - Ok(build_frame( - 0x39, - &[ - input_type, - frequency, - ], - )) + Ok(build_frame(0x39, &[input_type, frequency])) } // Command 0x3A (Matrix Routing) -pub fn build_matrix_routing( - output: u8, - input_bitmask: u8, -) -> Result, ValidationError> { - +pub fn build_matrix_routing(output: u8, input_bitmask: u8) -> Result, ValidationError> { validate_raw_output_channel(output)?; validate_raw_matrix_bitmask(input_bitmask)?; - Ok(build_frame( - 0x3A, - &[ - output, - input_bitmask, - ], - )) + Ok(build_frame(0x3A, &[output, input_bitmask])) } // Command 0x3B (Link Channel) @@ -413,52 +277,31 @@ pub fn build_link_channel( source_channel: u8, destination_channel_bitmask: u8, ) -> Result, ValidationError> { - validate_raw_link_channel(source_channel, destination_channel_bitmask)?; Ok(build_frame( 0x3B, - &[ - source_channel, - destination_channel_bitmask, - ], + &[source_channel, destination_channel_bitmask], )) } // Command 0x3C (Bypass EQ) -pub fn build_bypass_peq( - channel: u8, - bypass: u8, -) -> Result, ValidationError> { - +pub fn build_bypass_peq(channel: u8, bypass: u8) -> Result, ValidationError> { validate_raw_channel(channel)?; validate_raw_bool(bypass)?; - Ok(build_frame( - 0x3C, - &[ - channel, - bypass, - ], - )) + Ok(build_frame(0x3C, &[channel, bypass])) } // Command 0x3D (Store Channel Name) -pub fn build_store_channel_name( - channel: u8, - raw_name: &[u8], -) -> Result, ValidationError> { - +pub fn build_store_channel_name(channel: u8, raw_name: &[u8]) -> Result, ValidationError> { validate_raw_channel(channel)?; validate_raw_channel_name(raw_name)?; let mut payload = vec![channel]; payload.extend_from_slice(raw_name); - Ok(build_frame( - 0x3D, - &payload, - )) + Ok(build_frame(0x3D, &payload)) } // Command 0x3E (Set Gate Parameters) @@ -469,7 +312,6 @@ pub fn build_set_gate( raw_hold: u16, raw_release: u16, ) -> Result, ValidationError> { - validate_raw_input_channel(raw_channel)?; validate_raw_gate_threshold(raw_threshold)?; validate_raw_attack(raw_attack)?; @@ -504,7 +346,6 @@ pub fn build_set_limiter( raw_attack: u16, raw_release: u16, ) -> Result, ValidationError> { - validate_raw_output_channel(raw_channel)?; validate_raw_threshold(raw_threshold)?; validate_raw_attack(raw_attack)?; @@ -532,10 +373,7 @@ pub fn build_set_limiter( // Command 0x40 (Get Level Meters) pub fn build_get_meter_levels() -> Vec { - build_frame( - 0x40, - &[], - ) + build_frame(0x40, &[]) } // Command 0x41 (Set Matrix Gain) @@ -544,7 +382,6 @@ pub fn build_matrix_gain( raw_output_channel: u8, raw_gain: u16, ) -> Result, ValidationError> { - validate_raw_input_channel(raw_input_channel)?; validate_raw_output_channel(raw_output_channel)?; validate_raw_matrix_gain(raw_gain)?; @@ -553,12 +390,7 @@ pub fn build_matrix_gain( Ok(build_frame( 0x41, - &[ - raw_output_channel, - raw_input_channel, - gain[0], - gain[1], - ], + &[raw_output_channel, raw_input_channel, gain[0], gain[1]], )) } @@ -568,7 +400,6 @@ pub fn build_set_geq_band( raw_frequency_band: u8, raw_gain: u16, ) -> Result, ValidationError> { - validate_raw_input_channel(raw_channel)?; validate_raw_discrete_frequency(raw_frequency_band)?; validate_raw_eq_gain(raw_gain)?; @@ -577,43 +408,24 @@ pub fn build_set_geq_band( Ok(build_frame( 0x48, - &[ - raw_channel, - raw_frequency_band, - gain[0], - gain[1], - ], + &[raw_channel, raw_frequency_band, gain[0], gain[1]], )) } // Command 0x49 (Set GEQ Bypass) -pub fn build_set_geq_bypass( - raw_channel: u8, - bypass: u8, -) -> Result, ValidationError> { - +pub fn build_set_geq_bypass(raw_channel: u8, bypass: u8) -> Result, ValidationError> { validate_raw_input_channel(raw_channel)?; validate_raw_bool(bypass)?; - Ok(build_frame( - 0x49, - &[ - raw_channel, - bypass, - ], - )) + Ok(build_frame(0x49, &[raw_channel, bypass])) } #[cfg(test)] mod tests { - use super::*; use super::super::constants::*; + use super::*; - fn assert_frame( - frame: Vec, - expected_command: u8, - expected_payload: &[u8], - ) { + fn assert_frame(frame: Vec, expected_command: u8, expected_payload: &[u8]) { assert_eq!(frame[5], expected_command); assert_eq!(&frame[6..frame.len() - 3], expected_payload); } @@ -627,86 +439,34 @@ mod tests { #[test] fn test_simple_commands() { - assert_frame( - build_handshake(), - 0x10, - &[], - ); + assert_frame(build_handshake(), 0x10, &[]); - assert_frame( - build_disconnect(), - 0x11, - &[], - ); + assert_frame(build_disconnect(), 0x11, &[]); - assert_frame( - build_acknowledgement(), - 0x12, - &[], - ); + assert_frame(build_acknowledgement(), 0x12, &[]); - assert_frame( - build_request_device_name(), - 0x13, - &[], - ); + assert_frame(build_request_device_name(), 0x13, &[]); - assert_frame( - build_get_current_preset(), - 0x14, - &[], - ); + assert_frame(build_get_current_preset(), 0x14, &[]); - assert_frame( - build_preset_modification_status(), - 0x22, - &[], - ); + assert_frame(build_preset_modification_status(), 0x22, &[]); - assert_frame( - build_factory_reset(), - 0x23, - &[], - ); + assert_frame(build_factory_reset(), 0x23, &[]); - assert_frame( - build_get_device_flags(), - 0x2c, - &[], - ); + assert_frame(build_get_device_flags(), 0x2c, &[]); - assert_frame( - build_get_meter_levels(), - 0x40, - &[], - ); + assert_frame(build_get_meter_levels(), 0x40, &[]); } #[test] fn test_preset_commands() { - assert_frame( - build_recall(5).unwrap(), - 0x20, - &[5], - ); + assert_frame(build_recall(5).unwrap(), 0x20, &[5]); - assert_frame( - build_store_current_configuration(3).unwrap(), - 0x21, - &[3], - ); + assert_frame(build_store_current_configuration(3).unwrap(), 0x21, &[3]); - assert_frame( - build_get_preset_name(2).unwrap(), - 0x29, - &[2], - ); + assert_frame(build_get_preset_name(2).unwrap(), 0x29, &[2]); - assert_frame( - build_config_chunk(1).unwrap(), - 0x27, - &[1], - ); + assert_frame(build_config_chunk(1).unwrap(), 0x27, &[1]); assert_frame( build_store_current_preset_name(b"TEST ").unwrap(), @@ -717,57 +477,27 @@ mod tests { #[test] fn test_device_lock_commands() { - assert_frame( - build_unlock_device(b"1234").unwrap(), - 0x2d, - b"1234", - ); + assert_frame(build_unlock_device(b"1234").unwrap(), 0x2d, b"1234"); - assert_frame( - build_lock_device(b"1234").unwrap(), - 0x2f, - b"1234", - ); + assert_frame(build_lock_device(b"1234").unwrap(), 0x2f, b"1234"); } #[test] fn test_set_delay_unit() { - assert_frame( - build_set_delay_unit(1).unwrap(), - 0x15, - &[1], - ); + assert_frame(build_set_delay_unit(1).unwrap(), 0x15, &[1]); } #[test] fn test_copy_channel() { - assert_frame( - build_copy_channel(1, 3).unwrap(), - 0x2a, - &[1, 3], - ); + assert_frame(build_copy_channel(1, 3).unwrap(), 0x2a, &[1, 3]); } #[test] fn test_compressor_frame() { assert_frame( - build_set_compressor( - 5, - 1, - 300, - 400, - 2, - 11, - ).unwrap(), + build_set_compressor(5, 1, 300, 400, 2, 11).unwrap(), 0x30, - &[ - 5, - 1, 0, - 44, 1, - 144, 1, - 2, 0, - 11, 0, - ], + &[5, 1, 0, 44, 1, 144, 1, 2, 0, 11, 0], ); } @@ -869,17 +599,9 @@ mod tests { #[test] fn test_delay_and_input() { assert_frame( - build_set_delay( - *CHANNELS_RANGE.end(), - *DELAY_RAW_RANGE.end(), - ) - .unwrap(), + build_set_delay(*CHANNELS_RANGE.end(), *DELAY_RAW_RANGE.end()).unwrap(), 0x38, - &[ - *CHANNELS_RANGE.end(), - 0x00, - *DELAY_RAW_RANGE.end(), - ], + &[*CHANNELS_RANGE.end(), 0x00, *DELAY_RAW_RANGE.end()], ); assert_frame( @@ -935,11 +657,7 @@ mod tests { expected.extend_from_slice(&name); assert_frame( - build_store_channel_name( - *CHANNELS_RANGE.start(), - &name, - ) - .unwrap(), + build_store_channel_name(*CHANNELS_RANGE.start(), &name).unwrap(), 0x3D, &expected, ); @@ -953,14 +671,7 @@ mod tests { let release = *RELEASE_RAW_RANGE.end(); assert_frame( - build_set_gate( - *INPUT_CHANNELS.end(), - threshold, - attack, - hold, - release, - ) - .unwrap(), + build_set_gate(*INPUT_CHANNELS.end(), threshold, attack, hold, release).unwrap(), 0x3E, &[ *INPUT_CHANNELS.end(), @@ -978,13 +689,7 @@ mod tests { let threshold = *THRESHOLD_RAW_RANGE.end(); assert_frame( - build_set_limiter( - *OUTPUT_CHANNELS.end(), - threshold, - attack, - release, - ) - .unwrap(), + build_set_limiter(*OUTPUT_CHANNELS.end(), threshold, attack, release).unwrap(), 0x3F, &[ *OUTPUT_CHANNELS.end(), @@ -1005,12 +710,7 @@ mod tests { let gain = *MATRIX_GAIN_RAW_RANGE.end(); assert_frame( - build_matrix_gain( - *INPUT_CHANNELS.end(), - *OUTPUT_CHANNELS.end(), - gain, - ) - .unwrap(), + build_matrix_gain(*INPUT_CHANNELS.end(), *OUTPUT_CHANNELS.end(), gain).unwrap(), 0x41, &[ *OUTPUT_CHANNELS.end(), @@ -1042,16 +742,9 @@ mod tests { ); assert_frame( - build_set_geq_bypass( - *INPUT_CHANNELS.end(), - 1, - ) - .unwrap(), + build_set_geq_bypass(*INPUT_CHANNELS.end(), 1).unwrap(), 0x49, - &[ - *INPUT_CHANNELS.end(), - 1, - ], + &[*INPUT_CHANNELS.end(), 1], ); } -} \ No newline at end of file +} diff --git a/src/dsp408/protocol/config.rs b/src/dsp408/protocol/config.rs index 849151b..aee466c 100644 --- a/src/dsp408/protocol/config.rs +++ b/src/dsp408/protocol/config.rs @@ -6,11 +6,8 @@ use crate::{ common::errors::DSPError, dsp408::{ mapper, + protocol::{constants, reader::BinaryReader}, types, - protocol::{ - constants, - reader::BinaryReader, - }, }, }; @@ -37,9 +34,7 @@ fn read_gate(r: &mut BinaryReader) -> Result { }) } -fn read_geq( - r: &mut BinaryReader, -) -> Result { +fn read_geq(r: &mut BinaryReader) -> Result { let gains = types::DiscreteFrequency::iter() .map(|_| { let raw = r.read_u16()?; @@ -53,10 +48,7 @@ fn read_geq( }) } -fn read_peq_chain( - r: &mut BinaryReader, - band_count: usize, -) -> Result { +fn read_peq_chain(r: &mut BinaryReader, band_count: usize) -> Result { let bands = (0..band_count) .map(|_| { Ok(types::PEQ { @@ -75,9 +67,7 @@ fn read_peq_chain( }) } -fn read_crossover( - r: &mut BinaryReader, -) -> Result { +fn read_crossover(r: &mut BinaryReader) -> Result { let hp_freq = r.read_u16()?; let lp_freq = r.read_u16()?; let hp_filter = r.read_u8()?; @@ -94,9 +84,7 @@ fn read_crossover( }) } -fn read_compressor( - r: &mut BinaryReader, -) -> Result { +fn read_compressor(r: &mut BinaryReader) -> Result { Ok(types::Compressor { ratio: mapper::raw_to_ratio(r.read_u16()?)?, attack: mapper::raw_to_attack_ms(r.read_u16()?)?, @@ -106,9 +94,7 @@ fn read_compressor( }) } -fn read_limiter( - r: &mut BinaryReader, -) -> Result { +fn read_limiter(r: &mut BinaryReader) -> Result { let attack = mapper::raw_to_attack_ms(r.read_u16()?)?; let release = mapper::raw_to_release_ms(r.read_u16()?)?; @@ -132,7 +118,8 @@ pub fn decode_config(payload: &[u8]) -> Result let mut input_channels = vec![types::InputChannelState::default(); types::InputChannel::COUNT]; - let mut output_channels = vec![types::OutputChannelState::default(); types::OutputChannel::COUNT]; + let mut output_channels = + vec![types::OutputChannelState::default(); types::OutputChannel::COUNT]; let mut input_delays_raw: Vec = Vec::new(); let mut output_delays_raw: Vec = Vec::new(); @@ -162,7 +149,10 @@ pub fn decode_config(payload: &[u8]) -> Result r.skip(1)?; - inp.linked_channels = mapper::raw_to_link_channels(mapper::channel_to_raw(types::Channel::Input(channel))?, r.read_u8()?)?; + inp.linked_channels = mapper::raw_to_link_channels( + mapper::channel_to_raw(types::Channel::Input(channel))?, + r.read_u8()?, + )?; } // ============================ @@ -175,10 +165,7 @@ pub fn decode_config(payload: &[u8]) -> Result r.skip(1)?; out.matrix_routes = types::MatrixRoutes { - connected: - mapper::raw_to_matrix( - r.read_u8()? - )?, + connected: mapper::raw_to_matrix(r.read_u8()?)?, gains: (0..4) .map(|_| { @@ -206,43 +193,34 @@ pub fn decode_config(payload: &[u8]) -> Result r.skip(1)?; - out.linked_channels = mapper::raw_to_link_channels(mapper::channel_to_raw(types::Channel::Output(channel))?, r.read_u8()?)?; + out.linked_channels = mapper::raw_to_link_channels( + mapper::channel_to_raw(types::Channel::Output(channel))?, + r.read_u8()?, + )?; } // ============================ // MUTE FLAGS // ============================ - apply_flag( - &mut r, - &mut input_channels, - |ch, value| ch.mute = value, - )?; + apply_flag(&mut r, &mut input_channels, |ch, value| ch.mute = value)?; - apply_flag( - &mut r, - &mut output_channels, - |ch, value| ch.mute = value, - )?; + apply_flag(&mut r, &mut output_channels, |ch, value| ch.mute = value)?; // ============================ // PEQ BYPASS FLAGS // ============================ for inp in &mut input_channels { - apply_flag( - &mut r, - inp.peq_chain.bands.as_mut_slice(), - |band, value| band.bypass = value, - )?; + apply_flag(&mut r, inp.peq_chain.bands.as_mut_slice(), |band, value| { + band.bypass = value + })?; } for out in &mut output_channels { - apply_flag( - &mut r, - out.peq_chain.bands.as_mut_slice(), - |band, value| band.bypass = value, - )?; + apply_flag(&mut r, out.peq_chain.bands.as_mut_slice(), |band, value| { + band.bypass = value + })?; } // ============================ @@ -250,41 +228,27 @@ pub fn decode_config(payload: &[u8]) -> Result // ============================ let input_source = types::InputSource { - r#type: mapper::raw_to_input_source( - r.read_u16()? as u8, - )?, + r#type: mapper::raw_to_input_source(r.read_u16()? as u8)?, - frequency: mapper::raw_to_frequency_value( - r.read_u16()? as u8, - )?, + frequency: mapper::raw_to_frequency_value(r.read_u16()? as u8)?, }; // ============================ // DELAY UNIT // ============================ - let delay_unit = mapper::raw_to_delay_unit( - r.read_u16()? as u8, - )?; + let delay_unit = mapper::raw_to_delay_unit(r.read_u16()? as u8)?; // ============================ // APPLY DELAYS // ============================ - for (inp, raw_delay) in input_channels.iter_mut().zip(input_delays_raw) - { - inp.delay = mapper::raw_to_delay( - raw_delay, - delay_unit, - )?; + for (inp, raw_delay) in input_channels.iter_mut().zip(input_delays_raw) { + inp.delay = mapper::raw_to_delay(raw_delay, delay_unit)?; } - for (out, raw_delay) in output_channels.iter_mut().zip(output_delays_raw) - { - out.delay = mapper::raw_to_delay( - raw_delay, - delay_unit, - )?; + for (out, raw_delay) in output_channels.iter_mut().zip(output_delays_raw) { + out.delay = mapper::raw_to_delay(raw_delay, delay_unit)?; } // ============================ @@ -301,7 +265,6 @@ pub fn decode_config(payload: &[u8]) -> Result } } - let output_peq_bitmap = r.read_u16()?; for (index, out) in output_channels.iter_mut().enumerate() { @@ -325,19 +288,13 @@ pub fn decode_config(payload: &[u8]) -> Result let mut input_states = HashMap::new(); for (channel, state) in types::InputChannel::iter().zip(input_channels) { - input_states.insert( - channel, - state, - ); + input_states.insert(channel, state); } let mut output_states = HashMap::new(); for (channel, state) in types::OutputChannel::iter().zip(output_channels) { - output_states.insert( - channel, - state, - ); + output_states.insert(channel, state); } Ok(types::DSPConfigState { diff --git a/src/dsp408/protocol/constants.rs b/src/dsp408/protocol/constants.rs index e78860f..6509390 100644 --- a/src/dsp408/protocol/constants.rs +++ b/src/dsp408/protocol/constants.rs @@ -16,31 +16,31 @@ pub const CHANNELS_RANGE: RangeInclusive = 0x00..=0x0B; pub const INPUT_CHANNELS: RangeInclusive = 0x00..=0x03; pub const OUTPUT_CHANNELS: RangeInclusive = 0x04..=0x0B; -pub const RATIO_RAW_RANGE: RangeInclusive = 0x0000..=0x000F; -pub const ATTACK_RAW_RANGE: RangeInclusive = 0x0000..=0x03E6; -pub const RELEASE_RAW_RANGE: RangeInclusive = 0x0009..=0x0BB7; -pub const KNEE_RAW_RANGE: RangeInclusive = 0x0000..=0x000C; -pub const THRESHOLD_RAW_RANGE: RangeInclusive = 0x0000..=0x00DC; +pub const RATIO_RAW_RANGE: RangeInclusive = 0x0000..=0x000F; +pub const ATTACK_RAW_RANGE: RangeInclusive = 0x0000..=0x03E6; +pub const RELEASE_RAW_RANGE: RangeInclusive = 0x0009..=0x0BB7; +pub const KNEE_RAW_RANGE: RangeInclusive = 0x0000..=0x000C; +pub const THRESHOLD_RAW_RANGE: RangeInclusive = 0x0000..=0x00DC; -pub const FREQUENCY_RAW_RANGE: RangeInclusive = 0x0000..=0x012C; +pub const FREQUENCY_RAW_RANGE: RangeInclusive = 0x0000..=0x012C; pub const CROSSOVER_FILTER_RAW_RANGE: RangeInclusive = 0x00..=0x14; -pub const EQ_GAIN_RAW_RANGE: RangeInclusive = 0x0000..=0x00F0; -pub const PEQ_Q_RAW_RANGE: RangeInclusive = 0x00..=0x64; -pub const PEQ_INPUT_BAND_RANGE: RangeInclusive = 0x00..=0x07; -pub const PEQ_OUTPUT_BAND_RANGE:RangeInclusive = 0x00..=0x08; -pub const PEQ_FILTER_RAW_RANGE :RangeInclusive = 0x00..=0x08; +pub const EQ_GAIN_RAW_RANGE: RangeInclusive = 0x0000..=0x00F0; +pub const PEQ_Q_RAW_RANGE: RangeInclusive = 0x00..=0x64; +pub const PEQ_INPUT_BAND_RANGE: RangeInclusive = 0x00..=0x07; +pub const PEQ_OUTPUT_BAND_RANGE: RangeInclusive = 0x00..=0x08; +pub const PEQ_FILTER_RAW_RANGE: RangeInclusive = 0x00..=0x08; -pub const CHANNEL_GAIN_RAW_RANGE: RangeInclusive = 0x0000..=0x0190; +pub const CHANNEL_GAIN_RAW_RANGE: RangeInclusive = 0x0000..=0x0190; -pub const DELAY_RAW_RANGE: RangeInclusive = 0x00..=0xFF; +pub const DELAY_RAW_RANGE: RangeInclusive = 0x00..=0xFF; pub const INPUT_SOURCE_TYPE_RAW_RANGE: RangeInclusive = 0x00..=0x03; pub const DISCRETE_FREQUENCY_RAW_RANGE: RangeInclusive = 0x00..=0x1E; -pub const MATRIX_INPUT_MASK_RANGE: RangeInclusive = 0x00..=0x0F; +pub const MATRIX_INPUT_MASK_RANGE: RangeInclusive = 0x00..=0x0F; pub const MATRIX_INPUT_A_MASK: u8 = 0x01; pub const MATRIX_INPUT_B_MASK: u8 = 0x02; pub const MATRIX_INPUT_C_MASK: u8 = 0x04; @@ -50,9 +50,9 @@ pub const CHANNEL_NAME_LENGTH: usize = 8; pub const CHANNEL_NAME_PADDING: u8 = 0x00; pub const GATE_THRESHOLD_RAW_RANGE: RangeInclusive = 0x0000..=0x00B4; -pub const HOLD_RAW_RANGE: RangeInclusive = 0x0000..=0x03E6; +pub const HOLD_RAW_RANGE: RangeInclusive = 0x0000..=0x03E6; -pub const MATRIX_GAIN_RAW_RANGE: RangeInclusive = 0x0000..=0x0118; +pub const MATRIX_GAIN_RAW_RANGE: RangeInclusive = 0x0000..=0x0118; pub fn input_link_mask(channel: u8) -> Option { match channel { @@ -81,4 +81,4 @@ pub fn output_link_mask(channel: u8) -> Option { pub const METERS_SPLIT: f32 = 1.0; pub const METERS_SPLIT_LEVEL_DB: f32 = -18.0; pub const METERS_LOW_STEP: f32 = 0.0104; -pub const METERS_HIGH_STEP: f32 = 0.0208; \ No newline at end of file +pub const METERS_HIGH_STEP: f32 = 0.0208; diff --git a/src/dsp408/protocol/frame.rs b/src/dsp408/protocol/frame.rs index e09225d..bdf2dbb 100644 --- a/src/dsp408/protocol/frame.rs +++ b/src/dsp408/protocol/frame.rs @@ -65,8 +65,7 @@ pub fn extract_frame(data: &[u8]) -> Result { ))); } - let footer = find_footer(data) - .ok_or_else(|| FrameError::new("Missing frame footer"))?; + let footer = find_footer(data).ok_or_else(|| FrameError::new("Missing frame footer"))?; let expected = checksum(&data[2..footer]); let received = data[data.len() - 1]; @@ -89,8 +88,7 @@ fn find_footer(data: &[u8]) -> Option { return None; } - (2..data.len() - 1) - .find(|&i| data[i] == 0x10 && data[i + 1] == 0x03) + (2..data.len() - 1).find(|&i| data[i] == 0x10 && data[i + 1] == 0x03) } #[cfg(test)] diff --git a/src/dsp408/protocol/mod.rs b/src/dsp408/protocol/mod.rs index 0ee5afd..d36658a 100644 --- a/src/dsp408/protocol/mod.rs +++ b/src/dsp408/protocol/mod.rs @@ -1,8 +1,8 @@ mod reader; -pub(crate) mod frame; pub(crate) mod commands; -pub(crate) mod validators; pub(crate) mod config; +pub(crate) mod frame; +pub(crate) mod validators; -pub mod constants; \ No newline at end of file +pub mod constants; diff --git a/src/dsp408/protocol/reader.rs b/src/dsp408/protocol/reader.rs index d583d09..578ef56 100644 --- a/src/dsp408/protocol/reader.rs +++ b/src/dsp408/protocol/reader.rs @@ -11,9 +11,7 @@ impl<'a> BinaryReader<'a> { pub fn pop(&mut self, n: usize) -> Result<&'a [u8], DSPError> { if self.data.len() < n { - return Err(DSPError::InvalidRequest( - "buffer underflow".into() - )); + return Err(DSPError::InvalidRequest("buffer underflow".into())); } let (value, rest) = self.data.split_at(n); @@ -27,13 +25,11 @@ impl<'a> BinaryReader<'a> { } pub fn read_u16(&mut self) -> Result { - Ok(u16::from_le_bytes( - self.pop(2)?.try_into().unwrap() - )) + Ok(u16::from_le_bytes(self.pop(2)?.try_into().unwrap())) } pub fn skip(&mut self, n: usize) -> Result<(), DSPError> { self.pop(n)?; Ok(()) } -} \ No newline at end of file +} diff --git a/src/dsp408/protocol/validators.rs b/src/dsp408/protocol/validators.rs index 0d182c3..ab4ba13 100644 --- a/src/dsp408/protocol/validators.rs +++ b/src/dsp408/protocol/validators.rs @@ -1,45 +1,33 @@ use crate::{ common::{ errors::ValidationError, - validator::{ - validate_ascii_padded, - validate_bitmask, - validate_range, - }, + validator::{validate_ascii_padded, validate_bitmask, validate_range}, }, dsp408::protocol::constants::*, }; pub fn validate_raw_delay_unit(raw_unit: u8) -> Result<(), ValidationError> { - validate_range( - raw_unit, - DELAY_UNIT_RAW_RANGE, - || format!("Invalid delay unit: {:#04x}", raw_unit) - ) + validate_range(raw_unit, DELAY_UNIT_RAW_RANGE, || { + format!("Invalid delay unit: {:#04x}", raw_unit) + }) } pub fn validate_raw_preset_index(raw_index: u8) -> Result<(), ValidationError> { - validate_range( - raw_index, - 0..=PRESET_INDEX_MAX, - || format!("Invalid preset index {}", raw_index) - ) + validate_range(raw_index, 0..=PRESET_INDEX_MAX, || { + format!("Invalid preset index {}", raw_index) + }) } pub fn validate_raw_store_preset_index(raw_index: u8) -> Result<(), ValidationError> { - validate_range( - raw_index, - 1..=PRESET_INDEX_MAX, - || format!("Invalid preset index {}", raw_index) - ) + validate_range(raw_index, 1..=PRESET_INDEX_MAX, || { + format!("Invalid preset index {}", raw_index) + }) } pub fn validate_raw_get_preset_index(raw_index: u8) -> Result<(), ValidationError> { - validate_range( - raw_index, - 0..PRESET_INDEX_MAX, - || format!("Invalid preset index {}", raw_index) - ) + validate_range(raw_index, 0..PRESET_INDEX_MAX, || { + format!("Invalid preset index {}", raw_index) + }) } pub fn validate_raw_preset_name(raw_name: &[u8]) -> Result<(), ValidationError> { @@ -47,58 +35,46 @@ pub fn validate_raw_preset_name(raw_name: &[u8]) -> Result<(), ValidationError> raw_name, PRESET_NAME_LENGTH, PRESET_NAME_PADDING, - "Preset name" + "Preset name", ) } pub fn validate_raw_config_chunk_index(raw_index: u8) -> Result<(), ValidationError> { - validate_range( - raw_index, - 0..=CONFIG_CHUNK_INDEX_MAX, - || format!("Invalid config index: {:#04x}", raw_index) - ) + validate_range(raw_index, 0..=CONFIG_CHUNK_INDEX_MAX, || { + format!("Invalid config index: {:#04x}", raw_index) + }) } pub fn validate_raw_channel(channel: u8) -> Result<(), ValidationError> { - validate_range( - channel, - CHANNELS_RANGE, - || format!("Invalid Channel: {:#04x}", channel), - ) + validate_range(channel, CHANNELS_RANGE, || { + format!("Invalid Channel: {:#04x}", channel) + }) } pub fn validate_raw_input_channel(channel: u8) -> Result<(), ValidationError> { - validate_range( - channel, - INPUT_CHANNELS, - || format!("Invalid Channel: {:#04x}", channel), - ) + validate_range(channel, INPUT_CHANNELS, || { + format!("Invalid Channel: {:#04x}", channel) + }) } pub fn validate_raw_output_channel(channel: u8) -> Result<(), ValidationError> { - validate_range( - channel, - OUTPUT_CHANNELS, - || format!("Invalid Channel: {:#04x}", channel), - ) + validate_range(channel, OUTPUT_CHANNELS, || { + format!("Invalid Channel: {:#04x}", channel) + }) } pub fn validate_raw_copy_channels(source: u8, destination: u8) -> Result<(), ValidationError> { - validate_range( - source, - CHANNELS_RANGE, - || format!("Invalid source channel: {:#04x}", source), - )?; + validate_range(source, CHANNELS_RANGE, || { + format!("Invalid source channel: {:#04x}", source) + })?; - validate_range( - destination, - CHANNELS_RANGE, - || format!("Invalid destination channel: {:#04x}", destination), - )?; + validate_range(destination, CHANNELS_RANGE, || { + format!("Invalid destination channel: {:#04x}", destination) + })?; if source == destination { return Err(ValidationError::value( - "Source channel and destination channel can't be the same" + "Source channel and destination channel can't be the same", )); } @@ -107,7 +83,7 @@ pub fn validate_raw_copy_channels(source: u8, destination: u8) -> Result<(), Val if source_is_input != destination_is_input { return Err(ValidationError::value( - "Channels need to be both inputs or outputs" + "Channels need to be both inputs or outputs", )); } @@ -115,150 +91,111 @@ pub fn validate_raw_copy_channels(source: u8, destination: u8) -> Result<(), Val } pub fn validate_raw_password(password: &[u8]) -> Result<(), ValidationError> { - validate_ascii_padded( - password, - PASSWORD_LENGTH, - PASSWORD_PADDING, - "Password" - ) + validate_ascii_padded(password, PASSWORD_LENGTH, PASSWORD_PADDING, "Password") } pub fn validate_raw_compressor_ratio(raw_ratio: u16) -> Result<(), ValidationError> { - validate_range( - raw_ratio, - RATIO_RAW_RANGE, - || format!("Invalid compressor ratio: {:#06x}", raw_ratio), - ) + validate_range(raw_ratio, RATIO_RAW_RANGE, || { + format!("Invalid compressor ratio: {:#06x}", raw_ratio) + }) } pub fn validate_raw_attack(raw_attack: u16) -> Result<(), ValidationError> { - validate_range( - raw_attack, - ATTACK_RAW_RANGE, - || format!("Invalid attack: {:#06x}", raw_attack), - ) + validate_range(raw_attack, ATTACK_RAW_RANGE, || { + format!("Invalid attack: {:#06x}", raw_attack) + }) } pub fn validate_raw_release(raw_release: u16) -> Result<(), ValidationError> { - validate_range( - raw_release, - RELEASE_RAW_RANGE, - || format!("Invalid release: {:#06x}", raw_release), - ) + validate_range(raw_release, RELEASE_RAW_RANGE, || { + format!("Invalid release: {:#06x}", raw_release) + }) } pub fn validate_raw_compressor_knee(raw_knee: u16) -> Result<(), ValidationError> { - validate_range( - raw_knee, - KNEE_RAW_RANGE, - || format!("Invalid compressor knee: {:#06x}", raw_knee), - ) + validate_range(raw_knee, KNEE_RAW_RANGE, || { + format!("Invalid compressor knee: {:#06x}", raw_knee) + }) } pub fn validate_raw_threshold(raw_threshold: u16) -> Result<(), ValidationError> { - validate_range( - raw_threshold, - THRESHOLD_RAW_RANGE, - || format!("Invalid compressor threshold: {:#06x}", raw_threshold), - ) + validate_range(raw_threshold, THRESHOLD_RAW_RANGE, || { + format!("Invalid compressor threshold: {:#06x}", raw_threshold) + }) } pub fn validate_raw_frequency(raw_freq: u16) -> Result<(), ValidationError> { - validate_range( - raw_freq, - FREQUENCY_RAW_RANGE, - || format!("Invalid frequency: {:#06x}", raw_freq), - ) + validate_range(raw_freq, FREQUENCY_RAW_RANGE, || { + format!("Invalid frequency: {:#06x}", raw_freq) + }) } pub fn validate_raw_crossover_filter(raw_filter_type: u8) -> Result<(), ValidationError> { - validate_range( - raw_filter_type, - CROSSOVER_FILTER_RAW_RANGE, - || format!("Invalid filter: {:#04x}", raw_filter_type), - ) + validate_range(raw_filter_type, CROSSOVER_FILTER_RAW_RANGE, || { + format!("Invalid filter: {:#04x}", raw_filter_type) + }) } pub fn validate_raw_peq_band(raw_channel: u8, raw_band: u8) -> Result<(), ValidationError> { if INPUT_CHANNELS.contains(&raw_channel) { - validate_range( - raw_band, - PEQ_INPUT_BAND_RANGE, - || format!("Invalid input PEQ band: {:#04x}", raw_band), - )?; + validate_range(raw_band, PEQ_INPUT_BAND_RANGE, || { + format!("Invalid input PEQ band: {:#04x}", raw_band) + })?; } else if OUTPUT_CHANNELS.contains(&raw_channel) { - validate_range( - raw_band, - PEQ_OUTPUT_BAND_RANGE, - || format!("Invalid output PEQ band: {:#04x}", raw_band), - )?; + validate_range(raw_band, PEQ_OUTPUT_BAND_RANGE, || { + format!("Invalid output PEQ band: {:#04x}", raw_band) + })?; } Ok(()) } pub fn validate_raw_peq_q(raw_q: u8) -> Result<(), ValidationError> { - validate_range( - raw_q, - PEQ_Q_RAW_RANGE, - || format!("Invalid PEQ Q: {:#04x}", raw_q), - ) + validate_range(raw_q, PEQ_Q_RAW_RANGE, || { + format!("Invalid PEQ Q: {:#04x}", raw_q) + }) } pub fn validate_raw_peq_filter(raw_filter_type: u8) -> Result<(), ValidationError> { - validate_range( - raw_filter_type, - PEQ_FILTER_RAW_RANGE, - || format!("Invalid PEQ filter: {:#04x}", raw_filter_type), - ) + validate_range(raw_filter_type, PEQ_FILTER_RAW_RANGE, || { + format!("Invalid PEQ filter: {:#04x}", raw_filter_type) + }) } pub fn validate_raw_eq_gain(raw_gain: u16) -> Result<(), ValidationError> { - validate_range( - raw_gain, - EQ_GAIN_RAW_RANGE, - || format!("Invalid EQ gain: {:#06x}", raw_gain), - ) + validate_range(raw_gain, EQ_GAIN_RAW_RANGE, || { + format!("Invalid EQ gain: {:#06x}", raw_gain) + }) } pub fn validate_raw_gain(raw_gain: u16) -> Result<(), ValidationError> { - validate_range( - raw_gain, - CHANNEL_GAIN_RAW_RANGE, - || format!("Invalid channel gain: {:#06x}", raw_gain), - ) + validate_range(raw_gain, CHANNEL_GAIN_RAW_RANGE, || { + format!("Invalid channel gain: {:#06x}", raw_gain) + }) } pub fn validate_raw_channel_delay(delay: u8) -> Result<(), ValidationError> { - validate_range( - delay, - DELAY_RAW_RANGE, - || format!("Invalid channel delay: {:#04x}", delay) - ) + validate_range(delay, DELAY_RAW_RANGE, || { + format!("Invalid channel delay: {:#04x}", delay) + }) } pub fn validate_raw_input_source(input_type: u8) -> Result<(), ValidationError> { - validate_range( - input_type, - INPUT_SOURCE_TYPE_RAW_RANGE, - || format!("Invalid source type: {:#04x}", input_type), - ) + validate_range(input_type, INPUT_SOURCE_TYPE_RAW_RANGE, || { + format!("Invalid source type: {:#04x}", input_type) + }) } pub fn validate_raw_discrete_frequency(frequency: u8) -> Result<(), ValidationError> { - validate_range( - frequency, - DISCRETE_FREQUENCY_RAW_RANGE, - || format!("Invalid frequency: {:#04x}", frequency), - ) + validate_range(frequency, DISCRETE_FREQUENCY_RAW_RANGE, || { + format!("Invalid frequency: {:#04x}", frequency) + }) } pub fn validate_raw_matrix_bitmask(input_bitmask: u8) -> Result<(), ValidationError> { - validate_range( - input_bitmask, - MATRIX_INPUT_MASK_RANGE, - || format!("Invalid matrix bitmask: {:#04x}", input_bitmask), - ) + validate_range(input_bitmask, MATRIX_INPUT_MASK_RANGE, || { + format!("Invalid matrix bitmask: {:#04x}", input_bitmask) + }) } pub fn validate_raw_link_channel( @@ -273,20 +210,18 @@ pub fn validate_raw_link_channel( output_link_mask(source_channel) } .ok_or_else(|| { - ValidationError::value( - format!("Invalid link source channel: {:#04x}", source_channel) - ) + ValidationError::value(format!( + "Invalid link source channel: {:#04x}", + source_channel + )) })?; - validate_bitmask( - destination_channel_bitmask, - allowed_mask, - || format!( + validate_bitmask(destination_channel_bitmask, allowed_mask, || { + format!( "Invalid link bitmask {:#04x} for source channel {:#04x}", - destination_channel_bitmask, - source_channel - ), - ) + destination_channel_bitmask, source_channel + ) + }) } pub fn validate_raw_channel_name(raw_name: &[u8]) -> Result<(), ValidationError> { @@ -299,95 +234,87 @@ pub fn validate_raw_channel_name(raw_name: &[u8]) -> Result<(), ValidationError> } pub fn validate_raw_gate_threshold(raw_threshold: u16) -> Result<(), ValidationError> { - validate_range( - raw_threshold, - GATE_THRESHOLD_RAW_RANGE, - || format!("Invalid gate threshold: {:#06x}", raw_threshold), - ) + validate_range(raw_threshold, GATE_THRESHOLD_RAW_RANGE, || { + format!("Invalid gate threshold: {:#06x}", raw_threshold) + }) } pub fn validate_raw_hold(raw_hold: u16) -> Result<(), ValidationError> { - validate_range( - raw_hold, - HOLD_RAW_RANGE, - || format!("Invalid hold: {:#06x}", raw_hold), - ) + validate_range(raw_hold, HOLD_RAW_RANGE, || { + format!("Invalid hold: {:#06x}", raw_hold) + }) } pub fn validate_raw_matrix_gain(raw_gain: u16) -> Result<(), ValidationError> { - validate_range( - raw_gain, - MATRIX_GAIN_RAW_RANGE, - || format!("Invalid matrix gain: {:#06x}", raw_gain), - ) + validate_range(raw_gain, MATRIX_GAIN_RAW_RANGE, || { + format!("Invalid matrix gain: {:#06x}", raw_gain) + }) } pub fn validate_raw_bool(value: u8) -> Result<(), ValidationError> { - validate_range( - value, - 0..=1, - || format!("Invalid bool value: {:#04x}", value), - ) + validate_range(value, 0..=1, || { + format!("Invalid bool value: {:#04x}", value) + }) } #[cfg(test)] mod tests { use super::*; - + // ---- validate_raw_delay_unit: 0x00..=0x03 ---- #[test] fn delay_unit_accepts_low_and_high_bounds() { assert!(validate_raw_delay_unit(0x00).is_ok()); assert!(validate_raw_delay_unit(0x03).is_ok()); } - + #[test] fn delay_unit_rejects_just_above_max() { assert!(validate_raw_delay_unit(0x04).is_err()); } - + // ---- validate_raw_preset_index: 0..=20 ---- #[test] fn preset_index_accepts_bounds() { assert!(validate_raw_preset_index(0).is_ok()); assert!(validate_raw_preset_index(PRESET_INDEX_MAX).is_ok()); } - + #[test] fn preset_index_rejects_above_max() { assert!(validate_raw_preset_index(PRESET_INDEX_MAX + 1).is_err()); } - + // ---- validate_raw_store_preset_index: 1..=20 (0 reserved, unlike get/plain) ---- #[test] fn store_preset_index_rejects_zero() { assert!(validate_raw_store_preset_index(0).is_err()); } - + #[test] fn store_preset_index_accepts_one_through_max() { assert!(validate_raw_store_preset_index(1).is_ok()); assert!(validate_raw_store_preset_index(PRESET_INDEX_MAX).is_ok()); } - + #[test] fn store_preset_index_rejects_above_max() { assert!(validate_raw_store_preset_index(PRESET_INDEX_MAX + 1).is_err()); } - + // ---- validate_raw_get_preset_index: 0..20 (max itself excluded) ---- #[test] fn get_preset_index_accepts_zero_and_just_below_max() { assert!(validate_raw_get_preset_index(0).is_ok()); assert!(validate_raw_get_preset_index(PRESET_INDEX_MAX - 1).is_ok()); } - + #[test] fn get_preset_index_rejects_max_itself() { // Unlike validate_raw_preset_index, this range is exclusive of PRESET_INDEX_MAX. assert!(validate_raw_get_preset_index(PRESET_INDEX_MAX).is_err()); } - + // ---- validate_raw_preset_name: 14 ascii bytes, space-padded ---- #[test] fn preset_name_accepts_correctly_padded_ascii() { @@ -395,13 +322,13 @@ mod tests { name.resize(PRESET_NAME_LENGTH, PRESET_NAME_PADDING); assert!(validate_raw_preset_name(&name).is_ok()); } - + #[test] fn preset_name_rejects_wrong_length() { let name = b"TooShort".to_vec(); assert!(validate_raw_preset_name(&name).is_err()); } - + #[test] fn preset_name_rejects_non_ascii_byte() { let mut name = b"Bad".to_vec(); @@ -409,86 +336,86 @@ mod tests { name.resize(PRESET_NAME_LENGTH, PRESET_NAME_PADDING); assert!(validate_raw_preset_name(&name).is_err()); } - + // ---- validate_raw_config_chunk_index: 0..=0x1C ---- #[test] fn config_chunk_index_accepts_bounds() { assert!(validate_raw_config_chunk_index(0x00).is_ok()); assert!(validate_raw_config_chunk_index(CONFIG_CHUNK_INDEX_MAX).is_ok()); } - + #[test] fn config_chunk_index_rejects_above_max() { assert!(validate_raw_config_chunk_index(CONFIG_CHUNK_INDEX_MAX + 1).is_err()); } - + // ---- validate_raw_channel: 0..=0x0B ---- #[test] fn channel_accepts_full_range() { assert!(validate_raw_channel(0x00).is_ok()); assert!(validate_raw_channel(0x0B).is_ok()); } - + #[test] fn channel_rejects_above_max() { assert!(validate_raw_channel(0x0C).is_err()); } - + // ---- validate_raw_input_channel: 0..=0x03 ---- #[test] fn input_channel_accepts_its_own_range() { assert!(validate_raw_input_channel(0x00).is_ok()); assert!(validate_raw_input_channel(0x03).is_ok()); } - + #[test] fn input_channel_rejects_an_output_channel() { assert!(validate_raw_input_channel(0x04).is_err()); } - + // ---- validate_raw_output_channel: 0x04..=0x0B ---- #[test] fn output_channel_accepts_its_own_range() { assert!(validate_raw_output_channel(0x04).is_ok()); assert!(validate_raw_output_channel(0x0B).is_ok()); } - + #[test] fn output_channel_rejects_an_input_channel() { assert!(validate_raw_output_channel(0x03).is_err()); } - + // ---- validate_raw_copy_channels ---- #[test] fn copy_channels_allows_input_to_input() { assert!(validate_raw_copy_channels(0x00, 0x01).is_ok()); } - + #[test] fn copy_channels_allows_output_to_output() { assert!(validate_raw_copy_channels(0x04, 0x05).is_ok()); } - + #[test] fn copy_channels_rejects_same_source_and_destination() { assert!(validate_raw_copy_channels(0x01, 0x01).is_err()); } - + #[test] fn copy_channels_rejects_mixed_input_and_output() { assert!(validate_raw_copy_channels(0x01, 0x05).is_err()); } - + #[test] fn copy_channels_rejects_out_of_range_source() { assert!(validate_raw_copy_channels(0x0C, 0x01).is_err()); } - + #[test] fn copy_channels_rejects_out_of_range_destination() { assert!(validate_raw_copy_channels(0x01, 0x0C).is_err()); } - + // ---- validate_raw_password: 4 bytes, null-padded ---- #[test] fn password_accepts_null_padded_ascii() { @@ -496,128 +423,128 @@ mod tests { pw.resize(PASSWORD_LENGTH, PASSWORD_PADDING); assert!(validate_raw_password(&pw).is_ok()); } - + #[test] fn password_rejects_wrong_length() { assert!(validate_raw_password(b"abcde").is_err()); } - + #[test] fn password_rejects_non_ascii_non_padding_byte() { let pw = vec![b'a', b'b', 0x01, 0x00]; assert!(validate_raw_password(&pw).is_err()); } - + // ---- validate_raw_compressor_ratio: 0..=0x000F ---- #[test] fn compressor_ratio_accepts_bounds() { assert!(validate_raw_compressor_ratio(0x0000).is_ok()); assert!(validate_raw_compressor_ratio(0x000F).is_ok()); } - + #[test] fn compressor_ratio_rejects_above_max() { assert!(validate_raw_compressor_ratio(0x0010).is_err()); } - + // ---- validate_raw_attack: 0..=0x03E6 ---- #[test] fn attack_accepts_bounds() { assert!(validate_raw_attack(0x0000).is_ok()); assert!(validate_raw_attack(0x03E6).is_ok()); } - + #[test] fn attack_rejects_above_max() { assert!(validate_raw_attack(0x03E7).is_err()); } - + // ---- validate_raw_release: 0x0009..=0x0BB7 ---- #[test] fn release_rejects_below_min() { assert!(validate_raw_release(0x0008).is_err()); } - + #[test] fn release_accepts_bounds() { assert!(validate_raw_release(0x0009).is_ok()); assert!(validate_raw_release(0x0BB7).is_ok()); } - + #[test] fn release_rejects_above_max() { assert!(validate_raw_release(0x0BB8).is_err()); } - + // ---- validate_raw_compressor_knee: 0..=0x000C ---- #[test] fn compressor_knee_accepts_bounds() { assert!(validate_raw_compressor_knee(0x0000).is_ok()); assert!(validate_raw_compressor_knee(0x000C).is_ok()); } - + #[test] fn compressor_knee_rejects_above_max() { assert!(validate_raw_compressor_knee(0x000D).is_err()); } - + // ---- validate_raw_threshold: 0..=0x00DC ---- #[test] fn threshold_accepts_bounds() { assert!(validate_raw_threshold(0x0000).is_ok()); assert!(validate_raw_threshold(0x00DC).is_ok()); } - + #[test] fn threshold_rejects_above_max() { assert!(validate_raw_threshold(0x00DD).is_err()); } - + // ---- validate_raw_frequency: 0..=0x012C ---- #[test] fn frequency_accepts_bounds() { assert!(validate_raw_frequency(0x0000).is_ok()); assert!(validate_raw_frequency(0x012C).is_ok()); } - + #[test] fn frequency_rejects_above_max() { assert!(validate_raw_frequency(0x012D).is_err()); } - + // ---- validate_raw_crossover_filter: 0..=0x14 ---- #[test] fn crossover_filter_accepts_bounds() { assert!(validate_raw_crossover_filter(0x00).is_ok()); assert!(validate_raw_crossover_filter(0x14).is_ok()); } - + #[test] fn crossover_filter_rejects_above_max() { assert!(validate_raw_crossover_filter(0x15).is_err()); } - + // ---- validate_raw_peq_band: depends on whether channel is input or output ---- #[test] fn peq_band_accepts_max_band_for_input_channel() { assert!(validate_raw_peq_band(0x00, 0x07).is_ok()); // input max band } - + #[test] fn peq_band_rejects_above_max_for_input_channel() { assert!(validate_raw_peq_band(0x00, 0x08).is_err()); } - + #[test] fn peq_band_accepts_max_band_for_output_channel() { assert!(validate_raw_peq_band(0x04, 0x08).is_ok()); // output max band (one higher than input) } - + #[test] fn peq_band_rejects_above_max_for_output_channel() { assert!(validate_raw_peq_band(0x04, 0x09).is_err()); } - + #[test] fn peq_band_is_unchecked_for_out_of_range_channel() { // Neither branch fires when the channel is outside both INPUT_CHANNELS and @@ -625,55 +552,55 @@ mod tests { // This documents that behavior rather than asserting it's necessarily "correct". assert!(validate_raw_peq_band(0x0C, 0xFF).is_ok()); } - + // ---- validate_raw_peq_q: 0..=0x64 ---- #[test] fn peq_q_accepts_bounds() { assert!(validate_raw_peq_q(0x00).is_ok()); assert!(validate_raw_peq_q(0x64).is_ok()); } - + #[test] fn peq_q_rejects_above_max() { assert!(validate_raw_peq_q(0x65).is_err()); } - + // ---- validate_raw_peq_filter: 0..=0x08 ---- #[test] fn peq_filter_accepts_bounds() { assert!(validate_raw_peq_filter(0x00).is_ok()); assert!(validate_raw_peq_filter(0x08).is_ok()); } - + #[test] fn peq_filter_rejects_above_max() { assert!(validate_raw_peq_filter(0x09).is_err()); } - + // ---- validate_raw_eq_gain: 0..=0x00F0 ---- #[test] fn eq_gain_accepts_bounds() { assert!(validate_raw_eq_gain(0x0000).is_ok()); assert!(validate_raw_eq_gain(0x00F0).is_ok()); } - + #[test] fn eq_gain_rejects_above_max() { assert!(validate_raw_eq_gain(0x00F1).is_err()); } - + // ---- validate_raw_gain: 0..=0x0190 ---- #[test] fn gain_accepts_bounds() { assert!(validate_raw_gain(0x0000).is_ok()); assert!(validate_raw_gain(0x0190).is_ok()); } - + #[test] fn gain_rejects_above_max() { assert!(validate_raw_gain(0x0191).is_err()); } - + // ---- validate_raw_channel_delay: 0..=0xFF (the full u8 range) ---- #[test] fn channel_delay_accepts_the_entire_u8_range() { @@ -682,80 +609,80 @@ mod tests { assert!(validate_raw_channel_delay(0x00).is_ok()); assert!(validate_raw_channel_delay(0xFF).is_ok()); } - + // ---- validate_raw_input_source: 0..=0x03 ---- #[test] fn input_source_accepts_bounds() { assert!(validate_raw_input_source(0x00).is_ok()); assert!(validate_raw_input_source(0x03).is_ok()); } - + #[test] fn input_source_rejects_above_max() { assert!(validate_raw_input_source(0x04).is_err()); } - + // ---- validate_raw_discrete_frequency: 0..=0x1E ---- #[test] fn discrete_frequency_accepts_bounds() { assert!(validate_raw_discrete_frequency(0x00).is_ok()); assert!(validate_raw_discrete_frequency(0x1E).is_ok()); } - + #[test] fn discrete_frequency_rejects_above_max() { assert!(validate_raw_discrete_frequency(0x1F).is_err()); } - + // ---- validate_raw_matrix_bitmask: 0..=0x0F ---- #[test] fn matrix_bitmask_accepts_bounds() { assert!(validate_raw_matrix_bitmask(0x00).is_ok()); assert!(validate_raw_matrix_bitmask(0x0F).is_ok()); } - + #[test] fn matrix_bitmask_rejects_above_max() { assert!(validate_raw_matrix_bitmask(0x10).is_err()); } - + // ---- validate_raw_link_channel ---- #[test] fn link_channel_input_a_accepts_full_allowed_mask() { // Channel 0x00 (A) allows linking to A|B|C|D = 0x0F per input_link_mask. assert!(validate_raw_link_channel(0x00, 0x0F).is_ok()); } - + #[test] fn link_channel_input_a_rejects_bit_outside_allowed_mask() { assert!(validate_raw_link_channel(0x00, 0x10).is_err()); } - + #[test] fn link_channel_input_d_only_allows_its_own_bit() { // Channel 0x03 (D) only allows mask 0x08 per input_link_mask. assert!(validate_raw_link_channel(0x03, 0x08).is_ok()); assert!(validate_raw_link_channel(0x03, 0x04).is_err()); } - + #[test] fn link_channel_output_first_accepts_full_mask() { // Channel 0x04 allows mask 0xFF per output_link_mask. assert!(validate_raw_link_channel(0x04, 0xFF).is_ok()); } - + #[test] fn link_channel_output_last_only_allows_its_own_bit() { // Channel 0x0B allows only mask 0x80 per output_link_mask. assert!(validate_raw_link_channel(0x0B, 0x80).is_ok()); assert!(validate_raw_link_channel(0x0B, 0x01).is_err()); } - + #[test] fn link_channel_rejects_out_of_range_source_channel() { assert!(validate_raw_link_channel(0x0C, 0x01).is_err()); } - + // ---- validate_raw_channel_name: 8 ascii bytes, null-padded ---- #[test] fn channel_name_accepts_correctly_padded_ascii() { @@ -763,12 +690,12 @@ mod tests { name.resize(CHANNEL_NAME_LENGTH, CHANNEL_NAME_PADDING); assert!(validate_raw_channel_name(&name).is_ok()); } - + #[test] fn channel_name_rejects_wrong_length() { assert!(validate_raw_channel_name(b"TooLongName").is_err()); } - + #[test] fn channel_name_rejects_non_ascii_byte() { let mut name = b"Kick".to_vec(); @@ -776,38 +703,38 @@ mod tests { name.resize(CHANNEL_NAME_LENGTH, CHANNEL_NAME_PADDING); assert!(validate_raw_channel_name(&name).is_err()); } - + // ---- validate_raw_gate_threshold: 0..=0x00B4 ---- #[test] fn gate_threshold_accepts_bounds() { assert!(validate_raw_gate_threshold(0x0000).is_ok()); assert!(validate_raw_gate_threshold(0x00B4).is_ok()); } - + #[test] fn gate_threshold_rejects_above_max() { assert!(validate_raw_gate_threshold(0x00B5).is_err()); } - + // ---- validate_raw_hold: 0..=0x03E6 ---- #[test] fn hold_accepts_bounds() { assert!(validate_raw_hold(0x0000).is_ok()); assert!(validate_raw_hold(0x03E6).is_ok()); } - + #[test] fn hold_rejects_above_max() { assert!(validate_raw_hold(0x03E7).is_err()); } - + // ---- validate_raw_matrix_gain: 0..=0x0118 ---- #[test] fn matrix_gain_accepts_bounds() { assert!(validate_raw_matrix_gain(0x0000).is_ok()); assert!(validate_raw_matrix_gain(0x0118).is_ok()); } - + #[test] fn matrix_gain_rejects_above_max() { assert!(validate_raw_matrix_gain(0x0119).is_err()); diff --git a/src/dsp408/types.rs b/src/dsp408/types.rs index 4e7fc80..e9035df 100644 --- a/src/dsp408/types.rs +++ b/src/dsp408/types.rs @@ -1,5 +1,5 @@ use std::{collections::HashMap, net::IpAddr}; -use strum_macros::{EnumIter, EnumCount}; +use strum_macros::{EnumCount, EnumIter}; // ------ Enums ------ @@ -354,19 +354,13 @@ pub struct DSPConfigState { } impl DSPConfigState { - pub fn input_state_mut( - &mut self, - channel: InputChannel, - ) -> &mut InputChannelState { + pub fn input_state_mut(&mut self, channel: InputChannel) -> &mut InputChannelState { self.input_states .get_mut(&channel) .expect("Invalid input channel state") } - - pub fn output_state_mut( - &mut self, - channel: OutputChannel, - ) -> &mut OutputChannelState { + + pub fn output_state_mut(&mut self, channel: OutputChannel) -> &mut OutputChannelState { self.output_states .get_mut(&channel) .expect("Invalid output channel state") diff --git a/src/lib.rs b/src/lib.rs index b63c20f..dd40802 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,4 +1,4 @@ mod common; pub mod dsp408; -pub use common::errors::DSPError; \ No newline at end of file +pub use common::errors::DSPError; diff --git a/src/main.rs b/src/main.rs index 19e2620..c3459ca 100644 --- a/src/main.rs +++ b/src/main.rs @@ -5,14 +5,9 @@ use dsp_thomann::dsp408::DSP408; use dsp_thomann::dsp408::types; fn main() -> Result<(), Box> { - let host = IpAddr::from_str("192.168.49.30")?; - let mut dsp = DSP408::new( - host, - 9761, - 1, - )?; + let mut dsp = DSP408::new(host, 9761, 1)?; println!("Connecting to DSP..."); match dsp.connect() { @@ -35,6 +30,5 @@ fn main() -> Result<(), Box> { dsp.disconnect(); println!("Disconnected"); - Ok(()) -} \ No newline at end of file +}