<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>OpenJPEG: function_list.c File Reference</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 id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">OpenJPEG  <span id="projectnumber">2.5.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.17 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> <div id="nav-path" class="navpath"> <ul> <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> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#define-members">Macros</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">function_list.c File Reference</div> </div> </div><!--header--> <div class="contents"> <div class="textblock"><code>#include "<a class="el" href="opj__includes_8h_source.html">opj_includes.h</a>"</code><br /> </div><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:a8d474095158ba1ed5c673c66c60bd607"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="function__list_8c.html#a8d474095158ba1ed5c673c66c60bd607">OPJ_VALIDATION_SIZE</a>   10</td></tr> <tr class="memdesc:a8d474095158ba1ed5c673c66c60bd607"><td class="mdescLeft"> </td><td class="mdescRight">Default size of the validation list, if not sufficient, data will be reallocated with a double size. <a href="function__list_8c.html#a8d474095158ba1ed5c673c66c60bd607">More...</a><br /></td></tr> <tr class="separator:a8d474095158ba1ed5c673c66c60bd607"><td class="memSeparator" colspan="2"> </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:ae8846726864247ad8f11ed1be5987e39"><td class="memItemLeft" align="right" valign="top"><a class="el" href="function__list_8h.html#a59b23b53d24723a628ce8e83f0966e78">opj_procedure_list_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="function__list_8c.html#ae8846726864247ad8f11ed1be5987e39">opj_procedure_list_create</a> ()</td></tr> <tr class="memdesc:ae8846726864247ad8f11ed1be5987e39"><td class="mdescLeft"> </td><td class="mdescRight">Creates a validation list. <a href="function__list_8c.html#ae8846726864247ad8f11ed1be5987e39">More...</a><br /></td></tr> <tr class="separator:ae8846726864247ad8f11ed1be5987e39"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae39a4783cf450cc32e8d7bea251a6f90"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="function__list_8c.html#ae39a4783cf450cc32e8d7bea251a6f90">opj_procedure_list_destroy</a> (<a class="el" href="function__list_8h.html#a59b23b53d24723a628ce8e83f0966e78">opj_procedure_list_t</a> *p_list)</td></tr> <tr class="memdesc:ae39a4783cf450cc32e8d7bea251a6f90"><td class="mdescLeft"> </td><td class="mdescRight">Destroys a validation list. <a href="function__list_8c.html#ae39a4783cf450cc32e8d7bea251a6f90">More...</a><br /></td></tr> <tr class="separator:ae39a4783cf450cc32e8d7bea251a6f90"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a504334e4d2e64b16372e70f6c7a9d3e2"><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="function__list_8c.html#a504334e4d2e64b16372e70f6c7a9d3e2">opj_procedure_list_add_procedure</a> (<a class="el" href="function__list_8h.html#a59b23b53d24723a628ce8e83f0966e78">opj_procedure_list_t</a> *p_validation_list, <a class="el" href="function__list_8h.html#ad3262b137c34187dce496329b8a637b9">opj_procedure</a> p_procedure, <a class="el" href="event_8h.html#a9015b7726990d51ca282c8134b8eccdd">opj_event_mgr_t</a> *p_manager)</td></tr> <tr class="memdesc:a504334e4d2e64b16372e70f6c7a9d3e2"><td class="mdescLeft"> </td><td class="mdescRight">Adds a new validation procedure. <a href="function__list_8c.html#a504334e4d2e64b16372e70f6c7a9d3e2">More...</a><br /></td></tr> <tr class="separator:a504334e4d2e64b16372e70f6c7a9d3e2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a24cf23916e23907db588b420f870dbf4"><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="function__list_8c.html#a24cf23916e23907db588b420f870dbf4">opj_procedure_list_get_nb_procedures</a> (<a class="el" href="function__list_8h.html#a59b23b53d24723a628ce8e83f0966e78">opj_procedure_list_t</a> *p_validation_list)</td></tr> <tr class="memdesc:a24cf23916e23907db588b420f870dbf4"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of validation procedures. <a href="function__list_8c.html#a24cf23916e23907db588b420f870dbf4">More...</a><br /></td></tr> <tr class="separator:a24cf23916e23907db588b420f870dbf4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0fbe67e6c1863704ac826cd33de8f91b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="function__list_8h.html#ad3262b137c34187dce496329b8a637b9">opj_procedure</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="function__list_8c.html#a0fbe67e6c1863704ac826cd33de8f91b">opj_procedure_list_get_first_procedure</a> (<a class="el" href="function__list_8h.html#a59b23b53d24723a628ce8e83f0966e78">opj_procedure_list_t</a> *p_validation_list)</td></tr> <tr class="memdesc:a0fbe67e6c1863704ac826cd33de8f91b"><td class="mdescLeft"> </td><td class="mdescRight">Gets the pointer on the first validation procedure. <a href="function__list_8c.html#a0fbe67e6c1863704ac826cd33de8f91b">More...</a><br /></td></tr> <tr class="separator:a0fbe67e6c1863704ac826cd33de8f91b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9db9849fff78faa60392827aabf7e529"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="function__list_8c.html#a9db9849fff78faa60392827aabf7e529">opj_procedure_list_clear</a> (<a class="el" href="function__list_8h.html#a59b23b53d24723a628ce8e83f0966e78">opj_procedure_list_t</a> *p_validation_list)</td></tr> <tr class="memdesc:a9db9849fff78faa60392827aabf7e529"><td class="mdescLeft"> </td><td class="mdescRight">Clears the list of validation procedures. <a href="function__list_8c.html#a9db9849fff78faa60392827aabf7e529">More...</a><br /></td></tr> <tr class="separator:a9db9849fff78faa60392827aabf7e529"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Macro Definition Documentation</h2> <a id="a8d474095158ba1ed5c673c66c60bd607"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8d474095158ba1ed5c673c66c60bd607">◆ </a></span>OPJ_VALIDATION_SIZE</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define OPJ_VALIDATION_SIZE   10</td> </tr> </table> </div><div class="memdoc"> <p>Default size of the validation list, if not sufficient, data will be reallocated with a double size. </p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a id="a504334e4d2e64b16372e70f6c7a9d3e2"></a> <h2 class="memtitle"><span class="permalink"><a href="#a504334e4d2e64b16372e70f6c7a9d3e2">◆ </a></span>opj_procedure_list_add_procedure()</h2> <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="function__list_8h.html#a59b23b53d24723a628ce8e83f0966e78">opj_procedure_list_t</a> * </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="function__list_8h.html#ad3262b137c34187dce496329b8a637b9">opj_procedure</a> </td> <td class="paramname"><em>p_procedure</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="event_8h.html#a9015b7726990d51ca282c8134b8eccdd">opj_event_mgr_t</a> * </td> <td class="paramname"><em>p_manager</em> </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> <tr><td class="paramname">p_manager</td><td>the user event manager.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>OPJ_TRUE if the procedure could be added. </dd></dl> <p class="reference">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="event_8c.html#a80a24e8c6d24861cd2403e48a7c2591e">opj_event_msg()</a>, <a class="el" href="openjpeg_8h.html#ac672bfd7db39c609e828acb07a321964">OPJ_FALSE</a>, <a class="el" href="opj__malloc_8c.html#a9d7d909f8dc1a2c23313c48645341e81">opj_free()</a>, <a class="el" href="opj__malloc_8c.html#aa39cad09aebcf1b795fe829359115812">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 class="reference">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="j2k_8c.html#a7fa2dd1eb76428e165f90c94b3d3182c">opj_j2k_setup_decoding_validation()</a>, <a class="el" href="j2k_8c.html#a1cfd2341c822135243d49632743a09af">opj_j2k_setup_encoding_validation()</a>, <a class="el" href="j2k_8c.html#a6a868f1202d4d185f6853c472e2a8688">opj_j2k_setup_end_compress()</a>, <a class="el" href="j2k_8c.html#aa672a0ce8dc41d6cdfb2b803e051a21c">opj_j2k_setup_header_reading()</a>, <a class="el" href="j2k_8c.html#ab714ef6da730a44656754a9280ff8b8b">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> </div> </div> <a id="a9db9849fff78faa60392827aabf7e529"></a> <h2 class="memtitle"><span class="permalink"><a href="#a9db9849fff78faa60392827aabf7e529">◆ </a></span>opj_procedure_list_clear()</h2> <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="function__list_8h.html#a59b23b53d24723a628ce8e83f0966e78">opj_procedure_list_t</a> * </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 class="reference">References <a class="el" href="structopj__procedure__list.html#af7aae9f4ec9402a74049bbc439019742">opj_procedure_list::m_nb_procedures</a>.</p> <p class="reference">Referenced by <a class="el" href="j2k_8c.html#ada850e315ec35b2c29bb75e97b07ab2b">opj_j2k_exec()</a>, and <a class="el" href="jp2_8c.html#a5c8d5befcd92f556b160b2bdcddaf801">opj_jp2_exec()</a>.</p> </div> </div> <a id="ae8846726864247ad8f11ed1be5987e39"></a> <h2 class="memtitle"><span class="permalink"><a href="#ae8846726864247ad8f11ed1be5987e39">◆ </a></span>opj_procedure_list_create()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="function__list_8h.html#a59b23b53d24723a628ce8e83f0966e78">opj_procedure_list_t</a>* opj_procedure_list_create </td> <td>(</td> <td class="paramtype">void </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 class="reference">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="opj__malloc_8c.html#a3fe08bb7876e393dd04332d049a4d53e">opj_calloc()</a>, <a class="el" href="opj__malloc_8c.html#a9d7d909f8dc1a2c23313c48645341e81">opj_free()</a>, and <a class="el" href="function__list_8c.html#a8d474095158ba1ed5c673c66c60bd607">OPJ_VALIDATION_SIZE</a>.</p> <p class="reference">Referenced by <a class="el" href="j2k_8h.html#ad3c2b25f4d5a5f6fd4b442bc7210f6da">opj_j2k_create_compress()</a>, <a class="el" href="j2k_8h.html#ad76bb79d4d63030222ebf3dbe3fe86cf">opj_j2k_create_decompress()</a>, and <a class="el" href="jp2_8h.html#a7d5389b7ba1706b96ec2adeb431a4735">opj_jp2_create()</a>.</p> </div> </div> <a id="ae39a4783cf450cc32e8d7bea251a6f90"></a> <h2 class="memtitle"><span class="permalink"><a href="#ae39a4783cf450cc32e8d7bea251a6f90">◆ </a></span>opj_procedure_list_destroy()</h2> <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="function__list_8h.html#a59b23b53d24723a628ce8e83f0966e78">opj_procedure_list_t</a> * </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 class="reference">References <a class="el" href="structopj__procedure__list.html#a289f86770cadb567af4ccf3156fca8c7">opj_procedure_list::m_procedures</a>, and <a class="el" href="opj__malloc_8c.html#a9d7d909f8dc1a2c23313c48645341e81">opj_free()</a>.</p> <p class="reference">Referenced by <a class="el" href="j2k_8h.html#a5c4508543b134e726107308b6463528e">opj_j2k_destroy()</a>, and <a class="el" href="jp2_8h.html#a1f7f8e8462c3bf6fdf6c3d4d75b8b3b7">opj_jp2_destroy()</a>.</p> </div> </div> <a id="a0fbe67e6c1863704ac826cd33de8f91b"></a> <h2 class="memtitle"><span class="permalink"><a href="#a0fbe67e6c1863704ac826cd33de8f91b">◆ </a></span>opj_procedure_list_get_first_procedure()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="function__list_8h.html#ad3262b137c34187dce496329b8a637b9">opj_procedure</a>* opj_procedure_list_get_first_procedure </td> <td>(</td> <td class="paramtype"><a class="el" href="function__list_8h.html#a59b23b53d24723a628ce8e83f0966e78">opj_procedure_list_t</a> * </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 class="reference">References <a class="el" href="structopj__procedure__list.html#a289f86770cadb567af4ccf3156fca8c7">opj_procedure_list::m_procedures</a>.</p> <p class="reference">Referenced by <a class="el" href="j2k_8c.html#ada850e315ec35b2c29bb75e97b07ab2b">opj_j2k_exec()</a>, and <a class="el" href="jp2_8c.html#a5c8d5befcd92f556b160b2bdcddaf801">opj_jp2_exec()</a>.</p> </div> </div> <a id="a24cf23916e23907db588b420f870dbf4"></a> <h2 class="memtitle"><span class="permalink"><a href="#a24cf23916e23907db588b420f870dbf4">◆ </a></span>opj_procedure_list_get_nb_procedures()</h2> <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="function__list_8h.html#a59b23b53d24723a628ce8e83f0966e78">opj_procedure_list_t</a> * </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 class="reference">References <a class="el" href="structopj__procedure__list.html#af7aae9f4ec9402a74049bbc439019742">opj_procedure_list::m_nb_procedures</a>.</p> <p class="reference">Referenced by <a class="el" href="j2k_8c.html#ada850e315ec35b2c29bb75e97b07ab2b">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  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.17 </small></address> </body> </html>