Update ABI/API compatibility reports after commit cc1919b183f76d5ac79cc9927fb899b4770...
[openjpeg.git] / doxygen / dwt_8h_source.html
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"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.11"/>
7 <title>OpenJPEG: dwt.h Source File</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javascript" src="jquery.js"></script>
10 <script type="text/javascript" src="dynsections.js"></script>
11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
12 </head>
13 <body>
14 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
15 <div id="titlearea">
16 <table cellspacing="0" cellpadding="0">
17  <tbody>
18  <tr style="height: 56px;">
19   <td id="projectalign" style="padding-left: 0.5em;">
20    <div id="projectname">OpenJPEG
21    &#160;<span id="projectnumber">2.4.0</span>
22    </div>
23   </td>
24  </tr>
25  </tbody>
26 </table>
27 </div>
28 <!-- end header part -->
29 <!-- Generated by Doxygen 1.8.11 -->
30   <div id="navrow1" class="tabs">
31     <ul class="tablist">
32       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
33       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
34       <li><a href="modules.html"><span>Modules</span></a></li>
35       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
36       <li class="current"><a href="files.html"><span>Files</span></a></li>
37     </ul>
38   </div>
39   <div id="navrow2" class="tabs2">
40     <ul class="tablist">
41       <li><a href="files.html"><span>File&#160;List</span></a></li>
42       <li><a href="globals.html"><span>Globals</span></a></li>
43     </ul>
44   </div>
45 <div id="nav-path" class="navpath">
46   <ul>
47 <li class="navelem"><a class="el" href="dir_43e0a1f539e00dcfa1a6bc4d4fee4fc2.html">home</a></li><li class="navelem"><a class="el" href="dir_cb9b2b419d92b64f7cee83d8faf7a4ab.html">even</a></li><li class="navelem"><a class="el" href="dir_f75d9a0165d6564a1e04793ef847d41d.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_5f588d7ea139c1aae751d03c13a16064.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_378f732e812ef6cbaaae22e96a4fa79f.html">src</a></li><li class="navelem"><a class="el" href="dir_19dcb5713315405a27e1bde75a489a4c.html">lib</a></li><li class="navelem"><a class="el" href="dir_54e5bc4f0640fea590afaf04f4d9c88d.html">openjp2</a></li>  </ul>
48 </div>
49 </div><!-- top -->
50 <div class="header">
51   <div class="headertitle">
52 <div class="title">dwt.h</div>  </div>
53 </div><!--header-->
54 <div class="contents">
55 <a href="dwt_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * The copyright in this software is being made available under the 2-clauses</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * BSD License, included below. This software may be subject to other third</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * party and contributor rights, including patent rights, and no such rights</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * are granted under this license.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * Copyright (c) 2002-2014, Professor Benoit Macq</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * Copyright (c) 2001-2003, David Janssens</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * Copyright (c) 2002-2003, Yannick Verschueren</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * Copyright (c) 2003-2007, Francois-Olivier Devaux</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * Copyright (c) 2003-2014, Antonin Descampe</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * Copyright (c) 2005, Herve Drolon, FreeImage Team</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * modification, are permitted provided that the following conditions</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * are met:</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * 1. Redistributions of source code must retain the above copyright</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> *    notice, this list of conditions and the following disclaimer.</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> *    notice, this list of conditions and the following disclaimer in the</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> *    documentation and/or other materials provided with the distribution.</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS&#39;</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#ifndef OPJ_DWT_H</span></div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">#define OPJ_DWT_H</span></div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment">/* ----------------------------------------------------------------------- */</span></div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<a class="code" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> <a class="code" href="group___d_w_t.html#ga8c18c8b8503ce2fc2c1504f8e52344d6">opj_dwt_encode</a>(<a class="code" href="structopj__tcd.html">opj_tcd_t</a> *p_tcd,</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;                        <a class="code" href="structopj__tcd__tilecomp.html">opj_tcd_tilecomp_t</a> * tilec);</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<a class="code" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> <a class="code" href="group___d_w_t.html#ga67d22fad344dd6d7b1b3b3a237bea8d6">opj_dwt_decode</a>(<a class="code" href="structopj__tcd.html">opj_tcd_t</a> *p_tcd,</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;                        <a class="code" href="structopj__tcd__tilecomp.html">opj_tcd_tilecomp_t</a>* tilec,</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;                        <a class="code" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> numres);</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<a class="code" href="openjpeg_8h.html#a2e5e9eaf3c126e11d1f058b78a0bce78">OPJ_FLOAT64</a> <a class="code" href="group___d_w_t.html#ga15113da09b4cb72cf2c34433c059adf9">opj_dwt_getnorm</a>(<a class="code" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> level, <a class="code" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> orient);</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<a class="code" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> <a class="code" href="group___d_w_t.html#ga712062652d29679326bc9929da3cfc36">opj_dwt_encode_real</a>(<a class="code" href="structopj__tcd.html">opj_tcd_t</a> *p_tcd,</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;                             <a class="code" href="structopj__tcd__tilecomp.html">opj_tcd_tilecomp_t</a> * tilec);</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<a class="code" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> <a class="code" href="group___d_w_t.html#gadfd8b0e16f120a93b65b922bb2476c87">opj_dwt_decode_real</a>(<a class="code" href="structopj__tcd.html">opj_tcd_t</a> *p_tcd,</div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;                             <a class="code" href="structopj__tcd__tilecomp.html">opj_tcd_tilecomp_t</a>* <a class="code" href="opj__includes_8h.html#a47acbf7ae97e1ef7371a1c92a42505b2">OPJ_RESTRICT</a> tilec,</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;                             <a class="code" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> numres);</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<a class="code" href="openjpeg_8h.html#a2e5e9eaf3c126e11d1f058b78a0bce78">OPJ_FLOAT64</a> <a class="code" href="group___d_w_t.html#ga330f64c5e2755f1b2a3c1d2b591d09ed">opj_dwt_getnorm_real</a>(<a class="code" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> level, <a class="code" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> orient);</div><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group___d_w_t.html#ga1cbaf895c3ddcf1990d30d07e7604980">opj_dwt_calc_explicit_stepsizes</a>(<a class="code" href="structopj__tccp.html">opj_tccp_t</a> * tccp, <a class="code" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> prec);</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment">/* ----------------------------------------------------------------------- */</span></div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;</div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* OPJ_DWT_H */</span><span class="preprocessor"></span></div><div class="ttc" id="openjpeg_8h_html_a2e5e9eaf3c126e11d1f058b78a0bce78"><div class="ttname"><a href="openjpeg_8h.html#a2e5e9eaf3c126e11d1f058b78a0bce78">OPJ_FLOAT64</a></div><div class="ttdeci">double OPJ_FLOAT64</div><div class="ttdef"><b>Definition:</b> openjpeg.h:116</div></div>
56 <div class="ttc" id="structopj__tcd_html"><div class="ttname"><a href="structopj__tcd.html">opj_tcd</a></div><div class="ttdoc">Tile coder/decoder. </div><div class="ttdef"><b>Definition:</b> tcd.h:251</div></div>
57 <div class="ttc" id="openjpeg_8h_html_abb5dad6294f4611f1925388e919b16f4"><div class="ttname"><a href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a></div><div class="ttdeci">int OPJ_BOOL</div><div class="ttdef"><b>Definition:</b> openjpeg.h:110</div></div>
58 <div class="ttc" id="structopj__tccp_html"><div class="ttname"><a href="structopj__tccp.html">opj_tccp</a></div><div class="ttdoc">Tile-component coding parameters. </div><div class="ttdef"><b>Definition:</b> j2k.h:175</div></div>
59 <div class="ttc" id="group___d_w_t_html_ga15113da09b4cb72cf2c34433c059adf9"><div class="ttname"><a href="group___d_w_t.html#ga15113da09b4cb72cf2c34433c059adf9">opj_dwt_getnorm</a></div><div class="ttdeci">OPJ_FLOAT64 opj_dwt_getnorm(OPJ_UINT32 level, OPJ_UINT32 orient)</div><div class="ttdoc">Get the norm of a wavelet function of a subband at a specified level for the reversible 5-3 DWT...</div><div class="ttdef"><b>Definition:</b> dwt.c:1923</div></div>
60 <div class="ttc" id="opj__includes_8h_html_a47acbf7ae97e1ef7371a1c92a42505b2"><div class="ttname"><a href="opj__includes_8h.html#a47acbf7ae97e1ef7371a1c92a42505b2">OPJ_RESTRICT</a></div><div class="ttdeci">#define OPJ_RESTRICT</div><div class="ttdef"><b>Definition:</b> opj_includes.h:121</div></div>
61 <div class="ttc" id="group___d_w_t_html_ga712062652d29679326bc9929da3cfc36"><div class="ttname"><a href="group___d_w_t.html#ga712062652d29679326bc9929da3cfc36">opj_dwt_encode_real</a></div><div class="ttdeci">OPJ_BOOL opj_dwt_encode_real(opj_tcd_t *p_tcd, opj_tcd_tilecomp_t *tilec)</div><div class="ttdoc">Forward 9-7 wavelet transform in 2-D. </div><div class="ttdef"><b>Definition:</b> dwt.c:1939</div></div>
62 <div class="ttc" id="group___d_w_t_html_ga330f64c5e2755f1b2a3c1d2b591d09ed"><div class="ttname"><a href="group___d_w_t.html#ga330f64c5e2755f1b2a3c1d2b591d09ed">opj_dwt_getnorm_real</a></div><div class="ttdeci">OPJ_FLOAT64 opj_dwt_getnorm_real(OPJ_UINT32 level, OPJ_UINT32 orient)</div><div class="ttdoc">Get the norm of a wavelet function of a subband at a specified level for the irreversible 9-7 DWT...</div><div class="ttdef"><b>Definition:</b> dwt.c:1950</div></div>
63 <div class="ttc" id="group___d_w_t_html_ga1cbaf895c3ddcf1990d30d07e7604980"><div class="ttname"><a href="group___d_w_t.html#ga1cbaf895c3ddcf1990d30d07e7604980">opj_dwt_calc_explicit_stepsizes</a></div><div class="ttdeci">void opj_dwt_calc_explicit_stepsizes(opj_tccp_t *tccp, OPJ_UINT32 prec)</div><div class="ttdoc">Explicit calculation of the Quantization Stepsizes. </div><div class="ttdef"><b>Definition:</b> dwt.c:1963</div></div>
64 <div class="ttc" id="openjpeg_8h_html_a4cb1e6e6b6ef2df499d5c02f7df54cbb"><div class="ttname"><a href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a></div><div class="ttdeci">uint32_t OPJ_UINT32</div><div class="ttdef"><b>Definition:</b> openjpeg.h:126</div></div>
65 <div class="ttc" id="group___d_w_t_html_ga8c18c8b8503ce2fc2c1504f8e52344d6"><div class="ttname"><a href="group___d_w_t.html#ga8c18c8b8503ce2fc2c1504f8e52344d6">opj_dwt_encode</a></div><div class="ttdeci">OPJ_BOOL opj_dwt_encode(opj_tcd_t *p_tcd, opj_tcd_tilecomp_t *tilec)</div><div class="ttdoc">Forward 5-3 wavelet transform in 2-D. </div><div class="ttdef"><b>Definition:</b> dwt.c:1899</div></div>
66 <div class="ttc" id="structopj__tcd__tilecomp_html"><div class="ttname"><a href="structopj__tcd__tilecomp.html">opj_tcd_tilecomp</a></div><div class="ttdoc">Tile-component structure. </div><div class="ttdef"><b>Definition:</b> tcd.h:189</div></div>
67 <div class="ttc" id="group___d_w_t_html_ga67d22fad344dd6d7b1b3b3a237bea8d6"><div class="ttname"><a href="group___d_w_t.html#ga67d22fad344dd6d7b1b3b3a237bea8d6">opj_dwt_decode</a></div><div class="ttdeci">OPJ_BOOL opj_dwt_decode(opj_tcd_t *p_tcd, opj_tcd_tilecomp_t *tilec, OPJ_UINT32 numres)</div><div class="ttdoc">Inverse 5-3 wavelet transform in 2-D. </div><div class="ttdef"><b>Definition:</b> dwt.c:1910</div></div>
68 <div class="ttc" id="group___d_w_t_html_gadfd8b0e16f120a93b65b922bb2476c87"><div class="ttname"><a href="group___d_w_t.html#gadfd8b0e16f120a93b65b922bb2476c87">opj_dwt_decode_real</a></div><div class="ttdeci">OPJ_BOOL opj_dwt_decode_real(opj_tcd_t *p_tcd, opj_tcd_tilecomp_t *OPJ_RESTRICT tilec, OPJ_UINT32 numres)</div><div class="ttdoc">Inverse 9-7 wavelet transform in 2-D. </div><div class="ttdef"><b>Definition:</b> dwt.c:3747</div></div>
69 </div><!-- fragment --></div><!-- contents -->
70 <!-- start footer part -->
71 <hr class="footer"/><address class="footer"><small>
72 Generated by &#160;<a href="http://www.doxygen.org/index.html">
73 <img class="footer" src="doxygen.png" alt="doxygen"/>
74 </a> 1.8.11
75 </small></address>
76 </body>
77 </html>