2.5.2 post: fix full changelog
[openjpeg.git] / doxygen / opj__includes_8h.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: opj_includes.h 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.5.0</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.17 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35 $(function() {
36   initMenu('',false,false,'search.php','Search');
37 });
38 /* @license-end */</script>
39 <div id="main-nav"></div>
40 <div id="nav-path" class="navpath">
41   <ul>
42 <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_54e5bc4f0640fea590afaf04f4d9c88d.html">openjp2</a></li>  </ul>
43 </div>
44 </div><!-- top -->
45 <div class="header">
46   <div class="summary">
47 <a href="#define-members">Macros</a> &#124;
48 <a href="#typedef-members">Typedefs</a> &#124;
49 <a href="#func-members">Functions</a>  </div>
50   <div class="headertitle">
51 <div class="title">opj_includes.h File Reference</div>  </div>
52 </div><!--header-->
53 <div class="contents">
54 <div class="textblock"><code>#include &quot;opj_config_private.h&quot;</code><br />
55 <code>#include &lt;memory.h&gt;</code><br />
56 <code>#include &lt;stdlib.h&gt;</code><br />
57 <code>#include &lt;string.h&gt;</code><br />
58 <code>#include &lt;math.h&gt;</code><br />
59 <code>#include &lt;float.h&gt;</code><br />
60 <code>#include &lt;time.h&gt;</code><br />
61 <code>#include &lt;stdio.h&gt;</code><br />
62 <code>#include &lt;stdarg.h&gt;</code><br />
63 <code>#include &lt;ctype.h&gt;</code><br />
64 <code>#include &lt;assert.h&gt;</code><br />
65 <code>#include &lt;limits.h&gt;</code><br />
66 <code>#include &quot;<a class="el" href="openjpeg_8h_source.html">openjpeg.h</a>&quot;</code><br />
67 <code>#include &quot;<a class="el" href="opj__inttypes_8h_source.html">opj_inttypes.h</a>&quot;</code><br />
68 <code>#include &quot;<a class="el" href="opj__clock_8h_source.html">opj_clock.h</a>&quot;</code><br />
69 <code>#include &quot;<a class="el" href="opj__malloc_8h_source.html">opj_malloc.h</a>&quot;</code><br />
70 <code>#include &quot;<a class="el" href="event_8h_source.html">event.h</a>&quot;</code><br />
71 <code>#include &quot;<a class="el" href="function__list_8h_source.html">function_list.h</a>&quot;</code><br />
72 <code>#include &quot;<a class="el" href="bio_8h_source.html">bio.h</a>&quot;</code><br />
73 <code>#include &quot;<a class="el" href="cio_8h_source.html">cio.h</a>&quot;</code><br />
74 <code>#include &quot;<a class="el" href="thread_8h_source.html">thread.h</a>&quot;</code><br />
75 <code>#include &quot;<a class="el" href="tls__keys_8h_source.html">tls_keys.h</a>&quot;</code><br />
76 <code>#include &quot;<a class="el" href="image_8h_source.html">image.h</a>&quot;</code><br />
77 <code>#include &quot;<a class="el" href="invert_8h_source.html">invert.h</a>&quot;</code><br />
78 <code>#include &quot;<a class="el" href="j2k_8h_source.html">j2k.h</a>&quot;</code><br />
79 <code>#include &quot;<a class="el" href="jp2_8h_source.html">jp2.h</a>&quot;</code><br />
80 <code>#include &quot;<a class="el" href="mqc_8h_source.html">mqc.h</a>&quot;</code><br />
81 <code>#include &quot;<a class="el" href="pi_8h_source.html">pi.h</a>&quot;</code><br />
82 <code>#include &quot;<a class="el" href="tgt_8h_source.html">tgt.h</a>&quot;</code><br />
83 <code>#include &quot;<a class="el" href="tcd_8h_source.html">tcd.h</a>&quot;</code><br />
84 <code>#include &quot;<a class="el" href="t1_8h_source.html">t1.h</a>&quot;</code><br />
85 <code>#include &quot;<a class="el" href="dwt_8h_source.html">dwt.h</a>&quot;</code><br />
86 <code>#include &quot;<a class="el" href="t2_8h_source.html">t2.h</a>&quot;</code><br />
87 <code>#include &quot;<a class="el" href="mct_8h_source.html">mct.h</a>&quot;</code><br />
88 <code>#include &quot;<a class="el" href="opj__intmath_8h_source.html">opj_intmath.h</a>&quot;</code><br />
89 <code>#include &quot;<a class="el" href="sparse__array_8h_source.html">sparse_array.h</a>&quot;</code><br />
90 <code>#include &quot;openjpwl/jpwl.h&quot;</code><br />
91 <code>#include &quot;<a class="el" href="opj__codec_8h_source.html">opj_codec.h</a>&quot;</code><br />
92 </div>
93 <p><a href="opj__includes_8h_source.html">Go to the source code of this file.</a></p>
94 <table class="memberdecls">
95 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
96 Macros</h2></td></tr>
97 <tr class="memitem:a66051c67bcebedb8a341f0cccee37e1b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="opj__includes_8h.html#a66051c67bcebedb8a341f0cccee37e1b">OPJ_FSEEK</a>(stream,  offset,  whence)&#160;&#160;&#160;fseek(stream,offset,whence)</td></tr>
98 <tr class="separator:a66051c67bcebedb8a341f0cccee37e1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
99 <tr class="memitem:a6091261e0ee48b09b58beb5bb38b636a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="opj__includes_8h.html#a6091261e0ee48b09b58beb5bb38b636a">OPJ_FSTAT</a>(fildes,  stat_buff)&#160;&#160;&#160;fstat(fildes,stat_buff)</td></tr>
100 <tr class="separator:a6091261e0ee48b09b58beb5bb38b636a"><td class="memSeparator" colspan="2">&#160;</td></tr>
101 <tr class="memitem:af749884570cfedfbcae971535eb31be2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="opj__includes_8h.html#af749884570cfedfbcae971535eb31be2">OPJ_FTELL</a>(stream)&#160;&#160;&#160;ftell(stream)</td></tr>
102 <tr class="separator:af749884570cfedfbcae971535eb31be2"><td class="memSeparator" colspan="2">&#160;</td></tr>
103 <tr class="memitem:aa7514d5d53d45bfcca16e66b6b97fddb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="opj__includes_8h.html#aa7514d5d53d45bfcca16e66b6b97fddb">OPJ_STAT_STRUCT_T</a>&#160;&#160;&#160;struct stat</td></tr>
104 <tr class="separator:aa7514d5d53d45bfcca16e66b6b97fddb"><td class="memSeparator" colspan="2">&#160;</td></tr>
105 <tr class="memitem:af83cb61a965775033235fb5c043e617f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="opj__includes_8h.html#af83cb61a965775033235fb5c043e617f">OPJ_STAT</a>(path,  stat_buff)&#160;&#160;&#160;stat(path,stat_buff)</td></tr>
106 <tr class="separator:af83cb61a965775033235fb5c043e617f"><td class="memSeparator" colspan="2">&#160;</td></tr>
107 <tr class="memitem:a47acbf7ae97e1ef7371a1c92a42505b2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="opj__includes_8h.html#a47acbf7ae97e1ef7371a1c92a42505b2">OPJ_RESTRICT</a>&#160;&#160;&#160;/* restrict */</td></tr>
108 <tr class="separator:a47acbf7ae97e1ef7371a1c92a42505b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
109 <tr class="memitem:a8cd74f16e8d8d462ad6f4c7a6103ba40"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="opj__includes_8h.html#a8cd74f16e8d8d462ad6f4c7a6103ba40">OPJ_NOSANITIZE</a>(kind)</td></tr>
110 <tr class="separator:a8cd74f16e8d8d462ad6f4c7a6103ba40"><td class="memSeparator" colspan="2">&#160;</td></tr>
111 <tr class="memitem:a2af533efd81cc83803126d5b03fe4470"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="opj__includes_8h.html#a2af533efd81cc83803126d5b03fe4470">OPJ_UNUSED</a>(x)&#160;&#160;&#160;(void)x</td></tr>
112 <tr class="separator:a2af533efd81cc83803126d5b03fe4470"><td class="memSeparator" colspan="2">&#160;</td></tr>
113 </table><table class="memberdecls">
114 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
115 Typedefs</h2></td></tr>
116 <tr class="memitem:ae64d2795e8dbcd9ff6d8e1ebd904ce80"><td class="memItemLeft" align="right" valign="top">typedef unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a></td></tr>
117 <tr class="separator:ae64d2795e8dbcd9ff6d8e1ebd904ce80"><td class="memSeparator" colspan="2">&#160;</td></tr>
118 </table><table class="memberdecls">
119 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
120 Functions</h2></td></tr>
121 <tr class="memitem:aca8ace07bd7ad33de0fe3773dd36c5d3"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="openjpeg_8h.html#a2eb6f9e0395b47b8d5e3eeae4fe0c116">INLINE</a> long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="opj__includes_8h.html#aca8ace07bd7ad33de0fe3773dd36c5d3">opj_lrintf</a> (float f)</td></tr>
122 <tr class="separator:aca8ace07bd7ad33de0fe3773dd36c5d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
123 </table>
124 <h2 class="groupheader">Macro Definition Documentation</h2>
125 <a id="a66051c67bcebedb8a341f0cccee37e1b"></a>
126 <h2 class="memtitle"><span class="permalink"><a href="#a66051c67bcebedb8a341f0cccee37e1b">&#9670;&nbsp;</a></span>OPJ_FSEEK</h2>
127
128 <div class="memitem">
129 <div class="memproto">
130       <table class="memname">
131         <tr>
132           <td class="memname">#define OPJ_FSEEK</td>
133           <td>(</td>
134           <td class="paramtype">&#160;</td>
135           <td class="paramname">stream, </td>
136         </tr>
137         <tr>
138           <td class="paramkey"></td>
139           <td></td>
140           <td class="paramtype">&#160;</td>
141           <td class="paramname">offset, </td>
142         </tr>
143         <tr>
144           <td class="paramkey"></td>
145           <td></td>
146           <td class="paramtype">&#160;</td>
147           <td class="paramname">whence&#160;</td>
148         </tr>
149         <tr>
150           <td></td>
151           <td>)</td>
152           <td></td><td>&#160;&#160;&#160;fseek(stream,offset,whence)</td>
153         </tr>
154       </table>
155 </div><div class="memdoc">
156
157 </div>
158 </div>
159 <a id="a6091261e0ee48b09b58beb5bb38b636a"></a>
160 <h2 class="memtitle"><span class="permalink"><a href="#a6091261e0ee48b09b58beb5bb38b636a">&#9670;&nbsp;</a></span>OPJ_FSTAT</h2>
161
162 <div class="memitem">
163 <div class="memproto">
164       <table class="memname">
165         <tr>
166           <td class="memname">#define OPJ_FSTAT</td>
167           <td>(</td>
168           <td class="paramtype">&#160;</td>
169           <td class="paramname">fildes, </td>
170         </tr>
171         <tr>
172           <td class="paramkey"></td>
173           <td></td>
174           <td class="paramtype">&#160;</td>
175           <td class="paramname">stat_buff&#160;</td>
176         </tr>
177         <tr>
178           <td></td>
179           <td>)</td>
180           <td></td><td>&#160;&#160;&#160;fstat(fildes,stat_buff)</td>
181         </tr>
182       </table>
183 </div><div class="memdoc">
184
185 </div>
186 </div>
187 <a id="af749884570cfedfbcae971535eb31be2"></a>
188 <h2 class="memtitle"><span class="permalink"><a href="#af749884570cfedfbcae971535eb31be2">&#9670;&nbsp;</a></span>OPJ_FTELL</h2>
189
190 <div class="memitem">
191 <div class="memproto">
192       <table class="memname">
193         <tr>
194           <td class="memname">#define OPJ_FTELL</td>
195           <td>(</td>
196           <td class="paramtype">&#160;</td>
197           <td class="paramname">stream</td><td>)</td>
198           <td>&#160;&#160;&#160;ftell(stream)</td>
199         </tr>
200       </table>
201 </div><div class="memdoc">
202
203 </div>
204 </div>
205 <a id="a8cd74f16e8d8d462ad6f4c7a6103ba40"></a>
206 <h2 class="memtitle"><span class="permalink"><a href="#a8cd74f16e8d8d462ad6f4c7a6103ba40">&#9670;&nbsp;</a></span>OPJ_NOSANITIZE</h2>
207
208 <div class="memitem">
209 <div class="memproto">
210       <table class="memname">
211         <tr>
212           <td class="memname">#define OPJ_NOSANITIZE</td>
213           <td>(</td>
214           <td class="paramtype">&#160;</td>
215           <td class="paramname">kind</td><td>)</td>
216           <td></td>
217         </tr>
218       </table>
219 </div><div class="memdoc">
220
221 </div>
222 </div>
223 <a id="a47acbf7ae97e1ef7371a1c92a42505b2"></a>
224 <h2 class="memtitle"><span class="permalink"><a href="#a47acbf7ae97e1ef7371a1c92a42505b2">&#9670;&nbsp;</a></span>OPJ_RESTRICT</h2>
225
226 <div class="memitem">
227 <div class="memproto">
228       <table class="memname">
229         <tr>
230           <td class="memname">#define OPJ_RESTRICT&#160;&#160;&#160;/* restrict */</td>
231         </tr>
232       </table>
233 </div><div class="memdoc">
234
235 </div>
236 </div>
237 <a id="af83cb61a965775033235fb5c043e617f"></a>
238 <h2 class="memtitle"><span class="permalink"><a href="#af83cb61a965775033235fb5c043e617f">&#9670;&nbsp;</a></span>OPJ_STAT</h2>
239
240 <div class="memitem">
241 <div class="memproto">
242       <table class="memname">
243         <tr>
244           <td class="memname">#define OPJ_STAT</td>
245           <td>(</td>
246           <td class="paramtype">&#160;</td>
247           <td class="paramname">path, </td>
248         </tr>
249         <tr>
250           <td class="paramkey"></td>
251           <td></td>
252           <td class="paramtype">&#160;</td>
253           <td class="paramname">stat_buff&#160;</td>
254         </tr>
255         <tr>
256           <td></td>
257           <td>)</td>
258           <td></td><td>&#160;&#160;&#160;stat(path,stat_buff)</td>
259         </tr>
260       </table>
261 </div><div class="memdoc">
262
263 </div>
264 </div>
265 <a id="aa7514d5d53d45bfcca16e66b6b97fddb"></a>
266 <h2 class="memtitle"><span class="permalink"><a href="#aa7514d5d53d45bfcca16e66b6b97fddb">&#9670;&nbsp;</a></span>OPJ_STAT_STRUCT_T</h2>
267
268 <div class="memitem">
269 <div class="memproto">
270       <table class="memname">
271         <tr>
272           <td class="memname">#define OPJ_STAT_STRUCT_T&#160;&#160;&#160;struct stat</td>
273         </tr>
274       </table>
275 </div><div class="memdoc">
276
277 </div>
278 </div>
279 <a id="a2af533efd81cc83803126d5b03fe4470"></a>
280 <h2 class="memtitle"><span class="permalink"><a href="#a2af533efd81cc83803126d5b03fe4470">&#9670;&nbsp;</a></span>OPJ_UNUSED</h2>
281
282 <div class="memitem">
283 <div class="memproto">
284       <table class="memname">
285         <tr>
286           <td class="memname">#define OPJ_UNUSED</td>
287           <td>(</td>
288           <td class="paramtype">&#160;</td>
289           <td class="paramname">x</td><td>)</td>
290           <td>&#160;&#160;&#160;(void)x</td>
291         </tr>
292       </table>
293 </div><div class="memdoc">
294
295 </div>
296 </div>
297 <h2 class="groupheader">Typedef Documentation</h2>
298 <a id="ae64d2795e8dbcd9ff6d8e1ebd904ce80"></a>
299 <h2 class="memtitle"><span class="permalink"><a href="#ae64d2795e8dbcd9ff6d8e1ebd904ce80">&#9670;&nbsp;</a></span>OPJ_BITFIELD</h2>
300
301 <div class="memitem">
302 <div class="memproto">
303       <table class="memname">
304         <tr>
305           <td class="memname">typedef unsigned int <a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a></td>
306         </tr>
307       </table>
308 </div><div class="memdoc">
309
310 </div>
311 </div>
312 <h2 class="groupheader">Function Documentation</h2>
313 <a id="aca8ace07bd7ad33de0fe3773dd36c5d3"></a>
314 <h2 class="memtitle"><span class="permalink"><a href="#aca8ace07bd7ad33de0fe3773dd36c5d3">&#9670;&nbsp;</a></span>opj_lrintf()</h2>
315
316 <div class="memitem">
317 <div class="memproto">
318 <table class="mlabels">
319   <tr>
320   <td class="mlabels-left">
321       <table class="memname">
322         <tr>
323           <td class="memname">static <a class="el" href="openjpeg_8h.html#a2eb6f9e0395b47b8d5e3eeae4fe0c116">INLINE</a> long opj_lrintf </td>
324           <td>(</td>
325           <td class="paramtype">float&#160;</td>
326           <td class="paramname"><em>f</em></td><td>)</td>
327           <td></td>
328         </tr>
329       </table>
330   </td>
331   <td class="mlabels-right">
332 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
333   </tr>
334 </table>
335 </div><div class="memdoc">
336
337 <p class="reference">Referenced by <a class="el" href="t1_8c.html#a3a260db0855d38ed19c060139365b1ad">opj_t1_cblk_encode_processor()</a>, and <a class="el" href="tcd_8c.html#a9dc572b0982c7d7db4f3c53d8ccfdce6">opj_tcd_dc_level_shift_decode()</a>.</p>
338
339 </div>
340 </div>
341 </div><!-- contents -->
342 <!-- start footer part -->
343 <hr class="footer"/><address class="footer"><small>
344 Generated by &#160;<a href="http://www.doxygen.org/index.html">
345 <img class="footer" src="doxygen.png" alt="doxygen"/>
346 </a> 1.8.17
347 </small></address>
348 </body>
349 </html>