stv0g/embeddedsw
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
embeddedsw/XilinxProcessorIPLib/drivers/vprocss/doc/html/api/xvprocss_8h.html
Nava kishore Manne d18411f597 Drivers: Doxygen changes for 2015.4 
Signed-off-by: Nava kishore Manne <navam@xilinx.com>
2015-12-01 11:51:28 +05:30

2033 lines
115 KiB
HTML
Executable file
Raw Blame History

<!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.10"/>
<title>vprocss: xvprocss.h File 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="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.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="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">vprocss
</div>
<div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Overview</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="globals.html"><span>APIs</span></a></li>
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_14bc92f4b96c8519b376567118ac28b3.html">drivers</a></li><li class="navelem"><a class="el" href="dir_86c4c6fe37ccc146621b6d3460ee83cf.html">vprocss</a></li><li class="navelem"><a class="el" href="dir_b835bb48a15de58e60209c43527a5582.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">xvprocss.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p><b>Video Processing Subsystem Overview</b></p>
<p>Video Subsystem is a collection of IP cores bounded together by software to provide an abstract view of the processing pipe. It hides all the complexities of programming the underlying cores from end user.</p>
<p><b>Subsystem Driver Features</b></p>
<p>Video Subsystem supports following features</p><ul>
<li>AXI Stream Input/Output interface</li>
<li>1, 2 or 4 pixel-wide video interface</li>
<li>8/10/12/16 bits per component</li>
<li>RGB &amp; YCbCr color space</li>
<li>Memory based/streaming mode scaling in either direction (Up/Down)</li>
<li>Up to 4k2k 60Hz resolution at both Input and Output interface</li>
<li>Interlaced input support (1080i 50Hz/60Hz)</li>
<li>Frame rate conversion<ul>
<li>Drop frames if input rate &gt; output rate</li>
<li>Repeat frames if input rate &lt; output rate</li>
</ul>
</li>
<li>Auto configuration of processing pipe based on detected use case<ul>
<li>Scale Up/Down</li>
<li>Zoom mode wherein a window in input is scaled to panel resolution</li>
<li>Picture-In-Picture mode wherein the input stream is scaled down to a defined window size and background is painted to user define color</li>
<li>Color Space and color format Conversion</li>
<li>Interlaced to Progressive conversion</li>
</ul>
</li>
</ul>
<p><b>Subsystem Configurations</b></p>
<p>Two types of configurations are supported via GUI in IPI</p><ul>
<li>Full Configuration: provides all the features mentioned above</li>
<li>Streaming Mode Configuration (aka Scaler-Only) with limited functionality</li>
</ul>
<p>Number of processing cores that get included in the design will depend upon the configuration selected. Static configuration parameters are stored in vprocss_g.c file that gets generated when compiling the board support package (BSP). A table is defined where each entry contains configuration information for the instances of the subsystem in the design. This information includes the elected configuration, sub-cores used and their device ID, base addresses of memory mapped devices, user specified DDR address for buffer management and address range available for subsystem frame/field buffers.</p>
<p>Full configuration mode includes following sub-cores in HW</p><ul>
<li>Scalers (horizontal/vertical)</li>
<li>Chroma Resampler (horizontal/vertical)</li>
<li>Color Space Converter</li>
<li>VDMA for buffer management</li>
<li>De-Interlacer</li>
<li>Letter Box</li>
<li>AXIS Switch</li>
</ul>
<p>Stream mode configuration mode includes following sub-cores in HW</p><ul>
<li>Scalers (horizontal/vertical)</li>
</ul>
<p>The subsystem driver itself always includes the full software stack irrespective of the configuration selected. Generic API's are provided to interact with the subsystem and/or with the included sub-cores. At run-time the subsystem will query the static configuration and configures itself for supported use cases</p>
<p><b>Subsystem Driver Description</b></p>
<p>Subsystem driver is built upon layer 1&amp;2 device drivers of included sub-cores Layer 1 provides API's to peek/poke registers at HW level. Layer 2 provides API's that abstract sub-core functionality, providing an easy to use feature interface</p>
<p><b>Pre-Requisite's</b></p>
<ul>
<li>For memory based design (Full Fledged Topology) application must program the base address of the video buffers in memory. Refer Memory Requirement section below.</li>
<li>For microblaze based designs it is recommended to include a timer peripheral in the design and application should register a delay handling routine with the subsystem using the provided API.</li>
</ul>
<p><b>Subsystem Driver Usage</b></p>
<p>The subsystem driver in itself is a dormant driver that needs application SW to make use of provided API's to configure it at boot-up. Thereafter application SW is responsible to monitor the system for external impetus and call the subsystem API's to communicate the change and trigger the reconfiguration of internal data processing pipe (refer API XVprocSs_ConfigureSubsystem()) AXI Stream configuration for input/output interface is derived from the Xilinx video common driver and only the resolutions listed therein are supported at this time</p>
<p><b>Memory Requirement</b></p>
<p>For full configuration mode DDR memory is used to store video frame buffers Subsystem uses 5 frame buffers for Progressive input and 3 field buffers for interlaced input. Amount of memory required by the subsystem can be calculated by below equation</p>
<ul>
<li>5 * MAX_WIDTHp * MAX_HEIGHTp * NUM_VIDEO_COMPONENTS * BytesPerComp + 3 * MAX_WIDTHi * MAX_HEIGHTi * NUM_VIDEO_COMPONENTS * BytesPerComp</li>
</ul>
<p>BytesPerComp</p><ul>
<li>1 Byte for 8 bit data pipe</li>
<li>2 Byte for 10/12/16 bit data pipe</li>
</ul>
<p>The location of these buffers in the memory is system dependent and as such must be determined by the system designer and the application code is responsible to program the base address of the buffer memory prior to initializing the subsystem. API to use is defined below</p><ul>
<li>XVprocSs_SetFrameBufBaseaddr</li>
</ul>
<p><b>Interrupt Service</b></p>
<p>Currently no interrupts are available from the subsystem. User application is responsible for triggering processing pipe update when any change in subsystem configuration is performed at application level</p>
<p><b> Virtual Memory </b></p>
<p>This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.</p>
<p><b> Threads </b></p>
<p>This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.</p>
<p><b>Asserts</b></p>
<p>Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining, at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that application developers leave asserts on during development.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver Who Date Changes
----- ---- -------- -------------------------------------------------------
1.00 rco 08/28/15 Initial Release</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_vproc_ss___context_data.html">XVprocSs_ContextData</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_sub_core.html">XSubCore</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_vproc_ss___config.html">XVprocSs_Config</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:acbc2fc0f1cb34b9b607a59dc010e5c8c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#acbc2fc0f1cb34b9b607a59dc010e5c8c">XVprocSs_GetSubsystemTopology</a>(XVprocSsPtr)&#160;&#160;&#160;((XVprocSsPtr)-&gt;Config.Topology)</td></tr>
<tr class="separator:acbc2fc0f1cb34b9b607a59dc010e5c8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0a3f8f3946c8d71bac750de3c62b2c8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#ab0a3f8f3946c8d71bac750de3c62b2c8">XVprocSs_IsConfigModeMax</a>(XVprocSsPtr)&#160;&#160;&#160;((XVprocSsPtr)-&gt;Config.Topology == XVPROCSS_TOPOLOGY_FULL_FLEDGED)</td></tr>
<tr class="separator:ab0a3f8f3946c8d71bac750de3c62b2c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10342f4254eec4843f7cce3fd8744972"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a10342f4254eec4843f7cce3fd8744972">XVprocSs_IsConfigModeSscalerOnly</a>(XVprocSsPtr)&#160;&#160;&#160;((XVprocSsPtr)-&gt;Config.Topology == XVPROCSS_TOPOLOGY_SCALER_ONLY)</td></tr>
<tr class="separator:a10342f4254eec4843f7cce3fd8744972"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7db821ac7a4624d461aed0b5241e7a4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#ac7db821ac7a4624d461aed0b5241e7a4">XVprocSs_IsPipModeOn</a>(XVprocSsPtr) &#160;&#160;&#160;((XVprocSsPtr)-&gt;CtxtData.PipEn)</td></tr>
<tr class="separator:ac7db821ac7a4624d461aed0b5241e7a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc56195b4e98f368335ca3e7e6d7e897"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#afc56195b4e98f368335ca3e7e6d7e897">XVprocSs_IsZoomModeOn</a>(XVprocSsPtr) &#160;&#160;&#160;((XVprocSsPtr)-&gt;CtxtData.ZoomEn)</td></tr>
<tr class="separator:afc56195b4e98f368335ca3e7e6d7e897"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e4c82e3faace0de0420bb1d814d8c8d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a8e4c82e3faace0de0420bb1d814d8c8d">XVprocSs_GetPipZoomWinHStepSize</a>(XVprocSsPtr)&#160;&#160;&#160;((XVprocSsPtr)-&gt;CtxtData.PixelHStepSize)</td></tr>
<tr class="separator:a8e4c82e3faace0de0420bb1d814d8c8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d017fa1ca5cc101f1ada08fef364704"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a5d017fa1ca5cc101f1ada08fef364704">XVprocSs_ResetPipModeFlag</a>(XVprocSsPtr)&#160;&#160;&#160;((XVprocSsPtr)-&gt;CtxtData.PipEn = FALSE)</td></tr>
<tr class="separator:a5d017fa1ca5cc101f1ada08fef364704"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9700711526f9d3d645ae94cc0d2f534e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a9700711526f9d3d645ae94cc0d2f534e">XVprocSs_ResetZoomModeFlag</a>(XVprocSsPtr)&#160;&#160;&#160;((XVprocSsPtr)-&gt;CtxtData.ZoomEn = FALSE)</td></tr>
<tr class="separator:a9700711526f9d3d645ae94cc0d2f534e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacab9c525fac94a691a0d8c86f50befb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#aacab9c525fac94a691a0d8c86f50befb">XVprocSs_SetStreamColorFormat</a>(Stream, ColorFormat)&#160;&#160;&#160;((Stream)-&gt;ColorFormatId = ColorFormat)</td></tr>
<tr class="separator:aacab9c525fac94a691a0d8c86f50befb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a641ccc79989ce1d91ce41d0376516fbf"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a641ccc79989ce1d91ce41d0376516fbf">XVprocSs_SetStreamColorDepth</a>(Stream, ColorDepth)&#160;&#160;&#160;((Stream)-&gt;ColorDepth = ColorDepth)</td></tr>
<tr class="separator:a641ccc79989ce1d91ce41d0376516fbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a63cf1a12fdc139677b3bbf33aeaa6c34"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a63cf1a12fdc139677b3bbf33aeaa6c34">XVPROCSS_SUBCORE_ID</a> <tr class="separator:a63cf1a12fdc139677b3bbf33aeaa6c34"><td class="memSeparator" colspan="2">&#160;</td></tr>
</td></tr>
<tr class="memitem:a7d60f719453eb6b2145c6a9cfa45422f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a7d60f719453eb6b2145c6a9cfa45422f">XVprocSs_ColorChannel</a> <tr class="separator:a7d60f719453eb6b2145c6a9cfa45422f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a915162055bd362eb0e9e4f2b02db3ac0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a915162055bd362eb0e9e4f2b02db3ac0">XVprocSs_SetFrameBufBaseaddr</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, u32 addr)</td></tr>
<tr class="separator:a915162055bd362eb0e9e4f2b02db3ac0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae1122f4587efc719f26e180560081e55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_vproc_ss___config.html">XVprocSs_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vprocss.html#gae1122f4587efc719f26e180560081e55">XVprocSs_LookupConfig</a> (u32 DeviceId)</td></tr>
<tr class="separator:gae1122f4587efc719f26e180560081e55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f3ca0942da6148e9f6e905637b4ba25"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a3f3ca0942da6148e9f6e905637b4ba25">XVprocSs_CfgInitialize</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, <a class="el" href="struct_x_vproc_ss___config.html">XVprocSs_Config</a> *CfgPtr, u32 EffectiveAddr)</td></tr>
<tr class="separator:a3f3ca0942da6148e9f6e905637b4ba25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f673d448bb7702661b702519de94fd9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a0f673d448bb7702661b702519de94fd9">XVprocSs_Start</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="separator:a0f673d448bb7702661b702519de94fd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f28821282af5defa07408d1c00c2bfe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a1f28821282af5defa07408d1c00c2bfe">XVprocSs_Stop</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="separator:a1f28821282af5defa07408d1c00c2bfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab65fda7ce63456d82274a463a4d4b72a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#ab65fda7ce63456d82274a463a4d4b72a">XVprocSs_Reset</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="separator:ab65fda7ce63456d82274a463a4d4b72a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47c310a89b7072313404485d4bb9b03f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a47c310a89b7072313404485d4bb9b03f">XVprocSs_SetVidStreamIn</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, const XVidC_VideoStream *StrmIn)</td></tr>
<tr class="separator:a47c310a89b7072313404485d4bb9b03f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28fae690c023b4d8b7a1d9b9c68c966c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a28fae690c023b4d8b7a1d9b9c68c966c">XVprocSs_SetVidStreamOut</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, const XVidC_VideoStream *StrmOut)</td></tr>
<tr class="separator:a28fae690c023b4d8b7a1d9b9c68c966c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa00540dce648d610e8087f2ec6dc5462"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#aa00540dce648d610e8087f2ec6dc5462">XVprocSs_SetStreamResolution</a> (XVidC_VideoStream *StreamPtr, const XVidC_VideoMode VmId)</td></tr>
<tr class="separator:aa00540dce648d610e8087f2ec6dc5462"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49bdfcfcf9abb02829a7baf6603151f2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a49bdfcfcf9abb02829a7baf6603151f2">XVprocSs_SetSubsystemConfig</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="separator:a49bdfcfcf9abb02829a7baf6603151f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a799db27e282d2762ee5cf4be40e70712"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a799db27e282d2762ee5cf4be40e70712">XVprocSs_SetZoomMode</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, u8 OnOff)</td></tr>
<tr class="separator:a799db27e282d2762ee5cf4be40e70712"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84b1254cbeac02b7f81b1b90c721e84d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a84b1254cbeac02b7f81b1b90c721e84d">XVprocSs_SetPipMode</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, u8 OnOff)</td></tr>
<tr class="separator:a84b1254cbeac02b7f81b1b90c721e84d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8293d3dc637bc8c481b205d2272b4fc2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a8293d3dc637bc8c481b205d2272b4fc2">XVprocSs_SetZoomPipWindow</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, <a class="el" href="xvprocss_8h.html#a0743bfb208145c415f5af1ba231245a6">XVprocSs_Win</a> mode, XVidC_VideoWindow *win)</td></tr>
<tr class="separator:a8293d3dc637bc8c481b205d2272b4fc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55d0807b3f476d2608a8c49b44388fec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a55d0807b3f476d2608a8c49b44388fec">XVprocSs_GetZoomPipWindow</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, <a class="el" href="xvprocss_8h.html#a0743bfb208145c415f5af1ba231245a6">XVprocSs_Win</a> mode, XVidC_VideoWindow *win)</td></tr>
<tr class="separator:a55d0807b3f476d2608a8c49b44388fec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bdc6a00278cb1c847429d7498f8505e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a4bdc6a00278cb1c847429d7498f8505e">XVprocSs_UpdateZoomPipWindow</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="separator:a4bdc6a00278cb1c847429d7498f8505e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84c2f382ff78d4cc1c42628d0821870c"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a84c2f382ff78d4cc1c42628d0821870c">XVprocSs_GetPictureBrightness</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="separator:a84c2f382ff78d4cc1c42628d0821870c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a186ce7049ca9f0bcaf1a5e76866fbf31"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a186ce7049ca9f0bcaf1a5e76866fbf31">XVprocSs_SetPictureBrightness</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, s32 NewValue)</td></tr>
<tr class="separator:a186ce7049ca9f0bcaf1a5e76866fbf31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a628456c68064dcf093ecd1f7097e2879"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a628456c68064dcf093ecd1f7097e2879">XVprocSs_GetPictureContrast</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="separator:a628456c68064dcf093ecd1f7097e2879"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65dcb2906de961ca823262f6b6039b87"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a65dcb2906de961ca823262f6b6039b87">XVprocSs_SetPictureContrast</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, s32 NewValue)</td></tr>
<tr class="separator:a65dcb2906de961ca823262f6b6039b87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a124ab620c7b3aa805ea8b0086ba0c344"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a124ab620c7b3aa805ea8b0086ba0c344">XVprocSs_GetPictureSaturation</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="separator:a124ab620c7b3aa805ea8b0086ba0c344"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afccd0de81f7e5dc6bc19ce61eae38e92"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#afccd0de81f7e5dc6bc19ce61eae38e92">XVprocSs_SetPictureSaturation</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, s32 NewValue)</td></tr>
<tr class="separator:afccd0de81f7e5dc6bc19ce61eae38e92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8e9990e57b17ac9bdd9a911153ddbfe"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#af8e9990e57b17ac9bdd9a911153ddbfe">XVprocSs_GetPictureGain</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, <a class="el" href="xvprocss_8h.html#a7d60f719453eb6b2145c6a9cfa45422f">XVprocSs_ColorChannel</a> ChId)</td></tr>
<tr class="separator:af8e9990e57b17ac9bdd9a911153ddbfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05099b854831e91e4a2d6c39395c267d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a05099b854831e91e4a2d6c39395c267d">XVprocSs_SetPictureGain</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, <a class="el" href="xvprocss_8h.html#a7d60f719453eb6b2145c6a9cfa45422f">XVprocSs_ColorChannel</a> ChId, s32 NewValue)</td></tr>
<tr class="separator:a05099b854831e91e4a2d6c39395c267d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0002b9c7a313219e4701514fe3acae7b"><td class="memItemLeft" align="right" valign="top">XVidC_ColorStd&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a0002b9c7a313219e4701514fe3acae7b">XVprocSs_GetPictureColorStdIn</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="separator:a0002b9c7a313219e4701514fe3acae7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0b45fe8442626962284f22ea54e3d43"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#aa0b45fe8442626962284f22ea54e3d43">XVprocSs_SetPictureColorStdIn</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, XVidC_ColorStd NewVal)</td></tr>
<tr class="separator:aa0b45fe8442626962284f22ea54e3d43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b8d6dc56403962ed56cba01b01a3c2f"><td class="memItemLeft" align="right" valign="top">XVidC_ColorStd&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a9b8d6dc56403962ed56cba01b01a3c2f">XVprocSs_GetPictureColorStdOut</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="separator:a9b8d6dc56403962ed56cba01b01a3c2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01d3ff2ed3b9bb9c8808b187d1d685a6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a01d3ff2ed3b9bb9c8808b187d1d685a6">XVprocSs_SetPictureColorStdOut</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, XVidC_ColorStd NewVal)</td></tr>
<tr class="separator:a01d3ff2ed3b9bb9c8808b187d1d685a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b0ba7cd1d7384d9acd813d3b38f2979"><td class="memItemLeft" align="right" valign="top">XVidC_ColorRange&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a0b0ba7cd1d7384d9acd813d3b38f2979">XVprocSs_GetPictureColorRange</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="separator:a0b0ba7cd1d7384d9acd813d3b38f2979"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa0f891d54cc88f0fd6d4ef93960aec1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#aaa0f891d54cc88f0fd6d4ef93960aec1">XVprocSs_SetPictureColorRange</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, XVidC_ColorRange NewVal)</td></tr>
<tr class="separator:aaa0f891d54cc88f0fd6d4ef93960aec1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a007dc9d0a75c0e09fd85d733230be564"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a007dc9d0a75c0e09fd85d733230be564">XVprocSs_SetPictureActiveWindow</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, XVidC_VideoWindow *Win)</td></tr>
<tr class="separator:a007dc9d0a75c0e09fd85d733230be564"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34d1e25e364c4699c60ee30839f141f7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a34d1e25e364c4699c60ee30839f141f7">XVprocSs_SetPIPBackgroundColor</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, XLboxColorId ColorId)</td></tr>
<tr class="separator:a34d1e25e364c4699c60ee30839f141f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e48068cf0d1c946986e64b53cb24cc8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a1e48068cf0d1c946986e64b53cb24cc8">XVprocSs_LoadScalerCoeff</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, u32 CoreId, u16 num_phases, u16 num_taps, const short *Coeff)</td></tr>
<tr class="separator:a1e48068cf0d1c946986e64b53cb24cc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a45d3f05110a0eda88d959ecae7cd07"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#a7a45d3f05110a0eda88d959ecae7cd07">XVprocSs_LoadChromaResamplerCoeff</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, u32 CoreId, u16 num_taps, const short *Coeff)</td></tr>
<tr class="separator:a7a45d3f05110a0eda88d959ecae7cd07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe70027604ba640917538338703b4a7f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#abe70027604ba640917538338703b4a7f">XVprocSs_ReportSubsystemConfig</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="separator:abe70027604ba640917538338703b4a7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3ef2fc6d79df8ccb528644f8e539828"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#af3ef2fc6d79df8ccb528644f8e539828">XVprocSs_ReportSubsystemCoreInfo</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="separator:af3ef2fc6d79df8ccb528644f8e539828"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc2dd89a8c01c86bf6093d842db67262"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#acc2dd89a8c01c86bf6093d842db67262">XVprocSs_ReportSubcoreStatus</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, u32 SubcoreId)</td></tr>
<tr class="separator:acc2dd89a8c01c86bf6093d842db67262"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add7069c7a21fe0cf07779dcb945cab96"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8h.html#add7069c7a21fe0cf07779dcb945cab96">XVprocSs_SetUserTimerHandler</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, XVidC_DelayHandler CallbackFunc, void *CallbackRef)</td></tr>
<tr class="separator:add7069c7a21fe0cf07779dcb945cab96"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a8e4c82e3faace0de0420bb1d814d8c8d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XVprocSs_GetPipZoomWinHStepSize</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">XVprocSsPtr</td><td>)</td>
<td>&#160;&#160;&#160;((XVprocSsPtr)-&gt;CtxtData.PixelHStepSize)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro returns the Pip/Zoom window horizontal increment size. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">XVprocSsPtr</td><td>is a pointer to the Video Processing subsystem instance</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pixel H Step size </dd></dl>
<p>Referenced by <a class="el" href="xvprocss_8h.html#abe70027604ba640917538338703b4a7f">XVprocSs_ReportSubsystemConfig()</a>.</p>
</div>
</div>
<a class="anchor" id="acbc2fc0f1cb34b9b607a59dc010e5c8c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XVprocSs_GetSubsystemTopology</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">XVprocSsPtr</td><td>)</td>
<td>&#160;&#160;&#160;((XVprocSsPtr)-&gt;Config.Topology)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro returns the subsystem topology. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">XVprocSsPtr</td><td>is a pointer to the Video Processing subsystem instance</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XVPROCSS_TOPOLOGY_FULL_FLEDGED or XVPROCSS_TOPOLOGY_SCALER_ONLY </dd></dl>
<p>Referenced by <a class="el" href="xvprocss_8h.html#a3f3ca0942da6148e9f6e905637b4ba25">XVprocSs_CfgInitialize()</a>, <a class="el" href="xvprocss_8h.html#abe70027604ba640917538338703b4a7f">XVprocSs_ReportSubsystemConfig()</a>, and <a class="el" href="xvprocss_8h.html#a49bdfcfcf9abb02829a7baf6603151f2">XVprocSs_SetSubsystemConfig()</a>.</p>
</div>
</div>
<a class="anchor" id="a3efa6b1d0d1b794f3f7992fca2d3989a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XVPROCSS_H</td>
</tr>
</table>
</div><div class="memdoc">
<p>&lt; prevent circular inclusions by using protection macros </p>
</div>
</div>
<a class="anchor" id="ab0a3f8f3946c8d71bac750de3c62b2c8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XVprocSs_IsConfigModeMax</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">XVprocSsPtr</td><td>)</td>
<td>&#160;&#160;&#160;((XVprocSsPtr)-&gt;Config.Topology == XVPROCSS_TOPOLOGY_FULL_FLEDGED)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro checks if subsystem is in Maximum (Full_Fledged) configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">XVprocSsPtr</td><td>is a pointer to the Video Processing subsystem instance</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return 1 if condition is TRUE or 0 if FALSE </dd></dl>
<p>Referenced by <a class="el" href="xvprocss_8h.html#a55d0807b3f476d2608a8c49b44388fec">XVprocSs_GetZoomPipWindow()</a>, <a class="el" href="xvprocss_8h.html#abe70027604ba640917538338703b4a7f">XVprocSs_ReportSubsystemConfig()</a>, <a class="el" href="xvprocss_8h.html#a84b1254cbeac02b7f81b1b90c721e84d">XVprocSs_SetPipMode()</a>, <a class="el" href="xvprocss_8h.html#a799db27e282d2762ee5cf4be40e70712">XVprocSs_SetZoomMode()</a>, <a class="el" href="xvprocss_8h.html#a8293d3dc637bc8c481b205d2272b4fc2">XVprocSs_SetZoomPipWindow()</a>, and <a class="el" href="xvprocss_8h.html#a4bdc6a00278cb1c847429d7498f8505e">XVprocSs_UpdateZoomPipWindow()</a>.</p>
</div>
</div>
<a class="anchor" id="a10342f4254eec4843f7cce3fd8744972"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XVprocSs_IsConfigModeSscalerOnly</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">XVprocSsPtr</td><td>)</td>
<td>&#160;&#160;&#160;((XVprocSsPtr)-&gt;Config.Topology == XVPROCSS_TOPOLOGY_SCALER_ONLY)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro checks if subsystem configuration is in Stream Mode (Scaler Only) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">XVprocSsPtr</td><td>is pointer to the Video Processing subsystem instance</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns 1 if condition is TRUE or 0 if FALSE </dd></dl>
</div>
</div>
<a class="anchor" id="ac7db821ac7a4624d461aed0b5241e7a4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XVprocSs_IsPipModeOn</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">XVprocSsPtr</td><td>)</td>
<td>&#160;&#160;&#160;((XVprocSsPtr)-&gt;CtxtData.PipEn)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro returns the current state of PIP Mode stored in subsystem internal scratch pad memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">XVprocSsPtr</td><td>is a pointer to the Video Processing subsystem instance</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns 1 if PIP mode is ON or 0 if OFF </dd></dl>
<p>Referenced by <a class="el" href="xvprocss_8h.html#abe70027604ba640917538338703b4a7f">XVprocSs_ReportSubsystemConfig()</a>, <a class="el" href="group__vprocss.html#gac644ac3d0f02790c168ebdc82c202179">XVprocSs_SetupRouterDataFlow()</a>, and <a class="el" href="xvprocss_8h.html#a4bdc6a00278cb1c847429d7498f8505e">XVprocSs_UpdateZoomPipWindow()</a>.</p>
</div>
</div>
<a class="anchor" id="afc56195b4e98f368335ca3e7e6d7e897"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XVprocSs_IsZoomModeOn</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">XVprocSsPtr</td><td>)</td>
<td>&#160;&#160;&#160;((XVprocSsPtr)-&gt;CtxtData.ZoomEn)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro returns the current state of Zoom Mode stored in subsystem internal scratch pad memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">XVprocSsPtr</td><td>is a pointer to the Video Processing subsystem instance</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns 1 if ZOOM mode is ON or 0 if OFF </dd></dl>
<p>Referenced by <a class="el" href="xvprocss_8h.html#abe70027604ba640917538338703b4a7f">XVprocSs_ReportSubsystemConfig()</a>, and <a class="el" href="group__vprocss.html#gac644ac3d0f02790c168ebdc82c202179">XVprocSs_SetupRouterDataFlow()</a>.</p>
</div>
</div>
<a class="anchor" id="a5d017fa1ca5cc101f1ada08fef364704"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XVprocSs_ResetPipModeFlag</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">XVprocSsPtr</td><td>)</td>
<td>&#160;&#160;&#160;((XVprocSsPtr)-&gt;CtxtData.PipEn = FALSE)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro clears the PIP mode flag stored in subsystem internal scratch pad memory. </p>
<p>This call has no side-effect</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">XVprocSsPtr</td><td>is a pointer to the Video Processing subsystem instance</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="a9700711526f9d3d645ae94cc0d2f534e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XVprocSs_ResetZoomModeFlag</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">XVprocSsPtr</td><td>)</td>
<td>&#160;&#160;&#160;((XVprocSsPtr)-&gt;CtxtData.ZoomEn = FALSE)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro clears the ZOOM mode flag stored in subsystem internal scratch pad memory. </p>
<p>This call has no side-effect</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">XVprocSsPtr</td><td>is pointer to the Video Processing subsystem instance</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="a641ccc79989ce1d91ce41d0376516fbf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XVprocSs_SetStreamColorDepth</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">Stream, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">ColorDepth&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;((Stream)-&gt;ColorDepth = ColorDepth)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro sets the specified stream's color depth. </p>
<p>It can be used to update input or output stream. This call has no side-effect in isolation For change to take effect user must trigger processing path reconfiguration by calling XVprocSs_ConfigureSubsystem()</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Stream</td><td>is a pointer to the Subsystem Input or Output Stream </td></tr>
<tr><td class="paramname">ColorDepth</td><td>is the requested color depth</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="aacab9c525fac94a691a0d8c86f50befb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XVprocSs_SetStreamColorFormat</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">Stream, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">ColorFormat&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;((Stream)-&gt;ColorFormatId = ColorFormat)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro sets the specified stream's color format. </p>
<p>It can be used to update input or output stream. This call has no side-effect in isolation. For change to take effect user must trigger processing path reconfiguration by calling XVprocSs_ConfigureSubsystem()</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Stream</td><td>is a pointer to the Subsystem Input or Output Stream </td></tr>
<tr><td class="paramname">ColorFormat</td><td>is the requested color format</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a7d60f719453eb6b2145c6a9cfa45422f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="xvprocss_8h.html#a7d60f719453eb6b2145c6a9cfa45422f">XVprocSs_ColorChannel</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>This typedef enumerates supported Color Channels. </p>
</div>
</div>
<a class="anchor" id="a785e997d05dbd568eb8eefccd57930c3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="xvprocss_8h.html#a785e997d05dbd568eb8eefccd57930c3">XVPROCSS_CONFIG_TOPOLOGY</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>This typedef enumerates supported subsystem configuration topology. </p>
</div>
</div>
<a class="anchor" id="a182e23b6dddfe4387c89aeca2f17ecb1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="xvprocss_8h.html#a182e23b6dddfe4387c89aeca2f17ecb1">XVprocSs_ScaleMode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>This typedef enumerates supported scaling modes. </p>
</div>
</div>
<a class="anchor" id="a63cf1a12fdc139677b3bbf33aeaa6c34"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="xvprocss_8h.html#a63cf1a12fdc139677b3bbf33aeaa6c34">XVPROCSS_SUBCORE_ID</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Subsystem sub-core layer 2 header files Layer 2 includes Layer-1. </p>
<p>This typedef enumerates the AXIS Switch Port for Sub-Core connection </p>
</div>
</div>
<a class="anchor" id="a0743bfb208145c415f5af1ba231245a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="xvprocss_8h.html#a0743bfb208145c415f5af1ba231245a6">XVprocSs_Win</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>This typedef enumerates types of Windows (Sub-frames) available in the Subsystem. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a3f3ca0942da6148e9f6e905637b4ba25"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XVprocSs_CfgInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss___config.html">XVprocSs_Config</a> *&#160;</td>
<td class="paramname"><em>CfgPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&#160;</td>
<td class="paramname"><em>EffectiveAddr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function initializes the video subsystem and included sub-cores. </p>
<p>This function must be called prior to using the subsystem. Initialization includes setting up the instance data for top level as well as all included sub-core therein, and ensuring the hardware is in a known stable state.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">CfgPtr</td><td>points to the configuration structure associated with the subsystem instance. </td></tr>
<tr><td class="paramname">EffectiveAddr</td><td>is the base address of the device. If address translation is being used, then this parameter must reflect the virtual base address. Otherwise, the physical address should be used.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if initialization is successful else XST_FAILURE </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss___config.html#a3c18ecb1536c482cff488bf2a2933d34">XVprocSs_Config::BaseAddress</a>, <a class="el" href="struct_x_vproc_ss___config.html#adc152d18753ba8d8ccc8a84e88008124">XVprocSs_Config::ColorDepth</a>, <a class="el" href="struct_x_vproc_ss.html#a63bcaaaf281c28f90fb0ca06167cb658">XVprocSs::Config</a>, <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>, <a class="el" href="struct_x_vproc_ss.html#ad05c179ff8b000570b16a8ac39f885d7">XVprocSs::CtxtData</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#a47999c6a0cdce82720b6179fe300625f">XVprocSs_ContextData::DeintBufAddr</a>, <a class="el" href="struct_x_vproc_ss.html#a70b00c8be1d60113022ab158e32a4a09">XVprocSs::DeintPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a06a30c3445c63503910dd13b6a0fa3b2">XVprocSs::FrameBufBaseaddr</a>, <a class="el" href="struct_x_vproc_ss.html#a63814b30da817de6be4ded0f074565f0">XVprocSs::HcrsmplrPtr</a>, <a class="el" href="struct_x_vproc_ss.html#aeede92e78217d1779b83bb72049ddf18">XVprocSs::HscalerPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a79fd49934846d367fd49b8d547f747e8">XVprocSs::IsReady</a>, <a class="el" href="struct_x_vproc_ss.html#ad9c2ec47b6605c96b285a5619e3d4394">XVprocSs::LboxPtr</a>, <a class="el" href="struct_x_vproc_ss___config.html#a45ca82741c4e29aa9e066c709fd5af13">XVprocSs_Config::MaxHeight</a>, <a class="el" href="struct_x_vproc_ss___config.html#a3a47592ee2ec32f6ed8b36a20501bf10">XVprocSs_Config::MaxWidth</a>, <a class="el" href="struct_x_vproc_ss___config.html#aaf0dea78fabcc75885ba91ed87800826">XVprocSs_Config::NumVidComponents</a>, <a class="el" href="xvprocss_8c.html#a4d7ecf33e09776dec21233b9817277f2">RESET_MASK_IP_AXIMM</a>, <a class="el" href="struct_x_vproc_ss.html#ae31f2a9f76251d0b9f102a0b90408f79">XVprocSs::RouterPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a1ae29293edf26b756464dcd743391ed3">XVprocSs::RstAximmPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a60d8aa2a5128b89edef5173f34fbf5ff">XVprocSs::RstAxisPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a26babb3d9887d74920ae4e962b73b13b">XVprocSs::VcrsmplrInPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a4333e58c62911e0ba8ea3174009282d9">XVprocSs::VcrsmplrOutPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a7110cce03d4d2ff4c4972bfe460eee42">XVprocSs::VdmaPtr</a>, <a class="el" href="struct_x_vproc_ss.html#ae32c3f62e37bb2bbe4c386bde8504fa8">XVprocSs::VscalerPtr</a>, <a class="el" href="xvprocss_8h.html#acbc2fc0f1cb34b9b607a59dc010e5c8c">XVprocSs_GetSubsystemTopology</a>, <a class="el" href="xvprocss_8c.html#ab65fda7ce63456d82274a463a4d4b72a">XVprocSs_Reset()</a>, <a class="el" href="group__vprocss.html#gac64c8e364daf39e7651eed206c2d0850">XVprocSs_SubcoreInitCsc()</a>, <a class="el" href="group__vprocss.html#ga9daad66c25baa7c1bae1d20cc98f6de6">XVprocSs_SubcoreInitDeinterlacer()</a>, <a class="el" href="group__vprocss.html#gadcf7e51fe6694861af6f60966486e377">XVprocSs_SubcoreInitHCrsmplr()</a>, <a class="el" href="group__vprocss.html#ga37a3b40bf8023df481f8a754dd66c265">XVprocSs_SubcoreInitHScaler()</a>, <a class="el" href="group__vprocss.html#ga189ca6f1b0d8bbc9d8a0bdbf3305ca9e">XVprocSs_SubcoreInitLetterbox()</a>, <a class="el" href="group__vprocss.html#ga02845975c50815d61ada800f45c5b2f2">XVprocSs_SubcoreInitResetAximm()</a>, <a class="el" href="group__vprocss.html#gad19dfad7c200c92b4f3aa56427cd3a5c">XVprocSs_SubcoreInitResetAxis()</a>, <a class="el" href="group__vprocss.html#ga6052a82202855525ff99f7ee1539d9ac">XVprocSs_SubcoreInitRouter()</a>, <a class="el" href="group__vprocss.html#ga0cdee507022445a5080d2895ad38eedc">XVprocSs_SubcoreInitVCrsmpleIn()</a>, <a class="el" href="group__vprocss.html#gaf80bf035984ff1d10c5205840c94673f">XVprocSs_SubcoreInitVCrsmpleOut()</a>, <a class="el" href="group__vprocss.html#gabc2baba55536b58504a6a19d9835b780">XVprocSs_SubcoreInitVdma()</a>, and <a class="el" href="group__vprocss.html#ga11671a79af5d522b00908b9f7df259ca">XVprocSs_SubcoreInitVScaler()</a>.</p>
</div>
</div>
<a class="anchor" id="a84c2f382ff78d4cc1c42628d0821870c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 XVprocSs_GetPictureBrightness </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function returns picture brighntess setting. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>current value (0-100), if csc subcore is included </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a9d75bba64f41d111ec0d7644f58895fe">XVprocSs::CscL2Reg</a>, and <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>.</p>
</div>
</div>
<a class="anchor" id="a0b0ba7cd1d7384d9acd813d3b38f2979"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XVidC_ColorRange XVprocSs_GetPictureColorRange </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function returns picture color range for output. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current set output range, if csc core is included<ul>
<li>XVIDC_CR_16_235</li>
<li>XVIDC_CR_16_240</li>
</ul>
</dd></dl>
<ul>
<li>XVIDC_CR_0_255 Else XVIDC_CR_UNKNOWN_RANGE </li>
</ul>
<p>References <a class="el" href="struct_x_vproc_ss.html#a9d75bba64f41d111ec0d7644f58895fe">XVprocSs::CscL2Reg</a>, and <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>.</p>
</div>
</div>
<a class="anchor" id="a0002b9c7a313219e4701514fe3acae7b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XVidC_ColorStd XVprocSs_GetPictureColorStdIn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function returns picture color standard setting for input. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current set color standard, if csc core is included<ul>
<li>XVIDC_BT_2020</li>
<li>XVIDC_BT_709</li>
<li>XVIDC_BT_601 Else XVIDC_BT_UNKNOWN </li>
</ul>
</dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a9d75bba64f41d111ec0d7644f58895fe">XVprocSs::CscL2Reg</a>, and <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>.</p>
</div>
</div>
<a class="anchor" id="a9b8d6dc56403962ed56cba01b01a3c2f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XVidC_ColorStd XVprocSs_GetPictureColorStdOut </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function returns picture color standard setting for output. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current set color standard, if csc core is included<ul>
<li>XVIDC_BT_2020</li>
<li>XVIDC_BT_709</li>
<li>XVIDC_BT_601 Else XVIDC_BT_UNKNOWN </li>
</ul>
</dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a9d75bba64f41d111ec0d7644f58895fe">XVprocSs::CscL2Reg</a>, and <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>.</p>
</div>
</div>
<a class="anchor" id="a628456c68064dcf093ecd1f7097e2879"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 XVprocSs_GetPictureContrast </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function returns picture contrast setting. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>current value (0-100), if csc subcore is included </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a9d75bba64f41d111ec0d7644f58895fe">XVprocSs::CscL2Reg</a>, and <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>.</p>
</div>
</div>
<a class="anchor" id="af8e9990e57b17ac9bdd9a911153ddbfe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 XVprocSs_GetPictureGain </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xvprocss_8h.html#a7d60f719453eb6b2145c6a9cfa45422f">XVprocSs_ColorChannel</a>&#160;</td>
<td class="paramname"><em>ChId</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function returns picture gain setting for the specified color channel. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">ChId</td><td>is the color channel id for which gain is requested</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>current value (0-100), if csc subcore is included </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a9d75bba64f41d111ec0d7644f58895fe">XVprocSs::CscL2Reg</a>, and <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>.</p>
</div>
</div>
<a class="anchor" id="a124ab620c7b3aa805ea8b0086ba0c344"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 XVprocSs_GetPictureSaturation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function returns picture saturation setting. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>current value (0-100), if csc subcore is included </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a9d75bba64f41d111ec0d7644f58895fe">XVprocSs::CscL2Reg</a>, and <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>.</p>
</div>
</div>
<a class="anchor" id="a55d0807b3f476d2608a8c49b44388fec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_GetZoomPipWindow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xvprocss_8h.html#a0743bfb208145c415f5af1ba231245a6">XVprocSs_Win</a>&#160;</td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XVidC_VideoWindow *&#160;</td>
<td class="paramname"><em>win</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function reads the user defined Zoom/Pip window from scratch pad memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">mode</td><td>is feature (PIP or ZOOM) whose window coordinates are to be retrieved </td></tr>
<tr><td class="paramname">win</td><td>is structure that will contain read window coordinates and size</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>For Zoom mode RD client window is read from scratch pad memory For Pip mode WR client window is read from scratch pad memory This function is not applicable in Subsystem Stream Mode Configuration </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#ad05c179ff8b000570b16a8ac39f885d7">XVprocSs::CtxtData</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#a4ea15beae039b9b0a7ae82ec89d57c80">XVprocSs_ContextData::RdWindow</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#a79a5e7387a84068901a397e67c494e4d">XVprocSs_ContextData::WrWindow</a>, and <a class="el" href="xvprocss_8h.html#ab0a3f8f3946c8d71bac750de3c62b2c8">XVprocSs_IsConfigModeMax</a>.</p>
<p>Referenced by <a class="el" href="xvprocss_8h.html#abe70027604ba640917538338703b4a7f">XVprocSs_ReportSubsystemConfig()</a>.</p>
</div>
</div>
<a class="anchor" id="a7a45d3f05110a0eda88d959ecae7cd07"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_LoadChromaResamplerCoeff </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&#160;</td>
<td class="paramname"><em>CoreId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&#160;</td>
<td class="paramname"><em>num_taps</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const short *&#160;</td>
<td class="paramname"><em>Coeff</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function enables user to load external filter coefficients for Chroma Resampler cores, independently for H &amp; V. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">CoreId</td><td>is the resampler core to be worked on<ul>
<li>XVPROCSS_SUBCORE_CR_H</li>
<li>XVPROCSS_SUBCORE_CR_V_IN</li>
<li>XVPROCSS_SUBCORE_CR_V_OUT </li>
</ul>
</td></tr>
<tr><td class="paramname">num_taps</td><td>is the taps of the resampler hw instance </td></tr>
<tr><td class="paramname">Coeff</td><td>is the pointer to the filter table to be loaded</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if Resampler cores are included in the subsystem </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a13c0cec470a7c213dfb3f699adf1006f">XVprocSs::HcrL2Reg</a>, <a class="el" href="struct_x_vproc_ss.html#a63814b30da817de6be4ded0f074565f0">XVprocSs::HcrsmplrPtr</a>, <a class="el" href="struct_x_vproc_ss.html#aea3f35980f813ddb17f2137765350ac5">XVprocSs::VcrInL2Reg</a>, <a class="el" href="struct_x_vproc_ss.html#ae8889dc79aa5b668c4c04d54628b6deb">XVprocSs::VcrOutL2Reg</a>, <a class="el" href="struct_x_vproc_ss.html#a26babb3d9887d74920ae4e962b73b13b">XVprocSs::VcrsmplrInPtr</a>, and <a class="el" href="struct_x_vproc_ss.html#a4333e58c62911e0ba8ea3174009282d9">XVprocSs::VcrsmplrOutPtr</a>.</p>
</div>
</div>
<a class="anchor" id="a1e48068cf0d1c946986e64b53cb24cc8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_LoadScalerCoeff </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&#160;</td>
<td class="paramname"><em>CoreId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&#160;</td>
<td class="paramname"><em>num_phases</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&#160;</td>
<td class="paramname"><em>num_taps</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const short *&#160;</td>
<td class="paramname"><em>Coeff</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function enables user to load external filter coefficients for Scaler cores, independently for H &amp; V. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">CoreId</td><td>is the Scaler core to be worked on<ul>
<li>XVPROCSS_SUBCORE_SCALER_V</li>
<li>XVPROCSS_SUBCORE_SCALER_H </li>
</ul>
</td></tr>
<tr><td class="paramname">num_phases</td><td>is the number of phases supported by Scaler </td></tr>
<tr><td class="paramname">num_taps</td><td>is the effective taps to be used by Scaler </td></tr>
<tr><td class="paramname">Coeff</td><td>is the pointer to the filter table to be loaded</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if Scaler cores are included in the subsystem </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#aeede92e78217d1779b83bb72049ddf18">XVprocSs::HscalerPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a69c1d38b7999afaaf06028ed639a36c9">XVprocSs::HscL2Reg</a>, <a class="el" href="struct_x_vproc_ss.html#ae32c3f62e37bb2bbe4c386bde8504fa8">XVprocSs::VscalerPtr</a>, and <a class="el" href="struct_x_vproc_ss.html#a190576c5a1808ccd6ff70a025d8d9064">XVprocSs::VscL2Reg</a>.</p>
</div>
</div>
<a class="anchor" id="acc2dd89a8c01c86bf6093d842db67262"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_ReportSubcoreStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&#160;</td>
<td class="paramname"><em>SubcoreId</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function reports the status of specified sub-core. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">SubcoreId</td><td>is the subcore index from the below list<ul>
<li>XVPROCSS_SUBCORE_SCALER_V</li>
<li>XVPROCSS_SUBCORE_SCALER_H</li>
<li>XVPROCSS_SUBCORE_VDMA</li>
<li>XVPROCSS_SUBCORE_LBOX</li>
<li>XVPROCSS_SUBCORE_CR_H</li>
<li>XVPROCSS_SUBCORE_CR_V_IN</li>
<li>XVPROCSS_SUBCORE_CR_V_OUT</li>
<li>XVPROCSS_SUBCORE_CSC</li>
<li>XVPROCSS_SUBCORE_DEINT</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>, <a class="el" href="struct_x_vproc_ss.html#ad05c179ff8b000570b16a8ac39f885d7">XVprocSs::CtxtData</a>, <a class="el" href="struct_x_vproc_ss.html#a70b00c8be1d60113022ab158e32a4a09">XVprocSs::DeintPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a63814b30da817de6be4ded0f074565f0">XVprocSs::HcrsmplrPtr</a>, <a class="el" href="struct_x_vproc_ss.html#aeede92e78217d1779b83bb72049ddf18">XVprocSs::HscalerPtr</a>, <a class="el" href="struct_x_vproc_ss.html#ad9c2ec47b6605c96b285a5619e3d4394">XVprocSs::LboxPtr</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#a1a149725ed4dd88fcff95af968d91239">XVprocSs_ContextData::PixelWidthInBits</a>, <a class="el" href="struct_x_vproc_ss.html#a26babb3d9887d74920ae4e962b73b13b">XVprocSs::VcrsmplrInPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a4333e58c62911e0ba8ea3174009282d9">XVprocSs::VcrsmplrOutPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a7110cce03d4d2ff4c4972bfe460eee42">XVprocSs::VdmaPtr</a>, and <a class="el" href="struct_x_vproc_ss.html#ae32c3f62e37bb2bbe4c386bde8504fa8">XVprocSs::VscalerPtr</a>.</p>
</div>
</div>
<a class="anchor" id="abe70027604ba640917538338703b4a7f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_ReportSubsystemConfig </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function reports the subsystem HW and input/output stream configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss___config.html#adc152d18753ba8d8ccc8a84e88008124">XVprocSs_Config::ColorDepth</a>, <a class="el" href="struct_x_vproc_ss.html#a63bcaaaf281c28f90fb0ca06167cb658">XVprocSs::Config</a>, <a class="el" href="struct_x_vproc_ss___config.html#a45ca82741c4e29aa9e066c709fd5af13">XVprocSs_Config::MaxHeight</a>, <a class="el" href="struct_x_vproc_ss___config.html#a3a47592ee2ec32f6ed8b36a20501bf10">XVprocSs_Config::MaxWidth</a>, <a class="el" href="struct_x_vproc_ss___config.html#aaf0dea78fabcc75885ba91ed87800826">XVprocSs_Config::NumVidComponents</a>, <a class="el" href="struct_x_vproc_ss___config.html#ab49aa8f927f6858960fddc1c3bcdc997">XVprocSs_Config::PixPerClock</a>, <a class="el" href="struct_x_vproc_ss.html#a6440efa76dbba290ebfdd4b603cff0b2">XVprocSs::VidIn</a>, <a class="el" href="struct_x_vproc_ss.html#a1fce9dc484558616980012f4a77764ee">XVprocSs::VidOut</a>, <a class="el" href="xvprocss_8h.html#a8e4c82e3faace0de0420bb1d814d8c8d">XVprocSs_GetPipZoomWinHStepSize</a>, <a class="el" href="xvprocss_8h.html#acbc2fc0f1cb34b9b607a59dc010e5c8c">XVprocSs_GetSubsystemTopology</a>, <a class="el" href="xvprocss_8c.html#a55d0807b3f476d2608a8c49b44388fec">XVprocSs_GetZoomPipWindow()</a>, <a class="el" href="xvprocss_8h.html#ab0a3f8f3946c8d71bac750de3c62b2c8">XVprocSs_IsConfigModeMax</a>, <a class="el" href="xvprocss_8h.html#ac7db821ac7a4624d461aed0b5241e7a4">XVprocSs_IsPipModeOn</a>, <a class="el" href="xvprocss_8h.html#afc56195b4e98f368335ca3e7e6d7e897">XVprocSs_IsZoomModeOn</a>, and <a class="el" href="xvprocss_8c.html#af3ef2fc6d79df8ccb528644f8e539828">XVprocSs_ReportSubsystemCoreInfo()</a>.</p>
</div>
</div>
<a class="anchor" id="af3ef2fc6d79df8ccb528644f8e539828"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_ReportSubsystemCoreInfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function reports list of cores included in Video Processing Subsystem. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a70b00c8be1d60113022ab158e32a4a09">XVprocSs::DeintPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a63814b30da817de6be4ded0f074565f0">XVprocSs::HcrsmplrPtr</a>, <a class="el" href="struct_x_vproc_ss.html#aeede92e78217d1779b83bb72049ddf18">XVprocSs::HscalerPtr</a>, <a class="el" href="struct_x_vproc_ss.html#ad9c2ec47b6605c96b285a5619e3d4394">XVprocSs::LboxPtr</a>, <a class="el" href="struct_x_vproc_ss.html#ae31f2a9f76251d0b9f102a0b90408f79">XVprocSs::RouterPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a1ae29293edf26b756464dcd743391ed3">XVprocSs::RstAximmPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a60d8aa2a5128b89edef5173f34fbf5ff">XVprocSs::RstAxisPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a26babb3d9887d74920ae4e962b73b13b">XVprocSs::VcrsmplrInPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a4333e58c62911e0ba8ea3174009282d9">XVprocSs::VcrsmplrOutPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a7110cce03d4d2ff4c4972bfe460eee42">XVprocSs::VdmaPtr</a>, and <a class="el" href="struct_x_vproc_ss.html#ae32c3f62e37bb2bbe4c386bde8504fa8">XVprocSs::VscalerPtr</a>.</p>
<p>Referenced by <a class="el" href="xvprocss_8h.html#abe70027604ba640917538338703b4a7f">XVprocSs_ReportSubsystemConfig()</a>.</p>
</div>
</div>
<a class="anchor" id="ab65fda7ce63456d82274a463a4d4b72a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_Reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function resets the video subsystem sub-cores. </p>
<p>There are 2 reset networks within the subsystem</p><ul>
<li>For cores that are on AXIS interface</li>
<li>For cores that are on AXI-MM interface</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#ad05c179ff8b000570b16a8ac39f885d7">XVprocSs::CtxtData</a>, <a class="el" href="struct_x_vproc_ss.html#a70b00c8be1d60113022ab158e32a4a09">XVprocSs::DeintPtr</a>, <a class="el" href="xvprocss_8c.html#a807d7469badf377f59e8d0cd1c690727">RESET_MASK_IP_AXIS</a>, <a class="el" href="struct_x_vproc_ss.html#a60d8aa2a5128b89edef5173f34fbf5ff">XVprocSs::RstAxisPtr</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#aa02a961464f60d239452ebc287a02b98">XVprocSs_ContextData::StartCore</a>, and <a class="el" href="struct_x_vproc_ss.html#a7110cce03d4d2ff4c4972bfe460eee42">XVprocSs::VdmaPtr</a>.</p>
<p>Referenced by <a class="el" href="xvprocss_8h.html#a3f3ca0942da6148e9f6e905637b4ba25">XVprocSs_CfgInitialize()</a>.</p>
</div>
</div>
<a class="anchor" id="a915162055bd362eb0e9e4f2b02db3ac0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_SetFrameBufBaseaddr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&#160;</td>
<td class="paramname"><em>addr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function sets the base address of the video frame buffers used by the subsystem instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">addr</td><td>is the base address of the video frame buffers</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a06a30c3445c63503910dd13b6a0fa3b2">XVprocSs::FrameBufBaseaddr</a>.</p>
</div>
</div>
<a class="anchor" id="a007dc9d0a75c0e09fd85d733230be564"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XVprocSs_SetPictureActiveWindow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XVidC_VideoWindow *&#160;</td>
<td class="paramname"><em>Win</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function sets picture active window. </p>
<p>Post this function call all further picture settings will apply only within the defined window. Active window gets reset everytime subsystem configuration changes</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">Win</td><td>is the pointer to window coordinates within which picture settings should be applied</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if window is valid else XST_FAILURE</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if CSC core is included in the subsystem </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>.</p>
</div>
</div>
<a class="anchor" id="a186ce7049ca9f0bcaf1a5e76866fbf31"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_SetPictureBrightness </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">s32&#160;</td>
<td class="paramname"><em>NewValue</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function updates picture brighntess setting with specified value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">NewValue</td><td>is the new value to be written<ul>
<li>Range: 0-100</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if CSC core is included in the subsystem </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a9d75bba64f41d111ec0d7644f58895fe">XVprocSs::CscL2Reg</a>, and <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>.</p>
</div>
</div>
<a class="anchor" id="aaa0f891d54cc88f0fd6d4ef93960aec1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_SetPictureColorRange </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XVidC_ColorRange&#160;</td>
<td class="paramname"><em>NewVal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function sets picture color range for output. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">NewVal</td><td>is the required color range<ul>
<li>XVIDC_CR_16_235</li>
<li>XVIDC_CR_16_240</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<ul>
<li>XVIDC_CR_0_255</li>
</ul>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if CSC core is included in the subsystem </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a9d75bba64f41d111ec0d7644f58895fe">XVprocSs::CscL2Reg</a>, and <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>.</p>
</div>
</div>
<a class="anchor" id="aa0b45fe8442626962284f22ea54e3d43"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_SetPictureColorStdIn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XVidC_ColorStd&#160;</td>
<td class="paramname"><em>NewVal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function sets picture color standard setting for input. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">NewVal</td><td>is the required color standard<ul>
<li>XVIDC_BT_2020</li>
<li>XVIDC_BT_709</li>
<li>XVIDC_BT_601</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if CSC core is included in the subsystem </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a9d75bba64f41d111ec0d7644f58895fe">XVprocSs::CscL2Reg</a>, and <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>.</p>
</div>
</div>
<a class="anchor" id="a01d3ff2ed3b9bb9c8808b187d1d685a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_SetPictureColorStdOut </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XVidC_ColorStd&#160;</td>
<td class="paramname"><em>NewVal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function sets picture color standard setting for output. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">NewVal</td><td>is the required color standard<ul>
<li>XVIDC_BT_2020</li>
<li>XVIDC_BT_709</li>
<li>XVIDC_BT_601</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if CSC core is included in the subsystem </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a9d75bba64f41d111ec0d7644f58895fe">XVprocSs::CscL2Reg</a>, and <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>.</p>
</div>
</div>
<a class="anchor" id="a65dcb2906de961ca823262f6b6039b87"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_SetPictureContrast </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">s32&#160;</td>
<td class="paramname"><em>NewValue</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function updates picture contrast setting with specified value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">NewValue</td><td>is the new value to be written<ul>
<li>Range: 0-100</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if CSC core is included in the subsystem </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a9d75bba64f41d111ec0d7644f58895fe">XVprocSs::CscL2Reg</a>, and <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>.</p>
</div>
</div>
<a class="anchor" id="a05099b854831e91e4a2d6c39395c267d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_SetPictureGain </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xvprocss_8h.html#a7d60f719453eb6b2145c6a9cfa45422f">XVprocSs_ColorChannel</a>&#160;</td>
<td class="paramname"><em>ChId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">s32&#160;</td>
<td class="paramname"><em>NewValue</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function updates picture gain setting with specified value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">ChId</td><td>is the color channel id for which gain is to be updated </td></tr>
<tr><td class="paramname">NewValue</td><td>is the new value to be written<ul>
<li>Range: 0-100</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if CSC core is included in the subsystem </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a9d75bba64f41d111ec0d7644f58895fe">XVprocSs::CscL2Reg</a>, and <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>.</p>
</div>
</div>
<a class="anchor" id="afccd0de81f7e5dc6bc19ce61eae38e92"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_SetPictureSaturation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">s32&#160;</td>
<td class="paramname"><em>NewValue</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function updates picture saturation setting with specified value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">NewValue</td><td>is the new value to be written<ul>
<li>Range: 0-100</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if CSC core is included in the subsystem </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a9d75bba64f41d111ec0d7644f58895fe">XVprocSs::CscL2Reg</a>, and <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>.</p>
</div>
</div>
<a class="anchor" id="a34d1e25e364c4699c60ee30839f141f7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_SetPIPBackgroundColor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XLboxColorId&#160;</td>
<td class="paramname"><em>ColorId</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function sets PIP background color. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">ColorIs</td><td>is the requested background color<ul>
<li>XLBOX_BKGND_BLACK</li>
<li>XLBOX_BKGND_WHITE</li>
<li>XLBOX_BKGND_RED</li>
<li>XLBOX_BKGND_GREEN</li>
<li>XLBOX_BKGND_BLUE</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if Letterbox core is included in the subsystem </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#ad05c179ff8b000570b16a8ac39f885d7">XVprocSs::CtxtData</a>, <a class="el" href="struct_x_vproc_ss.html#ad9c2ec47b6605c96b285a5619e3d4394">XVprocSs::LboxPtr</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#a8e3923646d6b89ff1970f62e0d63d259">XVprocSs_ContextData::StrmCformat</a>, and <a class="el" href="struct_x_vproc_ss.html#a6440efa76dbba290ebfdd4b603cff0b2">XVprocSs::VidIn</a>.</p>
</div>
</div>
<a class="anchor" id="a84b1254cbeac02b7f81b1b90c721e84d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_SetPipMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&#160;</td>
<td class="paramname"><em>OnOff</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function configures the video subsystem to enable/disable PIP feature If PIP mode is set to ON but user has not set window coordinates then half of input stream resolution at coordinates 0,0 is set as the default zoom window. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">OnOff</td><td>is the action required</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>User must call XVprocSs_ConfigureSubsystem() for change to take effect This call has not been added here such that it provides an opportunity to make the change during vertical blanking at system level. This behavior will change once shadow register support is available in sub-core IP's This function is not applicable in Subsystem Stream Mode Configuration </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#ad05c179ff8b000570b16a8ac39f885d7">XVprocSs::CtxtData</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#a153a8ddde9a7c9d7b4fd9abb01339af2">XVprocSs_ContextData::PipEn</a>, <a class="el" href="xvprocss_8h.html#ab0a3f8f3946c8d71bac750de3c62b2c8">XVprocSs_IsConfigModeMax</a>, and <a class="el" href="struct_x_vproc_ss___context_data.html#a2295b97e85e14cba835e65ce302a7076">XVprocSs_ContextData::ZoomEn</a>.</p>
</div>
</div>
<a class="anchor" id="aa00540dce648d610e8087f2ec6dc5462"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XVprocSs_SetStreamResolution </td>
<td>(</td>
<td class="paramtype">XVidC_VideoStream *&#160;</td>
<td class="paramname"><em>StreamPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XVidC_VideoMode&#160;</td>
<td class="paramname"><em>VmId</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function validates the video mode id against the supported resolutions and if successful extracts the timing information for the mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">StreamPtr</td><td>is a pointer to the video stream to be configured </td></tr>
<tr><td class="paramname">VmId</td><td>is the Video Mode ID of the new resolution to be set</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCESS if successful else XST_FAILURE </dd></dl>
<p>Referenced by <a class="el" href="xvprocss_8h.html#a47c310a89b7072313404485d4bb9b03f">XVprocSs_SetVidStreamIn()</a>, and <a class="el" href="xvprocss_8h.html#a28fae690c023b4d8b7a1d9b9c68c966c">XVprocSs_SetVidStreamOut()</a>.</p>
</div>
</div>
<a class="anchor" id="a49bdfcfcf9abb02829a7baf6603151f2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XVprocSs_SetSubsystemConfig </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function is the entry point into the video processing subsystem driver processing path. </p>
<p>It will examine the instantiated subsystem configuration mode and the input and output stream configuration. Based on the available information control flow is determined and requisite sub-cores are configured to implement the supported use case</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful else XST_FAILURE </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a6440efa76dbba290ebfdd4b603cff0b2">XVprocSs::VidIn</a>, <a class="el" href="struct_x_vproc_ss.html#a1fce9dc484558616980012f4a77764ee">XVprocSs::VidOut</a>, and <a class="el" href="xvprocss_8h.html#acbc2fc0f1cb34b9b607a59dc010e5c8c">XVprocSs_GetSubsystemTopology</a>.</p>
</div>
</div>
<a class="anchor" id="add7069c7a21fe0cf07779dcb945cab96"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_SetUserTimerHandler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XVidC_DelayHandler&#160;</td>
<td class="paramname"><em>CallbackFunc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>CallbackRef</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function registers the user defined delay/sleep function with subsystem. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance </td></tr>
<tr><td class="paramname">CallbackFunc</td><td>is the function pointer to the user defined delay function </td></tr>
<tr><td class="paramname">CallbackRef</td><td>is the pointer to timer instance used by the delay function</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a7eb355254239a53c3c14cccdcc4d8045">XVprocSs::UsrDelayUs</a>, and <a class="el" href="struct_x_vproc_ss.html#a4a2b5a8f4a791f610db50f9a5c4032dd">XVprocSs::UsrTmrPtr</a>.</p>
</div>
</div>
<a class="anchor" id="a47c310a89b7072313404485d4bb9b03f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XVprocSs_SetVidStreamIn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XVidC_VideoStream *&#160;</td>
<td class="paramname"><em>StrmIn</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function configures the video subsystem input interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">StrmIn</td><td>is the pointer to input stream configuration</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCESS if successful else XST_FAILURE </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a6440efa76dbba290ebfdd4b603cff0b2">XVprocSs::VidIn</a>, and <a class="el" href="xvprocss_8c.html#aa00540dce648d610e8087f2ec6dc5462">XVprocSs_SetStreamResolution()</a>.</p>
</div>
</div>
<a class="anchor" id="a28fae690c023b4d8b7a1d9b9c68c966c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XVprocSs_SetVidStreamOut </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XVidC_VideoStream *&#160;</td>
<td class="paramname"><em>StrmOut</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function configures the video subsystem output interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">StrmOut</td><td>is the pointer to input stream configuration</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCESS if successful else XST_FAILURE </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a1fce9dc484558616980012f4a77764ee">XVprocSs::VidOut</a>, and <a class="el" href="xvprocss_8c.html#aa00540dce648d610e8087f2ec6dc5462">XVprocSs_SetStreamResolution()</a>.</p>
</div>
</div>
<a class="anchor" id="a799db27e282d2762ee5cf4be40e70712"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_SetZoomMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&#160;</td>
<td class="paramname"><em>OnOff</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function configures the video subsystem to enable/disable ZOOM feature If ZOOM mode is set to ON but user has not set window coordinates then quarter of input stream resolution at coordinates 0,0 is set as the default zoom window. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">OnOff</td><td>is the action required</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>User must call XVprocSs_ConfigureSubsystem() for change to take effect This call has not been added here such that it provides an opportunity to make the change during vertical blanking at system level. This behavior will change once shadow register support is available in sub-core IP's This function is not applicable in Subsystem Stream Mode Configuration </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#ad05c179ff8b000570b16a8ac39f885d7">XVprocSs::CtxtData</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#a153a8ddde9a7c9d7b4fd9abb01339af2">XVprocSs_ContextData::PipEn</a>, <a class="el" href="xvprocss_8h.html#ab0a3f8f3946c8d71bac750de3c62b2c8">XVprocSs_IsConfigModeMax</a>, and <a class="el" href="struct_x_vproc_ss___context_data.html#a2295b97e85e14cba835e65ce302a7076">XVprocSs_ContextData::ZoomEn</a>.</p>
</div>
</div>
<a class="anchor" id="a8293d3dc637bc8c481b205d2272b4fc2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_SetZoomPipWindow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xvprocss_8h.html#a0743bfb208145c415f5af1ba231245a6">XVprocSs_Win</a>&#160;</td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XVidC_VideoWindow *&#160;</td>
<td class="paramname"><em>win</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function allows user to set the Zoom or PIP window. </p>
<p>Scratch pad memory is updated with the new window information</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
<tr><td class="paramname">mode</td><td>is feature to be updated PIP or ZOOM </td></tr>
<tr><td class="paramname">win</td><td>is structure that contains window coordinates and size</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>For Zoom mode RD client window is written in scratch pad memory For Pip mode WR client window is written in scratch pad memory This function is not applicable in Subsystem Stream Mode Configuration </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a63bcaaaf281c28f90fb0ca06167cb658">XVprocSs::Config</a>, <a class="el" href="struct_x_vproc_ss.html#ad05c179ff8b000570b16a8ac39f885d7">XVprocSs::CtxtData</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#a03fb0a6f829e3ae161da411174b06333">XVprocSs_ContextData::PixelHStepSize</a>, <a class="el" href="struct_x_vproc_ss___config.html#ab49aa8f927f6858960fddc1c3bcdc997">XVprocSs_Config::PixPerClock</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#a4ea15beae039b9b0a7ae82ec89d57c80">XVprocSs_ContextData::RdWindow</a>, <a class="el" href="struct_x_vproc_ss.html#a7110cce03d4d2ff4c4972bfe460eee42">XVprocSs::VdmaPtr</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#a79a5e7387a84068901a397e67c494e4d">XVprocSs_ContextData::WrWindow</a>, and <a class="el" href="xvprocss_8h.html#ab0a3f8f3946c8d71bac750de3c62b2c8">XVprocSs_IsConfigModeMax</a>.</p>
</div>
</div>
<a class="anchor" id="a0f673d448bb7702661b702519de94fd9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_Start </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function starts the video subsystem including all sub-cores that are included in the processing pipeline for a given use-case. </p>
<p>Video pipe is started from back to front </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Cores are started only if the corresponding start flag in the scratch pad memory is set. This allows to selectively start only those cores included in the processing chain </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>, <a class="el" href="struct_x_vproc_ss.html#ad05c179ff8b000570b16a8ac39f885d7">XVprocSs::CtxtData</a>, <a class="el" href="struct_x_vproc_ss.html#a70b00c8be1d60113022ab158e32a4a09">XVprocSs::DeintPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a63814b30da817de6be4ded0f074565f0">XVprocSs::HcrsmplrPtr</a>, <a class="el" href="struct_x_vproc_ss.html#aeede92e78217d1779b83bb72049ddf18">XVprocSs::HscalerPtr</a>, <a class="el" href="struct_x_vproc_ss.html#ad9c2ec47b6605c96b285a5619e3d4394">XVprocSs::LboxPtr</a>, <a class="el" href="xvprocss_8c.html#a8af9f5be90c165ff01c98bde72ef2d48">RESET_MASK_VIDEO_IN</a>, <a class="el" href="struct_x_vproc_ss.html#a60d8aa2a5128b89edef5173f34fbf5ff">XVprocSs::RstAxisPtr</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#aa02a961464f60d239452ebc287a02b98">XVprocSs_ContextData::StartCore</a>, <a class="el" href="struct_x_vproc_ss.html#a26babb3d9887d74920ae4e962b73b13b">XVprocSs::VcrsmplrInPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a4333e58c62911e0ba8ea3174009282d9">XVprocSs::VcrsmplrOutPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a7110cce03d4d2ff4c4972bfe460eee42">XVprocSs::VdmaPtr</a>, and <a class="el" href="struct_x_vproc_ss.html#ae32c3f62e37bb2bbe4c386bde8504fa8">XVprocSs::VscalerPtr</a>.</p>
<p>Referenced by <a class="el" href="group__vprocss.html#gac644ac3d0f02790c168ebdc82c202179">XVprocSs_SetupRouterDataFlow()</a>.</p>
</div>
</div>
<a class="anchor" id="a1f28821282af5defa07408d1c00c2bfe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_Stop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function stops the video subsystem including all sub-cores Stop the video pipe starting from front to back. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#a445b58ef80648dd22c3595209415aae7">XVprocSs::CscPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a70b00c8be1d60113022ab158e32a4a09">XVprocSs::DeintPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a63814b30da817de6be4ded0f074565f0">XVprocSs::HcrsmplrPtr</a>, <a class="el" href="struct_x_vproc_ss.html#aeede92e78217d1779b83bb72049ddf18">XVprocSs::HscalerPtr</a>, <a class="el" href="struct_x_vproc_ss.html#ad9c2ec47b6605c96b285a5619e3d4394">XVprocSs::LboxPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a26babb3d9887d74920ae4e962b73b13b">XVprocSs::VcrsmplrInPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a4333e58c62911e0ba8ea3174009282d9">XVprocSs::VcrsmplrOutPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a7110cce03d4d2ff4c4972bfe460eee42">XVprocSs::VdmaPtr</a>, and <a class="el" href="struct_x_vproc_ss.html#ae32c3f62e37bb2bbe4c386bde8504fa8">XVprocSs::VscalerPtr</a>.</p>
</div>
</div>
<a class="anchor" id="a4bdc6a00278cb1c847429d7498f8505e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XVprocSs_UpdateZoomPipWindow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
<td class="paramname"><em>InstancePtr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function updates the Pip/Zoom window currently on screen in-place. </p>
<p>This implies the video is not blanked and the new coordinates will update instantly as the function executes</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function must be called only after the respective mode (PIP/Zoom) has been enabled and user wants to move window to a new location This function is not applicable in Subsystem Stream Mode Configuration </dd></dl>
<p>References <a class="el" href="struct_x_vproc_ss.html#ad05c179ff8b000570b16a8ac39f885d7">XVprocSs::CtxtData</a>, <a class="el" href="struct_x_vproc_ss.html#ad9c2ec47b6605c96b285a5619e3d4394">XVprocSs::LboxPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a7110cce03d4d2ff4c4972bfe460eee42">XVprocSs::VdmaPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a1fce9dc484558616980012f4a77764ee">XVprocSs::VidOut</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#a79a5e7387a84068901a397e67c494e4d">XVprocSs_ContextData::WrWindow</a>, <a class="el" href="xvprocss_8h.html#ab0a3f8f3946c8d71bac750de3c62b2c8">XVprocSs_IsConfigModeMax</a>, and <a class="el" href="xvprocss_8h.html#ac7db821ac7a4624d461aed0b5241e7a4">XVprocSs_IsPipModeOn</a>.</p>
</div>
</div>
</div><!-- contents -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink