walkero
/
openjpeg
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity
openjpeg/doxygen/group___v_a_l.html

304 lines
20 KiB
HTML
Raw Normal View History

added doxygen for latest release
2015-07-10 18:06:19 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>OpenJPEG: VAL - validation procedure</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">OpenJPEG
&#160;<span id="projectnumber">2.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">VAL - validation procedure</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__procedure__list.html">opj_procedure_list</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A list of procedures. <a href="structopj__procedure__list.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gad3262b137c34187dce496329b8a637b9"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___v_a_l.html#gad3262b137c34187dce496329b8a637b9">opj_procedure</a>) (void)</td></tr>
<tr class="memdesc:gad3262b137c34187dce496329b8a637b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">declare a function pointer <a href="#gad3262b137c34187dce496329b8a637b9">More...</a><br /></td></tr>
<tr class="separator:gad3262b137c34187dce496329b8a637b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a></td></tr>
<tr class="memdesc:ga641b452ff3c3c8b7ba21cf4db6016cbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">A list of procedures. <a href="#ga641b452ff3c3c8b7ba21cf4db6016cbd">More...</a><br /></td></tr>
<tr class="separator:ga641b452ff3c3c8b7ba21cf4db6016cbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<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> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___v_a_l.html#ga5058f9c3fdf2ff44f72c315e571cd153">opj_procedure_list_create</a> (void)</td></tr>
<tr class="memdesc:ga5058f9c3fdf2ff44f72c315e571cd153"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a validation list. <a href="#ga5058f9c3fdf2ff44f72c315e571cd153">More...</a><br /></td></tr>
<tr class="separator:ga5058f9c3fdf2ff44f72c315e571cd153"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae39a4783cf450cc32e8d7bea251a6f90"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
<tr class="memdesc:gae39a4783cf450cc32e8d7bea251a6f90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys a validation list. <a href="#gae39a4783cf450cc32e8d7bea251a6f90">More...</a><br /></td></tr>
<tr class="separator:gae39a4783cf450cc32e8d7bea251a6f90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga53fac4c079b64eecdf150212c1e52d65"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___v_a_l.html#ga53fac4c079b64eecdf150212c1e52d65">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)</td></tr>
<tr class="memdesc:ga53fac4c079b64eecdf150212c1e52d65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a new validation procedure. <a href="#ga53fac4c079b64eecdf150212c1e52d65">More...</a><br /></td></tr>
<tr class="separator:ga53fac4c079b64eecdf150212c1e52d65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga24cf23916e23907db588b420f870dbf4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</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>
<tr class="memdesc:ga24cf23916e23907db588b420f870dbf4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the number of validation procedures. <a href="#ga24cf23916e23907db588b420f870dbf4">More...</a><br /></td></tr>
<tr class="separator:ga24cf23916e23907db588b420f870dbf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0fbe67e6c1863704ac826cd33de8f91b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___v_a_l.html#gad3262b137c34187dce496329b8a637b9">opj_procedure</a> *&#160;</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>
<tr class="memdesc:ga0fbe67e6c1863704ac826cd33de8f91b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the pointer on the first validation procedure. <a href="#ga0fbe67e6c1863704ac826cd33de8f91b">More...</a><br /></td></tr>
<tr class="separator:ga0fbe67e6c1863704ac826cd33de8f91b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9db9849fff78faa60392827aabf7e529"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
<tr class="memdesc:ga9db9849fff78faa60392827aabf7e529"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the list of validation procedures. <a href="#ga9db9849fff78faa60392827aabf7e529">More...</a><br /></td></tr>
<tr class="separator:ga9db9849fff78faa60392827aabf7e529"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gad3262b137c34187dce496329b8a637b9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* opj_procedure) (void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>declare a function pointer </p>
</div>
</div>
<a class="anchor" id="ga641b452ff3c3c8b7ba21cf4db6016cbd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div><div class="memdoc">
<p>A list of procedures. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga53fac4c079b64eecdf150212c1e52d65"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_procedure_list_add_procedure </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a> *&#160;</td>
<td class="paramname"><em>p_validation_list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___v_a_l.html#gad3262b137c34187dce496329b8a637b9">opj_procedure</a>&#160;</td>
<td class="paramname"><em>p_procedure</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a new validation procedure. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_validation_list</td><td>the list of procedure to modify. </td></tr>
<tr><td class="paramname">p_procedure</td><td>the procedure to add.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>OPJ_TRUE if the procedure could be added. </dd></dl>
<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#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="openjpeg_8h.html#ac672bfd7db39c609e828acb07a321964">OPJ_FALSE</a>, <a class="el" href="group___m_i_s_c.html#ga700b1aef6148bd6c3edde626610ffe2f">opj_free</a>, <a class="el" href="group___m_i_s_c.html#ga44ed06e3c38bcd5a29178db6fd72485e">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>
<p>Referenced by <a class="el" href="j2k_8c.html#adf505c266a037f17022d92eeb0117f86">opj_j2k_setup_decoding()</a>, <a class="el" href="j2k_8c.html#adc09cccab2a1cb4f52d2f5d4e0908953">opj_j2k_setup_decoding_tile()</a>, <a class="el" href="group___j2_k.html#gaf6c8ae395c193dc54c1b7c64a30d93e8">opj_j2k_setup_decoding_validation()</a>, <a class="el" href="group___j2_k.html#ga16d6409e95bcd7606f2e3f65bd0c3773">opj_j2k_setup_encoding_validation()</a>, <a class="el" href="group___j2_k.html#gaf4d15f65e61cd4025b8ef75130d58fad">opj_j2k_setup_end_compress()</a>, <a class="el" href="group___j2_k.html#ga2abb6381836fd5b1d16bc279593e13de">opj_j2k_setup_header_reading()</a>, <a class="el" href="group___j2_k.html#gaedfae694fba11bc645d3b8522e23d145">opj_j2k_setup_header_writing()</a>, <a class="el" href="jp2_8c.html#aa8b98f03b9fcb103367a69429480a077">opj_jp2_setup_encoding_validation()</a>, <a class="el" href="jp2_8c.html#abd51383c8c56c4fbd42908b6de363ff4">opj_jp2_setup_end_header_reading()</a>, <a class="el" href="jp2_8c.html#ae2f8aaa41895b0b6ef30abe4edf0fa1a">opj_jp2_setup_end_header_writing()</a>, <a class="el" href="jp2_8c.html#a088a70f0b3950a42b94d5d1efdc29484">opj_jp2_setup_header_reading()</a>, and <a class="el" href="jp2_8c.html#a3329c81c84e07171cd2ed22dad79d96a">opj_jp2_setup_header_writing()</a>.</p>
</div>
</div>
<a class="anchor" id="ga9db9849fff78faa60392827aabf7e529"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void opj_procedure_list_clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a> *&#160;</td>
<td class="paramname"><em>p_validation_list</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the list of validation procedures. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_validation_list</td><td>the list of procedure to clear. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="structopj__procedure__list.html#af7aae9f4ec9402a74049bbc439019742">opj_procedure_list::m_nb_procedures</a>.</p>
<p>Referenced by <a class="el" href="group___j2_k.html#ga2b7ba0cdfd91d05bc13c11270f81d8c6">opj_j2k_exec()</a>, and <a class="el" href="jp2_8c.html#a5c8d5befcd92f556b160b2bdcddaf801">opj_jp2_exec()</a>.</p>
</div>
</div>
<a class="anchor" id="ga5058f9c3fdf2ff44f72c315e571cd153"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a>* opj_procedure_list_create </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a validation list. </p>
<dl class="section return"><dt>Returns</dt><dd>the newly created validation list. </dd></dl>
<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#ga1fb8ed2c030462ba457fbaaf182f4809">opj_calloc</a>, <a class="el" href="group___m_i_s_c.html#ga700b1aef6148bd6c3edde626610ffe2f">opj_free</a>, and <a class="el" href="function__list_8c.html#a8d474095158ba1ed5c673c66c60bd607">OPJ_VALIDATION_SIZE</a>.</p>
<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>
</div>
</div>
<a class="anchor" id="gae39a4783cf450cc32e8d7bea251a6f90"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void opj_procedure_list_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a> *&#160;</td>
<td class="paramname"><em>p_list</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys a validation list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_list</td><td>the list to destroy. </td></tr>
</table>
</dd>
</dl>
<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#ga700b1aef6148bd6c3edde626610ffe2f">opj_free</a>.</p>
<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>
</div>
</div>
<a class="anchor" id="ga0fbe67e6c1863704ac826cd33de8f91b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___v_a_l.html#gad3262b137c34187dce496329b8a637b9">opj_procedure</a>* opj_procedure_list_get_first_procedure </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a> *&#160;</td>
<td class="paramname"><em>p_validation_list</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the pointer on the first validation procedure. </p>
<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>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_validation_list</td><td>the list of procedure to get the first procedure from.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the first procedure. </dd></dl>
<p>References <a class="el" href="structopj__procedure__list.html#a289f86770cadb567af4ccf3156fca8c7">opj_procedure_list::m_procedures</a>.</p>
<p>Referenced by <a class="el" href="group___j2_k.html#ga2b7ba0cdfd91d05bc13c11270f81d8c6">opj_j2k_exec()</a>, and <a class="el" href="jp2_8c.html#a5c8d5befcd92f556b160b2bdcddaf801">opj_jp2_exec()</a>.</p>
</div>
</div>
<a class="anchor" id="ga24cf23916e23907db588b420f870dbf4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_procedure_list_get_nb_procedures </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a> *&#160;</td>
<td class="paramname"><em>p_validation_list</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the number of validation procedures. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_validation_list</td><td>the list of procedure to modify.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of validation procedures. </dd></dl>
<p>References <a class="el" href="structopj__procedure__list.html#af7aae9f4ec9402a74049bbc439019742">opj_procedure_list::m_nb_procedures</a>.</p>
<p>Referenced by <a class="el" href="group___j2_k.html#ga2b7ba0cdfd91d05bc13c11270f81d8c6">opj_j2k_exec()</a>, and <a class="el" href="jp2_8c.html#a5c8d5befcd92f556b160b2bdcddaf801">opj_jp2_exec()</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>