unmaintained/gstreamer/plugins/video/GstVideo-0.10.gir

   1 <?xml version="1.0"?>
   2 <!-- This file was automatically generated from C sources - DO NOT EDIT!
   3 To affect the contents of this file, edit the original C definitions,
   4 and/or use gtk-doc annotations.  -->
   5 <repository version="1.2"
   6             xmlns="http://www.gtk.org/introspection/core/1.0"
   7             xmlns:c="http://www.gtk.org/introspection/c/1.0"
   8             xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
   9   <include name="GLib" version="2.0"/>
  10   <include name="GModule" version="2.0"/>
  11   <include name="GObject" version="2.0"/>
  12   <include name="Gst" version="0.10"/>
  13   <include name="GstBase" version="0.10"/>
  14   <include name="libxml2" version="2.0"/>
  15   <package name="gstreamer-video-0.10"/>
  16   <c:include name="gst/video/gstvideofilter.h"/>
  17   <c:include name="gst/video/gstvideosink.h"/>
  18   <c:include name="gst/video/video-enumtypes.h"/>
  19   <c:include name="gst/video/video.h"/>
  20   <namespace name="GstVideo"
  21              version="0.10"
  22              shared-library="libgstvideo-0.10.so.0"
  23              c:identifier-prefixes="Gst"
  24              c:symbol-prefixes="gst">
  25     <constant name="VIDEO_BYTE1_MASK_24" value="0x00FF0000">
  26       <type name="utf8" c:type="gchar*"/>
  27     </constant>
  28     <constant name="VIDEO_BYTE1_MASK_24_INT" value="16711680">
  29       <type name="gint" c:type="gint"/>
  30     </constant>
  31     <constant name="VIDEO_BYTE1_MASK_32" value="0xFF000000">
  32       <type name="utf8" c:type="gchar*"/>
  33     </constant>
  34     <constant name="VIDEO_BYTE1_MASK_32_INT" value="-16777216">
  35       <type name="gint" c:type="gint"/>
  36     </constant>
  37     <constant name="VIDEO_BYTE2_MASK_24" value="0x0000FF00">
  38       <type name="utf8" c:type="gchar*"/>
  39     </constant>
  40     <constant name="VIDEO_BYTE2_MASK_24_INT" value="65280">
  41       <type name="gint" c:type="gint"/>
  42     </constant>
  43     <constant name="VIDEO_BYTE2_MASK_32" value="0x00FF0000">
  44       <type name="utf8" c:type="gchar*"/>
  45     </constant>
  46     <constant name="VIDEO_BYTE2_MASK_32_INT" value="16711680">
  47       <type name="gint" c:type="gint"/>
  48     </constant>
  49     <constant name="VIDEO_BYTE3_MASK_24" value="0x000000FF">
  50       <type name="utf8" c:type="gchar*"/>
  51     </constant>
  52     <constant name="VIDEO_BYTE3_MASK_24_INT" value="255">
  53       <type name="gint" c:type="gint"/>
  54     </constant>
  55     <constant name="VIDEO_BYTE3_MASK_32" value="0x0000FF00">
  56       <type name="utf8" c:type="gchar*"/>
  57     </constant>
  58     <constant name="VIDEO_BYTE3_MASK_32_INT" value="65280">
  59       <type name="gint" c:type="gint"/>
  60     </constant>
  61     <constant name="VIDEO_BYTE4_MASK_32" value="0x000000FF">
  62       <type name="utf8" c:type="gchar*"/>
  63     </constant>
  64     <constant name="VIDEO_BYTE4_MASK_32_INT" value="255">
  65       <type name="gint" c:type="gint"/>
  66     </constant>
  67     <constant name="VIDEO_CAPS_GRAY8"
  68               value="video/x-raw-gray, bpp = (int) 8, depth = (int) 8, width = ">
  69       <type name="utf8" c:type="gchar*"/>
  70     </constant>
  71     <constant name="VIDEO_CAPS_RGB8_PALETTED"
  72               value="video/x-raw-rgb, bpp = (int)8, depth = (int)8, width = ">
  73       <type name="utf8" c:type="gchar*"/>
  74     </constant>
  75     <constant name="VIDEO_COMP1_MASK_15" value="0x7c00">
  76       <type name="utf8" c:type="gchar*"/>
  77     </constant>
  78     <constant name="VIDEO_COMP1_MASK_15_INT" value="31744">
  79       <type name="gint" c:type="gint"/>
  80     </constant>
  81     <constant name="VIDEO_COMP1_MASK_16" value="0xf800">
  82       <type name="utf8" c:type="gchar*"/>
  83     </constant>
  84     <constant name="VIDEO_COMP1_MASK_16_INT" value="63488">
  85       <type name="gint" c:type="gint"/>
  86     </constant>
  87     <constant name="VIDEO_COMP2_MASK_15" value="0x03e0">
  88       <type name="utf8" c:type="gchar*"/>
  89     </constant>
  90     <constant name="VIDEO_COMP2_MASK_15_INT" value="992">
  91       <type name="gint" c:type="gint"/>
  92     </constant>
  93     <constant name="VIDEO_COMP2_MASK_16" value="0x07e0">
  94       <type name="utf8" c:type="gchar*"/>
  95     </constant>
  96     <constant name="VIDEO_COMP2_MASK_16_INT" value="2016">
  97       <type name="gint" c:type="gint"/>
  98     </constant>
  99     <constant name="VIDEO_COMP3_MASK_15" value="0x001f">
 100       <type name="utf8" c:type="gchar*"/>
 101     </constant>
 102     <constant name="VIDEO_COMP3_MASK_15_INT" value="31">
 103       <type name="gint" c:type="gint"/>
 104     </constant>
 105     <constant name="VIDEO_COMP3_MASK_16" value="0x001f">
 106       <type name="utf8" c:type="gchar*"/>
 107     </constant>
 108     <constant name="VIDEO_COMP3_MASK_16_INT" value="31">
 109       <type name="gint" c:type="gint"/>
 110     </constant>
 111     <constant name="VIDEO_FPS_RANGE" value="(fraction) [ 0, max ]">
 112       <type name="utf8" c:type="gchar*"/>
 113     </constant>
 114     <constant name="VIDEO_SIZE_RANGE" value="(int) [ 1, max ]">
 115       <type name="utf8" c:type="gchar*"/>
 116     </constant>
 117     <callback name="VideoConvertFrameCallback"
 118               c:type="GstVideoConvertFrameCallback">
 119       <return-value transfer-ownership="none">
 120         <type name="none" c:type="void"/>
 121       </return-value>
 122       <parameters>
 123         <parameter name="buf" transfer-ownership="none">
 124           <type name="Gst.Buffer" c:type="GstBuffer*"/>
 125         </parameter>
 126         <parameter name="error" transfer-ownership="none">
 127           <type name="GLib.Error" c:type="GError*"/>
 128         </parameter>
 129         <parameter name="user_data" transfer-ownership="none" closure="2">
 130           <type name="gpointer" c:type="gpointer"/>
 131         </parameter>
 132       </parameters>
 133     </callback>
 134     <class name="VideoFilter"
 135            c:symbol-prefix="video_filter"
 136            c:type="GstVideoFilter"
 137            parent="GstBase.BaseTransform"
 138            abstract="1"
 139            glib:type-name="GstVideoFilter"
 140            glib:get-type="gst_video_filter_get_type"
 141            glib:type-struct="VideoFilterClass">
 142       <field name="element">
 143         <type name="GstBase.BaseTransform" c:type="GstBaseTransform"/>
 144       </field>
 145       <field name="inited">
 146         <type name="gboolean" c:type="gboolean"/>
 147       </field>
 148     </class>
 149     <record name="VideoFilterClass"
 150             c:type="GstVideoFilterClass"
 151             glib:is-gtype-struct-for="VideoFilter">
 152       <field name="parent_class">
 153         <type name="GstBase.BaseTransformClass"
 154               c:type="GstBaseTransformClass"/>
 155       </field>
 156     </record>
 157     <enumeration name="VideoFormat"
 158                  glib:type-name="GstVideoFormat"
 159                  glib:get-type="gst_video_format_get_type"
 160                  c:type="GstVideoFormat">
 161       <doc xml:whitespace="preserve">Enum value describing the most common video formats.</doc>
 162       <member name="unknown"
 163               value="0"
 164               c:identifier="GST_VIDEO_FORMAT_UNKNOWN"
 165               glib:nick="unknown"/>
 166       <member name="i420"
 167               value="1"
 168               c:identifier="GST_VIDEO_FORMAT_I420"
 169               glib:nick="i420"/>
 170       <member name="yv12"
 171               value="2"
 172               c:identifier="GST_VIDEO_FORMAT_YV12"
 173               glib:nick="yv12"/>
 174       <member name="yuy2"
 175               value="3"
 176               c:identifier="GST_VIDEO_FORMAT_YUY2"
 177               glib:nick="yuy2"/>
 178       <member name="uyvy"
 179               value="4"
 180               c:identifier="GST_VIDEO_FORMAT_UYVY"
 181               glib:nick="uyvy"/>
 182       <member name="ayuv"
 183               value="5"
 184               c:identifier="GST_VIDEO_FORMAT_AYUV"
 185               glib:nick="ayuv"/>
 186       <member name="rgbx"
 187               value="6"
 188               c:identifier="GST_VIDEO_FORMAT_RGBx"
 189               glib:nick="rgbx"/>
 190       <member name="bgrx"
 191               value="7"
 192               c:identifier="GST_VIDEO_FORMAT_BGRx"
 193               glib:nick="bgrx"/>
 194       <member name="xrgb"
 195               value="8"
 196               c:identifier="GST_VIDEO_FORMAT_xRGB"
 197               glib:nick="xrgb"/>
 198       <member name="xbgr"
 199               value="9"
 200               c:identifier="GST_VIDEO_FORMAT_xBGR"
 201               glib:nick="xbgr"/>
 202       <member name="rgba"
 203               value="10"
 204               c:identifier="GST_VIDEO_FORMAT_RGBA"
 205               glib:nick="rgba"/>
 206       <member name="bgra"
 207               value="11"
 208               c:identifier="GST_VIDEO_FORMAT_BGRA"
 209               glib:nick="bgra"/>
 210       <member name="argb"
 211               value="12"
 212               c:identifier="GST_VIDEO_FORMAT_ARGB"
 213               glib:nick="argb"/>
 214       <member name="abgr"
 215               value="13"
 216               c:identifier="GST_VIDEO_FORMAT_ABGR"
 217               glib:nick="abgr"/>
 218       <member name="rgb"
 219               value="14"
 220               c:identifier="GST_VIDEO_FORMAT_RGB"
 221               glib:nick="rgb"/>
 222       <member name="bgr"
 223               value="15"
 224               c:identifier="GST_VIDEO_FORMAT_BGR"
 225               glib:nick="bgr"/>
 226       <member name="y41b"
 227               value="16"
 228               c:identifier="GST_VIDEO_FORMAT_Y41B"
 229               glib:nick="y41b"/>
 230       <member name="y42b"
 231               value="17"
 232               c:identifier="GST_VIDEO_FORMAT_Y42B"
 233               glib:nick="y42b"/>
 234       <member name="yvyu"
 235               value="18"
 236               c:identifier="GST_VIDEO_FORMAT_YVYU"
 237               glib:nick="yvyu"/>
 238       <member name="y444"
 239               value="19"
 240               c:identifier="GST_VIDEO_FORMAT_Y444"
 241               glib:nick="y444"/>
 242       <member name="v210"
 243               value="20"
 244               c:identifier="GST_VIDEO_FORMAT_v210"
 245               glib:nick="v210"/>
 246       <member name="v216"
 247               value="21"
 248               c:identifier="GST_VIDEO_FORMAT_v216"
 249               glib:nick="v216"/>
 250       <member name="nv12"
 251               value="22"
 252               c:identifier="GST_VIDEO_FORMAT_NV12"
 253               glib:nick="nv12"/>
 254       <member name="nv21"
 255               value="23"
 256               c:identifier="GST_VIDEO_FORMAT_NV21"
 257               glib:nick="nv21"/>
 258       <member name="gray8"
 259               value="24"
 260               c:identifier="GST_VIDEO_FORMAT_GRAY8"
 261               glib:nick="gray8"/>
 262       <member name="gray16_be"
 263               value="25"
 264               c:identifier="GST_VIDEO_FORMAT_GRAY16_BE"
 265               glib:nick="gray16-be"/>
 266       <member name="gray16_le"
 267               value="26"
 268               c:identifier="GST_VIDEO_FORMAT_GRAY16_LE"
 269               glib:nick="gray16-le"/>
 270       <member name="v308"
 271               value="27"
 272               c:identifier="GST_VIDEO_FORMAT_v308"
 273               glib:nick="v308"/>
 274       <member name="y800"
 275               value="28"
 276               c:identifier="GST_VIDEO_FORMAT_Y800"
 277               glib:nick="y800"/>
 278       <member name="y16"
 279               value="29"
 280               c:identifier="GST_VIDEO_FORMAT_Y16"
 281               glib:nick="y16"/>
 282       <member name="rgb16"
 283               value="30"
 284               c:identifier="GST_VIDEO_FORMAT_RGB16"
 285               glib:nick="rgb16"/>
 286       <member name="bgr16"
 287               value="31"
 288               c:identifier="GST_VIDEO_FORMAT_BGR16"
 289               glib:nick="bgr16"/>
 290       <member name="rgb15"
 291               value="32"
 292               c:identifier="GST_VIDEO_FORMAT_RGB15"
 293               glib:nick="rgb15"/>
 294       <member name="bgr15"
 295               value="33"
 296               c:identifier="GST_VIDEO_FORMAT_BGR15"
 297               glib:nick="bgr15"/>
 298       <member name="uyvp"
 299               value="34"
 300               c:identifier="GST_VIDEO_FORMAT_UYVP"
 301               glib:nick="uyvp"/>
 302       <member name="a420"
 303               value="35"
 304               c:identifier="GST_VIDEO_FORMAT_A420"
 305               glib:nick="a420"/>
 306       <member name="rgb8_paletted"
 307               value="36"
 308               c:identifier="GST_VIDEO_FORMAT_RGB8_PALETTED"
 309               glib:nick="rgb8-paletted"/>
 310       <member name="yuv9"
 311               value="37"
 312               c:identifier="GST_VIDEO_FORMAT_YUV9"
 313               glib:nick="yuv9"/>
 314       <member name="yvu9"
 315               value="38"
 316               c:identifier="GST_VIDEO_FORMAT_YVU9"
 317               glib:nick="yvu9"/>
 318       <member name="iyu1"
 319               value="39"
 320               c:identifier="GST_VIDEO_FORMAT_IYU1"
 321               glib:nick="iyu1"/>
 322     </enumeration>
 323     <record name="VideoRectangle" c:type="GstVideoRectangle">
 324       <doc xml:whitespace="preserve">Helper structure representing a rectangular area.</doc>
 325       <field name="x" writable="1">
 326         <type name="gint" c:type="gint"/>
 327       </field>
 328       <field name="y" writable="1">
 329         <type name="gint" c:type="gint"/>
 330       </field>
 331       <field name="w" writable="1">
 332         <type name="gint" c:type="gint"/>
 333       </field>
 334       <field name="h" writable="1">
 335         <type name="gint" c:type="gint"/>
 336       </field>
 337     </record>
 338     <class name="VideoSink"
 339            c:symbol-prefix="video_sink"
 340            c:type="GstVideoSink"
 341            parent="GstBase.BaseSink"
 342            glib:type-name="GstVideoSink"
 343            glib:get-type="gst_video_sink_get_type"
 344            glib:type-struct="VideoSinkClass">
 345       <doc xml:whitespace="preserve">The video sink instance structure. Derived video sinks should set the</doc>
 346       <function name="center_rect" c:identifier="gst_video_sink_center_rect">
 347         <doc xml:whitespace="preserve">Takes @src rectangle and position it at the center of @dst rectangle with or
 348 without @scaling. It handles clipping if the @src rectangle is bigger than
 349 the @dst one and @scaling is set to FALSE.</doc>
 350         <return-value transfer-ownership="none">
 351           <type name="none" c:type="void"/>
 352         </return-value>
 353         <parameters>
 354           <parameter name="src" transfer-ownership="none">
 355             <doc xml:whitespace="preserve">the #GstVideoRectangle describing the source area</doc>
 356             <type name="VideoRectangle" c:type="GstVideoRectangle"/>
 357           </parameter>
 358           <parameter name="dst" transfer-ownership="none">
 359             <doc xml:whitespace="preserve">the #GstVideoRectangle describing the destination area</doc>
 360             <type name="VideoRectangle" c:type="GstVideoRectangle"/>
 361           </parameter>
 362           <parameter name="result" transfer-ownership="none">
 363             <doc xml:whitespace="preserve">a pointer to a #GstVideoRectangle which will receive the result area</doc>
 364             <type name="VideoRectangle" c:type="GstVideoRectangle*"/>
 365           </parameter>
 366           <parameter name="scaling" transfer-ownership="none">
 367             <doc xml:whitespace="preserve">a #gboolean indicating if scaling should be applied or not</doc>
 368             <type name="gboolean" c:type="gboolean"/>
 369           </parameter>
 370         </parameters>
 371       </function>
 372       <virtual-method name="show_frame">
 373         <return-value transfer-ownership="none">
 374           <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
 375         </return-value>
 376         <parameters>
 377           <parameter name="buf" transfer-ownership="none">
 378             <type name="Gst.Buffer" c:type="GstBuffer*"/>
 379           </parameter>
 380         </parameters>
 381       </virtual-method>
 382       <property name="show-preroll-frame"
 383                 writable="1"
 384                 construct="1"
 385                 transfer-ownership="none">
 386         <type name="gboolean"/>
 387       </property>
 388       <field name="element">
 389         <type name="GstBase.BaseSink" c:type="GstBaseSink"/>
 390       </field>
 391       <field name="width">
 392         <type name="gint" c:type="gint"/>
 393       </field>
 394       <field name="height">
 395         <type name="gint" c:type="gint"/>
 396       </field>
 397       <field name="priv">
 398         <type name="VideoSinkPrivate" c:type="GstVideoSinkPrivate*"/>
 399       </field>
 400       <field name="_gst_reserved">
 401         <array zero-terminated="0" c:type="gpointer" fixed-size="3">
 402           <type name="gpointer" c:type="gpointer"/>
 403         </array>
 404       </field>
 405     </class>
 406     <record name="VideoSinkClass"
 407             c:type="GstVideoSinkClass"
 408             glib:is-gtype-struct-for="VideoSink">
 409       <doc xml:whitespace="preserve">The video sink class structure. Derived classes should override the</doc>
 410       <field name="parent_class">
 411         <type name="GstBase.BaseSinkClass" c:type="GstBaseSinkClass"/>
 412       </field>
 413       <field name="show_frame">
 414         <callback name="show_frame">
 415           <return-value transfer-ownership="none">
 416             <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
 417           </return-value>
 418           <parameters>
 419             <parameter name="video_sink" transfer-ownership="none">
 420               <type name="VideoSink" c:type="GstVideoSink*"/>
 421             </parameter>
 422             <parameter name="buf" transfer-ownership="none">
 423               <type name="Gst.Buffer" c:type="GstBuffer*"/>
 424             </parameter>
 425           </parameters>
 426         </callback>
 427       </field>
 428       <field name="_gst_reserved">
 429         <array zero-terminated="0" c:type="gpointer" fixed-size="3">
 430           <type name="gpointer" c:type="gpointer"/>
 431         </array>
 432       </field>
 433     </record>
 434     <record name="VideoSinkPrivate" c:type="GstVideoSinkPrivate" disguised="1">
 435     </record>
 436     <function name="video_calculate_display_ratio"
 437               c:identifier="gst_video_calculate_display_ratio"
 438               version="0.10.7">
 439       <doc xml:whitespace="preserve">Given the Pixel Aspect Ratio and size of an input video frame, and the
 440 pixel aspect ratio of the intended display device, calculates the actual
 441 display ratio the video will be rendered with.
 442 dar_n and dar_d parameters.
 443 The return value is FALSE in the case of integer overflow or other error.</doc>
 444       <return-value transfer-ownership="none">
 445         <doc xml:whitespace="preserve">A boolean indicating success and a calculated Display Ratio in the</doc>
 446         <type name="gboolean" c:type="gboolean"/>
 447       </return-value>
 448       <parameters>
 449         <parameter name="dar_n" transfer-ownership="none">
 450           <doc xml:whitespace="preserve">Numerator of the calculated display_ratio</doc>
 451           <type name="guint" c:type="guint*"/>
 452         </parameter>
 453         <parameter name="dar_d" transfer-ownership="none">
 454           <doc xml:whitespace="preserve">Denominator of the calculated display_ratio</doc>
 455           <type name="guint" c:type="guint*"/>
 456         </parameter>
 457         <parameter name="video_width" transfer-ownership="none">
 458           <doc xml:whitespace="preserve">Width of the video frame in pixels</doc>
 459           <type name="guint" c:type="guint"/>
 460         </parameter>
 461         <parameter name="video_height" transfer-ownership="none">
 462           <doc xml:whitespace="preserve">Height of the video frame in pixels</doc>
 463           <type name="guint" c:type="guint"/>
 464         </parameter>
 465         <parameter name="video_par_n" transfer-ownership="none">
 466           <doc xml:whitespace="preserve">Numerator of the pixel aspect ratio of the input video.</doc>
 467           <type name="guint" c:type="guint"/>
 468         </parameter>
 469         <parameter name="video_par_d" transfer-ownership="none">
 470           <doc xml:whitespace="preserve">Denominator of the pixel aspect ratio of the input video.</doc>
 471           <type name="guint" c:type="guint"/>
 472         </parameter>
 473         <parameter name="display_par_n" transfer-ownership="none">
 474           <doc xml:whitespace="preserve">Numerator of the pixel aspect ratio of the display device</doc>
 475           <type name="guint" c:type="guint"/>
 476         </parameter>
 477         <parameter name="display_par_d" transfer-ownership="none">
 478           <doc xml:whitespace="preserve">Denominator of the pixel aspect ratio of the display device</doc>
 479           <type name="guint" c:type="guint"/>
 480         </parameter>
 481       </parameters>
 482     </function>
 483     <function name="video_convert_frame"
 484               c:identifier="gst_video_convert_frame"
 485               version="0.10.31"
 486               introspectable="0"
 487               throws="1">
 488       <doc xml:whitespace="preserve">Converts a raw video buffer into the specified output caps.
 489 The output caps can be any raw video formats or any image formats (jpeg, png, ...).
 490 The width, height and pixel-aspect-ratio can also be specified in the output caps.
 491 will point to the #GError).</doc>
 492       <return-value>
 493         <doc xml:whitespace="preserve">The converted #GstBuffer, or %NULL if an error happened (in which case @err</doc>
 494         <type name="Gst.Buffer" c:type="GstBuffer*"/>
 495       </return-value>
 496       <parameters>
 497         <parameter name="buf" transfer-ownership="none">
 498           <doc xml:whitespace="preserve">a #GstBuffer</doc>
 499           <type name="Gst.Buffer" c:type="GstBuffer*"/>
 500         </parameter>
 501         <parameter name="to_caps" transfer-ownership="none">
 502           <doc xml:whitespace="preserve">the #GstCaps to convert to</doc>
 503           <type name="Gst.Caps" c:type="GstCaps*"/>
 504         </parameter>
 505         <parameter name="timeout" transfer-ownership="none">
 506           <doc xml:whitespace="preserve">the maximum amount of time allowed for the processing.</doc>
 507           <type name="Gst.ClockTime" c:type="GstClockTime"/>
 508         </parameter>
 509       </parameters>
 510     </function>
 511     <function name="video_convert_frame_async"
 512               c:identifier="gst_video_convert_frame_async"
 513               version="0.10.31">
 514       <doc xml:whitespace="preserve">Converts a raw video buffer into the specified output caps.
 515 The output caps can be any raw video formats or any image formats (jpeg, png, ...).
 516 The width, height and pixel-aspect-ratio can also be specified in the output caps.
 517 finish after @timeout. @callback will always be called from the thread default
 518 %GMainContext, see g_main_context_get_thread_default(). If GLib before 2.22 is used,
 519 this will always be the global default main context.
 520 anymore.</doc>
 521       <return-value transfer-ownership="none">
 522         <type name="none" c:type="void"/>
 523       </return-value>
 524       <parameters>
 525         <parameter name="buf" transfer-ownership="none">
 526           <doc xml:whitespace="preserve">a #GstBuffer</doc>
 527           <type name="Gst.Buffer" c:type="GstBuffer*"/>
 528         </parameter>
 529         <parameter name="to_caps" transfer-ownership="none">
 530           <doc xml:whitespace="preserve">the #GstCaps to convert to</doc>
 531           <type name="Gst.Caps" c:type="GstCaps*"/>
 532         </parameter>
 533         <parameter name="timeout" transfer-ownership="none">
 534           <doc xml:whitespace="preserve">the maximum amount of time allowed for the processing.</doc>
 535           <type name="Gst.ClockTime" c:type="GstClockTime"/>
 536         </parameter>
 537         <parameter name="callback"
 538                    transfer-ownership="none"
 539                    scope="notified"
 540                    closure="4"
 541                    destroy="5">
 542           <doc xml:whitespace="preserve">%GstVideoConvertFrameCallback that will be called after conversion.</doc>
 543           <type name="VideoConvertFrameCallback"
 544                 c:type="GstVideoConvertFrameCallback"/>
 545         </parameter>
 546         <parameter name="user_data" transfer-ownership="none">
 547           <type name="gpointer" c:type="gpointer"/>
 548         </parameter>
 549         <parameter name="destroy_notify"
 550                    transfer-ownership="none"
 551                    scope="async">
 552           <doc xml:whitespace="preserve">%GDestroyNotify to be called after @user_data is not needed anymore</doc>
 553           <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
 554         </parameter>
 555       </parameters>
 556     </function>
 557     <function name="video_event_new_still_frame"
 558               c:identifier="gst_video_event_new_still_frame"
 559               version="0.10.26"
 560               introspectable="0">
 561       <doc xml:whitespace="preserve">Creates a new Still Frame event. If @in_still is %TRUE, then the event
 562 represents the start of a still frame sequence. If it is %FALSE, then
 563 the event ends a still frame sequence.
 564 To parse an event created by gst_video_event_new_still_frame() use
 565 gst_video_event_parse_still_frame().</doc>
 566       <return-value>
 567         <doc xml:whitespace="preserve">The new GstEvent</doc>
 568         <type name="Gst.Event" c:type="GstEvent*"/>
 569       </return-value>
 570       <parameters>
 571         <parameter name="in_still" transfer-ownership="none">
 572           <doc xml:whitespace="preserve">boolean value for the still-frame state of the event.</doc>
 573           <type name="gboolean" c:type="gboolean"/>
 574         </parameter>
 575       </parameters>
 576     </function>
 577     <function name="video_event_parse_still_frame"
 578               c:identifier="gst_video_event_parse_still_frame"
 579               version="0.10.26">
 580       <doc xml:whitespace="preserve">Parse a #GstEvent, identify if it is a Still Frame event, and
 581 return the still-frame state from the event if it is.
 582 If the event represents the start of a still frame, the in_still
 583 variable will be set to TRUE, otherwise FALSE. It is OK to pass NULL for the
 584 in_still variable order to just check whether the event is a valid still-frame
 585 event.
 586 Create a still frame event using gst_video_event_new_still_frame()</doc>
 587       <return-value transfer-ownership="none">
 588         <doc xml:whitespace="preserve">%TRUE if the event is a valid still-frame event. %FALSE if not</doc>
 589         <type name="gboolean" c:type="gboolean"/>
 590       </return-value>
 591       <parameters>
 592         <parameter name="event" transfer-ownership="none">
 593           <doc xml:whitespace="preserve">A #GstEvent to parse</doc>
 594           <type name="Gst.Event" c:type="GstEvent*"/>
 595         </parameter>
 596         <parameter name="in_still" transfer-ownership="none">
 597           <doc xml:whitespace="preserve">A boolean to receive the still-frame status from the event, or NULL</doc>
 598           <type name="gboolean" c:type="gboolean*"/>
 599         </parameter>
 600       </parameters>
 601     </function>
 602     <function name="video_format_convert"
 603               c:identifier="gst_video_format_convert"
 604               version="0.10.16">
 605       <doc xml:whitespace="preserve">Converts among various #GstFormat types.  This function handles
 606 GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT.  For
 607 raw video, GST_FORMAT_DEFAULT corresponds to video frames.  This
 608 function can be to handle pad queries of the type GST_QUERY_CONVERT.</doc>
 609       <return-value transfer-ownership="none">
 610         <doc xml:whitespace="preserve">TRUE if the conversion was successful.</doc>
 611         <type name="gboolean" c:type="gboolean"/>
 612       </return-value>
 613       <parameters>
 614         <parameter name="format" transfer-ownership="none">
 615           <doc xml:whitespace="preserve">a #GstVideoFormat</doc>
 616           <type name="VideoFormat" c:type="GstVideoFormat"/>
 617         </parameter>
 618         <parameter name="width" transfer-ownership="none">
 619           <doc xml:whitespace="preserve">the width of video</doc>
 620           <type name="gint" c:type="int"/>
 621         </parameter>
 622         <parameter name="height" transfer-ownership="none">
 623           <doc xml:whitespace="preserve">the height of video</doc>
 624           <type name="gint" c:type="int"/>
 625         </parameter>
 626         <parameter name="fps_n" transfer-ownership="none">
 627           <doc xml:whitespace="preserve">frame rate numerator</doc>
 628           <type name="gint" c:type="int"/>
 629         </parameter>
 630         <parameter name="fps_d" transfer-ownership="none">
 631           <doc xml:whitespace="preserve">frame rate denominator</doc>
 632           <type name="gint" c:type="int"/>
 633         </parameter>
 634         <parameter name="src_format" transfer-ownership="none">
 635           <doc xml:whitespace="preserve">#GstFormat of the @src_value</doc>
 636           <type name="Gst.Format" c:type="GstFormat"/>
 637         </parameter>
 638         <parameter name="src_value" transfer-ownership="none">
 639           <doc xml:whitespace="preserve">value to convert</doc>
 640           <type name="gint64" c:type="gint64"/>
 641         </parameter>
 642         <parameter name="dest_format" transfer-ownership="none">
 643           <doc xml:whitespace="preserve">#GstFormat of the @dest_value</doc>
 644           <type name="Gst.Format" c:type="GstFormat"/>
 645         </parameter>
 646         <parameter name="dest_value" transfer-ownership="none">
 647           <doc xml:whitespace="preserve">pointer to destination value</doc>
 648           <type name="gint64" c:type="gint64*"/>
 649         </parameter>
 650       </parameters>
 651     </function>
 652     <function name="video_format_from_fourcc"
 653               c:identifier="gst_video_format_from_fourcc"
 654               version="0.10.16">
 655       <doc xml:whitespace="preserve">Converts a FOURCC value into the corresponding #GstVideoFormat.
 656 If the FOURCC cannot be represented by #GstVideoFormat,
 657 #GST_VIDEO_FORMAT_UNKNOWN is returned.</doc>
 658       <return-value transfer-ownership="none">
 659         <doc xml:whitespace="preserve">the #GstVideoFormat describing the FOURCC value</doc>
 660         <type name="VideoFormat" c:type="GstVideoFormat"/>
 661       </return-value>
 662       <parameters>
 663         <parameter name="fourcc" transfer-ownership="none">
 664           <doc xml:whitespace="preserve">a FOURCC value representing raw YUV video</doc>
 665           <type name="guint32" c:type="guint32"/>
 666         </parameter>
 667       </parameters>
 668     </function>
 669     <function name="video_format_get_component_height"
 670               c:identifier="gst_video_format_get_component_height"
 671               version="0.10.16">
 672       <doc xml:whitespace="preserve">Calculates the height of the component.  See
 673 of the component index.</doc>
 674       <return-value transfer-ownership="none">
 675         <doc xml:whitespace="preserve">height of component @component</doc>
 676         <type name="gint" c:type="int"/>
 677       </return-value>
 678       <parameters>
 679         <parameter name="format" transfer-ownership="none">
 680           <doc xml:whitespace="preserve">a #GstVideoFormat</doc>
 681           <type name="VideoFormat" c:type="GstVideoFormat"/>
 682         </parameter>
 683         <parameter name="component" transfer-ownership="none">
 684           <doc xml:whitespace="preserve">the component index</doc>
 685           <type name="gint" c:type="int"/>
 686         </parameter>
 687         <parameter name="height" transfer-ownership="none">
 688           <doc xml:whitespace="preserve">the height of video</doc>
 689           <type name="gint" c:type="int"/>
 690         </parameter>
 691       </parameters>
 692     </function>
 693     <function name="video_format_get_component_offset"
 694               c:identifier="gst_video_format_get_component_offset"
 695               version="0.10.16">
 696       <doc xml:whitespace="preserve">Calculates the offset (in bytes) of the first pixel of the component
 697 with index @component.  For packed formats, this will typically be a
 698 small integer (0, 1, 2, 3).  For planar formats, this will be a
 699 (relatively) large offset to the beginning of the second or third
 700 component planes.  See @gst_video_format_get_row_stride for a description
 701 of the component index.</doc>
 702       <return-value transfer-ownership="none">
 703         <doc xml:whitespace="preserve">offset of component @component</doc>
 704         <type name="gint" c:type="int"/>
 705       </return-value>
 706       <parameters>
 707         <parameter name="format" transfer-ownership="none">
 708           <doc xml:whitespace="preserve">a #GstVideoFormat</doc>
 709           <type name="VideoFormat" c:type="GstVideoFormat"/>
 710         </parameter>
 711         <parameter name="component" transfer-ownership="none">
 712           <doc xml:whitespace="preserve">the component index</doc>
 713           <type name="gint" c:type="int"/>
 714         </parameter>
 715         <parameter name="width" transfer-ownership="none">
 716           <doc xml:whitespace="preserve">the width of video</doc>
 717           <type name="gint" c:type="int"/>
 718         </parameter>
 719         <parameter name="height" transfer-ownership="none">
 720           <doc xml:whitespace="preserve">the height of video</doc>
 721           <type name="gint" c:type="int"/>
 722         </parameter>
 723       </parameters>
 724     </function>
 725     <function name="video_format_get_component_width"
 726               c:identifier="gst_video_format_get_component_width"
 727               version="0.10.16">
 728       <doc xml:whitespace="preserve">Calculates the width of the component.  See
 729 of the component index.</doc>
 730       <return-value transfer-ownership="none">
 731         <doc xml:whitespace="preserve">width of component @component</doc>
 732         <type name="gint" c:type="int"/>
 733       </return-value>
 734       <parameters>
 735         <parameter name="format" transfer-ownership="none">
 736           <doc xml:whitespace="preserve">a #GstVideoFormat</doc>
 737           <type name="VideoFormat" c:type="GstVideoFormat"/>
 738         </parameter>
 739         <parameter name="component" transfer-ownership="none">
 740           <doc xml:whitespace="preserve">the component index</doc>
 741           <type name="gint" c:type="int"/>
 742         </parameter>
 743         <parameter name="width" transfer-ownership="none">
 744           <doc xml:whitespace="preserve">the width of video</doc>
 745           <type name="gint" c:type="int"/>
 746         </parameter>
 747       </parameters>
 748     </function>
 749     <function name="video_format_get_pixel_stride"
 750               c:identifier="gst_video_format_get_pixel_stride"
 751               version="0.10.16">
 752       <doc xml:whitespace="preserve">Calculates the pixel stride (number of bytes from one pixel to the
 753 pixel to its immediate left) for the video component with an index
 754 of @component.  See @gst_video_format_get_row_stride for a description
 755 of the component index.</doc>
 756       <return-value transfer-ownership="none">
 757         <doc xml:whitespace="preserve">pixel stride of component @component</doc>
 758         <type name="gint" c:type="int"/>
 759       </return-value>
 760       <parameters>
 761         <parameter name="format" transfer-ownership="none">
 762           <doc xml:whitespace="preserve">a #GstVideoFormat</doc>
 763           <type name="VideoFormat" c:type="GstVideoFormat"/>
 764         </parameter>
 765         <parameter name="component" transfer-ownership="none">
 766           <doc xml:whitespace="preserve">the component index</doc>
 767           <type name="gint" c:type="int"/>
 768         </parameter>
 769       </parameters>
 770     </function>
 771     <function name="video_format_get_row_stride"
 772               c:identifier="gst_video_format_get_row_stride"
 773               version="0.10.16">
 774       <doc xml:whitespace="preserve">Calculates the row stride (number of bytes from one row of pixels to
 775 the next) for the video component with an index of @component.  For
 776 YUV video, Y, U, and V have component indices of 0, 1, and 2,
 777 respectively.  For RGB video, R, G, and B have component indicies of
 778 0, 1, and 2, respectively.  Alpha channels, if present, have a component
 779 index of 3.  The @width parameter always represents the width of the
 780 video, not the component.</doc>
 781       <return-value transfer-ownership="none">
 782         <doc xml:whitespace="preserve">row stride of component @component</doc>
 783         <type name="gint" c:type="int"/>
 784       </return-value>
 785       <parameters>
 786         <parameter name="format" transfer-ownership="none">
 787           <doc xml:whitespace="preserve">a #GstVideoFormat</doc>
 788           <type name="VideoFormat" c:type="GstVideoFormat"/>
 789         </parameter>
 790         <parameter name="component" transfer-ownership="none">
 791           <doc xml:whitespace="preserve">the component index</doc>
 792           <type name="gint" c:type="int"/>
 793         </parameter>
 794         <parameter name="width" transfer-ownership="none">
 795           <doc xml:whitespace="preserve">the width of video</doc>
 796           <type name="gint" c:type="int"/>
 797         </parameter>
 798       </parameters>
 799     </function>
 800     <function name="video_format_get_size"
 801               c:identifier="gst_video_format_get_size"
 802               version="0.10.16">
 803       <doc xml:whitespace="preserve">Calculates the total number of bytes in the raw video format.  This
 804 number should be used when allocating a buffer for raw video.</doc>
 805       <return-value transfer-ownership="none">
 806         <doc xml:whitespace="preserve">size (in bytes) of raw video format</doc>
 807         <type name="gint" c:type="int"/>
 808       </return-value>
 809       <parameters>
 810         <parameter name="format" transfer-ownership="none">
 811           <doc xml:whitespace="preserve">a #GstVideoFormat</doc>
 812           <type name="VideoFormat" c:type="GstVideoFormat"/>
 813         </parameter>
 814         <parameter name="width" transfer-ownership="none">
 815           <doc xml:whitespace="preserve">the width of video</doc>
 816           <type name="gint" c:type="int"/>
 817         </parameter>
 818         <parameter name="height" transfer-ownership="none">
 819           <doc xml:whitespace="preserve">the height of video</doc>
 820           <type name="gint" c:type="int"/>
 821         </parameter>
 822       </parameters>
 823     </function>
 824     <function name="video_format_has_alpha"
 825               c:identifier="gst_video_format_has_alpha"
 826               version="0.10.16">
 827       <doc xml:whitespace="preserve">Returns TRUE or FALSE depending on if the video format provides an
 828 alpha channel.</doc>
 829       <return-value transfer-ownership="none">
 830         <doc xml:whitespace="preserve">TRUE if @format has an alpha channel</doc>
 831         <type name="gboolean" c:type="gboolean"/>
 832       </return-value>
 833       <parameters>
 834         <parameter name="format" transfer-ownership="none">
 835           <doc xml:whitespace="preserve">a #GstVideoFormat</doc>
 836           <type name="VideoFormat" c:type="GstVideoFormat"/>
 837         </parameter>
 838       </parameters>
 839     </function>
 840     <function name="video_format_is_gray"
 841               c:identifier="gst_video_format_is_gray"
 842               version="0.10.29">
 843       <doc xml:whitespace="preserve">Determine whether the video format is a grayscale format.</doc>
 844       <return-value transfer-ownership="none">
 845         <doc xml:whitespace="preserve">TRUE if @format represents grayscale video</doc>
 846         <type name="gboolean" c:type="gboolean"/>
 847       </return-value>
 848       <parameters>
 849         <parameter name="format" transfer-ownership="none">
 850           <doc xml:whitespace="preserve">a #GstVideoFormat</doc>
 851           <type name="VideoFormat" c:type="GstVideoFormat"/>
 852         </parameter>
 853       </parameters>
 854     </function>
 855     <function name="video_format_is_rgb"
 856               c:identifier="gst_video_format_is_rgb"
 857               version="0.10.16">
 858       <doc xml:whitespace="preserve">Determine whether the video format is an RGB format.</doc>
 859       <return-value transfer-ownership="none">
 860         <doc xml:whitespace="preserve">TRUE if @format represents RGB video</doc>
 861         <type name="gboolean" c:type="gboolean"/>
 862       </return-value>
 863       <parameters>
 864         <parameter name="format" transfer-ownership="none">
 865           <doc xml:whitespace="preserve">a #GstVideoFormat</doc>
 866           <type name="VideoFormat" c:type="GstVideoFormat"/>
 867         </parameter>
 868       </parameters>
 869     </function>
 870     <function name="video_format_is_yuv"
 871               c:identifier="gst_video_format_is_yuv"
 872               version="0.10.16">
 873       <doc xml:whitespace="preserve">Determine whether the video format is a YUV format.</doc>
 874       <return-value transfer-ownership="none">
 875         <doc xml:whitespace="preserve">TRUE if @format represents YUV video</doc>
 876         <type name="gboolean" c:type="gboolean"/>
 877       </return-value>
 878       <parameters>
 879         <parameter name="format" transfer-ownership="none">
 880           <doc xml:whitespace="preserve">a #GstVideoFormat</doc>
 881           <type name="VideoFormat" c:type="GstVideoFormat"/>
 882         </parameter>
 883       </parameters>
 884     </function>
 885     <function name="video_format_new_caps"
 886               c:identifier="gst_video_format_new_caps"
 887               version="0.10.16">
 888       <doc xml:whitespace="preserve">Creates a new #GstCaps object based on the parameters provided.</doc>
 889       <return-value transfer-ownership="full">
 890         <doc xml:whitespace="preserve">a new #GstCaps object, or NULL if there was an error</doc>
 891         <type name="Gst.Caps" c:type="GstCaps*"/>
 892       </return-value>
 893       <parameters>
 894         <parameter name="format" transfer-ownership="none">
 895           <doc xml:whitespace="preserve">the #GstVideoFormat describing the raw video format</doc>
 896           <type name="VideoFormat" c:type="GstVideoFormat"/>
 897         </parameter>
 898         <parameter name="width" transfer-ownership="none">
 899           <doc xml:whitespace="preserve">width of video</doc>
 900           <type name="gint" c:type="int"/>
 901         </parameter>
 902         <parameter name="height" transfer-ownership="none">
 903           <doc xml:whitespace="preserve">height of video</doc>
 904           <type name="gint" c:type="int"/>
 905         </parameter>
 906         <parameter name="framerate_n" transfer-ownership="none">
 907           <doc xml:whitespace="preserve">numerator of frame rate</doc>
 908           <type name="gint" c:type="int"/>
 909         </parameter>
 910         <parameter name="framerate_d" transfer-ownership="none">
 911           <doc xml:whitespace="preserve">denominator of frame rate</doc>
 912           <type name="gint" c:type="int"/>
 913         </parameter>
 914         <parameter name="par_n" transfer-ownership="none">
 915           <doc xml:whitespace="preserve">numerator of pixel aspect ratio</doc>
 916           <type name="gint" c:type="int"/>
 917         </parameter>
 918         <parameter name="par_d" transfer-ownership="none">
 919           <doc xml:whitespace="preserve">denominator of pixel aspect ratio</doc>
 920           <type name="gint" c:type="int"/>
 921         </parameter>
 922       </parameters>
 923     </function>
 924     <function name="video_format_new_caps_interlaced"
 925               c:identifier="gst_video_format_new_caps_interlaced"
 926               version="0.10.23">
 927       <doc xml:whitespace="preserve">Creates a new #GstCaps object based on the parameters provided.</doc>
 928       <return-value transfer-ownership="full">
 929         <doc xml:whitespace="preserve">a new #GstCaps object, or NULL if there was an error</doc>
 930         <type name="Gst.Caps" c:type="GstCaps*"/>
 931       </return-value>
 932       <parameters>
 933         <parameter name="format" transfer-ownership="none">
 934           <doc xml:whitespace="preserve">the #GstVideoFormat describing the raw video format</doc>
 935           <type name="VideoFormat" c:type="GstVideoFormat"/>
 936         </parameter>
 937         <parameter name="width" transfer-ownership="none">
 938           <doc xml:whitespace="preserve">width of video</doc>
 939           <type name="gint" c:type="int"/>
 940         </parameter>
 941         <parameter name="height" transfer-ownership="none">
 942           <doc xml:whitespace="preserve">height of video</doc>
 943           <type name="gint" c:type="int"/>
 944         </parameter>
 945         <parameter name="framerate_n" transfer-ownership="none">
 946           <doc xml:whitespace="preserve">numerator of frame rate</doc>
 947           <type name="gint" c:type="int"/>
 948         </parameter>
 949         <parameter name="framerate_d" transfer-ownership="none">
 950           <doc xml:whitespace="preserve">denominator of frame rate</doc>
 951           <type name="gint" c:type="int"/>
 952         </parameter>
 953         <parameter name="par_n" transfer-ownership="none">
 954           <doc xml:whitespace="preserve">numerator of pixel aspect ratio</doc>
 955           <type name="gint" c:type="int"/>
 956         </parameter>
 957         <parameter name="par_d" transfer-ownership="none">
 958           <doc xml:whitespace="preserve">denominator of pixel aspect ratio</doc>
 959           <type name="gint" c:type="int"/>
 960         </parameter>
 961         <parameter name="interlaced" transfer-ownership="none">
 962           <doc xml:whitespace="preserve">#TRUE if the format is interlaced</doc>
 963           <type name="gboolean" c:type="gboolean"/>
 964         </parameter>
 965       </parameters>
 966     </function>
 967     <function name="video_format_parse_caps"
 968               c:identifier="gst_video_format_parse_caps"
 969               version="0.10.16">
 970       <doc xml:whitespace="preserve">Determines the #GstVideoFormat of @caps and places it in the location
 971 pointed to by @format.  Extracts the size of the video and places it
 972 in the location pointed to by @width and @height.  If @caps does not
 973 represent one of the raw video formats listed in #GstVideoFormat, the
 974 function will fail and return FALSE.</doc>
 975       <return-value transfer-ownership="none">
 976         <doc xml:whitespace="preserve">TRUE if @caps was parsed correctly.</doc>
 977         <type name="gboolean" c:type="gboolean"/>
 978       </return-value>
 979       <parameters>
 980         <parameter name="caps" transfer-ownership="none">
 981           <doc xml:whitespace="preserve">the #GstCaps to parse</doc>
 982           <type name="Gst.Caps" c:type="GstCaps*"/>
 983         </parameter>
 984         <parameter name="format" transfer-ownership="none">
 985           <doc xml:whitespace="preserve">the #GstVideoFormat of the video represented by @caps (output)</doc>
 986           <type name="VideoFormat" c:type="GstVideoFormat*"/>
 987         </parameter>
 988         <parameter name="width" transfer-ownership="none">
 989           <doc xml:whitespace="preserve">the width of the video represented by @caps, may be NULL (output)</doc>
 990           <type name="gint" c:type="int*"/>
 991         </parameter>
 992         <parameter name="height" transfer-ownership="none">
 993           <doc xml:whitespace="preserve">the height of the video represented by @caps, may be NULL (output)</doc>
 994           <type name="gint" c:type="int*"/>
 995         </parameter>
 996       </parameters>
 997     </function>
 998     <function name="video_format_parse_caps_interlaced"
 999               c:identifier="gst_video_format_parse_caps_interlaced"
