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.
 */
 
#pragma once
 
#include <chrono>
#include <cstdint>
#include <future>
#include <memory>
#include <mutex>
 
#include "livekit/audio_stream.h"
#include "livekit/data_stream.h"
#include "livekit/e2ee.h"
#include "livekit/ffi_handle.h"
#include "livekit/room_callbacks.h"
#include "livekit/room_event_types.h"
#include "livekit/stats.h"
#include "livekit/video_stream.h"
#include "livekit/visibility.h"
 
namespace livekit {
 
class RoomDelegate;
struct RoomInfoData;
namespace proto {
class FfiEvent;
}
 
struct E2EEOptions;
class E2EEManager;
class LocalParticipant;
class RemoteParticipant;
class SubscriptionThreadDispatcher;
 
struct IceServer {
  std::string url;
 
  std::string username;
 
  std::string credential;
};
 
struct RtcConfig {
  int ice_transport_type = 0;
 
  int continual_gathering_policy = 0;
 
  std::vector<IceServer> ice_servers;
};
 
struct RoomOptions {
  bool auto_subscribe = true;
 
  std::optional<bool> adaptive_stream;
 
  bool dynacast = false;
 
  std::optional<E2EEOptions> encryption;
 
  std::optional<RtcConfig> rtc_config;
 
  std::optional<std::uint32_t> join_retries;
 
  bool single_peer_connection = true;
 
  std::optional<std::chrono::milliseconds> connect_timeout;
 
  std::optional<std::string> other_sdks;
};
 
class LIVEKIT_API Room {
public:
  Room();
  ~Room();
 
  void setDelegate(RoomDelegate* delegate);
 
  bool connect(const std::string& url, const std::string& token, const RoomOptions& options);
 
  bool disconnect(DisconnectReason reason = DisconnectReason::ClientInitiated);
 
  // Accessors
 
  RoomInfoData roomInfo() const;
 
  std::weak_ptr<LocalParticipant> localParticipant() const;
 
  std::weak_ptr<RemoteParticipant> remoteParticipant(const std::string& identity) const;
 
  std::vector<std::weak_ptr<RemoteParticipant>> remoteParticipants() const;
 
  ConnectionState connectionState() const;
 
  std::future<SessionStats> getStats() const;
 
  void registerTextStreamHandler(const std::string& topic, TextStreamHandler handler);
 
  void unregisterTextStreamHandler(const std::string& topic);
 
  void registerByteStreamHandler(const std::string& topic, ByteStreamHandler handler);
 
  void unregisterByteStreamHandler(const std::string& topic);
 
  std::weak_ptr<E2EEManager> e2eeManager() const;
 
  // ---------------------------------------------------------------
  // Frame callbacks
  // ---------------------------------------------------------------
 
  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, 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, const std::string& track_name);
 
  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 struct RoomTestAccess;
 
  mutable std::mutex lock_;
  ConnectionState connection_state_ = ConnectionState::Disconnected;
  RoomDelegate* delegate_ = nullptr; // Not owned
  RoomInfoData room_info_;
  std::shared_ptr<FfiHandle> room_handle_;
  std::shared_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_;
  // The E2EE manager is owned by the room and is not shared with other objects.
  // It is a shared_ptr just to utilize the weak_ptr interface for the e2eeManager() accessor.
  std::shared_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);
 
  // Shared shutdown path for explicit disconnect, server disconnect, EOS, and destruction.
  bool shutdown(bool disconnect_ffi, DisconnectReason reason, bool notify_delegate);
};
} // namespace livekit