Update doxygen for release 2.3.1
[openjpeg.git] / doxygen / marker__manager_8c.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.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: marker_manager.c File Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <div id="titlearea">
17 <table cellspacing="0" cellpadding="0">
18  <tbody>
19  <tr style="height: 56px;">
20   <td id="projectalign" style="padding-left: 0.5em;">
21    <div id="projectname">OpenJPEG
22    &#160;<span id="projectnumber">2.3.1</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.13 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 $(function() {
35   initMenu('',false,false,'search.php','Search');
36 });
37 </script>
38 <div id="main-nav"></div>
39 <div id="nav-path" class="navpath">
40   <ul>
41 <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>
42 </div>
43 </div><!-- top -->
44 <div class="header">
45   <div class="summary">
46 <a href="#define-members">Macros</a> &#124;
47 <a href="#func-members">Functions</a>  </div>
48   <div class="headertitle">
49 <div class="title">marker_manager.c File Reference</div>  </div>
50 </div><!--header-->
51 <div class="contents">
52 <div class="textblock"><code>#include &quot;<a class="el" href="marker__manager_8h_source.html">marker_manager.h</a>&quot;</code><br />
53 </div><table class="memberdecls">
54 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
55 Macros</h2></td></tr>
56 <tr class="memitem:ac322e421aefb8ec9ccc10bef953e3d82"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8c.html#ac322e421aefb8ec9ccc10bef953e3d82">FCGI_stdout</a>&#160;&#160;&#160;stdout</td></tr>
57 <tr class="separator:ac322e421aefb8ec9ccc10bef953e3d82"><td class="memSeparator" colspan="2">&#160;</td></tr>
58 <tr class="memitem:a77b5d5af2adb2cfa7ec785b592fc4074"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8c.html#a77b5d5af2adb2cfa7ec785b592fc4074">FCGI_stderr</a>&#160;&#160;&#160;stderr</td></tr>
59 <tr class="separator:a77b5d5af2adb2cfa7ec785b592fc4074"><td class="memSeparator" colspan="2">&#160;</td></tr>
60 <tr class="memitem:a31c99676da88bb0bcdb350710f00fa96"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8c.html#a31c99676da88bb0bcdb350710f00fa96">logstream</a>&#160;&#160;&#160;stderr</td></tr>
61 <tr class="separator:a31c99676da88bb0bcdb350710f00fa96"><td class="memSeparator" colspan="2">&#160;</td></tr>
62 </table><table class="memberdecls">
63 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
64 Functions</h2></td></tr>
65 <tr class="memitem:aeba6604c55d20ce4dafca1c0bd8e1fbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8c.html#aeba6604c55d20ce4dafca1c0bd8e1fbc">set_marker</a> (<a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a> cs, <a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> code, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset, <a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> length)</td></tr>
66 <tr class="memdesc:aeba6604c55d20ce4dafca1c0bd8e1fbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">set marker parameters from inputs  <a href="#aeba6604c55d20ce4dafca1c0bd8e1fbc">More...</a><br /></td></tr>
67 <tr class="separator:aeba6604c55d20ce4dafca1c0bd8e1fbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
68 <tr class="memitem:a310269e7466f3a1588930e9cbc51570c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8c.html#a310269e7466f3a1588930e9cbc51570c">fetch_marker1byte</a> (<a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a> marker, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
69 <tr class="memdesc:a310269e7466f3a1588930e9cbc51570c"><td class="mdescLeft">&#160;</td><td class="mdescRight">fetch marker content 1-bytes of data in file stream  <a href="#a310269e7466f3a1588930e9cbc51570c">More...</a><br /></td></tr>
70 <tr class="separator:a310269e7466f3a1588930e9cbc51570c"><td class="memSeparator" colspan="2">&#160;</td></tr>
71 <tr class="memitem:ac884dafb92a564a501b1cbc01333d248"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8c.html#ac884dafb92a564a501b1cbc01333d248">fetch_marker2bytebigendian</a> (<a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a> marker, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
72 <tr class="memdesc:ac884dafb92a564a501b1cbc01333d248"><td class="mdescLeft">&#160;</td><td class="mdescRight">fetch marker content 2-byte big endian Byte codes in file stream  <a href="#ac884dafb92a564a501b1cbc01333d248">More...</a><br /></td></tr>
73 <tr class="separator:ac884dafb92a564a501b1cbc01333d248"><td class="memSeparator" colspan="2">&#160;</td></tr>
74 <tr class="memitem:a6531c0062e0d866e406543e3f63f9c86"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#aad2d957f29839c12c87e4dd945807d36">Byte4_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8c.html#a6531c0062e0d866e406543e3f63f9c86">fetch_marker4bytebigendian</a> (<a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a> marker, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
75 <tr class="memdesc:a6531c0062e0d866e406543e3f63f9c86"><td class="mdescLeft">&#160;</td><td class="mdescRight">fetch marker content 4-byte big endian Byte codes in file stream  <a href="#a6531c0062e0d866e406543e3f63f9c86">More...</a><br /></td></tr>
76 <tr class="separator:a6531c0062e0d866e406543e3f63f9c86"><td class="memSeparator" colspan="2">&#160;</td></tr>
77 </table>
78 <h2 class="groupheader">Macro Definition Documentation</h2>
79 <a id="a77b5d5af2adb2cfa7ec785b592fc4074"></a>
80 <h2 class="memtitle"><span class="permalink"><a href="#a77b5d5af2adb2cfa7ec785b592fc4074">&#9670;&nbsp;</a></span>FCGI_stderr</h2>
81
82 <div class="memitem">
83 <div class="memproto">
84       <table class="memname">
85         <tr>
86           <td class="memname">#define FCGI_stderr&#160;&#160;&#160;stderr</td>
87         </tr>
88       </table>
89 </div><div class="memdoc">
90
91 </div>
92 </div>
93 <a id="ac322e421aefb8ec9ccc10bef953e3d82"></a>
94 <h2 class="memtitle"><span class="permalink"><a href="#ac322e421aefb8ec9ccc10bef953e3d82">&#9670;&nbsp;</a></span>FCGI_stdout</h2>
95
96 <div class="memitem">
97 <div class="memproto">
98       <table class="memname">
99         <tr>
100           <td class="memname">#define FCGI_stdout&#160;&#160;&#160;stdout</td>
101         </tr>
102       </table>
103 </div><div class="memdoc">
104
105 </div>
106 </div>
107 <a id="a31c99676da88bb0bcdb350710f00fa96"></a>
108 <h2 class="memtitle"><span class="permalink"><a href="#a31c99676da88bb0bcdb350710f00fa96">&#9670;&nbsp;</a></span>logstream</h2>
109
110 <div class="memitem">
111 <div class="memproto">
112       <table class="memname">
113         <tr>
114           <td class="memname">#define logstream&#160;&#160;&#160;stderr</td>
115         </tr>
116       </table>
117 </div><div class="memdoc">
118
119 </div>
120 </div>
121 <h2 class="groupheader">Function Documentation</h2>
122 <a id="a310269e7466f3a1588930e9cbc51570c"></a>
123 <h2 class="memtitle"><span class="permalink"><a href="#a310269e7466f3a1588930e9cbc51570c">&#9670;&nbsp;</a></span>fetch_marker1byte()</h2>
124
125 <div class="memitem">
126 <div class="memproto">
127       <table class="memname">
128         <tr>
129           <td class="memname"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> fetch_marker1byte </td>
130           <td>(</td>
131           <td class="paramtype"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a>&#160;</td>
132           <td class="paramname"><em>marker</em>, </td>
133         </tr>
134         <tr>
135           <td class="paramkey"></td>
136           <td></td>
137           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
138           <td class="paramname"><em>offset</em>&#160;</td>
139         </tr>
140         <tr>
141           <td></td>
142           <td>)</td>
143           <td></td><td></td>
144         </tr>
145       </table>
146 </div><div class="memdoc">
147
148 <p>fetch marker content 1-bytes of data in file stream </p>
149 <dl class="params"><dt>Parameters</dt><dd>
150   <table class="params">
151     <tr><td class="paramdir">[in]</td><td class="paramname">marker</td><td>marker structure </td></tr>
152     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>start Byte position in marker </td></tr>
153   </table>
154   </dd>
155 </dl>
156 <dl class="section return"><dt>Returns</dt><dd>fetched code </dd></dl>
157
158 <p class="reference">References <a class="el" href="structmarker__param.html#ab4a936d6d175dbf0a0295a3ec86e16c6">marker_param::cs</a>, <a class="el" href="codestream__manager_8c.html#af659af47f43c4ef6cea74c5697acf078">fetch_codestream1byte()</a>, and <a class="el" href="structmarker__param.html#acb6fa042e8be6c79cb461a5f9bc74750">marker_param::offset</a>.</p>
159
160 <p class="reference">Referenced by <a class="el" href="index__manager_8c.html#a7e9ae91b6cde958c7857680290cce24e">set_CODmkrdata()</a>, and <a class="el" href="index__manager_8c.html#a4031ccd48358b64a1720c15cf87cc5ff">set_SIZmkrdata()</a>.</p>
161
162 </div>
163 </div>
164 <a id="ac884dafb92a564a501b1cbc01333d248"></a>
165 <h2 class="memtitle"><span class="permalink"><a href="#ac884dafb92a564a501b1cbc01333d248">&#9670;&nbsp;</a></span>fetch_marker2bytebigendian()</h2>
166
167 <div class="memitem">
168 <div class="memproto">
169       <table class="memname">
170         <tr>
171           <td class="memname"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> fetch_marker2bytebigendian </td>
172           <td>(</td>
173           <td class="paramtype"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a>&#160;</td>
174           <td class="paramname"><em>marker</em>, </td>
175         </tr>
176         <tr>
177           <td class="paramkey"></td>
178           <td></td>
179           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
180           <td class="paramname"><em>offset</em>&#160;</td>
181         </tr>
182         <tr>
183           <td></td>
184           <td>)</td>
185           <td></td><td></td>
186         </tr>
187       </table>
188 </div><div class="memdoc">
189
190 <p>fetch marker content 2-byte big endian Byte codes in file stream </p>
191 <dl class="params"><dt>Parameters</dt><dd>
192   <table class="params">
193     <tr><td class="paramdir">[in]</td><td class="paramname">marker</td><td>marker structure </td></tr>
194     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>start Byte position in marker </td></tr>
195   </table>
196   </dd>
197 </dl>
198 <dl class="section return"><dt>Returns</dt><dd>fetched code </dd></dl>
199
200 <p class="reference">References <a class="el" href="structmarker__param.html#ab4a936d6d175dbf0a0295a3ec86e16c6">marker_param::cs</a>, <a class="el" href="codestream__manager_8c.html#a6dbb4634cd0d3c32cc641750119d1a65">fetch_codestream2bytebigendian()</a>, and <a class="el" href="structmarker__param.html#acb6fa042e8be6c79cb461a5f9bc74750">marker_param::offset</a>.</p>
201
202 <p class="reference">Referenced by <a class="el" href="index__manager_8c.html#a7e9ae91b6cde958c7857680290cce24e">set_CODmkrdata()</a>, and <a class="el" href="index__manager_8c.html#a4031ccd48358b64a1720c15cf87cc5ff">set_SIZmkrdata()</a>.</p>
203
204 </div>
205 </div>
206 <a id="a6531c0062e0d866e406543e3f63f9c86"></a>
207 <h2 class="memtitle"><span class="permalink"><a href="#a6531c0062e0d866e406543e3f63f9c86">&#9670;&nbsp;</a></span>fetch_marker4bytebigendian()</h2>
208
209 <div class="memitem">
210 <div class="memproto">
211       <table class="memname">
212         <tr>
213           <td class="memname"><a class="el" href="byte__manager_8h.html#aad2d957f29839c12c87e4dd945807d36">Byte4_t</a> fetch_marker4bytebigendian </td>
214           <td>(</td>
215           <td class="paramtype"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a>&#160;</td>
216           <td class="paramname"><em>marker</em>, </td>
217         </tr>
218         <tr>
219           <td class="paramkey"></td>
220           <td></td>
221           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
222           <td class="paramname"><em>offset</em>&#160;</td>
223         </tr>
224         <tr>
225           <td></td>
226           <td>)</td>
227           <td></td><td></td>
228         </tr>
229       </table>
230 </div><div class="memdoc">
231
232 <p>fetch marker content 4-byte big endian Byte codes in file stream </p>
233 <dl class="params"><dt>Parameters</dt><dd>
234   <table class="params">
235     <tr><td class="paramdir">[in]</td><td class="paramname">marker</td><td>marker structure </td></tr>
236     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>start Byte position in marker </td></tr>
237   </table>
238   </dd>
239 </dl>
240 <dl class="section return"><dt>Returns</dt><dd>fetched code </dd></dl>
241
242 <p class="reference">References <a class="el" href="structmarker__param.html#ab4a936d6d175dbf0a0295a3ec86e16c6">marker_param::cs</a>, <a class="el" href="codestream__manager_8c.html#aee603a657d0cf18f32e86bd2b2efdafe">fetch_codestream4bytebigendian()</a>, and <a class="el" href="structmarker__param.html#acb6fa042e8be6c79cb461a5f9bc74750">marker_param::offset</a>.</p>
243
244 <p class="reference">Referenced by <a class="el" href="index__manager_8c.html#a4031ccd48358b64a1720c15cf87cc5ff">set_SIZmkrdata()</a>.</p>
245
246 </div>
247 </div>
248 <a id="aeba6604c55d20ce4dafca1c0bd8e1fbc"></a>
249 <h2 class="memtitle"><span class="permalink"><a href="#aeba6604c55d20ce4dafca1c0bd8e1fbc">&#9670;&nbsp;</a></span>set_marker()</h2>
250
251 <div class="memitem">
252 <div class="memproto">
253       <table class="memname">
254         <tr>
255           <td class="memname"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a> set_marker </td>
256           <td>(</td>
257           <td class="paramtype"><a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a>&#160;</td>
258           <td class="paramname"><em>cs</em>, </td>
259         </tr>
260         <tr>
261           <td class="paramkey"></td>
262           <td></td>
263           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a>&#160;</td>
264           <td class="paramname"><em>code</em>, </td>
265         </tr>
266         <tr>
267           <td class="paramkey"></td>
268           <td></td>
269           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
270           <td class="paramname"><em>offset</em>, </td>
271         </tr>
272         <tr>
273           <td class="paramkey"></td>
274           <td></td>
275           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a>&#160;</td>
276           <td class="paramname"><em>length</em>&#160;</td>
277         </tr>
278         <tr>
279           <td></td>
280           <td>)</td>
281           <td></td><td></td>
282         </tr>
283       </table>
284 </div><div class="memdoc">
285
286 <p>set marker parameters from inputs </p>
287 <dl class="params"><dt>Parameters</dt><dd>
288   <table class="params">
289     <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>marker code </td></tr>
290     <tr><td class="paramdir">[in]</td><td class="paramname">code</td><td>marker code </td></tr>
291     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>offset in the codestream </td></tr>
292     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>marker segment length </td></tr>
293   </table>
294   </dd>
295 </dl>
296 <dl class="section return"><dt>Returns</dt><dd>structure of generated marker parameters </dd></dl>
297
298 <p class="reference">References <a class="el" href="structmarker__param.html#a631774a24ccb8eddb0fd3c71d99cb7fa">marker_param::code</a>, <a class="el" href="structmarker__param.html#ab4a936d6d175dbf0a0295a3ec86e16c6">marker_param::cs</a>, <a class="el" href="structmarker__param.html#a74f9dda8b061c37c77d4c99a16ae9f92">marker_param::length</a>, and <a class="el" href="structmarker__param.html#acb6fa042e8be6c79cb461a5f9bc74750">marker_param::offset</a>.</p>
299
300 <p class="reference">Referenced by <a class="el" href="index__manager_8c.html#a7e9ae91b6cde958c7857680290cce24e">set_CODmkrdata()</a>, and <a class="el" href="index__manager_8c.html#a4031ccd48358b64a1720c15cf87cc5ff">set_SIZmkrdata()</a>.</p>
301
302 </div>
303 </div>
304 </div><!-- contents -->
305 <!-- start footer part -->
306 <hr class="footer"/><address class="footer"><small>
307 Generated by &#160;<a href="http://www.doxygen.org/index.html">
308 <img class="footer" src="doxygen.png" alt="doxygen"/>
309 </a> 1.8.13
310 </small></address>
311 </body>
312 </html>