aboutsummaryrefslogtreecommitdiffstats
path: root/docs/06_Component_Documentation/03_waltham_receiver_transmitter.md
diff options
context:
space:
mode:
authorVinod Ahuja <vahuja@unomaha.edu>2023-05-10 14:52:27 -0500
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2023-05-30 11:18:04 +0000
commit0d734156c785babe064ff32748ed01826a0a85fd (patch)
tree9f23a42ebe5d35c3a74fb2df17c0cfc86b2e7f31 /docs/06_Component_Documentation/03_waltham_receiver_transmitter.md
parenta7be1051df95f85eae2a6aedc8631221d48545eb (diff)
Removing Waltham page as dicussed in community meeting. Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: Ibc28380500ba7454ac695894fd9a5f084f04f359 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28872 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Diffstat (limited to 'docs/06_Component_Documentation/03_waltham_receiver_transmitter.md')
-rw-r--r--docs/06_Component_Documentation/03_waltham_receiver_transmitter.md96
1 files changed, 0 insertions, 96 deletions
diff --git a/docs/06_Component_Documentation/03_waltham_receiver_transmitter.md b/docs/06_Component_Documentation/03_waltham_receiver_transmitter.md
deleted file mode 100644
index 8397f0e..0000000
--- a/docs/06_Component_Documentation/03_waltham_receiver_transmitter.md
+++ /dev/null
@@ -1,96 +0,0 @@
----
-title: Waltham receiver/transmitter
----
-
-# Waltham
-
-[Waltham protocol](https://github.com/waltham/waltham) is a IPC library similar
-to [Wayland](https://wayland.freedesktop.org), developed with networking in
-mind. It operates over TCP sockets, while the wayland protocol only works
-locally over a UNIX socket. It retains wayland-esque paradigm, making use of
-XMLs to describe the protocol, and it follows an object-oriented design with an
-asynchronous architecture.
-
-## Differences from Wayland to Waltham
-
-Some of the differences between Wayland and Waltham are:
-
-* Waltham uses TCP sockets for communication
-* Waltham cannot send file descriptors
-* Waltham API is minimal and symmetric between server and client sides
-* Waltham does not provide an event loop implementation
-* The registry implementation is left out of the library, only the interface is
- provided
-* No multi-threading support for sharing objects between threads
-
-## Waltham-transmitter and remoting plugin
-
-Surface sharing is not part of Waltham protocol, each system needs to implement
-the most efficient way of passing by the buffers from one side to another. On
-AGL, make use of remoting-plugin to enable surface sharing which uses GStreamer
-as encoder/decoder. It uses libweston DRM virtual API to grab the buffers, and
-then to stream them over the network. The gstreamer pipeline uses UDP while the
-input events are communicated with Waltham protocol. The input part is handled
-by *waltham-transmitter* plugin which provides an API to create remote
-connections and push surfaces over the network and handles remote input. The
-act of pushing surface is a misnomer, kept from the older, previous
-implementation, and acts a notification mechanism from the transmitter side to
-the remote side.
-
-## The receiver client
-
-waltham-receiver application is a wayland demo implementation which should be
-running at the remote side. It is using Waltham protocol to obtain and process
-remote input events which handled the transmitter side by the waltham-transmitter
-plugin. It creates a similar gstreamer pipeline to process the incoming buffers
-and draw and displaying them into a subsurface created by waylandsink.
-
-Contrary to expectations, the waltham receiver is the one that implements the
-server side of the Waltham protocol and is capable of displaying the incoming
-buffers but also process input events locally and forward them with the help of
-the Waltham protocol back at the transmitter side, which in turn will update
-the image contents and stream to the receiver, showing the changes caused by
-that input.
-
-
- ECU 1 ECU 2
- +---------------------------------------------+ +--------------------------------------+
- | +-----------------+ | | |
- | | Application | | | +-----------+-----------+ |
- | +-----------------+ | | | Gstreamer | | |
- | ^ | Buffer ---------------> (Decode) | | |
- | wayland | +-------------------/ | +-----------+ | |
- | v | | (Ethernet) | | Waltham-receiver | |
- | +----+---------------------+ | | --------------------> | |
- | | | Transmitter plugin |<---------------------/ | +-----------------------+ |
- | | | | | | Waltham-Protocol | ^ |
- | | |---------------------| | | | wayland | |
- | | | Remoting plugin |-------+ | | v |
- | | | | | | +---------------------+ |
- | | +---------------------+ | | | | |
- | | | | | | compositor | |
- | | compositor | | | | | |
- | +------+-------------------+ | | +----------------+----+ |
- | | | | | |
- | v | | v |
- | +------------+ | | +----------+ |
- | | Display | | | | Display | |
- | | | | | | | |
- | +------------+ | | +----------+ |
- +---------------------------------------------+ +--------------------------------------+
-
-## Migrating/Placing applications on other outputs
-
-In order to start or place an application on the remoting-ouput output, we can
-use `agl-shell-app-id` ini entry for that particular output.
-
- [transmitter-output]
- name=transmitter-1
- mode=640x720@30
- host=192.168.20.99
- port=5005
- agl-shell-app-id=<APP_ID>
-
-Alternatively, and programmatically, one can use the
-[agl-shell-desktop](../02_agl_compositor#private-extensions) protocol and inform
-the compositor that it should migrate it to other, remote outputs.