Blyx

Hoopoe

Workflow framework · 0.1.0

Plan a thumbnail and check the decoded pixel buffer against a byte budget.

Check a thumbnail buffer before allocation

A 400×200 image fits into 100×50 pixels. Three channels and four-byte alignment require 15,000 bytes, above the given budget.

Run the native CLI

Extract the workflow collection for your platform. Run .\bin\hoopoe.exe --help in PowerShell or ./bin/hoopoe --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-hoopoe.git
cd blyx-hoopoe
blyxc native-run project.blyx -- 400 200 100 100 3 4 14000

Why this framework exists

Encoded file size gives a poor estimate of decoded thumbnail memory. Account for output dimensions and scanline padding before allocating. Pillow, aspect-preserving containment

Install Hoopoe in your editor

Extension RahulChaube.blyx-hoopoe · 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-hoopoe-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 Hoopoe.

Download the companion Blyx Language VSIX

Libraries in this framework

Install with Conda

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

To use this package in your application, copy share/blyx/hoopoe/vendor/hoopoe 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-hoopoe.git vendor/hoopoe

You can also download Hoopoe as a ZIP. Extract its contents into vendor/hoopoe.

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

use vendor::hoopoe::hoopoe;

fn main() {
    let width = 400.0;
    let height = 200.0;
    let box_w = 100.0;
    let box_h = 100.0;
    let channels = 3.0;
    let align = 4.0;
    let memory = 14000.0;
    let result = hoopoe_thumbnail(width, height, box_w, box_h, channels, align, memory);
    if len(result) == 0 { println!("invalid"); return; }
    let mut i = 0;
    while i < len(result) {
        println!(at(result, i));
        i += 1;
    }
}

Expected output

100
50
300
15000
0

API and input requirements

Returns [output width, output height, aligned stride, bytes, fits budget]. Includes one output buffer with one byte per channel. Decoder and encoder overhead are outside this estimate. Invalid arguments and nonfinite results return an empty vector.

APIUse
hoopoe_thumbnail(width, height, box_w, box_h, channels, align, memory)Returns [output width, output height, aligned stride, bytes, fits budget]. Includes one output buffer with one byte per channel. Decoder and encoder overhead are outside this estimate.

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.