Update Doxygen doc
[openjpeg.git] / doxygen / mhixbox__manager_8h_source.html
index 14cc3b549fb6a29ca14f90a4f8b8e29cd6478833..631481f6c9cf320a16980130918e081de44fd90b 100644 (file)
@@ -18,7 +18,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">OpenJPEG
-   &#160;<span id="projectnumber">2.1.2</span>
+   &#160;<span id="projectnumber">2.2.0</span>
    </div>
   </td>
  </tr>
 <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span></div>
 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> */</span></div>
 <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div>
-<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#ifndef         MHIXBOX_MANAGER_H_</span></div>
-<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor"># define        MHIXBOX_MANAGER_H_</span></div>
+<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#ifndef     MHIXBOX_MANAGER_H_</span></div>
+<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor"># define    MHIXBOX_MANAGER_H_</span></div>
 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>
 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="byte__manager_8h.html">byte_manager.h</a>&quot;</span></div>
 <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="box__manager_8h.html">box_manager.h</a>&quot;</span></div>
 <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div>
-<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structmarkeridx__param.html">   38</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structmarkeridx__param.html">markeridx_param</a>{</div>
-<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structmarkeridx__param.html#a67f2cbaad816454e3137ad669289f4f0">   39</a></span>&#160;  <a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> <a class="code" href="structmarkeridx__param.html#a67f2cbaad816454e3137ad669289f4f0">code</a>;                 </div>
-<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structmarkeridx__param.html#af25341650e6cb6e073ca9ed12fcd86ae">   40</a></span>&#160;  <a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> <a class="code" href="structmarkeridx__param.html#af25341650e6cb6e073ca9ed12fcd86ae">num_remain</a>;           </div>
-<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structmarkeridx__param.html#af6076115fd1d74ad8ff0faaa12c35913">   41</a></span>&#160;  <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> <a class="code" href="structmarkeridx__param.html#af6076115fd1d74ad8ff0faaa12c35913">offset</a>;               </div>
-<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structmarkeridx__param.html#ab8f8d7d018e9a8030a231cbfad67ca92">   44</a></span>&#160;  <a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> <a class="code" href="structmarkeridx__param.html#ab8f8d7d018e9a8030a231cbfad67ca92">length</a>;               </div>
-<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structmarkeridx__param.html#a96fec3389030014de88eeedc0ec41bf9">   45</a></span>&#160;  <span class="keyword">struct </span><a class="code" href="structmarkeridx__param.html">markeridx_param</a> *<a class="code" href="structmarkeridx__param.html#a96fec3389030014de88eeedc0ec41bf9">next</a>; </div>
+<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structmarkeridx__param.html">   38</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structmarkeridx__param.html">markeridx_param</a> {</div>
+<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structmarkeridx__param.html#a67f2cbaad816454e3137ad669289f4f0">   39</a></span>&#160;    <a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> <a class="code" href="structmarkeridx__param.html#a67f2cbaad816454e3137ad669289f4f0">code</a>;                 </div>
+<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structmarkeridx__param.html#af25341650e6cb6e073ca9ed12fcd86ae">   40</a></span>&#160;    <a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> <a class="code" href="structmarkeridx__param.html#af25341650e6cb6e073ca9ed12fcd86ae">num_remain</a>;           </div>
+<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structmarkeridx__param.html#af6076115fd1d74ad8ff0faaa12c35913">   41</a></span>&#160;    <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> <a class="code" href="structmarkeridx__param.html#af6076115fd1d74ad8ff0faaa12c35913">offset</a>;               </div>
+<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structmarkeridx__param.html#ab8f8d7d018e9a8030a231cbfad67ca92">   44</a></span>&#160;    <a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> <a class="code" href="structmarkeridx__param.html#ab8f8d7d018e9a8030a231cbfad67ca92">length</a>;               </div>
+<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structmarkeridx__param.html#a96fec3389030014de88eeedc0ec41bf9">   45</a></span>&#160;    <span class="keyword">struct </span><a class="code" href="structmarkeridx__param.html">markeridx_param</a> *<a class="code" href="structmarkeridx__param.html#a96fec3389030014de88eeedc0ec41bf9">next</a>; </div>
 <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;} <a class="code" href="mhixbox__manager_8h.html#a84577a8a4efa8188c74fb2c90f5e3c4b">markeridx_param_t</a>;</div>
 <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div>
 <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;</div>
 <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div>
-<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structmhixbox__param.html">   52</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structmhixbox__param.html">mhixbox_param</a>{</div>
-<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structmhixbox__param.html#ab48436449e3e05c4e44a246b095afdd9">   53</a></span>&#160;  <a class="code" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> <a class="code" href="structmhixbox__param.html#ab48436449e3e05c4e44a246b095afdd9">tlen</a>;             </div>
-<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structmhixbox__param.html#a51b8cd55ab497445287933e5be101584">   55</a></span>&#160;  <a class="code" href="structmarkeridx__param.html">markeridx_param_t</a> *<a class="code" href="structmhixbox__param.html#a51b8cd55ab497445287933e5be101584">first</a>; </div>
+<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structmhixbox__param.html">   52</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structmhixbox__param.html">mhixbox_param</a> {</div>
+<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structmhixbox__param.html#ab48436449e3e05c4e44a246b095afdd9">   53</a></span>&#160;    <a class="code" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> <a class="code" href="structmhixbox__param.html#ab48436449e3e05c4e44a246b095afdd9">tlen</a>;             </div>
+<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structmhixbox__param.html#a51b8cd55ab497445287933e5be101584">   55</a></span>&#160;    <a class="code" href="structmarkeridx__param.html">markeridx_param_t</a> *<a class="code" href="structmhixbox__param.html#a51b8cd55ab497445287933e5be101584">first</a>; </div>
 <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;} <a class="code" href="mhixbox__manager_8h.html#affa3bc2302f0306a416f721b6c29f296">mhixbox_param_t</a>;</div>
 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;</div>
 <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
 <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div>
-<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<a class="code" href="structmhixbox__param.html">mhixbox_param_t</a> * <a class="code" href="mhixbox__manager_8h.html#ab3cc1c5943e32e078257f5b386f6b32b">gene_mhixbox</a>( <a class="code" href="structbox__param.html">box_param_t</a> *box);</div>
+<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<a class="code" href="structmhixbox__param.html">mhixbox_param_t</a> * <a class="code" href="mhixbox__manager_8h.html#ab3cc1c5943e32e078257f5b386f6b32b">gene_mhixbox</a>(<a class="code" href="structbox__param.html">box_param_t</a> *box);</div>
 <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div>
 <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;</div>
-<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<a class="code" href="structmarkeridx__param.html">markeridx_param_t</a> * <a class="code" href="mhixbox__manager_8h.html#a694ec5436b961330f721653a4b3927cd">search_markeridx</a>( <a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> code, <a class="code" href="structmhixbox__param.html">mhixbox_param_t</a> *mhix);</div>
+<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<a class="code" href="structmarkeridx__param.html">markeridx_param_t</a> * <a class="code" href="mhixbox__manager_8h.html#a694ec5436b961330f721653a4b3927cd">search_markeridx</a>(<a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> code, <a class="code" href="structmhixbox__param.html">mhixbox_param_t</a> *mhix);</div>
 <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div>
 <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div>
-<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="keywordtype">void</span> <a class="code" href="mhixbox__manager_8h.html#a2639dde4d8531a6c04887b46cded28c5">print_mhixbox</a>( <a class="code" href="structmhixbox__param.html">mhixbox_param_t</a> *mhix);</div>
+<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="keywordtype">void</span> <a class="code" href="mhixbox__manager_8h.html#a2639dde4d8531a6c04887b46cded28c5">print_mhixbox</a>(<a class="code" href="structmhixbox__param.html">mhixbox_param_t</a> *mhix);</div>
 <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;</div>
 <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;</div>
-<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="keywordtype">void</span> <a class="code" href="mhixbox__manager_8h.html#a34a0d2a8641d9069cfc200df0fa55632">print_markeridx</a>( <a class="code" href="structmarkeridx__param.html">markeridx_param_t</a> *markeridx);</div>
+<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="keywordtype">void</span> <a class="code" href="mhixbox__manager_8h.html#a34a0d2a8641d9069cfc200df0fa55632">print_markeridx</a>(<a class="code" href="structmarkeridx__param.html">markeridx_param_t</a> *markeridx);</div>
 <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;</div>
 <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;</div>
-<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="keywordtype">void</span> <a class="code" href="mhixbox__manager_8h.html#a93e96cdf2beb6d3a4d5f30e462e2c079">delete_mhixbox</a>( <a class="code" href="structmhixbox__param.html">mhixbox_param_t</a> **mhix);</div>
+<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="keywordtype">void</span> <a class="code" href="mhixbox__manager_8h.html#a93e96cdf2beb6d3a4d5f30e462e2c079">delete_mhixbox</a>(<a class="code" href="structmhixbox__param.html">mhixbox_param_t</a> **mhix);</div>
 <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;</div>
 <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="preprocessor">#endif      </span><span class="comment">/* !MHIXBOX_MANAGER_H_ */</span><span class="preprocessor"></span></div>
 <div class="ttc" id="openjpeg_8h_html_a64948c8a524dee101c5a4d7293e6158c"><div class="ttname"><a href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a></div><div class="ttdeci">int64_t OPJ_OFF_T</div><div class="ttdef"><b>Definition:</b> openjpeg.h:130</div></div>
-<div class="ttc" id="mhixbox__manager_8h_html_a694ec5436b961330f721653a4b3927cd"><div class="ttname"><a href="mhixbox__manager_8h.html#a694ec5436b961330f721653a4b3927cd">search_markeridx</a></div><div class="ttdeci">markeridx_param_t * search_markeridx(Byte2_t code, mhixbox_param_t *mhix)</div><div class="ttdoc">search a marker index by marker code from mhix box </div><div class="ttdef"><b>Definition:</b> mhixbox_manager.c:77</div></div>
+<div class="ttc" id="mhixbox__manager_8h_html_a694ec5436b961330f721653a4b3927cd"><div class="ttname"><a href="mhixbox__manager_8h.html#a694ec5436b961330f721653a4b3927cd">search_markeridx</a></div><div class="ttdeci">markeridx_param_t * search_markeridx(Byte2_t code, mhixbox_param_t *mhix)</div><div class="ttdoc">search a marker index by marker code from mhix box </div><div class="ttdef"><b>Definition:</b> mhixbox_manager.c:78</div></div>
 <div class="ttc" id="structbox__param_html"><div class="ttname"><a href="structbox__param.html">box_param</a></div><div class="ttdoc">box parameters </div><div class="ttdef"><b>Definition:</b> box_manager.h:37</div></div>
 <div class="ttc" id="mhixbox__manager_8h_html_ab3cc1c5943e32e078257f5b386f6b32b"><div class="ttname"><a href="mhixbox__manager_8h.html#ab3cc1c5943e32e078257f5b386f6b32b">gene_mhixbox</a></div><div class="ttdeci">mhixbox_param_t * gene_mhixbox(box_param_t *box)</div><div class="ttdoc">generate mhix box </div><div class="ttdef"><b>Definition:</b> mhixbox_manager.c:47</div></div>
 <div class="ttc" id="structmhixbox__param_html_ab48436449e3e05c4e44a246b095afdd9"><div class="ttname"><a href="structmhixbox__param.html#ab48436449e3e05c4e44a246b095afdd9">mhixbox_param::tlen</a></div><div class="ttdeci">Byte8_t tlen</div><div class="ttdoc">length ( total length of the main </div><div class="ttdef"><b>Definition:</b> mhixbox_manager.h:53</div></div>
 <div class="ttc" id="structmarkeridx__param_html_ab8f8d7d018e9a8030a231cbfad67ca92"><div class="ttname"><a href="structmarkeridx__param.html#ab8f8d7d018e9a8030a231cbfad67ca92">markeridx_param::length</a></div><div class="ttdeci">Byte2_t length</div><div class="ttdoc">codestream ( including the length </div><div class="ttdef"><b>Definition:</b> mhixbox_manager.h:44</div></div>
 <div class="ttc" id="structmarkeridx__param_html_a96fec3389030014de88eeedc0ec41bf9"><div class="ttname"><a href="structmarkeridx__param.html#a96fec3389030014de88eeedc0ec41bf9">markeridx_param::next</a></div><div class="ttdeci">struct markeridx_param * next</div><div class="ttdoc">pointer to the next markeridx </div><div class="ttdef"><b>Definition:</b> mhixbox_manager.h:45</div></div>
 <div class="ttc" id="mhixbox__manager_8h_html_affa3bc2302f0306a416f721b6c29f296"><div class="ttname"><a href="mhixbox__manager_8h.html#affa3bc2302f0306a416f721b6c29f296">mhixbox_param_t</a></div><div class="ttdeci">struct mhixbox_param mhixbox_param_t</div><div class="ttdoc">header index table box parameters </div></div>
-<div class="ttc" id="mhixbox__manager_8h_html_a93e96cdf2beb6d3a4d5f30e462e2c079"><div class="ttname"><a href="mhixbox__manager_8h.html#a93e96cdf2beb6d3a4d5f30e462e2c079">delete_mhixbox</a></div><div class="ttdeci">void delete_mhixbox(mhixbox_param_t **mhix)</div><div class="ttdoc">delete mhix box </div><div class="ttdef"><b>Definition:</b> mhixbox_manager.c:125</div></div>
-<div class="ttc" id="mhixbox__manager_8h_html_a2639dde4d8531a6c04887b46cded28c5"><div class="ttname"><a href="mhixbox__manager_8h.html#a2639dde4d8531a6c04887b46cded28c5">print_mhixbox</a></div><div class="ttdeci">void print_mhixbox(mhixbox_param_t *mhix)</div><div class="ttdoc">print mhix box parameters </div><div class="ttdef"><b>Definition:</b> mhixbox_manager.c:96</div></div>
+<div class="ttc" id="mhixbox__manager_8h_html_a93e96cdf2beb6d3a4d5f30e462e2c079"><div class="ttname"><a href="mhixbox__manager_8h.html#a93e96cdf2beb6d3a4d5f30e462e2c079">delete_mhixbox</a></div><div class="ttdeci">void delete_mhixbox(mhixbox_param_t **mhix)</div><div class="ttdoc">delete mhix box </div><div class="ttdef"><b>Definition:</b> mhixbox_manager.c:128</div></div>
+<div class="ttc" id="mhixbox__manager_8h_html_a2639dde4d8531a6c04887b46cded28c5"><div class="ttname"><a href="mhixbox__manager_8h.html#a2639dde4d8531a6c04887b46cded28c5">print_mhixbox</a></div><div class="ttdeci">void print_mhixbox(mhixbox_param_t *mhix)</div><div class="ttdoc">print mhix box parameters </div><div class="ttdef"><b>Definition:</b> mhixbox_manager.c:98</div></div>
 <div class="ttc" id="structmhixbox__param_html"><div class="ttname"><a href="structmhixbox__param.html">mhixbox_param</a></div><div class="ttdoc">header index table box parameters </div><div class="ttdef"><b>Definition:</b> mhixbox_manager.h:52</div></div>
 <div class="ttc" id="byte__manager_8h_html"><div class="ttname"><a href="byte__manager_8h.html">byte_manager.h</a></div></div>
 <div class="ttc" id="structmarkeridx__param_html_af6076115fd1d74ad8ff0faaa12c35913"><div class="ttname"><a href="structmarkeridx__param.html#af6076115fd1d74ad8ff0faaa12c35913">markeridx_param::offset</a></div><div class="ttdeci">OPJ_OFF_T offset</div><div class="ttdoc">offset relative to the start of the </div><div class="ttdef"><b>Definition:</b> mhixbox_manager.h:41</div></div>
-<div class="ttc" id="mhixbox__manager_8h_html_a34a0d2a8641d9069cfc200df0fa55632"><div class="ttname"><a href="mhixbox__manager_8h.html#a34a0d2a8641d9069cfc200df0fa55632">print_markeridx</a></div><div class="ttdeci">void print_markeridx(markeridx_param_t *markeridx)</div><div class="ttdoc">print marker index parameters </div><div class="ttdef"><b>Definition:</b> mhixbox_manager.c:115</div></div>
+<div class="ttc" id="mhixbox__manager_8h_html_a34a0d2a8641d9069cfc200df0fa55632"><div class="ttname"><a href="mhixbox__manager_8h.html#a34a0d2a8641d9069cfc200df0fa55632">print_markeridx</a></div><div class="ttdeci">void print_markeridx(markeridx_param_t *markeridx)</div><div class="ttdoc">print marker index parameters </div><div class="ttdef"><b>Definition:</b> mhixbox_manager.c:117</div></div>
 <div class="ttc" id="structmarkeridx__param_html_af25341650e6cb6e073ca9ed12fcd86ae"><div class="ttname"><a href="structmarkeridx__param.html#af25341650e6cb6e073ca9ed12fcd86ae">markeridx_param::num_remain</a></div><div class="ttdeci">Byte2_t num_remain</div><div class="ttdoc">remining number of the same marker index segments listed immediately </div><div class="ttdef"><b>Definition:</b> mhixbox_manager.h:40</div></div>
 <div class="ttc" id="box__manager_8h_html"><div class="ttname"><a href="box__manager_8h.html">box_manager.h</a></div></div>
 <div class="ttc" id="structmarkeridx__param_html_a67f2cbaad816454e3137ad669289f4f0"><div class="ttname"><a href="structmarkeridx__param.html#a67f2cbaad816454e3137ad669289f4f0">markeridx_param::code</a></div><div class="ttdeci">Byte2_t code</div><div class="ttdoc">marker code </div><div class="ttdef"><b>Definition:</b> mhixbox_manager.h:39</div></div>