summaryrefslogtreecommitdiff
path: root/protocol/ivi-controller.xml
blob: de8a74d5e7fa6263c16540dd5273c4e99dad2c4b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="ivi_controller">

    <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_controller_surface" version="1">
        <description summary="Request property change of ivi_surface to server"/>

        <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="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>

        <event name="layer">
            <description summary="Receive a ivi_layer this ivi_surface belongs"/>
            <arg name="layer" type="object" interface="ivi_controller_layer" allow-null="true"/>
        </event>

        <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>

        <request name="destroy" type="destructor">
            <description summary="destroy ivi_controller_surface"/>
        </request>

        <event name="destroyed">
            <description summary="destroyed surface 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="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_controller_surface"/>
        </request>

        <request name="remove_surface">
            <description summary="remove a ivi_surface from a layer"/>
            <arg name="surface" type="object" interface="ivi_controller_surface"/>
        </request>

        <request name="set_render_order">
            <description summary="Set Render Order"/>
            <arg name="id_surfaces" type="array"/>
        </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="screen">
            <description summary="Receive a wl_output this ivi_layer belongs"/>
            <arg name="screen" type="object" interface="wl_output" allow-null="true"/>
        </event>

        <request name="destroy" type="destructor">
            <description summary="destroy ivi_controller_layer"/>
        </request>

        <event name="destroyed">
            <description summary="destroyed layer 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_controller_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 additional screen controller"/>
            <arg name="id_screen" type="uint"/>
            <arg name="screen" type="new_id" interface="ivi_controller_screen"/>
        </event>

        <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_controller_layer"/>
        </request>

        <event name="layer">
            <description summary="Receive id_layer and a layer controller"/>
            <arg name="id_layer" type="uint"/>
            <arg name="controller_layer" type="new_id" interface="ivi_controller_layer"/>
        </event>

        <request name="surface_create">
            <description summary="create surface controller"/>
            <arg name="id_surface" type="uint"/>
            <arg name="id" type="new_id" interface="ivi_controller_surface"/>
        </request>

        <event name="surface">
            <description summary="Receive id_surface and a controller to control ivi_surface"/>
            <arg name="id_surface" type="uint"/>
            <arg name="controller_surface" type="new_id" interface="ivi_controller_surface"/>
        </event>

    </interface>

</protocol>