Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .changes/public-subscribed-quality-event
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
minor type="added" "LocalTrackSubscribedQualityUpdatedEvent: the layers and codecs subscribers request for a local track, as a public room and participant event"
44 changes: 38 additions & 6 deletions lib/src/core/room.dart
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ import '../participant/remote.dart';
import '../preconnect/pre_connect_audio_buffer.dart';
import '../proto/livekit_models.pb.dart' as lk_models;
import '../proto/livekit_rtc.pb.dart' as lk_rtc;
import '../publication/local.dart';
import '../rpc/rpc_client_manager.dart';
import '../rpc/rpc_server_manager.dart';
import '../support/disposable.dart';
Expand Down Expand Up @@ -444,18 +445,21 @@ class Room extends DisposableChangeNotifier with EventsEmittable<RoomEvent> {
..on<SignalConnectionQualityUpdateEvent>((event) => _onSignalConnectionQualityUpdateEvent(event.updates))
..on<SignalStreamStateUpdatedEvent>((event) => _onSignalStreamStateUpdateEvent(event.updates))
..on<SignalSubscribedQualityUpdatedEvent>((event) async {
// Find the publication
final publication = localParticipant?.trackPublications[event.trackSid];
if (publication == null) {
logger.warning('Received subscribed quality update for unknown track (${event.trackSid})');
return;
}
// Taken before the layers are applied: for SVC codecs that marks every listed layer enabled.
final qualities = _subscribedQualities(event, publication);
// Dynacast is off or is unsupported
if (!roomOptions.dynacast || _serverVersion == '0.15.1') {
logger.fine(
'Received subscribed quality update'
' but Dynacast is off or server version is not supported.',
);
return;
}
// Find the publication
final publication = localParticipant?.trackPublications[event.trackSid];
if (publication == null) {
logger.warning('Received subscribed quality update for unknown track (${event.trackSid})');
_emitSubscribedQualityUpdated(publication, qualities);
return;
}
if (event.subscribedCodecs.isNotEmpty) {
Expand All @@ -478,6 +482,7 @@ class Room extends DisposableChangeNotifier with EventsEmittable<RoomEvent> {
isSVC: isSVCCodec(videoTrack.codec ?? ''),
);
}
_emitSubscribedQualityUpdated(publication, qualities);
})
..on<SignalSubscriptionPermissionUpdateEvent>((event) async {
logger.fine(
Expand Down Expand Up @@ -1228,6 +1233,33 @@ extension RoomPrivateMethods on Room {
}
}

Map<String, Map<VideoQuality, bool>> _subscribedQualities(
SignalSubscribedQualityUpdatedEvent event,
LocalTrackPublication publication,
) {
Map<VideoQuality, bool> byQuality(Iterable<lk_rtc.SubscribedQuality> qualities) => {
for (final q in qualities) q.quality.toLKType(): q.enabled,
};
return event.subscribedCodecs.isNotEmpty
? {for (final c in event.subscribedCodecs) c.codec: byQuality(c.qualities)}
: {
(publication.track?.codec ?? publication.mimeType.split('/').last).toLowerCase(): byQuality(
event.subscribedQualities,
),
};
}

void _emitSubscribedQualityUpdated(
LocalTrackPublication publication,
Map<String, Map<VideoQuality, bool>> qualities,
) {
final participant = localParticipant;
if (participant == null || connectionState != ConnectionState.connected) return;
[participant.events, events].emit(
LocalTrackSubscribedQualityUpdatedEvent(participant: participant, publication: publication, qualities: qualities),
);
}

@internal
void emitWhenConnected(RoomEvent event) {
if (connectionState == ConnectionState.connected) {
Expand Down
20 changes: 20 additions & 0 deletions lib/src/events.dart
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,26 @@ class RoomReconnectedEvent with RoomEvent {
String toString() => '${runtimeType}()';
}

/// The server updated the requested layers and codecs of a local track (dynacast). Emitted
/// after the SDK has applied them, and also when [RoomOptions.dynacast] is off.
/// Emitted by [Room] and [LocalParticipant].
class LocalTrackSubscribedQualityUpdatedEvent with RoomEvent, ParticipantEvent {
final LocalParticipant participant;
final LocalTrackPublication publication;

/// Per codec (e.g. 'vp8'), whether subscribers request each layer.
final Map<String, Map<VideoQuality, bool>> qualities;
const LocalTrackSubscribedQualityUpdatedEvent({
required this.participant,
required this.publication,
required this.qualities,
});

@override
String toString() =>
'${runtimeType}(participant: ${participant}, publication: ${publication}, qualities: ${qualities})';
}

/// Disconnected from the room
/// Emitted by [Room].
class RoomDisconnectedEvent with RoomEvent {
Expand Down
103 changes: 103 additions & 0 deletions test/core/room_e2e_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,10 @@ import 'package:logging/logging.dart';

import 'package:livekit_client/livekit_client.dart';
import 'package:livekit_client/src/internal/events.dart';
import 'package:livekit_client/src/proto/livekit_models.pb.dart' as lk_models;
import 'package:livekit_client/src/proto/livekit_rtc.pb.dart' as lk_rtc;
import '../mock/e2e_container.dart';
import '../mock/peerconnection_mock.dart';
import '../mock/test_data.dart';
import '../mock/websocket_mock.dart';
import 'signal_client_test.dart';
Expand Down Expand Up @@ -233,6 +236,86 @@ void main() {
});
});

group('subscribed quality', () {
lk_rtc.SignalResponse update(String trackSid) => lk_rtc.SignalResponse(
subscribedQualityUpdate: lk_rtc.SubscribedQualityUpdate(
trackSid: trackSid,
subscribedQualities: [
lk_rtc.SubscribedQuality(quality: lk_models.VideoQuality.LOW, enabled: true),
lk_rtc.SubscribedQuality(quality: lk_models.VideoQuality.HIGH, enabled: false),
],
),
);

test('emits the requested layers of a local track, with dynacast off', () async {
final lp = room.localParticipant!;
final track = LocalVideoTrack(
TrackSource.camera,
_FakeMediaStream('local_stream'),
_FakeMediaStreamTrack(id: 'local_video', kind: 'video'),
const CameraCaptureOptions(),
);
final publication = LocalTrackPublication<LocalVideoTrack>(
participant: lp,
info: lk_models.TrackInfo(sid: 'TR_local', type: lk_models.TrackType.VIDEO, mimeType: 'video/VP8'),
track: track,
);
lp.addTrackPublication(publication);

final future = room.events.waitFor<LocalTrackSubscribedQualityUpdatedEvent>(duration: const Duration(seconds: 1));
ws.onData(update('TR_local').writeToBuffer());
final event = await future;
expect(event.publication, publication);
expect(event.qualities, {
'vp8': {VideoQuality.LOW: true, VideoQuality.HIGH: false},
});
});

test('emits the requested layers, not the ones kept active for an SVC codec', () async {
final dynacast = E2EContainer(roomOptions: const RoomOptions(dynacast: true));
await dynacast.connectRoom();
final lp = dynacast.room.localParticipant!;
final track = LocalVideoTrack(
TrackSource.camera,
_FakeMediaStream('svc_stream'),
_FakeMediaStreamTrack(id: 'svc_video', kind: 'video'),
const CameraCaptureOptions(),
)..codec = 'vp9';
final sender = _ParamsSender([
rtc.RTCRtpEncoding(rid: 'q', active: true),
rtc.RTCRtpEncoding(rid: 'f', active: true),
]);
track.transceiver = MockRtpTransceiver(sender);
final publication = LocalTrackPublication<LocalVideoTrack>(
participant: lp,
info: lk_models.TrackInfo(sid: 'TR_svc', type: lk_models.TrackType.VIDEO, mimeType: 'video/VP9'),
track: track,
);
lp.addTrackPublication(publication);

final future = dynacast.room.events.waitFor<LocalTrackSubscribedQualityUpdatedEvent>(
duration: const Duration(seconds: 1),
);
dynacast.wsConnector.onData(update('TR_svc').writeToBuffer());
final event = await future;
expect(event.qualities, {
'vp9': {VideoQuality.LOW: true, VideoQuality.HIGH: false},
});
// The sender keeps every SVC layer on.
expect(sender.parameters.encodings!.every((e) => e.active), isTrue);
await dynacast.room.dispose();
});

test('skips unknown tracks', () async {
var emitted = false;
final cancel = room.events.on<LocalTrackSubscribedQualityUpdatedEvent>((_) => emitted = true);
ws.onData(update('TR_unknown').writeToBuffer());
await Future<void>.delayed(const Duration(milliseconds: 100));
expect(emitted, isFalse);
await cancel();
});
});

group('publish guards', () {
test('concurrent setSourceEnabled serializes calls', () async {
final lp = room.localParticipant!;
Expand Down Expand Up @@ -362,3 +445,23 @@ class _FakeMediaStreamTrack implements rtc.MediaStreamTrack {
@override
String toString() => 'FakeMediaStreamTrack(id: $id, kind: $kind, enabled: $enabled)';
}

/// A sender with fixed encodings, accepting any parameters.
class _ParamsSender implements rtc.RTCRtpSender {
_ParamsSender(List<rtc.RTCRtpEncoding> encodings) : parameters = rtc.RTCRtpParameters(encodings: encodings);

@override
rtc.RTCRtpParameters parameters;

@override
String get senderId => 'svc_sender';

@override
Future<bool> setParameters(rtc.RTCRtpParameters parameters) async {
this.parameters = parameters;
return true;
}

@override
dynamic noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
}
Loading