1000               version="0.10.23">
1001       <doc xml:whitespace="preserve">Extracts whether the caps represents interlaced content or not and places it
1002 in @interlaced.</doc>
1003       <return-value transfer-ownership="none">
1004         <doc xml:whitespace="preserve">TRUE if @caps was parsed correctly.</doc>
1005         <type name="gboolean" c:type="gboolean"/>
1006       </return-value>
1007       <parameters>
1008         <parameter name="caps" transfer-ownership="none">
1009           <doc xml:whitespace="preserve">the fixed #GstCaps to parse</doc>
1010           <type name="Gst.Caps" c:type="GstCaps*"/>
1011         </parameter>
1012         <parameter name="interlaced" transfer-ownership="none">
1013           <doc xml:whitespace="preserve">whether @caps represents interlaced video or not, may be NULL (output)</doc>
1014           <type name="gboolean" c:type="gboolean*"/>
1015         </parameter>
1016       </parameters>
1017     </function>
1018     <function name="video_format_to_fourcc"
1019               c:identifier="gst_video_format_to_fourcc"
1020               version="0.10.16">
1021       <doc xml:whitespace="preserve">Converts a #GstVideoFormat value into the corresponding FOURCC.  Only
1022 a few YUV formats have corresponding FOURCC values.  If @format has
1023 no corresponding FOURCC value, 0 is returned.</doc>
1024       <return-value transfer-ownership="none">
1025         <doc xml:whitespace="preserve">the FOURCC corresponding to @format</doc>
1026         <type name="guint32" c:type="guint32"/>
1027       </return-value>
1028       <parameters>
1029         <parameter name="format" transfer-ownership="none">
1030           <doc xml:whitespace="preserve">a #GstVideoFormat video format</doc>
1031           <type name="VideoFormat" c:type="GstVideoFormat"/>
1032         </parameter>
1033       </parameters>
1034     </function>
1035     <function name="video_frame_rate" c:identifier="gst_video_frame_rate">
1036       <doc xml:whitespace="preserve">A convenience function to retrieve a GValue holding the framerate
1037 from the caps on a pad.
1038 The pad needs to have negotiated caps containing a framerate property.
1039 do not contain a framerate.</doc>
1040       <return-value transfer-ownership="none">
1041         <doc xml:whitespace="preserve">NULL if the pad has no configured caps or the configured caps</doc>
1042         <type name="GObject.Value" c:type="GValue*"/>
1043       </return-value>
1044       <parameters>
1045         <parameter name="pad" transfer-ownership="none">
1046           <doc xml:whitespace="preserve">pointer to a #GstPad</doc>
1047           <type name="Gst.Pad" c:type="GstPad*"/>
1048         </parameter>
1049       </parameters>
1050     </function>
1051     <function name="video_get_size" c:identifier="gst_video_get_size">
1052       <doc xml:whitespace="preserve">Inspect the caps of the provided pad and retrieve the width and height of
1053 the video frames it is configured for.
1054 The pad needs to have negotiated caps containing width and height properties.</doc>
1055       <return-value transfer-ownership="none">
1056         <doc xml:whitespace="preserve">TRUE if the width and height could be retrieved.</doc>
1057         <type name="gboolean" c:type="gboolean"/>
1058       </return-value>
1059       <parameters>
1060         <parameter name="pad" transfer-ownership="none">
1061           <doc xml:whitespace="preserve">pointer to a #GstPad</doc>
1062           <type name="Gst.Pad" c:type="GstPad*"/>
1063         </parameter>
1064         <parameter name="width" transfer-ownership="none">
1065           <doc xml:whitespace="preserve">pointer to integer to hold pixel width of the video frames (output)</doc>
1066           <type name="gint" c:type="gint*"/>
1067         </parameter>
1068         <parameter name="height" transfer-ownership="none">
1069           <doc xml:whitespace="preserve">pointer to integer to hold pixel height of the video frames (output)</doc>
1070           <type name="gint" c:type="gint*"/>
1071         </parameter>
1072       </parameters>
1073     </function>
1074     <function name="video_parse_caps_chroma_site"
1075               c:identifier="gst_video_parse_caps_chroma_site"
1076               version="0.10.29">
1077       <doc xml:whitespace="preserve">Extracts the chroma site used by the caps.  Possible values are
1078 "mpeg2" for MPEG-2 style chroma siting (co-sited horizontally,
1079 halfway-sited vertically), "jpeg" for JPEG and Theora style
1080 chroma siting (halfway-sited both horizontally and vertically).
1081 Other chroma site values are possible, but uncommon.
1082 When no chroma site is specified in the caps, it should be assumed
1083 to be "mpeg2".
1084 determined.</doc>
1085       <return-value transfer-ownership="none">
1086         <doc xml:whitespace="preserve">a chroma site string, or NULL if no chroma site could be</doc>
1087         <type name="utf8" c:type="char*"/>
1088       </return-value>
1089       <parameters>
1090         <parameter name="caps" transfer-ownership="none">
1091           <doc xml:whitespace="preserve">the fixed #GstCaps to parse</doc>
1092           <type name="Gst.Caps" c:type="GstCaps*"/>
1093         </parameter>
1094       </parameters>
1095     </function>
1096     <function name="video_parse_caps_color_matrix"
1097               c:identifier="gst_video_parse_caps_color_matrix"
1098               version="0.10.29">
1099       <doc xml:whitespace="preserve">Extracts the color matrix used by the caps.  Possible values are
1100 "sdtv" for the standard definition color matrix (as specified in
1101 Rec. ITU-R BT.470-6) or "hdtv" for the high definition color
1102 matrix (as specified in Rec. ITU-R BT.709)
1103 determined.</doc>
1104       <return-value transfer-ownership="none">
1105         <doc xml:whitespace="preserve">a color matrix string, or NULL if no color matrix could be</doc>
1106         <type name="utf8" c:type="char*"/>
1107       </return-value>
1108       <parameters>
1109         <parameter name="caps" transfer-ownership="none">
1110           <doc xml:whitespace="preserve">the fixed #GstCaps to parse</doc>
1111           <type name="Gst.Caps" c:type="GstCaps*"/>
1112         </parameter>
1113       </parameters>
1114     </function>
1115     <function name="video_parse_caps_framerate"
1116               c:identifier="gst_video_parse_caps_framerate"
1117               version="0.10.16">
1118       <doc xml:whitespace="preserve">Extracts the frame rate from @caps and places the values in the locations
1119 pointed to by @fps_n and @fps_d.  Returns TRUE if the values could be
1120 parsed correctly, FALSE if not.
1121 This function can be used with #GstCaps that have any media type; it
1122 is not limited to formats handled by #GstVideoFormat.</doc>
1123       <return-value transfer-ownership="none">
1124         <doc xml:whitespace="preserve">TRUE if @caps was parsed correctly.</doc>
1125         <type name="gboolean" c:type="gboolean"/>
1126       </return-value>
1127       <parameters>
1128         <parameter name="caps" transfer-ownership="none">
1129           <doc xml:whitespace="preserve">pointer to a #GstCaps instance</doc>
1130           <type name="Gst.Caps" c:type="GstCaps*"/>
1131         </parameter>
1132         <parameter name="fps_n" transfer-ownership="none">
1133           <doc xml:whitespace="preserve">pointer to integer to hold numerator of frame rate (output)</doc>
1134           <type name="gint" c:type="int*"/>
1135         </parameter>
1136         <parameter name="fps_d" transfer-ownership="none">
1137           <doc xml:whitespace="preserve">pointer to integer to hold denominator of frame rate (output)</doc>
1138           <type name="gint" c:type="int*"/>
1139         </parameter>
1140       </parameters>
1141     </function>
1142     <function name="video_parse_caps_palette"
1143               c:identifier="gst_video_parse_caps_palette"
1144               version="0.10.32"
1145               introspectable="0">
1146       <doc xml:whitespace="preserve">Returns the palette data from the caps as a #GstBuffer. For
1147 #GST_VIDEO_FORMAT_RGB8_PALETTED this is containing 256 #guint32
1148 values, each containing ARGB colors in native endianness.</doc>
1149       <return-value>
1150         <doc xml:whitespace="preserve">a #GstBuffer containing the palette data. Unref after usage.</doc>
1151         <type name="Gst.Buffer" c:type="GstBuffer*"/>
1152       </return-value>
1153       <parameters>
1154         <parameter name="caps" transfer-ownership="none">
1155           <doc xml:whitespace="preserve">#GstCaps to parse</doc>
1156           <type name="Gst.Caps" c:type="GstCaps*"/>
1157         </parameter>
1158       </parameters>
1159     </function>
1160     <function name="video_parse_caps_pixel_aspect_ratio"
1161               c:identifier="gst_video_parse_caps_pixel_aspect_ratio"
1162               version="0.10.16">
1163       <doc xml:whitespace="preserve">Extracts the pixel aspect ratio from @caps and places the values in
1164 the locations pointed to by @par_n and @par_d.  Returns TRUE if the
1165 values could be parsed correctly, FALSE if not.
1166 This function can be used with #GstCaps that have any media type; it
1167 is not limited to formats handled by #GstVideoFormat.</doc>
1168       <return-value transfer-ownership="none">
1169         <doc xml:whitespace="preserve">TRUE if @caps was parsed correctly.</doc>
1170         <type name="gboolean" c:type="gboolean"/>
1171       </return-value>
1172       <parameters>
1173         <parameter name="caps" transfer-ownership="none">
1174           <doc xml:whitespace="preserve">pointer to a #GstCaps instance</doc>
1175           <type name="Gst.Caps" c:type="GstCaps*"/>
1176         </parameter>
1177         <parameter name="par_n" transfer-ownership="none">
1178           <doc xml:whitespace="preserve">pointer to numerator of pixel aspect ratio (output)</doc>
1179           <type name="gint" c:type="int*"/>
1180         </parameter>
1181         <parameter name="par_d" transfer-ownership="none">
1182           <doc xml:whitespace="preserve">pointer to denominator of pixel aspect ratio (output)</doc>
1183           <type name="gint" c:type="int*"/>
1184         </parameter>
1185       </parameters>
1186     </function>
1187   </namespace>
1188 </repository>