Blyx

Warbler

Workflow framework · 0.1.1

Flag sustained clipping while reporting the energy of an audio frame.

Distinguish a clipped transient from a sustained overload

Two adjacent full-scale samples breach the one-sample allowance. Separating them with silence changes the alert.

Run the native CLI

Extract the workflow collection for your platform. Run .\bin\warbler.exe --help in PowerShell or ./bin/warbler --help on Linux and macOS. Running the command with no arguments prints the worked example.

Build from source

With Blyx 0.2.1, Rust and a host linker installed, run these commands to edit and rebuild the example.

git clone --depth 1 --branch v0.1.1 https://github.com/Rahulchaube1/blyx-warbler.git
cd blyx-warbler
blyxc native-run project.blyx -- "1,-1,0,0" 1 1

Why this framework exists

Identical peak readings can represent a single transient or a sustained overload. Inspect run length alongside frame energy. librosa, frame energy

Install Warbler in your editor

Extension RahulChaube.blyx-warbler · 0.1.0

The extension includes a runnable Blyx example, function completions and the framework source. For the modular project, extract the starter, open its folder and run blyxc native-run main.blyx with the native toolchain installed.

Create an empty .blyx file, type blyx-warbler-demo and accept the completion. Choose Blyx: Run File to run the example.

For an offline installation, choose Extensions: Install from VSIX for Blyx Language first, then for Warbler.

Download the companion Blyx Language VSIX

Libraries in this framework

Install with Conda

Create an environment containing Warbler 0.1.1, its Blyx source and a runnable example. Run the second command with Blyx 0.2.1, Rust and a host linker installed.

conda create -y --prefix ./blyx-env --override-channels -c https://rahulchaube1.github.io/blyx-packages blyx-warbler=0.1.1=0
blyxc native-run ./blyx-env/share/blyx/warbler/main.blyx

To use this package in your application, copy share/blyx/warbler/vendor/warbler from the environment into your project's vendor directory.

Install the full collection with Homebrew or Scoop

Import into a Blyx project

Install Blyx 0.2.1, Rust 1.85 or newer and a host linker. From the directory containing your entry file, clone this tagged release.

git clone --depth 1 --branch v0.1.1 https://github.com/Rahulchaube1/blyx-warbler.git vendor/warbler

You can also download Warbler as a ZIP. Extract its contents into vendor/warbler.

Save this as main.blyx beside vendor and run blyxc native-run main.blyx.

use vendor::warbler::warbler;

fn main() {
    let samples = [1, -1, 0, 0];
    let ceiling = 1.0;
    let allowed = 1.0;
    let result = warbler_meter(samples, ceiling, allowed);
    if len(result) == 0 { println!("invalid"); return; }
    let mut i = 0;
    while i < len(result) {
        println!(at(result, i));
        i += 1;
    }
}

Expected output

1
0.5
2
1

API and input requirements

Returns [peak, mean square, longest clipped run, alert]. Alert means the longest run exceeded the allowed number of samples. Invalid arguments and nonfinite results return an empty vector.

APIUse
warbler_meter(samples, ceiling, allowed)Returns [peak, mean square, longest clipped run, alert]. Alert means the longest run exceeded the allowed number of samples.

Develop and contribute

Open the tagged source to read the implementation and examples. Include the smallest reproducible Blyx program, compiler version and expected result when reporting an issue.