video_frame.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 <cstddef>
#include <cstdint>
#include <optional>
#include <vector>
 
namespace livekit {
 
// Mirror of WebRTC video buffer type
enum class VideoBufferType {
  RGBA = 0,
  ABGR,
  ARGB,
  BGRA,
  RGB24,
  I420,
  I420A,
  I422,
  I444,
  I010,
  NV12
};
 
struct VideoPlaneInfo {
  std::uintptr_t data_ptr; // pointer to plane data (for FFI)
  std::uint32_t stride;    // bytes per row
  std::uint32_t size;      // plane size in bytes
};
 
namespace proto {
class OwnedVideoBuffer;
}
 
class VideoFrame {
public:
  VideoFrame();
  VideoFrame(int width, int height, VideoBufferType type,
               std::vector<std::uint8_t> data);
  virtual ~VideoFrame() = default;
 
  VideoFrame(const VideoFrame &) = delete;
  VideoFrame &operator=(const VideoFrame &) = delete;
  VideoFrame(VideoFrame &&) noexcept = default;
  VideoFrame &operator=(VideoFrame &&) noexcept = default;
 
  static VideoFrame create(int width, int height, VideoBufferType type);
 
  // Basic properties
  int width() const noexcept { return width_; }
  int height() const noexcept { return height_; }
  VideoBufferType type() const noexcept { return type_; }
 
  std::uint8_t *data() noexcept { return data_.data(); }
  const std::uint8_t *data() const noexcept { return data_.data(); }
  std::size_t dataSize() const noexcept { return data_.size(); }
 
  std::vector<VideoPlaneInfo> planeInfos() const;
 
  VideoFrame convert(VideoBufferType dst, bool flip_y = false) const;
 
protected:
  friend class VideoStream;
  // Only internal classes (e.g., VideoStream)
  // should construct frames directly from FFI buffers.
  static VideoFrame fromOwnedInfo(const proto::OwnedVideoBuffer &owned);
 
private:
  int width_;
  int height_;
  VideoBufferType type_;
  std::vector<std::uint8_t> data_;
};
 
} // namespace livekit