Started with colormap support

Author: TomSaw

ext/modm-devices

@@ -114,17 +114,25 @@ class Ili9341 : public Interface,
 	write(BufferInterface<C_> &buffer, Point origin = {0, 0}) {
 		RF_BEGIN();
 		RF_END_RETURN_CALL(writeImage(
-			Decoder<C_, modm::accessor::Ram>(&buffer),
+			ImageAccessor<C_, modm::accessor::Ram>(&buffer),
 			origin)
 		);
 	}
 
+	// Write BufferInterface
+	template<class C_>
+	modm::ResumableResult<void>
+	write(BufferInterface<C_> &buffer, ColorType* colormap, Point origin = {0, 0}) {
+		RF_BEGIN();
+		RF_END_RETURN_CALL(writeImage(ImageAccessor<C_, modm::accessor::Ram>(&buffer), colormap, origin));
+	}
+
 	// Write Flash Image
 	modm::ResumableResult<void>
 	write(const uint8_t *addr, Point origin = {0, 0}) {
 		RF_BEGIN();
 		RF_END_RETURN_CALL(writeImage(
-			Decoder<Monochrome, modm::accessor::Flash>(addr),
+			ImageAccessor<Monochrome, modm::accessor::Flash>(addr),
 			origin)
 		);
 	}
@@ -153,7 +161,7 @@ class Ili9341 : public Interface,
 	 */
 	template<template<typename> class Accessor>
 	modm::ResumableResult<void>
-	writeImage(Decoder<Rgb565, Accessor> decoder, Point origin = {0, 0});
+	writeImage(ImageAccessor<Rgb565, Accessor> decoder, Point origin = {0, 0});
 
 	/**
 	 * Write colored Image
@@ -163,7 +171,7 @@ class Ili9341 : public Interface,
 	 */
  	template<Color C_, template<typename> class Accessor>
 	modm::ResumableResult<void>
-	writeImage(Decoder<C_, Accessor> decoder, Point origin = {0, 0});
+	writeImage(ImageAccessor<C_, Accessor> decoder, Point origin = {0, 0});
 
 	/**
 	 * Write ColorGrayBase2 Image using color-mapping
@@ -173,7 +181,7 @@ class Ili9341 : public Interface,
 	 */
 	template<template<typename> class Accessor>
 	modm::ResumableResult<void>
-	writeImage(Decoder<Monochrome, Accessor> decoder, Point origin = {0, 0});
+	writeImage(ImageAccessor<Monochrome, Accessor> decoder, const ColorType colors[Monochrome::max + 1], Point origin = {0, 0});
 
 	inline void
 	initialize_write_monochrome(Point origin);

src/modm/driver/display/ili9341.hpp

@@ -10,9 +10,7 @@
  */
 
 #pragma once
-#ifndef MODM_ILI9341_HPP
-#error "Don't include this file directly, use 'ili9341.hpp' instead!"
-#endif
+#include "ili9341.hpp"
 
 using namespace modm::shape;
 using namespace modm::color;
