/usr/share/doc/gstreamer1.0-vaapi/libs/libs-GstVideoFormat.html is in gstreamer1.0-vaapi-doc 0.5.9-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GStreamer VA-API Plugins 1.4 Library Reference Manual: GstVideoFormat</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GStreamer VA-API Plugins 1.4 Library Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-vaapi Library">
<link rel="prev" href="ch01.html" title="gst-plugins-vaapi Library">
<link rel="next" href="libs-Basic-data-structures.html" title="Basic data structures">
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libs-GstVideoFormat.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libs-Basic-data-structures.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libs-GstVideoFormat"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libs-GstVideoFormat.top_of_page"></a>GstVideoFormat</span></h2>
<p>GstVideoFormat — Video format helpers for VA-API</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libs-GstVideoFormat.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libs-GstVideoFormat.html#gst-vaapi-video-format-to-string" title="gst_vaapi_video_format_to_string ()">gst_vaapi_video_format_to_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GstVideoFormat</span>
</td>
<td class="function_name">
<a class="link" href="libs-GstVideoFormat.html#gst-vaapi-video-format-from-va-format" title="gst_vaapi_video_format_from_va_format ()">gst_vaapi_video_format_from_va_format</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="libs-GstVideoFormat.html#gst-vaapi-video-format-get-chroma-type" title="gst_vaapi_video_format_get_chroma_type ()">gst_vaapi_video_format_get_chroma_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="libs-GstVideoFormat.html#gst-vaapi-video-format-get-score" title="gst_vaapi_video_format_get_score ()">gst_vaapi_video_format_get_score</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libs-GstVideoFormat.html#gst-vaapi-video-format-is-rgb" title="gst_vaapi_video_format_is_rgb ()">gst_vaapi_video_format_is_rgb</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libs-GstVideoFormat.html#gst-vaapi-video-format-is-yuv" title="gst_vaapi_video_format_is_yuv ()">gst_vaapi_video_format_is_yuv</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">VAImageFormat</span> *
</td>
<td class="function_name">
<a class="link" href="libs-GstVideoFormat.html#gst-vaapi-video-format-to-va-format" title="gst_vaapi_video_format_to_va_format ()">gst_vaapi_video_format_to_va_format</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libs-GstVideoFormat.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libs-GstVideoFormat.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gst-vaapi-video-format-to-string"></a><h3>gst_vaapi_video_format_to_string ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gst_vaapi_video_format_to_string (<em class="parameter"><code><span class="type">GstVideoFormat</span> format</code></em>);</pre>
<p>Returns the string representation of the <em class="parameter"><code>format</code></em>
argument.</p>
<div class="refsect3">
<a name="id-1.2.2.5.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>a <span class="type">GstVideoFormat</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.5.2.6"></a><h4>Returns</h4>
<p> string representation of <em class="parameter"><code>format</code></em>
, or <code class="literal">NULL</code> if unknown
or unsupported.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-vaapi-video-format-from-va-format"></a><h3>gst_vaapi_video_format_from_va_format ()</h3>
<pre class="programlisting"><span class="returnvalue">GstVideoFormat</span>
gst_vaapi_video_format_from_va_format (<em class="parameter"><code>const <span class="type">VAImageFormat</span> *va_format</code></em>);</pre>
<p>Converts a VA image format into the corresponding <span class="type">GstVideoFormat</span>.
If the image format cannot be represented by <span class="type">GstVideoFormat</span>,
then zero is returned.</p>
<div class="refsect3">
<a name="id-1.2.2.5.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>va_format</p></td>
<td class="parameter_description"><p>a <span class="type">VAImageFormat</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.5.3.6"></a><h4>Returns</h4>
<p> the <span class="type">GstVideoFormat</span> describing the <em class="parameter"><code>va_format</code></em>
</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-vaapi-video-format-get-chroma-type"></a><h3>gst_vaapi_video_format_get_chroma_type ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
gst_vaapi_video_format_get_chroma_type
(<em class="parameter"><code><span class="type">GstVideoFormat</span> format</code></em>);</pre>
<p>Converts a <span class="type">GstVideoFormat</span> into the corresponding <a class="link" href="libs-gstvaapisurface.html#GstVaapiChromaType" title="enum GstVaapiChromaType"><span class="type">GstVaapiChromaType</span></a>
format.</p>
<div class="refsect3">
<a name="id-1.2.2.5.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>a <span class="type">GstVideoFormat</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.5.4.6"></a><h4>Returns</h4>
<p> the <a class="link" href="libs-gstvaapisurface.html#GstVaapiChromaType" title="enum GstVaapiChromaType"><span class="type">GstVaapiChromaType</span></a> format, or zero if no match
was found.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-vaapi-video-format-get-score"></a><h3>gst_vaapi_video_format_get_score ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
gst_vaapi_video_format_get_score (<em class="parameter"><code><span class="type">GstVideoFormat</span> format</code></em>);</pre>
<p>Determines how "native" is this <em class="parameter"><code>format</code></em>
. The lower is the returned
score, the best format this is for the underlying hardware.</p>
<div class="refsect3">
<a name="id-1.2.2.5.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>a <span class="type">GstVideoFormat</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.5.5.6"></a><h4>Returns</h4>
<p> the <em class="parameter"><code>format</code></em>
score, or <code class="literal">G_MAXUINT</code> if none was found</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-vaapi-video-format-is-rgb"></a><h3>gst_vaapi_video_format_is_rgb ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gst_vaapi_video_format_is_rgb (<em class="parameter"><code><span class="type">GstVideoFormat</span> format</code></em>);</pre>
<p>Checks whether the format is an RGB format.</p>
<div class="refsect3">
<a name="id-1.2.2.5.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>a <span class="type">GstVideoFormat</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.5.6.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>format</code></em>
is RGB format</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-vaapi-video-format-is-yuv"></a><h3>gst_vaapi_video_format_is_yuv ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gst_vaapi_video_format_is_yuv (<em class="parameter"><code><span class="type">GstVideoFormat</span> format</code></em>);</pre>
<p>Checks whether the format is an YUV format.</p>
<div class="refsect3">
<a name="id-1.2.2.5.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>a <span class="type">GstVideoFormat</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.5.7.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>format</code></em>
is YUV format</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-vaapi-video-format-to-va-format"></a><h3>gst_vaapi_video_format_to_va_format ()</h3>
<pre class="programlisting">const <span class="returnvalue">VAImageFormat</span> *
gst_vaapi_video_format_to_va_format (<em class="parameter"><code><span class="type">GstVideoFormat</span> format</code></em>);</pre>
<p>Converts a <span class="type">GstVideoFormat</span> into the corresponding VA image
format. If no matching VA image format was found, <code class="literal">NULL</code> is returned
and this error must be reported to be fixed.</p>
<div class="refsect3">
<a name="id-1.2.2.5.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>a <span class="type">GstVideoFormat</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.5.8.6"></a><h4>Returns</h4>
<p> the VA image format, or <code class="literal">NULL</code> if none was found</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libs-GstVideoFormat.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|