Getting Started

This guide will help you get up and running with flo quickly.

Installation

CLI Tool (reflo)

From Source

# Clone the repository
git clone https://github.com/flo-audio/flo.git
cd flo

# Build and install
cd Build
cargo install --path crates/reflo-cli --manifest-path Cargo.toml

Pre-built Binaries

Download from GitHub Releases:

• reflo-linux - Linux x64
• reflo-macos - macOS x64
• reflo-macos-arm64 - macOS Apple Silicon
• reflo-windows.exe - Windows x64

Rust Libraries

Use libflo-audio for the codec or reflo for the higher-level raw-sample API:

[dependencies]
libflo-audio = { version = "0.1.2" }
# Or: reflo = { version = "0.1.2", default-features = false }

JavaScript (WASM)

npm install @flo-audio/libflo

Or use directly in HTML:

<script type="module">
  import init, { encode, decode } from './pkg-libflo/libflo_audio.js';
  await init();
</script>

Quick Examples

Convert a File (CLI)

# Lossless encoding (default)
reflo encode music.mp3 music.flo

# Lossy encoding with quality preset
reflo encode music.mp3 music.flo --lossy --quality high

# Decode back to WAV
reflo decode music.flo music.wav

# Show file info
reflo info music.flo

Encode in Rust

use libflo_audio::{Encoder, decode};

// Create encoder
let encoder = Encoder::new(44100, 2, 16);

// Your audio samples (interleaved f32, -1.0 to 1.0)
let samples: Vec<f32> = vec![0.0; 44100 * 2]; // 1 second stereo silence

// Encode
let flo_data = encoder.encode(&samples, &[]).unwrap();

// Decode
let decoded = decode(&flo_data).unwrap();

Encode in JavaScript

import init, { encode, decode, info } from '@flo-audio/libflo';

await init();

// Get samples from AudioBuffer or Web Audio API
const samples = new Float32Array(44100 * 2);

// Encode (lossless)
const floData = encode(samples, 44100, 2, 16, null);

// Decode
const decoded = decode(floData);

// Get info
const fileInfo = info(floData);
console.log(`Duration: ${fileInfo.duration_secs}s`);

Choosing Lossless vs Lossy

Quality Presets (Lossy)

Next Steps

• CLI Reference - Full command documentation
• JavaScript API - Browser integration
• Metadata Guide - Add titles, artwork, lyrics
• Streaming - Real-time playback