@@ -279,11 +277,11 @@ modm::Ili9341<Interface, Reset, BC>::write(Rectangle rectangle, P pattern) {
 template<class Interface, class Reset, size_t BC>
 template<template<typename> class Accessor>
 modm::ResumableResult<void>
-modm::Ili9341<Interface, Reset, BC>::writeImage(Decoder<Rgb565, Accessor> decoder, Point origin)
+modm::Ili9341<Interface, Reset, BC>::writeImage(ImageAccessor<Rgb565, Accessor> decoder, Point origin)
 {
 	// Found no cast for d share the memory between all of the writeImage()-methods.
 	// This waste of RAM will be history once Resumable Functions become history.
-	static Decoder<Rgb565, Accessor> d;
+	static ImageAccessor<Rgb565, Accessor> d;
 
 	RF_BEGIN();
 
@@ -317,10 +315,10 @@ modm::Ili9341<Interface, Reset, BC>::writeImage(Decoder<Rgb565, Accessor> decode
 template<class Interface, class Reset, size_t BC>
 template<Color C_, template<typename> class Accessor>
 modm::ResumableResult<void>
-modm::Ili9341<Interface, Reset, BC>::writeImage(Decoder<C_, Accessor> decoder, Point origin) {
+modm::Ili9341<Interface, Reset, BC>::writeImage(ImageAccessor<C_, Accessor> decoder, Point origin) {
 	// Found no cast for d share the memory between all of the writeImage()-methods.
 	// This waste of RAM will be history once Resumable Functions become history.
-	static Decoder<C_, Accessor> d;
+	static ImageAccessor<C_, Accessor> d;
 
 	RF_BEGIN();
 
@@ -358,10 +356,10 @@ modm::Ili9341<Interface, Reset, BC>::writeImage(Decoder<C_, Accessor> decoder, P
 template<class Interface, class Reset, size_t BC>
 template<template<typename> class Accessor>
 modm::ResumableResult<void>
-modm::Ili9341<Interface, Reset, BC>::writeImage(Decoder<Monochrome, Accessor> decoder, Point origin) {
+modm::Ili9341<Interface, Reset, BC>::writeImage(ImageAccessor<Monochrome, Accessor> decoder, const ColorType colors[Monochrome::max + 1], Point origin) {
 	// Found no cast for d share the memory between all of the writeImage()-methods.
 	// This waste of RAM will be history once Resumable Functions become history.
-	static Decoder<Monochrome, Accessor> d;
+	static ImageAccessor<Monochrome, Accessor> d;
 
 	RF_BEGIN();
 
@@ -380,7 +378,7 @@ modm::Ili9341<Interface, Reset, BC>::writeImage(Decoder<Monochrome, Accessor> de
 			// OPTIMIZE following Line is the only
 			// difference to -- write colored Image -- above
 			// IMPLEMENT color-mapping
-			p.buffer[p.i] = d.nextPixel();
+			p.buffer[p.i] = colors[d.nextPixel().getValue()];
 			if (++p.scanner.y == this->clipping.bottomRight.y) {
 				scannerNextRow();
 				d.nextRow();

src/modm/driver/display/ili9341_impl.hpp

@@ -43,15 +43,15 @@ class Sh1106 : public Ssd1306<I2cMaster, H>
 	modm::ResumableResult<bool>
 	write(BufferInterface<Monochrome> &buffer, Point origin = {0, 0}) {
 		RF_BEGIN();
-		RF_END_RETURN_CALL(writeImage(Decoder<Monochrome, modm::accessor::Ram>(&buffer), origin));
+		RF_END_RETURN_CALL(writeImage(ImageAccessor<Monochrome, modm::accessor::Ram>(&buffer), origin));
 	}
 
 	// Write Flash Image
 	modm::ResumableResult<void>
 	write(const uint8_t *addr, Point origin = {0, 0}) {
 		RF_BEGIN();
 		RF_END_RETURN_CALL(writeImage(
-			Decoder<Monochrome, modm::accessor::Flash>(addr),
+			ImageAccessor<Monochrome, modm::accessor::Flash>(addr),
 			origin)
 		);
 	}
@@ -67,7 +67,7 @@ class Sh1106 : public Ssd1306<I2cMaster, H>
 	// Caution: origin.y rounds to multiples of 8
 	template<template<typename> class Accessor>
 	modm::ResumableResult<bool>
-	writeImage(Decoder<Monochrome, Accessor> decoder, Point origin = {0, 0});
+	writeImage(ImageAccessor<Monochrome, Accessor> decoder, Point origin = {0, 0});
 
 	// Static variables for Resumable Functions
 	size_t yd; // vertical index in display (page)

src/modm/driver/display/sh1106.hpp

@@ -10,9 +10,7 @@
 // ----------------------------------------------------------------------------
 
 #pragma once
-#ifndef MODM_SH1106_HPP
-#error "Don't include this file directly, use 'sh1106.hpp' instead!"
-#endif
+#include "sh1106.hpp"
 
 using namespace modm::graphic;
 
@@ -48,7 +46,7 @@ modm::Sh1106<I2cMaster, H>::updateClipping()
 template<class I2cMaster, uint16_t H>
 template<template<typename> class Accessor>
 modm::ResumableResult<bool>
-modm::Sh1106<I2cMaster, H>::writeImage(Decoder<Monochrome, Accessor> decoder, Point origin) {
+modm::Sh1106<I2cMaster, H>::writeImage(ImageAccessor<Monochrome, Accessor> decoder, Point origin) {
 	RF_BEGIN();
 
 	// IMPLEMENT method with getIntersection()

src/modm/driver/display/sh1106_impl.hpp

@@ -167,15 +167,15 @@ class Ssd1306 : public ssd1306,
 	modm::ResumableResult<bool>
 	write(BufferInterface<Monochrome> &buffer, Point origin = {0, 0}) {
 		RF_BEGIN();
-		RF_END_RETURN_CALL(writeImage(Decoder<Monochrome, modm::accessor::Ram>(&buffer), origin));
+		RF_END_RETURN_CALL(writeImage(ImageAccessor<Monochrome, modm::accessor::Ram>(&buffer), origin));
 	}
 
 	// Write Flash Image
 	modm::ResumableResult<void>
 	write(const uint8_t *addr, Point origin = {0, 0}) {
 		RF_BEGIN();
 		RF_END_RETURN_CALL(writeImage(
-			Decoder<Monochrome, modm::accessor::Flash>(addr),
+			ImageAccessor<Monochrome, modm::accessor::Flash>(addr),
 			origin)
 		);
 	}
@@ -191,7 +191,7 @@ class Ssd1306 : public ssd1306,
 	// Write monochrome Image
 	template<template<typename> class Accessor>
 	modm::ResumableResult<bool>
-	writeImage(Decoder<Monochrome, Accessor> decoder, Point origin = {0, 0});
+	writeImage(ImageAccessor<Monochrome, Accessor> decoder, Point origin = {0, 0});
 
 	modm::ResumableResult<bool>
 	writeCommands(std::size_t length);

src/modm/driver/display/ssd1306.hpp

@@ -10,9 +10,7 @@
 // ----------------------------------------------------------------------------
 
 #pragma once
-#ifndef MODM_SSD1306_HPP
-#error "Don't include this file directly, use 'ssd1306.hpp' instead!"
-#endif
+#include "ssd1306.hpp"
 
 template<class I2cMaster, uint16_t H>
 modm::ResumableResult<bool>
@@ -170,7 +168,7 @@ modm::Ssd1306<I2cMaster, H>::updateClipping()
 template<class I2cMaster, uint16_t H>
 template<template<typename> class Accessor>
 modm::ResumableResult<bool>
-modm::Ssd1306<I2cMaster, H>::writeImage(Decoder<Monochrome, Accessor> decoder, Point origin) {
+modm::Ssd1306<I2cMaster, H>::writeImage(ImageAccessor<Monochrome, Accessor> decoder, Point origin) {
 	RF_BEGIN();
 
 	this->clipping = Rectangle(origin, decoder.size);

src/modm/driver/display/ssd1306_impl.hpp

@@ -9,8 +9,6 @@
  */
 // ----------------------------------------------------------------------------
 
-// TODO Find a better home for modm::UnsignedScaling
-
 #pragma once
 
 #include <algorithm>
@@ -21,77 +19,80 @@
 namespace modm {
 
 /**
- * @brief 		Unsigned integer with arbitrary digits and scaling value conversion
+ * @brief 		Unsigned integer with arbitrary digits and scaling value on conversion
  * 				between instances with different digits.
  * 
  * @tparam D 	Digits
  * 
  * @author		Thomas Sommer
  */
 template<int D>
-class UnsignedScaling {
+class ScalingUnsigned {
 public:
 	static constexpr int Digits = D;
 	using ValueType = uint_t<D>::least;
 
 	static constexpr ValueType min = 0;
 	static constexpr ValueType max = bitmask<D>();
 
-	constexpr UnsignedScaling() = default;
+	constexpr ScalingUnsigned() = default;
 
 	// FIXME want both:
 	// COMPTIME: static_assert(value <= max, "value out of range")
 	// RUNTIME: std::min(value, max) or modm_assert(value <= max, ...)
-	constexpr UnsignedScaling(ValueType value) : value(std::min(value, max)) {
+	constexpr ScalingUnsigned(ValueType value) : value(std::min(value, max)) {
 		// TODO disable via lbuild option
-		// modm_assert_continue_fail_debug(value <= max, "UnsignedScaling", "constructor", "value out of range");
+		// modm_assert_continue_fail_debug(value <= max, "ScalingUnsigned", "constructor", "value out of range");
 	}
 
 	// Construct from bigger or equal ColorGray
 	template <int E, std::enable_if_t<(D <= E), void*> = nullptr>
-	constexpr UnsignedScaling(const UnsignedScaling<E>& other)
+	constexpr ScalingUnsigned(const ScalingUnsigned<E>& other)
 		: value(other.value >> (E - D)) {}
 
 	template <int E, std::enable_if_t<(D <= E), void*> = nullptr>
-	constexpr UnsignedScaling(UnsignedScaling<E> &&other)
+	constexpr ScalingUnsigned(ScalingUnsigned<E> &&other)
 		: value(other.value >> (E - D)) {}
 
 	// Construct from smaller ColorGray
 	template <int E, std::enable_if_t<(D > E), void*> = nullptr>
-	constexpr UnsignedScaling(const UnsignedScaling<E>& other)
+	constexpr ScalingUnsigned(const ScalingUnsigned<E>& other)
 		: value(other.value * max / other.max)
 	{}
 
 	template <int E, std::enable_if_t<(D > E), void*> = nullptr>
-	constexpr UnsignedScaling(UnsignedScaling<E> &&other)
+	constexpr ScalingUnsigned(ScalingUnsigned<E> &&other)
 		: value(other.value * max / other.max)
 	{}
 
 	/* 	// Faster construction from monochrome
-	constexpr UnsignedScaling(const UnsignedScaling<1> &other) : value(other.value ? bitmask<D>() : 0){}
+	constexpr ScalingUnsigned(const ScalingUnsigned<1> &other) : value(other.value ? bitmask<D>() : 0){}
 
-	// constexpr UnsignedScaling(UnsignedScaling<1> &&other) : value(other.value ? bitmask<D>() : 0){}
-	constexpr UnsignedScaling& operator=(const UnsignedScaling<1> &other) {
+	// constexpr ScalingUnsigned(ScalingUnsigned<1> &&other) : value(other.value ? bitmask<D>() : 0){}
+	constexpr ScalingUnsigned& operator=(const ScalingUnsigned<1> &other) {
 		value = other.value ? bitmask<D>() : 0;
 		return *this;	
 	} */
 
-	// Assign UnsignedScaling with more or equal Depth
+	// Assign ScalingUnsigned with more or equal Depth
 	template <int E, std::enable_if_t<(D <= E), void*> = nullptr>
-	void operator=(const UnsignedScaling<E>& other) {
+	void operator=(const ScalingUnsigned<E>& other) {
 		value = other.value >> (E - D);
 	}
 
-	// Assign UnsignedScaling with less Depth
+	// Assign ScalingUnsigned with less Depth
 	template <int E, std::enable_if_t<(D > E), void*> = nullptr>
-	void operator=(const UnsignedScaling<E>& other) {
+	void operator=(const ScalingUnsigned<E>& other) {
 		value = other.value * max / other.max;
 	}
 
+	// FIXME want both:
+	// COMPTIME: static_assert(value <= max, "value out of range")
+	// RUNTIME: std::min(value, max) or modm_assert(value <= max, ...)
 	void setValue(ValueType value) {
 		this->value = std::min(value, max);
 		// TODO disable via lbuild option
-		// modm_assert_continue_fail_debug(value <= max, "modm::UnsignedScaling", "setValue()", "value out of range");
+		// modm_assert_continue_fail_debug(value <= max, "modm::ScalingUnsigned", "setValue()", "value out of range");
 	}
 
 	ValueType getValue() const { return value; }
@@ -100,15 +101,15 @@ class UnsignedScaling {
 		return value == max;
 	}
 
-	constexpr auto operator<=>(const UnsignedScaling<D> &) const = default;
+	constexpr auto operator<=>(const ScalingUnsigned<D> &) const = default;
 
 protected:
 	ValueType value = 0;
 
 	inline void max_cutoff() { value = std::min(value, max); }
 private:
 	template<int>
-	friend class UnsignedScaling;
+	friend class ScalingUnsigned;
 };
 
 }

src/modm/ui/color/unsigned_scaling.hpp renamed to src/modm/math/scaling_unsigned.hpp

@@ -0,0 +1,32 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2021, Thomas Sommer
+#
+# This file is part of the modm project.
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+# -----------------------------------------------------------------------------
+
+def init(module):
+    module.name = ":math:scaling_unsigned"
+    module.description = """
+# Scaling Unsigned
+
+Unsigned integer with arbitrary digits and scaling value on conversion between
+instances with different digits. F.e. a 2bit scaling unsigned of 0b11 becomes
+0b1111 when converted to a 4bit scaling unsigned.
+
+It's the baseclass to all in modm::color::* but may have wider applications.
+
+"""
+
+def prepare(module, options):
+    module.depends(":utils")
+    return True
+
+def build(env):
+    env.outbasepath = "modm/src/modm/math"
+    env.copy("scaling_unsigned.hpp")

src/modm/math/scaling_unsigned.lb

@@ -22,6 +22,7 @@ Color containers and converters in various formats: RGB, HSV, Brightness, Rgb565
 def prepare(module, options):
     module.depends(
 		":math:utils",
+		":math:scaling_unsigned",
 		":math:saturation"
 	)
     return True