## Problem and outcome / 问题与结果 This phase adds lightweight room interaction without making media depend on chat, and adds Windows source-audio exclusion and optional SFU-only hosting at their existing owners. It also corrects confirmed encoder/capture ownership and native color-conversion defects. Host microphone commentary remains on the shared media path; room voice and 4K are outside this phase. ## Release notes ### 中文 这是一次功能更新:Piik 加入了文字聊天与表情互动,并完善了 Windows 声音采集、画面颜色和自部署选项。 #### 新功能 - **边看边聊。** 在可移动、可缩放的聊天窗口中发送消息,或开启弹幕。停止分享后,房间中的朋友仍可继续聊天。 - **表情互动。** 点击沙发上的人物,给自己发表情,或把番茄等表情送给朋友;各端按同一事件显示动画。 - **排除应用声音。** Windows App 分享整个屏幕时,可排除一个应用及其子进程的声音,适合同时使用语音软件。所选应用退出后,来源声音停止,避免恢复为未过滤的系统声音。 - **可选的纯 SFU 模式。** 自部署管理员可让共享画面和声音统一通过媒体服务器转发。默认仍为优先 P2P;App 公网邀请保持纯 P2P。 - **Windows HDR 转 SDR。** 原生采集与缩略图自动将 HDR 来源转换为 SDR,沿用现有观看链路。 #### 修复与改进 - 修复原生颜色转换的范围与矩阵处理,避免已复现的暗部丢失、高光裁切和颜色偏差。 - 修复共享编码器切换时使用过期需求或过期帧信息的问题,保护正在观看的画面;修复换源后旧采集事件可能影响新来源的问题。 - 统一新控件、浮窗与来源选择文案,补充中英文使用说明。 #### 使用与升级 聊天与表情需要新版站点页面和 Server;声音排除需要新版页面与支持此能力的 Windows App。聊天只保留本页最近收到的消息,刷新后清空,不补发历史,且不提供端到端加密。 HDR 转换输出为 SDR,不代表端到端 HDR 或多声道支持。既有房主麦克风与立体声能力保留。 ### English This feature update brings text chat and reactions to Piik, alongside improvements to Windows audio capture, picture colors and self-hosting options. #### New features - **Chat while watching.** Send messages in a movable, resizable window, or enable on-screen chat. Friends can keep chatting after the host stops sharing. - **Reactions.** Select a person on the sofa to react above yourself or send a tomato and other reactions to a friend. Participants animate the same shared event. - **Exclude application audio.** When sharing a whole screen with Windows App, exclude one application and its child processes, useful when using a separate voice app. Source audio stops if the selected app exits, preventing a return to unfiltered system sound. - **Optional SFU-only hosting.** Site operators can require shared video and audio to pass through the media server. P2P-first remains the default; App Public invite remains P2P-only. - **Windows HDR-to-SDR conversion.** Native capture and source thumbnails automatically convert HDR sources to SDR for the existing viewing path. #### Fixes and improvements - Correct native color-conversion ranges and matrices, addressing reproduced crushed shadows, clipped highlights and color shifts. - Correct stale demand and frame evidence during shared-encoder handoffs to protect the current picture. Prevent events from a replaced capture from affecting its successor. - Align new controls, floating panels and source-picker copy, with updated Chinese and English guides. #### Using this update Chat and reactions require updated site pages and Server. Audio exclusion requires updated pages and a Windows App that supports the capability. Chat retains only recent messages received by the current page, clears on refresh and does not replay history. It is not end-to-end encrypted. HDR conversion produces SDR; it does not add end-to-end HDR or surround sound. Existing host microphone commentary and stereo support remain available. ## Verification / 验证 - Web type checks, 78 test files / 1275 tests and production build: PASS. - Go core tests, formatting/vet and target builds: PASS; Darwin cgo remains platform-limited on this Windows runner. - Native build/check/color probes and synthetic HDR-to-SDR H.264/VP8 browser reception: PASS. - Access/privacy gate, Native H.264 SFU-only media gate and local Auto/H.264 Host gate: PASS. - Three real production pages: chat/reactions, stop/resume, idle-room join, host departure/return, offline draft recovery and invitation revocation: PASS. - Synthetic parent/child process-audio exclusion and target lifetime: PASS; no raw audio retained. - Windows candidate archive extraction and packaged Local startup/shutdown: PASS. - Documentation and website build: PASS. - [Candidate CI](https://github.com/TNTcraftHIM/Piik/actions/runs/36873766646) at `f26cd208d03bc0dcbe353f8cac217f993216b0a3`: Go core and race checks, Web tests, Server/container checks and Windows/macOS/Linux App packaging all PASS. Publication was skipped as intended. The owner accepted the UI/model and bounded local walkthrough for phase closure. Physical HDR/mixed displays, mobile keyboard, real voice applications across output devices and macOS/Linux capture remain unverified. Existing field reports without matched evidence are not claimed resolved. The owner authorized v1.7.0 publication on 2026-10-02. The final documentation-only commit records that authorization; product code matches the verified candidate above. ## Impact / 影响 Authorized version: **v1.7.0**, matching the local release planner. Current wire contracts remain Browser/server 23, Native control 9 and capture 7. Optional capabilities gate new functionality; existing room/media authority remains owned by the existing services. No new ports, message persistence, room voice or automatic room creation on page visit. Updated README, guides, standards, research evidence and TODO stay with the candidate phase.
105 lines
6.1 KiB
Markdown
105 lines
6.1 KiB
Markdown
# Project Instructions
|
|
|
|
## Authority And Scope
|
|
|
|
- Read and follow the complete repo-tracked
|
|
[`ponytail` skill](./.agents/skills/ponytail/SKILL.md) before coding, review,
|
|
or design work. It is required guidance for the smallest correct result;
|
|
project authority and delivery constraints remain owned here.
|
|
- Within higher-priority instructions, the latest explicit user decision defines
|
|
the task. Review, research, implementation, deployment, and cleanup grant only
|
|
the authority inherent in that task type.
|
|
- Model recovery from the smallest underlying authority and connection state.
|
|
Restart, crash, timeout, and network loss do not justify parallel states or
|
|
case-specific fallbacks when their required action is the same.
|
|
- Ordinary scoped work uses the lean path: inspect the affected owner and code,
|
|
make the smallest coherent change, run focused checks, inspect the diff, and
|
|
stage the requested files. Use the full integration/release path only for an
|
|
explicitly requested release or a material contract, route/security,
|
|
infrastructure, persistence, or irreversible change.
|
|
- Until a public release is explicitly declared, keep one current internal
|
|
contract. Delete replaced wire/config/API surfaces; do not add compatibility
|
|
aliases, dual readers/writers, migrations, or tests for stale private clients.
|
|
|
|
## Product Contract
|
|
|
|
- Piik is private screen sharing for one Host and up to 20 authenticated
|
|
Viewers, with Web Host/Viewer/relay as the current product surface.
|
|
- Current product truth is split by owner:
|
|
[rooms/access](./docs/standards/rooms-access.md),
|
|
[routing/transport](./docs/standards/routing-transport.md),
|
|
[media quality](./docs/standards/media-quality.md), and
|
|
[presentation/lifecycle](./docs/standards/presentation-lifecycle.md).
|
|
- Media stays automatic and defaults to P2P-first; central services provide room authority,
|
|
signaling, STUN, observability, and bounded embedded SFU/UDP fallback using
|
|
mature LiveKit media components under [ADR-0013](./docs/adr/0013-embedded-node-local-media.md). Route
|
|
changes must preserve the single-graph, single-operation model in
|
|
[ADR-0005](./docs/adr/0005-automatic-hybrid-media-routing.md).
|
|
- WebRTC and LiveKit own network and media adaptation. Do not add custom quality
|
|
scores, ladders, all-pairs probes, periodic rebalancing, or hand-built SFU
|
|
representations without a new accepted decision backed by primary evidence.
|
|
|
|
## Durable Truth
|
|
|
|
- Start substantial work by reading [project memory](./docs/project-memory.md),
|
|
[status](./docs/status.md), [TODO](./docs/todo.md), and only the relevant
|
|
product module, ADR, research, or operations document. Then inspect branch,
|
|
HEAD, status, staged diff, and worktrees.
|
|
- Use the [standards index](./docs/standards/README.md) and
|
|
[documentation owner map](./docs/standards/documentation.md#owners): product
|
|
behavior, engineering, visual language, versions, evidence and operations each
|
|
have one owner. TODO is the only work ledger; Git/PRs own completed history.
|
|
- Give every durable fact one owner. Update memory or status only when its compact
|
|
snapshot materially changes. Ordinary UI detail, protocol field listings,
|
|
self-evident code, test inventories, routine validation, and agent process do
|
|
not belong in long-lived product truth.
|
|
- If semantics remain disputed, record the hold in TODO and freeze only dependent
|
|
work. Never encode a guess as accepted truth.
|
|
|
|
## Safety
|
|
|
|
- Never commit credentials, TLS private keys, raw access tokens, or real user
|
|
data. Commit placeholders and document local secret injection.
|
|
- Keep media credentials short-lived and narrowly authorized. Do not log or
|
|
persist private media-path identifiers beyond their accepted owner.
|
|
- Block the current phase on P0 security, privacy, authorization, irreversible-
|
|
data, generation, bounded-resource, or rollback failure, and on P1 failure of
|
|
that phase's core path.
|
|
|
|
## Repository And Delivery
|
|
|
|
- Canonical root must be clean current `main` at audit/integration boundaries.
|
|
Create branches/worktrees from that exact commit; old branches and worktrees
|
|
are never truth sources.
|
|
- `main` remains low-frequency: one complete, user-accepted phase per squash PR,
|
|
with no intermediate release-record or cleanup commits. Keep implementation
|
|
on worktrees; [CONTRIBUTING.md](./CONTRIBUTING.md#full-integration-and-release-workflow)
|
|
owns the full workflow and explicit emergency exception.
|
|
- Preserve user work. Branch, truth-checkpoint, PR, release, recovery, and
|
|
cleanup rules are owned by [CONTRIBUTING.md](./CONTRIBUTING.md); do not mirror
|
|
that workflow here.
|
|
|
|
## Engineering Defaults
|
|
|
|
- Repeated meanings across code, UI, copy, configuration and lifecycle follow
|
|
one owned [contextual contract](./docs/standards/engineering.md#contextual-consistency).
|
|
Check related producers and consumers before adding another local rule;
|
|
preserve differences justified by authority, scope or user intent.
|
|
Use the [consistency review skill](./.agents/skills/context-consistency/SKILL.md)
|
|
for cross-cutting consistency work; ordinary changes check the affected family.
|
|
- UI changes must follow the shared [visual language](./docs/standards/visual-language.md):
|
|
cast, semantic colours, result panels and motion have one owner. Extend the
|
|
existing preview when adding a new meaning; do not invent scene-local rules.
|
|
- Follow [engineering and interface boundaries](./docs/standards/engineering.md):
|
|
simple cohesive modules, clear state/resource owners, mature reuse and narrow
|
|
contracts. After a material module, remove additions that the accepted result
|
|
does not need; total complexity matters more than marginal performance gains.
|
|
- [Versioning](./docs/standards/versioning.md) separates build identity, wire,
|
|
storage and live generations, and owns the public compatibility design.
|
|
The declared public release is the compatibility baseline for subsequent work.
|
|
- Use primary sources for non-trivial design and bugs. Add focused tests in
|
|
proportion to risk; batch full browser/network/endurance checks at acceptance.
|
|
- Keep scripts deterministic, fast, cross-platform and CI-runnable.
|
|
- Before finishing material work, inspect status, report untracked artifacts,
|
|
and stage requested files unless told otherwise.
|