rdkcentral/rdkshell

Controls the management of composition, layout, z-order, and key handling of launched applications.

RDKShell

RDKShell is a native component that provides application management, composition, and advanced key handling.

The RDKShell component has dependencies on Westeros, Essos, and OpenGL ES 2.0. RDKShell uses Westeros to create a Wayland surface or display for applications to connect itself to. RDKShell provides a set of APIs for the system or applications to control the display and the positioning of the application windows on screen.

RDKShell connects to either the native windowing system or to a Wayland compositor. It achieves this flexibility and functionality by using Essos. By default, RDKShell will render its display to a native window (EGL).

RDKShell also provides a Thunder API. This API allows applications to communicate with RDKShell using JSON-RPC if desired. Alternatively, there are C++ APIs to interact with RDKShell directly in native code.

Key Handling Sequence

RDKShell allows for applications to register for key events that they may be interested in even if they are not the focused application. By default, all key events go to the currently focused application. However, an application can request to intercept a key if desired. If the key is intercepted then the focused app will not receive the key event unless if it intercepts the key as well.

rdkshell's Issues

rdkshell crashed with SIGSEGV on DRM backend

RDKShell is crashed with Segmentation fault where DRM is the backend for wayland, however essos-sample is running good in the same environment. The crash seems to be on RDKShell::image::draw()
Error log:

root@raspberrypi-rdk-mc:~# export XDG_RUNTIME_DIR=/run/user/0
root@raspberrypi-rdk-mc:~# export LD_PRELOAD=/usr/lib/libwesteros_gl.so.0
root@raspberrypi-rdk-mc:~# ./rdkshell 
initializing rdk shell
Ignored file read due to keyMap env not set
Ignored file read due to easter egg environment variable not set
Ignored file read due to input devices environment variable not set
key initial delay: 500 repeat interval: 100
Essos Info: westeros (essos) version 1.01.21
Essos Info: westeros (essos) config supports: direct 1 wayland 1
1609413373501: INFO: ../git/drm/westeros-gl/westeros-gl.c:3121 opened /dev/dri/card0: master 1
1609413373501: INFO: ../git/drm/westeros-gl/westeros-gl.c:3189 westeros-gl: have drm atomic mode setting
1609413373565: INFO: ../git/drm/westeros-gl/westeros-gl.c:3280 wstInitCtx: current mode 1920x1080@60
1609413373570: INFO: ../git/drm/westeros-gl/westeros-gl.c:3476 wstInitCtx; found 7 overlay planes
1609413373570: ERROR: ../git/drm/westeros-gl/westeros-gl.c:1713 wstInitServiceServer: failed to create lock file (/run/user/0/display.lock) errno 2
1609413373570: ERROR: ../git/drm/westeros-gl/westeros-gl.c:2458 wstInitVideoServer: Error: unable to start service server
1609413373570: ERROR: ../git/drm/westeros-gl/westeros-gl.c:3494 wstInitCtx: failed to initialize display server
1609413373571: ERROR: ../git/drm/westeros-gl/westeros-gl.c:1713 wstInitServiceServer: failed to create lock file (/run/user/0/video.lock) errno 2
1609413373571: ERROR: ../git/drm/westeros-gl/westeros-gl.c:1828 wstInitVideoServer: Error: unable to start service server
1609413373571: ERROR: ../git/drm/westeros-gl/westeros-gl.c:3511 wstInitCtx: failed to initialize video server
Essos Info: displaySizeCallback: display size 1920x1080
Essos Info: displaySizeCallback: display safe (96,54,1728,972)
1609413373619: INFO: ../git/drm/westeros-gl/westeros-gl.c:5695 native window: wxh=1280x720
1609413373619: INFO: ../git/drm/westeros-gl/westeros-gl.c:3825 choosing output mode: 1280x720x60
1609413373619: INFO: ../git/drm/westeros-gl/westeros-gl.c:5725 plane 0x161ee0 : zorder: 262
Essos Info: essResize 1920x1080
1609413373626: INFO: ../git/drm/westeros-gl/westeros-gl.c:5695 native window: wxh=1920x1080
1609413373626: INFO: ../git/drm/westeros-gl/westeros-gl.c:5725 plane 0x161ee0 : zorder: 262
the power key is set to 0
power key support enabled: 0
compositor type is empty, setting to nested by default 
Segmentation fault (core dumped)

Stack trace:

Thread 1 "rdkshell" received signal SIGSEGV, Segmentation fault.
0x76fb93ac in RdkShell::Image::draw() () from /usr/lib/librdkshell.so
(gdb) bt full
#0  0x76fb93ac in RdkShell::Image::draw() () from /usr/lib/librdkshell.so
No symbol table info available.
#1  0x76fac0ca in RdkShell::CompositorController::draw() () from /usr/lib/librdkshell.so
No symbol table info available.
#2  0x76fab0dc in RdkShell::run() () from /usr/lib/librdkshell.so
No symbol table info available.
#3  0x0000883a in main ()
No symbol table info available.

Platform: Raspberrypi
linux kernel: 5.4.72
Environment: vc4graphics + direct rendering management (DRM) backend