Merge pull request #663 from facchinm/stm32h7_video_lib

Refactor Video Library for STM32H7 boards

Author: facchinm

.github/workflows/compile-examples.yml

@@ -57,20 +57,23 @@ jobs:
               fqbn: arduino:mbed:envie_m7:target_core=cm4
             additional-libraries: |
               - name: lvgl
+                version: 8.3.5
+              - name: ArduinoGraphics
             additional-sketch-paths: |
               - libraries/doom
               - libraries/KernelDebug
               - libraries/Portenta_SDCARD
               - libraries/Portenta_SDRAM
-              - libraries/Portenta_Video
+              - libraries/Arduino_H7_Video
               - libraries/RPC
           - board:
               fqbn: arduino:mbed:envie_m7
             additional-libraries: |
               - name: lvgl
-                version: 7.11.0
+                version: 8.3.5
               - name: MicroNMEA
               - name: ArduinoBLE
+              - name: ArduinoGraphics
             additional-sketch-paths: |
               - libraries/PDM
               - libraries/doom
@@ -82,7 +85,7 @@ jobs:
               - libraries/Portenta_SDCARD
               - libraries/Portenta_SDRAM
               - libraries/STM32H747_System
-              - libraries/Portenta_Video
+              - libraries/Arduino_H7_Video
               - libraries/RPC
               - libraries/ThreadDebug
               - libraries/USBHID

libraries/Arduino_H7_Video/README.md

@@ -0,0 +1,5 @@
+# 📺 Arduino H7 Video Library
+
+The Arduino H7 Video Library manages the video output on Arduino boards based on the STM32H7 microcontroller (Portenta H7, GIGA R1 WiFi), providing functions to draw on the screen and integrate third-party video libraries such as [LVGL](https://lvgl.io/) and [emWin](https://www.segger.com/products/user-interface/emwin/).
+
+📖 For more information about this library, please refer to the documentation [here](./docs/).

libraries/Arduino_H7_Video/docs/README.md

@@ -0,0 +1,56 @@
+# Arduino H7 Video Library
+
+[![License](https://img.shields.io/badge/License-LGPLv3-blue.svg)]()
+
+The Arduino H7 Video library is a C++ library designed to handle the video output of Arduino boards based on the STM32H7 microcontroller with DSI video interface. DSI stands for Display Serial Interface, which is a serial interface used to connect a display to the microcontroller.
+
+This library is based on the graphics primitives of the [ArduinoGraphics](https://github.com/arduino-libraries/ArduinoGraphics) library and currently supports the Arduino Portenta H7 and Arduino Giga R1 WiFi boards. The library offers two modes of operation for the Portenta H7 board: you can connect the display to the video output via a USB Type-C connection or use the Giga Display Shield. For the Giga R1 board, only the Giga Display Shield is supported.
+
+The library allows you to draw graphics elements on the screen using simple graphics primitives such as lines, circles, images, etc. Additionally, you can integrate third-party graphic libraries like [LVGL](https://lvgl.io/) and [emWin](https://www.segger.com/products/user-interface/emwin/) to achieve more complex GUI.
+
+The library provides methods for initializing the video controller, clearing the screen, and drawing basic graphics elements.
+
+## Features
+
+- Handles video output of Arduino boards based on the STM32H7 microcontroller with DSI video interface
+- Allows drawing graphics elements using simple primitives like lines, circles, images, etc.
+- Integration of third-party graphic libraries like LVGL and emWin for more complex GUI
+
+## Usage
+
+To use this library, you must have a supported Arduino board and a display. Once you have connected the display to the board, you can include the display library in your Arduino sketch and use its functions to draw graphic elements on the screen. 
+Here is a minimal example for the Arduino GIGA R1 WiFi with Giga Display Shield:
+
+```cpp
+#include "Arduino_H7_Video.h"
+#include "ArduinoGraphics.h"
+
+Arduino_H7_Video Display(800, 480, GigaDisplayShield);
+
+void setup() {
+  Display.begin();
+  
+  // Draw a green rectangle that covers the entire display
+  Display.beginDraw();
+  Display.clear();
+  Display.noStroke();
+  Display.fill(0, 255, 0);
+  Display.rect(0, 0, Display.width(), Display.height());
+  Display.endDraw();
+}
+
+void loop() { }
+```
+## Examples
+
+- **[ArduinoLogo](../examples/ArduinoLogo):** This example demonstrates how to display an Arduino logo image on the screen.
+- **[ArduinoLogoDrawing](../examples/ArduinoLogoDrawing):** This example demonstrates how to draw an Arduino logo image using graphics primitives (line, circle, rect, etc.).
+- **[LVGLDemo](../examples/LVGLDemo):** This example demonstrates how to create a graphical user interface (GUI) using the LVGL library. It includes the [Arduino_GigaDisplayTouch](https://github.com/arduino-libraries/Arduino_GigaDisplayTouch/) library to handle touch events.
+
+## API
+
+The API documentation can be found [here](./api.md).
+
+## License
+
+This library is released under the [LGPLv3 license]().

libraries/Arduino_H7_Video/docs/api.md

@@ -0,0 +1,117 @@
+# Summary
+
+ Members                        | Descriptions                                
+--------------------------------|---------------------------------------------
+`class` [`Arduino_H7_Video`](#class-arduino_h7_video) | The main class for managing the video controller and the display.
+
+# class [`Arduino_H7_Video`](#class-arduino_h7_video)
+The main class for managing the video controller and the display.
+
+## Summary
+
+| Members                                                     | Descriptions                                |
+|-------------------------------------------------------------|---------------------------------------------|
+| `public ` [`Arduino_H7_Video`](#public-arduino_h7_videoint-width-int-height-h7displayshield-shield) | Construct a new Arduino_H7_Video object with the specified width, height, and display shield. |
+| `public int` [`begin`](#public-int-begin) | Initialize the video controller and display. |
+| `public void` [`end`](#public-void-end) | De-initialize the video controller and display. |
+| `public int` [`width`](#public-int-width) | Get the width of the display. |
+| `public int` [`height`](#public-int-height) | Get the height of the display. |
+| `public bool` [`isRotated`](#public-bool-isrotated) | Check if the display is rotated. |
+| `public void` [`clear`](#public-void-clear) | Clear the display. |
+| `public void` [`beginDraw`](#public-void-begindraw) | Begin drawing operations on the display. |
+| `public void` [`endDraw`](#public-void-enddraw) | End drawing operations on the display. |
+| `public void` [`set`](#public-void-setint-x-int-y-uint8_t-r-uint8_t-g-uint8_t-b) | Set the color of the pixel at the specified coordinates. |
+
+> *Note: For all drawing functions, refer to the documentation of the [`ArduinoGraphics`](https://reference.arduino.cc/reference/en/libraries/arduinographics/) library.*
+
+## Members
+
+### `public ` [`Arduino_H7_Video`](#)`(int width, int height, H7DisplayShield &shield)`
+
+Construct a new Arduino_H7_Video object with the specified width, height, and display shield.
+
+#### Parameters
+- `width`: The width of the display.
+- `height`: The height of the display.
+- `shield`: The display shield used.
+    - *GigaDisplayShield*: Giga Display Shield
+    - *USBCVideo*: Display attach to the USB-C port
+
+---
+
+### `public int` [`begin`](#)`()`
+
+Initialize the video controller and display.
+
+#### Returns
+`int`: 0 if initialization is successful, otherwise an error code.
+
+---
+
+### `public void` [`end`](#)`()`
+
+De-initialize the video controller and display.
+
+---
+
+### `public int` [`width`](#)`()`
+
+Get the width of the display.
+
+#### Returns
+`int`: The width of the display.
+
+---
+
+### `public int` [`height`](#)`()`
+
+Get the height of the display.
+
+#### Returns
+`int`: The height of the display.
+
+---
+
+### `public bool` [`isRotated`](#)`()`
+
+Check if the display is rotated.
+
+#### Returns
+`bool`: True if the display is rotated, false otherwise.
+
+---
+
+### `public void` [`clear`](#)`()`
+
+Clear the display.
+
+---
+
+### `public void` [`beginDraw`](#)`()`
+
+Begin drawing operations on the display.
+
+---
+
+### `public void` [`endDraw`](#)`()`
+
+End drawing operations on the display.
+
+---
+
+### `public void` [`set`](#)`(int x, int y, uint8_t r, uint8_t g, uint8_t b)`
+
+Set the color of the pixel at the specified coordinates.
+
+#### Parameters
+- `x`: The x-coordinate of the pixel.
+- `y`: The y-coordinate of the pixel.
+- `r`: The red component of the color.
+- `g`: The green component of the color.
+- `b`: The blue component of the color.
+
+---
+
+> *Note: For detailed information on drawing functions, please refer to the documentation of the [`ArduinoGraphics`](https://reference.arduino.cc/reference/en/libraries/arduinographics/) library.*
+
+

libraries/Arduino_H7_Video/examples/ArduinoLogo/ArduinoLogo.ino

@@ -0,0 +1,33 @@
+/*
+  ArduinoLogo
+
+  created 17 Apr 2023
+  by Leonardo Cavagnis
+*/
+
+#include "Arduino_H7_Video.h"
+#include "ArduinoGraphics.h"
+
+#include "img_arduinologo.h"
+// Alternatively, any raw RGB565 image can be included on demand using this macro
+// Online image converter: https://lvgl.io/tools/imageconverter (Output format: Binary RGB565)
+/*
+#define INCBIN_PREFIX
+#include "incbin.h"
+INCBIN(test, "/home/user/Downloads/test.bin");
+*/
+
+Arduino_H7_Video Display(800, 480, GigaDisplayShield);
+//Arduino_H7_Video Display(1024, 768, USBCVideo);
+
+Image img_arduinologo(ENCODING_RGB16, (uint8_t *) texture_raw, 300, 300);
+
+void setup() {
+  Display.begin();
+
+  Display.beginDraw();
+  Display.image(img_arduinologo, (Display.width() - img_arduinologo.width())/2, (Display.height() - img_arduinologo.height())/2);
+  Display.endDraw();
+}
+
+void loop() { }

libraries/Portenta_Video/examples/ArduinoLogo/image.h libraries/Arduino_H7_Video/examples/ArduinoLogo/img_arduinologo.h

@@ -0,0 +1,37 @@
+/*
+  ArduinoLogoDrawing
+
+  created 17 Apr 2023
+  by Leonardo Cavagnis
+*/
+
+#include "Arduino_H7_Video.h"
+#include "ArduinoGraphics.h"
+
+Arduino_H7_Video Display(800, 480, GigaDisplayShield);
+//Arduino_H7_Video Display(1024, 768, USBCVideo);
+
+void setup() {
+  Display.begin();
+  
+  Display.beginDraw();
+  Display.background(255, 255, 255);
+  Display.clear();
+  Display.fill(0x008184);
+  Display.circle(Display.width()/2, Display.height()/2, 300);
+  Display.stroke(255, 255, 255);
+  Display.noFill();
+  for (int i=0; i<30; i++) {
+    Display.circle((Display.width()/2)-55+5, Display.height()/2, 110-i);
+    Display.circle((Display.width()/2)+55-5, Display.height()/2, 110-i);
+  }
+  Display.fill(255, 255, 255);
+  Display.rect((Display.width()/2)-55-16+5, (Display.height()/2)-5, 32, 10);
+  Display.fill(255, 255, 255);
+  Display.rect((Display.width()/2)+55-16-5, (Display.height()/2)-5, 32, 10);
+  Display.fill(255, 255, 255);
+  Display.rect((Display.width()/2)+55-5-5, (Display.height()/2)-16, 10, 32);
+  Display.endDraw();
+}
+
+void loop() { }