Files
Piik/docs/adr/0014-browser-node-local-encoding-pool.md
T
AAA 799d6efb4a fix: improve sharing recovery and UI feedback
## Problem and outcome / 问题与结果

Browser sharing can remain connected to a local encoding transport that never becomes usable, leaving viewers without frames. This phase bounds that startup at eight seconds and restores ordinary encoding through the existing failure path. It also keeps ready App services running after a browser-open failure, preserves user presentation/playback choices, and aligns room feedback, illustrated hints, metrics and documentation.

部分环境下,本机编码连接一直无法建立会让观众收不到画面。本轮在八秒后进入现有降级流程,同时修复客户端启动移交、播放状态和前端反馈的一致性问题,并更新官网与中英文教程。

Closes #399.

Related: #396. The release contains relevant startup/error-handling repairs, but the reporting machine has not been retested. Keep this issue open for a current-build result. #401 (optional Windows capture-border hiding) remains deferred.

Release / 发布版本:**v1.3.1**.

## Release notes

### 中文

- 客户端记住上次确认的启动模式;启动移交保留已保存的语言、纯视觉模式和主题选择。
- 系统浏览器未能自动打开时,客户端继续运行,并在终端保留页面地址、重试入口和具体错误。
- 改善浏览器共享画面的启动兜底,避免 App 媒体因短暂信令中断被误判为失败。
- 音轨变化保持现有视频与观众的本机暂停状态;连接恢复和暂停恢复不再重复播放电视开机动画。
- 修复昵称编辑及长昵称查看,减少重复的角色提示,统一人物选择和连接状态的区别。
- 完善房间准入、密码和邀请说明;复制反馈对应当前链接及当前操作,避免迟到结果覆盖新反馈。
- 修正采集参数、统计单位与采样区间的展示,未知参数不再用配置上限代替。
- 统一提示漫画、状态图标与动效,改善选源器还焦、键盘操作、剧场布局和触控目标尺寸。
- 服务端默认支持 20 位观众,可在配置中设为 1–20 位,房主不占观众名额。
- 更新官网、教程入口和中英文说明,清理过时预览及失用代码。

兼容说明:使用旧版 App 连接更新后的站点时,站点会优先保留自己的显示偏好。如需更改语言或主题,请在进入后的页面调整。

### English

- Remember the last confirmed App launch mode and preserve saved language, visual-mode and theme choices during launch handoff.
- Keep the App running if the system browser fails to open, with the page address, retry action and error details available in the terminal.
- Improve the browser sharing startup fallback and avoid treating brief signaling outages as App media failures.
- Keep existing video and local pause state when audio tracks change. Reconnecting and resuming no longer replay the television startup animation over the picture.
- Fix nickname editing and full-name access, remove redundant role hints, and distinguish participant selection from connection state.
- Clarify room access, passwords and invitations. Copy feedback now belongs to the current link and operation, so late results cannot replace newer feedback.
- Correct capture details, metric units and observation intervals. Unknown capture values are no longer replaced with configured ceilings.
- Align illustrated hints, status icons and motion. Improve source-picker focus, keyboard operation, theater layout and touch targets.
- Default the Server to 20 viewers, configurable from 1 to 20. The host does not count toward that limit.
- Update the website, guide links and bilingual instructions, and remove obsolete previews and unused code.

Compatibility: when an older App connects to an updated Site, the Site keeps its saved presentation preferences. Change language or theme on the destination page when using an older launcher.

## Verification / 验证

