Support eglstream (#52)

Author: Mai-Matsuura

.github/workflows/build-test.yml

@@ -41,12 +41,22 @@ jobs:
       # Execute the build.  You can specify a specific target with "--target <NAME>"
       run: cmake --build . --config $BUILD_TYPE
 
-    - name: Configure CMake for drm backend
+    - name: Configure CMake for drm backend with GBM
       shell: bash
       working-directory: ${{github.workspace}}/build
-      run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DUSER_PROJECT_PATH=examples/flutter-drm-backend ..
+      run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DUSER_PROJECT_PATH=examples/flutter-drm-gbm-backend ..
 
-    - name: Build for drm backend
+    - name: Build for drm backend with GBM
+      working-directory: ${{github.workspace}}/build
+      shell: bash
+      run: cmake --build . --config $BUILD_TYPE
+
+    - name: Configure CMake for drm backend with EGLStream
+      shell: bash
+      working-directory: ${{github.workspace}}/build
+      run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DUSER_PROJECT_PATH=examples/flutter-drm-eglstream-backend ..
+
+    - name: Build for drm backend with EGLStream
       working-directory: ${{github.workspace}}/build
       shell: bash
       run: cmake --build . --config $BUILD_TYPE

CMakeLists.txt

@@ -7,7 +7,7 @@ set(CMAKE_CXX_COMPILER clang++)
 set(CMAKE_CXX_STANDARD 17)
 
 # Build options.
-option(USE_DRM "Select WAYLAND or DRM as the display backend type" OFF)
+option(BACKEND_TYPE "Select WAYLAND, DRM-GBM, DRM-EGLSTREAM, or X11 as the display backend type" WAYLAND)
 option(DESKTOP_SHELL "Work as weston desktop-shell" OFF)
 option(USE_VIRTUAL_KEYBOARD "Use virtual keyboard" OFF)
 option(USE_GLES3 "Use OpenGL ES3 (default is OpenGL ES2)" OFF)

README.md

@@ -16,7 +16,7 @@ We would be grateful if you could give us feedback on bugs and new feature reque
 - [Wayland](https://wayland.freedesktop.org/) backend support
 - Direct rendering module ([DRM](https://en.wikipedia.org/wiki/Direct_Rendering_Manager)) backend support
   - [x] Generic Buffer Management ([GBM](https://en.wikipedia.org/wiki/Mesa_(computer_graphics)))
-  - [ ] [EGLStream](https://docs.nvidia.com/drive/drive_os_5.1.6.1L/nvvib_docs/index.html#page/DRIVE_OS_Linux_SDK_Development_Guide/Graphics/graphics_eglstream_user_guide.html) for NVIDIA devices (coming soon)
+  - [x] [EGLStream](https://docs.nvidia.com/drive/drive_os_5.1.6.1L/nvvib_docs/index.html#page/DRIVE_OS_Linux_SDK_Development_Guide/Graphics/graphics_eglstream_user_guide.html) for NVIDIA devices
 - X11 backend supoort
   - This is for the purpose of developing Flutter apps in Linux desktops. It is not intended for use in embedded systems.
 - Always single window fullscreen
@@ -39,7 +39,7 @@ This embedder supports x64 and Arm64 (aarch64, ARMv8) architectures on Linux whi
 | QEMU (x86_64) | QEMU | [AGL (Automotive Grade Linux)](https://wiki.automotivelinux.org/) koi | Wayland | :heavy_check_mark: |
 | QEMU (x86_64) | QEMU | [AGL (Automotive Grade Linux)](https://wiki.automotivelinux.org/) koi | DRM | :heavy_check_mark: |
 | [Jetson Nano](https://developer.nvidia.com/embedded/jetson-nano-developer-kit) | NVIDIA | JetPack 4.3 | Wayland | :heavy_check_mark: |
-| [Jetson Nano](https://developer.nvidia.com/embedded/jetson-nano-developer-kit) | NVIDIA | JetPack 4.3 | DRM | See: [#1](https://github.com/sony/flutter-embedded-linux/issues/1) |
+| [Jetson Nano](https://developer.nvidia.com/embedded/jetson-nano-developer-kit) | NVIDIA | JetPack 4.3 | DRM | :heavy_check_mark: ([#1](https://github.com/sony/flutter-embedded-linux/issues/1))|
 | [Raspberry Pi 4 Model B](https://www.raspberrypi.org/products/raspberry-pi-4-model-b/) | Raspberry Pi Foundation | Ubuntu 20.10 | Wayland | :heavy_check_mark: |
 | [Raspberry Pi 4 Model B](https://www.raspberrypi.org/products/raspberry-pi-4-model-b/) | Raspberry Pi Foundation | Ubuntu 20.10 | DRM | :heavy_check_mark: ([#9](https://github.com/sony/flutter-embedded-linux/issues/9)) |
 | [i.MX 8MQuad EVK](https://www.nxp.com/design/development-boards/i-mx-evaluation-and-development-boards/evaluation-kit-for-the-i-mx-8m-applications-processor:MCIMX8M-EVK) | NXP | Sumo (kernel 4.14.98) | Wayland | :heavy_check_mark: |
@@ -164,10 +164,21 @@ $ cmake --build .
 
 ### Build for DRM backend
 
+#### Use GBM
+
+```Shell
+$ mkdir build
+$ cd build
+$ cmake -DUSER_PROJECT_PATH=examples/flutter-drm-gbm-backend ..
+$ cmake --build .
+```
+
+#### Use EGLStream
+
 ```Shell
 $ mkdir build
 $ cd build
-$ cmake -DUSER_PROJECT_PATH=examples/flutter-drm-backend ..
+$ cmake -DUSER_PROJECT_PATH=examples/flutter-drm-eglstream-backend ..
 $ cmake --build .
 ```
 
@@ -195,8 +206,7 @@ Please edit `cmake/user_config.cmake` file.
 
 | Option | Description |
 | ------------- | ------------- |
-| USE_DRM | Use DRM backend instead of Wayland |
-| USE_X11 | Use X11 backend instead of Wayland |
+| BACKEND_TYPE | Select WAYLAND, DRM-GBM, DRM-EGLSTREAM, or X11 as the display backend type (The default setting is WAYLAND) |
 | DESKTOP_SHELL | Work as Weston desktop-shell |
 | USE_VIRTUAL_KEYBOARD | Use Virtual Keyboard (only when using `DESKTOP_SHELL`) |
 | USE_GLES3 | Use OpenGLES3 instead of OpenGLES2 |
@@ -267,7 +277,7 @@ You need to switch from GUI which is running X11 or Wayland to the Character Use
 
 ```Shell
 $ Ctrl + Alt + F3 # Switching to CUI
-$ sudo FLUTTER_DRM_DEVICE="/dev/dri/card1" ./flutter-drm-backend ./sample/build/linux/x64/release/bundle
+$ sudo FLUTTER_DRM_DEVICE="/dev/dri/card1" <binary_file_name> ./sample/build/linux/x64/release/bundle
 ```
 
 If you want to switch back from CUI to GUI, run `Ctrl + Alt + F2` keys in a terminal.

cmake/build.cmake

@@ -2,13 +2,18 @@ cmake_minimum_required(VERSION 3.10)
 
 # display backend type.
 set(DISPLAY_BACKEND_SRC "")
-if(USE_DRM)
-  add_definitions(-DDISPLAY_BACKEND_TYPE_DRM)
+if(${BACKEND_TYPE} STREQUAL "DRM-GBM")
+  add_definitions(-DDISPLAY_BACKEND_TYPE_DRM_GBM)
   set(DISPLAY_BACKEND_SRC
-    src/flutter/shell/platform/linux_embedded/window/linuxes_window_drm.cc
-    src/flutter/shell/platform/linux_embedded/window/native_window_drm.cc
-    src/flutter/shell/platform/linux_embedded/surface/linuxes_surface_gl_drm.cc)
-elseif(USE_X11)
+    src/flutter/shell/platform/linux_embedded/window/native_window_drm_gbm.cc)
+elseif(${BACKEND_TYPE} STREQUAL "DRM-EGLSTREAM")
+  ## Define "EGL_NO_X11" to avoid including x11-related files.
+  add_definitions(-DDISPLAY_BACKEND_TYPE_DRM_EGLSTREAM -DEGL_NO_X11)
+  set(DISPLAY_BACKEND_SRC
+    src/flutter/shell/platform/linux_embedded/surface/context_egl_drm_eglstream.cc
+    src/flutter/shell/platform/linux_embedded/surface/environment_egl_drm_eglstream.cc
+    src/flutter/shell/platform/linux_embedded/window/native_window_drm_eglstream.cc)
+elseif(${BACKEND_TYPE} STREQUAL "X11")
   add_definitions(-DDISPLAY_BACKEND_TYPE_X11)
   set(DISPLAY_BACKEND_SRC
     src/flutter/shell/platform/linux_embedded/window/linuxes_window_x11.cc
@@ -42,13 +47,13 @@ else()
 endif()
 
 # desktop-shell for weston.
-if(NOT USE_DRM AND DESKTOP_SHELL)
+if((${BACKEND_TYPE} STREQUAL "WAYLAND") AND DESKTOP_SHELL)
   add_definitions(-DDESKTOP_SHELL)
 endif()
 
 # wayland & weston protocols.
 set(WAYLAND_PROTOCOL_SRC "")
-if(NOT USE_DRM AND DESKTOP_SHELL)
+if((${BACKEND_TYPE} STREQUAL "WAYLAND") AND DESKTOP_SHELL)
   set(WAYLAND_PROTOCOL_SRC ${WAYLAND_PROTOCOL_SRC} src/wayland/protocol/weston-desktop-shell-protocol.c)  
 
   if(USE_VIRTUAL_KEYBOARD)
@@ -90,6 +95,7 @@ add_executable(${TARGET}
   src/flutter/shell/platform/linux_embedded/plugin/text_input_plugin.cc
   src/flutter/shell/platform/linux_embedded/plugin/platform_plugin.cc
   src/flutter/shell/platform/linux_embedded/plugin/mouse_cursor_plugin.cc
+  src/flutter/shell/platform/linux_embedded/surface/context_egl.cc
   src/flutter/shell/platform/linux_embedded/surface/egl_utils.cc
   ${DISPLAY_BACKEND_SRC}
   ${WAYLAND_PROTOCOL_SRC}
@@ -152,7 +158,7 @@ target_link_libraries(${TARGET}
     ${USER_APP_LIBRARIES}
 )
 
-if(USE_DRM)
+if(${BACKEND_TYPE} MATCHES "DRM-(GBM|EGLSTREAM)")
 target_link_libraries(${TARGET}
     PRIVATE
       Threads::Threads

cmake/package.cmake

@@ -9,16 +9,18 @@ pkg_check_modules(EGL REQUIRED egl)
 pkg_check_modules(XKBCOMMON REQUIRED xkbcommon)
 
 # depends on backend type.
-if(USE_DRM)
+if(${BACKEND_TYPE} MATCHES "DRM-(GBM|EGLSTREAM)")
   # DRM backend
   pkg_check_modules(DRM REQUIRED libdrm)
-  pkg_check_modules(GBM REQUIRED gbm)
   pkg_check_modules(LIBINPUT REQUIRED libinput)
   pkg_check_modules(LIBUDEV REQUIRED libudev)
   pkg_check_modules(LIBSYSTEMD REQUIRED libsystemd)
+  if(${BACKEND_TYPE} STREQUAL "DRM-GBM")
+    pkg_check_modules(GBM REQUIRED gbm)
+  endif()
   set(THREADS_PREFER_PTHREAD_FLAG ON)
   find_package(Threads REQUIRED)
-elseif(USE_X11)
+elseif(${BACKEND_TYPE} STREQUAL "X11")
   pkg_check_modules(X11 REQUIRED x11)
 else()
   # Wayland backend

examples/README.md

@@ -7,6 +7,7 @@ These are an example of how to use embedded Linux embedding for Flutter.
 - [flutter-wayland-client](https://github.com/sony/flutter-embedded-linux/tree/master/examples/flutter-wayland-client): Wayland client app
 - [flutter-weston-desktop-shell](https://github.com/sony/flutter-embedded-linux/tree/master/examples/flutter-weston-desktop-shell): Works on Weston desktop-shell
 - [flutter-weston-desktop-shell-virtual-keyboard](https://github.com/sony/flutter-embedded-linux/tree/master/examples/flutter-weston-desktop-shell-virtual-keyboard): Works on Weston desktop-shell with the virtual keyboard
-- [flutter-drm-backend](https://github.com/sony/flutter-embedded-linux/tree/master/examples/flutter-drm-backend): Fullscreen app on DRM backend
+- [flutter-drm-gbm-backend](https://github.com/sony/flutter-embedded-linux/tree/master/examples/flutter-drm-gbm-backend): Fullscreen app on DRM backend with GBM
+- [flutter-drm-eglstream-backend](https://github.com/sony/flutter-embedded-linux/tree/master/examples/flutter-drm-eglstream-backend): Fullscreen app on DRM backend with EGLStream
 - [flutter-x11-client](https://github.com/sony/flutter-embedded-linux/tree/master/examples/flutter-x11-client): X11 client app
 - [flutter-external-texture-plugin](https://github.com/sony/flutter-embedded-linux/tree/master/examples/flutter-external-texture-plugin): Wayland client app using external texture plugin

examples/flutter-drm-eglstream-backend/README.md

@@ -0,0 +1,25 @@
+# Overview
+
+This is the example of DRM backend with EGLStream.
+
+## Building
+
+```Shell
+$ mkdir build
+$ cd build
+$ cmake -DUSER_PROJECT_PATH=examples/flutter-drm-eglstream-backend ..
+$ cmake --build .
+```
+
+## Running Flutter app
+
+You need to switch from GUI which is running X11 or Wayland to the Character User Interface (CUI). In addition, `FLUTTER_DRM_DEVICE` must be set properly. The default value is `/dev/dri/card0`.
+
+```Shell
+$ Ctrl + Alt + F3 # Switching to CUI
+$ FLUTTER_DRM_DEVICE="/dev/dri/card1" ./flutter-drm-eglstream-backend FLUTTER_BUNDLE_PATH
+```
+
+Note that replace `FLUTTER_BUNDLE_PATH` with the flutter bundle path you want to use like ./sample/build/linux/x64/release/bundle.
+
+If you want to switch back from CUI to GUI, run `Ctrl + Alt + F2` keys in a terminal.

examples/flutter-drm-eglstream-backend/cmake/user_build.cmake

@@ -0,0 +1,25 @@
+cmake_minimum_required(VERSION 3.10)
+
+# user binary name.
+set(TARGET flutter-drm-eglstream-backend)
+
+# source files for user apps.
+set(USER_APP_SRCS
+  examples/flutter-drm-eglstream-backend/main.cc
+)
+
+# header files for user apps.
+set(USER_APP_INCLUDE_DIRS
+  ## Public APIs for developers (Don't edit!).
+  src/client_wrapper/include
+  src/flutter/shell/platform/common/client_wrapper
+  src/flutter/shell/platform/common/client_wrapper/include/flutter
+  src/flutter/shell/platform/common/public
+  src/flutter/shell/platform/linux_embedded/public
+  src/public/include
+  ## header file include path for user apps.
+  examples/flutter-drm-eglstream-backend
+)
+
+# link libraries for user apps.
+set(USER_APP_LIBRARIES "")

examples/flutter-drm-backend/cmake/user_config.cmake renamed to examples/flutter-drm-eglstream-backend/cmake/user_config.cmake

@@ -2,8 +2,7 @@ cmake_minimum_required(VERSION 3.10)
 
 # Flutter embedder configurations.
 # See: https://github.com/sony/flutter-embedded-linux#user-configuration-parameters-cmake-options
-set(USE_DRM ON)
-set(USE_X11 OFF)
+set(BACKEND_TYPE DRM-EGLSTREAM)
 set(DESKTOP_SHELL OFF)
 set(USE_VIRTUAL_KEYBOARD OFF)
 set(USE_GLES3 OFF)