Blyx

Spoonbill

Workflow framework · 0.1.0

Preflight caption cue timings against an explicit overlap policy.

Detect overlapping captions in a rational time base

At 30 ticks per second the track spans two seconds. The second cue begins before the first one finishes.

Run the native CLI

Extract the workflow collection for your platform. Run .\bin\spoonbill.exe --help in PowerShell or ./bin/spoonbill --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.0 https://github.com/Rahulchaube1/blyx-spoonbill.git
cd blyx-spoonbill
blyxc native-run project.blyx -- "0,20" "30,60" 1 30 0

Why this framework exists

Two cues touching at one endpoint are consecutive; two cues occupying the same frame overlap. Apply a policy using exact tick boundaries. W3C, WebVTT cues

Install Spoonbill in your editor

Extension RahulChaube.blyx-spoonbill · 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-spoonbill-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 Spoonbill.

Download the companion Blyx Language VSIX

Libraries in this framework

Install with Conda

Create an environment containing Spoonbill 0.1.0, 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-spoonbill=0.1.0=0
blyxc native-run ./blyx-env/share/blyx/spoonbill/main.blyx

To use this package in your application, copy share/blyx/spoonbill/vendor/spoonbill 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.0 https://github.com/Rahulchaube1/blyx-spoonbill.git vendor/spoonbill

You can also download Spoonbill as a ZIP. Extract its contents into vendor/spoonbill.

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

use vendor::spoonbill::spoonbill;

fn main() {
    let starts = [0, 20];
    let ends = [30, 60];
    let numerator = 1.0;
    let denominator = 30.0;
    let allow_overlap = 0.0;
    let result = spoonbill_captions(starts, ends, numerator, denominator, allow_overlap);
    if len(result) == 0 { println!("invalid"); return; }
    let mut i = 0;
    while i < len(result) {
        println!(at(result, i));
        i += 1;
    }
}

Expected output

0
1
1
2

API and input requirements

Returns [accepted, overlapping cue count, first overlap index, cue-track span in seconds]. Some subtitle tracks allow overlaps; the caller chooses the policy. Invalid arguments and nonfinite results return an empty vector.

APIUse
spoonbill_captions(starts, ends, numerator, denominator, allow_overlap)Returns [accepted, overlapping cue count, first overlap index, cue-track span in seconds]. Some subtitle tracks allow overlaps; the caller chooses the policy.

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.