video_stream.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 <condition_variable>
#include <cstdint>
#include <deque>
#include <functional>
#include <memory>
#include <mutex>
#include <optional>
 
#include "livekit/ffi_handle.h"
#include "livekit/participant.h"
#include "livekit/track.h"
#include "livekit/video_frame.h"
#include "livekit/video_source.h"
#include "livekit/visibility.h"
 
namespace livekit {
 
struct VideoFrameEvent {
  VideoFrame frame;
  std::int64_t timestamp_us;
  VideoRotation rotation;
  std::optional<VideoFrameMetadata> metadata;
};
 
namespace proto {
class FfiEvent;
}
 
class LIVEKIT_API VideoStream {
public:
  struct Options {
    std::size_t capacity{0};
 
    VideoBufferType format{VideoBufferType::RGBA};
  };
 
  static std::shared_ptr<VideoStream> fromTrack(const std::shared_ptr<Track>& track, const Options& options);
 
  static std::shared_ptr<VideoStream> fromParticipant(Participant& participant, TrackSource track_source,
                                                      const Options& options);
 
  virtual ~VideoStream();
 
  VideoStream(const VideoStream&) = delete;
  VideoStream& operator=(const VideoStream&) = delete;
  VideoStream(VideoStream&&) noexcept;
  VideoStream& operator=(VideoStream&&) noexcept;
 
  bool read(VideoFrameEvent& out);
 
  void close();
 
private:
  VideoStream() = default;
 
  // Internal init helpers, used by the factories
  void initFromTrack(const std::shared_ptr<Track>& track, const Options& options);
  void initFromParticipant(Participant& participant, TrackSource source, const Options& options);
 
  // FFI event handler (registered with FfiClient)
  void onFfiEvent(const proto::FfiEvent& event);
 
  // Queue helpers
  void pushFrame(VideoFrameEvent&& ev);
  void pushEos();
 
  mutable std::mutex mutex_;
  std::condition_variable cv_;
  std::deque<VideoFrameEvent> queue_;
  std::size_t capacity_{0};
  bool eof_{false};
  bool closed_{false};
 
  // Underlying FFI handle for the video stream
  FfiHandle stream_handle_;
 
  // Listener id registered on FfiClient
  std::int32_t listener_id_{0};
};
 
} // namespace livekit