Update ABI/API compatibility reports after commit 43b8ddc6af015715b2fbda2052a17b29d15...
[openjpeg.git] / doxygen / tgt_8h.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: tgt.h File Reference</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="summary">
52 <a href="#nested-classes">Data Structures</a> &#124;
53 <a href="#typedef-members">Typedefs</a>  </div>
54   <div class="headertitle">
55 <div class="title">tgt.h File Reference</div>  </div>
56 </div><!--header-->
57 <div class="contents">
58
59 <p>Implementation of a tag-tree coder (TGT)  
60 <a href="#details">More...</a></p>
61
62 <p><a href="tgt_8h_source.html">Go to the source code of this file.</a></p>
63 <table class="memberdecls">
64 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
65 Data Structures</h2></td></tr>
66 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__tgt__node.html">opj_tgt_node</a></td></tr>
67 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tag node.  <a href="structopj__tgt__node.html#details">More...</a><br /></td></tr>
68 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
69 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__tgt__tree.html">opj_tgt_tree</a></td></tr>
70 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tag tree.  <a href="structopj__tgt__tree.html#details">More...</a><br /></td></tr>
71 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
72 </table><table class="memberdecls">
73 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
74 Typedefs</h2></td></tr>
75 <tr class="memitem:ga8eddc00e16d716a49948fafc52bcd29d"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structopj__tgt__node.html">opj_tgt_node</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_g_t.html#ga8eddc00e16d716a49948fafc52bcd29d">opj_tgt_node_t</a></td></tr>
76 <tr class="memdesc:ga8eddc00e16d716a49948fafc52bcd29d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tag node.  <a href="group___t_g_t.html#ga8eddc00e16d716a49948fafc52bcd29d">More...</a><br /></td></tr>
77 <tr class="separator:ga8eddc00e16d716a49948fafc52bcd29d"><td class="memSeparator" colspan="2">&#160;</td></tr>
78 <tr class="memitem:gaf06887ec727f9f79a488c8f15661d622"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structopj__tgt__tree.html">opj_tgt_tree</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_g_t.html#gaf06887ec727f9f79a488c8f15661d622">opj_tgt_tree_t</a></td></tr>
79 <tr class="memdesc:gaf06887ec727f9f79a488c8f15661d622"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tag tree.  <a href="group___t_g_t.html#gaf06887ec727f9f79a488c8f15661d622">More...</a><br /></td></tr>
80 <tr class="separator:gaf06887ec727f9f79a488c8f15661d622"><td class="memSeparator" colspan="2">&#160;</td></tr>
81 </table><table class="memberdecls">
82 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
83 Functions</h2></td></tr>
84 <tr><td colspan="2"><div class="groupHeader">Exported functions</div></td></tr>
85 <tr class="memitem:gaaf27107458b5242fe7d848480b4a4690"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___t_g_t.html#gaf06887ec727f9f79a488c8f15661d622">opj_tgt_tree_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_g_t.html#gaaf27107458b5242fe7d848480b4a4690">opj_tgt_create</a> (<a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> numleafsh, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> numleafsv, <a class="el" href="event_8h.html#a4cba85f9ee037b1f2c6bceb903051d96">opj_event_mgr_t</a> *p_manager)</td></tr>
86 <tr class="memdesc:gaaf27107458b5242fe7d848480b4a4690"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a tag-tree.  <a href="group___t_g_t.html#gaaf27107458b5242fe7d848480b4a4690">More...</a><br /></td></tr>
87 <tr class="separator:gaaf27107458b5242fe7d848480b4a4690"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:gaa34fdf087e24d66a2a661c31ba194c3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___t_g_t.html#gaf06887ec727f9f79a488c8f15661d622">opj_tgt_tree_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_g_t.html#gaa34fdf087e24d66a2a661c31ba194c3f">opj_tgt_init</a> (<a class="el" href="group___t_g_t.html#gaf06887ec727f9f79a488c8f15661d622">opj_tgt_tree_t</a> *p_tree, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> p_num_leafs_h, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> p_num_leafs_v, <a class="el" href="event_8h.html#a4cba85f9ee037b1f2c6bceb903051d96">opj_event_mgr_t</a> *p_manager)</td></tr>
89 <tr class="memdesc:gaa34fdf087e24d66a2a661c31ba194c3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reinitialises a tag-tree from an exixting one.  <a href="group___t_g_t.html#gaa34fdf087e24d66a2a661c31ba194c3f">More...</a><br /></td></tr>
90 <tr class="separator:gaa34fdf087e24d66a2a661c31ba194c3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
91 <tr class="memitem:gaa9a20506fefbb59153ad401f9af51fe7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_g_t.html#gaa9a20506fefbb59153ad401f9af51fe7">opj_tgt_destroy</a> (<a class="el" href="group___t_g_t.html#gaf06887ec727f9f79a488c8f15661d622">opj_tgt_tree_t</a> *tree)</td></tr>
92 <tr class="memdesc:gaa9a20506fefbb59153ad401f9af51fe7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy a tag-tree, liberating memory.  <a href="group___t_g_t.html#gaa9a20506fefbb59153ad401f9af51fe7">More...</a><br /></td></tr>
93 <tr class="separator:gaa9a20506fefbb59153ad401f9af51fe7"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <tr class="memitem:gad4bf197e6977fd4c4e947a946391e598"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_g_t.html#gad4bf197e6977fd4c4e947a946391e598">opj_tgt_reset</a> (<a class="el" href="group___t_g_t.html#gaf06887ec727f9f79a488c8f15661d622">opj_tgt_tree_t</a> *tree)</td></tr>
95 <tr class="memdesc:gad4bf197e6977fd4c4e947a946391e598"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset a tag-tree (set all leaves to 0)  <a href="group___t_g_t.html#gad4bf197e6977fd4c4e947a946391e598">More...</a><br /></td></tr>
96 <tr class="separator:gad4bf197e6977fd4c4e947a946391e598"><td class="memSeparator" colspan="2">&#160;</td></tr>
97 <tr class="memitem:gab0844dbb6cdf88a7bb4036d718774f69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_g_t.html#gab0844dbb6cdf88a7bb4036d718774f69">opj_tgt_setvalue</a> (<a class="el" href="group___t_g_t.html#gaf06887ec727f9f79a488c8f15661d622">opj_tgt_tree_t</a> *tree, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> leafno, <a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a> value)</td></tr>
98 <tr class="memdesc:gab0844dbb6cdf88a7bb4036d718774f69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the value of a leaf of a tag-tree.  <a href="group___t_g_t.html#gab0844dbb6cdf88a7bb4036d718774f69">More...</a><br /></td></tr>
99 <tr class="separator:gab0844dbb6cdf88a7bb4036d718774f69"><td class="memSeparator" colspan="2">&#160;</td></tr>
100 <tr class="memitem:gafe36abfc042710c566552ed3adfcb2a9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_g_t.html#gafe36abfc042710c566552ed3adfcb2a9">opj_tgt_encode</a> (<a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *bio, <a class="el" href="group___t_g_t.html#gaf06887ec727f9f79a488c8f15661d622">opj_tgt_tree_t</a> *tree, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> leafno, <a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a> threshold)</td></tr>
101 <tr class="memdesc:gafe36abfc042710c566552ed3adfcb2a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode the value of a leaf of the tag-tree up to a given threshold.  <a href="group___t_g_t.html#gafe36abfc042710c566552ed3adfcb2a9">More...</a><br /></td></tr>
102 <tr class="separator:gafe36abfc042710c566552ed3adfcb2a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
103 <tr class="memitem:ga5b970bfd9b761cdf2ff36001821b06aa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_g_t.html#ga5b970bfd9b761cdf2ff36001821b06aa">opj_tgt_decode</a> (<a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *bio, <a class="el" href="group___t_g_t.html#gaf06887ec727f9f79a488c8f15661d622">opj_tgt_tree_t</a> *tree, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> leafno, <a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a> threshold)</td></tr>
104 <tr class="memdesc:ga5b970bfd9b761cdf2ff36001821b06aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decode the value of a leaf of the tag-tree up to a given threshold.  <a href="group___t_g_t.html#ga5b970bfd9b761cdf2ff36001821b06aa">More...</a><br /></td></tr>
105 <tr class="separator:ga5b970bfd9b761cdf2ff36001821b06aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
106 </table>
107 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
108 <div class="textblock"><p>Implementation of a tag-tree coder (TGT) </p>
109 <p>The functions in TGT.C have for goal to realize a tag-tree coder. The functions in TGT.C are used by some function in T2.C. </p>
110 </div></div><!-- contents -->
111 <!-- start footer part -->
112 <hr class="footer"/><address class="footer"><small>
113 Generated by &#160;<a href="http://www.doxygen.org/index.html">
114 <img class="footer" src="doxygen.png" alt="doxygen"/>
115 </a> 1.8.11
116 </small></address>
117 </body>
118 </html>