git.demorecorder.com Git - free-sw/xcb/proto/blob - src/extensions/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">
  30     <import>shm</import>
  31     <!-- Implements version 2.2 of XV -->
  32
  33     <!-- XIDs -->
  34     <xidtype name="PORT" />
  35     <xidtype name="ENCODING" />
  36
  37     <enum name="Type">
  38         <item name="InputMask"><value>0x00000001</value></item>
  39         <item name="OutputMask"><value>0x00000002</value></item>
  40         <item name="VideoMask"><value>0x00000004</value></item>
  41         <item name="StillMask"><value>0x00000008</value></item>
  42         <item name="ImageMask"><value>0x00000010</value></item>
  43     </enum>
  44
  45     <enum name="ImageFormatInfoType">
  46         <item name="RGB" />
  47         <item name="YUV" />
  48     </enum>
  49
  50     <enum name="ImageFormatInfoFormat">
  51         <item name="Packed" />
  52         <item name="Planar" />
  53     </enum>
  54
  55     <enum name="AttributeFlag">
  56         <item name="Gettable"><value>0x01</value></item>
  57         <item name="Settable"><value>0x02</value></item>
  58     </enum>
  59
  60     <struct name="Rational">
  61         <field type="INT32" name="numerator" />
  62         <field type="INT32" name="denominator" />
  63     </struct>
  64
  65     <struct name="AdaptorInfo">
  66         <field type="PORT" name="base_id" />
  67         <field type="CARD16" name="name_size" />
  68         <field type="CARD16" name="num_ports" />
  69         <field type="CARD16" name="num_formats" />
  70         <field type="CARD8" name="type" />
  71         <field type="CARD8" name="pad" />
  72         <list type="char" name="name">
  73             <fieldref>name_size</fieldref>
  74         </list>
  75         <list type="Format" name="formats">
  76             <fieldref>num_formats</fieldref>
  77         </list>
  78
  79     </struct>
  80
  81     <struct name="EncodingInfo">
  82         <field type="ENCODING" name="encoding" />
  83         <field type="CARD16" name="name_size" />
  84         <field type="CARD16" name="width" />
  85         <field type="CARD16" name="height" />
  86         <field type="Rational" name="rate" />
  87         <!--
  88         Xvproto.h has a padding CARD16 here but the name
  89         overlaps.
  90         -->
  91         <list type="char" name="name">
  92             <fieldref>name_size</fieldref>
  93         </list>
  94     </struct>
  95
  96     <struct name="Format">
  97         <field type="VISUALID" name="visual" />
  98         <field type="CARD8" name="depth" />
  99     </struct>
 100
 101     <struct name="Image">
 102         <field type="CARD32" name="id" />
 103         <field type="CARD16" name="width" />
 104         <field type="CARD16" name="height" />
 105         <field type="CARD32" name="data_size" />
 106         <field type="CARD32" name="num_planes" />
 107         <list type="CARD32" name="pitches">
 108             <fieldref>num_planes</fieldref>
 109         </list>
 110         <list type="CARD32" name="offsets">
 111             <fieldref>num_planes</fieldref>
 112         </list>
 113         <list type="CARD8" name="data">
 114             <fieldref>data_size</fieldref>
 115         </list>
 116         <!-- Some XPointer "obdata" for SHM use-->
 117     </struct>
 118
 119     <struct name="AttributeInfo">
 120         <field type="CARD32" name="flags" />
 121         <field type="INT32" name="min" />
 122         <field type="INT32" name="max" />
 123         <field type="CARD32" name="size" />
 124         <list type="char" name="name">
 125             <fieldref>size</fieldref>
 126         </list>
 127     </struct>
 128
 129     <struct name="ImageFormatInfo">
 130         <field type="CARD32" name="id" />
 131         <field type="CARD8" name="type" />
 132         <field type="CARD8" name="byte_order" />
 133         <field type="CARD16" name="pad1" />
 134         <list type="CARD8" name="guid">
 135             <value>16</value>
 136         </list>
 137         <field type="CARD8" name="bpp" />
 138         <field type="CARD8" name="num_planes" />
 139         <field type="CARD16" name="pad2" />
 140         <field type="CARD8" name="depth" />
 141         <field type="CARD8" name="pad3" />
 142         <field type="CARD16" name="pad4" />
 143         <field type="CARD32" name="red_mask" />
 144         <field type="CARD32" name="green_mask" />
 145         <field type="CARD32" name="blue_mask" />
 146         <field type="CARD8" name="format" />
 147         <field type="CARD8" name="pad5" />
 148         <field type="CARD16" name="pad6" />
 149         <field type="CARD32" name="y_sample_bits" />
 150         <field type="CARD32" name="u_sample_bits" />
 151         <field type="CARD32" name="v_sample_bits" />
 152         <field type="CARD32" name="vhorz_y_period" />
 153         <field type="CARD32" name="vhorz_u_period" />
 154         <field type="CARD32" name="vhorz_v_period" />
 155         <field type="CARD32" name="vvert_y_period" />
 156         <field type="CARD32" name="vvert_u_period" />
 157         <field type="CARD32" name="vvert_v_period" />
 158         <list type="CARD8" name="vcomp_order">
 159             <value>32</value>
 160         </list>
 161         <field type="CARD8" name="vscanline_order" />
 162         <field type="CARD8" name="vpad7" />
 163         <field type="CARD16" name="vpad8" />
 164         <field type="CARD32" name="vpad9" />
 165         <field type="CARD32" name="vpad10" />
 166     </struct>
 167
 168
 169     <!-- Errors -->
 170     <error name="BadPort" number="0"/>
 171     <error name="BadEncoding" number="1"/>
 172     <error name="BadControl" number="2"/>
 173
 174     <!-- Events -->
 175     <event name="VideoNotify" number="0">
 176         <field type="BYTE" name="reason" />
 177         <field type="TIMESTAMP" name="time" />
 178         <field type="DRAWABLE" name="drawable" />
 179         <field type="PORT" name="port" />
 180     </event>
 181
 182     <event name="PortNotify" number="1">
 183         <pad bytes="1" />
 184         <field type="TIMESTAMP" name="time" />
 185         <field type="PORT" name="port" />
 186         <field type="ATOM" name="attribute" />
 187         <field type="INT32" name="value" />
 188     </event>
 189
 190
 191     <!-- Requests -->
 192     <request name="QueryExtension" opcode="0">
 193         <reply>
 194             <pad bytes="1" />
 195             <field type="CARD16" name="major" />
 196             <field type="CARD16" name="minor" />
 197         </reply>
 198     </request>
 199
 200     <request name="QueryAdaptors" opcode="1">
 201         <field type="WINDOW" name="window" />
 202         <reply>
 203             <pad bytes="1" />
 204             <field type="CARD16" name="num_adaptors" />
 205             <pad bytes="22" />
 206             <list type="AdaptorInfo" name="info">
 207                 <fieldref>num_adaptors</fieldref>
 208             </list>
 209         </reply>
 210     </request>
 211
 212     <request name="QueryEncodings" opcode="2">
 213         <field type="PORT" name="port" />
 214         <reply>
 215             <pad bytes="1" />
 216             <field type="CARD16" name="num_encodings" />
 217             <!--
 218             In Xvproto.h this padding is 24 bytes
 219             in actuality it is 22 bytes
 220             -->
 221             <pad bytes="22" />
 222             <list type="EncodingInfo" name="info">
 223                 <fieldref>num_encodings</fieldref>
 224             </list>
 225         </reply>
 226     </request>
 227
 228     <request name="GrabPort" opcode="3">
 229         <field type="PORT" name="port" />
 230         <field type="TIMESTAMP" name="time" />
 231         <reply>
 232             <field type="BYTE" name="result" />
 233         </reply>
 234     </request>
 235
 236     <request name="UngrabPort" opcode="4">
 237         <field type="PORT" name="port" />
 238         <field type="TIMESTAMP" name="time" />
 239     </request>
 240
 241     <request name="PutVideo" opcode="5">
 242         <field type="PORT" name="port" />
 243         <field type="DRAWABLE" name="drawable" />
 244         <field type="GCONTEXT" name="gc" />
 245         <field type="INT16" name="vid_x" />
 246         <field type="INT16" name="vid_y" />
 247         <field type="CARD16" name="vid_w" />
 248         <field type="CARD16" name="vid_h" />
 249         <field type="INT16" name="drw_x" />
 250         <field type="INT16" name="drw_y" />
 251         <field type="CARD16" name="drw_w" />
 252         <field type="CARD16" name="drw_h" />
 253     </request>
 254
 255     <request name="PutStill" opcode="6">
 256         <field type="PORT" name="port" />
 257         <field type="DRAWABLE" name="drawable" />
 258         <field type="GCONTEXT" name="gc" />
 259         <field type="INT16" name="vid_x" />
 260         <field type="INT16" name="vid_y" />
 261         <field type="CARD16" name="vid_w" />
 262         <field type="CARD16" name="vid_h" />
 263         <field type="INT16" name="drw_x" />
 264         <field type="INT16" name="drw_y" />
 265         <field type="CARD16" name="drw_w" />
 266         <field type="CARD16" name="drw_h" />
 267     </request>
 268
 269     <request name="GetVideo" opcode="7">
 270         <field type="PORT" name="port" />
 271         <field type="DRAWABLE" name="drawable" />
 272         <field type="GCONTEXT" name="gc" />
 273         <field type="INT16" name="vid_x" />
 274         <field type="INT16" name="vid_y" />
 275         <field type="CARD16" name="vid_w" />
 276         <field type="CARD16" name="vid_h" />
 277         <field type="INT16" name="drw_x" />
 278         <field type="INT16" name="drw_y" />
 279         <field type="CARD16" name="drw_w" />
 280         <field type="CARD16" name="drw_h" />
 281     </request>
 282
 283     <request name="GetStill" opcode="8">
 284         <field type="PORT" name="port" />
 285         <field type="DRAWABLE" name="drawable" />
 286         <field type="GCONTEXT" name="gc" />
 287         <field type="INT16" name="vid_x" />
 288         <field type="INT16" name="vid_y" />
 289         <field type="CARD16" name="vid_w" />
 290         <field type="CARD16" name="vid_h" />
 291         <field type="INT16" name="drw_x" />
 292         <field type="INT16" name="drw_y" />
 293         <field type="CARD16" name="drw_w" />
 294         <field type="CARD16" name="drw_h" />
 295     </request>
 296
 297     <request name="StopVideo" opcode="9">
 298         <field type="PORT" name="port" />
 299         <field type="DRAWABLE" name="drawable" />
 300     </request>
 301
 302     <request name="SelectVideoNotify" opcode="10">
 303         <field type="DRAWABLE" name="drawable" />
 304         <field type="BOOL" name="onoff" />
 305     </request>
 306
 307     <request name="SelectPortNotify" opcode="11">
 308         <field type="DRAWABLE" name="drawable" />
 309         <field type="BOOL" name="onoff" />
 310     </request>
 311
 312     <request name="QueryBestSize" opcode="12">
 313         <field type="PORT" name="port" />
 314         <field type="CARD16" name="vid_w" />
 315         <field type="CARD16" name="vid_h" />
 316         <field type="CARD16" name="drw_w" />
 317         <field type="CARD16" name="drw_h" />
 318         <field type="BOOL" name="motion" />
 319         <reply>
 320             <pad bytes="1" />
 321             <field type="CARD16" name="actual_width" />
 322             <field type="CARD16" name="actual_height" />
 323         </reply>
 324     </request>
 325
 326     <request name="SetPortAttribute" opcode="13">
 327         <field type="PORT" name="port" />
 328         <field type="ATOM" name="attribute" />
 329         <field type="INT32" name="value" />
 330     </request>
 331
 332     <request name="GetPortAttribute" opcode="14">
 333         <field type="PORT" name="port" />
 334         <field type="ATOM" name="attribute" />
 335         <reply>
 336             <pad bytes="1" />
 337             <field type="INT32" name="value" />
 338         </reply>
 339     </request>
 340
 341     <!-- Not in the docs beyond this point :( -->
 342
 343     <request name="QueryPortAttributes" opcode="15">
 344         <field type="PORT" name="port" />
 345         <reply>
 346             <pad bytes="1" />
 347             <field type="CARD32" name="num_attributes" />
 348             <field type="CARD32" name="text_size" />
 349             <pad bytes="16" />
 350             <list type="AttributeInfo" name="attributes">
 351                 <fieldref>num_attributes</fieldref>
 352             </list>
 353         </reply>
 354     </request>
 355
 356     <request name="ListImageFormats" opcode="16">
 357         <field type="PORT" name="port" />
 358         <reply>
 359             <pad bytes="1" />
 360             <field type="CARD32" name="num_formats" />
 361             <pad bytes="20" />
 362             <list type="ImageFormatInfo" name="format">
 363                 <fieldref>num_formats</fieldref>
 364             </list>
 365         </reply>
 366     </request>
 367
 368     <request name="QueryImageAttributes" opcode="17">
 369         <field type="PORT" name="port" />
 370         <field type="CARD32" name="id" />
 371         <field type="CARD16" name="width" />
 372         <field type="CARD16" name="height" />
 373         <reply>
 374             <pad bytes="1" />
 375             <field type="CARD32" name="num_planes" />
 376             <field type="CARD32" name="data_size" />
 377             <field type="CARD16" name="width" />
 378             <field type="CARD16" name="height" />
 379             <pad bytes="12" />
 380             <list type="CARD32" name="pitches">
 381                 <fieldref>num_planes</fieldref>
 382             </list>
 383             <list type="CARD32" name="offsets">
 384                 <fieldref>num_planes</fieldref>
 385             </list>
 386         </reply>
 387     </request>
 388
 389     <request name="PutImage" opcode="18">
 390         <field type="PORT" name="port" />
 391         <field type="DRAWABLE" name="drawable" />
 392         <field type="GCONTEXT" name="gc" />
 393         <field type="CARD32" name="id" />
 394         <field type="INT16" name="src_x" />
 395         <field type="INT16" name="src_y" />
 396         <field type="CARD16" name="src_w" />
 397         <field type="CARD16" name="src_h" />
 398         <field type="INT16" name="drw_x" />
 399         <field type="INT16" name="drw_y" />
 400         <field type="CARD16" name="drw_w" />
 401         <field type="CARD16" name="drw_h" />
 402         <field type="CARD16" name="width" />
 403         <field type="CARD16" name="height" />
 404         <localfield type="CARD32" name="data_size" />
 405         <list type="CARD8" name="data">
 406             <fieldref>data_size</fieldref>
 407         </list>
 408     </request>
 409
 410     <request name="ShmPutImage" opcode="19">
 411         <field type="PORT" name="port" />
 412         <field type="DRAWABLE" name="drawable" />
 413         <field type="GCONTEXT" name="gc" />
 414         <field type="SEG" name="shmseg" />
 415         <field type="CARD32" name="id" />
 416         <field type="CARD32" name="offset" />
 417         <field type="INT16" name="src_x" />
 418         <field type="INT16" name="src_y" />
 419         <field type="CARD16" name="src_w" />
 420         <field type="CARD16" name="src_h" />
 421         <field type="INT16" name="drw_x" />
 422         <field type="INT16" name="drw_y" />
 423         <field type="CARD16" name="drw_w" />
 424         <field type="CARD16" name="drw_h" />
 425         <field type="CARD16" name="width" />
 426         <field type="CARD16" name="height" />
 427         <field type="CARD8" name="send_event" />
 428     </request>
 429 </xcb>