[PATCH weston 2/6] ivi-shell: definision of ivi-shell protocol
Nobuhiko Tanibata
NOBUHIKO_TANIBATA at xddp.denso.co.jp
Tue Sep 3 18:06:45 PDT 2013
This protocol is designed based on use cases of In-Vehicle Infotainment,
especially for layer management.
Signed-off-by: Nobuhiko Tanibata <NOBUHIKO_TANIBATA at xddp.denso.co.jp>
---
protocol/ivi-shell.xml | 452 ++++++++++++++++++++++++++++++++++++++++++++++++
1 files changed, 452 insertions(+), 0 deletions(-)
create mode 100644 protocol/ivi-shell.xml
diff --git a/protocol/ivi-shell.xml b/protocol/ivi-shell.xml
new file mode 100644
index 0000000..936cadf
--- /dev/null
+++ b/protocol/ivi-shell.xml
@@ -0,0 +1,452 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<protocol name="ivi_shell">
+
+ <copyright>
+ Copyright (C) 2013 DENSO CORPORATION
+ Copyright (c) 2013 BMW Car IT GmbH
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+ </copyright>
+
+ <interface name="ivi_surface" version="1">
+ <description summary="Tell property change of ivi_surface to client"/>
+
+ <request name="destroy" type="destructor">
+ <description summary="destroy ivi_surface"/>
+ </request>
+
+ <event name="visibility">
+ <description summary="sent in response to set_visibility"/>
+ <arg name="visibility" type="int"/>
+ </event>
+
+ <event name="opacity">
+ <description summary="sent in response to set_opacity"/>
+ <arg name="opacity" type="fixed"/>
+ </event>
+
+ <event name="source_rectangle">
+ <description summary="sent in response to set_source_rectangle"/>
+ <arg name="x" type="int"/>
+ <arg name="y" type="int"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
+ </event>
+
+ <event name="destination_rectangle">
+ <description summary="sent in response to set_destination_rectangle"/>
+ <arg name="x" type="int"/>
+ <arg name="y" type="int"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
+ </event>
+
+ <event name="dimension">
+ <description summary="sent in response to set_dimension"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
+ </event>
+
+ <event name="position">
+ <description summary="sent in response to set_position"/>
+ <arg name="x" type="int"/>
+ <arg name="y" type="int"/>
+ </event>
+
+ <enum name="orientation">
+ <description summary="orientation presets in degrees"/>
+ <entry name="0_degrees" value="0"
+ summary="not rotated"/>
+ <entry name="90_degrees" value="1"
+ summary="rotated 90 degrees clockwise"/>
+ <entry name="180_degrees" value="2"
+ summary="rotated 180 degrees clockwise"/>
+ <entry name="270_degrees" value="3"
+ summary="rotated 270 degrees clockwise"/>
+ </enum>
+
+ <event name="orientation">
+ <description summary="sent in response to set_orientation"/>
+ <arg name="orientation" type="int"/>
+ </event>
+
+ <enum name="pixelformat">
+ <description summary="pixel format values"/>
+ <entry name="r_8" value="0"
+ summary="8 bit luminance surface"/>
+ <entry name="rgb_888" value="1"
+ summary="24 bit rgb surface"/>
+ <entry name="rgba_8888" value="2"
+ summary="24 bit rgb surface with 8 bit alpha"/>
+ <entry name="rgb_565" value="3"
+ summary="16 bit rgb surface"/>
+ <entry name="rgba_5551" value="4"
+ summary="16 bit rgb surface with binary mask"/>
+ <entry name="rgba_6661" value="5"
+ summary="18 bit rgb surface with binary mask"/>
+ <entry name="rgba_4444" value="6"
+ summary="12 bit rgb surface with 4 bit alpha"/>
+ <entry name="unknown" value="7"
+ summary="unknown"/>
+ </enum>
+
+ <event name="pixelformat">
+ <description summary="pixelformat"/>
+ <arg name="pixelformat" type="int"/>
+ </event>
+
+ <request name="set_native">
+ <description summary="Set the native content of an application to be used as surface content"/>
+ <arg name="id_native" type="uint"/>
+ </request>
+
+ <request name="send_stats"/>
+
+ <event name="stats">
+ <description summary="sent in response to send_stats"/>
+ <arg name="redraw_count" type="uint"/>
+ <arg name="frame_count" type="uint"/>
+ <arg name="update_count" type="uint"/>
+ <arg name="pid" type="uint"/>
+ </event>
+
+ <event name="destroyed">
+ <description summary="destroyed event"/>
+ </event>
+
+ </interface>
+
+ <interface name="ivi_layer" version="1">
+ <description summary="Tell property change of ivi_layer to client"/>
+
+ <request name="destroy" type="destructor">
+ <description summary="destroy ivi_layer"/>
+ </request>
+
+ <event name="visibility">
+ <description summary="sent in response to set_visibility"/>
+ <arg name="visibility" type="int"/>
+ </event>
+
+ <event name="opacity">
+ <description summary="sent in response to set_opacity"/>
+ <arg name="opacity" type="fixed"/>
+ </event>
+
+ <event name="source_rectangle">
+ <description summary="sent in response to set_source_rectangle"/>
+ <arg name="x" type="int"/>
+ <arg name="y" type="int"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
+ </event>
+
+ <event name="destination_rectangle">
+ <description summary="sent in response to set_destination_rectangle"/>
+ <arg name="x" type="int"/>
+ <arg name="y" type="int"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
+ </event>
+
+ <event name="dimension">
+ <description summary="sent in response to set_dimension"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
+ </event>
+
+ <event name="position">
+ <description summary="sent in response to set_position"/>
+ <arg name="x" type="int"/>
+ <arg name="y" type="int"/>
+ </event>
+
+ <event name="orientation">
+ <description summary="sent in response to set_orientation"/>
+ <arg name="orientation" type="int"/>
+ </event>
+
+ <event name="destroyed">
+ <description summary="destroyed event"/>
+ </event>
+
+ </interface>
+
+ <interface name="ivi_controller_surface" version="1">
+ <description summary="Request property change of ivi_surface to server"/>
+
+ <request name="destroy" type="destructor">
+ <description summary="destroy ivi_controller_surface"/>
+ </request>
+
+ <request name="set_visibility">
+ <description summary="Set Visibility"/>
+ <arg name="visibility" type="uint"/>
+ </request>
+
+ <request name="set_opacity">
+ <description summary="Set Opacity"/>
+ <arg name="opacity" type="fixed"/>
+ </request>
+
+ <request name="set_source_rectangle">
+ <description summary="Set the area of wl_surface which should be used for the rendering">
+ x: horizontal start position of the used area
+ y: vertical start position of the used area
+ width : width of the area
+ height: height of the area
+ </description>
+ <arg name="x" type="int"/>
+ <arg name="y" type="int"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
+ </request>
+
+ <request name="set_destination_rectangle">
+ <description summary="Set the destination area of a surface within a layer for rendering">
+ Set the destination area of a wl_surface within a layer for rendering. The surface will be scaled to this rectangle for rendering.
+ x: horizontal start position of the used area
+ y: vertical start position of the used area
+ width : width of the area
+ height: height of the area
+ </description>
+ <arg name="x" type="int"/>
+ <arg name="y" type="int"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
+ </request>
+
+ <request name="set_dimension">
+ <description summary="Set Dimension"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
+ </request>
+
+ <request name="set_position">
+ <description summary="Set Position"/>
+ <arg name="x" type="int"/>
+ <arg name="y" type="int"/>
+ </request>
+
+ <request name="set_orientation">
+ <description summary="Set Orientation"/>
+ <arg name="orientation" type="int"/>
+ </request>
+
+ <request name="screenshot">
+ <description summary="Take screenshot"/>
+ <arg name="filename" type="string"/>
+ </request>
+
+ <event name="layer">
+ <description summary="Receive a ivi_layer this ivi_surface belongs"/>
+ <arg name="layer" type="object" interface="ivi_layer" allow-null="true"/>
+ </event>
+
+ <event name="destroyed">
+ <description summary="destroyed event"/>
+ </event>
+
+ </interface>
+
+ <interface name="ivi_controller_layer" version="1">
+ <description summary="Request property change of ivi_layer and add/remove ivi_surface from ivi_layer to server"/>
+
+ <request name="destroy" type="destructor">
+ <description summary="destroy ivi_controller_layer"/>
+ </request>
+
+ <request name="set_visibility">
+ <description summary="Set Visibility"/>
+ <arg name="visibility" type="uint"/>
+ </request>
+
+ <request name="set_opacity">
+ <description summary="Set Opacity"/>
+ <arg name="opacity" type="fixed"/>
+ </request>
+
+ <request name="set_source_rectangle">
+ <description summary="Set the area of layer which should be used for the rendering">
+ x: horizontal start position of the used area
+ y: vertical start position of the used area
+ width : width of the area
+ height: height of the area
+ </description>
+ <arg name="x" type="int"/>
+ <arg name="y" type="int"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
+ </request>
+
+ <request name="set_destination_rectangle">
+ <description summary="Set the destination area on the display for a layer">
+ Set the destination area on the display for a layer. The layer will be scaled and positioned to this rectangle for rendering
+ x: horizontal start position of the used area
+ y: vertical start position of the used area
+ width : width of the area
+ height: height of the area
+ </description>
+ <arg name="x" type="int"/>
+ <arg name="y" type="int"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
+ </request>
+
+ <request name="set_dimension">
+ <description summary="Set Dimension"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
+ </request>
+
+ <request name="set_position">
+ <description summary="Set Position"/>
+ <arg name="x" type="int"/>
+ <arg name="y" type="int"/>
+ </request>
+
+ <request name="set_orientation">
+ <description summary="Set Orientation"/>
+ <arg name="orientation" type="int"/>
+ </request>
+
+ <request name="screenshot">
+ <description summary="Take screenshot"/>
+ <arg name="filename" type="string"/>
+ </request>
+
+ <request name="clear_surfaces">
+ <description summary="remove all ivi_surfaces from a layer"/>
+ </request>
+
+ <request name="add_surface">
+ <description summary="add a ivi_surface to top order of a ivi_layer"/>
+ <arg name="surface" type="object" interface="ivi_surface"/>
+ </request>
+
+ <request name="remove_surface">
+ <description summary="remove a ivi_surface from a layer"/>
+ <arg name="surface" type="object" interface="ivi_surface"/>
+ </request>
+
+ <request name="set_render_order">
+ <description summary="Set Render Order"/>
+ <arg name="id_surfaces" type="array"/>
+ </request>
+
+ <event name="screen">
+ <description summary="Receive a wl_output this ivi_layer belongs"/>
+ <arg name="screen" type="object" interface="wl_output" allow-null="true"/>
+ </event>
+
+ <event name="destroyed">
+ <description summary="destroyed event"/>
+ </event>
+
+ </interface>
+
+ <interface name="ivi_controller_screen" version="1">
+ <description summary="Request add/remove layer from ivi_layer to server"/>
+
+ <request name="destroy" type="destructor">
+ <description summary="destroy ivi_controller_screen"/>
+ </request>
+
+ <request name="clear">
+ <description summary="remove all ivi_layers from wl_output"/>
+ </request>
+
+ <request name="add_layer">
+ <description summary="add a ivi_layer to top order of a wl_output"/>
+ <arg name="layer" type="object" interface="ivi_layer"/>
+ </request>
+
+ <request name="screenshot">
+ <description summary="Take screenshot"/>
+ <arg name="filename" type="string"/>
+ </request>
+
+ <request name="set_render_order">
+ <description summary="Set Render Order"/>
+ <arg name="id_layers" type="array"/>
+ </request>
+
+ </interface>
+
+ <interface name="ivi_controller" version="1">
+ <description summary="Interface for central controller of layers and surfaces"/>
+
+ <request name="commit_changes">
+ <description summary="commit changes and request done by client"/>
+ </request>
+
+ <event name="screen">
+ <description summary="Receive new addtional screen"/>
+ <arg name="id_screen" type="uint"/>
+ <arg name="screen" type="new_id" interface="ivi_controller_screen"/>
+ </event>
+
+ <event name="layer">
+ <description summary="Receive id_layer/ivi_layer and a controller to control ivi_layer"/>
+ <arg name="id_layer" type="uint"/>
+ <arg name="layer" type="new_id" interface="ivi_layer"/>
+ <arg name="controller" type="new_id" interface="ivi_controller_layer"/>
+ </event>
+
+ <event name="surface">
+ <description summary="Receive id_surface/ivi_surface and a controller to control ivi_surface"/>
+ <arg name="id_surface" type="uint"/>
+ <arg name="surface" type="new_id" interface="ivi_surface"/>
+ <arg name="controller_surface" type="new_id" interface="ivi_controller_surface"/>
+ </event>
+
+ <event name="nativesurface">
+ <description summary="Receive wl_surface and properties to control pure wl_shell_surface"/>
+ <arg name="id_native" type="uint"/>
+ <arg name="pid" type="uint"/>
+ <arg name="title" type="string"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
+ </event>
+
+ </interface>
+
+ <interface name="ivi_client" version="1">
+ <description summary="creation of ivi_surface/ivi_layer"/>
+
+ <request name="surface_create">
+ <description summary="ilm_surfaceCreate"/>
+ <arg name="id_surface" type="uint"/>
+ <arg name="id_native" type="uint"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
+ <arg name="id" type="new_id" interface="ivi_surface"/>
+ </request>
+
+ <request name="layer_create">
+ <description summary="ilm_layerCreateWithDimension"/>
+ <arg name="id_layer" type="uint"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
+ <arg name="id" type="new_id" interface="ivi_layer"/>
+ </request>
+
+ </interface>
+
+</protocol>
--
1.7.4.4
More information about the wayland-devel
mailing list