room.h

/*
 * Copyright 2025 LiveKit
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an “AS IS” BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef LIVEKIT_ROOM_H
#define LIVEKIT_ROOM_H
 
#include "livekit/data_stream.h"
#include "livekit/e2ee.h"
#include "livekit/ffi_handle.h"
#include "livekit/room_event_types.h"
#include "livekit/subscription_thread_dispatcher.h"
 
#include <cstdint>
#include <memory>
#include <mutex>
 
namespace livekit {
 
class RoomDelegate;
struct RoomInfoData;
namespace proto {
class FfiEvent;
}
 
struct E2EEOptions;
class E2EEManager;
class LocalParticipant;
class RemoteParticipant;
 
// Represents a single ICE server configuration.
struct IceServer {
  // TURN/STUN server URL (e.g. "stun:stun.l.google.com:19302").
  std::string url;
 
  // Optional username for TURN authentication.
  std::string username;
 
  // Optional credential (password) for TURN authentication.
  std::string credential;
};
 
// WebRTC configuration (ICE, transport, etc.).
struct RtcConfig {
  // ICE transport type (e.g., ALL, RELAY). Maps to proto::IceTransportType.
  int ice_transport_type = 0;
 
  // Continuous or single ICE gathering. Maps to
  // proto::ContinualGatheringPolicy.
  int continual_gathering_policy = 0;
 
  // List of STUN/TURN servers for ICE candidate generation.
  std::vector<IceServer> ice_servers;
};
 
// Top-level room connection options.
struct RoomOptions {
  // If true (default), automatically subscribe to all remote tracks.
  // This is CRITICAL. Without auto_subscribe, you will never receive:
  //   - `track_subscribed` events
  //   - remote audio/video frames
  bool auto_subscribe = true;
 
  // Enable dynacast (server sends optimal layers depending on subscribers).
  bool dynacast = false;
 
  // Enable single peer connection mode. When true, uses one RTCPeerConnection
  // for both publishing and subscribing instead of two separate connections.
  // Falls back to dual peer connection if the server doesn't support single PC.
  bool single_peer_connection = true;
 
  // Optional WebRTC configuration (ICE policy, servers, etc.)
  std::optional<RtcConfig> rtc_config;
 
  // Optional end-to-end encryption settings.
  std::optional<E2EEOptions> encryption;
};
 
class Room {
public:
  Room();
  ~Room();
 
  /* Assign a RoomDelegate that receives room lifecycle callbacks.
   *
   * The delegate must remain valid for the lifetime of the Room or until a
   * different delegate is assigned. The Room does not take ownership.
   * Typical usage:
   *     class MyDelegate : public RoomDelegate { ... };
   *     MyDelegate del;
   *     Room room;
   *     room.setDelegate(&del);
   */
  void setDelegate(RoomDelegate *delegate);
 
  /* Connect to a LiveKit room using the given URL and token,  applying the
   * supplied connection options.
   *
   * Parameters:
   *   url      — WebSocket URL of the LiveKit server.
   *   token    — Access token for authentication.
   *   options  — Connection options controlling auto-subscribe,
   *               dynacast, E2EE, and WebRTC configuration.
   * Behavior:
   *   - Registers an FFI event listener *before* sending the connect request.
   *   - Sends a proto::FfiRequest::Connect with the URL, token,
   *     and the provided RoomOptions.
   *   - Blocks until the FFI connect response arrives.
   *   - Initializes local participant and remote participants.
   *   - Emits room/participant/track events to the delegate.
   * IMPORTANT:
   *   RoomOptions defaults auto_subscribe = true.
   *   Without auto_subscribe enabled, remote tracks will NOT be subscribed
   *   automatically, and no remote audio/video will ever arrive.
   */
  bool Connect(const std::string &url, const std::string &token,
               const RoomOptions &options);
 
  // Accessors
 
  /* Retrieve static metadata about the room.
   * This contains fields such as:
   *   - SID
   *   - room name
   *   - metadata
   *   - participant counts
   *   - creation timestamp
   */
  RoomInfoData room_info() const;
 
  /* Get the local participant.
   *
   * This object represents the current user, including:
   *   - published tracks (audio/video/screen)
   *   - identity, SID, metadata
   *   - publishing/unpublishing operations
   * Return value:
   *   Non-null pointer after successful Connect().
   */
  LocalParticipant *localParticipant() const;
 
  /* Look up a remote participant by identity.
   *
   * Parameters:
   *   identity — The participant’s identity string (not SID)
   * Return value:
   *   Pointer to RemoteParticipant if present, otherwise nullptr.
   * RemoteParticipant contains:
   *   - identity/name/metadata
   *   - track publications
   *  - callbacks for track subscribed/unsubscribed, muted/unmuted
   */
  RemoteParticipant *remoteParticipant(const std::string &identity) const;
 
  std::vector<std::shared_ptr<RemoteParticipant>> remoteParticipants() const;
 
  /* Register a handler for incoming text streams on a specific topic.
   *
   * When a remote participant opens a text stream with the given topic,
   * the handler is invoked with:
   *   - a shared_ptr<TextStreamReader> for consuming the stream
   *   - the identity of the participant who sent the stream
   *
   * Notes:
   *   - Only one handler may be registered per topic.
   *   - If no handler is registered for a topic, incoming streams with that
   *     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.
   *
   * Throws:
   *   std::runtime_error if a handler is already registered for the topic.
   */
  void registerTextStreamHandler(const std::string &topic,
                                 TextStreamHandler handler);
 
  /* Unregister the text stream handler for the given topic.
   *
   * If no handler exists for the topic, this function is a no-op.
   */
  void unregisterTextStreamHandler(const std::string &topic);
 
  /* Register a handler for incoming byte streams on a specific topic.
   *
   * When a remote participant opens a byte stream with the given topic,
   * the handler is invoked with:
   *   - a shared_ptr<ByteStreamReader> for consuming the stream
   *   - the identity of the participant who sent the stream
   *
   * Notes:
   *   - Only one handler may be registered per topic.
   *   - If no handler is registered for a topic, incoming streams with that
   *     topic are ignored.
   *   - The ByteStreamReader remains valid as long as the shared_ptr is held,
   *     preventing lifetime-related crashes when reading asynchronously.
   *
   * Throws:
   *   std::runtime_error if a handler is already registered for the topic.
   */
  void registerByteStreamHandler(const std::string &topic,
                                 ByteStreamHandler handler);
 
  /* Unregister the byte stream handler for the given topic.
   *
   * If no handler exists for the topic, this function is a no-op.
   */
  void unregisterByteStreamHandler(const std::string &topic);
 
  E2EEManager *e2eeManager() const;
 
  // ---------------------------------------------------------------
  // Frame callbacks
  // ---------------------------------------------------------------
 
  void setOnAudioFrameCallback(const std::string &participant_identity,
                               TrackSource source, AudioFrameCallback callback,
                               const AudioStream::Options &opts = {});
 
  void setOnAudioFrameCallback(const std::string &participant_identity,
                               const std::string &track_name,
                               AudioFrameCallback callback,
                               const AudioStream::Options &opts = {});
 
  void setOnVideoFrameCallback(const std::string &participant_identity,
                               TrackSource source, VideoFrameCallback callback,
                               const VideoStream::Options &opts = {});
 
  void setOnVideoFrameCallback(const std::string &participant_identity,
                               const std::string &track_name,
                               VideoFrameCallback callback,
                               const VideoStream::Options &opts = {});
 
  void setOnVideoFrameEventCallback(const std::string &participant_identity,
                                    const std::string &track_name,
                                    VideoFrameEventCallback callback,
                                    const VideoStream::Options &opts = {});
 
  void clearOnAudioFrameCallback(const std::string &participant_identity,
                                 TrackSource source);
  void clearOnAudioFrameCallback(const std::string &participant_identity,
                                 const std::string &track_name);
 
  void clearOnVideoFrameCallback(const std::string &participant_identity,
                                 TrackSource source);
 
  void clearOnVideoFrameCallback(const std::string &participant_identity,
                                 const std::string &track_name);
 
  DataFrameCallbackId
  addOnDataFrameCallback(const std::string &participant_identity,
                         const std::string &track_name,
                         DataFrameCallback callback);
 
  void removeOnDataFrameCallback(DataFrameCallbackId id);
 
