Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libjpeg-turbo / aa367580e83c9a2a35ee81650c997d529a02bfd8 / . / doc / html / structtjtransform.html
blob: ef2c8d59c3c3bbe36d64073e7b8a2d092ba58570 [file] [log] [blame]
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.3.1"/>
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]7<title>TurboJPEG: tjtransform Struct Reference</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]9<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]11<link href="search/search.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="search/search.js"></script>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]13<script type="text/javascript">
14 $(document).ready(function() { searchBox.OnSelectItem(0); });
15</script>
16<link href="doxygen.css" rel="stylesheet" type="text/css" />
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]17</head>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]18<body>
19<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]20<div id="titlearea">
21<table cellspacing="0" cellpadding="0">
22 <tbody>
23 <tr style="height: 56px;">
24 <td style="padding-left: 0.5em;">
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]25 <div id="projectname">TurboJPEG
26 &#160;<span id="projectnumber">1.4</span>
27 </div>
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]28 </td>
29 </tr>
30 </tbody>
31</table>
32</div>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]33<!-- end header part -->
34<!-- Generated by Doxygen 1.8.3.1 -->
35<script type="text/javascript">
36var searchBox = new SearchBox("searchBox", "search",false,'Search');
37</script>
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]38 <div id="navrow1" class="tabs">
39 <ul class="tablist">
40 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
41 <li><a href="modules.html"><span>Modules</span></a></li>
42 <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]43 <li>
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]44 <div id="MSearchBox" class="MSearchBoxInactive">
45 <span class="left">
46 <img id="MSearchSelect" src="search/mag_sel.png"
47 onmouseover="return searchBox.OnSearchSelectShow()"
48 onmouseout="return searchBox.OnSearchSelectHide()"
49 alt=""/>
50 <input type="text" id="MSearchField" value="Search" accesskey="S"
51 onfocus="searchBox.OnSearchFieldFocus(true)"
52 onblur="searchBox.OnSearchFieldFocus(false)"
53 onkeyup="searchBox.OnSearchFieldChange(event)"/>
54 </span><span class="right">
55 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
56 </span>
57 </div>
58 </li>
59 </ul>
60 </div>
61 <div id="navrow2" class="tabs2">
62 <ul class="tablist">
63 <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
64 <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
65 <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
66 </ul>
67 </div>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]68<!-- window showing the filter options -->
69<div id="MSearchSelectWindow"
70 onmouseover="return searchBox.OnSearchSelectShow()"
71 onmouseout="return searchBox.OnSearchSelectHide()"
72 onkeydown="return searchBox.OnSearchSelectKey(event)">
73<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a></div>
74
75<!-- iframe showing the search results (closed by default) -->
76<div id="MSearchResultsWindow">
77<iframe src="javascript:void(0)" frameborder="0"
78 name="MSearchResults" id="MSearchResults">
79</iframe>
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]80</div>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]81
82</div><!-- top -->
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]83<div class="header">
84 <div class="summary">
85<a href="#pub-attribs">Data Fields</a> </div>
86 <div class="headertitle">
87<div class="title">tjtransform Struct Reference<div class="ingroups"><a class="el" href="group___turbo_j_p_e_g.html">TurboJPEG</a></div></div> </div>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]88</div><!--header-->
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]89<div class="contents">
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]90
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]91<p>Lossless transform.
92 <a href="structtjtransform.html#details">More...</a></p>
93
94<p><code>#include &lt;turbojpeg.h&gt;</code></p>
95<table class="memberdecls">
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]96<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]97Data Fields</h2></td></tr>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]98<tr class="memitem:ac324e5e442abec8a961e5bf219db12cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structtjregion.html">tjregion</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtjtransform.html#ac324e5e442abec8a961e5bf219db12cf">r</a></td></tr>
99<tr class="memdesc:ac324e5e442abec8a961e5bf219db12cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cropping region. <a href="#ac324e5e442abec8a961e5bf219db12cf">More...</a><br/></td></tr>
100<tr class="separator:ac324e5e442abec8a961e5bf219db12cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
101<tr class="memitem:a2525aab4ba6978a1c273f74fef50e498"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtjtransform.html#a2525aab4ba6978a1c273f74fef50e498">op</a></td></tr>
102<tr class="memdesc:a2525aab4ba6978a1c273f74fef50e498"><td class="mdescLeft">&#160;</td><td class="mdescRight">One of the <a class="el" href="group___turbo_j_p_e_g.html#ga2de531af4e7e6c4f124908376b354866">transform operations</a>. <a href="#a2525aab4ba6978a1c273f74fef50e498">More...</a><br/></td></tr>
103<tr class="separator:a2525aab4ba6978a1c273f74fef50e498"><td class="memSeparator" colspan="2">&#160;</td></tr>
104<tr class="memitem:ac0e74655baa4402209a21e1ae481c8f6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtjtransform.html#ac0e74655baa4402209a21e1ae481c8f6">options</a></td></tr>
105<tr class="memdesc:ac0e74655baa4402209a21e1ae481c8f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The bitwise OR of one of more of the <a class="el" href="group___turbo_j_p_e_g.html#ga9c771a757fc1294add611906b89ab2d2">transform options</a>. <a href="#ac0e74655baa4402209a21e1ae481c8f6">More...</a><br/></td></tr>
106<tr class="separator:ac0e74655baa4402209a21e1ae481c8f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
107<tr class="memitem:a688fe8f1a8ecc12a538d9e561cf338e3"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtjtransform.html#a688fe8f1a8ecc12a538d9e561cf338e3">data</a></td></tr>
108<tr class="memdesc:a688fe8f1a8ecc12a538d9e561cf338e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arbitrary data that can be accessed within the body of the callback function. <a href="#a688fe8f1a8ecc12a538d9e561cf338e3">More...</a><br/></td></tr>
109<tr class="separator:a688fe8f1a8ecc12a538d9e561cf338e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
110<tr class="memitem:a43ee1bcdd2a8d7249a756774f78793c1"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtjtransform.html#a43ee1bcdd2a8d7249a756774f78793c1">customFilter</a> )(short *coeffs, <a class="el" href="structtjregion.html">tjregion</a> arrayRegion, <a class="el" href="structtjregion.html">tjregion</a> planeRegion, int componentIndex, int transformIndex, struct <a class="el" href="structtjtransform.html">tjtransform</a> *transform)</td></tr>
DRCcd7c3e62013-08-23 02:49:25 +0000[diff] [blame]111<tr class="memdesc:a43ee1bcdd2a8d7249a756774f78793c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">A callback function that can be used to modify the DCT coefficients after they are losslessly transformed but before they are transcoded to a new JPEG image. <a href="#a43ee1bcdd2a8d7249a756774f78793c1">More...</a><br/></td></tr>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]112<tr class="separator:a43ee1bcdd2a8d7249a756774f78793c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]113</table>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]114<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]115<div class="textblock"><p>Lossless transform. </p>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]116</div><h2 class="groupheader">Field Documentation</h2>
117<a class="anchor" id="a43ee1bcdd2a8d7249a756774f78793c1"></a>
DRC7bf04d32011-09-17 00:18:31 +0000[diff] [blame]118<div class="memitem">
119<div class="memproto">
120 <table class="memname">
121 <tr>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]122 <td class="memname">int(* tjtransform::customFilter)(short *coeffs, <a class="el" href="structtjregion.html">tjregion</a> arrayRegion, <a class="el" href="structtjregion.html">tjregion</a> planeRegion, int componentIndex, int transformIndex, struct <a class="el" href="structtjtransform.html">tjtransform</a> *transform)</td>
DRC7bf04d32011-09-17 00:18:31 +0000[diff] [blame]123 </tr>
124 </table>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]125</div><div class="memdoc">
DRC7bf04d32011-09-17 00:18:31 +0000[diff] [blame]126
DRCcd7c3e62013-08-23 02:49:25 +0000[diff] [blame]127<p>A callback function that can be used to modify the DCT coefficients after they are losslessly transformed but before they are transcoded to a new JPEG image. </p>
DRC7bf04d32011-09-17 00:18:31 +0000[diff] [blame]128<p>This allows for custom filters or other transformations to be applied in the frequency domain.</p>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]129<dl class="params"><dt>Parameters</dt><dd>
DRC7bf04d32011-09-17 00:18:31 +0000[diff] [blame]130 <table class="params">
DRCf5467112011-09-20 05:02:19 +0000[diff] [blame]131 <tr><td class="paramname">coeffs</td><td>pointer to an array of transformed DCT coefficients. (NOTE: this pointer is not guaranteed to be valid once the callback returns, so applications wishing to hand off the DCT coefficients to another function or library should make a copy of them within the body of the callback.) </td></tr>
DRCf69dc282011-09-20 18:20:43 +0000[diff] [blame]132 <tr><td class="paramname">arrayRegion</td><td><a class="el" href="structtjregion.html" title="Cropping region.">tjregion</a> structure containing the width and height of the array pointed to by <code>coeffs</code> as well as its offset relative to the component plane. TurboJPEG implementations may choose to split each component plane into multiple DCT coefficient arrays and call the callback function once for each array. </td></tr>
DRCf5467112011-09-20 05:02:19 +0000[diff] [blame]133 <tr><td class="paramname">planeRegion</td><td><a class="el" href="structtjregion.html" title="Cropping region.">tjregion</a> structure containing the width and height of the component plane to which <code>coeffs</code> belongs </td></tr>
DRCb3a028e2013-11-25 21:08:47 +0000[diff] [blame]134 <tr><td class="paramname">componentID</td><td>ID number of the component plane to which <code>coeffs</code> belongs (Y, Cb, and Cr have, respectively, ID's of 0, 1, and 2 in typical JPEG images.) </td></tr>
DRC01fdcc32013-04-26 08:41:25 +0000[diff] [blame]135 <tr><td class="paramname">transformID</td><td>ID number of the transformed image to which <code>coeffs</code> belongs. This is the same as the index of the transform in the <code>transforms</code> array that was passed to <a class="el" href="group___turbo_j_p_e_g.html#gae403193ceb4aafb7e0f56ab587b48616" title="Losslessly transform a JPEG image into another JPEG image.">tjTransform()</a>. </td></tr>
DRCf5467112011-09-20 05:02:19 +0000[diff] [blame]136 <tr><td class="paramname">transform</td><td>a pointer to a <a class="el" href="structtjtransform.html" title="Lossless transform.">tjtransform</a> structure that specifies the parameters and/or cropping region for this transform</td></tr>
DRC7bf04d32011-09-17 00:18:31 +0000[diff] [blame]137 </table>
138 </dd>
139</dl>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]140<dl class="section return"><dt>Returns</dt><dd>0 if the callback was successful, or -1 if an error occurred. </dd></dl>
DRC7bf04d32011-09-17 00:18:31 +0000[diff] [blame]141
142</div>
143</div>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]144<a class="anchor" id="a688fe8f1a8ecc12a538d9e561cf338e3"></a>
DRCf5467112011-09-20 05:02:19 +0000[diff] [blame]145<div class="memitem">
146<div class="memproto">
147 <table class="memname">
148 <tr>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]149 <td class="memname">void* tjtransform::data</td>
DRCf5467112011-09-20 05:02:19 +0000[diff] [blame]150 </tr>
151 </table>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]152</div><div class="memdoc">
DRCf5467112011-09-20 05:02:19 +0000[diff] [blame]153
154<p>Arbitrary data that can be accessed within the body of the callback function. </p>
155
156</div>
157</div>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]158<a class="anchor" id="a2525aab4ba6978a1c273f74fef50e498"></a>
DRC25b995a2011-05-21 15:34:54 +0000[diff] [blame]159<div class="memitem">
160<div class="memproto">
161 <table class="memname">
162 <tr>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]163 <td class="memname">int tjtransform::op</td>
DRC25b995a2011-05-21 15:34:54 +0000[diff] [blame]164 </tr>
165 </table>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]166</div><div class="memdoc">
DRC25b995a2011-05-21 15:34:54 +0000[diff] [blame]167
168<p>One of the <a class="el" href="group___turbo_j_p_e_g.html#ga2de531af4e7e6c4f124908376b354866">transform operations</a>. </p>
169
170</div>
171</div>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]172<a class="anchor" id="ac0e74655baa4402209a21e1ae481c8f6"></a>
DRC25b995a2011-05-21 15:34:54 +0000[diff] [blame]173<div class="memitem">
174<div class="memproto">
175 <table class="memname">
176 <tr>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]177 <td class="memname">int tjtransform::options</td>
DRC25b995a2011-05-21 15:34:54 +0000[diff] [blame]178 </tr>
179 </table>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]180</div><div class="memdoc">
DRC25b995a2011-05-21 15:34:54 +0000[diff] [blame]181
182<p>The bitwise OR of one of more of the <a class="el" href="group___turbo_j_p_e_g.html#ga9c771a757fc1294add611906b89ab2d2">transform options</a>. </p>
183
184</div>
185</div>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]186<a class="anchor" id="ac324e5e442abec8a961e5bf219db12cf"></a>
DRC25b995a2011-05-21 15:34:54 +0000[diff] [blame]187<div class="memitem">
188<div class="memproto">
189 <table class="memname">
190 <tr>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]191 <td class="memname"><a class="el" href="structtjregion.html">tjregion</a> tjtransform::r</td>
DRC25b995a2011-05-21 15:34:54 +0000[diff] [blame]192 </tr>
193 </table>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]194</div><div class="memdoc">
DRC25b995a2011-05-21 15:34:54 +0000[diff] [blame]195
196<p>Cropping region. </p>
197
198</div>
199</div>
200<hr/>The documentation for this struct was generated from the following file:<ul>
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]201<li>turbojpeg.h</li>
202</ul>
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]203</div><!-- contents -->
204<!-- start footer part -->
205<hr class="footer"/><address class="footer"><small>
DRCca866c42013-08-18 09:37:48 +0000[diff] [blame]206Generated by &#160;<a href="http://www.doxygen.org/index.html">
DRCa4a48ed2013-08-18 08:47:03 +0000[diff] [blame]207<img class="footer" src="doxygen.png" alt="doxygen"/>
208</a> 1.8.3.1
209</small></address>
DRC9b28def2011-05-21 14:37:15 +0000[diff] [blame]210</body>
211</html>