Class to abstract decoding different image formats.
More...
#include <image_decoder.h>
|
| | ImageDecoder (RuntimeImage *image, ImageFormat format) |
| | Construct a new Image Decoder object.
|
| |
| virtual | ~ImageDecoder ()=default |
| |
| ImageFormat | get_format () const |
| | Get the image format handled by this decoder.
|
| |
| bool | is_active () const |
| | Check if a decoding session is in progress (prepare() called, reset() not yet).
|
| |
| virtual void | reset () |
| | Reset the decoder state, ending any decoding session.
|
| |
| virtual int | prepare (size_t expected_size) |
| | Initialize the decoder, starting a new decoding session.
|
| |
| virtual int | decode (uint8_t *buffer, size_t size)=0 |
| | Decode a part of the image.
|
| |
| virtual bool | supports_source () const |
| | Whether this decoder can read a DecodeSource itself, a step at a time, instead of being fed data.
|
| |
| virtual int | begin_source (DecodeSource *source) |
| | Start decoding from a source the decoder reads itself.
|
| |
| virtual int | decode_step () |
| | Decode a little more of an image started with begin_source(), keeping each call short.
|
| |
| bool | set_size (int width, int height) |
| | Request the image to be resized once the actual dimensions are known.
|
| |
| void | draw (int x, int y, int w, int h, const Color &color) |
| | Fill a rectangle on the display_buffer using the defined color.
|
| |
| size_t | get_decoded_bytes () const |
| | Bytes of the image the decoder has used so far.
|
| |
| virtual bool | is_finished () const |
| | Check if the decoder has finished processing.
|
| |
| virtual bool | knows_end () const |
| | Whether is_finished() can tell a complete image from a cut-off one.
|
| |
| bool | uses_direct_rgb565 () const |
| | The image is opaque RGB565, so draw() writes it straight into the buffer.
|
| |
|
| bool | resize_image_ (int width, int height) |
| | Resize the image for a width x height source, without preparing to draw. prepare_draw_() must follow.
|
| |
| void | prepare_draw_ (int width, int height) |
| | Draw a source of width x height over the whole buffer from now on.
|
| |
| void | draw_rgb565_ (int x, int y, int w, int h, uint16_t rgb565) |
| | Paint a block of source pixels in one color straight into the buffer. Only while uses_direct_rgb565().
|
| |
| uint8_t * | image_buffer_ () const |
| | The image's pixel buffer, for decoders that write their output straight into it.
|
| |
| bool | image_is_big_endian_ () const |
| |
Class to abstract decoding different image formats.
Definition at line 74 of file image_decoder.h.
◆ ImageDecoder()
Construct a new Image Decoder object.
- Parameters
-
| image | The RuntimeImage to decode the stream into. |
| format | The image format this decoder handles. |
Definition at line 82 of file image_decoder.h.
◆ ~ImageDecoder()
| virtual esphome::runtime_image::ImageDecoder::~ImageDecoder |
( |
| ) |
|
|
virtualdefault |
◆ begin_source()
| virtual int esphome::runtime_image::ImageDecoder::begin_source |
( |
DecodeSource * | source | ) |
|
|
inlinevirtual |
Start decoding from a source the decoder reads itself.
Call after prepare(), in place of decode().
The image headers (everything before the image data) must be readable from the source when this is called; only decode_step() can wait for more to arrive. The source must hold expected_size bytes in the end, and stay valid until the session ends.
- Returns
- int 0 on success, or a {
- See also
- DecodeError} value.
Reimplemented in esphome::runtime_image::JpegDecoder.
Definition at line 143 of file image_decoder.h.
◆ decode()
| virtual int esphome::runtime_image::ImageDecoder::decode |
( |
uint8_t * | buffer, |
|
|
size_t | size ) |
|
pure virtual |
Decode a part of the image.
It will try reading from the buffer. There is no guarantee that the whole available buffer will be read/decoded; the method will return the amount of bytes actually decoded, so that the unread content can be moved to the beginning.
- Parameters
-
| buffer | The buffer to read from. |
| size | The maximum amount of bytes that can be read from the buffer. |
- Returns
- int The amount of bytes read. It can be 0 if the buffer does not have enough content to meaningfully decode anything, or negative in case of a decoding error.
Implemented in esphome::runtime_image::BmpDecoder, esphome::runtime_image::JpegDecoder, esphome::runtime_image::PngDecoder, and esphome::runtime_image::QoiDecoder.
◆ decode_step()
| virtual int esphome::runtime_image::ImageDecoder::decode_step |
( |
| ) |
|
|
inlinevirtual |
◆ draw()
| void esphome::runtime_image::ImageDecoder::draw |
( |
int | x, |
|
|
int | y, |
|
|
int | w, |
|
|
int | h, |
|
|
const Color & | color ) |
Fill a rectangle on the display_buffer using the defined color.
Will check the given coordinates for out-of-bounds, and clip the rectangle accordingly. In case of binary displays, the color will be converted to binary as well. Called by the callback functions, to be able to access the parent Image class.
- Parameters
-
| x | The left-most coordinate of the rectangle. |
| y | The top-most coordinate of the rectangle. |
| w | The width of the rectangle. |
| h | The height of the rectangle. |
| color | The fill color |
Definition at line 78 of file image_decoder.cpp.
◆ draw_rgb565_()
| void esphome::runtime_image::ImageDecoder::draw_rgb565_ |
( |
int | x, |
|
|
int | y, |
|
|
int | w, |
|
|
int | h, |
|
|
uint16_t | rgb565 ) |
|
protected |
◆ get_decoded_bytes()
| size_t esphome::runtime_image::ImageDecoder::get_decoded_bytes |
( |
| ) |
const |
|
inline |
Bytes of the image the decoder has used so far.
Definition at line 179 of file image_decoder.h.
◆ get_format()
| ImageFormat esphome::runtime_image::ImageDecoder::get_format |
( |
| ) |
const |
|
inline |
Get the image format handled by this decoder.
Definition at line 86 of file image_decoder.h.
◆ image_buffer_()
| uint8_t * esphome::runtime_image::ImageDecoder::image_buffer_ |
( |
| ) |
const |
|
protected |
The image's pixel buffer, for decoders that write their output straight into it.
Definition at line 109 of file image_decoder.cpp.
◆ image_is_big_endian_()
| bool esphome::runtime_image::ImageDecoder::image_is_big_endian_ |
( |
| ) |
const |
|
protected |
◆ is_active()
| bool esphome::runtime_image::ImageDecoder::is_active |
( |
| ) |
const |
|
inline |
◆ is_finished()
| virtual bool esphome::runtime_image::ImageDecoder::is_finished |
( |
| ) |
const |
|
inlinevirtual |
◆ knows_end()
| virtual bool esphome::runtime_image::ImageDecoder::knows_end |
( |
| ) |
const |
|
inlinevirtual |
◆ prepare()
| virtual int esphome::runtime_image::ImageDecoder::prepare |
( |
size_t | expected_size | ) |
|
|
inlinevirtual |
◆ prepare_draw_()
| void esphome::runtime_image::ImageDecoder::prepare_draw_ |
( |
int | width, |
|
|
int | height ) |
|
protected |
Draw a source of width x height over the whole buffer from now on.
For an opaque RGB565 image this builds the tables of where each source column and row lands; without the memory for them it draws pixel by pixel instead.
Definition at line 23 of file image_decoder.cpp.
◆ reset()
| virtual void esphome::runtime_image::ImageDecoder::reset |
( |
| ) |
|
|
inlinevirtual |
◆ resize_image_()
| bool esphome::runtime_image::ImageDecoder::resize_image_ |
( |
int | width, |
|
|
int | height ) |
|
protected |
◆ set_size()
| bool esphome::runtime_image::ImageDecoder::set_size |
( |
int | width, |
|
|
int | height ) |
Request the image to be resized once the actual dimensions are known.
Called by the callback functions, to be able to access the parent Image class.
- Parameters
-
| width | The image's width. |
| height | The image's height. |
- Returns
- true if the image was resized, false otherwise.
Definition at line 11 of file image_decoder.cpp.
◆ supports_source()
| virtual bool esphome::runtime_image::ImageDecoder::supports_source |
( |
| ) |
const |
|
inlinevirtual |
◆ uses_direct_rgb565()
| bool esphome::runtime_image::ImageDecoder::uses_direct_rgb565 |
( |
| ) |
const |
|
inline |
The image is opaque RGB565, so draw() writes it straight into the buffer.
Definition at line 199 of file image_decoder.h.
◆ active_
| bool esphome::runtime_image::ImageDecoder::active_ = false |
|
protected |
◆ decoded_bytes_
| size_t esphome::runtime_image::ImageDecoder::decoded_bytes_ = 0 |
|
protected |
◆ direct_rgb565_
| bool esphome::runtime_image::ImageDecoder::direct_rgb565_ = false |
|
protected |
◆ draw_height_
| int esphome::runtime_image::ImageDecoder::draw_height_ = 0 |
|
protected |
◆ draw_width_
| int esphome::runtime_image::ImageDecoder::draw_width_ = 0 |
|
protected |
◆ expected_size_
| size_t esphome::runtime_image::ImageDecoder::expected_size_ = 0 |
|
protected |
◆ format_
| const ImageFormat esphome::runtime_image::ImageDecoder::format_ |
|
protected |
◆ image_
◆ size_valid_
| bool esphome::runtime_image::ImageDecoder::size_valid_ = true |
|
protected |
◆ x_boundaries_
| FixedVector<uint16_t> esphome::runtime_image::ImageDecoder::x_boundaries_ {} |
|
protected |
◆ y_boundaries_
| FixedVector<uint16_t> esphome::runtime_image::ImageDecoder::y_boundaries_ {} |
|
protected |
The documentation for this class was generated from the following files: