Adding yocto packages: Difference between revisions

From Variscite Wiki
Line 115: Line 115:


== Add Chromium to the build ==
== Add Chromium to the build ==
Chromium support is provided by the 3rd party layer [https://github.com/OSSystems/meta-browser meta-browser].


Add the following line to YOCTO_DIR/BUILD_DIR/conf/local.conf:
Before proceeding, double-check that the [https://github.com/OSSystems/meta-browser meta-browser] layer is actually listed in the YOCTO_DIR/BUILD_DIR/conf/blayers.conf file.
 
If missing, ensure to have downloaded the [https://github.com/OSSystems/meta-browser meta-browser] layer in YOCTO_DIR/sources folder and to add it to the list in the YOCTO_DIR/BUILD_DIR/conf/blayers.conf file.
 
Due to the lack of dedicated integrations with iMX SoCs, this layer is no longer part of our latest manifests. Also, be aware that the branch/commit should match your current BSP version, but not all the branches are vailable from [https://github.com/OSSystems/meta-browser meta-browser] layer: e.g. at the time being, there's no dunfell branch.
 
To build chromium, you can add the following line to YOCTO_DIR/BUILD_DIR/conf/local.conf:
  IMAGE_INSTALL_append = " chromium'''<suffix>'''"
  IMAGE_INSTALL_append = " chromium'''<suffix>'''"
  LICENSE_FLAGS_WHITELIST += "commercial_libav commercial_x264"
  LICENSE_FLAGS_WHITELIST += "commercial_libav commercial_x264"
Line 127: Line 134:
  IMAGE_INSTALL_append = " chromium-ozone-wayland"
  IMAGE_INSTALL_append = " chromium-ozone-wayland"
If you plan to use Chromium, please take care of the specific requirements for commercial license of libav and x264 packages.
If you plan to use Chromium, please take care of the specific requirements for commercial license of libav and x264 packages.
 
The demo browser used for the above tests is available as
The demo browser used for the above tests is available as
  {{#ifeq: {{#var:YOCTO_NAME}} | Sumo |
  {{#ifeq: {{#var:YOCTO_NAME}} | Sumo |
Line 133: Line 140:
  #!/bin/sh
  #!/bin/sh
  /usr/bin/chromium --use-gl=egl --gpu-no-context-lost --ignore-gpu-blacklist --no-sandbox about:blank
  /usr/bin/chromium --use-gl=egl --gpu-no-context-lost --ignore-gpu-blacklist --no-sandbox about:blank
 
  To spawn the browser from command line  
  To spawn the browser from command line  
  #export DISPLAY=:0
  #export DISPLAY=:0

Revision as of 08:50, 31 May 2021

Adding packages to the Yocto build

General

Packages and package groups can be added to image recipes. See the Yocto Development manual for how to customize an image: http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#usingpoky-extend-customimage-imagefeatures

Adding a package to the local build of the BSP

Search for the corresponding recipe and which layer the recipe is in. This link is a useful tool for doing so: http://layers.openembedded.org/layerindex/branch/morty/layers/

If the package is in the meta-openembedded layer, the recipe is already available in your build tree.

Add the following line to YOCTO_DIR/BUILD_DIR/conf/local.conf:

 IMAGE_INSTALL_append = " <package>"

Note: The leading white-space between the " and the package name is necessary for the append command.

If you need to add a layer to the BSP, clone or extract it to the YOCTO_DIR/sources/ directory. Then, modify YOCTO_DIR/BUILD_DIR/conf/bblayers.conf to include this new layer in BBLAYERS:

 BBLAYERS += "${BSPDIR}/sources/<new_layer>"

Webserver support

Recipes in meta-openembedded/meta-webserver/recipes-httpd:
- apache2
- cherokee
- hiawatha
- monkey
- nginx
- nostromo
- sthttpd
Recipes in poky/meta/recipes-extended/lighttpd:
- lighttpd

Although full of capabilities and features, Apache is commonly considered quite heavy, so is not generally used for embedded devices.
Nostromo and sthttpd are commonly considered ultralight webserver, with a very small set of capabilities and features, with very limited resource requirements.
The usual choice is usually between the following 5:
- cherokee
- hiawatha
- monkey
- nginx
- lighttpd
Here you can find an article comparing the above 5 webserver:
https://www.linux.com/news/which-light-weight-open-source-web-server-right-you


Accelerated browsers support

Yocto build system allow integrating browsers that support iMX6 GPU accelerations.

The common used browsers are:

  • qtwebkit based browsers: QtWebKit is the WebKit porting to QT. WebKit is an open source web browser engine. QT5 provide some demo implementations in webkitwidgets examples.
  • qtwebengine based browsers: QtWebEngine integrates chromium's fast moving web capabilities into QT. QT5 provide some demo implementations in webenginewidgets examples.
  • chromium based browsers: Chromium is an open-source browser project.

Till 2016, FSLC community maintained chromium-imx project: customized Chromium versions (up to v48) providing GPU and VPU integration for iMX6 CPUs.

Much more updated Chromium versions are available from meta-browser, only providing GPU integration.

The minimum requirements to use chromium browsers is X11 or Wayland.

QT based browsers directly rely on QT integration with iMX6 accelerations.

QtWebKit has been superseded by QtWebEngine, mainly because QtWebKit has not been actively synchronized with the upstream WebKit code since Qt 5.2 and has been deprecated in Qt 5.5. Further details are available in Qt WebEngine Overview

QT team provides a QtWebEngine browser for embedded touch devices and related recipes hase been integrated in our BSP starting from Sumo.

The performance of each browser is strictly related to the features to be used, so different html applications can provide better performance with different browsers.

The following table try to summarize some benchmark for Wayland backend:

website QtWebKit QtWebEngine Chromium
http://peacekeeper.futuremark.com crash 623 n/a
http://www.kevs3d.co.uk/dev/canvasmark n/a 4796 3780
http://webglsamples.org/blob/blob.html 2 fps 32 fps 34 fps

Add QtWebKit examples to the build

Add the following line to YOCTO_DIR/BUILD_DIR/conf/local.conf:

IMAGE_INSTALL_append = " qtwebkit-examples-examples"

The demo browser used for the above tests is available as

/usr/share/qt5/examples/webkitwidgets/fancybrowser/fancybrowser

Add QtWebEngine examples to the build

Add the following line to YOCTO_DIR/BUILD_DIR/conf/local.conf:

IMAGE_INSTALL_append = " qtwebengine-examples"

The demo browser used for the above tests is available as

/usr/share/qt5/examples/webenginewidgets/fancybrowser/fancybrowser

Add Chromium to the build

Chromium support is provided by the 3rd party layer meta-browser.

Before proceeding, double-check that the meta-browser layer is actually listed in the YOCTO_DIR/BUILD_DIR/conf/blayers.conf file.

If missing, ensure to have downloaded the meta-browser layer in YOCTO_DIR/sources folder and to add it to the list in the YOCTO_DIR/BUILD_DIR/conf/blayers.conf file.

Due to the lack of dedicated integrations with iMX SoCs, this layer is no longer part of our latest manifests. Also, be aware that the branch/commit should match your current BSP version, but not all the branches are vailable from meta-browser layer: e.g. at the time being, there's no dunfell branch.

To build chromium, you can add the following line to YOCTO_DIR/BUILD_DIR/conf/local.conf:

IMAGE_INSTALL_append = " chromium<suffix>"
LICENSE_FLAGS_WHITELIST += "commercial_libav commercial_x264"
The <suffix> depends on your specific Yocto version and graphic backend.

Till Yocto Morty, chromium was available only for x11 backend and no suffix was required

IMAGE_INSTALL_append = " chromium"

Starting from Yocto Thud, chromium is available for both x11 backend

IMAGE_INSTALL_append = " chromium-x11"

and wayland backend

IMAGE_INSTALL_append = " chromium-ozone-wayland"

If you plan to use Chromium, please take care of the specific requirements for commercial license of libav and x264 packages.

The demo browser used for the above tests is available as

/usr/bin/google-chrome