Merge branch 'main' into session-api

Author: hiroshihorie

.changes/event-logging-trace

@@ -0,0 +1 @@
+patch type="changed" "Add event logging with public/internal tagging"

.changes/fix-linux-audio-processing

@@ -0,0 +1 @@
+patch type="changed" "Enabled software AEC/NS/AGC for linux"

example/lib/main.dart

@@ -7,9 +7,9 @@ import 'pages/connect.dart';
 void main() async {
   final format = DateFormat('HH:mm:ss');
   // configure logs for debugging
-  Logger.root.level = Level.FINE;
+  Logger.root.level = Level.FINEST;
   Logger.root.onRecord.listen((record) {
-    print('${format.format(record.time)}: ${record.message}');
+    print('${format.format(record.time)} [${record.level.name}]: ${record.message}');
   });
 
   WidgetsFlutterBinding.ensureInitialized();

lib/src/core/room.dart

@@ -422,7 +422,7 @@ class Room extends DisposableChangeNotifier with EventsEmittable<RoomEvent> {
       logger.fine('[Engine] Received JoinResponse, '
           'serverVersion: ${event.response.serverVersion}');
 
-      _localParticipant ??= LocalParticipant(
+      _localParticipant ??= await LocalParticipant.createFromInfo(
         room: this,
         info: event.response.participant,
       );
@@ -487,7 +487,7 @@ class Room extends DisposableChangeNotifier with EventsEmittable<RoomEvent> {
       for (final info in event.response.otherParticipants) {
         logger.fine('Creating RemoteParticipant: sid = ${info.sid}(identity:${info.identity}) '
             'tracks:${info.tracks.map((e) => e.sid)}');
-        await _getOrCreateRemoteParticipant(info.identity, info);
+        await _getOrCreateRemoteParticipant(info);
       }
 
       if (e2eeManager != null && event.response.sifTrailer.isNotEmpty) {
@@ -657,9 +657,12 @@ class Room extends DisposableChangeNotifier with EventsEmittable<RoomEvent> {
     return null;
   }
 
-  Future<ParticipantCreationResult> _getOrCreateRemoteParticipant(
-      String identity, lk_models.ParticipantInfo? info) async {
-    RemoteParticipant? participant = _remoteParticipants[identity];
+  Future<ParticipantCreationResult> _getOrCreateRemoteParticipant(lk_models.ParticipantInfo info) async {
+    if (!info.hasIdentity() || !info.hasSid()) {
+      throw Exception('ParticipantInfo must have identity and sid');
+    }
+
+    final participant = _remoteParticipants[info.identity];
     if (participant != null) {
       // Return existing participant with no new publications; caller handles updates.
       return ParticipantCreationResult(
@@ -668,25 +671,10 @@ class Room extends DisposableChangeNotifier with EventsEmittable<RoomEvent> {
       );
     }
 
-    ParticipantCreationResult result;
-    if (info == null) {
-      logger.warning('RemoteParticipant.info is null identity: $identity');
-      participant = RemoteParticipant(
-        room: this,
-        sid: '',
-        identity: identity,
-        name: '',
-      );
-      result = ParticipantCreationResult(
-        participant: participant,
-        newPublications: const [],
-      );
-    } else {
-      result = await RemoteParticipant.createFromInfo(
-        room: this,
-        info: info,
-      );
-    }
+    final result = await RemoteParticipant.createFromInfo(
+      room: this,
+      info: info,
+    );
 
     _remoteParticipants[result.participant.identity] = result.participant;
     _sidToIdentity[result.participant.sid] = result.participant.identity;
@@ -717,7 +705,7 @@ class Room extends DisposableChangeNotifier with EventsEmittable<RoomEvent> {
         continue;
       }
 
-      final result = await _getOrCreateRemoteParticipant(info.identity, info);
+      final result = await _getOrCreateRemoteParticipant(info);
 
       if (isNew) {
         hasChanged = true;

lib/src/events.dart

@@ -30,7 +30,11 @@ import 'types/participant_state.dart' show ParticipantState;
 import 'types/transcription_segment.dart';
 
 /// Base type for all LiveKit events.
-mixin LiveKitEvent {}
+mixin LiveKitEvent {
+  /// Every event must provide a useful textual representation for logging.
+  @override
+  String toString();
+}
 
 /// Base type for all [Room] events.
 mixin RoomEvent implements LiveKitEvent {}
@@ -47,6 +51,9 @@ mixin EngineEvent implements LiveKitEvent {}
 /// Base type for all [SignalClient] events.
 mixin SignalEvent implements LiveKitEvent {}
 
+/// Base type for internal-only events.
+mixin InternalEvent implements LiveKitEvent {}
+
 class RoomConnectedEvent with RoomEvent {
   final Room room;
   final String? metadata;
@@ -56,7 +63,7 @@ class RoomConnectedEvent with RoomEvent {
   });
 
   @override
-  String toString() => '${runtimeType}(room: ${room})';
+  String toString() => '${runtimeType}(room: ${room}, metadata: ${metadata})';
 }
 
 /// When the connection to the server has been interrupted and it's attempting
@@ -81,7 +88,9 @@ class RoomAttemptReconnectEvent with RoomEvent {
   });
 
   @override
-  String toString() => '${runtimeType}()';
+  String toString() => '${runtimeType}'
+      '(attempt: ${attempt}, maxAttemptsRetry: ${maxAttemptsRetry}, '
+      'nextRetryDelaysInMs: ${nextRetryDelaysInMs})';
 }
 
 /// Connection to room is re-established. All existing state is preserved.
@@ -102,7 +111,7 @@ class RoomDisconnectedEvent with RoomEvent {
   });
 
   @override
-  String toString() => '${runtimeType}($reason)';
+  String toString() => '${runtimeType}(reason: ${reason})';
 }
 
 /// Room metadata has changed.
@@ -115,7 +124,7 @@ class RoomMetadataChangedEvent with RoomEvent {
   });
 
   @override
-  String toString() => '${runtimeType}()';
+  String toString() => '${runtimeType}(metadata: ${metadata})';
 }
 
 /// Participant's attributes have changed.
@@ -130,7 +139,8 @@ class ParticipantAttributesChanged with RoomEvent, ParticipantEvent {
   });
 
   @override
-  String toString() => '${runtimeType}(participant: ${participant})';
+  String toString() => '${runtimeType}'
+      '(participant: ${participant}, attributes: ${attributes})';
 }
 
 /// Room recording status has changed.