private:
  friend class RoomCallbackTest;
 
  mutable std::mutex lock_;
  ConnectionState connection_state_ = ConnectionState::Disconnected;
  RoomDelegate *delegate_ = nullptr; // Not owned
  RoomInfoData room_info_;
  std::shared_ptr<FfiHandle> room_handle_;
  std::unique_ptr<LocalParticipant> local_participant_;
  std::unordered_map<std::string, std::shared_ptr<RemoteParticipant>>
      remote_participants_;
  // Data stream
  std::unordered_map<std::string, TextStreamHandler> text_stream_handlers_;
  std::unordered_map<std::string, ByteStreamHandler> byte_stream_handlers_;
  std::unordered_map<std::string, std::shared_ptr<TextStreamReader>>
      text_stream_readers_;
  std::unordered_map<std::string, std::shared_ptr<ByteStreamReader>>
      byte_stream_readers_;
  // E2EE
  std::unique_ptr<E2EEManager> e2ee_manager_;
  std::shared_ptr<SubscriptionThreadDispatcher> subscription_thread_dispatcher_;
 
  // FfiClient listener ID (0 means no listener registered)
  int listener_id_{0};
 
  void OnEvent(const proto::FfiEvent &event);
};
} // namespace livekit
 
#endif /* LIVEKIT_ROOM_H */