Files
Piik/docs/adr/0007-path-isolated-representation-quality.md
T
AAA cdd503a98d feat: improve feedback and App lifecycle reliability (#404)
Waiting feedback and tooltips now share consistent presentation lifecycles, while App shutdown and native-media operation failures stay within their owning session or output. This phase also consolidates the project standards and publishes searchable English/Chinese reader documentation alongside the homepage.

Validation: repository hygiene and Markdown links; TypeScript, 971 Web tests and production build; website/documentation build; Go tests, vet and Windows/Linux builds with Windows capture checks; desktop/mobile UI and documentation review. Linux race, container and three-platform packaging checks run in the release pipeline. Physical macOS/Linux capture and broader network coverage remain outside this acceptance.

The owner approved v1.4.0 publication. Existing empty-source, Windows URL-handler and public-invitation timeout reports remain tracked; this release makes no claim to resolve those device/network reports. The Windows capture-border request is next-phase work.

## Release notes

### 中文

这是一次以稳定性和交互一致性为重点的功能更新。等待与提示更有反馈,App 启动、原生分享和连接恢复的边界处理得到改善,使用与部署指南也有了统一的文档中心。

#### 新增与改进

- 欢迎语、等待短句和六类可轮换的标签页标题共用一致的显示规则。等待短句从一开始就出现,并在停留时轮换;明确的错误与操作提示保持固定。
- 房间准入等漫画采用更克制的小人物与循环动效。改进 tooltip 的定位与指向,减少对播放器的遮挡;状态、图标和文案保持相同含义。
- 新增中英文文档中心,提供搜索、手机目录、使用教程、问题排查与自部署指南。官网 FAQ 聚焦开始使用前的问题,详细排查统一进入文档中心。

#### 修复

- 使用 `--local` 启动不再清空已保存的 Piik 站点地址。
- 打开系统浏览器不再阻塞 App 的退出流程;改进临时公网邀请、终端和诊断导出在关闭时的清理及错误反馈。
- 单条原生媒体连接的操作失败不再被误判为整个会话的协议错误;重复停止分享保持幂等。
- 修复连接替换、转发停止和异常退出时的部分资源清理问题,避免迟到结果影响当前连接。
- Windows 原生采集中,单个输出的编码错误只结束对应输出;共享采集源本身的错误仍会结束分享。

#### 升级与已知边界

本次保持现有协议版本与配置格式。更新 App 或自托管 Server 后,重新打开页面即可使用对应的新界面。

个别设备的空窗口列表、Windows 浏览器启动异常,以及 Linux 编码输出的故障隔离仍在跟进。macOS/Linux 的物理采集和更广泛的公网网络场景仍需实机验证;本次不宣称这些问题已经解决,也不承诺所有网络都能直连。

### English

This feature update focuses on stability and consistent feedback. Waiting states are easier to follow, App startup and native sharing handle several failure cases more reliably, and the new documentation center brings usage and deployment guides together.

#### New and improved

- Welcome lines, waiting captions and six groups of rotating tab titles follow one presentation lifecycle. Waiting captions appear immediately and rotate while visible; actionable errors and instructions remain fixed.
- Room-admission comics use restrained characters and looping motion. Tooltips point more accurately to their controls and interfere less with the player, with consistent meanings across illustrations, icons and copy.
- A new English/Chinese documentation center includes search, mobile navigation, usage guides, troubleshooting and self-hosting. The homepage FAQ covers questions before getting started and links to the documentation for detailed help.

#### Fixes

- Starting with `--local` no longer clears a saved Piik site address.
- Opening the system browser no longer blocks App shutdown. Temporary public invitations, the terminal and diagnostic exports handle cleanup and exit errors more consistently.
- An operation failure on one native media connection no longer becomes a protocol failure for the entire session. Repeated stop-sharing requests are safe.
- Fixed cleanup cases during connection replacement, relay shutdown and unexpected exits, preventing late results from affecting the current connection.
- On Windows, an encoder failure for one native output stops that output only. A failure of the shared capture source still ends sharing.

#### Updating and known limits

Protocol versions and configuration formats are unchanged. After updating the App or your self-hosted Server, reopen the page to use its updated interface.

Empty source lists on some devices, Windows browser-launch failures and Linux output-failure isolation remain under investigation. Physical macOS/Linux capture and broader public-network coverage still need device testing; this update does not claim to resolve those cases or guarantee a direct connection on every network.
2026-09-16 13:13:06 +08:00

9.9 KiB

ADR-0007: Framework-Owned Media Quality Adaptation

  • Status: Accepted
  • Date: 2026-08-19
  • Last reviewed: 2026-09-01

ADR-0013 supersedes the external SFU SDK, Dynacast-service and single-output Native assumptions for the current candidate. Browser source intent, codec selection and framework-owned adaptation remain. Historical evidence below is not acceptance of the shared Native/embedded-SFU implementation; media quality owns current behavior.

Context

Piik sends one realtime game-screen source through independent P2P connections and, when needed, one shared LiveKit publication. WebRTC and LiveKit already own congestion control, encoder adaptation, retransmission, simulcast construction, subscriber bandwidth estimation, and layer selection.

Earlier experiments added a Piik-defined lower SFU encoding and treated quality preference as an application policy. Production evidence showed that an always-active lower encoding can compete with the highest encoding on a constrained Host-to-SFU path. It did not justify replacing LiveKit's native adaptation with a single HIGH representation or another application controller.

The product needs standard game-motion intent and user-selected ceilings, but it does not need a second bitrate, resolution, FPS, or layer-control system.

Decision

  1. Browser video makes one internal, share-generation-scoped codec decision per sending endpoint. A bounded actual-RTCPeerConnection preflight measures H.264 encoded progress against a deterministic moving probe track at the current share's effective target dimensions and frame rate. The real capture supplies those target settings, but its current motion does not decide encoder capability. A proved sender prefers H.264 and retains VP8 as the native negotiation fallback; an unsupported, inconclusive, slow, or failed preflight uses VP8 only. The Host advanced settings expose one local VP8 | Auto | H264 selector with Auto default: it is editable only before a share, strict H264/VP8 bypass the gate, and share start locks it. Viewer relay senders remain Auto. The selection is not persisted or inferred from UA, GPU, capability advertisement, or powerEfficientEncoder alone; it creates no room state, wire field, or active-edge codec switching.
  2. Display video uses the standard contentHint = "motion"; display audio uses contentHint = "music". The hint expresses content intent and does not promise a resolution, frame rate, bitrate, encoder, or hardware path.
  3. The three recommended profiles and advanced controls supply capture and sender ceilings plus degradationPreference. Every sender reads back the parameters that the browser actually accepted.
  4. Every direct, Browser-relay, and Host SFU video sender owns one MediaStreamTrack clone. The original capture or received track remains a source and local presentation track and is never attached directly to an outbound sender. The sender owner retains the game-motion content intent and current enabled state, applies live Host capture constraints to Host-owned clones, and stops the clone on replacement, rollback, failure, unpublish, or teardown. After accepting an answer, the Host still reapplies the current video profile to the negotiated sender because the browser may replace or rewrite encoding parameters during negotiation.
  5. Auto direct and Browser-relay offers with a proved sender order H.264 before VP8 in one standard codec-preference list; endpoints select their first common codec without a parallel media connection. Failed Auto or manual VP8 offers VP8 only; manual H264 offers H.264 mode 1 only. Existing edges are not renegotiated when a later relay gate completes; its result applies to future children.
  6. The SFU publisher uses the Host source decision and one sender-owned clone for its publication, disables backup codec, sets the selected HIGH ceiling and degradation preference, but does not set screenShareSimulcastLayers, mutate lower encodings, or select a subscriber layer. Pinned LiveKit defaults own the selected codec's representation set and source-replacement/republish behavior.
  7. LiveKit Dynacast and server send-side BWE remain enabled. AdaptiveStream remains disabled because a Viewer may relay its received track to peer children; local DOM size or visibility cannot represent that downstream demand.
  8. WebRTC and LiveKit remain the media-adaptation owners. ADR-0005's deployed native-edge convergence may consume only a persistent categorical limitation from the exact sender and comparative delivery proof from the same Viewer over a real prepared candidate. It does not set bitrate, resolution, FPS, or layer, infer a physical bottleneck, or combine quality measurements into a score. A native App P2P edge obtains that category from Pion GCC: after real transport feedback and encoded-frame progress, a target payload bitrate below the source's measured H.264 plus Opus payload is bandwidth; sufficient target payload is none; missing feedback or source progress is unknown. Pion observes through an immediate no-queue pacer and does not rewrite the shared encoder or own another adaptation policy.
  9. A healthy decoded route remains sticky. Manual media reconnect rebuilds the current exact P2P parent or current SFU subscription; it does not search for a better parent. If current-route recovery genuinely exhausts, ADR-0005's existing controller tries other eligible P2P parents before SFU.

Evidence Boundary

Chrome 151 production measurements established three durable facts:

  • direct and browser-relay VP8 can sustain about 60 fps after stock bandwidth estimation warms up; sender ceilings are not startup guarantees;
  • forcing an always-active lower SFU encoding can reduce the highest encoding on the same Host-to-SFU congestion budget; and
  • pinned LiveKit 2.22.0 plus server 1.13.5 can select lower and higher VP8 screen-share representations per subscriber when server send-side BWE is enabled.

Separate content-hint probes showed that motion changes Chromium's adaptation tradeoff and may spatially downscale to preserve motion. That is the standard behavior requested for games, not a quality floor. Real-game readability, weaker Hosts, heterogeneous devices, and public-network SFU quality still require physical evidence.

The exact Chrome 151/153 comparison in realtime-quality research established why this decision is runtime-evidence driven: the cadence-failing AMD H.264 MFT and the full-cadence NVIDIA H.264 MFT both reported hardware efficiency. Source versus encoded-frame progress separated them. Chrome 153 then sustained the same H.264 path with two senders, Browser relay re-encoding, and one pinned LiveKit HIGH+LOW publication without backup codec.

A separate Chrome 151 display-capture experiment distinguished bare cloning from sender-owned clone generations. With a preview-only original track, a constrained sender could remain adapted after its bitrate budget recovered, but retiring that sender and its clone let a new clone return immediately to about 30 fps at high resolution. Simultaneous clones still showed transient shared- source interference, so this decision prevents adaptation inheritance rather than claiming complete source isolation.

Consequences

  • Piik owns fewer media mechanisms and follows the pinned frameworks' supported control surfaces.
  • A capable Browser Host or relay can use H.264 hardware encoding while another sender remains on VP8 without a room-protocol branch; the Host can explicitly override one future share for diagnosis or preference.
  • A constrained Viewer may receive a lower LiveKit representation without lowering every subscriber, subject to the publisher and network actually sustaining the framework contract.
  • A retired sender cannot leave its adapted video track attached to the source generation used by a replacement sender. Cloning adds one track adapter per outbound video sender but no additional capture or encoder beyond the sender that already exists.
  • A Host may need to lower its explicit share profile when encoder or uplink capacity is insufficient; Piik does not silently remove constrained Viewer support.
  • ADR-0005's native-edge local convergence is deployed and performs bounded real-candidate comparisons without owning media adaptation. Weighted or global topology optimization still requires another route-model decision.

Stop Lines

  • No Piik resolution/FPS/bitrate ladder or representation formula.
  • No codec wire/state, GPU/MFT allowlist, persistent codec cache, parallel VP8/H.264 route, active-edge codec churn, or LiveKit backup publication. The local pre-share Host selector is the only manual codec surface.
  • No manual SFU layer selector, forced single HIGH publication, or per-Viewer encoder.
  • No quality score, all-pairs probing, periodic rebalancing, or parent switching outside ADR-0005's native-edge operation.
  • No AdaptiveStream while a subscriber can relay the track.
  • No claim that track clones isolate their shared underlying media source.
  • No quality or hardware claim from configured options alone.

References