added Pinecil | fixed some typos | added some information (#14)

* Adding a logo preview

Just a preview of the logos to facilitate the choise.

* Delete arcade_pac_man.gif

* Delete horizontal_bars_transitions.gif

Bootup Logos/README.md

@@ -1,15 +1,17 @@
 ## Boot up logo's are logos or animations shown on boot of IronOS
 
 These are programmed into the device just like the normal firmware.
-They can be (re)programmed as many times as desired after flashing the normal firmware.
+They can be (re)programmed as many times as desired, after flashing the normal firmware.
 
 ### Data storage format
 
-The data is stored into the second last page of flash, this gives 1024 bytes of space for the entire payload of bootup logo data.
+The data is stored into the second last page of flash. This gives 1024 bytes of space for the entire payload of bootup-logo-data.
 
-The first byte is marked purely to indicate that the page is programmed and which revision of the boot logo logic it is
-The next byte indicates the frame timing in milliseconds, or `0` to indicate only show first frame for whole bootloader duration (still image mode)
-Then the OLED buffer is cleared to black, then every frame is encoded as either:
+The first byte is marked purely to indicate that the page is programmed and which revision of the boot-logo-logic it is.
+
+The next byte indicates the frame timing in milliseconds, or `0` to indicate: Only show the first frame for the whole bootloader duration (still image mode).
+
+After the OLED buffer is cleared to black, every frame is encoded as either:
 
 ### Full frame updates
 
@@ -18,5 +20,38 @@ Then the OLED buffer is cleared to black, then every frame is encoded as either:
 ### Delta frame update
 
 `[count of updates][[index,data][index,data][index,data][index,data]]`
-Where index is byte location into screen buffer, and data is the new byte to plonk down there
-This just overwrites individual bytes in the output buffer
+
+Where index is byte location into screen buffer and data is the new byte to plonk down there.
+This just overwrites individual bytes in the output buffer.
+
+## Logos preview
+
+**Static logos**
+|Logo           |Filename       |Note   |
+|:-------------:|:-------------:|:-----:|
+|![Alt text](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/ad_maiora.png)|ad_maiora.png|English: "Towards greater things"|
+|![Alt text](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/arcade_galaga.png)|arcade_galaga.png||
+|![Alt text](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/arcade_pac_man.png)|arcade_pac_man.png||
+|![Alt text](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/bender.png)|bender.png||
+|![Alt text](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/f1.png)|f1.png||
+|![Alt text](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/halo_master_chief_helmet.png)|halo_master_chief_helmet.png||
+|![Alt text](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/horror_vacui_IronOS.png)|horror_vacui_IronOS.png||
+|![IronOS](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/IronOS.png)|IronOS.png|lefty-version available|
+|![Alt text](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/lot_of_tin_is_too_few_tin_IT.png)|lot_of_tin_is_too_few_tin_IT.png|English: "A lot of tin is too few tin"|
+|![Alt text](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/open_sw_hw_IronOS_logos.png)|open_sw_hw_IronOS_logos.png||
+|![Pinecil](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/Pinecil.png)|Pinecil.png|lefty-version available|
+|![Alt text](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/skulls.png)|skulls.png||
+|![TS100](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/TS100.png)|TS100.png|lefty-version available|
+|![TS80](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/TS80.png)|TS80.png|lefty-version available|
+|![TS80P](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/TS80P.png)|TS80P.png|lefty-version available|
+|![Alt text](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/wh_40k.png)|wh_40k.png||
+|![Alt text](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/wwii_kilroy.png)|wwii_kilroy.png||
+
+**Animated logos**
+|Logo \*          |Filename       |Note   |
+|:-------------:|:-------------:|:-----:|
+|![Alt text](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/CRT_horror_vacui.gif) |CRT_horror_vacui.gif||
+|![IronOS](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/IronOS.gif)|IronOS.gif|lefty-version available|
+|![Alt text](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/Images/terminal.gif)|terminal.gif||
+
+_* Click the individual logo to see its animation, if you missed it here._

Bootup Logos/img2logo.py

@@ -22,6 +22,7 @@ LCD_PAGE_SIZE = 1024
 
 DATA_PROGRAMMED_MARKER = 0xAA
 FULL_FRAME_MARKER = 0xFF
+EMPTY_FRAME_MARKER = 0xFE  # If this marker is used to start a frame, the frame is a 0-length delta frame
 
 
 class MiniwareSettings:
@@ -103,7 +104,9 @@ def get_screen_blob(previous_frame: bytearray, this_frame: bytearray):
     """
     outputData = []
     delta = calculate_frame_delta_encode(previous_frame, this_frame)
-    if len(delta) < (len(this_frame)):
+    if len(delta) == 0:
+        outputData.append(EMPTY_FRAME_MARKER)
+    elif len(delta) < (len(this_frame)):
         outputData.append(len(delta))
         outputData.extend(delta)
         # print("delta encoded frame")
@@ -138,18 +141,31 @@ def animated_image_to_bytes(imageIn: Image, negative: bool, dither: bool, thresh
         frameData.append(frameb)
         # Store inter-frame duration
         frameDuration_ms = image.info["duration"]
-        if frameDuration_ms > 255:
-            frameDuration_ms = 255
-        if frameTiming is None or frameTiming == 0:
+        if frameTiming is None:
             frameTiming = frameDuration_ms
+        else:
+            delta = frameDuration_ms / frameTiming
+            if delta > 1.05 or delta < 0.95:
+                print(f"ERROR: You have a frame that is different to the first frame time. Mixed rates are not supported")
+                sys.exit(-1)
     print(f"Found {len(frameData)} frames, interval {frameTiming}ms")
-    # We have no mangled the image into our frambuffers
+    frameTiming = frameTiming / 5
+    if frameTiming <= 0 or frameTiming > 254:
+        newTiming = max(frameTiming, 1)
+        newTiming = min(newTiming, 254)
+
+        print(f"Inter frame delay {frameTiming} is out of range, and is being adjusted to {newTiming*5}")
+        frameTiming = newTiming
+
+    # We have now mangled the image into our framebuffers
 
     # Now we can build our output data blob
     # First we always start with a full first frame; future optimisation to check if we should or not
     outputData = [DATA_PROGRAMMED_MARKER]
-    outputData.append(frameTiming)
-    outputData.extend(get_screen_blob([0x00] * (LCD_NUM_BYTES), frameData[0]))
+    outputData.append(int(frameTiming))
+    first_frame = get_screen_blob([0x00] * (LCD_NUM_BYTES), frameData[0])
+    outputData.extend(first_frame)
+    print(f"Frame 1 encoded to {len(first_frame)} bytes")
 
     """
     Format for each frame block is:
@@ -164,8 +180,9 @@ def animated_image_to_bytes(imageIn: Image, negative: bool, dither: bool, thresh
         if (len(outputData) + len(frameBlob)) > LCD_PAGE_SIZE:
             print(f"Truncating animation after {id} frames as we are out of space")
             break
-        print(f"Frame {id} encoded to {len(frameBlob)} bytes")
+        print(f"Frame {id + 1} encoded to {len(frameBlob)} bytes")
         outputData.extend(frameBlob)
+    print(f"Total size used: {len(outputData)} of 1024 bytes")
     return outputData
 
 

Bootup Logos/run.sh

@@ -1,4 +1,5 @@
 #! /bin/sh
 echo $1
 echo $2
+set -e
 find Images/ -type f -exec python3 img2logo.py {} "$1" "$2" \;