Skip to content

feat: fec subscribe presets - #1987

Open
cloudwebrtc wants to merge 3 commits into
mainfrom
duan/fec-subscribe-presets
Open

cloudwebrtc wants to merge 3 commits into
mainfrom
duan/fec-subscribe-presets

Conversation

@cloudwebrtc

@cloudwebrtc cloudwebrtc commented Nov 16, 2026 •

Copy link
Copy Markdown

Note for reviewers: fec intentionally uses different update semantics from the other fields in UpdateTrackSettings.

The other fields are replaced on every update. In livekit-server, SubscribedTrack.UpdateSubscriberSettings stores a full clone of the incoming message (t.settings = proto.CloneOf(settings)), so a field that is left out goes back to its zero value.

fec is the exception: if it is omitted, the previous setting is kept. This is why it is declared optional, so the server can tell "not sent" apart from "sent as FEC_MODE_DISABLED". With this, clients that don't know about FEC (or that only want to change dimensions or disabled) won't turn FEC off just by sending a normal settings update.

What the server needs to do:

  • When fec is unset, carry over the previous FECProtection before storing or comparing settings. As things stand, proto.CloneOf would drop it, and the proto.Equal short-circuit would also see a difference.
  • Start each subscription at FEC_MODE_DISABLED.

If we'd rather keep the replace-on-every-update semantics for all fields, we can drop optional and this sentence. The cost is that every client has to resend fec on each update.

chenosaurus and others added 3 commits November 11, 2026 22:24
Replace the FECProtection enum with a message carrying a mode
(disabled, adaptive, fixed, minimum) and a level (low, medium, high).
Enum values are prefixed to avoid package-scope collisions, and zero
values are FEC_MODE_DISABLED and FEC_LEVEL_UNSPECIFIED.
@changeset-bot

changeset-bot Bot commented Nov 16, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: de2bab4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
github.com/livekit/protocol Minor
@livekit/protocol Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

cloudwebrtc added a commit to livekit/livekit that referenced this pull request Nov 16, 2026
Adopt the FECProtection message from livekit/protocol#1987: subscribers
select a mode (disabled, adaptive, fixed, minimum) and a level (low,
medium, high; unspecified is low) per track. As before, an update that
omits fec keeps the previous setting. Unknown modes disable FEC and
unknown levels are treated as unspecified.

The modes follow libwebrtc's RtpParameters::fec_protection
(webrtc-sdk/webrtc#329):
- adaptive ports VCMNackFecMethod: the kFecRateTable lookup with a 10
  second max-window loss filter, key frame boost, ConvertFECRate, NACK
  only delta frames below 20ms RTT, and BitRateTooLowForFec. Inputs are
  the subscriber's receiver reports, the sent bit and frame rates, and
  the forwarded layer's dimensions.
- fixed uses the level for delta and key frames.
- minimum uses the larger of the adaptive rate and the level.
- the adaptive state is updated in every mode, so switching to adaptive
  or minimum starts from the current loss history, and a protection
  change keeps the group that is accumulating and protects it at the
  new rate.

Key frames get their own protection factor, so pacer packets carry a
key frame flag. Repairs are still generated per frame; multi-frame
blocks (max_fec_frames) are not supported.

The end-to-end tests report the simulated loss in receiver reports,
since the test client sends none, and check that adaptive protection
sends no repairs without loss and protects with loss, and that minimum
protection matches its level without loss and rises with loss.

Requires livekit/protocol#1987, which is not in the pinned protocol
version yet.
cloudwebrtc added a commit that referenced this pull request Nov 17, 2026
Applies #1987 (de2bab4) on top of 2172178; only the
proto and changeset, the Go bindings are not used by the Swift SDK.
cloudwebrtc added a commit to livekit/livekit that referenced this pull request Nov 17, 2026
cloudwebrtc added a commit to livekit/rust-sdks that referenced this pull request Nov 17, 2026
Move the livekit-protocol submodule to de2bab40, the head of
livekit/protocol#1987, and regenerate the Rust protobufs. The request
now carries a FECProtection message with a mode (disabled, adaptive,
fixed, minimum) and a level, exposed as SubscriptionFecProtection.

The newer protocol adds UpdateStreamRequest.add_destinations and
TransferSipParticipantRequest.dialtone; livekit-api leaves both at
their defaults.
cloudwebrtc added a commit to livekit/rust-sdks that referenced this pull request Nov 17, 2026
Point the protocol submodule at the FEC subscribe presets branch and
regenerate livekit-protocol. Fill the new UpdateStreamRequest and
TransferSipParticipantRequest fields with defaults in livekit-api.
cloudwebrtc added a commit to livekit/rust-sdks that referenced this pull request Nov 17, 2026
dc/feature/fec now models publish-side FEC as FecProtection { mode, level },
mirroring FECProtection in livekit/protocol#1987. Use the same type for
RemoteTrackPublication::set_fec_protection instead of the separate
SubscriptionFecProtection and SubscriptionFecLevel, and map it to the
protocol message through FecProtectionMode and FecProtectionLevel.

The fec_test subscriber schedule now spells the minimum mode as
minimum-<level>, matching the publisher's --fec-mode values.
@cloudwebrtc
cloudwebrtc marked this pull request as ready for review November 17, 2026 08:32
cloudwebrtc added a commit to livekit/livekit that referenced this pull request Nov 17, 2026
Adopt the FECProtection message from livekit/protocol#1987: subscribers
select a mode (disabled, adaptive, fixed, minimum) and a level (low,
medium, high; unspecified is low) per track. As before, an update that
omits fec keeps the previous setting. Unknown modes disable FEC and
unknown levels are treated as unspecified.

The modes follow libwebrtc's RtpParameters::fec_protection
(webrtc-sdk/webrtc#329):
- adaptive ports VCMNackFecMethod: the kFecRateTable lookup with a 10
  second max-window loss filter, key frame boost, ConvertFECRate, NACK
  only delta frames below 20ms RTT, and BitRateTooLowForFec. Inputs are
  the subscriber's receiver reports, the sent bit and frame rates, and
  the forwarded layer's dimensions.
- fixed uses the level for delta and key frames.
- minimum uses the larger of the adaptive rate and the level.
- the adaptive state is updated in every mode, so switching to adaptive
  or minimum starts from the current loss history, and a protection
  change keeps the group that is accumulating and protects it at the
  new rate.

Key frames get their own protection factor, so pacer packets carry a
key frame flag. Repairs are still generated per frame; multi-frame
blocks (max_fec_frames) are not supported.

The end-to-end tests report the simulated loss in receiver reports,
since the test client sends none, and check that adaptive protection
sends no repairs without loss and protects with loss, and that minimum
protection matches its level without loss and rises with loss.

Requires livekit/protocol#1987, which is not in the pinned protocol
version yet.
cloudwebrtc added a commit to livekit/livekit that referenced this pull request Nov 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants