video_source.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 <cstdint>
#include <optional>
#include <vector>
 
#include "livekit/ffi_handle.h"
#include "livekit/visibility.h"
 
namespace livekit {
 
class VideoFrame;
class EncodedVideoSource;
struct VideoSourceAccess;
 
enum class VideoRotation {
  VIDEO_ROTATION_0 = 0,
  VIDEO_ROTATION_90 = 90,
  VIDEO_ROTATION_180 = 180,
  VIDEO_ROTATION_270 = 270,
};
 
struct VideoFrameMetadata {
  std::optional<std::uint64_t> user_timestamp_us;
  std::optional<std::uint32_t> frame_id;
  std::optional<std::vector<std::uint8_t>> user_data;
};
 
struct VideoCaptureOptions {
  std::int64_t timestamp_us = 0;
  VideoRotation rotation = VideoRotation::VIDEO_ROTATION_0;
  std::optional<VideoFrameMetadata> metadata;
};
 
class LIVEKIT_API VideoSource {
public:
  VideoSource(int width, int height);
  virtual ~VideoSource() = default;
 
  VideoSource(const VideoSource&) = delete;
  VideoSource& operator=(const VideoSource&) = delete;
  VideoSource(VideoSource&&) noexcept = default;
  VideoSource& operator=(VideoSource&&) noexcept = default;
 
  int width() const noexcept { return width_; }
  int height() const noexcept { return height_; }
 
  std::uint64_t ffiHandleId() const noexcept { return handle_.get(); }
 
  void captureFrame(const VideoFrame& frame, const VideoCaptureOptions& options);
 
  void captureFrame(const VideoFrame& frame, std::int64_t timestamp_us = 0,
                    VideoRotation rotation = VideoRotation::VIDEO_ROTATION_0);
 
private:
  friend class EncodedVideoSource;
  friend struct VideoSourceAccess;
 
  enum class SourceType { Native, Encoded };
  VideoSource(int width, int height, SourceType source_type);
 
  VideoSource(FfiHandle&& handle, int width, int height) noexcept
      : handle_(std::move(handle)), width_(width), height_(height) {}
 
  FfiHandle handle_; // owned FFI handle
  int width_{0};
  int height_{0};
};
 
} // namespace livekit