Skip to content

armgit / Piik

Public Imported from GitHub
0

Free, open-source screen sharing for private live streams with friends. Watch together in a browser or self-host Piik. 免费开源的私密屏幕共享,支持游戏直播、一起看电影与自部署。

9.0 KB
Raw Blame

Scoped Go Dependency Changes

Use the shared upstream refresh procedure to compare retained patches with current official source.

The root go.mod replaces these two modules with local source. They retain their original module paths and Apache-2.0 licenses. The checked-in source, upstream tests and focused regressions are built and tested by npm run check:go.

Module Source baseline Local changes
go-nat netbirdio/go-nat at 6b2c8c5c74e8 NAT-PMP honors contexts, assigned ports and deletion; optional PCPv6 finishes inside Piik's mapping budget so it cannot withhold successful IPv4; regressions retain both gateway paths
go-nat-pmp jackpal/go-nat-pmp v1.0.2 Context-aware request methods, deadline/cancellation through UDP I/O, adapted recorder/test caller, and a module manifest

Upstream source and tests are retained, excluding examples and CI configuration. Modified upstream files carry a notice; formatting follows the project Go toolchain. The package notice collector reads the replacement modules' license files directly, so App archives retain their attribution.

Assigned-port and deletion handling repair NAT-PMP behavior. The Context methods extend cancellation support; the shorter optional PCPv6 waits are Piik's mapping budget policy. These changes preserve the gateway selector and PCPv6 composition. The NAT research owner describes the runtime limits. Do not add a second gateway client in Piik.

When maintained upstream revisions cover these fixes and the same regressions pass, replace both local module directives with version pins, remove their source directories and the extra dependency test patterns in scripts/check-go.mjs. Until then, review updates against the named baselines; do not edit Go's shared module cache or apply build-time patches.

LiveKit Send-Side Bandwidth Estimation

livekit/sendsidebwe retains only the eight source files from LiveKit v1.13.6's package, with its original LICENSE and NOTICE. It uses the existing pinned LiveKit interfaces; the rest of LiveKit comes from the pinned Go dependency, including the temporary allocator input described below. No build-time patch is applied.

Measurement corrections are marked in the modified files: probe finalization returns the current acknowledged capacity and rejects invalid/empty feedback; probe timing begins with its first acknowledged packet, excluding pre-probe idle time; congestion statistics retain the packet that starts each new CTR group, including its received/lost accounting; overlapping TWCC feedback changes each packet's state once, retaining late ACKs without duplicating counts or moving the receive-time baseline. Only new observations advance congestion state. Group loss membership covers the packet tracker's history. Delay measurement advances in send order with a receive-time watermark, while older ACKs repair counts without rewinding it. Reset reseeds that delay baseline without discarding delivery history. Piik's shared forwarding package uses this copy for both individual transports and publications. Two recovery policies accompany those corrections. Inconclusive probes use existing backoff from completion without growing the next probe or reporting measured congestion. Delay inference tolerates clock-rate skew using RFC 6817 A.2's 500 ppm virtual-sender-clock allowance; packet timestamps, acknowledged traffic and loss remain unadjusted. Long, lossless TWCC controls and real queue/loss recovery controls exercise both policies. Its regression checks use real TWCC feedback and retain the no-feedback and idle-before-probe controls. The media research owner records the runtime evidence and remaining limits.

The package notice collector still includes LiveKit's upstream license and notice through the other compiled LiveKit packages. When a maintained upstream version covers these corrections and the same regressions pass, remove this directory and restore the upstream imports. Review dependency bumps against the named baseline; do not evolve a separate congestion-control algorithm here.

The LiveKit dependency includes upstream #5013, which restores probe delivery after cached RTX packets expire. Its earlier padding correction also replaces Piik's former padding writer. Those repairs use the upstream dependency; no additional LiveKit package is copied here. The local send-side measurement corrections above remain necessary.

The dependency also includes upstream #5018 and #5019: dummy-start timestamp offsets stay within the RTP clock's wrap domain and are cleared on receiver restart. These correct layer/source-switch continuity in the existing DownTrack; Piik adds no timestamp repair alongside it.

The retained detector also includes upstream #4935 and its regression from v1.13.9, adapted to standard Go assertions. Reserved TWCC symbols carry no receive delta: skip their measurement rather than consuming the next packet's delta or indexing past the feedback array.

Local Encoder Probe Demand

Until upstream #5016 is available, the root module replaces LiveKit with the immutable c7f56b38 revision, based on upstream cde3991916cf. Its only changes are an optional local encoder demand input to StreamAllocator and regression tests. Native publication uses that input; ordinary forwarding leaves it unset. The existing allocator still owns probe timing, congestion response and allocation; encoder demand does not change track-deficiency state. No allocator source is copied into Piik and no build-time patch is applied.

The explicit TestPublicationConstrainedRecovery gate and the upstream tests cover recovery and withdrawal without replacing measured source rates or capacity. Once an upstream revision supports this input and passes those checks, remove the replacement directive and its replacement checksums. The separate local send-side estimator corrections retain their own removal gate.

Pion H.264 Profile Matching

Until upstream #3668 is available, the root module replaces Pion with the immutable 6ed9e55c revision, based on official v4.2.26. It matches equivalent H.264 subprofiles according to RFC 6184 Table 5. Without this repair, an offer containing Constrained Baseline 42c01f and VP8 can select VP8 even though the receiver prefers and supports that H.264 profile. The patch changes only profile matching and its regressions; level and packetization handling stay upstream-owned. Piik adds no SDP aliases or local Pion source. The package notice collector reads the replacement's MIT license.

Once an upstream revision passes the actual receiver negotiation and encoded forwarding controls, remove this replacement and its checksums. Keep the mixed H.264/VP8 regression in the existing media-edge receiver test table.

Pion Repaired-Packet Identity

The shared RTP receive adapter uses the negotiated primary codec for packets Pion identifies as repaired. In Pion v4.2.23, receiveForRid initializes the codec before the first primary read initializes PayloadType; an earlier RTX packet can therefore be queued with payload type zero. Ordinary packet validation remains unchanged. A real simulcast/NACK regression fences that ordering without sleeps and fails when the correction is removed. Remove the adapter when a maintained upstream version passes that same control without it; this repair adds no second retransmission handler.

Pion's wire-level NACK generator also does not observe repaired primary sequence numbers. Native receive and SFU publication use the public interceptor options to leave video NACK generation to their existing LiveKit input buffer, after deencapsulation. That buffer retries missing packets and removes repaired holes; its existing RTCP callback returns NACKs to the actual upstream SSRC. Pion retains audio NACK behavior, receiver reports, TWCC and the retransmission responder. The shared real-peer regression holds a hole open, restores its exact primary packet through RTX, and verifies that retries stop on both receiving paths.