image_frame.h

Go to the documentation of this file.

#pragma once
#include <optional>
#include <vector>
#include <memory>
#ifdef WEBCFACE_MESON
#include "webcface-config.h"
#else
#include "webcface/common/webcface-config.h"
#endif
 
WEBCFACE_NS_BEGIN
namespace message {
struct ImageFrame;
} // namespace message
 
enum class ImageColorMode {
    gray = 0,
    bgr = 1,
    bgra = 2,
    rgb = 3,
    rgba = 4,
};
enum class ImageCompressMode {
    raw = 0,
    jpeg = 1,
    webp = 2,
    png = 3,
};
 
class Size {
    int w_ = 0, h_ = 0;
    Size(int width, int height) : w_(width), h_(height) {}
 
  public:
    Size() = default;
    friend Size WEBCFACE_CALL sizeWH(int width, int height);
    friend Size WEBCFACE_CALL sizeHW(int height, int width);
    int width() const { return w_; }
    int height() const { return h_; }
    int rows() const { return h_; }
    int cols() const { return w_; }
};
 
inline Size WEBCFACE_CALL sizeWH(int width, int height) {
    return Size{width, height};
}
inline Size WEBCFACE_CALL sizeHW(int height, int width) {
    return Size{width, height};
}
 
class SizeOption {
    std::optional<int> w_, h_;
    SizeOption(std::optional<int> width, std::optional<int> height)
        : w_(width), h_(height) {}
 
  public:
    SizeOption() = default;
    SizeOption(const Size &s) : w_(s.width()), h_(s.height()) {}
    friend SizeOption WEBCFACE_CALL sizeWH(std::optional<int> width,
                                           std::optional<int> height);
    friend SizeOption WEBCFACE_CALL sizeHW(std::optional<int> height,
                                           std::optional<int> width);
    std::optional<int> rows() const { return h_; }
    std::optional<int> cols() const { return w_; }
};
 
inline SizeOption WEBCFACE_CALL sizeWH(std::optional<int> width,
                                       std::optional<int> height) {
    return SizeOption{width, height};
}
inline SizeOption WEBCFACE_CALL sizeHW(std::optional<int> height,
                                       std::optional<int> width) {
    return SizeOption{width, height};
}
 
class WEBCFACE_DLL ImageFrame {
  protected:
    Size size_;
    std::shared_ptr<std::vector<unsigned char>> data_;
    ImageColorMode color_mode_;
    ImageCompressMode cmp_mode_;
 
  public:
    ImageFrame();
    ImageFrame(const Size &size,
               const std::shared_ptr<std::vector<unsigned char>> &data,
               ImageColorMode color_mode = ImageColorMode::bgr,
               ImageCompressMode cmp_mode = ImageCompressMode::raw);
    ImageFrame(const message::ImageFrame &m);
    message::ImageFrame toMessage() const;
 
    ImageFrame(const ImageFrame &);
    ImageFrame &operator=(const ImageFrame &);
    ImageFrame(ImageFrame &&) noexcept;
    ImageFrame &operator=(ImageFrame &&) noexcept;
 
    [[deprecated("Ambiguous image size")]] ImageFrame(
        int rows, int cols, const void *data,
        ImageColorMode color_mode = ImageColorMode::bgr)
        : ImageFrame(sizeHW(rows, cols), data, color_mode) {}
    ImageFrame(const Size &size, const void *data, ImageColorMode color_mode);
    ImageFrame(const Size &size, ImageColorMode color_mode);
 
    bool empty() const { return data_->size() == 0; }
    const Size &size() const { return size_; }
    int width() const { return size_.width(); }
    int height() const { return size_.height(); }
    int rows() const { return size_.rows(); }
    int cols() const { return size_.cols(); }
    int channels() const;
    ImageColorMode color_mode() const { return color_mode_; }
    ImageColorMode colorMode() const { return color_mode_; }
    ImageCompressMode compress_mode() const { return cmp_mode_; }
    ImageCompressMode compressMode() const { return cmp_mode_; }
 
    std::shared_ptr<std::vector<unsigned char>> dataPtr() const {
        return data_;
    }
    const std::vector<unsigned char> &data() const { return *data_; }
    std::vector<unsigned char> &data() { return *data_; }
    const unsigned char &at(int row, int col, int ch = 0) const {
        return dataPtr()->at((row * cols() + col) * channels() + ch);
    }
    unsigned char &at(int row, int col, int ch = 0) {
        return dataPtr()->at((row * cols() + col) * channels() + ch);
    }
};
 
using ImageBase [[deprecated]] = ImageFrame;
 
WEBCFACE_NS_END