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">
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.10"/>
7 <title>OpenJPEG: codestream_manager.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" />
14 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <table cellspacing="0" cellpadding="0">
18 <tr style="height: 56px;">
19 <td id="projectalign" style="padding-left: 0.5em;">
20 <div id="projectname">OpenJPEG
21  <span id="projectnumber">2.2.0</span>
28 <!-- end header part -->
29 <!-- Generated by Doxygen 1.8.10 -->
30 <div id="navrow1" class="tabs">
32 <li><a href="index.html"><span>Main Page</span></a></li>
33 <li><a href="pages.html"><span>Related Pages</span></a></li>
34 <li><a href="modules.html"><span>Modules</span></a></li>
35 <li><a href="annotated.html"><span>Data Structures</span></a></li>
36 <li class="current"><a href="files.html"><span>Files</span></a></li>
39 <div id="navrow2" class="tabs2">
41 <li><a href="files.html"><span>File List</span></a></li>
42 <li><a href="globals.html"><span>Globals</span></a></li>
45 <div id="nav-path" class="navpath">
47 <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>
52 <a href="#nested-classes">Data Structures</a> |
53 <a href="#typedef-members">Typedefs</a> |
54 <a href="#func-members">Functions</a> </div>
55 <div class="headertitle">
56 <div class="title">codestream_manager.h File Reference</div> </div>
58 <div class="contents">
59 <div class="textblock"><code>#include "<a class="el" href="byte__manager_8h_source.html">byte_manager.h</a>"</code><br />
61 <p><a href="codestream__manager_8h_source.html">Go to the source code of this file.</a></p>
62 <table class="memberdecls">
63 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
64 Data Structures</h2></td></tr>
65 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structcodestream__param.html">codestream_param</a></td></tr>
66 <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">codestream parameters <a href="structcodestream__param.html#details">More...</a><br /></td></tr>
67 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
68 </table><table class="memberdecls">
69 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
70 Typedefs</h2></td></tr>
71 <tr class="memitem:ae63fd7d7c047905a5cd0229f824aff09"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structcodestream__param.html">codestream_param</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a></td></tr>
72 <tr class="memdesc:ae63fd7d7c047905a5cd0229f824aff09"><td class="mdescLeft"> </td><td class="mdescRight">codestream parameters <a href="#ae63fd7d7c047905a5cd0229f824aff09">More...</a><br /></td></tr>
73 <tr class="separator:ae63fd7d7c047905a5cd0229f824aff09"><td class="memSeparator" colspan="2"> </td></tr>
74 </table><table class="memberdecls">
75 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
76 Functions</h2></td></tr>
77 <tr class="memitem:abe246d173d4accb765de170e9976cd20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="codestream__manager_8h.html#abe246d173d4accb765de170e9976cd20">set_codestream</a> (int fd, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset, <a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> length)</td></tr>
78 <tr class="memdesc:abe246d173d4accb765de170e9976cd20"><td class="mdescLeft"> </td><td class="mdescRight">set codestream parameters from inputs <a href="#abe246d173d4accb765de170e9976cd20">More...</a><br /></td></tr>
79 <tr class="separator:abe246d173d4accb765de170e9976cd20"><td class="memSeparator" colspan="2"> </td></tr>
80 <tr class="memitem:a92e8c0b1815dc9ede628541b28971dc4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="codestream__manager_8h.html#a92e8c0b1815dc9ede628541b28971dc4">fetch_codestreambytes</a> (<a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a> *cs, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset, <a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> size)</td></tr>
81 <tr class="memdesc:a92e8c0b1815dc9ede628541b28971dc4"><td class="mdescLeft"> </td><td class="mdescRight">fetch Codestream bytes of data in file stream <a href="#a92e8c0b1815dc9ede628541b28971dc4">More...</a><br /></td></tr>
82 <tr class="separator:a92e8c0b1815dc9ede628541b28971dc4"><td class="memSeparator" colspan="2"> </td></tr>
83 <tr class="memitem:af659af47f43c4ef6cea74c5697acf078"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="codestream__manager_8h.html#af659af47f43c4ef6cea74c5697acf078">fetch_codestream1byte</a> (<a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a> *cs, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
84 <tr class="memdesc:af659af47f43c4ef6cea74c5697acf078"><td class="mdescLeft"> </td><td class="mdescRight">fetch Codestream 1-byte Byte code in file stream <a href="#af659af47f43c4ef6cea74c5697acf078">More...</a><br /></td></tr>
85 <tr class="separator:af659af47f43c4ef6cea74c5697acf078"><td class="memSeparator" colspan="2"> </td></tr>
86 <tr class="memitem:a6dbb4634cd0d3c32cc641750119d1a65"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="codestream__manager_8h.html#a6dbb4634cd0d3c32cc641750119d1a65">fetch_codestream2bytebigendian</a> (<a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a> *cs, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
87 <tr class="memdesc:a6dbb4634cd0d3c32cc641750119d1a65"><td class="mdescLeft"> </td><td class="mdescRight">fetch Codestream 2-byte big endian Byte codes in file stream <a href="#a6dbb4634cd0d3c32cc641750119d1a65">More...</a><br /></td></tr>
88 <tr class="separator:a6dbb4634cd0d3c32cc641750119d1a65"><td class="memSeparator" colspan="2"> </td></tr>
89 <tr class="memitem:aee603a657d0cf18f32e86bd2b2efdafe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#aad2d957f29839c12c87e4dd945807d36">Byte4_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="codestream__manager_8h.html#aee603a657d0cf18f32e86bd2b2efdafe">fetch_codestream4bytebigendian</a> (<a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a> *cs, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
90 <tr class="memdesc:aee603a657d0cf18f32e86bd2b2efdafe"><td class="mdescLeft"> </td><td class="mdescRight">fetch Codestream 4-byte big endian Byte codes in file stream <a href="#aee603a657d0cf18f32e86bd2b2efdafe">More...</a><br /></td></tr>
91 <tr class="separator:aee603a657d0cf18f32e86bd2b2efdafe"><td class="memSeparator" colspan="2"> </td></tr>
92 <tr class="memitem:a5c8f513ed058bbc4c5798b8e0893cd62"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="codestream__manager_8h.html#a5c8f513ed058bbc4c5798b8e0893cd62">print_codestream</a> (<a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a> cs)</td></tr>
93 <tr class="memdesc:a5c8f513ed058bbc4c5798b8e0893cd62"><td class="mdescLeft"> </td><td class="mdescRight">print codestream parameters <a href="#a5c8f513ed058bbc4c5798b8e0893cd62">More...</a><br /></td></tr>
94 <tr class="separator:a5c8f513ed058bbc4c5798b8e0893cd62"><td class="memSeparator" colspan="2"> </td></tr>
96 <h2 class="groupheader">Typedef Documentation</h2>
97 <a class="anchor" id="ae63fd7d7c047905a5cd0229f824aff09"></a>
99 <div class="memproto">
100 <table class="memname">
102 <td class="memname">typedef struct <a class="el" href="structcodestream__param.html">codestream_param</a> <a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a></td>
105 </div><div class="memdoc">
107 <p>codestream parameters </p>
111 <h2 class="groupheader">Function Documentation</h2>
112 <a class="anchor" id="af659af47f43c4ef6cea74c5697acf078"></a>
113 <div class="memitem">
114 <div class="memproto">
115 <table class="memname">
117 <td class="memname"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> fetch_codestream1byte </td>
119 <td class="paramtype"><a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a> * </td>
120 <td class="paramname"><em>cs</em>, </td>
123 <td class="paramkey"></td>
125 <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> </td>
126 <td class="paramname"><em>offset</em> </td>
134 </div><div class="memdoc">
136 <p>fetch Codestream 1-byte Byte code in file stream </p>
137 <dl class="params"><dt>Parameters</dt><dd>
138 <table class="params">
139 <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>codestream pointer </td></tr>
140 <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>start Byte position in codestream </td></tr>
144 <dl class="section return"><dt>Returns</dt><dd>fetched code </dd></dl>
146 <p>References <a class="el" href="structcodestream__param.html#a75fc79562c1244fc477916b83c6b888c">codestream_param::fd</a>, <a class="el" href="byte__manager_8c.html#a80c5006e047b8a2a5bbb48bcbc9bbd7c">fetch_1byte()</a>, and <a class="el" href="structcodestream__param.html#ac6010c22e0f1e7414a219b7d0927435b">codestream_param::offset</a>.</p>
148 <p>Referenced by <a class="el" href="marker__manager_8h.html#a310269e7466f3a1588930e9cbc51570c">fetch_marker1byte()</a>.</p>
152 <a class="anchor" id="a6dbb4634cd0d3c32cc641750119d1a65"></a>
153 <div class="memitem">
154 <div class="memproto">
155 <table class="memname">
157 <td class="memname"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> fetch_codestream2bytebigendian </td>
159 <td class="paramtype"><a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a> * </td>
160 <td class="paramname"><em>cs</em>, </td>
163 <td class="paramkey"></td>
165 <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> </td>
166 <td class="paramname"><em>offset</em> </td>
174 </div><div class="memdoc">
176 <p>fetch Codestream 2-byte big endian Byte codes in file stream </p>
177 <dl class="params"><dt>Parameters</dt><dd>
178 <table class="params">
179 <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>codestream pointer </td></tr>
180 <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>start Byte position in codestream </td></tr>
184 <dl class="section return"><dt>Returns</dt><dd>fetched code </dd></dl>
186 <p>References <a class="el" href="structcodestream__param.html#a75fc79562c1244fc477916b83c6b888c">codestream_param::fd</a>, <a class="el" href="byte__manager_8c.html#adc0810a234de2f1a8d59218959e07671">fetch_2bytebigendian()</a>, and <a class="el" href="structcodestream__param.html#ac6010c22e0f1e7414a219b7d0927435b">codestream_param::offset</a>.</p>
188 <p>Referenced by <a class="el" href="marker__manager_8h.html#ac884dafb92a564a501b1cbc01333d248">fetch_marker2bytebigendian()</a>.</p>
192 <a class="anchor" id="aee603a657d0cf18f32e86bd2b2efdafe"></a>
193 <div class="memitem">
194 <div class="memproto">
195 <table class="memname">
197 <td class="memname"><a class="el" href="byte__manager_8h.html#aad2d957f29839c12c87e4dd945807d36">Byte4_t</a> fetch_codestream4bytebigendian </td>
199 <td class="paramtype"><a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a> * </td>
200 <td class="paramname"><em>cs</em>, </td>
203 <td class="paramkey"></td>
205 <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> </td>
206 <td class="paramname"><em>offset</em> </td>
214 </div><div class="memdoc">
216 <p>fetch Codestream 4-byte big endian Byte codes in file stream </p>
217 <dl class="params"><dt>Parameters</dt><dd>
218 <table class="params">
219 <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>codestream pointer </td></tr>
220 <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>start Byte position in codestream </td></tr>
224 <dl class="section return"><dt>Returns</dt><dd>fetched code </dd></dl>
226 <p>References <a class="el" href="structcodestream__param.html#a75fc79562c1244fc477916b83c6b888c">codestream_param::fd</a>, <a class="el" href="byte__manager_8c.html#a72b441947e1fab5e8dd83fdc985bf29c">fetch_4bytebigendian()</a>, and <a class="el" href="structcodestream__param.html#ac6010c22e0f1e7414a219b7d0927435b">codestream_param::offset</a>.</p>
228 <p>Referenced by <a class="el" href="marker__manager_8h.html#a6531c0062e0d866e406543e3f63f9c86">fetch_marker4bytebigendian()</a>.</p>
232 <a class="anchor" id="a92e8c0b1815dc9ede628541b28971dc4"></a>
233 <div class="memitem">
234 <div class="memproto">
235 <table class="memname">
237 <td class="memname"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a>* fetch_codestreambytes </td>
239 <td class="paramtype"><a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a> * </td>
240 <td class="paramname"><em>cs</em>, </td>
243 <td class="paramkey"></td>
245 <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> </td>
246 <td class="paramname"><em>offset</em>, </td>
249 <td class="paramkey"></td>
251 <td class="paramtype"><a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> </td>
252 <td class="paramname"><em>size</em> </td>
260 </div><div class="memdoc">
262 <p>fetch Codestream bytes of data in file stream </p>
263 <dl class="params"><dt>Parameters</dt><dd>
264 <table class="params">
265 <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>codestream pointer </td></tr>
266 <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>start Byte position in codestream </td></tr>
267 <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Byte length </td></tr>
271 <dl class="section return"><dt>Returns</dt><dd>pointer to the fetched data </dd></dl>
273 <p>References <a class="el" href="structcodestream__param.html#a75fc79562c1244fc477916b83c6b888c">codestream_param::fd</a>, <a class="el" href="byte__manager_8c.html#a62851758f9c2af1b12995190a1e4e909">fetch_bytes()</a>, and <a class="el" href="structcodestream__param.html#ac6010c22e0f1e7414a219b7d0927435b">codestream_param::offset</a>.</p>
277 <a class="anchor" id="a5c8f513ed058bbc4c5798b8e0893cd62"></a>
278 <div class="memitem">
279 <div class="memproto">
280 <table class="memname">
282 <td class="memname">void print_codestream </td>
284 <td class="paramtype"><a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a> </td>
285 <td class="paramname"><em>cs</em></td><td>)</td>
289 </div><div class="memdoc">
291 <p>print codestream parameters </p>
292 <dl class="params"><dt>Parameters</dt><dd>
293 <table class="params">
294 <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>codestream </td></tr>
299 <p>References <a class="el" href="structcodestream__param.html#a75fc79562c1244fc477916b83c6b888c">codestream_param::fd</a>, <a class="el" href="structcodestream__param.html#adb9e4859001399db5cbf825a6ec52a76">codestream_param::length</a>, <a class="el" href="codestream__manager_8c.html#a31c99676da88bb0bcdb350710f00fa96">logstream</a>, and <a class="el" href="structcodestream__param.html#ac6010c22e0f1e7414a219b7d0927435b">codestream_param::offset</a>.</p>
303 <a class="anchor" id="abe246d173d4accb765de170e9976cd20"></a>
304 <div class="memitem">
305 <div class="memproto">
306 <table class="memname">
308 <td class="memname"><a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a> set_codestream </td>
310 <td class="paramtype">int </td>
311 <td class="paramname"><em>fd</em>, </td>
314 <td class="paramkey"></td>
316 <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> </td>
317 <td class="paramname"><em>offset</em>, </td>
320 <td class="paramkey"></td>
322 <td class="paramtype"><a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> </td>
323 <td class="paramname"><em>length</em> </td>
331 </div><div class="memdoc">
333 <p>set codestream parameters from inputs </p>
334 <dl class="params"><dt>Parameters</dt><dd>
335 <table class="params">
336 <tr><td class="paramdir">[in]</td><td class="paramname">fd</td><td>file descriptor </td></tr>
337 <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>offset in the file </td></tr>
338 <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>codestream length </td></tr>
342 <dl class="section return"><dt>Returns</dt><dd>structure of generated codestream parameters </dd></dl>
344 <p>References <a class="el" href="structcodestream__param.html#a75fc79562c1244fc477916b83c6b888c">codestream_param::fd</a>, <a class="el" href="structcodestream__param.html#adb9e4859001399db5cbf825a6ec52a76">codestream_param::length</a>, and <a class="el" href="structcodestream__param.html#ac6010c22e0f1e7414a219b7d0927435b">codestream_param::offset</a>.</p>
346 <p>Referenced by <a class="el" href="index__manager_8c.html#a1bca84a98c266c9da610ebbb5d17e83c">set_cidxdata()</a>.</p>
350 </div><!-- contents -->
351 <!-- start footer part -->
352 <hr class="footer"/><address class="footer"><small>
353 Generated by  <a href="http://www.doxygen.org/index.html">
354 <img class="footer" src="doxygen.png" alt="doxygen"/>