FileInterface.hpp

Go to the documentation of this file.

#pragma once
#include "aare/core/DType.hpp"
#include "aare/core/Frame.hpp"
#include "aare/core/defs.hpp"
#include <filesystem>
#include <vector>
 
namespace aare {
 
struct FileConfig {
    aare::DType dtype = aare::DType(typeid(uint16_t));
    uint64_t rows;
    uint64_t cols;
    xy geometry{1, 1};
    bool operator==(const FileConfig &other) const {
        return dtype == other.dtype && rows == other.rows && cols == other.cols && geometry == other.geometry;
    }
    bool operator!=(const FileConfig &other) const { return !(*this == other); }
};
 
class FileInterface {
  public:
    virtual void write(Frame &frame) = 0;
 
    // virtual void write(std::vector<Frame> &frames) = 0;
 
    virtual Frame read() = 0;
 
    virtual std::vector<Frame> read(size_t n_frames) = 0; // Is this the right interface?
 
    virtual void read_into(std::byte *image_buf) = 0;
 
    virtual void read_into(std::byte *image_buf, size_t n_frames) = 0;
 
    virtual size_t frame_number(size_t frame_index) = 0;
 
    virtual size_t bytes_per_frame() = 0;
 
    virtual size_t pixels() = 0;
 
    virtual void seek(size_t frame_number) = 0;
 
    virtual size_t tell() = 0;
 
    virtual size_t total_frames() const = 0;
    virtual ssize_t rows() const = 0;
    virtual ssize_t cols() const = 0;
    virtual ssize_t bitdepth() const = 0;
 
    Frame iread(size_t frame_number) {
        auto old_pos = tell();
        seek(frame_number);
        Frame tmp = read();
        seek(old_pos);
        return tmp;
    };
 
    std::vector<Frame> iread(size_t frame_number, size_t n_frames) {
        auto old_pos = tell();
        seek(frame_number);
        std::vector<Frame> tmp = read(n_frames);
        seek(old_pos);
        return tmp;
    }
 
    // function to query the data type of the file
    /*virtual DataType dtype = 0; */
 
    virtual ~FileInterface(){
 
    };
 
  public:
    std::string m_mode;
    std::filesystem::path m_fname;
    std::filesystem::path m_base_path;
    std::string m_base_name, m_ext;
    int m_findex;
    size_t m_total_frames{};
    size_t max_frames_per_file{};
    std::string version;
    DetectorType m_type;
    ssize_t m_rows{};
    ssize_t m_cols{};
    ssize_t m_bitdepth{};
    size_t current_frame{};
};
 
} // namespace aare