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" />
  48         <item name="YUV" />
  49     </enum>
  50
  51     <enum name="ImageFormatInfoFormat">
  52         <item name="Packed" />
  53         <item name="Planar" />
  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     <struct name="Rational">
  62         <field type="INT32" name="numerator" />
  63         <field type="INT32" name="denominator" />
  64     </struct>
  65
  66     <struct name="AdaptorInfo">
  67         <field type="PORT" name="base_id" />
  68         <field type="CARD16" name="name_size" />
  69         <field type="CARD16" name="num_ports" />
  70         <field type="CARD16" name="num_formats" />
  71         <field type="CARD8" name="type" />
  72         <pad bytes="1" />
  73         <list type="char" name="name">
  74             <fieldref>name_size</fieldref>
  75         </list>
  76         <list type="Format" name="formats">
  77             <fieldref>num_formats</fieldref>
  78         </list>
  79
  80     </struct>
  81
  82     <struct name="EncodingInfo">
  83         <field type="ENCODING" name="encoding" />
  84         <field type="CARD16" name="name_size" />
  85         <field type="CARD16" name="width" />
  86         <field type="CARD16" name="height" />
  87         <!--
  88         Some versions of Xvproto.h incorrectly have
  89         this padding after "rate".
  90         -->
  91         <pad bytes="2" />
  92         <field type="Rational" name="rate" />
  93         <list type="char" name="name">
  94             <fieldref>name_size</fieldref>
  95         </list>
  96     </struct>
  97
  98     <struct name="Format">
  99         <field type="VISUALID" name="visual" />
 100         <field type="CARD8" name="depth" />
 101         <pad bytes="3" />
 102     </struct>
 103
 104     <struct name="Image">
 105         <field type="CARD32" name="id" />
 106         <field type="CARD16" name="width" />
 107         <field type="CARD16" name="height" />
 108         <field type="CARD32" name="data_size" />
 109         <field type="CARD32" name="num_planes" />
 110         <list type="CARD32" name="pitches">
 111             <fieldref>num_planes</fieldref>
 112         </list>
 113         <list type="CARD32" name="offsets">
 114             <fieldref>num_planes</fieldref>
 115         </list>
 116         <list type="CARD8" name="data">
 117             <fieldref>data_size</fieldref>
 118         </list>
 119         <!-- Some XPointer "obdata" for SHM use-->
 120     </struct>
 121
 122     <struct name="AttributeInfo">
 123         <field type="CARD32" name="flags" />
 124         <field type="INT32" name="min" />
 125         <field type="INT32" name="max" />
 126         <field type="CARD32" name="size" />
 127         <list type="char" name="name">
 128             <fieldref>size</fieldref>
 129         </list>
 130     </struct>
 131
 132     <struct name="ImageFormatInfo">
 133         <field type="CARD32" name="id" />
 134         <field type="CARD8" name="type" />
 135         <field type="CARD8" name="byte_order" />
 136         <pad bytes="2" />
 137         <list type="CARD8" name="guid">
 138             <value>16</value>
 139         </list>
 140         <field type="CARD8" name="bpp" />
 141         <field type="CARD8" name="num_planes" />
 142         <pad bytes="2" />
 143         <field type="CARD8" name="depth" />
 144         <pad bytes="3" />
 145         <field type="CARD32" name="red_mask" />
 146         <field type="CARD32" name="green_mask" />
 147         <field type="CARD32" name="blue_mask" />
 148         <field type="CARD8" name="format" />
 149         <pad bytes="3" />
 150         <field type="CARD32" name="y_sample_bits" />
 151         <field type="CARD32" name="u_sample_bits" />
 152         <field type="CARD32" name="v_sample_bits" />
 153         <field type="CARD32" name="vhorz_y_period" />
 154         <field type="CARD32" name="vhorz_u_period" />
 155         <field type="CARD32" name="vhorz_v_period" />
 156         <field type="CARD32" name="vvert_y_period" />
 157         <field type="CARD32" name="vvert_u_period" />
 158         <field type="CARD32" name="vvert_v_period" />
 159         <list type="CARD8" name="vcomp_order">
 160             <value>32</value>
 161         </list>
 162         <field type="CARD8" name="vscanline_order" />
 163         <pad bytes="11" />
 164     </struct>
 165
 166
 167     <!-- Errors -->
 168     <error name="BadPort" number="0"/>
 169     <error name="BadEncoding" number="1"/>
 170     <error name="BadControl" number="2"/>
 171
 172     <!-- Events -->
 173     <event name="VideoNotify" number="0">
 174         <field type="BYTE" name="reason" />
 175         <field type="TIMESTAMP" name="time" />
 176         <field type="DRAWABLE" name="drawable" />
 177         <field type="PORT" name="port" />
 178     </event>
 179
 180     <event name="PortNotify" number="1">
 181         <pad bytes="1" />
 182         <field type="TIMESTAMP" name="time" />
 183         <field type="PORT" name="port" />
 184         <field type="ATOM" name="attribute" />
 185         <field type="INT32" name="value" />
 186     </event>
 187
 188
 189     <!-- Requests -->
 190     <request name="QueryExtension" opcode="0">
 191         <reply>
 192             <pad bytes="1" />
 193             <field type="CARD16" name="major" />
 194             <field type="CARD16" name="minor" />
 195         </reply>
 196     </request>
 197
 198     <request name="QueryAdaptors" opcode="1">
 199         <field type="WINDOW" name="window" />
 200         <reply>
 201             <pad bytes="1" />
 202             <field type="CARD16" name="num_adaptors" />
 203             <pad bytes="22" />
 204             <list type="AdaptorInfo" name="info">
 205                 <fieldref>num_adaptors</fieldref>
 206             </list>
 207         </reply>
 208     </request>
 209
 210     <request name="QueryEncodings" opcode="2">
 211         <field type="PORT" name="port" />
 212         <reply>
 213             <pad bytes="1" />
 214             <field type="CARD16" name="num_encodings" />
 215             <!--
 216             In Xvproto.h this padding is 24 bytes
 217             in actuality it is 22 bytes
 218             -->
 219             <pad bytes="22" />
 220             <list type="EncodingInfo" name="info">
 221                 <fieldref>num_encodings</fieldref>
 222             </list>
 223         </reply>
 224     </request>
 225
 226     <request name="GrabPort" opcode="3">
 227         <field type="PORT" name="port" />
 228         <field type="TIMESTAMP" name="time" />
 229         <reply>
 230             <field type="BYTE" name="result" />
 231         </reply>
 232     </request>
 233
 234     <request name="UngrabPort" opcode="4">
 235         <field type="PORT" name="port" />
 236         <field type="TIMESTAMP" name="time" />
 237     </request>
 238
 239     <request name="PutVideo" opcode="5">
 240         <field type="PORT" name="port" />
 241         <field type="DRAWABLE" name="drawable" />
 242         <field type="GCONTEXT" name="gc" />
 243         <field type="INT16" name="vid_x" />
 244         <field type="INT16" name="vid_y" />
 245         <field type="CARD16" name="vid_w" />
 246         <field type="CARD16" name="vid_h" />
 247         <field type="INT16" name="drw_x" />
 248         <field type="INT16" name="drw_y" />
 249         <field type="CARD16" name="drw_w" />
 250         <field type="CARD16" name="drw_h" />
 251     </request>
 252
 253     <request name="PutStill" opcode="6">
 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="GetVideo" opcode="7">
 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="GetStill" opcode="8">
 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="StopVideo" opcode="9">
 296         <field type="PORT" name="port" />
 297         <field type="DRAWABLE" name="drawable" />
 298     </request>
 299
 300     <request name="SelectVideoNotify" opcode="10">
 301         <field type="DRAWABLE" name="drawable" />
 302         <field type="BOOL" name="onoff" />
 303     </request>
 304
 305     <request name="SelectPortNotify" opcode="11">
 306         <field type="PORT" name="port" />
 307         <field type="BOOL" name="onoff" />
 308     </request>
 309
 310     <request name="QueryBestSize" opcode="12">
 311         <field type="PORT" name="port" />
 312         <field type="CARD16" name="vid_w" />
 313         <field type="CARD16" name="vid_h" />
 314         <field type="CARD16" name="drw_w" />
 315         <field type="CARD16" name="drw_h" />
 316         <field type="BOOL" name="motion" />
 317         <reply>
 318             <pad bytes="1" />
 319             <field type="CARD16" name="actual_width" />
 320             <field type="CARD16" name="actual_height" />
 321         </reply>
 322     </request>
 323
 324     <request name="SetPortAttribute" opcode="13">
 325         <field type="PORT" name="port" />
 326         <field type="ATOM" name="attribute" />
 327         <field type="INT32" name="value" />
 328     </request>
 329
 330     <request name="GetPortAttribute" opcode="14">
 331         <field type="PORT" name="port" />
 332         <field type="ATOM" name="attribute" />
 333         <reply>
 334             <pad bytes="1" />
 335             <field type="INT32" name="value" />
 336         </reply>
 337     </request>
 338
 339     <!-- Not in the docs beyond this point :( -->
 340
 341     <request name="QueryPortAttributes" opcode="15">
 342         <field type="PORT" name="port" />
 343         <reply>
 344             <pad bytes="1" />
 345             <field type="CARD32" name="num_attributes" />
 346             <field type="CARD32" name="text_size" />
 347             <pad bytes="16" />
 348             <list type="AttributeInfo" name="attributes">
 349                 <fieldref>num_attributes</fieldref>
 350             </list>
 351         </reply>
 352     </request>
 353
 354     <request name="ListImageFormats" opcode="16">
 355         <field type="PORT" name="port" />
 356         <reply>
 357             <pad bytes="1" />
 358             <field type="CARD32" name="num_formats" />
 359             <pad bytes="20" />
 360             <list type="ImageFormatInfo" name="format">
 361                 <fieldref>num_formats</fieldref>
 362             </list>
 363         </reply>
 364     </request>
 365
 366     <request name="QueryImageAttributes" opcode="17">
 367         <field type="PORT" name="port" />
 368         <field type="CARD32" name="id" />
 369         <field type="CARD16" name="width" />
 370         <field type="CARD16" name="height" />
 371         <reply>
 372             <pad bytes="1" />
 373             <field type="CARD32" name="num_planes" />
 374             <field type="CARD32" name="data_size" />
 375             <field type="CARD16" name="width" />
 376             <field type="CARD16" name="height" />
 377             <pad bytes="12" />
 378             <list type="CARD32" name="pitches">
 379                 <fieldref>num_planes</fieldref>
 380             </list>
 381             <list type="CARD32" name="offsets">
 382                 <fieldref>num_planes</fieldref>
 383             </list>
 384         </reply>
 385     </request>
 386
 387     <request name="PutImage" opcode="18">
 388         <field type="PORT" name="port" />
 389         <field type="DRAWABLE" name="drawable" />
 390         <field type="GCONTEXT" name="gc" />
 391         <field type="CARD32" name="id" />
 392         <field type="INT16" name="src_x" />
 393         <field type="INT16" name="src_y" />
 394         <field type="CARD16" name="src_w" />
 395         <field type="CARD16" name="src_h" />
 396         <field type="INT16" name="drw_x" />
 397         <field type="INT16" name="drw_y" />
 398         <field type="CARD16" name="drw_w" />
 399         <field type="CARD16" name="drw_h" />
 400         <field type="CARD16" name="width" />
 401         <field type="CARD16" name="height" />
 402         <list type="CARD8" name="data" />
 403     </request>
 404
 405     <request name="ShmPutImage" opcode="19">
 406         <field type="PORT" name="port" />
 407         <field type="DRAWABLE" name="drawable" />
 408         <field type="GCONTEXT" name="gc" />
 409         <field type="SEG" name="shmseg" />
 410         <field type="CARD32" name="id" />
 411         <field type="CARD32" name="offset" />
 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         <field type="CARD8" name="send_event" />
 423     </request>
 424 </xcb>