git.demorecorder.com Git - free-sw/xcb/proto/blob - src/xv.xml

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