Skip to content

PROGRESS_LOG.md

Latest commit

 

History

History
134 lines (118 loc) · 6.33 KB

PROGRESS_LOG.md

File metadata and controls

134 lines (118 loc) · 6.33 KB
Raw

Progress Log

2026-02-23 — Initial Evaluation

Phase 1: Foundations — COMPLETE

  • Workspace structure (Cargo.toml, agua-core, agua-cli)
  • error.rs — Error enum with thiserror
  • key.rs — WatermarkKey + AES-PRNG (6 tests)
  • fft.rs — FFT wrapper with round-trip tests (3 tests)

Phase 2: Core Algorithm — COMPLETE

  • config.rs — WatermarkConfig with defaults
  • payload.rs — 128-bit payload + CRC-32 (5 tests)
  • patchwork.rs — Single-frame embed/detect (5 tests)
  • codec.rs — Convolutional encoder + Viterbi decoder (7 tests)

Phase 3: Integration — COMPLETE

  • sync.rs — Sync generation + correlation detection (5 tests)
  • frame.rs — Windowing + overlap-add (3 tests)
  • embed.rs — Full embedding pipeline (3 tests)
  • detect.rs — Full detection pipeline + round-trip test (3 tests)

Phase 4: Streaming + CLI — COMPLETE

  • stream.rs — StreamEmbedder / StreamDetector (1 test)
  • agua-cli — CLI binary (embed/detect commands)
  • WAV integration tests (4 tests: f32 round-trip, i16 quantization, 44100 Hz, streaming embed)
  • Criterion benchmarks (embed, detect, streaming, FFT)

Phase 5: Robustness, Parallelism & Licensing — COMPLETE

  • LICENSE-MIT and LICENSE-APACHE files added
  • WatermarkConfig::robust() constructor (strength 0.05 for lossy codec survival)
  • MP3/AAC/Opus round-trip robustness tests (8 tests, #[ignore], require ffmpeg)
  • Parameter tuning sweep test (#[ignore], strength x codec matrix)
  • Optional rayon parallelism (parallel feature: embed_parallel, detect_parallel)
  • Parallel benchmarks (embed + detect)

Phase 6: GStreamer Plugin — COMPLETE

  • agua-gst crate added to workspace
  • aguawatermarkembed GStreamer element (BaseTransform, in-place processing)
  • Properties: key, payload, strength, frame-size, num-bin-pairs, min-bin, max-bin, offset-frames, profile
  • Multi-channel support (per-channel embedding with independent frame tracking)
  • No tests yet for agua-gst

Phase 7: WASM Web Demo — COMPLETE

  • agua-web crate added to workspace (wasm-bindgen + web-sys)
  • WasmDetector WASM wrapper around StreamDetector
  • PreProcessor bandpass filter + RMS normalization for mic input
  • Browser UI: real-time mic detection, offline WAV detection, demo player
  • AudioWorklet + Web Worker architecture
  • Acoustic detection confirmed on iPhone (strength 0.08+) and macOS

Phase 8: StreamDetector Combining — COMPLETE

  • Sub-frame alignment search (8 offsets) for first combining block
  • extract_data_soft_near() with position-hinted candidate selection
  • extract_data_soft_at() for extraction at known sync position
  • find_best_sync() for cheaper sync-only search
  • Drain fix: drain to start of next block (eliminates ~23s gap)
  • Increased max_combine_blocks from 3 to 5
  • 4 new combining tests (end-to-end, large buffer, resets, soft combine)

Outstanding Issues

  • No tests for agua-gst

Test Summary

  • 59/59 tests passing (55 unit + 4 WAV integration), default features
  • 62/62 tests passing with --features parallel (adds 3 parallel unit tests)
  • 22 additional #[ignore] tests (9 acoustic simulation, 8 lossy codec, 5 parameter tuning)
  • cargo fmt --all --check — clean
  • cargo clippy — 0 warnings in agua-core

Benchmark Results (release build)

Benchmark Time Real-time ratio
embed_1s_48khz 223 µs ~4500x real-time
detect_22s_48khz 4.9 ms ~4500x real-time
stream_embed_1s (4096 chunks) 266 µs ~3760x real-time
stream_detect_22s (4096 chunks) 4.7 ms ~4680x real-time
fft_forward_inverse_1024 18.6 µs —

Conclusion: easily real-time capable — thousands of times faster than real-time for both embedding and detection.

Git History

Commit Description
f9366e8 feat: implement Agua audio watermarking library
5e6f2dc test: add WAV integration tests and criterion benchmarks
a8b011b some additions
8e4f0ae fix: correct GStreamer plugin lib name for symbol resolution
89db9a4 feat: add robustness tests, rayon parallelism, and license files (Phase 5)
d1e0948 feat: add GStreamer plugin for agua audio watermarking
dc9cf6b chore: add agua-gst to workspace and fmt agua-cli

Workspace Crates

Crate Type Description
agua-core lib Core watermarking library (15 modules, 62 tests w/ parallel)
agua-cli bin CLI for embed/detect on WAV files
agua-gst lib (cdylib) GStreamer plugin element aguawatermarkembed
agua-web lib (cdylib) Browser WASM demo (real-time mic detection)

Files Implemented

Module Tests Status
agua-core
lib.rs — Public API re-exports
error.rs — Error types
key.rs 8 AES-PRNG bin selection
fft.rs 3 realfft wrapper
config.rs 3 Configuration + robust()
payload.rs 5 128-bit payload + CRC
patchwork.rs 4 Core embed/detect per frame
codec.rs 6 Conv. encoder + Viterbi
sync.rs 5 Sync pattern + correlation
frame.rs 3 Windowing + overlap-add
embed.rs 3 Embedding pipeline
detect.rs 3 Detection pipeline
preprocess.rs 3 Bandpass filter + RMS normalization
stream.rs 9 Streaming wrappers + soft combining
parallel.rs 3 Rayon parallel embed/detect (feature-gated)
tests/wav_round_trip.rs 4 WAV file integration tests
tests/acoustic_simulation.rs 9 Acoustic channel simulation (ignored)
tests/lossy_codec_round_trip.rs 8 MP3/AAC/Opus robustness (ignored)
tests/parameter_tuning.rs 5 Strength/spacing sweeps (ignored)
benches/throughput.rs 5+2 Criterion benchmarks (+ parallel)
agua-cli
main.rs — CLI binary (embed/detect commands)
agua-gst
lib.rs — Plugin registration
embed.rs — AguaWatermarkEmbed BaseTransform element
agua-web
src/lib.rs — WASM wrapper (WasmDetector)
static/app.js — Browser UI + offline detection
static/worker.js — Web Worker for WASM processing
static/processor.js — AudioWorklet sample forwarder