openjpeg/doxygen/codestream__manager_8h_sour...

143 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>OpenJPEG: codestream_manager.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OpenJPEG
&#160;<span id="projectnumber">2.3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d522931ffa1371640980b621734a4381.html">Users</a></li><li class="navelem"><a class="el" href="dir_694e20c96f4fc1be4aed4f026eadce94.html">antonin</a></li><li class="navelem"><a class="el" href="dir_3ca1ad36e65e03f9e8d67ddc2553765b.html">dev</a></li><li class="navelem"><a class="el" href="dir_181a881edfcb8646dab693a228fa6bde.html">opj</a></li><li class="navelem"><a class="el" href="dir_5064bb5511811c3176850b7e47443f14.html">github</a></li><li class="navelem"><a class="el" href="dir_0b20524d8f8835ca75acc430451c8412.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_e3f8a8e294f8271ee71cbcf3c2acacc1.html">src</a></li><li class="navelem"><a class="el" href="dir_da83fe5fdfb6c4554d36abffc03790ad.html">lib</a></li><li class="navelem"><a class="el" href="dir_6ec2d9a1b37a1187cc46aeaf3b19e1b3.html">openjpip</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">codestream_manager.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="codestream__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 CODESTREAM_MANAGER_H_</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor"># define CODESTREAM_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;</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structcodestream__param.html"> 37</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structcodestream__param.html">codestream_param</a> {</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structcodestream__param.html#a75fc79562c1244fc477916b83c6b888c"> 38</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="structcodestream__param.html#a75fc79562c1244fc477916b83c6b888c">fd</a>; </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structcodestream__param.html#ac6010c22e0f1e7414a219b7d0927435b"> 39</a></span>&#160; <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> <a class="code" href="structcodestream__param.html#ac6010c22e0f1e7414a219b7d0927435b">offset</a>; </div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structcodestream__param.html#adb9e4859001399db5cbf825a6ec52a76"> 40</a></span>&#160; <a class="code" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> <a class="code" href="structcodestream__param.html#adb9e4859001399db5cbf825a6ec52a76">length</a>; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;} <a class="code" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<a class="code" href="structcodestream__param.html">codestream_param_t</a> <a class="code" href="codestream__manager_8h.html#abe246d173d4accb765de170e9976cd20">set_codestream</a>(<span class="keywordtype">int</span> fd, <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset, <a class="code" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> length);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<a class="code" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> * <a class="code" href="codestream__manager_8h.html#a92e8c0b1815dc9ede628541b28971dc4">fetch_codestreambytes</a>(<a class="code" href="structcodestream__param.html">codestream_param_t</a> *cs, <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset,</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <a class="code" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> size);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<a class="code" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> <a class="code" href="codestream__manager_8h.html#af659af47f43c4ef6cea74c5697acf078">fetch_codestream1byte</a>(<a class="code" href="structcodestream__param.html">codestream_param_t</a> *cs, <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> <a class="code" href="codestream__manager_8h.html#a6dbb4634cd0d3c32cc641750119d1a65">fetch_codestream2bytebigendian</a>(<a class="code" href="structcodestream__param.html">codestream_param_t</a> *cs,</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<a class="code" href="byte__manager_8h.html#aad2d957f29839c12c87e4dd945807d36">Byte4_t</a> <a class="code" href="codestream__manager_8h.html#aee603a657d0cf18f32e86bd2b2efdafe">fetch_codestream4bytebigendian</a>(<a class="code" href="structcodestream__param.html">codestream_param_t</a> *cs,</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="keywordtype">void</span> <a class="code" href="codestream__manager_8h.html#a5c8f513ed058bbc4c5798b8e0893cd62">print_codestream</a>(<a class="code" href="structcodestream__param.html">codestream_param_t</a> cs);</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* !CODESTREAM_MANAGER_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="codestream__manager_8h_html_abe246d173d4accb765de170e9976cd20"><div class="ttname"><a href="codestream__manager_8h.html#abe246d173d4accb765de170e9976cd20">set_codestream</a></div><div class="ttdeci">codestream_param_t set_codestream(int fd, OPJ_OFF_T offset, OPJ_SIZE_T length)</div><div class="ttdoc">set codestream parameters from inputs </div><div class="ttdef"><b>Definition:</b> codestream_manager.c:44</div></div>
<div class="ttc" id="codestream__manager_8h_html_a5c8f513ed058bbc4c5798b8e0893cd62"><div class="ttname"><a href="codestream__manager_8h.html#a5c8f513ed058bbc4c5798b8e0893cd62">print_codestream</a></div><div class="ttdeci">void print_codestream(codestream_param_t cs)</div><div class="ttdoc">print codestream parameters </div><div class="ttdef"><b>Definition:</b> codestream_manager.c:76</div></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>
<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="codestream__manager_8h_html_aee603a657d0cf18f32e86bd2b2efdafe"><div class="ttname"><a href="codestream__manager_8h.html#aee603a657d0cf18f32e86bd2b2efdafe">fetch_codestream4bytebigendian</a></div><div class="ttdeci">Byte4_t fetch_codestream4bytebigendian(codestream_param_t *cs, OPJ_OFF_T offset)</div><div class="ttdoc">fetch Codestream 4-byte big endian Byte codes in file stream </div><div class="ttdef"><b>Definition:</b> codestream_manager.c:71</div></div>
<div class="ttc" id="structcodestream__param_html_adb9e4859001399db5cbf825a6ec52a76"><div class="ttname"><a href="structcodestream__param.html#adb9e4859001399db5cbf825a6ec52a76">codestream_param::length</a></div><div class="ttdeci">Byte8_t length</div><div class="ttdoc">content length </div><div class="ttdef"><b>Definition:</b> codestream_manager.h:40</div></div>
<div class="ttc" id="structcodestream__param_html_ac6010c22e0f1e7414a219b7d0927435b"><div class="ttname"><a href="structcodestream__param.html#ac6010c22e0f1e7414a219b7d0927435b">codestream_param::offset</a></div><div class="ttdeci">OPJ_OFF_T offset</div><div class="ttdoc">byte position of DBox (Box Contents) in the file </div><div class="ttdef"><b>Definition:</b> codestream_manager.h:39</div></div>
<div class="ttc" id="openjpeg_8h_html_aba7397be054e36dc0284a6589736135e"><div class="ttname"><a href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a></div><div class="ttdeci">size_t OPJ_SIZE_T</div><div class="ttdef"><b>Definition:</b> openjpeg.h:133</div></div>
<div class="ttc" id="structcodestream__param_html"><div class="ttname"><a href="structcodestream__param.html">codestream_param</a></div><div class="ttdoc">codestream parameters </div><div class="ttdef"><b>Definition:</b> codestream_manager.h:37</div></div>
<div class="ttc" id="structcodestream__param_html_a75fc79562c1244fc477916b83c6b888c"><div class="ttname"><a href="structcodestream__param.html#a75fc79562c1244fc477916b83c6b888c">codestream_param::fd</a></div><div class="ttdeci">int fd</div><div class="ttdoc">file descriptor </div><div class="ttdef"><b>Definition:</b> codestream_manager.h:38</div></div>
<div class="ttc" id="codestream__manager_8h_html_a6dbb4634cd0d3c32cc641750119d1a65"><div class="ttname"><a href="codestream__manager_8h.html#a6dbb4634cd0d3c32cc641750119d1a65">fetch_codestream2bytebigendian</a></div><div class="ttdeci">Byte2_t fetch_codestream2bytebigendian(codestream_param_t *cs, OPJ_OFF_T offset)</div><div class="ttdoc">fetch Codestream 2-byte big endian Byte codes in file stream </div><div class="ttdef"><b>Definition:</b> codestream_manager.c:66</div></div>
<div class="ttc" id="byte__manager_8h_html_aad2d957f29839c12c87e4dd945807d36"><div class="ttname"><a href="byte__manager_8h.html#aad2d957f29839c12c87e4dd945807d36">Byte4_t</a></div><div class="ttdeci">uint32_t Byte4_t</div><div class="ttdef"><b>Definition:</b> byte_manager.h:39</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="codestream__manager_8h_html_ae63fd7d7c047905a5cd0229f824aff09"><div class="ttname"><a href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a></div><div class="ttdeci">struct codestream_param codestream_param_t</div><div class="ttdoc">codestream parameters </div></div>
<div class="ttc" id="codestream__manager_8h_html_a92e8c0b1815dc9ede628541b28971dc4"><div class="ttname"><a href="codestream__manager_8h.html#a92e8c0b1815dc9ede628541b28971dc4">fetch_codestreambytes</a></div><div class="ttdeci">Byte_t * fetch_codestreambytes(codestream_param_t *cs, OPJ_OFF_T offset, OPJ_SIZE_T size)</div><div class="ttdoc">fetch Codestream bytes of data in file stream </div><div class="ttdef"><b>Definition:</b> codestream_manager.c:55</div></div>
<div class="ttc" id="codestream__manager_8h_html_af659af47f43c4ef6cea74c5697acf078"><div class="ttname"><a href="codestream__manager_8h.html#af659af47f43c4ef6cea74c5697acf078">fetch_codestream1byte</a></div><div class="ttdeci">Byte_t fetch_codestream1byte(codestream_param_t *cs, OPJ_OFF_T offset)</div><div class="ttdoc">fetch Codestream 1-byte Byte code in file stream </div><div class="ttdef"><b>Definition:</b> codestream_manager.c:61</div></div>
<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>
<div class="ttc" id="byte__manager_8h_html_a633aa9ecff048e1b8bfbdac4c4dfdb33"><div class="ttname"><a href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a></div><div class="ttdeci">uint16_t Byte2_t</div><div class="ttdef"><b>Definition:</b> byte_manager.h:38</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>