| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>VA-API: VAEncSegParamAV1 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 |
|  <span id="projectnumber">2.23.0</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.1 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</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> | |
| <a href="structVAEncSegParamAV1-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">VAEncSegParamAV1 Struct Reference<div class="ingroups"><a class="el" href="group__api__enc__av1.html">AV1 encoding API</a></div></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Segment parameters. |
| <a href="structVAEncSegParamAV1.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="va__enc__av1_8h_source.html">va_enc_av1.h</a>></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:a519fa2d2831630d343f39acc6753d8c0"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncSegParamAV1.html#a519fa2d2831630d343f39acc6753d8c0">segment_number</a></td></tr> |
| <tr class="separator:a519fa2d2831630d343f39acc6753d8c0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7957d2cedd6f949a7ffa0a2223e704e5"><td class="memItemLeft" align="right" valign="top"><a id="a7957d2cedd6f949a7ffa0a2223e704e5"></a> |
| int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncSegParamAV1.html#a7957d2cedd6f949a7ffa0a2223e704e5">feature_data</a> [VA_AV1_MAX_SEGMENTS][VA_AV1_SEG_LVL_MAX]</td></tr> |
| <tr class="memdesc:a7957d2cedd6f949a7ffa0a2223e704e5"><td class="mdescLeft"> </td><td class="mdescRight">segment parameters. feature_data[][] is equivalent to variable FeatureData[][] in spec, which is after clip3() operation. Clip3(x, y, z) = (z<x)? x : ((z > y)? y : z); The limit is defined in Segmentation_Feature_Max[ SEG_LVL_MAX ] = { 255, MAX_LOOP_FILTER, MAX_LOOP_FILTER, MAX_LOOP_FILTER, MAX_LOOP_FILTER, 7, 0, 0 } <br /></td></tr> |
| <tr class="separator:a7957d2cedd6f949a7ffa0a2223e704e5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7fd72424fe4a08941276c11e3f5263f3"><td class="memItemLeft" align="right" valign="top"><a id="a7fd72424fe4a08941276c11e3f5263f3"></a> |
| uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncSegParamAV1.html#a7fd72424fe4a08941276c11e3f5263f3">feature_mask</a> [VA_AV1_MAX_SEGMENTS]</td></tr> |
| <tr class="memdesc:a7fd72424fe4a08941276c11e3f5263f3"><td class="mdescLeft"> </td><td class="mdescRight">Bit field to indicate each feature is enabled or not per segment_id. Each bit is the feature_id. <br /></td></tr> |
| <tr class="separator:a7fd72424fe4a08941276c11e3f5263f3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7797c0d59ea41efda003cbab2f455afc"><td class="memItemLeft" align="right" valign="top"><a id="a7797c0d59ea41efda003cbab2f455afc"></a> |
| uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncSegParamAV1.html#a7797c0d59ea41efda003cbab2f455afc">va_reserved</a> [<a class="el" href="group__api__core.html#gaaa4fb20d1c2606379cccfa562c2ebb3b">VA_PADDING_LOW</a>]</td></tr> |
| <tr class="memdesc:a7797c0d59ea41efda003cbab2f455afc"><td class="mdescLeft"> </td><td class="mdescRight">Reserved bytes for future use, must be zero. <br /></td></tr> |
| <tr class="separator:a7797c0d59ea41efda003cbab2f455afc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad92c8928efb2cc9cc5025c189112b353"><td class="memItemLeft" align="right" valign="top"><a id="ad92c8928efb2cc9cc5025c189112b353"></a> |
| uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncSegParamAV1.html#ad92c8928efb2cc9cc5025c189112b353">segmentation_enabled</a>: 1</td></tr> |
| <tr class="memdesc:ad92c8928efb2cc9cc5025c189112b353"><td class="mdescLeft"> </td><td class="mdescRight">Indicates if segmentation is enabled in the current frame. If disabled, all the below parameters in the structure should be set to 0, and ignored by driver. <br /></td></tr> |
| <tr class="separator:ad92c8928efb2cc9cc5025c189112b353"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1469d4de4ff46cfc3993ed63a504a900"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncSegParamAV1.html#a1469d4de4ff46cfc3993ed63a504a900">segmentation_update_map</a>: 1</td></tr> |
| <tr class="separator:a1469d4de4ff46cfc3993ed63a504a900"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a849d28f0623edcf090c3a2244d688fbf"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncSegParamAV1.html#a849d28f0623edcf090c3a2244d688fbf">segmentation_temporal_update</a>: 1</td></tr> |
| <tr class="separator:a849d28f0623edcf090c3a2244d688fbf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a859327e7dfb792b40ccf7a6d18290d27"><td class="memItemLeft" align="right" valign="top"><a id="a859327e7dfb792b40ccf7a6d18290d27"></a> |
| uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structVAEncSegParamAV1.html#a859327e7dfb792b40ccf7a6d18290d27">reserved</a>: 5</td></tr> |
| <tr class="memdesc:a859327e7dfb792b40ccf7a6d18290d27"><td class="mdescLeft"> </td><td class="mdescRight">Reserved bytes for future use, must be zero. <br /></td></tr> |
| <tr class="separator:a859327e7dfb792b40ccf7a6d18290d27"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Segment parameters. </p> |
| </div><h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a519fa2d2831630d343f39acc6753d8c0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a519fa2d2831630d343f39acc6753d8c0">◆ </a></span>segment_number</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint8_t VAEncSegParamAV1::segment_number</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>If segmentation_enabled equals 1, this parameter indicates the number of segments conveyed through VAAPI. In this case, if segment_number equals 0, it will force the driver to determine how many segments would be created as well as the segmentation map to be generated. Also the driver shall write the segmentation_params() syntax in the uncompressed header at <code>bit_offset_segmentation</code> (back-annotation). In application, the rest parameters in this structure should be all set to 0 and ignored by driver. And app should NOT send the "Segment map data buffer". In packed uncompressed header bitstream, app should write syntax element segmentation_enabled as 0 and segmentation_params() should be only 1-bit-long. If segment_number > 0, and segmentation_update_map = 1, app should provide the "Segment map data buffer" and populate the rest of the current data structure. And that underline encoder would honor the segmentation parameters feature_data[0..segment_number-1][] and feature_mask[0..segment_number-1], etc. Value range [0..8]. </p> |
| |
| </div> |
| </div> |
| <a id="a849d28f0623edcf090c3a2244d688fbf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a849d28f0623edcf090c3a2244d688fbf">◆ </a></span>segmentation_temporal_update</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint8_t VAEncSegParamAV1::segmentation_temporal_update</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>When segmentation_update_map equals 1, this parameter equaling 1 indicates segment id per block will be determined either from reference frame or from app. Equaling 0 means segment id per block will come from app. When segmentation_temporal_update equals 0, this parameter should be set to 0 and ignored by driver. </p> |
| |
| </div> |
| </div> |
| <a id="a1469d4de4ff46cfc3993ed63a504a900"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1469d4de4ff46cfc3993ed63a504a900">◆ </a></span>segmentation_update_map</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint8_t VAEncSegParamAV1::segmentation_update_map</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>When segmentation_enabled equals 1 and segment_number > 0, this parameter equals 1 indicates the segmentation map may come from application, and that "Segment map data buffer" should be provided with populated segment_id. If equals 0, segmentation map should be inherited from a reference frame (specified by <code>primary_ref_frame</code>). When segmentation_enabled or segment_number equals 0, this parameter should be set to 0 and ignored by driver. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following file:<ul> |
| <li><a class="el" href="va__enc__av1_8h_source.html">va_enc_av1.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated for VA-API by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1</small></address> |
| </body> |
| </html> |
