video_source.hpp

// video_source.hpp
// Created by Greg on 2/29/2024.
// Copyright (C) 2025 Presage Security, Inc.
//
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#pragma once
// === standard library includes (if any) ===
#include <cstdint>
#include <vector>
// === third-party includes (if any) ===
#include <mediapipe/framework/port/opencv_core_inc.h>
#include <absl/status/statusor.h>
// === local includes (if any) ===
#include "settings.hpp"
#include "input_transformer.hpp"

 
namespace presage::smartspectra::video_source {

class VideoSource {
public:
    VideoSource& operator>>(cv::Mat& frame);

    virtual absl::Status Initialize(const VideoSourceSettings& settings);
 
    virtual ~VideoSource() = default;
 
    // == timestamp controls
    virtual bool SupportsExactFrameTimestamp() const = 0;

    virtual int64_t GetFrameTimestamp() const = 0;
 
    // These have definitions here, technically making this not a true interface.
    // Ignore this for now, maybe redesign later, (e.g. using C++20 concepts?).
 
    // == exposure controls ==

    virtual absl::Status TurnOnAutoExposure();

    virtual absl::Status TurnOffAutoExposure();

    virtual absl::Status ToggleAutoExposure();

    virtual absl::StatusOr<bool> IsAutoExposureOn();

    virtual absl::Status IncreaseExposure();

    virtual absl::Status DecreaseExposure();

    virtual absl::Status SetExposure(double value);

    virtual absl::StatusOr<double> GetExposure();

    virtual bool SupportsExposureControls();
 
    // == white balance controls ==

    virtual bool SupportsWhiteBalanceControls();

    virtual absl::Status TurnOnAutoWhiteBalance();

    virtual absl::Status TurnOffAutoWhiteBalance();

    virtual absl::Status ToggleAutoWhiteBalance();

    virtual absl::StatusOr<bool> IsAutoWhiteBalanceOn();

    virtual absl::Status IncreaseWhiteBalance();

    virtual absl::Status DecreaseWhiteBalance();

    virtual absl::Status SetWhiteBalance(double value);

    virtual absl::StatusOr<double> GetWhiteBalance();
 
    // == gain controls ==

    virtual bool SupportsGainControl();

    virtual absl::Status IncreaseGain();

    virtual absl::Status DecreaseGain();

    virtual absl::Status SetGain(double value);

    virtual absl::StatusOr<double> GetGain();
 
    virtual int GetWidth();
 
    virtual int GetHeight();
 
    virtual InputTransformMode GetDefaultInputTransformMode();

    bool HasFrameDimensions();
 
    // == compressed frame support
    virtual bool SupportsCompressedOutput();

    virtual bool ProduceCompressedFrame(std::vector<uint8_t>& jpeg_data);
 
protected:
    InputTransformer input_transformer;
    virtual void ProducePreTransformFrame(cv::Mat& frame) = 0;
};
 
 
} // namespace presage::smartspectra::video_source