ustreamer-capture 0.1.0

GPU frame capture from wgpu render targets — zero-copy (Metal/NVENC) and staging buffer paths
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

# ultra-streamer-rs

Stream any Rust/wgpu application to a web browser with GPU hardware encoding and sub-30ms LAN latency.

## Overview

Capture GPU frames from your `wgpu` render loop, encode with platform-native hardware encoders, and stream to Chrome/Chromium via WebTransport or WebSocket. The browser decodes with WebCodecs and forwards user input back to the host.

## Target Hardware

| Platform | Encoder | Capture |
|---|---|---|
| **Apple Silicon** (M1+) | VideoToolbox HEVC | Metal IOSurface zero-copy |
| **NVIDIA** (RTX 20+) | NVENC HEVC/AV1 | Vulkan external memory → CUDA |
| **AMD** (RDNA2+) | AMF HEVC | CPU staging fallback |

## Workspace

```
crates/
├── ustreamer-proto      # Wire protocol types
├── ustreamer-capture    # GPU frame capture
├── ustreamer-encode     # HW video encoding (VideoToolbox, NVENC, AMF)
├── ustreamer-transport  # WebTransport + WebSocket server
├── ustreamer-input      # Browser input mapping
├── ustreamer-quality    # Adaptive quality controller
├── ustreamer-app        # Integration traits for external apps
├── ustreamer-demo       # Headless demo server
└── ustreamer-nvenc-probe # NVENC validation harness (Windows)

client/                  # Browser client
```

## Quick Start

```bash
# macOS (VideoToolbox)
cargo run -p ustreamer-demo

# NVIDIA (direct NVENC)
cargo run -p ustreamer-demo --features nvenc-direct

# AMD (direct AMF)
cargo run -p ustreamer-demo --features amf-direct

# Auto-detect GPU vendor (recommended for mixed hardware)
cargo run -p ustreamer-demo --features nvenc-direct,amf-direct
```

Then open `http://127.0.0.1:8090/` in Chrome/Chromium.

The demo auto-detects your GPU and selects the best encoder. Build with `nvenc-direct,amf-direct` when you want one Windows/Linux binary that can choose NVIDIA or AMD at startup. Override with `--codec hevc|av1` or `--nvenc-device <n>` if needed.

## Building

```bash
cargo build
cargo test
```

## Publishing

```bash
scripts/publish-crates.sh list       # show release order
scripts/publish-crates.sh stage1 --dry-run
```

Stages: `proto`/`capture` → `input`/`quality`/`transport`/`encode` → `app`

## Architecture

See [PLAN.md](./PLAN.md) for the full design document.

## License

MIT OR Apache-2.0