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: VAL - validation procedure</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><a href="files.html"><span>Files</span></a></li>
42 <a href="#nested-classes">Data Structures</a> |
43 <a href="#typedef-members">Typedefs</a> |
44 <a href="#func-members">Functions</a> </div>
45 <div class="headertitle">
46 <div class="title">VAL - validation procedure</div> </div>
48 <div class="contents">
49 <table class="memberdecls">
50 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
51 Data Structures</h2></td></tr>
52 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__procedure__list.html">opj_procedure_list</a></td></tr>
53 <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A list of procedures. <a href="structopj__procedure__list.html#details">More...</a><br /></td></tr>
54 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
55 </table><table class="memberdecls">
56 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
57 Typedefs</h2></td></tr>
58 <tr class="memitem:gad3262b137c34187dce496329b8a637b9"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___v_a_l.html#gad3262b137c34187dce496329b8a637b9">opj_procedure</a>) (void)</td></tr>
59 <tr class="memdesc:gad3262b137c34187dce496329b8a637b9"><td class="mdescLeft"> </td><td class="mdescRight">declare a function pointer <a href="#gad3262b137c34187dce496329b8a637b9">More...</a><br /></td></tr>
60 <tr class="separator:gad3262b137c34187dce496329b8a637b9"><td class="memSeparator" colspan="2"> </td></tr>
61 <tr class="memitem:ga641b452ff3c3c8b7ba21cf4db6016cbd"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structopj__procedure__list.html">opj_procedure_list</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a></td></tr>
62 <tr class="memdesc:ga641b452ff3c3c8b7ba21cf4db6016cbd"><td class="mdescLeft"> </td><td class="mdescRight">A list of procedures. <a href="#ga641b452ff3c3c8b7ba21cf4db6016cbd">More...</a><br /></td></tr>
63 <tr class="separator:ga641b452ff3c3c8b7ba21cf4db6016cbd"><td class="memSeparator" colspan="2"> </td></tr>
64 </table><table class="memberdecls">
65 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
66 Functions</h2></td></tr>
67 <tr class="memitem:ga5058f9c3fdf2ff44f72c315e571cd153"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___v_a_l.html#ga5058f9c3fdf2ff44f72c315e571cd153">opj_procedure_list_create</a> (void)</td></tr>
68 <tr class="memdesc:ga5058f9c3fdf2ff44f72c315e571cd153"><td class="mdescLeft"> </td><td class="mdescRight">Creates a validation list. <a href="#ga5058f9c3fdf2ff44f72c315e571cd153">More...</a><br /></td></tr>
69 <tr class="separator:ga5058f9c3fdf2ff44f72c315e571cd153"><td class="memSeparator" colspan="2"> </td></tr>
70 <tr class="memitem:gae39a4783cf450cc32e8d7bea251a6f90"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___v_a_l.html#gae39a4783cf450cc32e8d7bea251a6f90">opj_procedure_list_destroy</a> (<a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a> *p_list)</td></tr>
71 <tr class="memdesc:gae39a4783cf450cc32e8d7bea251a6f90"><td class="mdescLeft"> </td><td class="mdescRight">Destroys a validation list. <a href="#gae39a4783cf450cc32e8d7bea251a6f90">More...</a><br /></td></tr>
72 <tr class="separator:gae39a4783cf450cc32e8d7bea251a6f90"><td class="memSeparator" colspan="2"> </td></tr>
73 <tr class="memitem:ga504334e4d2e64b16372e70f6c7a9d3e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___v_a_l.html#ga504334e4d2e64b16372e70f6c7a9d3e2">opj_procedure_list_add_procedure</a> (<a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a> *p_validation_list, <a class="el" href="group___v_a_l.html#gad3262b137c34187dce496329b8a637b9">opj_procedure</a> p_procedure, <a class="el" href="event_8h.html#a4cba85f9ee037b1f2c6bceb903051d96">opj_event_mgr_t</a> *p_manager)</td></tr>
74 <tr class="memdesc:ga504334e4d2e64b16372e70f6c7a9d3e2"><td class="mdescLeft"> </td><td class="mdescRight">Adds a new validation procedure. <a href="#ga504334e4d2e64b16372e70f6c7a9d3e2">More...</a><br /></td></tr>
75 <tr class="separator:ga504334e4d2e64b16372e70f6c7a9d3e2"><td class="memSeparator" colspan="2"> </td></tr>
76 <tr class="memitem:ga24cf23916e23907db588b420f870dbf4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___v_a_l.html#ga24cf23916e23907db588b420f870dbf4">opj_procedure_list_get_nb_procedures</a> (<a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a> *p_validation_list)</td></tr>
77 <tr class="memdesc:ga24cf23916e23907db588b420f870dbf4"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of validation procedures. <a href="#ga24cf23916e23907db588b420f870dbf4">More...</a><br /></td></tr>
78 <tr class="separator:ga24cf23916e23907db588b420f870dbf4"><td class="memSeparator" colspan="2"> </td></tr>
79 <tr class="memitem:ga0fbe67e6c1863704ac826cd33de8f91b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___v_a_l.html#gad3262b137c34187dce496329b8a637b9">opj_procedure</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___v_a_l.html#ga0fbe67e6c1863704ac826cd33de8f91b">opj_procedure_list_get_first_procedure</a> (<a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a> *p_validation_list)</td></tr>
80 <tr class="memdesc:ga0fbe67e6c1863704ac826cd33de8f91b"><td class="mdescLeft"> </td><td class="mdescRight">Gets the pointer on the first validation procedure. <a href="#ga0fbe67e6c1863704ac826cd33de8f91b">More...</a><br /></td></tr>
81 <tr class="separator:ga0fbe67e6c1863704ac826cd33de8f91b"><td class="memSeparator" colspan="2"> </td></tr>
82 <tr class="memitem:ga9db9849fff78faa60392827aabf7e529"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___v_a_l.html#ga9db9849fff78faa60392827aabf7e529">opj_procedure_list_clear</a> (<a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a> *p_validation_list)</td></tr>
83 <tr class="memdesc:ga9db9849fff78faa60392827aabf7e529"><td class="mdescLeft"> </td><td class="mdescRight">Clears the list of validation procedures. <a href="#ga9db9849fff78faa60392827aabf7e529">More...</a><br /></td></tr>
84 <tr class="separator:ga9db9849fff78faa60392827aabf7e529"><td class="memSeparator" colspan="2"> </td></tr>
86 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
87 <h2 class="groupheader">Typedef Documentation</h2>
88 <a class="anchor" id="gad3262b137c34187dce496329b8a637b9"></a>
90 <div class="memproto">
91 <table class="memname">
93 <td class="memname">typedef void(* opj_procedure) (void)</td>
96 </div><div class="memdoc">
98 <p>declare a function pointer </p>
102 <a class="anchor" id="ga641b452ff3c3c8b7ba21cf4db6016cbd"></a>
103 <div class="memitem">
104 <div class="memproto">
105 <table class="memname">
107 <td class="memname">typedef struct <a class="el" href="structopj__procedure__list.html">opj_procedure_list</a> <a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a></td>
110 </div><div class="memdoc">
112 <p>A list of procedures. </p>
116 <h2 class="groupheader">Function Documentation</h2>
117 <a class="anchor" id="ga504334e4d2e64b16372e70f6c7a9d3e2"></a>
118 <div class="memitem">
119 <div class="memproto">
120 <table class="memname">
122 <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_procedure_list_add_procedure </td>
124 <td class="paramtype"><a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a> * </td>
125 <td class="paramname"><em>p_validation_list</em>, </td>
128 <td class="paramkey"></td>
130 <td class="paramtype"><a class="el" href="group___v_a_l.html#gad3262b137c34187dce496329b8a637b9">opj_procedure</a> </td>
131 <td class="paramname"><em>p_procedure</em>, </td>
134 <td class="paramkey"></td>
136 <td class="paramtype"><a class="el" href="event_8h.html#a4cba85f9ee037b1f2c6bceb903051d96">opj_event_mgr_t</a> * </td>
137 <td class="paramname"><em>p_manager</em> </td>
145 </div><div class="memdoc">
147 <p>Adds a new validation procedure. </p>
148 <dl class="params"><dt>Parameters</dt><dd>
149 <table class="params">
150 <tr><td class="paramname">p_validation_list</td><td>the list of procedure to modify. </td></tr>
151 <tr><td class="paramname">p_procedure</td><td>the procedure to add. </td></tr>
152 <tr><td class="paramname">p_manager</td><td>the user event manager.</td></tr>
156 <dl class="section return"><dt>Returns</dt><dd>OPJ_TRUE if the procedure could be added. </dd></dl>
158 <p>References <a class="el" href="event_8h.html#a7323671f4df0a721ae02d610b1269ab9">EVT_ERROR</a>, <a class="el" href="structopj__procedure__list.html#ac64b1b06188f14c9f6f0b5136c200ad0">opj_procedure_list::m_nb_max_procedures</a>, <a class="el" href="structopj__procedure__list.html#af7aae9f4ec9402a74049bbc439019742">opj_procedure_list::m_nb_procedures</a>, <a class="el" href="structopj__procedure__list.html#a289f86770cadb567af4ccf3156fca8c7">opj_procedure_list::m_procedures</a>, <a class="el" href="group___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">opj_event_msg()</a>, <a class="el" href="openjpeg_8h.html#ac672bfd7db39c609e828acb07a321964">OPJ_FALSE</a>, <a class="el" href="group___m_i_s_c.html#ga2bd00e2482ae36197631bde0665cfdfe">opj_free()</a>, <a class="el" href="group___m_i_s_c.html#ga95862b2a456efdc436c61beba816fb25">opj_realloc()</a>, <a class="el" href="openjpeg_8h.html#a04830036d767cba56cbf5ae5bdc481d3">OPJ_TRUE</a>, and <a class="el" href="function__list_8c.html#a8d474095158ba1ed5c673c66c60bd607">OPJ_VALIDATION_SIZE</a>.</p>
160 <p>Referenced by <a class="el" href="j2k_8c.html#a96d53f4d6a1eff377827a88db47fe554">opj_j2k_setup_decoding()</a>, <a class="el" href="j2k_8c.html#aa132529cb242ca5e64f431f66e5cf3c2">opj_j2k_setup_decoding_tile()</a>, <a class="el" href="group___j2_k.html#ga7fa2dd1eb76428e165f90c94b3d3182c">opj_j2k_setup_decoding_validation()</a>, <a class="el" href="group___j2_k.html#ga1cfd2341c822135243d49632743a09af">opj_j2k_setup_encoding_validation()</a>, <a class="el" href="group___j2_k.html#ga6a868f1202d4d185f6853c472e2a8688">opj_j2k_setup_end_compress()</a>, <a class="el" href="group___j2_k.html#gaa672a0ce8dc41d6cdfb2b803e051a21c">opj_j2k_setup_header_reading()</a>, <a class="el" href="group___j2_k.html#gab714ef6da730a44656754a9280ff8b8b">opj_j2k_setup_header_writing()</a>, <a class="el" href="jp2_8c.html#a2eb08d51a6a71a825fa047a6c5aca441">opj_jp2_setup_encoding_validation()</a>, <a class="el" href="jp2_8c.html#a9adcd86e8c4369aff8e0378b1aaf8ef4">opj_jp2_setup_end_header_reading()</a>, <a class="el" href="jp2_8c.html#a45d924fc300f75d460c35170a18e1ae1">opj_jp2_setup_end_header_writing()</a>, <a class="el" href="jp2_8c.html#aa2c50479d75d27a2c08c89be866fcfa5">opj_jp2_setup_header_reading()</a>, and <a class="el" href="jp2_8c.html#acde1c55531d9a33bf7512f70ebeaeb0e">opj_jp2_setup_header_writing()</a>.</p>
164 <a class="anchor" id="ga9db9849fff78faa60392827aabf7e529"></a>
165 <div class="memitem">
166 <div class="memproto">
167 <table class="memname">
169 <td class="memname">void opj_procedure_list_clear </td>
171 <td class="paramtype"><a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a> * </td>
172 <td class="paramname"><em>p_validation_list</em></td><td>)</td>
176 </div><div class="memdoc">
178 <p>Clears the list of validation procedures. </p>
179 <dl class="params"><dt>Parameters</dt><dd>
180 <table class="params">
181 <tr><td class="paramname">p_validation_list</td><td>the list of procedure to clear. </td></tr>
186 <p>References <a class="el" href="structopj__procedure__list.html#af7aae9f4ec9402a74049bbc439019742">opj_procedure_list::m_nb_procedures</a>.</p>
188 <p>Referenced by <a class="el" href="group___j2_k.html#gada850e315ec35b2c29bb75e97b07ab2b">opj_j2k_exec()</a>, and <a class="el" href="jp2_8c.html#a5c8d5befcd92f556b160b2bdcddaf801">opj_jp2_exec()</a>.</p>
192 <a class="anchor" id="ga5058f9c3fdf2ff44f72c315e571cd153"></a>
193 <div class="memitem">
194 <div class="memproto">
195 <table class="memname">
197 <td class="memname"><a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a>* opj_procedure_list_create </td>
199 <td class="paramtype">void </td>
200 <td class="paramname"></td><td>)</td>
204 </div><div class="memdoc">
206 <p>Creates a validation list. </p>
207 <dl class="section return"><dt>Returns</dt><dd>the newly created validation list. </dd></dl>
209 <p>References <a class="el" href="structopj__procedure__list.html#ac64b1b06188f14c9f6f0b5136c200ad0">opj_procedure_list::m_nb_max_procedures</a>, <a class="el" href="structopj__procedure__list.html#a289f86770cadb567af4ccf3156fca8c7">opj_procedure_list::m_procedures</a>, <a class="el" href="group___m_i_s_c.html#ga7fe6dfcb0a623dbec30daf0f48624bf7">opj_calloc()</a>, <a class="el" href="group___m_i_s_c.html#ga2bd00e2482ae36197631bde0665cfdfe">opj_free()</a>, and <a class="el" href="function__list_8c.html#a8d474095158ba1ed5c673c66c60bd607">OPJ_VALIDATION_SIZE</a>.</p>
211 <p>Referenced by <a class="el" href="group___j2_k.html#gad3c2b25f4d5a5f6fd4b442bc7210f6da">opj_j2k_create_compress()</a>, <a class="el" href="j2k_8h.html#ad76bb79d4d63030222ebf3dbe3fe86cf">opj_j2k_create_decompress()</a>, and <a class="el" href="group___j_p2.html#ga7d5389b7ba1706b96ec2adeb431a4735">opj_jp2_create()</a>.</p>
215 <a class="anchor" id="gae39a4783cf450cc32e8d7bea251a6f90"></a>
216 <div class="memitem">
217 <div class="memproto">
218 <table class="memname">
220 <td class="memname">void opj_procedure_list_destroy </td>
222 <td class="paramtype"><a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a> * </td>
223 <td class="paramname"><em>p_list</em></td><td>)</td>
227 </div><div class="memdoc">
229 <p>Destroys a validation list. </p>
230 <dl class="params"><dt>Parameters</dt><dd>
231 <table class="params">
232 <tr><td class="paramname">p_list</td><td>the list to destroy. </td></tr>
237 <p>References <a class="el" href="structopj__procedure__list.html#a289f86770cadb567af4ccf3156fca8c7">opj_procedure_list::m_procedures</a>, and <a class="el" href="group___m_i_s_c.html#ga2bd00e2482ae36197631bde0665cfdfe">opj_free()</a>.</p>
239 <p>Referenced by <a class="el" href="j2k_8h.html#a5c4508543b134e726107308b6463528e">opj_j2k_destroy()</a>, and <a class="el" href="group___j_p2.html#ga1f7f8e8462c3bf6fdf6c3d4d75b8b3b7">opj_jp2_destroy()</a>.</p>
243 <a class="anchor" id="ga0fbe67e6c1863704ac826cd33de8f91b"></a>
244 <div class="memitem">
245 <div class="memproto">
246 <table class="memname">
248 <td class="memname"><a class="el" href="group___v_a_l.html#gad3262b137c34187dce496329b8a637b9">opj_procedure</a>* opj_procedure_list_get_first_procedure </td>
250 <td class="paramtype"><a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a> * </td>
251 <td class="paramname"><em>p_validation_list</em></td><td>)</td>
255 </div><div class="memdoc">
257 <p>Gets the pointer on the first validation procedure. </p>
258 <p>This function is similar to the C++ iterator class to iterate through all the procedures inside the validation list. the caller does not take ownership of the pointer.</p>
259 <dl class="params"><dt>Parameters</dt><dd>
260 <table class="params">
261 <tr><td class="paramname">p_validation_list</td><td>the list of procedure to get the first procedure from.</td></tr>
265 <dl class="section return"><dt>Returns</dt><dd>a pointer to the first procedure. </dd></dl>
267 <p>References <a class="el" href="structopj__procedure__list.html#a289f86770cadb567af4ccf3156fca8c7">opj_procedure_list::m_procedures</a>.</p>
269 <p>Referenced by <a class="el" href="group___j2_k.html#gada850e315ec35b2c29bb75e97b07ab2b">opj_j2k_exec()</a>, and <a class="el" href="jp2_8c.html#a5c8d5befcd92f556b160b2bdcddaf801">opj_jp2_exec()</a>.</p>
273 <a class="anchor" id="ga24cf23916e23907db588b420f870dbf4"></a>
274 <div class="memitem">
275 <div class="memproto">
276 <table class="memname">
278 <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_procedure_list_get_nb_procedures </td>
280 <td class="paramtype"><a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a> * </td>
281 <td class="paramname"><em>p_validation_list</em></td><td>)</td>
285 </div><div class="memdoc">
287 <p>Gets the number of validation procedures. </p>
288 <dl class="params"><dt>Parameters</dt><dd>
289 <table class="params">
290 <tr><td class="paramname">p_validation_list</td><td>the list of procedure to modify.</td></tr>
294 <dl class="section return"><dt>Returns</dt><dd>the number of validation procedures. </dd></dl>
296 <p>References <a class="el" href="structopj__procedure__list.html#af7aae9f4ec9402a74049bbc439019742">opj_procedure_list::m_nb_procedures</a>.</p>
298 <p>Referenced by <a class="el" href="group___j2_k.html#gada850e315ec35b2c29bb75e97b07ab2b">opj_j2k_exec()</a>, and <a class="el" href="jp2_8c.html#a5c8d5befcd92f556b160b2bdcddaf801">opj_jp2_exec()</a>.</p>
302 </div><!-- contents -->
303 <!-- start footer part -->
304 <hr class="footer"/><address class="footer"><small>
305 Generated by  <a href="http://www.doxygen.org/index.html">
306 <img class="footer" src="doxygen.png" alt="doxygen"/>