Non-publishing [CI candidate run 34919320511](https://github.com/TNTcraftHIM/Piik/actions/runs/34919320511) passed Go core, race, Web checks, Server/container verification and all three native App package checks at source 188376e8. Subsequent commits only update deployment documentation, status and TODO; documentation/hygiene checks passed. Product inputs are unchanged.

- `npm run check`: TypeScript, 64 test files / 854 tests, and the Web production build passed.
- `npm run check:client-core`: final Go source passed tests, formatting, vet and core target builds. Windows capture compilation and geometry checks passed earlier in this phase; later edits did not change native capture.
- Website build, documentation checks, repository hygiene and diff checks passed. Existing documentation-size and bundle-size warnings remain.
- Actual browser flows covered sharing, source changes, pause/resume, late audio, brief signaling loss, invitation/copy feedback, entry preferences, source-picker focus, and narrow layouts.
- A local three-viewer P2P relay check covered quality-report expiry, recovery and cleanup without interrupting video. A controlled browser-helper failure returning `0xc0000005` left the real App launcher and Local service available.
- Homepage checks covered Chinese/English, light/dark preferences and inline-film open/close after removing the separate-page entry.

Limits: no new reporter-machine confirmation for #396 or the Windows URL-handler crash; physical Safari/mobile, macOS/Linux capture and wider public-network/endurance coverage remain deferred. Formal release artifacts will be built from the approved squash-merge revision. Hero-loop controls and video-adjacent tooltip placement remain open design items in TODO.

## Impact / 影响

Compatible patch; signaling, Native control and capture contracts are unchanged. Older App launch handoff keeps the updated Site's saved presentation preferences. The Server's default viewer limit is corrected to 20; an explicit 1–20 configuration remains valid.

Service updates retain persisted room authority but restart active media sessions. Deploy the verified immutable Server artifact through the existing bounded health/recovery process. Public Demo remains open and P2P-only; deployment does not enable SFU or change infrastructure/configuration.
2026-09-15 10:13:29 +08:00

8.2 KiB

ADR-0014: Browser Node-Local Encoding Pool

  • Status: Accepted; bounded implementation evidence complete, broader limits in verification status
  • Date: 2026-09-09

Context

The Browser pool research proves that an independent local WebRTC encoder can supply real video to multiple outgoing senders. The initial standard payload-only transform retained carrier metadata and failed intermittent VP8 startup checks. The selected refinement uses Chromium's existing encoded-stream API to retain the producer's encoded payload/type and exposed codec metadata, with the outgoing stream's RTP clock. It avoids making one downstream connection the shared encoding authority. Small carrier encodes and local transport/decoder work remain real costs. Measured savings and recovery vary by codec; the prototype is not production acceptance.

This decision extends ADR-0007 and ADR-0013 for eligible Browser outputs. Their ordinary Browser path remains available. The existing Native composition in ADR-0011 remains independently owned.

Decision

  1. A Browser source owner manages a bounded set of local encoding groups for its direct children. Compatible consumers reuse one group; a missing compatible output may require another group. No ancestor lookup, extra upstream subscription, room-wide minimum or topology operation is introduced.
  2. Each group uses stock WebRTC encoding and adaptation through an independent local producer. Each outgoing connection retains stock ICE, DTLS-SRTP, bandwidth estimation, RTP packetization, pacing and loss recovery. Piik connects existing demand observations to group budgets and membership; it adds no congestion estimator, quality score or arbitrary resolution ladder.
  3. Reuse HostPeer and its existing signaling, sender-mutation and retirement owners. A connection-owned encoded output stays attached across source changes. It copies complete producer frames, preserving codec/reference metadata, and assigns the outgoing carrier's RTP timestamp. A scaled source clone bootstraps negotiation; once the producer supplies real frames, the existing track-replacement owner installs a tiny CPU-resident Canvas carrier. Producer frame events drive it directly, without an independent clock timer or Worker. This avoids processing a full received decoder surface for every carrier. Chromium's createEncodedStreams() path is required for this composition. Do not force this through the standard RTCRtpScriptTransform owner restrictions, use feature flags to weaken them, or fabricate native frame statistics. Unsupported APIs use ordinary senders.
  4. Group compatibility includes source-track identity/generation, negotiated codec and codec parameters, Host ceilings, content intent, degradation preference and effective demand. Adapted dimensions alone are insufficient. Update an owned group's rates in place; a new observation does not itself require recreating an encoder. Re-evaluate pending membership when a shared producer outgrows a waiting child's allocation; it cannot depend on bandwidth growth before delivering its first frame. Unproven compatibility uses ordinary encoding.
  5. The original captured or received track remains intact for presentation and source ownership. Producers own their input clones; outgoing bindings own their carriers. Group queues, retained frames and references are bounded by admitted consumers and existing prepared operations. Last-use retirement closes unused producers and local connections. The outgoing encoded stream belongs to its PeerConnection, so replacing a source cannot detach it or create a second writer. Audio passes through the same API unchanged.
  6. Live settings and source replacement follow the existing requested/applied boundary. Prepare the replacement while retaining healthy output, reject stale completion, and release the old group only after the owning operation commits. Failure preserves the prior applied state. Pause synchronously gates borrowed payload, including pending output; stop cancels pending preparation and releases resources. Local transport startup is bounded so a stalled producer yields to ordinary encoding before the outer route readiness deadline. Both local connections must connect; once connected, a quiet or paused source is not evidence of failure.
  7. Switching requires an accepted recovery frame and compatible key/delta, dependency, codec and packetization metadata. Preserve ordering and discard obsolete data only at a valid recovery boundary. Carrier timestamps and sender reports must remain consistent with real content and audio timing. A copied frame does not preserve every internal native capture timestamp; paired source-age and played-audio measurements are required. Current H264/VP8 connections do not negotiate generic dependency descriptors and do not need another frame-ID mapping layer. Browser feature flags that relax ownership or metadata checks are not a product dependency.
  8. Keep producer, carrier, actual egress and receiver observations distinct. Receiver details use inbound decoded dimensions/FPS and received-byte rates. Fresh receiver reports remain authoritative for remote delivery details. Carrier dimensions, encode time and limitation reason describe its tiny encoder; they cannot establish real-picture quality or per-child CPU cost. Preserve raw RTCStats and report unknown when actual-media attribution is unproved. Quality convergence requires evidence from the attached output and the same receiving connection, not substituted shared-producer counters.
  9. Browser-to-Native ingress, dedicated ordinary recovery candidates and the SFU publisher remain distinct compositions. Do not add redundant pooling behind Native encoded fanout. SFU integration must preserve its existing two-RID representation policy, demand activation and aggregate publication budget; declaring carrier dimensions or silently collapsing it to one RID is invalid. Unsupported APIs and unproven compositions retain the ordinary Browser path.

Acceptance And Consequences

Activation requires codec-specific evidence for late join, constrained-child entry/recovery, unaffected siblings, dependency correctness, synchronized A/V, pause, settings/source rollback, producer failure and bounded retirement. Compare useful delivery and whole-node CPU/GPU cost with ordinary senders; fewer full-size encodes alone do not justify adoption. Sampling intervals, test budgets and fixture thresholds remain research evidence, not product rules. Implementation and physical acceptance are tracked in TODO.

API And Primary References