/usr/share/doc/ffmpeg/api/structAVSphericalMapping.html is in ffmpeg-doc 7:3.4.2-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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FFmpeg: AVSphericalMapping Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FFmpeg
 <span id="projectnumber">3.4.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">AVSphericalMapping Struct Reference<div class="ingroups"><a class="el" href="group__lavu.html">libavutil</a> » <a class="el" href="group__lavu__video.html">Video related</a> » <a class="el" href="group__lavu__video__spherical.html">Spherical video mapping</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>This structure describes how to handle spherical videos, outlining information about projection, initial layout, and any other view modifier.
<a href="structAVSphericalMapping.html#details">More...</a></p>
<p><code>#include <<a class="el" href="spherical_8h_source.html">libavutil/spherical.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a5576008bdc224db049b1795b3c95fe16"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__lavu__video__spherical.html#ga689eeb8cf9b453f3619f3cf626e03a08">AVSphericalProjection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVSphericalMapping.html#a5576008bdc224db049b1795b3c95fe16">projection</a></td></tr>
<tr class="memdesc:a5576008bdc224db049b1795b3c95fe16"><td class="mdescLeft"> </td><td class="mdescRight">Projection type. <a href="#a5576008bdc224db049b1795b3c95fe16">More...</a><br /></td></tr>
<tr class="separator:a5576008bdc224db049b1795b3c95fe16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adeea248f32ff9ec9cd8de310f3d00108"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVSphericalMapping.html#adeea248f32ff9ec9cd8de310f3d00108">padding</a></td></tr>
<tr class="memdesc:adeea248f32ff9ec9cd8de310f3d00108"><td class="mdescLeft"> </td><td class="mdescRight">Number of pixels to pad from the edge of each cube face. <a href="#adeea248f32ff9ec9cd8de310f3d00108">More...</a><br /></td></tr>
<tr class="separator:adeea248f32ff9ec9cd8de310f3d00108"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Initial orientation</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>There fields describe additional rotations applied to the sphere after the video frame is mapped onto it.</p>
<p>The sphere is rotated around the viewer, who remains stationary. The order of transformation is always yaw, followed by pitch, and finally by roll.</p>
<p>The coordinate system matches the one defined in OpenGL, where the forward vector (z) is coming out of screen, and it is equivalent to a rotation matrix of R = r_y(yaw) * r_x(pitch) * r_z(roll).</p>
<p>A positive yaw rotates the portion of the sphere in front of the viewer toward their right. A positive pitch rotates the portion of the sphere in front of the viewer upwards. A positive roll tilts the portion of the sphere in front of the viewer to the viewer's right.</p>
<p>These values are exported as 16.16 fixed point.</p>
<p>See this equirectangular projection as example:</p>
<div class="fragment"><div class="line"> Yaw</div><div class="line"> -180 0 180</div><div class="line"> 90 +-------------+-------------+ 180</div><div class="line"> | | | up</div><div class="line">P | | | y| forward</div><div class="line">i | ^ | | /z</div><div class="line">t 0 +-------------X-------------+ 0 Roll | /</div><div class="line">c | | | | /</div><div class="line">h | | | 0|/_____right</div><div class="line"> | | | x</div><div class="line"> -90 +-------------+-------------+ -180</div><div class="line"></div><div class="line">X - the default camera center</div><div class="line">^ - the default up vector</div></div><!-- fragment --> </div></td></tr>
<tr class="memitem:ad7d7c61a2550cc4284076cc846873702"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVSphericalMapping.html#ad7d7c61a2550cc4284076cc846873702">yaw</a></td></tr>
<tr class="memdesc:ad7d7c61a2550cc4284076cc846873702"><td class="mdescLeft"> </td><td class="mdescRight">Rotation around the up vector [-180, 180]. <a href="#ad7d7c61a2550cc4284076cc846873702">More...</a><br /></td></tr>
<tr class="separator:ad7d7c61a2550cc4284076cc846873702"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84dfa298ac2ddf98665781507182a979"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVSphericalMapping.html#a84dfa298ac2ddf98665781507182a979">pitch</a></td></tr>
<tr class="memdesc:a84dfa298ac2ddf98665781507182a979"><td class="mdescLeft"> </td><td class="mdescRight">Rotation around the right vector [-90, 90]. <a href="#a84dfa298ac2ddf98665781507182a979">More...</a><br /></td></tr>
<tr class="separator:a84dfa298ac2ddf98665781507182a979"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaad422230e2b0f0ebfb981275e22ffb0"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVSphericalMapping.html#aaad422230e2b0f0ebfb981275e22ffb0">roll</a></td></tr>
<tr class="memdesc:aaad422230e2b0f0ebfb981275e22ffb0"><td class="mdescLeft"> </td><td class="mdescRight">Rotation around the forward vector [-180, 180]. <a href="#aaad422230e2b0f0ebfb981275e22ffb0">More...</a><br /></td></tr>
<tr class="separator:aaad422230e2b0f0ebfb981275e22ffb0"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Bounding rectangle</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="bounding"></a> These fields indicate the location of the current tile, and where it should be mapped relative to the original surface. They are exported as 0.32 fixed point, and can be converted to classic pixel values with av_spherical_bounds().</p>
<div class="fragment"><div class="line">+----------------+----------+</div><div class="line">| |bound_top |</div><div class="line">| +--------+ |</div><div class="line">| bound_left |tile | |</div><div class="line">+<---------->| |<--->+bound_right</div><div class="line">| +--------+ |</div><div class="line">| | |</div><div class="line">| bound_bottom| |</div><div class="line">+----------------+----------+</div></div><!-- fragment --><p>If needed, the original video surface dimensions can be derived by adding the current stream or frame size to the related bounds, like in the following example:</p>
<div class="fragment"><div class="line">original_width = tile->width + <a class="code" href="structAVSphericalMapping.html#a5168f1a737916aae56f0cf41d71937f7">bound_left</a> + <a class="code" href="structAVSphericalMapping.html#a6cbcda5b8d0118e50e4a1b574919af50">bound_right</a>;</div><div class="line">original_height = tile->height + <a class="code" href="structAVSphericalMapping.html#a5f82d37755e0d54559c254b7bdefffbe">bound_top</a> + <a class="code" href="structAVSphericalMapping.html#a670ae033266fb97133204baa6609955f">bound_bottom</a>;</div></div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>These values are valid only for the tiled equirectangular projection type (<a class="el" href="group__lavu__video__spherical.html#gga689eeb8cf9b453f3619f3cf626e03a08a768257247d4090b959ee1678f67bc9d3">AV_SPHERICAL_EQUIRECTANGULAR_TILE</a>), and should be ignored in all other cases. </dd></dl>
</div></td></tr>
<tr class="memitem:a5168f1a737916aae56f0cf41d71937f7"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVSphericalMapping.html#a5168f1a737916aae56f0cf41d71937f7">bound_left</a></td></tr>
<tr class="memdesc:a5168f1a737916aae56f0cf41d71937f7"><td class="mdescLeft"> </td><td class="mdescRight">Distance from the left edge. <a href="#a5168f1a737916aae56f0cf41d71937f7">More...</a><br /></td></tr>
<tr class="separator:a5168f1a737916aae56f0cf41d71937f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f82d37755e0d54559c254b7bdefffbe"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVSphericalMapping.html#a5f82d37755e0d54559c254b7bdefffbe">bound_top</a></td></tr>
<tr class="memdesc:a5f82d37755e0d54559c254b7bdefffbe"><td class="mdescLeft"> </td><td class="mdescRight">Distance from the top edge. <a href="#a5f82d37755e0d54559c254b7bdefffbe">More...</a><br /></td></tr>
<tr class="separator:a5f82d37755e0d54559c254b7bdefffbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6cbcda5b8d0118e50e4a1b574919af50"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVSphericalMapping.html#a6cbcda5b8d0118e50e4a1b574919af50">bound_right</a></td></tr>
<tr class="memdesc:a6cbcda5b8d0118e50e4a1b574919af50"><td class="mdescLeft"> </td><td class="mdescRight">Distance from the right edge. <a href="#a6cbcda5b8d0118e50e4a1b574919af50">More...</a><br /></td></tr>
<tr class="separator:a6cbcda5b8d0118e50e4a1b574919af50"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a670ae033266fb97133204baa6609955f"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVSphericalMapping.html#a670ae033266fb97133204baa6609955f">bound_bottom</a></td></tr>
<tr class="memdesc:a670ae033266fb97133204baa6609955f"><td class="mdescLeft"> </td><td class="mdescRight">Distance from the bottom edge. <a href="#a670ae033266fb97133204baa6609955f">More...</a><br /></td></tr>
<tr class="separator:a670ae033266fb97133204baa6609955f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This structure describes how to handle spherical videos, outlining information about projection, initial layout, and any other view modifier. </p>
<dl class="section note"><dt>Note</dt><dd>The struct must be allocated with <a class="el" href="group__lavu__video__spherical.html#gab366393b8836ac987df51546183386ea" title="Allocate a AVSphericalVideo structure and initialize its fields to default values. ">av_spherical_alloc()</a> and its size is not a part of the public ABI. </dd></dl>
<p class="definition">Definition at line <a class="el" href="spherical_8h_source.html#l00082">82</a> of file <a class="el" href="spherical_8h_source.html">spherical.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a5576008bdc224db049b1795b3c95fe16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5576008bdc224db049b1795b3c95fe16">◆ </a></span>projection</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__lavu__video__spherical.html#ga689eeb8cf9b453f3619f3cf626e03a08">AVSphericalProjection</a> AVSphericalMapping::projection</td>
</tr>
</table>
</div><div class="memdoc">
<p>Projection type. </p>
<p class="definition">Definition at line <a class="el" href="spherical_8h_source.html#l00086">86</a> of file <a class="el" href="spherical_8h_source.html">spherical.h</a>.</p>
</div>
</div>
<a id="ad7d7c61a2550cc4284076cc846873702"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7d7c61a2550cc4284076cc846873702">◆ </a></span>yaw</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t AVSphericalMapping::yaw</td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotation around the up vector [-180, 180]. </p>
<p class="definition">Definition at line <a class="el" href="spherical_8h_source.html#l00126">126</a> of file <a class="el" href="spherical_8h_source.html">spherical.h</a>.</p>
</div>
</div>
<a id="a84dfa298ac2ddf98665781507182a979"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84dfa298ac2ddf98665781507182a979">◆ </a></span>pitch</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t AVSphericalMapping::pitch</td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotation around the right vector [-90, 90]. </p>
<p class="definition">Definition at line <a class="el" href="spherical_8h_source.html#l00127">127</a> of file <a class="el" href="spherical_8h_source.html">spherical.h</a>.</p>
</div>
</div>
<a id="aaad422230e2b0f0ebfb981275e22ffb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaad422230e2b0f0ebfb981275e22ffb0">◆ </a></span>roll</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t AVSphericalMapping::roll</td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotation around the forward vector [-180, 180]. </p>
<p class="definition">Definition at line <a class="el" href="spherical_8h_source.html#l00128">128</a> of file <a class="el" href="spherical_8h_source.html">spherical.h</a>.</p>
</div>
</div>
<a id="a5168f1a737916aae56f0cf41d71937f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5168f1a737916aae56f0cf41d71937f7">◆ </a></span>bound_left</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t AVSphericalMapping::bound_left</td>
</tr>
</table>
</div><div class="memdoc">
<p>Distance from the left edge. </p>
<p class="definition">Definition at line <a class="el" href="spherical_8h_source.html#l00167">167</a> of file <a class="el" href="spherical_8h_source.html">spherical.h</a>.</p>
</div>
</div>
<a id="a5f82d37755e0d54559c254b7bdefffbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f82d37755e0d54559c254b7bdefffbe">◆ </a></span>bound_top</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t AVSphericalMapping::bound_top</td>
</tr>
</table>
</div><div class="memdoc">
<p>Distance from the top edge. </p>
<p class="definition">Definition at line <a class="el" href="spherical_8h_source.html#l00168">168</a> of file <a class="el" href="spherical_8h_source.html">spherical.h</a>.</p>
</div>
</div>
<a id="a6cbcda5b8d0118e50e4a1b574919af50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cbcda5b8d0118e50e4a1b574919af50">◆ </a></span>bound_right</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t AVSphericalMapping::bound_right</td>
</tr>
</table>
</div><div class="memdoc">
<p>Distance from the right edge. </p>
<p class="definition">Definition at line <a class="el" href="spherical_8h_source.html#l00169">169</a> of file <a class="el" href="spherical_8h_source.html">spherical.h</a>.</p>
</div>
</div>
<a id="a670ae033266fb97133204baa6609955f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a670ae033266fb97133204baa6609955f">◆ </a></span>bound_bottom</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t AVSphericalMapping::bound_bottom</td>
</tr>
</table>
</div><div class="memdoc">
<p>Distance from the bottom edge. </p>
<p class="definition">Definition at line <a class="el" href="spherical_8h_source.html#l00170">170</a> of file <a class="el" href="spherical_8h_source.html">spherical.h</a>.</p>
</div>
</div>
<a id="adeea248f32ff9ec9cd8de310f3d00108"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adeea248f32ff9ec9cd8de310f3d00108">◆ </a></span>padding</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t AVSphericalMapping::padding</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of pixels to pad from the edge of each cube face. </p>
<dl class="section note"><dt>Note</dt><dd>This value is valid for only for the cubemap projection type (<a class="el" href="group__lavu__video__spherical.html#gga689eeb8cf9b453f3619f3cf626e03a08aa0a8bc866354ecb619493db502c4d103">AV_SPHERICAL_CUBEMAP</a>), and should be ignored in all other cases. </dd></dl>
<p class="definition">Definition at line <a class="el" href="spherical_8h_source.html#l00182">182</a> of file <a class="el" href="spherical_8h_source.html">spherical.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>libavutil/<a class="el" href="spherical_8h_source.html">spherical.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|