encoder.h

Go to the documentation of this file.

#pragma once
 
#include "buffer.h"
#include "camera.h"
 
namespace esphome::camera {
 
enum EncoderError : uint8_t {
  ENCODER_ERROR_SUCCESS = 0,   
  ENCODER_ERROR_SKIP_FRAME,    
  ENCODER_ERROR_RETRY_FRAME,   
  ENCODER_ERROR_CONFIGURATION  
};
 
inline const char *to_string(EncoderError error) {
  switch (error) {
    case ENCODER_ERROR_SUCCESS:
      return "ENCODER_ERROR_SUCCESS";
    case ENCODER_ERROR_SKIP_FRAME:
      return "ENCODER_ERROR_SKIP_FRAME";
    case ENCODER_ERROR_RETRY_FRAME:
      return "ENCODER_ERROR_RETRY_FRAME";
    case ENCODER_ERROR_CONFIGURATION:
      return "ENCODER_ERROR_CONFIGURATION";
  }
  return "ENCODER_ERROR_INVALID";
}
 
class EncoderBuffer {
 public:
  virtual bool set_buffer_size(size_t size) = 0;
 
  virtual uint8_t *get_data() const = 0;
 
  virtual size_t get_size() const = 0;
 
  virtual size_t get_max_size() const = 0;
 
  virtual ~EncoderBuffer() = default;
};
 
class Encoder {
 public:
  virtual EncoderError encode_pixels(CameraImageSpec *spec, Buffer *pixels) = 0;
 
  virtual EncoderBuffer *get_output_buffer() = 0;
 
  virtual void dump_config() = 0;
  virtual ~Encoder() = default;
};
 
}  // namespace esphome::camera