snapshot.h

Go to the documentation of this file.

#pragma once
 
#ifdef USE_HOST
 
#include <cstddef>
#include <cstdint>
#include <memory>
#include <string>
 
// Directory snapshots are written to. Normally set by codegen to a folder under .esphome; the
// fallback keeps the component compiling for static analysis, where no defines.h is generated.
#ifndef ESPHOME_SNAPSHOT_DIR
#define ESPHOME_SNAPSHOT_DIR "."
#endif
 
namespace esphome::snapshot {
 
class Snapshot {
 public:
  // Declared here and defined where Recording is complete, which unique_ptr needs.
  Snapshot();
  virtual ~Snapshot();
 
  void set_snapshot_prefix(const char *prefix) { this->snapshot_prefix_ = prefix; }
 
  bool take_snapshot(const char *filename);
 
  bool take_animation(const char *filename, uint32_t frames, float frame_rate);
 
  void take_snapshot_or_log(const char *filename, uint32_t frames, float frame_rate);
  void take_snapshot_or_log(const std::string &filename, uint32_t frames, float frame_rate) {
    this->take_snapshot_or_log(filename.c_str(), frames, frame_rate);
  }
 
 protected:
  virtual int snapshot_width() = 0;
  virtual int snapshot_height() = 0;
  virtual bool capture_bgr(uint8_t *dest, size_t row_stride) = 0;
 
  const char *snapshot_prefix_{"snapshot"};
 
 private:
  struct Recording;
 
  bool record_frame_();
 
  std::unique_ptr<Recording> recording_;
};
 
}  // namespace esphome::snapshot
 
#endif