Chromium Embedded Framework
Chromium Embedded Framework (CEF) is an extension of the Chromium browser rendering engine, an open-source project which is a component of Google Chrome.
In relation to Valve
The Steam client on Windows and OS X uses a customized version of CEF to render web content.
The Source code for Valve’s usage of the Chromium Embedded Framework (and Chromium) can be downloaded as a ZIP archive (783 MB, 24th April 2012). A patch for revision 465 of the CEF codebase is available on pastebin (280 KB) that will apply Valve’s changes.
Chromium Embedded Framework (CEF)
The Chromium Embedded Framework (CEF) is an open source framework for embedding a web browser engine based on the Chromium core. It allows developers to add web browser control and implement an HTML5-based layout GUI in a desktop application or to provide web browser capabilities to a software application or game, and provides the infrastructure for developers to add HTML rendering and JavaScript to a C++ project. It also comes with bindings for C, C++, Delphi, Go, Java, .NET / Mono, Visual Basic 6.0, and Python and runs on Linux, Mac OS X and Windows.
There are two versions of Chromium Embedded Framework: CEF 1 and CEF 3. Development of CEF 2 was abandoned after the appearance of the Chromium Content API.
CEF 1 is a single-process implementation based on the Chromium WebKit API. It is no longer actively developed or supported.
CEF 3 is a multi-process implementation based on the Chromium Content API and has performance similar to Google Chrome. It uses asynchronous messaging to communicate between the main application process and one or more render processes (Blink + V8 JavaScript engine). It supports PPAPI plugins and extensions, both internal (PDF viewer) or externally loadable. The single-process run mode is not supported, but still present; currently it is being used for debugging purposes only.
I will therefore focus on the Lazarus version. In fact, there are two different versions of components, called fpCEF3 and CEF4Delphi.
CEF4Delphi is an open source project created by Salvador D�az Fau to embed Chromium-based browsers in applications made with Delphi or Lazarus/FPC and is based on DCEF3, made by Henri Gourvest.
The current version of CEF4Delphi uses CEF 3.3497.1829.g004ef91 which includes Chromium 69.0.3497.81.
CEF4Delphi is being more developed than fpCEF3 lately, and is up-to-date with the chromium engine. Both projects are hosted on github, respectively: https://github.com/dliw/fpCEF3, https://github.com/salvadordf/CEF4Delphi.
Installation
Besides the Lazarus package, the CEF framework itself is needed. It is important to use the correct version of the CEF framework for the fpCEF release used. Further specific installation instructions can be found on Github: https://github.com/dliw/fpCEF3.
Warning: You can install fpCEF3 or CEF4Delphi, not both, since the component is named Chromium, the same in both packages. However, you can modify it and make a non-standard install.
Package Installation: FpCEF3
Download & Install fpCEF3
1. First of all, we need to download fpCEF3. You can download the latest version from https://github.com/dliw/fpCEF3.
2. Extract & Copy the folder to the Components directory inside your Lazarus installation (this is usually C:\Lazarus\Components).
After downloading the fpCEF3 package, it can be installed in Lazarus as follows:
- Start Lazarus and open the main menu Package -> Open package file (.lpk).
- Select the file cef3.lpk in the fpCEF3 subdirectory Component
- The package editing window will open
- Click on Compile, the package will be compiled
- Click on Use. -> Install and confirm the dialog window with Yes
- Lazarus is now compiling and create a new tab Chromium in the component palette
CEF4Delphi
Follow the same steps as in fpCEF3 install, only you will install different package name, downloaded from https://github.com/salvadordf/CEF4Delphi (see image), and installed component pallete will look just a bit different:
Download Framework CEF3
You can find CEF3 precompiled binaries for different platforms in following location:
Be sure to check the version number or commit messages to look for the appropriate version of CEF to be downloaded for it to work.
1. Download CEF. 2. Download & Install 7-zip. You’ll need 7-zip to extract the file above. 3. Now extract the file and keep it that way. We’ll only need the Release» & «Resources folders from this archive.
Usage
Now let�s create a web browser even quicker than you can install one! All using the people’s favorite chromium engine!
FpCEF3 is a great project that will let us use the Chromium engine right in our Lazarus project. It is possible to use it in Windows, Linux and Mac OS platforms. But now, we are using Windows. (You can adopt this tutorial for the other platforms quite easily if you know your way around.)
So, let’s make this browser .
The previous steps were just preparations — which you’ll only have to do once.
Create a new Application project (Project->New Project->Application->OK).
Save the Project (File -> Save All) in a directory.
And then copy all the files inside the Release and Resources folders from CEF package, and paste it directly into the project directory.
Drop a new TPanel in to the form and remove it�s Caption. On TPanel drop TEdit and TButton. Set its properties like this:
The result is as follows:
Now we’ll have a nice Location bar/Address bar at the top.
Now Drop a new TChromium (from Chromium tab) in the form. Set its properties:
It will fit the Chromium component nicely in the form’s blank area.
Now double click the Form1 item in the Object Inspector and enter the code:
Now that you are in the Code view, add the necessary unit in the uses clause:
Now add the following code on edtURL’s OnButtonClick event (select the edtURL component, go to Event tab, click the [. ] button beside OnButtonClick item):
Now add the following code on Chromium’s OnLoadEnd event (select the Chromium component, go to Event tab, click the [. ] button beside OnLoadEnd item):
All done! In about 2 minutes!
If you want to use CEF4Delphi, you need a little bit more time (I will leave it simple here):
In the project lpr file, add uCEFApplication to uses list. Also, add the following
And make the body of main lpr file look like
In the main unit, add Windows, uCEFChromium, uCEFWindowParent, uCEFInterfaces, uCEFConstants to uses list.
Also, add the following to the implementation section
In the protected section of your main form class, define:
This time we need to use two components, a TChromium and a TCEFWindowParent
Как собрать Chromium Embedded Framework для продуктов Google
В этой статье описано, как создать собственную версию Chromium Embedded Framework (CEF) для использования с программными продуктами Google на основе проекта CEF с открытым исходным кодом.
Такие продукты Google собраны на разных версиях CEF. При каждом обновлении продукта эти версии могут меняться. Перед созданием сборки рекомендуем проверить, какая версия CEF используется в продукте Google, в разделе с описанием этого продукта. Если версии CEF различаются, могут возникнуть проблемы с совместимостью.
После создания собственной сборки вы можете использовать ее, скопировав исполняемые файлы в каталог установки продукта. Структура папок с исполняемыми файлами должна совпадать со структурой папок приложения, для которого была создана сборка CEF.
Инструкции для сотрудников Google
Если вы сотрудник Google, вместо этого перейдите по ссылке go/cef.
Как создать сборку, используя официальный репозиторий CEF
Фреймворк CEF размещен на сайте Bitbucket по адресу https://bitbucket.org/chromiumembedded/cef. На этом ресурсе есть вики-страница с информацией о создании сборок CEF. Все продукты Google, в которых используется CEF, построены на ветвях выпусков CEF. На этой странице можно найти инструкции по созданию сборки из ветви выпуска. Сборки CEF в значительной степени основаны на проекте Chromium с открытым исходным кодом. По этой причине системные требования для создания сборок CEF могут быть очень высокими.
При создании сборок CEF Google использует модифицированную версию скрипта на языке Python для автоматизированной сборки, который применяет дополнительные исправления исходного кода. Для сборки версии CEF, совместимой с продуктами Google на основе CEF, использовать эти исправления необязательно, но при желании их можно найти на сайте https://third-party-mirror.googlesource.com/cef. Там продублированы в общем доступе все файлы, использованные Google для сборки CEF.
Как использовать метод CEF для автоматизированной сборки
Чтобы создать сборку, используя автоматизированный процесс CEF, следуйте инструкциям на этой странице. Не забудьте указать нужную ветвь выпуска для совместимости с версией CEF в продукте Google, под который создается сборка.
Как использовать исправления Google
Чтобы создать сборку, применив исправления, используемые Google, выполните следующие действия:
- Следуйте обычному процессу автоматизированной сборки CEF. Запустите синхронизацию с правильным источником ветви выпуска.
- Скачайте отзеркалированные файлы исправлений и добавьте их в уже существующую папку по адресу cef/patches . Следуйте инструкциям из файла README.txt , где описано, как добавить исправления и как добавить их упоминания в файл конфигурации исправлений.
- Запустите процесс сборки CEF с помощью скрипта automated_git.py .
Как включить в сборку проприетарные кодеки Chrome
Сборка CEF по умолчанию не включает проприетарные аудио- и видеокодеки. Чтобы создать сборку CEF с включенными в нее кодеками Chrome, необходимо добавить код ffmpeg_branding=Chrome proprietary_codecs=true в переменную среды GN_DEFINES .
Обратите внимание, что для использования дополнительных кодеков необходимо принять лицензионные соглашения и оплатить комиссии держателям патентов на эти кодеки.