sam3_assets.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Povl Filip Sonne-Frederiksen
//
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include "reusex/vision/sam3/EngineBuildProfiles.hpp"
 
#include <atomic>
#include <filesystem>
#include <functional>
#include <stdexcept>
#include <string>
#include <vector>
 
namespace reusex::vision::sam3 {

enum class PrepState {
  absent,      
  not_built,   
  downloading, 
  building,    
  ready,       
  error        
};
 
const char *to_string(PrepState state);

class Sam3PrepCancelled : public std::runtime_error {
    public:
  using std::runtime_error::runtime_error;
};

struct PrepProgress {
  PrepState state = PrepState::absent;
  float fraction = 0.0f; 
  std::string message;   
  std::vector<std::string> update_engines;
};
 
using ProgressCallback = std::function<void(const PrepProgress &)>;

struct Sam3AssetOptions {
  std::filesystem::path models_dir;

  std::string manifest_url;

  bool allow_download = true;

  bool use_cuda = true;

  const std::atomic<bool> *cancel = nullptr;
};

const std::vector<std::string> &required_engines();

std::filesystem::path
resolve_models_dir(const std::filesystem::path &explicit_dir = {});

std::filesystem::path sam3_onnx_dir(const Sam3AssetOptions &opts);

std::filesystem::path sam3_engine_dir(const Sam3AssetOptions &opts);

std::vector<std::string>
missing_onnx_files(const std::filesystem::path &onnx_dir);

std::vector<std::string>
missing_engine_files(const std::filesystem::path &onnx_dir,
                     const std::filesystem::path &engine_dir);

EngineBuildProfiles
load_engine_build_profiles(const std::filesystem::path &onnx_dir);

std::vector<std::string> stale_engines(const std::filesystem::path &onnx_dir,
                                       const std::filesystem::path &engine_dir);

std::vector<std::string>
fallback_engines(const std::filesystem::path &engine_dir);

std::vector<std::string>
fallback_engines_to_retry(const std::filesystem::path &onnx_dir,
                          const std::filesystem::path &engine_dir);

PrepProgress sam3_status(const Sam3AssetOptions &opts);

std::filesystem::path prepare_sam3_model(const Sam3AssetOptions &opts,
                                         const ProgressCallback &cb = {});
 
} // namespace reusex::vision::sam3