Update ABI/API compatibility reports after commit cc1919b183f76d5ac79cc9927fb899b4770...
[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.11"/>
7 <title>OpenJPEG: marker_manager.c 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" />
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="summary">
52 <a href="#define-members">Macros</a> &#124;
53 <a href="#func-members">Functions</a>  </div>
54   <div class="headertitle">
55 <div class="title">marker_manager.c File Reference</div>  </div>
56 </div><!--header-->
57 <div class="contents">
58 <div class="textblock"><code>#include &quot;<a class="el" href="marker__manager_8h_source.html">marker_manager.h</a>&quot;</code><br />
59 </div><table class="memberdecls">
60 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
61 Macros</h2></td></tr>
62 <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>
63 <tr class="separator:ac322e421aefb8ec9ccc10bef953e3d82"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <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>
65 <tr class="separator:a77b5d5af2adb2cfa7ec785b592fc4074"><td class="memSeparator" colspan="2">&#160;</td></tr>
66 <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>
67 <tr class="separator:a31c99676da88bb0bcdb350710f00fa96"><td class="memSeparator" colspan="2">&#160;</td></tr>
68 </table><table class="memberdecls">
69 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
70 Functions</h2></td></tr>
71 <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>
72 <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>
73 <tr class="separator:aeba6604c55d20ce4dafca1c0bd8e1fbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
74 <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>
75 <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>
76 <tr class="separator:a310269e7466f3a1588930e9cbc51570c"><td class="memSeparator" colspan="2">&#160;</td></tr>
77 <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>
78 <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>
79 <tr class="separator:ac884dafb92a564a501b1cbc01333d248"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <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>
81 <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>
82 <tr class="separator:a6531c0062e0d866e406543e3f63f9c86"><td class="memSeparator" colspan="2">&#160;</td></tr>
83 </table>
84 <h2 class="groupheader">Macro Definition Documentation</h2>
85 <a class="anchor" id="a77b5d5af2adb2cfa7ec785b592fc4074"></a>
86 <div class="memitem">
87 <div class="memproto">
88       <table class="memname">
89         <tr>
90           <td class="memname">#define FCGI_stderr&#160;&#160;&#160;stderr</td>
91         </tr>
92       </table>
93 </div><div class="memdoc">
94
95 </div>
96 </div>
97 <a class="anchor" id="ac322e421aefb8ec9ccc10bef953e3d82"></a>
98 <div class="memitem">
99 <div class="memproto">
100       <table class="memname">
101         <tr>
102           <td class="memname">#define FCGI_stdout&#160;&#160;&#160;stdout</td>
103         </tr>
104       </table>
105 </div><div class="memdoc">
106
107 </div>
108 </div>
109 <a class="anchor" id="a31c99676da88bb0bcdb350710f00fa96"></a>
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 class="anchor" id="a310269e7466f3a1588930e9cbc51570c"></a>
123 <div class="memitem">
124 <div class="memproto">
125       <table class="memname">
126         <tr>
127           <td class="memname"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> fetch_marker1byte </td>
128           <td>(</td>
129           <td class="paramtype"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a>&#160;</td>
130           <td class="paramname"><em>marker</em>, </td>
131         </tr>
132         <tr>
133           <td class="paramkey"></td>
134           <td></td>
135           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
136           <td class="paramname"><em>offset</em>&#160;</td>
137         </tr>
138         <tr>
139           <td></td>
140           <td>)</td>
141           <td></td><td></td>
142         </tr>
143       </table>
144 </div><div class="memdoc">
145
146 <p>fetch marker content 1-bytes of data in file stream </p>
147 <dl class="params"><dt>Parameters</dt><dd>
148   <table class="params">
149     <tr><td class="paramdir">[in]</td><td class="paramname">marker</td><td>marker structure </td></tr>
150     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>start Byte position in marker </td></tr>
151   </table>
152   </dd>
153 </dl>
154 <dl class="section return"><dt>Returns</dt><dd>fetched code </dd></dl>
155
156 <p>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>
157
158 <p>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>
159
160 </div>
161 </div>
162 <a class="anchor" id="ac884dafb92a564a501b1cbc01333d248"></a>
163 <div class="memitem">
164 <div class="memproto">
165       <table class="memname">
166         <tr>
167           <td class="memname"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> fetch_marker2bytebigendian </td>
168           <td>(</td>
169           <td class="paramtype"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a>&#160;</td>
170           <td class="paramname"><em>marker</em>, </td>
171         </tr>
172         <tr>
173           <td class="paramkey"></td>
174           <td></td>
175           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
176           <td class="paramname"><em>offset</em>&#160;</td>
177         </tr>
178         <tr>
179           <td></td>
180           <td>)</td>
181           <td></td><td></td>
182         </tr>
183       </table>
184 </div><div class="memdoc">
185
186 <p>fetch marker content 2-byte big endian Byte codes in file stream </p>
187 <dl class="params"><dt>Parameters</dt><dd>
188   <table class="params">
189     <tr><td class="paramdir">[in]</td><td class="paramname">marker</td><td>marker structure </td></tr>
190     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>start Byte position in marker </td></tr>
191   </table>
192   </dd>
193 </dl>
194 <dl class="section return"><dt>Returns</dt><dd>fetched code </dd></dl>
195
196 <p>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>
197
198 <p>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>
199
200 </div>
201 </div>
202 <a class="anchor" id="a6531c0062e0d866e406543e3f63f9c86"></a>
203 <div class="memitem">
204 <div class="memproto">
205       <table class="memname">
206         <tr>
207           <td class="memname"><a class="el" href="byte__manager_8h.html#aad2d957f29839c12c87e4dd945807d36">Byte4_t</a> fetch_marker4bytebigendian </td>
208           <td>(</td>
209           <td class="paramtype"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a>&#160;</td>
210           <td class="paramname"><em>marker</em>, </td>
211         </tr>
212         <tr>
213           <td class="paramkey"></td>
214           <td></td>
215           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
216           <td class="paramname"><em>offset</em>&#160;</td>
217         </tr>
218         <tr>
219           <td></td>
220           <td>)</td>
221           <td></td><td></td>
222         </tr>
223       </table>
224 </div><div class="memdoc">
225
226 <p>fetch marker content 4-byte big endian Byte codes in file stream </p>
227 <dl class="params"><dt>Parameters</dt><dd>
228   <table class="params">
229     <tr><td class="paramdir">[in]</td><td class="paramname">marker</td><td>marker structure </td></tr>
230     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>start Byte position in marker </td></tr>
231   </table>
232   </dd>
233 </dl>
234 <dl class="section return"><dt>Returns</dt><dd>fetched code </dd></dl>
235
236 <p>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>
237
238 <p>Referenced by <a class="el" href="index__manager_8c.html#a4031ccd48358b64a1720c15cf87cc5ff">set_SIZmkrdata()</a>.</p>
239
240 </div>
241 </div>
242 <a class="anchor" id="aeba6604c55d20ce4dafca1c0bd8e1fbc"></a>
243 <div class="memitem">
244 <div class="memproto">
245       <table class="memname">
246         <tr>
247           <td class="memname"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a> set_marker </td>
248           <td>(</td>
249           <td class="paramtype"><a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a>&#160;</td>
250           <td class="paramname"><em>cs</em>, </td>
251         </tr>
252         <tr>
253           <td class="paramkey"></td>
254           <td></td>
255           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a>&#160;</td>
256           <td class="paramname"><em>code</em>, </td>
257         </tr>
258         <tr>
259           <td class="paramkey"></td>
260           <td></td>
261           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
262           <td class="paramname"><em>offset</em>, </td>
263         </tr>
264         <tr>
265           <td class="paramkey"></td>
266           <td></td>
267           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a>&#160;</td>
268           <td class="paramname"><em>length</em>&#160;</td>
269         </tr>
270         <tr>
271           <td></td>
272           <td>)</td>
273           <td></td><td></td>
274         </tr>
275       </table>
276 </div><div class="memdoc">
277
278 <p>set marker parameters from inputs </p>
279 <dl class="params"><dt>Parameters</dt><dd>
280   <table class="params">
281     <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>marker code </td></tr>
282     <tr><td class="paramdir">[in]</td><td class="paramname">code</td><td>marker code </td></tr>
283     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>offset in the codestream </td></tr>
284     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>marker segment length </td></tr>
285   </table>
286   </dd>
287 </dl>
288 <dl class="section return"><dt>Returns</dt><dd>structure of generated marker parameters </dd></dl>
289
290 <p>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>
291
292 <p>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>
293
294 </div>
295 </div>
296 </div><!-- contents -->
297 <!-- start footer part -->
298 <hr class="footer"/><address class="footer"><small>
299 Generated by &#160;<a href="http://www.doxygen.org/index.html">
300 <img class="footer" src="doxygen.png" alt="doxygen"/>
301 </a> 1.8.11
302 </small></address>
303 </body>
304 </html>