blob: a5be57fbd9aba395629e49aeb49c899e42e41af6 [file] [log] [blame]
<!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>VA-API: VAEncMiscParameterFrameRate 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">VA-API
&#160;<span id="projectnumber">2.13.0.pre1</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">Public Attributes</a> &#124;
<a href="structVAEncMiscParameterFrameRate-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">VAEncMiscParameterFrameRate Struct Reference<div class="ingroups"><a class="el" href="group__api__core.html">Core API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="va_8h_source.html">va.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab6e7d3fb7751750d7e26adb08a861198"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncMiscParameterFrameRate.html#ab6e7d3fb7751750d7e26adb08a861198">framerate</a></td></tr>
<tr class="separator:ab6e7d3fb7751750d7e26adb08a861198"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a070046ef6f3ec04a3577a399deda10d5"><td class="memItemLeft" align="right" valign="top"><a id="a070046ef6f3ec04a3577a399deda10d5"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncMiscParameterFrameRate.html#a070046ef6f3ec04a3577a399deda10d5">va_reserved</a> [<a class="el" href="group__api__core.html#gaaa4fb20d1c2606379cccfa562c2ebb3b">VA_PADDING_LOW</a>]</td></tr>
<tr class="memdesc:a070046ef6f3ec04a3577a399deda10d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserved bytes for future use, must be zero. <br /></td></tr>
<tr class="separator:a070046ef6f3ec04a3577a399deda10d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d780469f72f33497ded209167ebc445"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncMiscParameterFrameRate.html#a7d780469f72f33497ded209167ebc445">temporal_id</a>: 8</td></tr>
<tr class="separator:a7d780469f72f33497ded209167ebc445"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a799f9dd449d39eea77b7f9936a71522d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncMiscParameterFrameRate.html#a799f9dd449d39eea77b7f9936a71522d">reserved</a>: 24</td></tr>
<tr class="separator:a799f9dd449d39eea77b7f9936a71522d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Encode framerate parameters.</p>
<p>Sets the encode framerate used by the rate controller. This should be provided in all modes using a bitrate target (variable framerate is not supported). </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ab6e7d3fb7751750d7e26adb08a861198"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6e7d3fb7751750d7e26adb08a861198">&#9670;&nbsp;</a></span>framerate</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t VAEncMiscParameterFrameRate::framerate</td>
</tr>
</table>
</div><div class="memdoc">
<p>Encode framerate.</p>
<p>The framerate is specified as a number of frames per second, as a fraction. The denominator of the fraction is given in the top half (the high two bytes) of the framerate field, and the numerator is given in the bottom half (the low two bytes).</p>
<p>That is: denominator = framerate &gt;&gt; 16 &amp; 0xffff; numerator = framerate &amp; 0xffff; fps = numerator / denominator;</p>
<p>For example, if framerate is set to (100 &lt;&lt; 16 | 750), this is 750 / 100, hence 7.5fps.</p>
<p>If the denominator is zero (the high two bytes are both zero) then it takes the value one instead, so the framerate is just the integer in the low 2 bytes. </p>
</div>
</div>
<a id="a799f9dd449d39eea77b7f9936a71522d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a799f9dd449d39eea77b7f9936a71522d">&#9670;&nbsp;</a></span>reserved</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t VAEncMiscParameterFrameRate::reserved</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reserved for future use, must be zero. </p>
</div>
</div>
<a id="a7d780469f72f33497ded209167ebc445"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d780469f72f33497ded209167ebc445">&#9670;&nbsp;</a></span>temporal_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t VAEncMiscParameterFrameRate::temporal_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>The temporal layer that these framerate parameters apply to. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="va_8h_source.html">va.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated for VA-API by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13</small></address>
</body>
</html>