blob: 0405d2b5cbe7c174c3175f6369c926baaa2c4e59 [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: VAEncryptionParameters 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="structVAEncryptionParameters-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">VAEncryptionParameters 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>Encryption parameters buffer for VAEncryptionParameterBufferType.
<a href="structVAEncryptionParameters.html#details">More...</a></p>
<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:ad0c6803facf84e9f6a9fddbcadf0412e"><td class="memItemLeft" align="right" valign="top"><a id="ad0c6803facf84e9f6a9fddbcadf0412e"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncryptionParameters.html#ad0c6803facf84e9f6a9fddbcadf0412e">encryption_type</a></td></tr>
<tr class="memdesc:ad0c6803facf84e9f6a9fddbcadf0412e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encryption type, refer to <code>VA_ENCRYPTION_TYPE_FULLSAMPLE_CTR</code>, <code>VA_ENCRYPTION_TYPE_FULLSAMPLE_CBC</code>, <code>VA_ENCRYPTION_TYPE_SUBSAMPLE_CTR</code>, or <code>VA_ENCRYPTION_TYPE_SUBSAMPLE_CBC</code>. <br /></td></tr>
<tr class="separator:ad0c6803facf84e9f6a9fddbcadf0412e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d63dacb073034c830852646a63ca977"><td class="memItemLeft" align="right" valign="top"><a id="a9d63dacb073034c830852646a63ca977"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncryptionParameters.html#a9d63dacb073034c830852646a63ca977">num_segments</a></td></tr>
<tr class="memdesc:a9d63dacb073034c830852646a63ca977"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of sengments. <br /></td></tr>
<tr class="separator:a9d63dacb073034c830852646a63ca977"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac98df9c278ac27199fad22e600f55ca"><td class="memItemLeft" align="right" valign="top"><a id="aac98df9c278ac27199fad22e600f55ca"></a>
<a class="el" href="structVAEncryptionSegmentInfo.html">VAEncryptionSegmentInfo</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncryptionParameters.html#aac98df9c278ac27199fad22e600f55ca">segment_info</a></td></tr>
<tr class="memdesc:aac98df9c278ac27199fad22e600f55ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer of segments. <br /></td></tr>
<tr class="separator:aac98df9c278ac27199fad22e600f55ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad80c28d749c6878834463c545ed011c"><td class="memItemLeft" align="right" valign="top"><a id="aad80c28d749c6878834463c545ed011c"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncryptionParameters.html#aad80c28d749c6878834463c545ed011c">status_report_index</a></td></tr>
<tr class="memdesc:aad80c28d749c6878834463c545ed011c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The status report index reserved for CENC fullsample workload. The related structures and definitions are vendor specific. <br /></td></tr>
<tr class="separator:aad80c28d749c6878834463c545ed011c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa85edbcb535fb89fcf25ba267f178037"><td class="memItemLeft" align="right" valign="top"><a id="aa85edbcb535fb89fcf25ba267f178037"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncryptionParameters.html#aa85edbcb535fb89fcf25ba267f178037">size_of_length</a></td></tr>
<tr class="memdesc:aa85edbcb535fb89fcf25ba267f178037"><td class="mdescLeft">&#160;</td><td class="mdescRight">CENC counter length. <br /></td></tr>
<tr class="separator:aa85edbcb535fb89fcf25ba267f178037"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b935a2e103379651af32f1abc9d4a75"><td class="memItemLeft" align="right" valign="top"><a id="a4b935a2e103379651af32f1abc9d4a75"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncryptionParameters.html#a4b935a2e103379651af32f1abc9d4a75">wrapped_decrypt_blob</a> [64]</td></tr>
<tr class="memdesc:a4b935a2e103379651af32f1abc9d4a75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapped decrypt blob (Snd)kb, valid size is specified by <code>key_blob_size</code>. <br /></td></tr>
<tr class="separator:a4b935a2e103379651af32f1abc9d4a75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d289830945046b77855f2896108b08c"><td class="memItemLeft" align="right" valign="top"><a id="a0d289830945046b77855f2896108b08c"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncryptionParameters.html#a0d289830945046b77855f2896108b08c">wrapped_encrypt_blob</a> [64]</td></tr>
<tr class="memdesc:a0d289830945046b77855f2896108b08c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapped Key blob info (Sne)kb, valid size is specified by <code>key_blob_size</code>. <br /></td></tr>
<tr class="separator:a0d289830945046b77855f2896108b08c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f0d04b6b0f1df9529a45a997bd1093e"><td class="memItemLeft" align="right" valign="top"><a id="a2f0d04b6b0f1df9529a45a997bd1093e"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncryptionParameters.html#a2f0d04b6b0f1df9529a45a997bd1093e">key_blob_size</a></td></tr>
<tr class="memdesc:a2f0d04b6b0f1df9529a45a997bd1093e"><td class="mdescLeft">&#160;</td><td class="mdescRight">key blob size It could be <code>VA_PC_BLOCK_SIZE_128</code>, <code>VA_PC_BLOCK_SIZE_192</code>, or <code>VA_PC_BLOCK_SIZE_256</code> <br /></td></tr>
<tr class="separator:a2f0d04b6b0f1df9529a45a997bd1093e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5618d5fa95b4a44449d238602d1b885"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncryptionParameters.html#ac5618d5fa95b4a44449d238602d1b885">blocks_stripe_encrypted</a></td></tr>
<tr class="memdesc:ac5618d5fa95b4a44449d238602d1b885"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates the number of 16-byte BLOCKS that are encrypted in any given encrypted region of segments. If this value is zero: <a href="#ac5618d5fa95b4a44449d238602d1b885">More...</a><br /></td></tr>
<tr class="separator:ac5618d5fa95b4a44449d238602d1b885"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74e13c367e537dc2d1e9bac11bf7f389"><td class="memItemLeft" align="right" valign="top"><a id="a74e13c367e537dc2d1e9bac11bf7f389"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncryptionParameters.html#a74e13c367e537dc2d1e9bac11bf7f389">blocks_stripe_clear</a></td></tr>
<tr class="memdesc:a74e13c367e537dc2d1e9bac11bf7f389"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates the number of 16-byte BLOCKS that are clear in any given encrypted region of segments, as defined by the CENS and CBCS schemes in the common encryption spec. If this value is zero, all bytes in encrypted region of segments are encrypted, i.e. the CENC or CBC1 scheme is being used. <br /></td></tr>
<tr class="separator:a74e13c367e537dc2d1e9bac11bf7f389"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f525446e7926989ce1556e636bbe1b0"><td class="memItemLeft" align="right" valign="top"><a id="a9f525446e7926989ce1556e636bbe1b0"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncryptionParameters.html#a9f525446e7926989ce1556e636bbe1b0">va_reserved</a> [VA_PADDING_MEDIUM]</td></tr>
<tr class="memdesc:a9f525446e7926989ce1556e636bbe1b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserved bytes for future use, must be zero. <br /></td></tr>
<tr class="separator:a9f525446e7926989ce1556e636bbe1b0"><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>Encryption parameters buffer for VAEncryptionParameterBufferType. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ac5618d5fa95b4a44449d238602d1b885"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5618d5fa95b4a44449d238602d1b885">&#9670;&nbsp;</a></span>blocks_stripe_encrypted</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t VAEncryptionParameters::blocks_stripe_encrypted</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates the number of 16-byte BLOCKS that are encrypted in any given encrypted region of segments. If this value is zero: </p>
<ol type="1">
<li>All bytes in encrypted region of segments are encrypted, i.e. the CENC or CBC1 scheme is being used</li>
<li>blocks_stripe_clear must also be zero. If this value is non-zero, blocks_stripe_clear must also be non-zero. </li>
</ol>
</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>