diff --git a/contribute.rst b/contribute.rst
index 832389525c04d4934446987f7f025e18fbef8897..66472a8b9c88717683c6b1439e6e5a5078b812ab 100644
--- a/contribute.rst
+++ b/contribute.rst
@@ -23,8 +23,8 @@ instructions on how to report bugs and issues you encounter in Jami.
Contributing code
=================
-If you want to start to contribute to Jami, you can start by looking good
-first issues at: https://git.jami.net/groups/savoirfairelinux/-/issues/?sort=created_date&state=opened&label_name%5B%5D=good-first-issue
+If you want to start to contribute to Jami, you can start by looking good first issues at:
+https://git.jami.net/groups/savoirfairelinux/-/issues/?sort=created_date&state=opened&label_name%5B%5D=good%20first%20issue
You can contact developers directly by adding a comment on the ticket you
want to start with. They will be able to guide you through the process.
@@ -80,7 +80,7 @@ the Snap Store or https://dl.jami.net
+ Via the packaging process of your favorite GNU/Linux distribution
.. note:: Jami is a quite complex project with a lot of dependencies.
- This isn't a quick and easy task and ask for some maintainance.
+ This isn't a quick and easy task and ask for some maintenance.
If you choose the second option, here are some useful notes:
+ For our official release, we stick to a certain Qt version, because
@@ -114,10 +114,10 @@ If you want to add a new distribution, you will need to:
+ Cross fingers
+ Test the package in a VM
-.. note:: Chromium is a hard part to build. the 3 commons problems we got are:
+.. note:: Chromium is a hard part to build. Three common problems encountered are:
+ GCC is too recent:
- + Generally the fix consist of importing patches from chromium's gerrit to fix GCC issues
+ + Generally the fix consist of importing patches from Chromium's gerrit to fix GCC issues
+ Python is too recent:
+ Generally the fix consist of using PyEnv to get a virtual environment with the correct Python's version
+ Missing dependencies:
diff --git a/developer/jami-concepts/drt.rst b/developer/jami-concepts/drt.rst
index 3bf7fdbb4d33d58f21f25572feed3f078fe14ab3..a021de0a45fbda937f137866783a99e16ff78af4 100644
--- a/developer/jami-concepts/drt.rst
+++ b/developer/jami-concepts/drt.rst
@@ -182,5 +182,3 @@ Future work
1. Dynamic bucket size limit to get different bucket size depending on how large is the routing table
2. Declining some connections to speed-up the transmission a bit
-
-
diff --git a/developer/new-developers/qt-qml-testing-tools.md b/developer/new-developers/qt-qml-testing-tools.md
index 79950ddd21532038bc749fd4e8ee447c647fd629..26c6d5ab51378c7401ff3321aa4a6bc75c886f07 100644
--- a/developer/new-developers/qt-qml-testing-tools.md
+++ b/developer/new-developers/qt-qml-testing-tools.md
@@ -47,7 +47,7 @@ index 2f1b633a..0df2594d 100644
[{"Alias":"AmarOk","ID":"a2d724d18a943e6c","NotificationCount":0,"Status":5,"Type":1,"Username":"amarok"},{"Alias":"Munnin","ID":"8a22b7d0176327db","NotificationCount":0,"Status":5,"Type":1,"Username":"munnin"},{"Alias":"TEST JAMI","ID":"3b7d2b9e2af83a47","NotificationCount":0,"Status":5,"Type":2,"Username":"696"},{"Alias":"Sébastien Blin","ID":"131ad59045a9a146","NotificationCount":0,"Status":5,"Type":1,"Username":"sblin"}]
```
-Now, the developper can easily use it in a test. The best way is to add this data in a variable or a separated js file (cf https://doc.qt.io/qt-6/qtqml-documents-networktransparency.html). And use it in a test e.g.:
+Now, the developer can easily use it in a test. The best way is to add this data in a variable or a separated js file (cf https://doc.qt.io/qt-6/qtqml-documents-networktransparency.html). And use it in a test e.g.:
```qml
TestWrapper {
diff --git a/developer/new-developers/working-with-gerrit.md b/developer/new-developers/working-with-gerrit.md
index 55a6ab55089715c11c8bf69bcb93d5c6cdd60835..c8adf6a58d2628e956b67d1e9274d2157ea5055c 100644
--- a/developer/new-developers/working-with-gerrit.md
+++ b/developer/new-developers/working-with-gerrit.md
@@ -12,7 +12,7 @@ Working with Gerrit
3. Don't forget to select a username.
4. Finally, the email address specified in your git config must match one the email address registered with your Gerrit account.
-*Note for Savoir-faire Linux employees: please continue to use your @savoirfairelinux.com email address.*
+*Note for Savoir-faire Linux Inc. employees: please continue to use your @savoirfairelinux.com email address.*
### To Know your Git Config
diff --git a/index.rst b/index.rst
index f3db2ba9953f12a879aeef59ac9d256df4016270..0034b746b853cea1cdbcb926302158e9808b8fe7 100644
--- a/index.rst
+++ b/index.rst
@@ -18,8 +18,8 @@ option) any later version. The Jami team :doc:`uses Gerrit for
development <developer/new-developers/working-with-gerrit>` and code reviews, and
issues and feature requests are :doc:`tracked on the Jami GitLab
<user/bug-report-guide>`. The development of Jami is led by
-`Savoir-faire Linux <https://savoirfairelinux.com/en>`_ --- a Canadian
-GNU/Linux consulting company based in Montréal --- and is supported by
+`Savoir-faire Linux Inc. <https://savoirfairelinux.com/en>`_ --- a Canadian
+GNU/Linux consulting company based in Montréal, Québec --- and is supported by
a growing global community of users and contributors.
This documentation is community-driven and :ref:`anyone can contribute
@@ -51,22 +51,25 @@ contribute to Jami:
Community and support
---------------------
-You can reach the Jami developers and community of users at the
-following public places:
+Learn more about:
+Jami: https://jami.net/
+Jami extensions: https://jami.net/extensions/
+“Jami Account Management Server” (JAMS): https://jami.biz/
+Jami documentation: https://docs.jami.net/
-- Jami's forum: https://forum.jami.net
-- Jami's GNU mailing list: `jami@gnu.org
- <https://lists.gnu.org/mailman/listinfo/jami>`_
-- Jami's IRC channel on the Libera.Chat network:
- `#jami <https://web.libera.chat/#jami>`_
-- Jami's Matrix room: `#jami:matrix.org
- <https://matrix.to/#/#jami:matrix.org>`_
- (bridged with the above IRC channel)
-- Jami's social media:
- `@jami_social <https://nitter.net/jami_social>`_ (Twitter)
- and `@Jami@mstdn.io <https://mstdn.io/@Jami>`_ (Fediverse)
-- Jami's subreddit: `/r/jami <https://old.reddit.com/r/jami>`_
+Follow us for more:
+- Mastodon: `@Jami@mstdn.io <https://mstdn.io/@Jami>`_
+- X: `@jami_social <https://x.com/jami_social>`_
+- YouTube: `@jami9311 <https://www.youtube.com/@jami9311>`_
-You can also contact the Jami team at Savoir-faire Linux directly via
-email, at contact@jami.net. Additionally, Savoir-faire Linux offers
+We’d love to hear from you! Join the Jami community:
+- Contribute: https://jami.net/contribute/
+- Forum: https://forum.jami.net/
+- GNU Mailman: `jami@gnu.org <https://lists.gnu.org/mailman/listinfo/jami>`_
+- Libera.Chat: `#jami <https://web.libera.chat/#jami>`_
+- Matrix: `#jami:matrix.org <https://matrix.to/#/#jami:matrix.org>`_
+ (bridged with Libera.Chat)
+
+You can also contact the Jami team at Savoir-faire Linux Inc. directly via
+email at contact@jami.net. Additionally, Savoir-faire Linux Inc. offers
commercial support for Jami via https://jami.biz.
diff --git a/jami-extensions/creating-jami-plugins.md b/jami-extensions/creating-jami-plugins.md
index e81d087faf01406b0e5f709cc499d1bd71e22808..c52303eb68a3ee50b5a9bf990f755840c0b8d0b5 100644
--- a/jami-extensions/creating-jami-plugins.md
+++ b/jami-extensions/creating-jami-plugins.md
@@ -4,9 +4,9 @@ Creating Jami plugins
**NOTE: this page introduces the Jami Plugins SDK.**
## Jami Plugins
-As from September of 2020, Jami team has added plugins as a call feature for GNU/Linux, Windows, macOS, and Android users.
+In September 2020, the Jami team added plugins as a call feature for GNU/Linux, Windows, macOS, and Android users.
This means that now you can personalize your call and chat experience by using one of our available plugins.
-But that is not all, you can also transform your awesome ideas into a brand new plugin!
+But that is not all, you can also transform your awesome ideas into brand new plugins!
Here you will be guided through the SDK that will help you start your plugin development.
The text is organized as:
@@ -17,7 +17,7 @@ The text is organized as:
We developed a Plugin System for Jami and we have a few plugins available to be used.
However as an open source project, we now desire users to be able to create, use, and distribute their own plugins.
To achieve that goal, we also developed a Jami Plugins SDK.
-This kit is fully written in Python, and can be invoked running [pluginMainSDK.py]('') from `<plugins>` folder.
+This kit is written in Python, and can be invoked running [pluginMainSDK.py]('') from `<plugins>` folder.
To get started you must:
``` bash
@@ -44,7 +44,8 @@ Each one of these functionalities will be detailed next.
We also will explain the importance of the files it generates and any related SDK limitations.
#### Create full plugin skeleton
-This option performs a sequence of actions to properly create all base files needed to start a plugin development. The steps are:
+This option performs a sequence of actions to properly create all base files needed to start a plugin development.
+The steps are:
1. gather authorship information;
2. define a plugin name;
@@ -54,14 +55,16 @@ This option performs a sequence of actions to properly create all base files nee
6. define basic package.json;
7. define basic build file (CMakeLists.txt).
-If all is completed successfully, the plugin may be build, installed, and loaded. Also the functionalities may be toggled, however, since their data processes are not implemented, they will perform no action. In our `HelloWorld` plugin, we implement a simple process using **OpenCV**. For more complex options, you can refer to our available plugins at {gitlab-project}`jami-plugins`. Feel free to implement any ideas you may have, but you should respect those constrains:
-* use ffmpeg, opencv, and onnx from jami-daemon project;
-* if using tensorflow, choose version 2.1.0. Why?
- * We have all needed header files of tensorflow 2.1.0 in <jami-plugins>/contrib/libs.tar.gz;
- * We provide docker images with libraries for Tensorflow C++ API and Tensorflow
- Lite, for both Android and Linux development.
-* if you need other libraries, check if we support it's build with jami-daemon project,
- otherwise, you will have to build it and ensure correct link to the plugin libraries.
+If all is completed successfully, the plugin may be build, installed, and loaded.
+Also the functionalities may be toggled, however, since their data processes are not implemented, they will perform no action.
+In our `HelloWorld` plugin, we implement a simple process using **OpenCV**.
+For more complex options, you can refer to our available plugins at {gitlab-project}`jami-plugins`.
+Feel free to implement any ideas you may have, but you should respect those constrains:
+* use FFmpeg, OpenCV, and ONNX from jami-daemon project;
+* if using TensorFlow, choose version 2.1.0. Why?
+ * We have all needed header files of TensorFlow 2.1.0 in <jami-plugins>/contrib/libs.tar.gz;
+ * We provide docker images with libraries for TensorFlow C++ API and TensorFlow Lite, for both Android and Linux development.
+* if you need other libraries, check if we support it's build with jami-daemon project, otherwise, you will have to build it and ensure correct link to the plugin libraries.
To fully create a basic plugin with pre-implementation of desired functionalities APIs, preferences, package, manifest, main file, and basic build related files, from inside Jami Plugins SDK shell, the user must call:
```
@@ -71,7 +74,9 @@ To fully create a basic plugin with pre-implementation of desired functionalitie
The SDK will ask other information needed to correctly accomplish the task.
#### Create, modify or delete manifest.json
-Every plugin must have a manifest. This file contains the official name, a description, and carries the plugin build version as in the example bellow. Without it, the plugin system will not be able to find the plugin library it should load. Due to it's importance, every time Jami Plugin SDK is told to create files to a non existing plugin or to a plugin with no manifest, it will first create a new manifest.
+Every plugin must have a manifest.
+This file contains the official name, a description, and carries the plugin build version as in the example below.
+Without it, the plugin system will not be able to find the plugin library it should load. Due to it's importance, every time Jami Plugin SDK is told to create files to a non existing plugin or to a plugin with no manifest, it will first create a new manifest.
``` bash
{
@@ -89,16 +94,16 @@ To create/modify (or to delete) a manifest.json, from inside Jami Plugins SDK sh
The SDK will ask other information needed to correctly accomplish the task.
#### Create a package.json
-Jami currently supports plugins for GNU/Linux, Android and Windows. For the latter, the build system used is the same as for Jami, it is, we call the plugin build using a python script. This script will look for a `package.json` file to aquire build information and commands. Without this file our build pipeline for Windows will not work.
+Jami currently supports plugins for GNU/Linux, Android and Windows. For the latter, the build system used is the same as for Jami, it is, we call the plugin build using a Python script. This script will look for a `package.json` file to acquire build information and commands. Without this file our build pipeline for Windows will not work.
-An example package.json file is shown bellow.
+An example package.json file is shown below.
* `name` and `version` in the package.json and manifest.json files should match.
-* `extractLibs` indicates to the build system if the files under `<jami-plugins>/contrib/libs.tar.gz` will be used. This archive contains header files for **Tensorflow**. Thus, you only need to set `extractLibs` to true if you plan to use this library.
-* To play with audio or video, the plugin is dependent of **ffmpeg**. By adding it to `deps`, the build system will automatically compile this library from `<jami-daemon>/contrib` if needed. We also provide **OpenCV** build from inside `<jami-daemon>/contrib` !
-If you want to use Tensorflow, we provide built libraries for GNU/Linux and Android with our docker images [here](https://hub.docker.com/repository/docker/sflagsantos/tensorflow-cuda) and [here](https://hub.docker.com/repository/docker/sflagsantos/tensorflowlite).
-For more information about OpenCV and Tensorflow build, please refer to {doc}`jami-plugins` technical documentation. There we have a step-by-step!
+* `extractLibs` indicates to the build system if the files under `<jami-plugins>/contrib/libs.tar.gz` will be used. This archive contains header files for **TensorFlow**. Thus, you only need to set `extractLibs` to true if you plan to use this library.
+* To play with audio or video, the plugin is dependent on **FFmpeg**. By adding it to `deps`, the build system will automatically compile this library from `<jami-daemon>/contrib` if needed. We also provide **OpenCV** build from inside `<jami-daemon>/contrib` !
+If you want to use TensorFlow, we provide built libraries for GNU/Linux and Android with our docker images [here](https://hub.docker.com/repository/docker/sflagsantos/tensorflow-cuda) and [here](https://hub.docker.com/repository/docker/sflagsantos/tensorflowlite).
+For more information about OpenCV and TensorFlow build, please refer to {doc}`jami-plugins` technical documentation. There we have a step-by-step!
* If you're using cmake, your can set configuration definition in `defines` property. Example: if your configuration line is of the form `cmake -DCPU=TRUE ..` you may set `"defines": ["CPU=TRUE"]`.
-* Any command directly related to the plugin build can be defined inside `custom_scripts`. Bellow we create the build folder to with the plugins project will be configured with `mkdir msvc` and we also set the build command as `cmake --build ./msvc --config Release`. Our example CMakeLists.txt may have pre and post build instruction that are not listed here.
+* Any command directly related to the plugin build can be defined inside `custom_scripts`. Below we create the build folder to with the plugins project will be configured with `mkdir msvc` and we also set the build command as `cmake --build ./msvc --config Release`. Our example CMakeLists.txt may have pre and post build instruction that are not listed here.
``` bash
{
@@ -137,11 +142,13 @@ For `EDITTEXT` preferences there is no other property to be set.
For `PATH` preferences we have: `mimeType`.
For `LIST` preferences we have: `entries` and `entryValues`.
A `LIST` preference must have a list of possible values to be used and a list of 'names' for these values. For example:
-If you have two `entriesValues`: '0' and '1', these values may not be understandable by the user. Jami's UI will take the values from `entries` to be shown as 'names' for each one of these `entryValues`.
-Then you can call '0' and '1' as 'sent' and 'received'. The UI will show these names that are more user friendly!
+If you have two `entriesValues`: '0' and '1', these values may not be understandable by the user.
+Jami's UI will take the values from `entries` to be shown as 'names' for each one of these `entryValues`.
+Then you can call '0' and '1' as 'sent' and 'received'.
+The UI will show these names that are more user friendly!
It is important to note that `entries` and `entryValues` must have the same number of items.
-Another important point to be noted for the preferences is that their values could be modified during runtime if, and only if, two conditions are satisfied:
+Another important point to be noted for the preferences is that their values could be modified at runtime if, and only if, two conditions are satisfied:
1. the code that applies the new value is within your functionality implementation and;
2. this functionality is listed in the preference's `scope` property.
@@ -151,14 +158,14 @@ To better explain, we have to detail what is a scope and how a preference change
* **Scope**: A scope is a list of functionalities that can modify a preference value even if the functionality is under use. It is, imagine you have a functionality called "Circle" that prints a colored circle to your video. Consider also that the color of that circle is set by a preference and that this preference lists "Circle" as one of it's scopes. In that scenario "Circle" will be able to modify the default circle color to another one.
* **Code implementation**: Continuing our example above, "Circle" also is the implementation of an abstract API class from Daemon (for more details check [#Create functionality](#create-functionality). When a user changes a preference value, the plugin system will call the `setPreferenceAttribute` implementation for each of the functionalities listed by the preference's scope. By it's turn, this function will match the preference unique `key` and call an internal function to apply the new value.
-For a pratical example, you can check the 'Foreground Segmentation' functionality of the GreenScreen plugin - [pluginMediaHandler.cpp](https://git.jami.net/savoirfairelinux/jami-plugins/blob/master/GreenScreen/pluginMediaHandler.cpp) and [preferences-onnx.json](https://git.jami.net/savoirfairelinux/jami-plugins/blob/master/GreenScreen/preferences-onnx.json). This plugin has both `LIST` and `PATH` preferences and also has one preference that can be modified during runtime. Can you tell which one?
+For a practical example, you can check the 'Foreground Segmentation' functionality of the GreenScreen plugin - [pluginMediaHandler.cpp](https://git.jami.net/savoirfairelinux/jami-plugins/blob/master/GreenScreen/pluginMediaHandler.cpp) and [preferences-onnx.json](https://git.jami.net/savoirfairelinux/jami-plugins/blob/master/GreenScreen/preferences-onnx.json). This plugin has both `LIST` and `PATH` preferences and also has one preference that can be modified at runtime. Can you tell which one?
To create (or delete) a preference, from inside Jami Plugins SDK shell, the user must call:
```
(Jami Plugins SDK) preference (-del)
```
-The SDK will ask other information needed to correctly accomplish the task. If a preference is created from outside a functionality creation pipeline, any API implementation will not be changed in order to avoid being overwritten. Thus, if you want to allow values change during runtime, you may need to manually modify your functionality implementation to fit running time change conditions.
+The SDK will ask other information needed to correctly accomplish the task. If a preference is created from outside a functionality creation pipeline, any API implementation will not be changed in order to avoid being overwritten. Thus, if you want to allow values change at runtime, you may need to manually modify your functionality implementation to fit running time change conditions.
#### Create functionality
A Jami plugin may wrap one or multiple functionalities. It is, the same plugins may have a functionality to change background and to draw a circle to a video for example.
@@ -176,8 +183,8 @@ To create a functionality, from inside Jami Plugins SDK shell, the user must cal
The SDK will ask other information needed to correctly accomplish the task.
#### Create main
-This option create plugin's `main.cpp`. A file that implements the plugin external loading function that Jami Plugin System
-will call to initialize and register all functionalities for latter use.
+This option create plugin's `main.cpp`.
+A file that implements the plugin external loading function that Jami Plugin System will call to initialize and register all functionalities for latter use.
The SDK is set to rewrite the main file every time you create a new functionality.
Thus, if you want to manually create or delete a functionality, we recommend calling this option instead.
@@ -195,7 +202,7 @@ OBS.: files added by the developer must be organized under the `data/` folder.
The SDK assemble option has two different behaviors:
-* it creates a build folder and copies there all files that will be compressed to the final plugin archive. For linux host: `<plugins>/<HelloWorld>/build-local/jpl/` and for a windows host: `<plugins>/<HelloWorld>/msvc/jpl/`;
+* it creates a build folder and copies there all files that will be compressed to the final plugin archive. For a Linux host: `<plugins>/<HelloWorld>/build-local/jpl/` and for a Windows host: `<plugins>/<HelloWorld>/msvc/jpl/`;
* it compresses all files inside the build folder to the jpl archive which is output under `<plugins>/build`.
Both process should be called from inside the CMakeLists.txt as POST_BUILD and PRE_BUILD commands, respectively.For more information about CMakeLists.txt file, please refer to [build](#build) and to our available plugins at {gitlab-project}`jami-plugins`.
@@ -254,9 +261,9 @@ The SDK will ask other information needed to correctly accomplish the task.
### Create my first plugin
Through this section we will present a step-by-step construction of a `HelloWorld` plugin using our SDK.
Our goal is to print a colored circle in the middle of the video frames using **OpenCV**.
-The color of that circle will be defined by a preference which will be changeable during runtime.
-Also we can set a stream preference to define if the plugin will modify the video sent or the one received, this time we don't want to allow a change during runtime.
-We can define a second functionality that will always draw a circle in the right top corner, with the color defined by the same preference as the previous functionality but that cannot be changed during runtime.
+The color of that circle will be defined by a preference which will be changeable at runtime.
+Also we can set a stream preference to define if the plugin will modify the video sent or the one received, this time we don't want to allow a change at runtime.
+We can define a second functionality that will always draw a circle in the right top corner, with the color defined by the same preference as the previous functionality but that cannot be changed at runtime.
At the end we will exemplify how to build your plugin with and without the SDK.
#### Step 1 - prepare development environment
@@ -394,7 +401,7 @@ All final files can be found {gitlab-project}`here <jami-plugins>`.
#### Step 3 - build
-Before building the HelloWorld, you should compile ffmpeg and OpenCV dependencies. This can be achieved by following the build instructions for OpenCV {doc}`here <jami-plugins>`. Ffmpeg will be automatically build if you follow those instructions.
+Before building the HelloWorld, you should compile FFmpeg and OpenCV dependencies. This can be achieved by following the build instructions for OpenCV {doc}`here <jami-plugins>`. FFmpeg will build automatically if you follow those instructions.
To build you plugin, you can either:
* Call the build from Jami Plugins SDK (works for GNU/Linux and Windows):
@@ -471,6 +478,5 @@ New plugin version (ignore to keep previous version): 2.0
Finally, you can rebuild the plugin using the same steps as before!
-
Now you can start your own creations!
-Remember to tag Jami and Savoir-Faire Linux in your repository, this way we can get to know how the community is developing their own plugins!
+Remember to tag Jami and Savoir-Faire Linux Inc. in your repository, this way we can get to know how the community is developing their own plugins!
diff --git a/jami-extensions/how-it-works.md b/jami-extensions/how-it-works.md
index e9fbf42cee78f8b070401993ff4d635dc86d9c21..ffcb15ae2c7b6c24866729e718c23019f79f682d 100644
--- a/jami-extensions/how-it-works.md
+++ b/jami-extensions/how-it-works.md
@@ -2,26 +2,37 @@ How it works?
=============
**NOTE: this page describes what is a Jami Plugin and how to install and use them.
-In the documentation and in the code, we use the term plugin. However note that the Jami client user interface refers to and displays "plugins" as "extensions". **
+In the documentation and in the code, we use the term plugin.
+However note that the Jami client user interface refers to and displays "plugins" as "extensions".**
Jami can be break down to three main components that interact together: Daemon, LRC and clients.
-Daemon is the core of Jami, and although it does not interact with users, it is involved in every
-command. Therefore, Daemon has a `JamiPluginManager` class that among other actions perfoms install/uninstall, load/unload, edit preferences and control plugins' usage.
+Daemon is the core of Jami, and although it does not interact with users, it is involved in every command.
+Therefore, Daemon has a `JamiPluginManager` class that among other actions perfoms install/uninstall, load/unload, edit preferences and control plugins' usage.
Despite Daemon importance, what a plugin effectivelly does to a call video/audio or to a chat message is unknown to it the same way Daemon does not know what is effectivelly done by LRC or the clients interfaces.
Plugins then can be seen as a forth interacting component in Jami.
-The plugin system inside Jami exposes different APIs that can be used by the plugins. For instance, the ChatHandler and the Media Handler API. The latter enables the plugins to modify audio and video streams from Jami calls and is used by our GreenScreen plugin but could also be used to build a YouTube streaming system, various instagram-style filters, a real time translation service, etc.
+The plugin system inside Jami exposes different APIs that can be used by the plugins.
+For instance, the ChatHandler and the Media Handler API.
+The latter enables the plugins to modify audio and video streams from Jami calls and is used by our GreenScreen plugin but could also be used to build a YouTube streaming system, various instagram-style filters, a real time translation service, etc.
-Plugins can be composed by one or multiple media and chat handlers that are responsible for attaching/detaching a data stream from Jami and a data process. Each handler represents a functionality that can be totally different between them or can be a modified versions of the same core process. In our example, we have only one functionality, it being, the GreenScreen plugin has one media handler which data process is responsible for segmenting the foreground from a video frame and applying another image to the background, just like it is done with the green screens in movies!
+Plugins can be composed by one or multiple media and chat handlers that are responsible for attaching/detaching a data stream from Jami and a data process.
+Each handler represents a functionality that can be totally different between them or can be a modified versions of the same core process.
+In our example, we have only one functionality, it being, the GreenScreen plugin has one media handler which data process is responsible for segmenting the foreground from a video frame and applying another image to the background, just like it is done with the green screens in movies!
-To use one custom functionality, it is necessary that Jami knows all plugins' handlers, which one is going to be used and the data that should be processed. Plugin's handlers are created once a plugin is loaded and are shared with Daemon's Plugin Manager. The data is inside Jami flow (for a call plugin, in the event of a new call, Jami creates and stores the corresponding media stream subjects). Finally, once a user puts a plugin functionality in action Jami tells this handler to attach the available data. When deactivated, Jami tells the handler to dettach.
+To use one custom functionality, it is necessary that Jami knows all plugins' handlers, which one is going to be used and the data that should be processed.
+Plugin's handlers are created once a plugin is loaded and are shared with Daemon's Plugin Manager.
+The data is inside Jami flow (for a call plugin, in the event of a new call, Jami creates and stores the corresponding media stream subjects).
+Finally, once a user puts a plugin functionality in action Jami tells this handler to attach the available data.
+When deactivated, Jami tells the handler to dettach.
## How to use it?
## Setup
A Jami plugin is a `pluginname.jpl` file, and it must be installed to your Jami.
-Once installed, Jami will add your new plugin to the available plugins list but they will not be ready for use yet. Plugins are libraries and must be loaded if you want to expose them.
-Moreover, plugin may have preferences and besides install/uninstall and load/unload actions, it is possible to modify those preferences. For example, our GreenScreen plugin allows the user to change the background image displayed.
+Once installed, Jami will add your new plugin to the available plugins list but they will not be ready for use yet.
+Plugins are libraries and must be loaded if you want to expose them.
+Moreover, plugin may have preferences and besides install/uninstall and load/unload actions, it is possible to modify those preferences.
+For example, our GreenScreen plugin allows the user to change the background image displayed.
## Android
To setup a plugin for Android you must go under Setting, enable plugins if they are disabled, and select a plugin file from your phone.
@@ -51,4 +62,4 @@ For either Android, Linux or Windows you can do so by clicking on the plugins ic
-Similarly, for chat handler functionality, you will see a plugin icon in the chat window as in the images bellow.
\ No newline at end of file
+Similarly, for chat handler functionality, you will see a plugin icon in the chat window as in the images below.
\ No newline at end of file
diff --git a/jami-extensions/how-to-build.md b/jami-extensions/how-to-build.md
index d871c65fe274655700b7a19b7a31ed28a840ac31..a3095ae2cacee0908822c3e9a4137a5970df2039 100644
--- a/jami-extensions/how-to-build.md
+++ b/jami-extensions/how-to-build.md
@@ -4,7 +4,8 @@ How to build?
**NOTE: this page describes what is a Jami Plugin and how to install and use it.**
-When you create a Jami Plugin, you may need some libraries, as opencv to modify the frame.If everyone uses different versions of libraries, it would not be maintainable.
+When you create a Jami Plugin, you may need some libraries, as OpenCV to modify the frame.
+If everyone uses different versions of libraries, it would not be maintainable.
That's why we included some libraries with fixed versions in the daemon.. You can easily use it in your plugin.
@@ -24,7 +25,7 @@ Other libraries should work as long they and the plugin are correctly built!
We are going to see how to build the most commonly used dependencies in plugins.
ONNX can take a long time so if you don't need it feel free to disable it.
-Examples of dependencies built include: ffmpeg, fmt, msgpack, opencv, opendht, onnx, opus, and freetype.
+Examples of dependencies built include: FFmpeg, fmt, msgpack, OpenCV, OpenDHT, ONNX, opus, and FreeType.
### Update daemon
Before anything, update the submodule `daemon` (from [jami-daemon](https://git.jami.net/savoirfairelinux/jami-daemon)) in `jami-plugins`
@@ -110,17 +111,20 @@ docker run -t --rm \
If you want to build other dependencies, update accordingly build-dependencies.sh
-**NOTE: if onnx makes error on root permissions, add --allow_running_as_root at the end of the build line of your configuration in `daemon/contrib/src/onnx/rules.mak`**
+**NOTE: if an error occurs while running ONNEX with root permissions, add --allow_running_as_root at the end of the build line of your configuration in `daemon/contrib/src/onnx/rules.mak`**
-## Onnxruntime 1.6.0
+## ONNX Runtime 1.6.0
A difficulty for a lot of people working with deep learning models is how to deploy them.
-With that in mind we provide the user the possibility of using onnxruntime.
-There are several development libraries to train and test but, they are usually too heavy to deploy. Tensorflow with cuda support, for instance, can easily surpass 400MB. In our GreenScreen plugin We chose to use onnxruntime because it's lighter (library size of 140Mb for cuda support) and supports model convertion from several development libraries (Tensorflow, PyTorch, Caffe, etc.).
+With that in mind we provide the user the possibility of using the ONNX Runtime.
+There are several development libraries to train and test but, they are usually too heavy to deploy.
+TensorFlow with CUDA support, for instance, can easily surpass 400MB.
+The GreenScreen plugin uses the ONNX Runtime because it's lighter (library size of 140Mb for CUDA support) and supports model conversion from several development libraries (TensorFlow, PyTorch, Caffe, etc.).
-To build onnxruntime based plugins for Linux and Android, we strongly recommend using docker files available under `<plugins>/docker/`. We don't offer Windows docker, but here we carefully guide you through the proper build of this library for our three supported platforms.
+To build ONNX Runtime based plugins for Linux and Android, we strongly recommend using docker files available under `<plugins>/docker/`.
+We don't offer Windows docker, but here we carefully guide you through the proper build of this library for our three supported platforms.
-If you want to build onnxruntime with Nvidia GPU suport, be sure to have a CUDA capable GPU and that you have followed all installation steps for the Nvidia drivers, CUDA Toolkit, CUDNN, and that their versions
+If you want to build ONNX Runtime with Nvidia GPU suport, be sure to have a CUDA capable GPU and that you have followed all installation steps for the Nvidia drivers, CUDA Toolkit, CUDNN, and that their versions
match.
The following links may be very helpful:
@@ -130,8 +134,8 @@ The following links may be very helpful:
* https://developer.nvidia.com/cudnn
### Linux and Android
-We added onnxruntime as a contrib in [daemon](https://git.jami.net/savoirfairelinux/jami-daemon/tree/master/contrib).
-This way you can easily build onnxruntime for Android, and Linux.
+We added ONNX Runtime as a contrib in [daemon](https://git.jami.net/savoirfairelinux/jami-daemon/tree/master/contrib).
+This way you can easily build ONNX Runtime for Android, and Linux.
* Linux - Without acceleration:
@@ -217,7 +221,7 @@ cp ./build/Windows/Release/Release/onnxruntime.dll ../onnxruntime/nvidia-gpu/onn
cp -r ./include/onnxruntime/core/ ../onnxruntime/include/
```
-For further build instructions, please refer to onnxruntime official [GitHub](https://github.com/microsoft/onnxruntime/blob/master/BUILD.md).
+For further build instructions, please visit the official ONNX Runtime instructions at [GitHub](https://github.com/microsoft/onnxruntime/blob/master/BUILD.md).
## Plugin
To exemplify a plugin build, we will use the GreenScreen plugin available [here](https://git.jami.net/savoirfairelinux/jami-plugins).
diff --git a/jami-extensions/tensorflow-plugin.md b/jami-extensions/tensorflow-plugin.md
index 457265c5bcaa41a7e6e847a75c2fef639097a2e3..75484b2c4da28e869419c7b0c8ef37f4f54edf23 100644
--- a/jami-extensions/tensorflow-plugin.md
+++ b/jami-extensions/tensorflow-plugin.md
@@ -1,34 +1,35 @@
-Tensorflow plugin
+TensorFlow plugin
=================
-**NOTE: this page describes to build Tensorflow and TensorflowLite C++ API for Linux Android and Windows.**
+**NOTE: this page describes to build TensorFlow and LiteRT C++ API for Linux, Windows, and Android.
+LiteRT (short for Lite Runtime) is the new name for TensorFlow Lite (TFLite)**
-## Tensorflow 2.1.0
-A difficulty for a lot of people working with tensorflow is how to properly build it.
-With that in mind we created docker images with cuda and tensorflow libraries available for GNU/Linux builds [here](https://hub.docker.com/repository/docker/sflagsantos/tensorflow-cuda) and for Android builds [here](https://hub.docker.com/repository/docker/sflagsantos/tensorflowlite). These docker can be used to build plugins for Linux and Android, however they cannot handle Windows.
-Here we carefully guide you through the proper build of tensorflow LITE Native and Tensorflow C++ API for our three supported platforms.
+## TensorFlow 2.1.0
+A difficulty for a lot of people working with TensorFlow is how to properly build it.
+With that in mind we created docker images with cuda and TensorFlow libraries available for GNU/Linux builds [here](https://hub.docker.com/repository/docker/sflagsantos/tensorflow-cuda) and for Android builds [here](https://hub.docker.com/repository/docker/sflagsantos/tensorflowlite). These docker can be used to build plugins for Linux and Android, however they cannot handle Windows.
+Here we carefully guide you through the proper build of LiteRT Native and TensorFlow C++ API for our three supported platforms.
You will need:
* Python 3
* Bazel 0.29.1
-* Tensorflow 2.1.0 repository:
+* TensorFlow 2.1.0 repository:
```bash
git clone https://github.com/tensorflow/tensorflow.git
cd tensorflow
git checkout v2.1.0
```
-We assembled Tensorflow headers needed to build plugins, to access them you only have to extract `libs.tar.gz` file found under `jami-project/plugins/contrib`. However, if you are using another tensorflow version or you want to do it by yourself, you can follow the assemble instructions for Tensorflow LITE Native and C++ API are available under {gitlab-project}`jami-plugins` README_ASSEMBLE file.
+We assembled TensorFlow headers needed to build plugins, to access them you only have to extract `libs.tar.gz` file found under `jami-project/plugins/contrib`. However, if you are using another tensorflow version or you want to do it by yourself, you can follow the assemble instructions for Tensorflow Lite Native and C++ API are available under {gitlab-project}`jami-plugins` README_ASSEMBLE file.
##### Linux
-Tensorflow LITE does not support desktops GPU. If you want to use them, please consider using C++ API
+LiteRT does not support desktops GPU. If you want to use them, please consider using C++ API
-If you want to build Tensorflow C++ API with GPU suport, be sure to have a CUDA capable GPU and that you have
+If you want to build TensorFlow C++ API with GPU suport, be sure to have a CUDA capable GPU and that you have
followed all installation steps for the Nvidia drivers, CUDA Toolkit, CUDNN, Tensor RT, that their versions
-matches and that they are correct for the Tensorflow version you want to build.
+matches and that they are correct for the TensorFlow version you want to build.
-The following links may be very helpfull:
+The following links may be very helpful:
* https://www.tensorflow.org/install/source
* https://developer.nvidia.com/cuda-gpus
@@ -37,25 +38,25 @@ The following links may be very helpfull:
Setup your build options with `./configure`.
-* Tensorflow LITE Native
+* LiteRT Native
```bash
bazel build //tensorflow/lite:libtensorflowlite.so
```
-* Tensorflow C++ API
+* TensorFlow C++ API
```bash
bazel build --config=v1 --define framework_shared_object=false --define=no_tensorflow_py_deps=true //tensorflow:libtensorflow_cc.so
```
##### Windows
-Tensorflow LITE does not support desktops GPU. If you want to use them, please consider using C++ API
+LiteRT does not support desktops GPU. If you want to use them, please consider using C++ API
-If you want to build Tensorflow C++ API with GPU suport, be sure to have a CUDA capable GPU and that you have
+If you want to build TensorFlow C++ API with GPU suport, be sure to have a CUDA capable GPU and that you have
followed all installation steps for the Nvidia drivers, CUDA Toolkit, CUDNN, Tensor RT, that their versions
-matches and that they are correct for the Tensorflow version you want to build.
+matches and that they are correct for the TensorFlow version you want to build.
-The following links may be very helpfull:
+The following links may be very helpful:
* https://www.tensorflow.org/install/source
* https://developer.nvidia.com/cuda-gpus
@@ -64,20 +65,20 @@ The following links may be very helpfull:
Setup your build options with `python3 configure.py`.
-* Tensorflow LITE Native
+* LiteRT Native
```bash
bazel build //tensorflow/lite:tensorflowlite.dll
```
-* Tensorflow C++ API
+* TensorFlow C++ API
```bash
bazel build --config=v1 --define framework_shared_object=false --config=cuda --define=no_tensorflow_py_deps=true //tensorflow:tensorflow_cc.dll
```
-There may be some missign references while compilling a plugin with Tensorflow C++ API. If that happens you have to rebuild you tensorflow and explicitly export the missing symbols. Fortunatelly Tensorflow now has a easy workaround to do so, you only have to feed [this]("https://github.com/tensorflow/tensorflow/blob/v2.2.0/tensorflow/tools/def_file_filter/def_file_filter.py.tpl") file with the desired symbols.
+There may be some missign references while compilling a plugin with TensorFlow C++ API. If that happens you have to rebuild your TensorFlow and explicitly export the missing symbols. Fortunatelly TensorFlow now has a easy workaround to do so, you only have to feed [this]("https://github.com/tensorflow/tensorflow/blob/v2.2.0/tensorflow/tools/def_file_filter/def_file_filter.py.tpl") file with the desired symbols.
-##### Android - Tensorflow LITE Native
-For mobile applications Tensorflow LITE is the only option you want to consider and to succesfully build it you will also need:
+##### Android - LiteRT Native
+For mobile applications LiteRT is the only option you want to consider and to succesfully build it you will also need:
* Android NDK 18r
diff --git a/user/all-features-by-client.md b/user/all-features-by-client.md
index 378759055b59f3911aba38c1a6b965a2182628eb..eeb08021d6735b2f0860209305085eae02e26f87 100644
--- a/user/all-features-by-client.md
+++ b/user/all-features-by-client.md
@@ -3,118 +3,123 @@ All features by client
Legend:
- - ✓ : available
- - E : experimental
- - X : not yet available
- - N/A : not applicable for this client
+ - ✓ : Available
+ - E : Experimental
+ - X : Not yet available
+ - N/A : Not applicable for this client
+ - ? : Unknown/under development
- Desktop : Apple macOS, GNU/Linux, Microsoft Windows operating systems
+ - iOS : iPad and iPhone devices with iOS operating system
+ - Web : Jami access with a web browser
+
## Text messaging
-| **Client** | Desktop | Android | Android TV | iOS |
-| ---------------------------------- | :-----: | :-----: | :--------: | :-: |
-| Text messaging | ✓ | ✓ | ✓ | ✓ |
-| Group chat | ✓ | ✓ | X | ✓ |
-| Public chat | X | X | X | X |
-| Chat history shared across devices | ✓ | ✓ | ✓ | ✓ |
-| Send files | ✓ | ✓ | X | ✓ |
-| Auto accept images | ✓ | ✓ | ✓ | ✓ |
-| Custom download location | ✓ | X | X | X |
-| Typing indicator | ✓ | ✓ | X | ✓ |
-| Read status | ✓ | ✓ | ✓ | ✓ |
-| Reply to | ✓ | ✓ | X | X |
-| Message edition | ✓ | ✓ | X | X |
-| Emoji reaction | ✓ | ✓ | X | X |
-| Update conversation's profile | ✓ | ✓ | X | ✓ |
-| Add/Kick members | ✓ | ✓ | X | ✓ |
-| Conversation's preferences | ✓ | ✓ | X | ✓ |
-| Search messages | ✓ | ✓ | X | X |
-| Share location | ✓ | ✓ | X | ✓ |
-| Media gallery | ✓ | ✓ | X | X |
+| **Client** | Desktop | Android | Android TV | iOS | Web |
+| ---------------------------------- | :-----: | :-----: | :--------: | :-: | :-: |
+| Text messaging | ✓ | ✓ | ✓ | ✓ | ? |
+| Group chat | ✓ | ✓ | X | ✓ | ? |
+| Public chat | X | X | X | X | ? |
+| Chat history shared across devices | ✓ | ✓ | ✓ | ✓ | ? |
+| Send files | ✓ | ✓ | X | ✓ | ? |
+| Auto accept images | ✓ | ✓ | ✓ | ✓ | ? |
+| Custom download location | ✓ | X | X | X | ? |
+| Typing indicator | ✓ | ✓ | X | ✓ | ? |
+| Read status | ✓ | ✓ | ✓ | ✓ | ? |
+| Reply to | ✓ | ✓ | X | X | ? |
+| Message edition | ✓ | ✓ | X | X | ? |
+| Emoji reaction | ✓ | ✓ | X | X | ? |
+| Update conversation's profile | ✓ | ✓ | X | ✓ | ? |
+| Add/Kick members | ✓ | ✓ | X | ✓ | ? |
+| Conversation's preferences | ✓ | ✓ | X | ✓ | ? |
+| Search messages | ✓ | ✓ | X | X | ? |
+| Share messages | ✓ | ✓(1) | X | X | ? |
+| Share location | ✓ | ✓ | X | ✓ | ? |
+| Media gallery | ✓ | ✓ | X | X | ? |
+
+(1) Sharing messages and media is available on Android through the system-native sharing feature
## Calling
-| **Client** | Desktop | Android | Android TV | iOS |
-| ---------------------------------- | :-----: | :-----: | :--------: | :--: |
-| Audio calling | ✓ | ✓ | ✓ | ✓ |
-| Video calling | ✓ | ✓ | ✓ | ✓ |
-| Call in Swarms | E | ✓ | E | X |
-| Host call conference | ✓ | ✓ | ✓ | ✓ |
-| Auto bitrate | ✓ | ✓ | ✓ | ✓ |
-| Change video quality | ✓ | ✓ | ✓ | X |
-| Custom ringtones | ✓ | ✓ | X | X |
-| Select camera | ✓ | ✓ | X | ✓ |
-| Video call recording | ✓ | X | X | X |
-| Leave audio message | ✓ | ✓ | X | ✓ |
-| Leave video message | ✓ | ✓ | X | ✓ |
-| Screen sharing | ✓(1) | ✓ | X | X |
-| Window sharing | ✓(3) | X | X | X |
-| Media sharing | ✓ | X | X | X |
-| Hardware encoding * | ✓ | ✓ | ✓ | ✓ |
-| Hardware decoding * | ✓ | ✓ | ✓ | ✓ |
-| Mute sound | ✓ | ✓ | X | ✓ |
-| Texting while on call | ✓ | ✓ | X | ✓ |
-| Remote recording notification | ✓ | X | X | ✓ |
-| Rendez-vous mode | ✓ | X | ✓ | X |
-| Conference layout | ✓ | ✓ | X | ✓ |
-| Multistream | ✓ | X | X | X |
-| Push-To-Talk | ✓(1) | X | X | X |
-| Videosplit | ✓ | ✓ | ✓ | X |
-| Audio processor \*\* | ✓ | ✓(2) | ✓(2) | ✓(2) |
-| Voice activity | ✓ | ✓ | ✓ | ✓ |
-
-
-\* This enables 4k video calling support
-\*\* cf. {ref}`user/faq:How can I configure the audio processor?` in
-the FAQ
-
-(1) only on X (not Wayland)
-(2) Some features enabled by default and not configurable
-(3) only on X and not on Microsoft Windows
+| **Client** | Desktop | Android | Android TV | iOS | Web |
+| ---------------------------------- | :-----: | :-----: | :--------: | :--: | :-: |
+| Audio calls | ✓ | ✓ | ✓ | ✓ | ? |
+| Video calls | ✓ | ✓ | ✓ | ✓ | ? |
+| Group calls | E | ✓ | E | X | ? |
+| Host call conference | ✓ | ✓ | ✓ | ✓ | ? |
+| Auto bitrate | ✓ | ✓ | ✓ | ✓ | ? |
+| Change video quality | ✓ | ✓ | ✓ | X | ? |
+| Custom ringtones | ✓ | ✓ | X | X | ? |
+| Select camera | ✓ | ✓ | X | ✓ | ? |
+| Video call recording | ✓ | X | X | X | ? |
+| Leave audio message | ✓ | ✓ | X | ✓ | ? |
+| Leave video message | ✓ | ✓ | X | ✓ | ? |
+| Screen sharing | ✓(1) | ✓ | X | X | ? |
+| Window sharing | ✓(3) | X | X | X | ? |
+| Media sharing | ✓ | X | X | X | ? |
+| Hardware encoding\* | ✓ | ✓ | ✓ | ✓ | ? |
+| Hardware decoding\* | ✓ | ✓ | ✓ | ✓ | ? |
+| Mute sound | ✓ | ✓ | X | ✓ | ? |
+| Texting while on call | ✓ | ✓ | X | ✓ | ? |
+| Remote recording notification | ✓ | X | X | ✓ | ? |
+| Rendez-vous mode | ✓ | X | ✓ | X | ? |
+| Conference layout | ✓ | ✓ | X | ✓ | ? |
+| Multistream | ✓ | X | X | X | ? |
+| Push-to-talk | ✓(1) | X | X | X | ? |
+| Videosplit | ✓ | ✓ | ✓ | ✓ | ? |
+| Audio processor\*\* | ✓ | ✓(2) | ✓(2) | ✓(2)| ? |
+| Voice activity | ✓ | ✓ | ✓ | ✓ | ? |
+
+\* This enables 4K video calling support<br>
+\*\* cf. {ref}`user/faq:How can I configure the audio processor?` in the FAQ
+
+(1) Available on both X and Wayland<br>
+(2) Some features enabled by default and not configurable<br>
+(3) Only on X and not on Microsoft Windows
## Account settings
-| **Client** | Desktop | Android | Android TV | iOS |
-| --------------------------- | :-----: | :-----: | :--------: | :-: |
-| Profile picture | ✓ | ✓ | ✓ | ✓ |
-| Disable account | ✓ | ✓ | X | ✓ |
-| Delete account | ✓ | ✓ | X | ✓ |
-| Contact availability | ✓ | ✓ | ✓ | ✓ |
-| Register username | ✓ | ✓ | ✓ | ✓ |
-| Delete contacts | ✓ | ✓ | ✓ | ✓ |
-| Block contacts | ✓ | ✓ | X | ✓ |
-| Link new device via DHT | ✓ | ✓ | ✓ | ✓ |
-| Link new device via archive | ✓ | ✓ | X | X |
-| Auto answer | ✓ | ✓ | ✓ | X |
-| Custom ringtones | ✓ | ✓ | X | X |
+| **Client** | Desktop | Android | Android TV | iOS | Web |
+| --------------------------- | :-----: | :-----: | :--------: | :-: | :-: |
+| Profile picture | ✓ | ✓ | ✓ | ✓ | ? |
+| Disable account | ✓ | ✓ | X | ✓ | ? |
+| Delete account | ✓ | ✓ | X | ✓ | ? |
+| Contact availability | ✓ | ✓ | ✓ | ✓ | ? |
+| Register username | ✓ | ✓ | ✓ | ✓ | ? |
+| Delete contacts | ✓ | ✓ | ✓ | ✓ | ? |
+| Block contacts | ✓ | ✓ | X | ✓ | ? |
+| Link new device via DHT | ✓ | ✓ | ✓ | ✓ | ? |
+| Link new device via archive | ✓ | ✓ | X | X | ? |
+| Auto answer | ✓ | ✓ | ✓ | X | ? |
+| Custom ringtones | ✓ | ✓ | X | X | ? |
## Other features
-| **Client** | Desktop | Android | Android TV | iOS |
-| ------------------------------ | :-----: | :-----: | :--------: | :-: |
-| Scan QR code | X | ✓ | X | ✓ |
-| Display QR code | ✓ | ✓ | ✓ | ✓ |
-| Block contact | ✓ | ✓ | X | ✓ |
-| System notifications | ✓ | ✓ | ✓ | ✓ |
-| Supported languages * | 98 | 98 | 98 | 98 |
-| Contacts shared across devices | ✓ | ✓ | ✓ | ✓ |
-| Multi account | ✓ | ✓ | X | ✓ |
-| SIP account | ✓ | ✓ | X | ✓ |
-| SIP transferring | X | X | X | X |
-| Dark theme support | ✓ | ✓ | ✓ | ✓ |
-| JAMS\*\* support | ✓ | ✓ | X | ✓ |
-| Plugin support | ✓ | ✓ | ✓ | X |
-| Plugin store | ✓ | X | X | X |
-| Application translation | ✓ | X | X | X |
-| White Labelling | ✓ | ✓ | X | X |
-
-\* According to <https://explore.transifex.com/savoirfairelinux/jami/>
+| **Client** | Desktop | Android | Android TV | iOS | Web |
+| ------------------------------ | :-----: | :-----: | :--------: | :-: | :-: |
+| Scan QR code | X | ✓ | X | ✓ | ? |
+| Display QR code | ✓ | ✓ | ✓ | ✓ | ? |
+| Block contact | ✓ | ✓ | X | ✓ | ? |
+| System notifications | ✓ | ✓ | ✓ | ✓ | ? |
+| Supported languages | 105\* | 105\* | 105\* | 105\*| 2 |
+| Contacts shared across devices | ✓ | ✓ | ✓ | ✓ | ? |
+| Multi account | ✓ | ✓ | X | ✓ | ? |
+| SIP account | ✓ | ✓ | X | ✓ | ? |
+| SIP transferring | X | X | X | X | ? |
+| Dark theme support | ✓ | ✓ | ✓ | ✓ | ? |
+| JAMS\*\* support | ✓ | ✓ | ✓ | ✓ | ? |
+| Plugin support | ✓ | ✓ | ✓ | X | ? |
+| Plugin store | ✓ | X | X | X | ? |
+| Application translation | ✓ | ✓ | ✓ | ✓ | ? |
+| White labeling | ✓ | ✓ | X | X | ? |
+
+\* According to <https://explore.transifex.com/savoirfairelinux/jami/><br>
\*\* JAMS (Jami Account Management Server) <https://jami.biz/>
## Advanced settings
-| **Client** | Desktop | Android | Android TV | iOS |
-| ------------------ | :-----: | :-----: | :--------: | :-: |
-| DHT proxy support | ✓ | ✓ | X | ✓ |
-| Push notification | N/A | ✓ | N/A | ✓ |
-| UPnP | ✓ | ✓ | ✓ | X |
-| TURN configuration | ✓ | ✓ | ✓ | ✓ |
+| **Client** | Desktop | Android | Android TV | iOS | Web |
+| ------------------ | :-----: | :-----: | :--------: | :-: | :-: |
+| DHT proxy support | ✓ | ✓ | X | ✓ | ? |
+| Push notification | N/A | ✓ | N/A | ✓ | ? |
+| UPnP | ✓ | ✓ | ✓ | X | ? |
+| TURN configuration | ✓ | ✓ | ✓ | ✓ | ? |
diff --git a/user/faq.rst b/user/faq.rst
index 4ea5ed904cff815d5f5bb7092f9cebcbb2adc023..68cc80c2b26baf96f2404c059fe152eaf377bdf9 100644
--- a/user/faq.rst
+++ b/user/faq.rst
@@ -205,11 +205,11 @@ Jami also uses an algorithm to change the consumption depending of the
quality of the link. So, the bitrate can have a minimum of 200 Kbit/s
and maximum of 6 Mbit/s.
-How can Savoir-Faire Linux (SFL) afford to give Jami away for free? How does SFL make money with Jami?
+How can Savoir-Faire Linux Inc. (SFL) afford to give Jami away for free? How does SFL make money with Jami?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-`Savoir-Faire Linux <https://savoirfairelinux.com/>`_ (SFL) is a consulting company with some R&D projects.
-Jami is a GPLv3+ project and this will not change. Savoir-Faire Linux already sells services
+`Savoir-Faire Linux Inc. <https://savoirfairelinux.com/>`_ (SFL) is a consulting company with some R&D projects.
+Jami is a GPLv3+ project and this will not change. SFL already sells services
for several fields of expertise (hosting, developing websites and applications, embedded
software, etc). Jami is financed several ways:
diff --git a/user/introduction.rst b/user/introduction.rst
index 9d60aed60087914ee86d99933a2de04140a2d742..2c1031c2354b4c4a28dd5ec02992ec02c4917e01 100644
--- a/user/introduction.rst
+++ b/user/introduction.rst
@@ -40,7 +40,7 @@ in-depth information.
Who makes Jami?
---------------
-The Jami project is led by `Savoir-faire Linux
+The Jami project is led by `Savoir-faire Linux Inc.
<https://www.savoirfairelinux.com/en/>`_ -- a Canadian/Québécois
GNU/Linux consulting company -- and is supported by a global community
of free software enthusiasts, users, and contributors.
diff --git a/user/jami-distributed-network.md b/user/jami-distributed-network.md
index 802cf2a5e8b7958dffde836797e9135ed205ede0..2b6b8a81fc88639cc875d0c85bb261500705476e 100644
--- a/user/jami-distributed-network.md
+++ b/user/jami-distributed-network.md
@@ -84,8 +84,8 @@ Jami clients to various more or less centralized user directories.
### Contribute to the JamiNS blockchain
-The default Jami name service is ns.jami.net, provided by Savoir-faire
-Linux, connected to an Ethereum blockchain node; the goal being to give
+The default Jami name service is ns.jami.net, provided by Savoir-faire Linux Inc.,
+connected to an Ethereum blockchain node; the goal being to give
everyone the possibility (if they which so) to run their own blockchain
node and HTTP service, mine some Ether, and use it to pay the
transaction fee needed to register their username in Jami.