Update ABI/API compatibility reports after commit 43b8ddc6af015715b2fbda2052a17b29d15...
[openjpeg.git] / doxygen / boxheader__manager_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: boxheader_manager.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_54d80c9412497e935deb5677b5fae801.html">openjpip</a></li>  </ul>
48 </div>
49 </div><!-- top -->
50 <div class="header">
51   <div class="headertitle">
52 <div class="title">boxheader_manager.h</div>  </div>
53 </div><!--header-->
54 <div class="contents">
55 <a href="boxheader__manager_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"> * $Id$</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Copyright (c) 2002-2014, Professor Benoit Macq</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Copyright (c) 2010-2011, Kaori Hagihara</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * modification, are permitted provided that the following conditions</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * are met:</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * 1. Redistributions of source code must retain the above copyright</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *    notice, this list of conditions and the following disclaimer.</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *    notice, this list of conditions and the following disclaimer in the</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *    documentation and/or other materials provided with the distribution.</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</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="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</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="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     BOXHEADER_MANAGER_H_</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor"># define    BOXHEADER_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="openjpeg_8h.html">openjpeg.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="byte__manager_8h.html">byte_manager.h</a>&quot;</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</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="l00037"></a><span class="lineno">   37</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structboxheader__param.html">   39</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structboxheader__param.html">boxheader_param</a> {</div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structboxheader__param.html#aabf782e3d43e158e4477308c11670ac4">   40</a></span>&#160;    <a class="code" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a>  <a class="code" href="structboxheader__param.html#aabf782e3d43e158e4477308c11670ac4">headlen</a>;              </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structboxheader__param.html#a2a90e59fdad1a3ff2c0f40b4dfff7ed1">   41</a></span>&#160;    <a class="code" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> <a class="code" href="structboxheader__param.html#a2a90e59fdad1a3ff2c0f40b4dfff7ed1">length</a>;               </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structboxheader__param.html#ad64aefab7bef517b0bfe152352f89d99">   42</a></span>&#160;    <span class="keywordtype">char</span>    <a class="code" href="structboxheader__param.html#ad64aefab7bef517b0bfe152352f89d99">type</a>[4];              </div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structboxheader__param.html#a24a521b8c32b65e2354e67191c14f232">   43</a></span>&#160;    <span class="keyword">struct </span><a class="code" href="structboxheader__param.html">boxheader_param</a> *<a class="code" href="structboxheader__param.html#a24a521b8c32b65e2354e67191c14f232">next</a>; </div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;} <a class="code" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a>;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<a class="code" href="structboxheader__param.html">boxheader_param_t</a> * <a class="code" href="boxheader__manager_8h.html#ad67b5454e29ddcd711d07eaddbe29f67">gene_boxheader</a>(<span class="keywordtype">int</span> fd, <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset);</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<a class="code" href="structboxheader__param.html">boxheader_param_t</a> * <a class="code" href="boxheader__manager_8h.html#acef0f9dedbcfe391a86a87b5693fda5a">gene_childboxheader</a>(<a class="code" href="structbox__param.html">box_param_t</a> *superbox,</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;                                        <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset);</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="keywordtype">void</span> <a class="code" href="boxheader__manager_8h.html#a366e577597bfcd3e2d8c6db97f802a26">print_boxheader</a>(<a class="code" href="structboxheader__param.html">boxheader_param_t</a> *boxheader);</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="preprocessor">#endif      </span><span class="comment">/* !BOXHEADER_MANAGER_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="byte__manager_8h_html_ade896f5d51f03e046a004d006b53a8b0"><div class="ttname"><a href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a></div><div class="ttdeci">uint8_t Byte_t</div><div class="ttdef"><b>Definition:</b> byte_manager.h:37</div></div>
56 <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>
57 <div class="ttc" id="structboxheader__param_html_a24a521b8c32b65e2354e67191c14f232"><div class="ttname"><a href="structboxheader__param.html#a24a521b8c32b65e2354e67191c14f232">boxheader_param::next</a></div><div class="ttdeci">struct boxheader_param * next</div><div class="ttdoc">pointer to the next header box </div><div class="ttdef"><b>Definition:</b> boxheader_manager.h:43</div></div>
58 <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>
59 <div class="ttc" id="structboxheader__param_html_a2a90e59fdad1a3ff2c0f40b4dfff7ed1"><div class="ttname"><a href="structboxheader__param.html#a2a90e59fdad1a3ff2c0f40b4dfff7ed1">boxheader_param::length</a></div><div class="ttdeci">Byte8_t length</div><div class="ttdoc">length of the reference Box </div><div class="ttdef"><b>Definition:</b> boxheader_manager.h:41</div></div>
60 <div class="ttc" id="boxheader__manager_8h_html_a52219183b1007413e580aa9ba6504669"><div class="ttname"><a href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a></div><div class="ttdeci">struct boxheader_param boxheader_param_t</div><div class="ttdoc">box header parameters </div></div>
61 <div class="ttc" id="structboxheader__param_html"><div class="ttname"><a href="structboxheader__param.html">boxheader_param</a></div><div class="ttdoc">box header parameters </div><div class="ttdef"><b>Definition:</b> boxheader_manager.h:39</div></div>
62 <div class="ttc" id="openjpeg_8h_html"><div class="ttname"><a href="openjpeg_8h.html">openjpeg.h</a></div></div>
63 <div class="ttc" id="boxheader__manager_8h_html_acef0f9dedbcfe391a86a87b5693fda5a"><div class="ttname"><a href="boxheader__manager_8h.html#acef0f9dedbcfe391a86a87b5693fda5a">gene_childboxheader</a></div><div class="ttdeci">boxheader_param_t * gene_childboxheader(box_param_t *superbox, OPJ_OFF_T offset)</div><div class="ttdoc">generate a child box header at the given offset </div><div class="ttdef"><b>Definition:</b> boxheader_manager.c:74</div></div>
64 <div class="ttc" id="byte__manager_8h_html"><div class="ttname"><a href="byte__manager_8h.html">byte_manager.h</a></div></div>
65 <div class="ttc" id="structboxheader__param_html_ad64aefab7bef517b0bfe152352f89d99"><div class="ttname"><a href="structboxheader__param.html#ad64aefab7bef517b0bfe152352f89d99">boxheader_param::type</a></div><div class="ttdeci">char type[4]</div><div class="ttdoc">type of information in the DBox </div><div class="ttdef"><b>Definition:</b> boxheader_manager.h:42</div></div>
66 <div class="ttc" id="boxheader__manager_8h_html_a366e577597bfcd3e2d8c6db97f802a26"><div class="ttname"><a href="boxheader__manager_8h.html#a366e577597bfcd3e2d8c6db97f802a26">print_boxheader</a></div><div class="ttdeci">void print_boxheader(boxheader_param_t *boxheader)</div><div class="ttdoc">print box header parameters </div><div class="ttdef"><b>Definition:</b> boxheader_manager.c:79</div></div>
67 <div class="ttc" id="boxheader__manager_8h_html_ad67b5454e29ddcd711d07eaddbe29f67"><div class="ttname"><a href="boxheader__manager_8h.html#ad67b5454e29ddcd711d07eaddbe29f67">gene_boxheader</a></div><div class="ttdeci">boxheader_param_t * gene_boxheader(int fd, OPJ_OFF_T offset)</div><div class="ttdoc">generate a box header at the given offset </div><div class="ttdef"><b>Definition:</b> boxheader_manager.c:48</div></div>
68 <div class="ttc" id="box__manager_8h_html"><div class="ttname"><a href="box__manager_8h.html">box_manager.h</a></div></div>
69 <div class="ttc" id="structboxheader__param_html_aabf782e3d43e158e4477308c11670ac4"><div class="ttname"><a href="structboxheader__param.html#aabf782e3d43e158e4477308c11670ac4">boxheader_param::headlen</a></div><div class="ttdeci">Byte_t headlen</div><div class="ttdoc">header length 8 or 16 </div><div class="ttdef"><b>Definition:</b> boxheader_manager.h:40</div></div>
70 <div class="ttc" id="byte__manager_8h_html_a89544bfd8f79b949793e43e323e1ace1"><div class="ttname"><a href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a></div><div class="ttdeci">uint64_t Byte8_t</div><div class="ttdef"><b>Definition:</b> byte_manager.h:40</div></div>
71 </div><!-- fragment --></div><!-- contents -->
72 <!-- start footer part -->
73 <hr class="footer"/><address class="footer"><small>
74 Generated by &#160;<a href="http://www.doxygen.org/index.html">
75 <img class="footer" src="doxygen.png" alt="doxygen"/>
76 </a> 1.8.11
77 </small></address>
78 </body>
79 </html>