Files
AAA 1b9f5bd2a2 feat: add room interactions and media sharing improvements
## 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.
2026-10-02 01:36:45 +08:00

946 lines
33 KiB
Go

package route
import (
"crypto/sha256"
"errors"
"math"
"sort"
"strings"
"github.com/TNTcraftHIM/Piik/internal/server/ordered"
"github.com/TNTcraftHIM/Piik/internal/server/protocol"
)
const (
maxDirectHeadStartMs int64 = 5_000
maxNatConnectionAttempts = 4
sfuOpportunityPrefix = "sfu\x00"
maxSafeInteger int64 = protocol.MaxSafeInteger
qualityEvidenceExpiryMs int64 = protocol.ViewerQualityEvidenceExpiryMs
persistentDegradedWindows = int64(protocol.PersistentNativeEdgeDegradedWindows)
)
// candidateOpportunity is one consumed-ledger entry (TS CandidateOpportunity).
type candidateOpportunity struct {
rank int
startedAttempts int
exhausted bool
}
// participant is a known peer (TS Participant). sessionID "" is the TS
// null: disconnected but in grace, or departed. Wire session IDs are
// validated opaque IDs, so an empty string never names a live session;
// bootstrapFailureReported and sfuFirstAtNextRoute are TS `true | undefined`
// and only ever compared to true, so a bool is exact.
type participant struct {
peerID string
role protocol.Role
sessionID string
departureConfirmed bool
joinOrder int64
effectiveDownstreamCapacity int
availabilityExhausted bool
consumedCandidateOpportunities ordered.Map[string, candidateOpportunity]
bootstrapFailureReported bool
sfuFirstAtNextRoute bool
}
// sessionIs ports `participant.sessionId === id`: a disconnected
// participant (TS null) never equals any session string.
func (p *participant) sessionIs(id string) bool {
return p.sessionID != "" && p.sessionID == id
}
// senderQualityIdentity is TS SenderQualityIdentity.
type senderQualityIdentity struct {
childSessionID string
parentPeerID string
parentSessionID string
connectionID string
senderIdentity string
}
// attempt is the live candidate (TS Attempt). The optional strings use ""
// for undefined (they are only ever set to non-empty values or compared
// after a truthiness check); the optional timestamps are pointers because
// 0 is a legal accepted/sample time and `!== undefined` is semantic.
type attempt struct {
tuple CandidateTuple
revision int64
connectionID string
childSessionID string
parentSessionID string
hostSessionID string
publicationGeneration string
publicationConnectionID string
reservation CandidateReservation
startedAtMs int64
transportConnected bool
mediaReady bool
connectionAttempt *ConnectionAttemptProgress
senderQualityState SenderQualityState // "" = undefined
senderQualityAcceptedAtMs *int64
senderQualityConsecutiveHealthyWindows int64 // read only through `?? 0`
senderQualityConsecutiveDegradedWindows int64 // read only through `?? 0`
senderQualitySampleTimestampMs *int64
senderQualityIdentity string // "" = undefined
relativeQualityApprovedAtMs *int64
}
// operation is the single in-flight route operation (TS ChildOperation).
type operation struct {
childPeerID string
childSessionID string
demandPeerID string
demandSessionID string
reason DemandReason
baseRevision int64
candidates []CandidatePlan
cursor int
deadlineAtMs int64
builtAtFactVersion int64
deferredParentPeerIDs []string
peerAttemptStarted bool
qualitySource *senderQualityIdentity
current *attempt
}
// planAt ports `operation.candidates[index]`: nil when out of range. It
// returns a copy because the candidate array is spliced in place and TS
// plan objects are never mutated after construction.
func (o *operation) planAt(index int) *CandidatePlan {
if index < 0 || index >= len(o.candidates) {
return nil
}
plan := o.candidates[index]
return &plan
}
// planAtOrLast ports `operation.candidates[Math.min(cursor, length - 1)]`,
// which is undefined (nil) for an empty array.
func (o *operation) planAtOrLast() *CandidatePlan {
return o.planAt(min(o.cursor, len(o.candidates)-1))
}
// currentTuple ports `operation.current?.tuple ?? operation.candidates[operation.cursor]?.tuple`.
func (o *operation) currentTuple() *CandidateTuple {
if o.current != nil {
tuple := o.current.tuple
return &tuple
}
if plan := o.planAt(o.cursor); plan != nil {
return &plan.Tuple
}
return nil
}
// directContinuation is TS DirectContinuation; parentPeerIDs is the retry
// order and is spliced in place.
type directContinuation struct {
childSessionID string
sfuConnectionID string
publicationGeneration string
parentPeerIDs []string
}
type sfuBootstrapIntent struct {
demandPeerID string
demandSessionID string
}
type sfuBootstrapCarrier struct {
demandPeerID string
demandSessionID string
carrierPeerID string
}
// routeTimingRecord is TS RouteTimingRecord; the optional timestamps are
// pointers (undefined = never happened, distinct from 0).
type routeTimingRecord struct {
demandAtMs int64
reason DemandReason
operationStartedAtMs *int64
candidateStartedAtMs *int64
firstDecodedFrameAtMs *int64
finalAtMs *int64
finalRoute FinalRoute
rejectionBucket RejectionBucket
}
// routeQualityObservation is TS RouteQualityObservation. upstreamPeerID is
// "" for the sfu upstream (TS null); lastDecodedProgressAtMs nil is TS null.
type routeQualityObservation struct {
childSessionID string
upstreamKind UpstreamKind
upstreamPeerID string
connectionID string
presentationEpoch int64
eligibleWindows int64
eligibleDurationMs int64
freezeWindows int64
freezeCount int64
freezeDurationMs int64
pauseCount int64
pauseDurationMs int64
lastAcceptedAtMs int64
lastDecodedProgressAtMs *int64
}
// senderQualityObservation is TS SenderQualityObservation. The consumed
// ledger is a pointer because `{...previous}` copies carry the same Map.
type senderQualityObservation struct {
childSessionID string
parentPeerID string
parentSessionID string
connectionID string
senderIdentity string
state SenderQualityState
consecutiveDegradedWindows int64
lastSampleTimestampMs int64
lastAcceptedAtMs int64
consumedQualityCandidates *ordered.Map[string, int]
}
type sfuPublisherQualityObservation struct {
hostSessionID string
publicationGeneration string
state SenderQualityState
consecutiveHealthyWindows int64
lastSampleTimestampMs int64
lastAcceptedAtMs int64
}
// resourceSet is a JS Set<Resource>: pointer identity plus insertion order.
type resourceSet struct {
seen map[*Resource]struct{}
list []*Resource
}
func (s *resourceSet) add(resources ...*Resource) {
if s.seen == nil {
s.seen = make(map[*Resource]struct{})
}
for _, resource := range resources {
if _, ok := s.seen[resource]; ok {
continue
}
s.seen[resource] = struct{}{}
s.list = append(s.list, resource)
}
}
func (s *resourceSet) has(resource *Resource) bool {
_, ok := s.seen[resource]
return ok
}
// resources returns a fresh slice in insertion order (`[...set]`).
func (s *resourceSet) resources() []*Resource {
return append([]*Resource{}, s.list...)
}
// concatResources ports `[...a, ...b]` into a fresh, never-nil slice.
func concatResources(parts ...[]*Resource) []*Resource {
out := []*Resource{}
for _, part := range parts {
out = append(out, part...)
}
return out
}
// dedupeStrings ports `[...new Set(values)]`: first occurrence wins.
func dedupeStrings(values []string) []string {
seen := make(map[string]struct{}, len(values))
out := make([]string, 0, len(values))
for _, value := range values {
if _, ok := seen[value]; ok {
continue
}
seen[value] = struct{}{}
out = append(out, value)
}
return out
}
// New ports the constructor: panics with "Endpoint media copy capacity must
// be 1, 2, or 3" or "Route operation timeout must be a positive integer".
func New(options Options) *Controller {
if err := protocol.AssertEndpointMediaCopyCapacity(options.EndpointMediaCopyCapacity); err != nil {
panic(err)
}
if !isSafeInteger(options.OperationTimeoutMs) || options.OperationTimeoutMs <= 0 {
panic(errors.New("Route operation timeout must be a positive integer"))
}
if options.SfuOnly && !options.SfuEnabled {
panic(errors.New("SFU-only routing requires SFU availability"))
}
c := &Controller{
hostPeerID: options.HostPeerID,
debugRoomID: options.DebugRoomID,
debugLog: options.DebugLog,
endpointMediaCopyCapacity: options.EndpointMediaCopyCapacity,
operationTimeoutMs: options.OperationTimeoutMs,
sfuEnabled: options.SfuEnabled,
sfuOnly: options.SfuOnly,
qualityConvergenceEnabled: options.QualityConvergenceEnabled && !options.SfuOnly,
natPredictionEnabled: options.NatPredictionEnabled && !options.SfuOnly,
routeTimings: make(map[string]*routeTimingRecord),
qualityObservations: make(map[string]*routeQualityObservation),
senderQualityObservations: make(map[string]*senderQualityObservation),
senderQualityBaselines: make(map[string]bool),
senderQualityRegenerationBlocks: make(map[string]senderQualityIdentity),
qualityBaselinesPending: make(map[string]struct{}),
}
c.debug("controller-created",
"endpointCapacity", options.EndpointMediaCopyCapacity,
"operationTimeoutMs", options.OperationTimeoutMs,
"sfuEnabled", options.SfuEnabled,
"sfuOnly", options.SfuOnly,
"qualityConvergenceEnabled", options.QualityConvergenceEnabled)
return c
}
// DiagnosticParticipantLabel returns "host", "viewer-<joinOrder>" or
// "viewer-unknown" for a peer ID without exposing the ID.
func (c *Controller) DiagnosticParticipantLabel(peerID string) string {
return c.debugPeer(peerID)
}
// Revision is Snapshot().Revision without the graph copy, for the callers
// that only compare revisions before and after a mutation.
func (c *Controller) Revision() int64 { return c.revision }
// Operation is Snapshot().Operation without the graph copy: a deep copy of
// the in-flight operation, or nil when the controller is idle.
func (c *Controller) Operation() *OperationSnapshot { return c.operationSnapshot() }
// Publication is Snapshot().HostPublication without the graph copy: a copy
// of the single live SFU ingress, or nil when there is none.
func (c *Controller) Publication() *HostPublication {
if c.hostPublication == nil {
return nil
}
copied := *c.hostPublication
return &copied
}
// Snapshot returns a copy of the committed graph, the publication and the
// operation snapshot; it mutates nothing.
func (c *Controller) Snapshot() RouteSnapshot {
// The router iterates this map to build assignments.
upstream := &ordered.Map[string, CommittedEdge]{}
for id, edge := range c.upstreamByViewer.All() {
upstream.Set(id, *edge)
}
var publication *HostPublication
if c.hostPublication != nil {
copied := *c.hostPublication
publication = &copied
}
return RouteSnapshot{
Revision: c.revision,
Paused: c.paused,
FactVersion: c.factVersion,
UpstreamByViewer: upstream,
HostPublication: publication,
Operation: c.operationSnapshot(),
}
}
// RouteDiagnosticSnapshot returns the privacy-safe snapshot: connected
// viewers sorted by join order with snapshot-local ordinals and relative
// durations; operation is nil unless its demand peer has an ordinal.
func (c *Controller) RouteDiagnosticSnapshot(nowMs int64) protocol.RouteDiagnosticSnapshot {
viewers := []*participant{}
for _, current := range c.participants.Values() {
if current.role == protocol.RoleViewer && current.sessionID != "" && !current.departureConfirmed {
viewers = append(viewers, current)
}
}
sort.SliceStable(viewers, func(i, j int) bool { return compareParticipant(viewers[i], viewers[j]) < 0 })
ordinals := make(map[string]int, len(viewers))
for index, viewer := range viewers {
ordinals[viewer.peerID] = index + 1
}
children := make([]protocol.RouteDiagnosticChild, 0, len(viewers))
for _, viewer := range viewers {
edge, _ := c.upstreamByViewer.Get(viewer.peerID)
record := c.routeTimings[viewer.peerID]
finalRoute := c.currentFinalRoute(viewer.peerID)
childCount := 0
for _, childPeerID := range c.childrenOf(viewer.peerID) {
if childEdge, ok := c.upstreamByViewer.Get(childPeerID); ok && childEdge.Kind == UpstreamPeer && childEdge.PhysicalActive {
childCount++
}
}
child := protocol.RouteDiagnosticChild{
Ordinal: protocol.Int(ordinals[viewer.peerID]),
Parent: c.diagnosticParent(edge, ordinals),
EffectiveCapacity: protocol.Int(viewer.effectiveDownstreamCapacity),
ChildCount: protocol.Int(childCount),
FinalRoute: string(finalRoute),
RejectionBucket: string(RejectionNone),
Quality: c.diagnosticQuality(viewer.peerID, edge, nowMs),
}
if record != nil {
child.DemandAgeMs = elapsedMs(record.demandAtMs, nowMs)
if record.operationStartedAtMs != nil {
child.QueueWaitMs = elapsedMs(record.demandAtMs, *record.operationStartedAtMs)
}
if record.candidateStartedAtMs != nil {
child.CandidateStartMs = elapsedMs(record.demandAtMs, *record.candidateStartedAtMs)
}
if record.firstDecodedFrameAtMs != nil {
child.FirstDecodedFrameMs = elapsedMs(record.demandAtMs, *record.firstDecodedFrameAtMs)
}
if record.finalAtMs != nil {
child.FinalMs = elapsedMs(record.demandAtMs, *record.finalAtMs)
}
child.RejectionBucket = string(record.rejectionBucket)
}
if finalRoute == FinalRouteWaiting {
child.FinalRoute = string(FinalRouteWaiting)
if record != nil && record.finalRoute == FinalRouteFailed {
child.FinalRoute = string(FinalRouteFailed)
}
}
children = append(children, child)
}
var diagnosticOperation *protocol.RouteDiagnosticOperation
if op := c.operation; op != nil {
if childOrdinal, ok := ordinals[op.demandPeerID]; ok {
stage := "admission"
if op.current != nil {
stage = "first-frame"
if op.current.mediaReady {
stage = "quality-proof"
}
}
diagnosticOperation = &protocol.RouteDiagnosticOperation{
ChildOrdinal: protocol.Int(childOrdinal),
Reason: string(op.reason),
Stage: stage,
Cursor: protocol.Int(op.cursor),
CandidateCount: protocol.Int(len(op.candidates)),
}
}
}
return protocol.RouteDiagnosticSnapshot{Children: children, Operation: diagnosticOperation}
}
// UpsertParticipant adds or updates a participant, aborting an operation
// that used a replaced session; a viewer without a usable route records a
// "join" demand when nowMs is non-nil. Panics on a Host/role inconsistency.
func (c *Controller) UpsertParticipant(input ParticipantInput, nowMs *int64) []*Resource {
if (input.PeerID == c.hostPeerID) != (input.Role == protocol.RoleHost) {
panic(errors.New("Route Host identity is inconsistent"))
}
capacity := c.effectiveCapacity(input.EffectiveDownstreamCapacity)
current, _ := c.participants.Get(input.PeerID)
released := []*Resource{}
if current != nil && current.role != input.Role {
panic(errors.New("Route role cannot change"))
}
if current != nil {
changed := false
previousSessionID := current.sessionID
if previousSessionID != input.SessionID {
c.clearOpportunitiesForSessionChange(input.PeerID, input.Role)
c.clearQualityForParticipant(input.PeerID)
if c.operationUsesParticipantSession(input.PeerID) {
released = append(released, c.abortOperation(nowMs, RejectionStale)...)
}
c.directContinuations.Delete(input.PeerID)
c.clearSfuBootstrapForDemand(input.PeerID)
current.sessionID = input.SessionID
c.rebindCommittedSession(input.PeerID, input.SessionID)
changed = true
}
if current.departureConfirmed {
current.departureConfirmed = false
changed = true
}
if current.effectiveDownstreamCapacity != capacity {
current.effectiveDownstreamCapacity = capacity
changed = true
}
if changed {
c.touchFacts()
c.debug("participant-updated",
"participant", c.debugPeer(input.PeerID),
"capacity", capacity,
"sessionChanged", previousSessionID != input.SessionID)
}
if input.Role == protocol.RoleViewer && nowMs != nil && !c.usableRoute(input.PeerID) {
c.recordDemand(input.PeerID, *nowMs, DemandJoin)
}
return released
}
// A new key appends to the insertion order (TS Map.set at 573).
c.participants.Set(input.PeerID, &participant{
peerID: input.PeerID,
role: input.Role,
sessionID: input.SessionID,
effectiveDownstreamCapacity: capacity,
joinOrder: c.nextJoinOrder,
})
c.nextJoinOrder++
c.debug("participant-joined",
"participant", c.debugPeer(input.PeerID),
"role", input.Role,
"capacity", capacity)
if input.Role == protocol.RoleViewer && nowMs != nil {
c.recordDemand(input.PeerID, *nowMs, DemandJoin)
}
c.touchFacts()
return released
}
// RebindHostIdentity moves the Host to a new peer ID (same ID delegates to
// UpsertParticipant), tearing down the whole graph and returning every SFU
// subscription, the publication and the aborted reservation, deduplicated.
func (c *Controller) RebindHostIdentity(peerID, sessionID string, nowMs *int64) []*Resource {
previousPeerID := c.hostPeerID
if peerID == previousPeerID {
return c.UpsertParticipant(ParticipantInput{
PeerID: peerID,
Role: protocol.RoleHost,
SessionID: sessionID,
EffectiveDownstreamCapacity: c.endpointMediaCopyCapacity,
}, nowMs)
}
if c.participants.Has(peerID) {
panic(errors.New("Route Host identity collides with another participant"))
}
host, _ := c.participants.Get(previousPeerID)
if host == nil || host.role != protocol.RoleHost {
panic(errors.New("Route Host identity is unavailable"))
}
// Aborted reservation, then SFU edges in map
// order, then the publication, deduplicated.
released := &resourceSet{}
if c.operation != nil {
released.add(c.abortOperation(nowMs, RejectionStale)...)
}
for _, edge := range c.upstreamByViewer.Values() {
if edge.Kind == UpstreamSfu && edge.PhysicalActive {
released.add(edge.Resource)
}
}
if c.hostPublication != nil && c.hostPublication.PhysicalActive {
released.add(c.hostPublication.Resource)
}
c.upstreamByViewer.Clear()
c.hostPublication = nil
clear(c.routeTimings)
clear(c.qualityObservations)
clear(c.senderQualityObservations)
clear(c.senderQualityBaselines)
clear(c.senderQualityRegenerationBlocks)
clear(c.qualityBaselinesPending)
c.sfuPublisherQualityObservation = nil
c.directContinuations.Clear()
c.retiringPublicationGenerations.Clear()
c.sfuBootstrapIntent = nil
c.consumedSfuBootstrapOpportunities.Clear()
c.rootConvergenceRootPeerID = ""
// Demand is re-recorded in participants order.
for _, current := range c.participants.Values() {
current.availabilityExhausted = false
current.bootstrapFailureReported = false
current.sfuFirstAtNextRoute = false
current.consumedCandidateOpportunities.Clear()
if current.role == protocol.RoleViewer && current.sessionID != "" && nowMs != nil {
c.recordDemand(current.peerID, *nowMs, DemandEdgeUnavailable)
}
}
// Delete + set moves the Host to the tail of the
// insertion order while it keeps its joinOrder.
c.participants.Delete(previousPeerID)
host.peerID = peerID
host.sessionID = sessionID
host.departureConfirmed = false
c.participants.Set(peerID, host)
c.hostPeerID = peerID
c.revision = c.allocateRevision()
c.touchFacts()
c.assertGraph()
return released.resources()
}
// DisconnectSession marks the participant's exact session as gone (grace
// state, no revision change); false when the session does not match.
func (c *Controller) DisconnectSession(peerID, sessionID string) bool {
current, _ := c.participants.Get(peerID)
if current == nil || !current.sessionIs(sessionID) {
return false
}
c.clearOpportunitiesForSessionChange(peerID, current.role)
current.sessionID = ""
c.clearQualityForParticipant(peerID)
c.directContinuations.Delete(peerID)
c.clearSfuBootstrapForDemand(peerID)
c.touchFacts()
c.debug("participant-disconnected", "participant", c.debugPeer(peerID))
return true
}
// ConfirmDeparture finalises a viewer's departure (capacity 0, demand
// recorded for its children when nowMs is non-nil); false for the Host or
// an unknown peer; idempotent.
func (c *Controller) ConfirmDeparture(peerID string, nowMs *int64) bool {
current, _ := c.participants.Get(peerID)
if current == nil || current.role == protocol.RoleHost {
return false
}
delete(c.routeTimings, peerID)
if current.departureConfirmed && current.sessionID == "" && current.effectiveDownstreamCapacity == 0 {
return true
}
c.clearOpportunitiesForSessionChange(peerID, current.role)
current.sessionID = ""
c.clearQualityForParticipant(peerID)
current.departureConfirmed = true
current.effectiveDownstreamCapacity = 0
c.directContinuations.Delete(peerID)
c.clearSfuBootstrapForDemand(peerID)
if nowMs != nil {
for _, childPeerID := range c.childrenOf(peerID) {
c.recordDemand(childPeerID, *nowMs, DemandParentDeparted)
}
}
c.touchFacts()
c.debug("participant-departed", "participant", c.debugPeer(peerID))
return true
}
// SetEffectiveCapacity clamps and stores the participant's downstream
// capacity for the matching session; true even when unchanged (facts are
// touched only on change).
func (c *Controller) SetEffectiveCapacity(peerID, sessionID string, value int, nowMs *int64) bool {
current, _ := c.participants.Get(peerID)
if current == nil || !current.sessionIs(sessionID) {
return false
}
capacity := c.effectiveCapacity(value)
if current.effectiveDownstreamCapacity == capacity {
return true
}
current.effectiveDownstreamCapacity = capacity
if nowMs != nil {
for _, childPeerID := range c.overflowPeerChildren(peerID) {
c.recordDemand(childPeerID, *nowMs, DemandCapacityReduction)
}
}
c.touchFacts()
c.debug("capacity-updated", "participant", c.debugPeer(peerID), "capacity", capacity)
return true
}
// TouchExternalFacts reopens every SFU opportunity after an external fact
// change (for example a share generation) and bumps the fact version.
func (c *Controller) TouchExternalFacts() {
c.clearSfuCandidateOpportunities()
c.sfuBootstrapIntent = nil
c.touchFacts()
}
// InvalidateEdge marks the exactly identified edge unusable and records an
// "edge-unavailable" demand; true when the guard matched (idempotent).
func (c *Controller) InvalidateEdge(guard EdgeGuard, nowMs *int64) bool {
child, _ := c.participants.Get(guard.ChildPeerID)
edge, _ := c.upstreamByViewer.Get(guard.ChildPeerID)
if child == nil || !child.sessionIs(guard.ChildSessionID) || c.revision != guard.RouteRevision ||
edge == nil || edge.ConnectionID != guard.ConnectionID ||
edge.ChildSessionID != guard.ChildSessionID ||
(edge.Kind == UpstreamPeer && edge.ParentSessionID != guard.ParentSessionID) {
return false
}
if edge.Usable {
c.consumeActiveEdgeOpportunity(child, edge)
c.clearQualityForParticipant(guard.ChildPeerID)
edge.Usable = false
c.directContinuations.Delete(guard.ChildPeerID)
child.availabilityExhausted = false
child.bootstrapFailureReported = false
c.touchFacts()
if nowMs != nil {
c.recordDemand(guard.ChildPeerID, *nowMs, DemandEdgeUnavailable)
}
}
return true
}
// InvalidateDirectEdgeFromParent invalidates the first committed direct edge
// (insertion order) matching the parent-side guard.
func (c *Controller) InvalidateDirectEdgeFromParent(input ParentEdgeGuard, nowMs *int64) bool {
// First match in insertion order wins.
for childPeerID, edge := range c.upstreamByViewer.All() {
if edge.Kind == UpstreamPeer &&
edge.ParentPeerID == input.ParentPeerID &&
edge.ParentSessionID == input.ParentSessionID &&
edge.ConnectionID == input.ConnectionID {
return c.InvalidateEdge(EdgeGuard{
ChildPeerID: childPeerID,
ChildSessionID: edge.ChildSessionID,
ParentSessionID: input.ParentSessionID,
RouteRevision: input.RouteRevision,
ConnectionID: input.ConnectionID,
}, nowMs)
}
}
return false
}
// InvalidateHostPublication marks the identified publication unusable and
// records demand for every SFU child; true when the guard matched (idempotent).
func (c *Controller) InvalidateHostPublication(guard PublicationGuard, nowMs *int64) bool {
publication := c.hostPublication
if publication == nil || c.revision != guard.RouteRevision ||
publication.HostSessionID != guard.HostSessionID ||
publication.Generation != guard.Generation ||
publication.ConnectionID != guard.ConnectionID {
return false
}
if publication.Usable {
c.clearSfuQuality()
publication.Usable = false
c.directContinuations.Clear()
c.sfuBootstrapIntent = nil
if nowMs != nil {
for childPeerID, edge := range c.upstreamByViewer.All() {
if edge.Kind == UpstreamSfu {
c.recordDemand(childPeerID, *nowMs, DemandEdgeUnavailable)
}
}
}
c.touchFacts()
}
return true
}
// AdoptDirectConnection accepts a replacement for the exact active edge.
// Recovery supersedes optional preparation for that child when the replacement
// arrives. Required availability work, including capacity reduction, keeps priority.
func (c *Controller) AdoptDirectConnection(input AdoptDirectConnectionInput, nowMs int64) SettleResult {
result := SettleResult{ActiveRevision: c.revision}
edge, _ := c.upstreamByViewer.Get(input.ChildPeerID)
if c.revision != input.RouteRevision ||
edge == nil ||
edge.Kind != UpstreamPeer ||
edge.Transport != TransportDirect ||
!edge.Usable ||
!edge.PhysicalActive ||
edge.ChildSessionID != input.ChildSessionID ||
edge.ParentSessionID != input.ParentSessionID ||
edge.ConnectionID != input.ConnectionID ||
input.NewConnectionID == "" {
return result
}
if input.NewConnectionID == edge.ConnectionID {
result.Accepted = true
return result
}
if op := c.operation; op != nil && op.childPeerID == input.ChildPeerID {
if isAvailabilityOperation(op.reason) {
return result
}
result.Released = c.abortOperation(&nowMs, RejectionAborted)
}
c.clearQualityForParticipant(input.ChildPeerID)
edge.ConnectionID = input.NewConnectionID
if child, ok := c.participants.Get(input.ChildPeerID); ok {
child.availabilityExhausted = false
}
c.touchFacts()
result.Accepted = true
result.ActiveRevision = c.revision
return result
}
// RetireHostPublication retires the physically active publication and its
// subscriptions when no attempt is live and the guard matches, returning the
// subscriptions then the publication resource; empty otherwise.
func (c *Controller) RetireHostPublication(guard PublicationGuard) []*Resource {
publication := c.hostPublication
if (c.operation != nil && c.operation.current != nil) || publication == nil || !publication.PhysicalActive ||
c.revision != guard.RouteRevision ||
publication.HostSessionID != guard.HostSessionID ||
publication.Generation != guard.Generation ||
publication.ConnectionID != guard.ConnectionID {
return []*Resource{}
}
// Subscriptions in map order, then the publication.
released := []*Resource{}
for viewerPeerID, edge := range c.upstreamByViewer.All() {
if edge.Kind == UpstreamSfu && edge.PublicationGeneration == publication.Generation {
c.retireSfuEdge(viewerPeerID, edge, &released, c.retainsAnchor(viewerPeerID))
}
}
publication.PhysicalActive = false
publication.Usable = false
c.hostPublication = nil
c.clearSfuQuality()
c.revision = c.allocateRevision()
if c.operation != nil {
c.operation.baseRevision = c.revision
}
c.touchFacts()
released = append(released, publication.Resource)
c.pruneRetiringSfuAnchors()
return released
}
// SetPaused pauses (aborting the operation and clearing quality state) or
// resumes; returns the aborted reservation's resources.
func (c *Controller) SetPaused(paused bool, nowMs *int64) []*Resource {
if c.paused == paused {
return []*Resource{}
}
c.paused = paused
if paused {
clear(c.qualityObservations)
clear(c.qualityBaselinesPending)
clear(c.senderQualityObservations)
clear(c.senderQualityBaselines)
clear(c.senderQualityRegenerationBlocks)
c.sfuPublisherQualityObservation = nil
}
c.touchFacts()
if paused {
return c.abortOperation(nowMs, RejectionAborted)
}
return []*Resource{}
}
// Dispose clears all state, pauses the controller and returns the live
// reservation's resources then every committed resource, deduplicated.
func (c *Controller) Dispose() []*Resource {
// Reservation first, then committed resources.
resources := &resourceSet{}
if c.operation != nil && c.operation.current != nil {
resources.add(reservationResources(c.operation.current.reservation)...)
}
resources.add(c.committedResources()...)
c.operation = nil
c.upstreamByViewer.Clear()
clear(c.qualityObservations)
clear(c.qualityBaselinesPending)
clear(c.senderQualityObservations)
clear(c.senderQualityBaselines)
clear(c.senderQualityRegenerationBlocks)
c.sfuPublisherQualityObservation = nil
c.hostPublication = nil
c.participants.Clear()
clear(c.routeTimings)
c.directContinuations.Clear()
c.retiringPublicationGenerations.Clear()
c.sfuBootstrapIntent = nil
c.consumedSfuBootstrapOpportunities.Clear()
c.rootConvergenceRootPeerID = ""
// nextJoinOrder, revision, latestRevision and factVersion survive.
c.paused = true
return resources.resources()
}
// abortOperation finishes demand timing when nowMs is given, releases the live
// reservation and clears the operation.
func (c *Controller) abortOperation(nowMs *int64, bucket RejectionBucket) []*Resource {
if c.operation == nil {
return []*Resource{}
}
if nowMs != nil {
c.finishTiming(c.operation.demandPeerID, *nowMs, c.currentFinalRoute(c.operation.demandPeerID), bucket, false)
}
op := c.operation
released := []*Resource{}
if op.current != nil {
released = reservationResources(op.current.reservation)
c.advanceActiveRevision(op)
}
c.operation = nil
return released
}
func (c *Controller) operationUsesParticipantSession(peerID string) bool {
op := c.operation
if op == nil {
return false
}
if op.childPeerID == peerID || op.demandPeerID == peerID {
return true
}
tuple := op.currentTuple()
if tuple != nil && tuple.Kind == UpstreamPeer {
return tuple.ParentPeerID == peerID
}
return peerID == c.hostPeerID
}
// effectiveCapacity panics "Effective capacity is invalid" for
// a negative or unsafe value and clamps to the endpoint capacity.
func (c *Controller) effectiveCapacity(value int) int {
if !isSafeInteger(int64(value)) || value < 0 {
panic(errors.New("Effective capacity is invalid"))
}
return min(value, c.endpointMediaCopyCapacity)
}
func (c *Controller) touchFacts() { c.factVersion++ }
// allocateRevision bounds revisions by MAX_SAFE_INTEGER.
func (c *Controller) allocateRevision() int64 {
if c.latestRevision >= protocol.MaxMediaRouteRevision {
panic(errors.New("Media route revision space exhausted"))
}
c.latestRevision++
return c.latestRevision
}
// isSafeInteger is Number.isSafeInteger for a value that is already integral.
func isSafeInteger(value int64) bool {
return value >= -maxSafeInteger && value <= maxSafeInteger
}
// joinOrder is allocated once per participant and preserved across
// rebindHostIdentity, so two live
// participants never share one and the TS localeCompare (ICU) tiebreak is
// unreachable; strings.Compare stands in for it.
func compareParticipant(left, right *participant) int {
if left.joinOrder != right.joinOrder {
if left.joinOrder < right.joinOrder {
return -1
}
return 1
}
return strings.Compare(left.peerID, right.peerID)
}
// stablePairRank returns the first 6 bytes, big-endian, of
// sha256(child + "\0" + parent). Byte-exact: it breaks parent ties.
func stablePairRank(childPeerID, parentPeerID string) int64 {
sum := sha256.Sum256([]byte(childPeerID + "\x00" + parentPeerID))
var rank int64
for _, b := range sum[:6] {
rank = rank<<8 | int64(b)
}
return rank
}
// JS Math.round is half-up while math.Round is half-away-from-zero;
// they differ only for negative halves, which the
// `rounded < 0` branch drops either way. NaN and +/-Inf drop the window.
func safeAdd(total int64, delta float64) int64 {
rounded := math.Round(delta)
if math.IsNaN(rounded) || math.IsInf(rounded, 0) || rounded < 0 || rounded > float64(maxSafeInteger) {
return total
}
value := int64(rounded)
if value > maxSafeInteger-total {
return maxSafeInteger
}
return total + value
}