ebml-webm 0.2.1

Sans-IO EBML/WebM mux + demux (Segment/Tracks/Cluster/SimpleBlock subset)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

# ebml-webm

<p align="center">
  <a href="https://docs.rs/ebml-webm"><img src="https://img.shields.io/docsrs/ebml-webm" alt="docs.rs"></a>
  <a href="https://crates.io/crates/ebml-webm"><img src="https://img.shields.io/crates/v/ebml-webm.svg" alt="crates.io"></a>
  <a href="https://github.com/nyxways/mediaway"><img src="https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue" alt="License"></a>
</p>

> **Status:** early development (`0.x`). Not recommended for production; public APIs may
> change without notice. Part of the [Mediaway](https://github.com/nyxways/mediaway)
> media stack.

Sans-IO EBML / WebM mux and demux. Demux handles the common Matroska/WebM profile —
`SimpleBlock` and `BlockGroup` frames, Xiph/fixed/EBML lacing, `Cues`/`SeekHead`
(index) — and mux writes spec-valid WebM with known-size clusters. Pure state machine:
push bytes in, poll frames out; no I/O in the core.

## Quick start

```rust
use ebml_webm::mux::{Live, Muxer};
use ebml_webm::types::{Bytes, TrackInfo};

let mut muxer = Muxer::new();
muxer.add_track(TrackInfo {
    track_number: 1,
    track_type: 1, // video
    codec_id: "V_VP9".to_owned(),
    codec_private: None,
    width: 1920,
    height: 1080,
    sample_rate: 0.0,
    channels: 0,
})?;

let mut muxer: Muxer<Live> = muxer.begin();
muxer.push_frame(1, 0, true, &vp9_keyframe)?; // track, timecode, keyframe, payload
muxer.flush();

let mut webm = Vec::new();
muxer.poll_bytes(&mut webm);

// Demux: feed bytes, poll frames — the index is exposed informationally.
let mut demuxer = ebml_webm::Demuxer::new();
demuxer.push_bytes(&webm);
while let Some(frame) = demuxer.poll_frame() { /* … */ }
let _index = demuxer.cues();
```

## Status

Status marks: ✅ first-class (tests for claimed scope) · ⚡ Zero-Copy path (no payload copy; implies ✅) · 🆗 best-effort / prototype · 🛠️ planned · ❌ attempted and genuinely blocked · 👻 not exercisable yet (no hardware / device / session available)

| Area | Status | Notes |
| ---- | ------ | ----- |
| Demux: EBML VINT, `Segment`/`Tracks`/`Cluster`/`SimpleBlock` | ✅ | |
| Demux: lacing (Xiph, fixed, EBML), `BlockGroup`/`BlockDuration` | ✅ | |
| Demux: `Cues` / `SeekHead` index | ✅ | Exposed informationally; no seeking in the core |
| Mux (typestate `Open` → `Live`) | ✅ | Known-size clusters, `SimpleBlock` only (no lacing on write) |
| Indefinite-size `Cluster` lookahead (live streams) | 🛠️ | Open-element stack grows until `Segment` closes |
| Mux-side lacing | 🛠️ | Demux already reads all three lacing kinds |

## Docs

- [`docs/roadmap.md`](docs/roadmap.md) — stages, deferred items, design decisions
- [`mediaway-container`](../mediaway-container/) — Mediaway-typed `webm` surface over this crate
- Root [README](../../README.md) — container support matrix

## Contributing

Contributions are welcome — open an issue or pull request at
[github.com/nyxways/mediaway](https://github.com/nyxways/mediaway).

## License

MIT OR Apache-2.0.