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         <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     </struct>
 122
 123     <struct name="Image">
 124         <field type="CARD32" name="id" />
 125         <field type="CARD16" name="width" />
 126         <field type="CARD16" name="height" />
 127         <field type="CARD32" name="data_size" />
 128         <field type="CARD32" name="num_planes" />
 129         <list type="CARD32" name="pitches">
 130             <fieldref>num_planes</fieldref>
 131         </list>
 132         <list type="CARD32" name="offsets">
 133             <fieldref>num_planes</fieldref>
 134         </list>
 135         <list type="CARD8" name="data">
 136             <fieldref>data_size</fieldref>
 137         </list>
 138         <!-- Some XPointer "obdata" for SHM use-->
 139     </struct>
 140
 141     <struct name="AttributeInfo">
 142         <field type="CARD32" name="flags" mask="AttributeFlag" />
 143         <field type="INT32" name="min" />
 144         <field type="INT32" name="max" />
 145         <field type="CARD32" name="size" />
 146         <list type="char" name="name">
 147             <fieldref>size</fieldref>
 148         </list>
 149     </struct>
 150
 151     <struct name="ImageFormatInfo">
 152         <field type="CARD32" name="id" />
 153         <field type="CARD8" name="type" enum="ImageFormatInfoType" />
 154         <field type="CARD8" name="byte_order" enum="ImageOrder" />
 155         <pad bytes="2" />
 156         <list type="CARD8" name="guid">
 157             <value>16</value>
 158         </list>
 159         <field type="CARD8" name="bpp" />
 160         <field type="CARD8" name="num_planes" />
 161         <pad bytes="2" />
 162         <field type="CARD8" name="depth" />
 163         <pad bytes="3" />
 164         <field type="CARD32" name="red_mask" />
 165         <field type="CARD32" name="green_mask" />
 166         <field type="CARD32" name="blue_mask" />
 167         <field type="CARD8" name="format" enum="ImageFormatInfoFormat" />
 168         <pad bytes="3" />
 169         <field type="CARD32" name="y_sample_bits" />
 170         <field type="CARD32" name="u_sample_bits" />
 171         <field type="CARD32" name="v_sample_bits" />
 172         <field type="CARD32" name="vhorz_y_period" />
 173         <field type="CARD32" name="vhorz_u_period" />
 174         <field type="CARD32" name="vhorz_v_period" />
 175         <field type="CARD32" name="vvert_y_period" />
 176         <field type="CARD32" name="vvert_u_period" />
 177         <field type="CARD32" name="vvert_v_period" />
 178         <list type="CARD8" name="vcomp_order">
 179             <value>32</value>
 180         </list>
 181         <field type="CARD8" name="vscanline_order" enum="ScanlineOrder" />
 182         <pad bytes="11" />
 183     </struct>
 184
 185
 186     <!-- Errors -->
 187     <error name="BadPort" number="0"/>
 188     <error name="BadEncoding" number="1"/>
 189     <error name="BadControl" number="2"/>
 190
 191     <!-- Events -->
 192     <event name="VideoNotify" number="0">
 193         <field type="BYTE" name="reason" enum="VideoNotifyReason" />
 194         <field type="TIMESTAMP" name="time" />
 195         <field type="DRAWABLE" name="drawable" />
 196         <field type="PORT" name="port" />
 197     </event>
 198
 199     <event name="PortNotify" number="1">
 200         <pad bytes="1" />
 201         <field type="TIMESTAMP" name="time" />
 202         <field type="PORT" name="port" />
 203         <field type="ATOM" name="attribute" />
 204         <field type="INT32" name="value" />
 205     </event>
 206
 207
 208     <!-- Requests -->
 209     <request name="QueryExtension" opcode="0">
 210         <reply>
 211             <pad bytes="1" />
 212             <field type="CARD16" name="major" />
 213             <field type="CARD16" name="minor" />
 214         </reply>
 215     </request>
 216
 217     <request name="QueryAdaptors" opcode="1">
 218         <field type="WINDOW" name="window" />
 219         <reply>
 220             <pad bytes="1" />
 221             <field type="CARD16" name="num_adaptors" />
 222             <pad bytes="22" />
 223             <list type="AdaptorInfo" name="info">
 224                 <fieldref>num_adaptors</fieldref>
 225             </list>
 226         </reply>
 227     </request>
 228
 229     <request name="QueryEncodings" opcode="2">
 230         <field type="PORT" name="port" />
 231         <reply>
 232             <pad bytes="1" />
 233             <field type="CARD16" name="num_encodings" />
 234             <pad bytes="22" />
 235             <list type="EncodingInfo" name="info">
 236                 <fieldref>num_encodings</fieldref>
 237             </list>
 238         </reply>
 239     </request>
 240
 241     <request name="GrabPort" opcode="3">
 242         <field type="PORT" name="port" />
 243         <field type="TIMESTAMP" name="time" altenum="Time" />
 244         <reply>
 245             <field type="BYTE" name="result" enum="GrabPortStatus" />
 246         </reply>
 247     </request>
 248
 249     <request name="UngrabPort" opcode="4">
 250         <field type="PORT" name="port" />
 251         <field type="TIMESTAMP" name="time" altenum="Time" />
 252     </request>
 253
 254     <request name="PutVideo" opcode="5">
 255         <field type="PORT" name="port" />
 256         <field type="DRAWABLE" name="drawable" />
 257         <field type="GCONTEXT" name="gc" />
 258         <field type="INT16" name="vid_x" />
 259         <field type="INT16" name="vid_y" />
 260         <field type="CARD16" name="vid_w" />
 261         <field type="CARD16" name="vid_h" />
 262         <field type="INT16" name="drw_x" />
 263         <field type="INT16" name="drw_y" />
 264         <field type="CARD16" name="drw_w" />
 265         <field type="CARD16" name="drw_h" />
 266     </request>
 267
 268     <request name="PutStill" opcode="6">
 269         <field type="PORT" name="port" />
 270         <field type="DRAWABLE" name="drawable" />
 271         <field type="GCONTEXT" name="gc" />
 272         <field type="INT16" name="vid_x" />
 273         <field type="INT16" name="vid_y" />
 274         <field type="CARD16" name="vid_w" />
 275         <field type="CARD16" name="vid_h" />
 276         <field type="INT16" name="drw_x" />
 277         <field type="INT16" name="drw_y" />
 278         <field type="CARD16" name="drw_w" />
 279         <field type="CARD16" name="drw_h" />
 280     </request>
 281
 282     <request name="GetVideo" opcode="7">
 283         <field type="PORT" name="port" />
 284         <field type="DRAWABLE" name="drawable" />
 285         <field type="GCONTEXT" name="gc" />
 286         <field type="INT16" name="vid_x" />
 287         <field type="INT16" name="vid_y" />
 288         <field type="CARD16" name="vid_w" />
 289         <field type="CARD16" name="vid_h" />
 290         <field type="INT16" name="drw_x" />
 291         <field type="INT16" name="drw_y" />
 292         <field type="CARD16" name="drw_w" />
 293         <field type="CARD16" name="drw_h" />
 294     </request>
 295
 296     <request name="GetStill" opcode="8">
 297         <field type="PORT" name="port" />
 298         <field type="DRAWABLE" name="drawable" />
 299         <field type="GCONTEXT" name="gc" />
 300         <field type="INT16" name="vid_x" />
 301         <field type="INT16" name="vid_y" />
 302         <field type="CARD16" name="vid_w" />
 303         <field type="CARD16" name="vid_h" />
 304         <field type="INT16" name="drw_x" />
 305         <field type="INT16" name="drw_y" />
 306         <field type="CARD16" name="drw_w" />
 307         <field type="CARD16" name="drw_h" />
 308     </request>
 309
 310     <request name="StopVideo" opcode="9">
 311         <field type="PORT" name="port" />
 312         <field type="DRAWABLE" name="drawable" />
 313     </request>
 314
 315     <request name="SelectVideoNotify" opcode="10">
 316         <field type="DRAWABLE" name="drawable" />
 317         <field type="BOOL" name="onoff" />
 318         <pad bytes="3" />
 319     </request>
 320
 321     <request name="SelectPortNotify" opcode="11">
 322         <field type="PORT" name="port" />
 323         <field type="BOOL" name="onoff" />
 324         <pad bytes="3" />
 325     </request>
 326
 327     <request name="QueryBestSize" opcode="12">
 328         <field type="PORT" name="port" />
 329         <field type="CARD16" name="vid_w" />
 330         <field type="CARD16" name="vid_h" />
 331         <field type="CARD16" name="drw_w" />
 332         <field type="CARD16" name="drw_h" />
 333         <field type="BOOL" name="motion" />
 334         <pad bytes="3" />
 335         <reply>
 336             <pad bytes="1" />
 337             <field type="CARD16" name="actual_width" />
 338             <field type="CARD16" name="actual_height" />
 339         </reply>
 340     </request>
 341
 342     <request name="SetPortAttribute" opcode="13">
 343         <field type="PORT" name="port" />
 344         <field type="ATOM" name="attribute" />
 345         <field type="INT32" name="value" />
 346     </request>
 347
 348     <request name="GetPortAttribute" opcode="14">
 349         <field type="PORT" name="port" />
 350         <field type="ATOM" name="attribute" />
 351         <reply>
 352             <pad bytes="1" />
 353             <field type="INT32" name="value" />
 354         </reply>
 355     </request>
 356
 357     <!-- Not in the docs beyond this point :( -->
 358
 359     <request name="QueryPortAttributes" opcode="15">
 360         <field type="PORT" name="port" />
 361         <reply>
 362             <pad bytes="1" />
 363             <field type="CARD32" name="num_attributes" />
 364             <field type="CARD32" name="text_size" />
 365             <pad bytes="16" />
 366             <list type="AttributeInfo" name="attributes">
 367                 <fieldref>num_attributes</fieldref>
 368             </list>
 369         </reply>
 370     </request>
 371
 372     <request name="ListImageFormats" opcode="16">
 373         <field type="PORT" name="port" />
 374         <reply>
 375             <pad bytes="1" />
 376             <field type="CARD32" name="num_formats" />
 377             <pad bytes="20" />
 378             <list type="ImageFormatInfo" name="format">
 379                 <fieldref>num_formats</fieldref>
 380             </list>
 381         </reply>
 382     </request>
 383
 384     <request name="QueryImageAttributes" opcode="17">
 385         <field type="PORT" name="port" />
 386         <field type="CARD32" name="id" />
 387         <field type="CARD16" name="width" />
 388         <field type="CARD16" name="height" />
 389         <reply>
 390             <pad bytes="1" />
 391             <field type="CARD32" name="num_planes" />
 392             <field type="CARD32" name="data_size" />
 393             <field type="CARD16" name="width" />
 394             <field type="CARD16" name="height" />
 395             <pad bytes="12" />
 396             <list type="CARD32" name="pitches">
 397                 <fieldref>num_planes</fieldref>
 398             </list>
 399             <list type="CARD32" name="offsets">
 400                 <fieldref>num_planes</fieldref>
 401             </list>
 402         </reply>
 403     </request>
 404
 405     <request name="PutImage" opcode="18">
 406         <field type="PORT" name="port" />
 407         <field type="DRAWABLE" name="drawable" />
 408         <field type="GCONTEXT" name="gc" />
 409         <field type="CARD32" name="id" />
 410         <field type="INT16" name="src_x" />
 411         <field type="INT16" name="src_y" />
 412         <field type="CARD16" name="src_w" />
 413         <field type="CARD16" name="src_h" />
 414         <field type="INT16" name="drw_x" />
 415         <field type="INT16" name="drw_y" />
 416         <field type="CARD16" name="drw_w" />
 417         <field type="CARD16" name="drw_h" />
 418         <field type="CARD16" name="width" />
 419         <field type="CARD16" name="height" />
 420         <list type="CARD8" name="data" />
 421     </request>
 422
 423     <request name="ShmPutImage" opcode="19">
 424         <field type="PORT" name="port" />
 425         <field type="DRAWABLE" name="drawable" />
 426         <field type="GCONTEXT" name="gc" />
 427         <field type="SEG" name="shmseg" />
 428         <field type="CARD32" name="id" />
 429         <field type="CARD32" name="offset" />
 430         <field type="INT16" name="src_x" />
 431         <field type="INT16" name="src_y" />
 432         <field type="CARD16" name="src_w" />
 433         <field type="CARD16" name="src_h" />
 434         <field type="INT16" name="drw_x" />
 435         <field type="INT16" name="drw_y" />
 436         <field type="CARD16" name="drw_w" />
 437         <field type="CARD16" name="drw_h" />
 438         <field type="CARD16" name="width" />
 439         <field type="CARD16" name="height" />
 440         <field type="CARD8" name="send_event" />
 441         <pad bytes="3" />
 442     </request>
 443 </xcb>