Update Doxygen doc
[openjpeg.git] / doxygen / opj__includes_8h.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.10"/>
7 <title>OpenJPEG: opj_includes.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" />
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.2.0</span>
22    </div>
23   </td>
24  </tr>
25  </tbody>
26 </table>
27 </div>
28 <!-- end header part -->
29 <!-- Generated by Doxygen 1.8.10 -->
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_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_68013e83e260d17d49dee5e209315608.html">openjp2</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="#typedef-members">Typedefs</a> &#124;
54 <a href="#func-members">Functions</a>  </div>
55   <div class="headertitle">
56 <div class="title">opj_includes.h File Reference</div>  </div>
57 </div><!--header-->
58 <div class="contents">
59 <div class="textblock"><code>#include &quot;opj_config_private.h&quot;</code><br />
60 <code>#include &lt;memory.h&gt;</code><br />
61 <code>#include &lt;stdlib.h&gt;</code><br />
62 <code>#include &lt;string.h&gt;</code><br />
63 <code>#include &lt;math.h&gt;</code><br />
64 <code>#include &lt;float.h&gt;</code><br />
65 <code>#include &lt;time.h&gt;</code><br />
66 <code>#include &lt;stdio.h&gt;</code><br />
67 <code>#include &lt;stdarg.h&gt;</code><br />
68 <code>#include &lt;ctype.h&gt;</code><br />
69 <code>#include &lt;assert.h&gt;</code><br />
70 <code>#include &lt;limits.h&gt;</code><br />
71 <code>#include &quot;<a class="el" href="openjpeg_8h_source.html">openjpeg.h</a>&quot;</code><br />
72 <code>#include &quot;<a class="el" href="opj__inttypes_8h_source.html">opj_inttypes.h</a>&quot;</code><br />
73 <code>#include &quot;<a class="el" href="opj__clock_8h_source.html">opj_clock.h</a>&quot;</code><br />
74 <code>#include &quot;<a class="el" href="opj__malloc_8h_source.html">opj_malloc.h</a>&quot;</code><br />
75 <code>#include &quot;<a class="el" href="event_8h_source.html">event.h</a>&quot;</code><br />
76 <code>#include &quot;<a class="el" href="function__list_8h_source.html">function_list.h</a>&quot;</code><br />
77 <code>#include &quot;<a class="el" href="bio_8h_source.html">bio.h</a>&quot;</code><br />
78 <code>#include &quot;<a class="el" href="cio_8h_source.html">cio.h</a>&quot;</code><br />
79 <code>#include &quot;<a class="el" href="thread_8h_source.html">thread.h</a>&quot;</code><br />
80 <code>#include &quot;<a class="el" href="tls__keys_8h_source.html">tls_keys.h</a>&quot;</code><br />
81 <code>#include &quot;<a class="el" href="image_8h_source.html">image.h</a>&quot;</code><br />
82 <code>#include &quot;<a class="el" href="invert_8h_source.html">invert.h</a>&quot;</code><br />
83 <code>#include &quot;<a class="el" href="j2k_8h_source.html">j2k.h</a>&quot;</code><br />
84 <code>#include &quot;<a class="el" href="jp2_8h_source.html">jp2.h</a>&quot;</code><br />
85 <code>#include &quot;<a class="el" href="mqc_8h_source.html">mqc.h</a>&quot;</code><br />
86 <code>#include &quot;<a class="el" href="pi_8h_source.html">pi.h</a>&quot;</code><br />
87 <code>#include &quot;<a class="el" href="tgt_8h_source.html">tgt.h</a>&quot;</code><br />
88 <code>#include &quot;<a class="el" href="tcd_8h_source.html">tcd.h</a>&quot;</code><br />
89 <code>#include &quot;<a class="el" href="t1_8h_source.html">t1.h</a>&quot;</code><br />
90 <code>#include &quot;<a class="el" href="dwt_8h_source.html">dwt.h</a>&quot;</code><br />
91 <code>#include &quot;<a class="el" href="t2_8h_source.html">t2.h</a>&quot;</code><br />
92 <code>#include &quot;<a class="el" href="mct_8h_source.html">mct.h</a>&quot;</code><br />
93 <code>#include &quot;<a class="el" href="opj__intmath_8h_source.html">opj_intmath.h</a>&quot;</code><br />
94 <code>#include &quot;openjpwl/jpwl.h&quot;</code><br />
95 <code>#include &quot;<a class="el" href="opj__codec_8h_source.html">opj_codec.h</a>&quot;</code><br />
96 </div>
97 <p><a href="opj__includes_8h_source.html">Go to the source code of this file.</a></p>
98 <table class="memberdecls">
99 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
100 Macros</h2></td></tr>
101 <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>
102 <tr class="separator:a66051c67bcebedb8a341f0cccee37e1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
103 <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>
104 <tr class="separator:a6091261e0ee48b09b58beb5bb38b636a"><td class="memSeparator" colspan="2">&#160;</td></tr>
105 <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>
106 <tr class="separator:af749884570cfedfbcae971535eb31be2"><td class="memSeparator" colspan="2">&#160;</td></tr>
107 <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>
108 <tr class="separator:aa7514d5d53d45bfcca16e66b6b97fddb"><td class="memSeparator" colspan="2">&#160;</td></tr>
109 <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>
110 <tr class="separator:af83cb61a965775033235fb5c043e617f"><td class="memSeparator" colspan="2">&#160;</td></tr>
111 <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>
112 <tr class="separator:a47acbf7ae97e1ef7371a1c92a42505b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
113 <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>
114 <tr class="separator:a8cd74f16e8d8d462ad6f4c7a6103ba40"><td class="memSeparator" colspan="2">&#160;</td></tr>
115 </table><table class="memberdecls">
116 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
117 Typedefs</h2></td></tr>
118 <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>
119 <tr class="separator:ae64d2795e8dbcd9ff6d8e1ebd904ce80"><td class="memSeparator" colspan="2">&#160;</td></tr>
120 </table><table class="memberdecls">
121 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
122 Functions</h2></td></tr>
123 <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>
124 <tr class="separator:aca8ace07bd7ad33de0fe3773dd36c5d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
125 </table>
126 <h2 class="groupheader">Macro Definition Documentation</h2>
127 <a class="anchor" id="a66051c67bcebedb8a341f0cccee37e1b"></a>
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 <p>Referenced by <a class="el" href="openjpeg_8c.html#a12856d08877dbc3558a47a56553a8c8e">opj_get_data_length_from_file()</a>, <a class="el" href="openjpeg_8c.html#a3aab793d4767e2899acba18567bb38fa">opj_seek_from_file()</a>, and <a class="el" href="openjpeg_8c.html#ae8060b5a32b0a58fd0485a04f55de141">opj_skip_from_file()</a>.</p>
158
159 </div>
160 </div>
161 <a class="anchor" id="a6091261e0ee48b09b58beb5bb38b636a"></a>
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 class="anchor" id="af749884570cfedfbcae971535eb31be2"></a>
188 <div class="memitem">
189 <div class="memproto">
190       <table class="memname">
191         <tr>
192           <td class="memname">#define OPJ_FTELL</td>
193           <td>(</td>
194           <td class="paramtype">&#160;</td>
195           <td class="paramname">stream</td><td>)</td>
196           <td>&#160;&#160;&#160;ftell(stream)</td>
197         </tr>
198       </table>
199 </div><div class="memdoc">
200
201 <p>Referenced by <a class="el" href="openjpeg_8c.html#a12856d08877dbc3558a47a56553a8c8e">opj_get_data_length_from_file()</a>.</p>
202
203 </div>
204 </div>
205 <a class="anchor" id="a8cd74f16e8d8d462ad6f4c7a6103ba40"></a>
206 <div class="memitem">
207 <div class="memproto">
208       <table class="memname">
209         <tr>
210           <td class="memname">#define OPJ_NOSANITIZE</td>
211           <td>(</td>
212           <td class="paramtype">&#160;</td>
213           <td class="paramname">kind</td><td>)</td>
214           <td></td>
215         </tr>
216       </table>
217 </div><div class="memdoc">
218
219 </div>
220 </div>
221 <a class="anchor" id="a47acbf7ae97e1ef7371a1c92a42505b2"></a>
222 <div class="memitem">
223 <div class="memproto">
224       <table class="memname">
225         <tr>
226           <td class="memname">#define OPJ_RESTRICT&#160;&#160;&#160;/* restrict */</td>
227         </tr>
228       </table>
229 </div><div class="memdoc">
230
231 <p>Referenced by <a class="el" href="group___d_w_t.html#ga403bd8bf5833ad7b859499006bc94bfc">opj_dwt_decode_real()</a>, <a class="el" href="group___d_w_t.html#ga473550255363b8acb0c9b10a6dbac434">opj_dwt_decode_tile()</a>, <a class="el" href="t1_8c.html#a4f37cf7aca8eb1313fe5bc320c85ad55">opj_t1_clbl_decode_processor()</a>, <a class="el" href="group___t1.html#ga20cf3c3ce3f470e6311e96bf6e365cb0">opj_t1_decode_cblks()</a>, <a class="el" href="group___t1.html#gada55dfa54a9324f948a3383ed95aedc5">opj_t1_encode_cblks()</a>, <a class="el" href="group___d_w_t.html#ga8894826af3ccbb0ca37f78750eb4e891">opj_v4dwt_decode_step1()</a>, <a class="el" href="group___d_w_t.html#ga094fd3d3e5a1a1f8b00c5340872f037e">opj_v4dwt_interleave_h()</a>, and <a class="el" href="group___d_w_t.html#gafd9564a93feba5c3a554ee00b2332ef8">opj_v4dwt_interleave_v()</a>.</p>
232
233 </div>
234 </div>
235 <a class="anchor" id="af83cb61a965775033235fb5c043e617f"></a>
236 <div class="memitem">
237 <div class="memproto">
238       <table class="memname">
239         <tr>
240           <td class="memname">#define OPJ_STAT</td>
241           <td>(</td>
242           <td class="paramtype">&#160;</td>
243           <td class="paramname">path, </td>
244         </tr>
245         <tr>
246           <td class="paramkey"></td>
247           <td></td>
248           <td class="paramtype">&#160;</td>
249           <td class="paramname">stat_buff&#160;</td>
250         </tr>
251         <tr>
252           <td></td>
253           <td>)</td>
254           <td></td><td>&#160;&#160;&#160;stat(path,stat_buff)</td>
255         </tr>
256       </table>
257 </div><div class="memdoc">
258
259 </div>
260 </div>
261 <a class="anchor" id="aa7514d5d53d45bfcca16e66b6b97fddb"></a>
262 <div class="memitem">
263 <div class="memproto">
264       <table class="memname">
265         <tr>
266           <td class="memname">#define OPJ_STAT_STRUCT_T&#160;&#160;&#160;struct stat</td>
267         </tr>
268       </table>
269 </div><div class="memdoc">
270
271 </div>
272 </div>
273 <h2 class="groupheader">Typedef Documentation</h2>
274 <a class="anchor" id="ae64d2795e8dbcd9ff6d8e1ebd904ce80"></a>
275 <div class="memitem">
276 <div class="memproto">
277       <table class="memname">
278         <tr>
279           <td class="memname">typedef unsigned int <a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a></td>
280         </tr>
281       </table>
282 </div><div class="memdoc">
283
284 </div>
285 </div>
286 <h2 class="groupheader">Function Documentation</h2>
287 <a class="anchor" id="aca8ace07bd7ad33de0fe3773dd36c5d3"></a>
288 <div class="memitem">
289 <div class="memproto">
290 <table class="mlabels">
291   <tr>
292   <td class="mlabels-left">
293       <table class="memname">
294         <tr>
295           <td class="memname">static <a class="el" href="openjpeg_8h.html#a2eb6f9e0395b47b8d5e3eeae4fe0c116">INLINE</a> long opj_lrintf </td>
296           <td>(</td>
297           <td class="paramtype">float&#160;</td>
298           <td class="paramname"><em>f</em></td><td>)</td>
299           <td></td>
300         </tr>
301       </table>
302   </td>
303   <td class="mlabels-right">
304 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
305   </tr>
306 </table>
307 </div><div class="memdoc">
308
309 <p>Referenced by <a class="el" href="tcd_8c.html#a9dc572b0982c7d7db4f3c53d8ccfdce6">opj_tcd_dc_level_shift_decode()</a>.</p>
310
311 </div>
312 </div>
313 </div><!-- contents -->
314 <!-- start footer part -->
315 <hr class="footer"/><address class="footer"><small>
316 Generated by &#160;<a href="http://www.doxygen.org/index.html">
317 <img class="footer" src="doxygen.png" alt="doxygen"/>
318 </a> 1.8.10
319 </small></address>
320 </body>
321 </html>