1<?xml version="1.0" encoding="utf-8"?>
2<!--
3Copyright (C) 2006 Jeremy Kolb.
4All Rights Reserved.
5
6Permission is hereby granted, free of charge, to any person obtaining a copy
7of this software and associated documentation files (the "Software"), to deal
8in the Software without restriction, including without limitation the rights
9to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10copies of the Software, and to permit persons to whom the Software is
11furnished to do so, subject to the following conditions:
12
13The above copyright notice and this permission notice shall be included in all
14copies or substantial portions of the Software.
15
16THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
20ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22
23Except as contained in this notice, the names of the authors or their
24institutions shall not be used in advertising or otherwise to promote the
25sale, use or other dealings in this Software without prior written
26authorization from the authors.
27-->
28
29<xcb header="xv" extension-xname="XVideo" extension-name="Xv" major-version="2" minor-version="2">
30    <import>xproto</import>
31    <import>shm</import>
32    <!-- Implements version 2.2 of XV -->
33
34    <!-- XIDs -->
35    <xidtype name="PORT" />
36    <xidtype name="ENCODING" />
37
38    <enum name="Type">
39        <item name="InputMask"><bit>0</bit></item>
40        <item name="OutputMask"><bit>1</bit></item>
41        <item name="VideoMask"><bit>2</bit></item>
42        <item name="StillMask"><bit>3</bit></item>
43        <item name="ImageMask"><bit>4</bit></item>
44    </enum>
45
46    <enum name="ImageFormatInfoType">
47        <item name="RGB"> <value>0</value> </item>
48        <item name="YUV"> <value>1</value> </item>
49    </enum>
50
51    <enum name="ImageFormatInfoFormat">
52        <item name="Packed"> <value>0</value> </item>
53        <item name="Planar"> <value>1</value> </item>
54    </enum>
55
56    <enum name="AttributeFlag">
57        <item name="Gettable"><bit>0</bit></item>
58        <item name="Settable"><bit>1</bit></item>
59    </enum>
60    
61    <enum name="VideoNotifyReason">
62	<item name="Started">   <value>0</value> </item>
63	<item name="Stopped">   <value>1</value> </item>
64	<item name="Busy">      <value>2</value> </item>
65	<item name="Preempted"> <value>3</value> </item>
66	<item name="HardError"> <value>4</value> </item>
67    </enum>
68
69    <enum name="ScanlineOrder">
70        <item name="TopToBottom"> <value>0</value> </item>
71        <item name="BottomToTop"> <value>1</value> </item>
72    </enum>
73
74    <enum name="GrabPortStatus">
75        <item name="Success">        <value>0</value> </item>
76        <item name="BadExtension">   <value>1</value> </item>
77        <item name="AlreadyGrabbed"> <value>2</value> </item>
78        <item name="InvalidTime">    <value>3</value> </item>
79        <item name="BadReply">       <value>4</value> </item>
80        <item name="BadAlloc">       <value>5</value> </item>
81    </enum>
82
83    <struct name="Rational">
84        <field type="INT32" name="numerator" />
85        <field type="INT32" name="denominator" />
86    </struct>
87
88    <struct name="Format">
89        <field type="VISUALID" name="visual" />
90        <field type="CARD8" name="depth" />
91        <pad bytes="3" />
92    </struct>
93
94    <struct name="AdaptorInfo">
95        <field type="PORT" name="base_id" />
96        <field type="CARD16" name="name_size" />
97        <field type="CARD16" name="num_ports" />
98        <field type="CARD16" name="num_formats" />
99        <field type="CARD8" name="type" mask="Type" />
100        <pad bytes="1" />
101        <list type="char" name="name">
102            <fieldref>name_size</fieldref>
103        </list>
104        <pad align="4" />
105        <list type="Format" name="formats">
106            <fieldref>num_formats</fieldref>
107        </list>
108
109    </struct>
110
111    <struct name="EncodingInfo">
112        <field type="ENCODING" name="encoding" />
113        <field type="CARD16" name="name_size" />
114        <field type="CARD16" name="width" />
115        <field type="CARD16" name="height" />
116        <pad bytes="2" />
117        <field type="Rational" name="rate" />
118        <list type="char" name="name">
119            <fieldref>name_size</fieldref>
120        </list>
121        <pad align="4" />
122    </struct>
123
124    <struct name="Image">
125        <field type="CARD32" name="id" />
126        <field type="CARD16" name="width" />
127        <field type="CARD16" name="height" />
128        <field type="CARD32" name="data_size" />
129        <field type="CARD32" name="num_planes" />
130        <list type="CARD32" name="pitches">
131            <fieldref>num_planes</fieldref>
132        </list>
133        <list type="CARD32" name="offsets">
134            <fieldref>num_planes</fieldref>
135        </list>
136        <list type="CARD8" name="data">
137            <fieldref>data_size</fieldref>
138        </list>
139        <!-- Some XPointer "obdata" for SHM use-->
140    </struct>
141    
142    <struct name="AttributeInfo">
143        <field type="CARD32" name="flags" mask="AttributeFlag" />
144        <field type="INT32" name="min" />
145        <field type="INT32" name="max" />
146        <field type="CARD32" name="size" />
147        <list type="char" name="name">
148            <fieldref>size</fieldref>
149        </list>
150        <pad align="4" />
151    </struct>
152
153    <struct name="ImageFormatInfo">
154        <field type="CARD32" name="id" />
155        <field type="CARD8" name="type" enum="ImageFormatInfoType" />
156        <field type="CARD8" name="byte_order" enum="ImageOrder" />
157        <pad bytes="2" />
158        <list type="CARD8" name="guid">
159            <value>16</value>
160        </list>
161        <field type="CARD8" name="bpp" />
162        <field type="CARD8" name="num_planes" />
163        <pad bytes="2" />
164        <field type="CARD8" name="depth" />
165        <pad bytes="3" />
166        <field type="CARD32" name="red_mask" />
167        <field type="CARD32" name="green_mask" />
168        <field type="CARD32" name="blue_mask" />
169        <field type="CARD8" name="format" enum="ImageFormatInfoFormat" />
170        <pad bytes="3" />
171        <field type="CARD32" name="y_sample_bits" />
172        <field type="CARD32" name="u_sample_bits" />
173        <field type="CARD32" name="v_sample_bits" />
174        <field type="CARD32" name="vhorz_y_period" />
175        <field type="CARD32" name="vhorz_u_period" />
176        <field type="CARD32" name="vhorz_v_period" />
177        <field type="CARD32" name="vvert_y_period" />
178        <field type="CARD32" name="vvert_u_period" />
179        <field type="CARD32" name="vvert_v_period" />
180        <list type="CARD8" name="vcomp_order">
181            <value>32</value>
182        </list>
183        <field type="CARD8" name="vscanline_order" enum="ScanlineOrder" />
184        <pad bytes="11" />
185    </struct>
186
187
188    <!-- Errors -->
189    <error name="BadPort" number="0"/>
190    <error name="BadEncoding" number="1"/>
191    <error name="BadControl" number="2"/>
192
193    <!-- Events -->
194    <event name="VideoNotify" number="0">
195        <field type="BYTE" name="reason" enum="VideoNotifyReason" />
196        <field type="TIMESTAMP" name="time" />
197        <field type="DRAWABLE" name="drawable" />
198        <field type="PORT" name="port" />
199    </event>
200
201    <event name="PortNotify" number="1">
202        <pad bytes="1" />
203        <field type="TIMESTAMP" name="time" />
204        <field type="PORT" name="port" />
205        <field type="ATOM" name="attribute" />
206        <field type="INT32" name="value" />
207    </event>
208    
209    
210    <!-- Requests -->
211    <request name="QueryExtension" opcode="0">
212        <reply>
213            <pad bytes="1" />
214            <field type="CARD16" name="major" />
215            <field type="CARD16" name="minor" />
216        </reply>
217    </request>
218
219    <request name="QueryAdaptors" opcode="1">
220        <field type="WINDOW" name="window" />
221        <reply>
222            <pad bytes="1" />
223            <field type="CARD16" name="num_adaptors" />
224            <pad bytes="22" />
225            <list type="AdaptorInfo" name="info">
226                <fieldref>num_adaptors</fieldref>
227            </list>
228        </reply>
229    </request>
230
231    <request name="QueryEncodings" opcode="2">
232        <field type="PORT" name="port" />
233        <reply>
234            <pad bytes="1" />
235            <field type="CARD16" name="num_encodings" />
236            <pad bytes="22" />
237            <list type="EncodingInfo" name="info">
238                <fieldref>num_encodings</fieldref>
239            </list>
240        </reply>
241    </request>
242
243    <request name="GrabPort" opcode="3">
244        <field type="PORT" name="port" />
245        <field type="TIMESTAMP" name="time" altenum="Time" />
246        <reply>
247            <field type="BYTE" name="result" enum="GrabPortStatus" />
248        </reply>
249    </request>
250
251    <request name="UngrabPort" opcode="4">
252        <field type="PORT" name="port" />
253        <field type="TIMESTAMP" name="time" altenum="Time" />
254    </request>
255
256    <request name="PutVideo" opcode="5">
257        <field type="PORT" name="port" />
258        <field type="DRAWABLE" name="drawable" />
259        <field type="GCONTEXT" name="gc" />
260        <field type="INT16" name="vid_x" />
261        <field type="INT16" name="vid_y" />
262        <field type="CARD16" name="vid_w" />
263        <field type="CARD16" name="vid_h" />
264        <field type="INT16" name="drw_x" />
265        <field type="INT16" name="drw_y" />
266        <field type="CARD16" name="drw_w" />
267        <field type="CARD16" name="drw_h" />
268    </request>
269
270    <request name="PutStill" opcode="6">
271        <field type="PORT" name="port" />
272        <field type="DRAWABLE" name="drawable" />
273        <field type="GCONTEXT" name="gc" />
274        <field type="INT16" name="vid_x" />
275        <field type="INT16" name="vid_y" />
276        <field type="CARD16" name="vid_w" />
277        <field type="CARD16" name="vid_h" />
278        <field type="INT16" name="drw_x" />
279        <field type="INT16" name="drw_y" />
280        <field type="CARD16" name="drw_w" />
281        <field type="CARD16" name="drw_h" />
282    </request>
283
284    <request name="GetVideo" opcode="7">
285        <field type="PORT" name="port" />
286        <field type="DRAWABLE" name="drawable" />
287        <field type="GCONTEXT" name="gc" />
288        <field type="INT16" name="vid_x" />
289        <field type="INT16" name="vid_y" />
290        <field type="CARD16" name="vid_w" />
291        <field type="CARD16" name="vid_h" />
292        <field type="INT16" name="drw_x" />
293        <field type="INT16" name="drw_y" />
294        <field type="CARD16" name="drw_w" />
295        <field type="CARD16" name="drw_h" />
296    </request>
297
298    <request name="GetStill" opcode="8">
299        <field type="PORT" name="port" />
300        <field type="DRAWABLE" name="drawable" />
301        <field type="GCONTEXT" name="gc" />
302        <field type="INT16" name="vid_x" />
303        <field type="INT16" name="vid_y" />
304        <field type="CARD16" name="vid_w" />
305        <field type="CARD16" name="vid_h" />
306        <field type="INT16" name="drw_x" />
307        <field type="INT16" name="drw_y" />
308        <field type="CARD16" name="drw_w" />
309        <field type="CARD16" name="drw_h" />
310    </request>
311
312    <request name="StopVideo" opcode="9">
313        <field type="PORT" name="port" />
314        <field type="DRAWABLE" name="drawable" />
315    </request>
316
317    <request name="SelectVideoNotify" opcode="10">
318        <field type="DRAWABLE" name="drawable" />
319        <field type="BOOL" name="onoff" />
320        <pad bytes="3" />
321    </request>
322
323    <request name="SelectPortNotify" opcode="11">
324        <field type="PORT" name="port" />
325        <field type="BOOL" name="onoff" />
326        <pad bytes="3" />
327    </request>
328
329    <request name="QueryBestSize" opcode="12">
330        <field type="PORT" name="port" />
331        <field type="CARD16" name="vid_w" />
332        <field type="CARD16" name="vid_h" />
333        <field type="CARD16" name="drw_w" />
334        <field type="CARD16" name="drw_h" />
335        <field type="BOOL" name="motion" />
336        <pad bytes="3" />
337        <reply>
338            <pad bytes="1" />
339            <field type="CARD16" name="actual_width" />
340            <field type="CARD16" name="actual_height" />
341        </reply>
342    </request>
343
344    <request name="SetPortAttribute" opcode="13">
345        <field type="PORT" name="port" />
346        <field type="ATOM" name="attribute" />
347        <field type="INT32" name="value" />
348    </request>
349
350    <request name="GetPortAttribute" opcode="14">
351        <field type="PORT" name="port" />
352        <field type="ATOM" name="attribute" />
353        <reply>
354            <pad bytes="1" />
355            <field type="INT32" name="value" />
356        </reply>
357    </request>
358
359    <!-- Not in the docs beyond this point :( -->
360
361    <request name="QueryPortAttributes" opcode="15">
362        <field type="PORT" name="port" />
363        <reply>
364            <pad bytes="1" />
365            <field type="CARD32" name="num_attributes" />
366            <field type="CARD32" name="text_size" />
367            <pad bytes="16" />
368            <list type="AttributeInfo" name="attributes">
369                <fieldref>num_attributes</fieldref>
370            </list>
371        </reply>
372    </request>
373
374    <request name="ListImageFormats" opcode="16">
375        <field type="PORT" name="port" />
376        <reply>
377            <pad bytes="1" />
378            <field type="CARD32" name="num_formats" />
379            <pad bytes="20" />
380            <list type="ImageFormatInfo" name="format">
381                <fieldref>num_formats</fieldref>
382            </list>
383        </reply>
384    </request>
385
386    <request name="QueryImageAttributes" opcode="17">
387        <field type="PORT" name="port" />
388        <field type="CARD32" name="id" />
389        <field type="CARD16" name="width" />
390        <field type="CARD16" name="height" />
391        <reply>
392            <pad bytes="1" />
393            <field type="CARD32" name="num_planes" />
394            <field type="CARD32" name="data_size" />
395            <field type="CARD16" name="width" />
396            <field type="CARD16" name="height" />
397            <pad bytes="12" />
398            <list type="CARD32" name="pitches">
399                <fieldref>num_planes</fieldref>
400            </list>
401            <list type="CARD32" name="offsets">
402                <fieldref>num_planes</fieldref>
403            </list>
404        </reply>
405    </request>
406
407    <request name="PutImage" opcode="18">
408        <field type="PORT" name="port" />
409        <field type="DRAWABLE" name="drawable" />
410        <field type="GCONTEXT" name="gc" />
411        <field type="CARD32" name="id" />
412        <field type="INT16" name="src_x" />
413        <field type="INT16" name="src_y" />
414        <field type="CARD16" name="src_w" />
415        <field type="CARD16" name="src_h" />
416        <field type="INT16" name="drw_x" />
417        <field type="INT16" name="drw_y" />
418        <field type="CARD16" name="drw_w" />
419        <field type="CARD16" name="drw_h" />
420        <field type="CARD16" name="width" />
421        <field type="CARD16" name="height" />
422	<list type="CARD8" name="data" />
423    </request>
424
425    <request name="ShmPutImage" opcode="19">
426        <field type="PORT" name="port" />
427        <field type="DRAWABLE" name="drawable" />
428        <field type="GCONTEXT" name="gc" />
429        <field type="SEG" name="shmseg" />
430        <field type="CARD32" name="id" />
431        <field type="CARD32" name="offset" />
432        <field type="INT16" name="src_x" />
433        <field type="INT16" name="src_y" />
434        <field type="CARD16" name="src_w" />
435        <field type="CARD16" name="src_h" />
436        <field type="INT16" name="drw_x" />
437        <field type="INT16" name="drw_y" />
438        <field type="CARD16" name="drw_w" />
439        <field type="CARD16" name="drw_h" />
440        <field type="CARD16" name="width" />
441        <field type="CARD16" name="height" />
442        <field type="CARD8" name="send_event" />
443        <pad bytes="3" />
444    </request>
445</xcb>
446