some more cleanup

Author: xianshijing-lk

examples/simple_data_stream/main.cpp

@@ -187,7 +187,7 @@ void handleWelcomeImage(std::shared_ptr<livekit::ByteStreamReader> reader,
 } // namespace
 
 int main(int argc, char *argv[]) {
-  // Get URL and token from env, like the Python example
+  // Get URL and token from env.
   std::string url = getenvOrEmpty("LIVEKIT_URL");
   std::string token = getenvOrEmpty("LIVEKIT_TOKEN");
 

include/livekit/audio_frame.h

@@ -85,7 +85,7 @@ class AudioFrame {
   /// Duration in seconds (samples_per_channel / sample_rate).
   double duration() const noexcept;
 
-  /// A human-readable description (like Python __repr__).
+  /// A human-readable description.
   std::string to_string() const;
 
 private:

include/livekit/audio_source.h

@@ -102,11 +102,6 @@ class AudioSource {
    */
   void captureFrame(const AudioFrame &frame, int timeout_ms = 20);
 
-  /**
-   * Block until the currently queued audio has (roughly) played out.
-   */
-  void waitForPlayout() const;
-
 private:
   // Internal helper to reset the local queue tracking (like _release_waiter).
   void resetQueueTracking() noexcept;

include/livekit/data_stream.h

@@ -31,8 +31,10 @@ namespace livekit {
 
 class LocalParticipant;
 
-// Same size as Python STREAM_CHUNK_SIZE
-constexpr std::size_t kStreamChunkSize = 15'000;
+// Chunk size for data streams (matches Python STREAM_CHUNK_SIZE).
+// Chosen to balance throughput and latency, and to work well with WebRTC data
+// channels.
+constexpr std::size_t kStreamChunkSize = 15'000; // 15 KB
 
 /// Base metadata for any stream (text or bytes).
 struct BaseStreamInfo {
@@ -67,11 +69,9 @@ struct ByteStreamInfo : BaseStreamInfo {
   std::string name;
 };
 
-// ---------------------------------------------------------------------
 // Readers
 //   - TextStreamReader: yields UTF-8 text chunks (std::string)
 //   - ByteStreamReader: yields raw bytes (std::vector<uint8_t>)
-// ---------------------------------------------------------------------
 
 /// Reader for incoming text streams.
 /// Created internally by the SDK when a text stream header is received.
@@ -149,10 +149,6 @@ class ByteStreamReader {
   std::condition_variable cv_;
 };
 
-// ---------------------------------------------------------------------
-// Writers (sync API mirroring Python BaseStreamWriter/TextStreamWriter)
-// ---------------------------------------------------------------------
-
 /// Base class for sending data streams.
 /// Concrete subclasses are TextStreamWriter and ByteStreamWriter.
 class BaseStreamWriter {

include/livekit/remote_participant.h

@@ -46,7 +46,6 @@ class RemoteParticipant : public Participant {
     return track_publications_;
   }
 
-  // C++ equivalent of Python's __repr__
   std::string to_string() const;
 
 protected:

include/livekit/room.h

@@ -36,7 +36,6 @@ class LocalParticipant;
 class RemoteParticipant;
 
 /// Represents end-to-end encryption (E2EE) settings.
-/// Mirrors python sdk: `E2EEOptions`
 struct E2EEOptions {
   // Encryption algorithm type.
   int encryption_type = 0;
@@ -55,7 +54,6 @@ struct E2EEOptions {
 };
 
 // Represents a single ICE server configuration.
-// Mirrors python: RtcConfiguration.ice_servers[*]
 struct IceServer {
   // TURN/STUN server URL (e.g. "stun:stun.l.google.com:19302").
   std::string url;
@@ -68,7 +66,6 @@ struct IceServer {
 };
 
 // WebRTC configuration (ICE, transport, etc.).
-// Mirrors python: `RtcConfiguration`
 struct RtcConfig {
   // ICE transport type (e.g., ALL, RELAY). Maps to proto::IceTransportType.
   int ice_transport_type = 0;
@@ -82,7 +79,6 @@ struct RtcConfig {
 };
 
 // Top-level room connection options.
-// Mirrors python: `RoomOptions`
 struct RoomOptions {
   // If true (default), automatically subscribe to all remote tracks.
   // This is CRITICAL. Without auto_subscribe, you will never receive:
@@ -195,7 +191,7 @@ class Room {
    * Notes:
    *   - Only one handler may be registered per topic.
    *   - If no handler is registered for a topic, incoming streams with that
-   *     topic are ignored (mirrors Python SDK behavior).
+   *     topic are ignored.
    *   - The handler is invoked on the Room event thread. The handler must
    *     not block; spawn a background thread if synchronous reading is
    *     required.

include/livekit/rpc_error.h

@@ -40,7 +40,7 @@ class RpcError;
 class RpcError : public std::runtime_error {
 public:
   /**
-   * Built-in error codes, mirroring the Python RpcError.ErrorCode enum.
+   * Built-in error codes
    */
   enum class ErrorCode : std::uint32_t {
     APPLICATION_ERROR = 1500,
@@ -97,7 +97,7 @@ class RpcError : public std::runtime_error {
 
   /**
    * Create a built-in RpcError using a predefined ErrorCode and default
-   * message text that matches the Python RpcError.ErrorMessage table.
+   * message text.
    *
    * @param code  Built-in error code.
    * @param data  Optional extra data payload (JSON recommended).

src/audio_source.cpp

@@ -128,16 +128,4 @@ void AudioSource::captureFrame(const AudioFrame &frame, int timeout_ms) {
   }
 }
 
-void AudioSource::waitForPlayout() const {
-  // Python uses a future + event loop timer that fires after q_size.
-  // Here we approximate that by simply sleeping for the current queued
-  // duration.
-  double dur = queuedDuration();
-  if (dur <= 0.0) {
-    return;
-  }
-
-  std::this_thread::sleep_for(std::chrono::duration<double>(dur));
-}
-
 } // namespace livekit

src/audio_stream.cpp

@@ -212,10 +212,6 @@ void AudioStream::onFfiEvent(const FfiEvent &event) {
   }
   if (ase.has_frame_received()) {
     const auto &fr = ase.frame_received();
-
-    // Convert owned buffer -> AudioFrame via helper.
-    // Implement AudioFrame::fromOwnedInfo(...) to mirror Python's
-    // AudioFrame._from_owned_info.
     AudioFrame frame = AudioFrame::fromOwnedInfo(fr.frame());
     AudioFrameEvent ev{std::move(frame)};
     pushFrame(std::move(ev));

src/data_stream.cpp

@@ -29,7 +29,6 @@ std::string generateRandomId(std::size_t bytes = 16) {
 }
 
 // Split UTF-8 string into chunks of at most max_bytes, not breaking codepoints.
-// Mimics Python split_utf8 helper.
 std::vector<std::string> splitUtf8(const std::string &s,
                                    std::size_t max_bytes) {
   std::vector<std::string> result;
@@ -69,14 +68,6 @@ std::vector<std::string> splitUtf8(const std::string &s,
   return result;
 }
 
-std::map<std::string, std::string>
-toMap(const google::protobuf::Map<std::string, std::string> &m) {
-  std::map<std::string, std::string> out;
-  for (const auto &kv : m)
-    out.emplace(kv.first, kv.second);
-  return out;
-}
-
 void fillBaseInfo(BaseStreamInfo &dst, const std::string &stream_id,
                   const std::string &mime_type, const std::string &topic,
                   std::int64_t timestamp_ms,