doc/html/structtjtransform.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.20"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>TurboJPEG: tjtransform Struct Reference</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13 <script type="text/javascript" src="search/searchdata.js"></script>
  14 <script type="text/javascript" src="search/search.js"></script>
  15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16 <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
  17 </head>
  18 <body>
  19 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20 <div id="titlearea">
  21 <table cellspacing="0" cellpadding="0">
  22  <tbody>
  23  <tr style="height: 56px;">
  24   <td id="projectalign" style="padding-left: 0.5em;">
  25    <div id="projectname">TurboJPEG
  26    &#160;<span id="projectnumber">3</span>
  27    </div>
  28   </td>
  29  </tr>
  30  </tbody>
  31 </table>
  32 </div>
  33 <!-- end header part -->
  34 <!-- Generated by Doxygen 1.8.20 -->
  35 <script type="text/javascript">
  36 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  37 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38 /* @license-end */
  39 </script>
  40 <script type="text/javascript" src="menudata.js"></script>
  41 <script type="text/javascript" src="menu.js"></script>
  42 <script type="text/javascript">
  43 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  44 $(function() {
  45   initMenu('',true,false,'search.php','Search');
  46   $(document).ready(function() { init_search(); });
  47 });
  48 /* @license-end */</script>
  49 <div id="main-nav"></div>
  50 <!-- window showing the filter options -->
  51 <div id="MSearchSelectWindow"
  52      onmouseover="return searchBox.OnSearchSelectShow()"
  53      onmouseout="return searchBox.OnSearchSelectHide()"
  54      onkeydown="return searchBox.OnSearchSelectKey(event)">
  55 </div>
  56
  57 <!-- iframe showing the search results (closed by default) -->
  58 <div id="MSearchResultsWindow">
  59 <iframe src="javascript:void(0)" frameborder="0"
  60         name="MSearchResults" id="MSearchResults">
  61 </iframe>
  62 </div>
  63
  64 </div><!-- top -->
  65 <div class="header">
  66   <div class="summary">
  67 <a href="#pub-attribs">Data Fields</a>  </div>
  68   <div class="headertitle">
  69 <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>
  70 </div><!--header-->
  71 <div class="contents">
  72
  73 <p>Lossless transform.
  74  <a href="structtjtransform.html#details">More...</a></p>
  75
  76 <p><code>#include &lt;turbojpeg.h&gt;</code></p>
  77 <table class="memberdecls">
  78 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  79 Data Fields</h2></td></tr>
  80 <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>
  81 <tr class="memdesc:ac324e5e442abec8a961e5bf219db12cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cropping region.  <a href="structtjtransform.html#ac324e5e442abec8a961e5bf219db12cf">More...</a><br /></td></tr>
  82 <tr class="separator:ac324e5e442abec8a961e5bf219db12cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 <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>
  84 <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="structtjtransform.html#a2525aab4ba6978a1c273f74fef50e498">More...</a><br /></td></tr>
  85 <tr class="separator:a2525aab4ba6978a1c273f74fef50e498"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <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>
  87 <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#gaecaaa3b7e2af812592c015d83207f010">transform options</a>.  <a href="structtjtransform.html#ac0e74655baa4402209a21e1ae481c8f6">More...</a><br /></td></tr>
  88 <tr class="separator:ac0e74655baa4402209a21e1ae481c8f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 <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>
  90 <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="structtjtransform.html#a688fe8f1a8ecc12a538d9e561cf338e3">More...</a><br /></td></tr>
  91 <tr class="separator:a688fe8f1a8ecc12a538d9e561cf338e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 <tr class="memitem:a0dc7697d59a7abe48afc629e96cbc1d2"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtjtransform.html#a0dc7697d59a7abe48afc629e96cbc1d2">customFilter</a> )(short *coeffs, <a class="el" href="structtjregion.html">tjregion</a> arrayRegion, <a class="el" href="structtjregion.html">tjregion</a> planeRegion, int componentID, int transformID, struct <a class="el" href="structtjtransform.html">tjtransform</a> *transform)</td></tr>
  93 <tr class="memdesc:a0dc7697d59a7abe48afc629e96cbc1d2"><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="structtjtransform.html#a0dc7697d59a7abe48afc629e96cbc1d2">More...</a><br /></td></tr>
  94 <tr class="separator:a0dc7697d59a7abe48afc629e96cbc1d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95 </table>
  96 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  97 <div class="textblock"><p>Lossless transform. </p>
  98 </div><h2 class="groupheader">Field Documentation</h2>
  99 <a id="a0dc7697d59a7abe48afc629e96cbc1d2"></a>
 100 <h2 class="memtitle"><span class="permalink"><a href="#a0dc7697d59a7abe48afc629e96cbc1d2">&#9670;&nbsp;</a></span>customFilter</h2>
 101
 102 <div class="memitem">
 103 <div class="memproto">
 104       <table class="memname">
 105         <tr>
 106           <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 componentID, int transformID, struct <a class="el" href="structtjtransform.html">tjtransform</a> *transform)</td>
 107         </tr>
 108       </table>
 109 </div><div class="memdoc">
 110
 111 <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>
 112 <p>This allows for custom filters or other transformations to be applied in the frequency domain.</p>
 113 <dl class="params"><dt>Parameters</dt><dd>
 114   <table class="params">
 115     <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>
 116     <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>
 117     <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>
 118     <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>
 119     <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#gaff23ba1dcabed456794b844791613920" title="Losslessly transform a JPEG image into another JPEG image.">tj3Transform()</a>.</td></tr>
 120     <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>
 121   </table>
 122   </dd>
 123 </dl>
 124 <dl class="section return"><dt>Returns</dt><dd>0 if the callback was successful, or -1 if an error occurred. </dd></dl>
 125
 126 </div>
 127 </div>
 128 <a id="a688fe8f1a8ecc12a538d9e561cf338e3"></a>
 129 <h2 class="memtitle"><span class="permalink"><a href="#a688fe8f1a8ecc12a538d9e561cf338e3">&#9670;&nbsp;</a></span>data</h2>
 130
 131 <div class="memitem">
 132 <div class="memproto">
 133       <table class="memname">
 134         <tr>
 135           <td class="memname">void* tjtransform::data</td>
 136         </tr>
 137       </table>
 138 </div><div class="memdoc">
 139
 140 <p>Arbitrary data that can be accessed within the body of the callback function. </p>
 141
 142 </div>
 143 </div>
 144 <a id="a2525aab4ba6978a1c273f74fef50e498"></a>
 145 <h2 class="memtitle"><span class="permalink"><a href="#a2525aab4ba6978a1c273f74fef50e498">&#9670;&nbsp;</a></span>op</h2>
 146
 147 <div class="memitem">
 148 <div class="memproto">
 149       <table class="memname">
 150         <tr>
 151           <td class="memname">int tjtransform::op</td>
 152         </tr>
 153       </table>
 154 </div><div class="memdoc">
 155
 156 <p>One of the <a class="el" href="group___turbo_j_p_e_g.html#ga2de531af4e7e6c4f124908376b354866">transform operations</a>. </p>
 157
 158 </div>
 159 </div>
 160 <a id="ac0e74655baa4402209a21e1ae481c8f6"></a>
 161 <h2 class="memtitle"><span class="permalink"><a href="#ac0e74655baa4402209a21e1ae481c8f6">&#9670;&nbsp;</a></span>options</h2>
 162
 163 <div class="memitem">
 164 <div class="memproto">
 165       <table class="memname">
 166         <tr>
 167           <td class="memname">int tjtransform::options</td>
 168         </tr>
 169       </table>
 170 </div><div class="memdoc">
 171
 172 <p>The bitwise OR of one of more of the <a class="el" href="group___turbo_j_p_e_g.html#gaecaaa3b7e2af812592c015d83207f010">transform options</a>. </p>
 173
 174 </div>
 175 </div>
 176 <a id="ac324e5e442abec8a961e5bf219db12cf"></a>
 177 <h2 class="memtitle"><span class="permalink"><a href="#ac324e5e442abec8a961e5bf219db12cf">&#9670;&nbsp;</a></span>r</h2>
 178
 179 <div class="memitem">
 180 <div class="memproto">
 181       <table class="memname">
 182         <tr>
 183           <td class="memname"><a class="el" href="structtjregion.html">tjregion</a> tjtransform::r</td>
 184         </tr>
 185       </table>
 186 </div><div class="memdoc">
 187
 188 <p>Cropping region. </p>
 189
 190 </div>
 191 </div>
 192 <hr/>The documentation for this struct was generated from the following file:<ul>
 193 <li>turbojpeg.h</li>
 194 </ul>
 195 </div><!-- contents -->
 196 <!-- start footer part -->
 197 <hr class="footer"/><address class="footer"><small>
 198 Generated by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
 199 </small></address>
 200 </body>
 201 </html>