@@ -143,7 +153,7 @@ class RoomRecordingStatusChanged with RoomEvent {
   });
 
   @override
-  String toString() => '${runtimeType}(activeRecording = $activeRecording)';
+  String toString() => '${runtimeType}(activeRecording: ${activeRecording})';
 }
 
 /// When a new [RemoteParticipant] joins *after* the current participant has connected
@@ -238,8 +248,7 @@ class LocalTrackSubscribedEvent with RoomEvent, ParticipantEvent {
   });
 
   @override
-  String toString() => '${runtimeType}'
-      '(trakSid: ${trackSid}})';
+  String toString() => '${runtimeType}(trackSid: ${trackSid})';
 }
 
 /// The local participant has unpublished one of their [Track].
@@ -287,6 +296,10 @@ class TrackSubscriptionExceptionEvent with RoomEvent, ParticipantEvent {
     this.sid,
     required this.reason,
   });
+
+  @override
+  String toString() => '${runtimeType}'
+      '(participant: ${participant}, sid: ${sid}, reason: ${reason})';
 }
 
 /// The [LocalParticipant] has unsubscribed from a track published by a
@@ -370,7 +383,8 @@ class ParticipantMetadataUpdatedEvent with RoomEvent, ParticipantEvent {
   });
 
   @override
-  String toString() => '${runtimeType}(participant: ${participant})';
+  String toString() => '${runtimeType}'
+      '(participant: ${participant}, metadata: ${metadata})';
 }
 
 class ParticipantStateUpdatedEvent with RoomEvent, ParticipantEvent {
@@ -417,7 +431,7 @@ class DataReceivedEvent with RoomEvent, ParticipantEvent {
 
   @override
   String toString() => '${runtimeType}'
-      '(participant: ${participant}, data: ${data})';
+      '(participant: ${participant}, topic: ${topic}, data: ${data})';
 }
 
 /// The participant's isSpeaking property has changed
@@ -470,7 +484,8 @@ class ParticipantPermissionsUpdatedEvent with RoomEvent, ParticipantEvent {
 
   @override
   String toString() => '${runtimeType}'
-      '(participant: ${participant}, permissions: ${permissions})';
+      '(participant: ${participant}, permissions: ${permissions}, '
+      'oldPermissions: ${oldPermissions})';
 }
 
 /// Transcription event received from the server.
@@ -483,6 +498,11 @@ class TranscriptionEvent with RoomEvent, ParticipantEvent {
     required this.publication,
     required this.segments,
   });
+
+  @override
+  String toString() => '${runtimeType}'
+      '(participant: ${participant}, publication: ${publication}, '
+      'segments: ${segments})';
 }
 
 class ParticipantNameUpdatedEvent with RoomEvent, ParticipantEvent {
@@ -505,8 +525,7 @@ class AudioPlaybackStatusChanged with RoomEvent {
   });
 
   @override
-  String toString() => '${runtimeType}'
-      'Audio Playback Status Changed, isPlaying: ${isPlaying})';
+  String toString() => '${runtimeType}(isPlaying: ${isPlaying})';
 }
 
 class AudioSenderStatsEvent with TrackEvent {
@@ -519,7 +538,7 @@ class AudioSenderStatsEvent with TrackEvent {
 
   @override
   String toString() => '${runtimeType}'
-      'stats: ${stats})';
+      '(stats: ${stats}, currentBitrate: ${currentBitrate})';
 }
 
 class VideoSenderStatsEvent with TrackEvent {
@@ -534,7 +553,8 @@ class VideoSenderStatsEvent with TrackEvent {
 
   @override
   String toString() => '${runtimeType}'
-      'stats: ${stats})';
+      '(stats: ${stats}, bitrateForLayers: ${bitrateForLayers}, '
+      'currentBitrate: ${currentBitrate})';
 }
 
 class AudioReceiverStatsEvent with TrackEvent {
@@ -547,7 +567,7 @@ class AudioReceiverStatsEvent with TrackEvent {
 
   @override
   String toString() => '${runtimeType}'
-      'stats: ${stats})';
+      '(stats: ${stats}, currentBitrate: ${currentBitrate})';
 }
 
 class VideoReceiverStatsEvent with TrackEvent {
@@ -560,7 +580,7 @@ class VideoReceiverStatsEvent with TrackEvent {
 
   @override
   String toString() => '${runtimeType}'
-      'stats: ${stats})';
+      '(stats: ${stats}, currentBitrate: ${currentBitrate})';
 }
 
 class AudioVisualizerEvent with TrackEvent {
@@ -572,8 +592,7 @@ class AudioVisualizerEvent with TrackEvent {
   });
 
   @override
-  String toString() => '${runtimeType}'
-      'track: ${track})';
+  String toString() => '${runtimeType}(track: ${track}, event: ${event})';
 }
 
 class TrackProcessorUpdateEvent with TrackEvent {
@@ -586,7 +605,7 @@ class TrackProcessorUpdateEvent with TrackEvent {
 
   @override
   String toString() => '${runtimeType}'
-      'track: ${track})';
+      '(track: ${track}, processor: ${processor})';
 }
 
 /// Pre-connect audio buffer has started recording.