doxygen/function__list_8h_source.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: function_list.h Source File</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.3.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="headertitle">
  52 <div class="title">function_list.h</div>  </div>
  53 </div><!--header-->
  54 <div class="contents">
  55 <a href="function__list_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
  56 <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * The copyright in this software is being made available under the 2-clauses</span></div>
  57 <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * BSD License, included below. This software may be subject to other third</span></div>
  58 <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * party and contributor rights, including patent rights, and no such rights</span></div>
  59 <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * are granted under this license.</span></div>
  60 <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> *</span></div>
  61 <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * Copyright (c) 2008, Jerome Fimes, Communications &amp; Systemes &lt;jerome.fimes@c-s.fr&gt;</span></div>
  62 <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * All rights reserved.</span></div>
  63 <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *</span></div>
  64 <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
  65 <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * modification, are permitted provided that the following conditions</span></div>
  66 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * are met:</span></div>
  67 <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * 1. Redistributions of source code must retain the above copyright</span></div>
  68 <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *    notice, this list of conditions and the following disclaimer.</span></div>
  69 <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span></div>
  70 <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *    notice, this list of conditions and the following disclaimer in the</span></div>
  71 <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *    documentation and/or other materials provided with the distribution.</span></div>
  72 <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> *</span></div>
  73 <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS&#39;</span></div>
  74 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
  75 <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
  76 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span></div>
  77 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span></div>
  78 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div>
  79 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div>
  80 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div>
  81 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div>
  82 <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span></div>
  83 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span></div>
  84 <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"> */</span></div>
  85 <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div>
  86 <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#ifndef OPJ_FUNCTION_LIST_H</span></div>
  87 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#define OPJ_FUNCTION_LIST_H</span></div>
  88 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div>
  89 <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div>
  90 <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">/**************************************************************************************************</span></div>
  91 <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment"> ***************************************** FORWARD DECLARATION ************************************</span></div>
  92 <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment"> **************************************************************************************************/</span></div>
  93 <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;</div>
  94 <div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="group___v_a_l.html#gad3262b137c34187dce496329b8a637b9">   52</a></span>&#160;<span class="keyword">typedef</span> void (*<a class="code" href="group___v_a_l.html#gad3262b137c34187dce496329b8a637b9">opj_procedure</a>)(void);</div>
  95 <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div>
  96 <div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structopj__procedure__list.html">   57</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structopj__procedure__list.html">opj_procedure_list</a> {</div>
  97 <div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structopj__procedure__list.html#af7aae9f4ec9402a74049bbc439019742">   61</a></span>&#160;    <a class="code" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> <a class="code" href="structopj__procedure__list.html#af7aae9f4ec9402a74049bbc439019742">m_nb_procedures</a>;</div>
  98 <div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="structopj__procedure__list.html#ac64b1b06188f14c9f6f0b5136c200ad0">   65</a></span>&#160;    <a class="code" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> <a class="code" href="structopj__procedure__list.html#ac64b1b06188f14c9f6f0b5136c200ad0">m_nb_max_procedures</a>;</div>
  99 <div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="structopj__procedure__list.html#a289f86770cadb567af4ccf3156fca8c7">   69</a></span>&#160;    <a class="code" href="group___v_a_l.html#gad3262b137c34187dce496329b8a637b9">opj_procedure</a> * <a class="code" href="structopj__procedure__list.html#a289f86770cadb567af4ccf3156fca8c7">m_procedures</a>;</div>
 100 <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div>
 101 <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;} <a class="code" href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a>;</div>
 102 <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div>
 103 <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment">/* ----------------------------------------------------------------------- */</span></div>
 104 <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;</div>
 105 <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<a class="code" href="structopj__procedure__list.html">opj_procedure_list_t</a> *  <a class="code" href="group___v_a_l.html#ga5058f9c3fdf2ff44f72c315e571cd153">opj_procedure_list_create</a>(<span class="keywordtype">void</span>);</div>
 106 <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;</div>
 107 <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="keywordtype">void</span>  <a class="code" href="group___v_a_l.html#gae39a4783cf450cc32e8d7bea251a6f90">opj_procedure_list_destroy</a>(<a class="code" href="structopj__procedure__list.html">opj_procedure_list_t</a> * p_list);</div>
 108 <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;</div>
 109 <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<a class="code" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> <a class="code" href="group___v_a_l.html#ga504334e4d2e64b16372e70f6c7a9d3e2">opj_procedure_list_add_procedure</a>(<a class="code" href="structopj__procedure__list.html">opj_procedure_list_t</a> *</div>
 110 <div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;        p_validation_list, <a class="code" href="group___v_a_l.html#gad3262b137c34187dce496329b8a637b9">opj_procedure</a> p_procedure, <a class="code" href="structopj__event__mgr.html">opj_event_mgr_t</a>* p_manager);</div>
 111 <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;</div>
 112 <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<a class="code" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> <a class="code" href="group___v_a_l.html#ga24cf23916e23907db588b420f870dbf4">opj_procedure_list_get_nb_procedures</a>(<a class="code" href="structopj__procedure__list.html">opj_procedure_list_t</a> *</div>
 113 <div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;        p_validation_list);</div>
 114 <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;</div>
 115 <div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<a class="code" href="group___v_a_l.html#gad3262b137c34187dce496329b8a637b9">opj_procedure</a>* <a class="code" href="group___v_a_l.html#ga0fbe67e6c1863704ac826cd33de8f91b">opj_procedure_list_get_first_procedure</a>(<a class="code" href="structopj__procedure__list.html">opj_procedure_list_t</a> *</div>
 116 <div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;        p_validation_list);</div>
 117 <div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;</div>
 118 <div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;</div>
 119 <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group___v_a_l.html#ga9db9849fff78faa60392827aabf7e529">opj_procedure_list_clear</a>(<a class="code" href="structopj__procedure__list.html">opj_procedure_list_t</a> * p_validation_list);</div>
 120 <div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* OPJ_FUNCTION_LIST_H */</span><span class="preprocessor"></span></div>
 121 <div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;</div>
 122 <div class="ttc" id="group___v_a_l_html_gad3262b137c34187dce496329b8a637b9"><div class="ttname"><a href="group___v_a_l.html#gad3262b137c34187dce496329b8a637b9">opj_procedure</a></div><div class="ttdeci">void(* opj_procedure)(void)</div><div class="ttdoc">declare a function pointer </div><div class="ttdef"><b>Definition:</b> function_list.h:52</div></div>
 123 <div class="ttc" id="structopj__event__mgr_html"><div class="ttname"><a href="structopj__event__mgr.html">opj_event_mgr</a></div><div class="ttdoc">Message handler object used for. </div><div class="ttdef"><b>Definition:</b> event.h:50</div></div>
 124 <div class="ttc" id="group___v_a_l_html_ga9db9849fff78faa60392827aabf7e529"><div class="ttname"><a href="group___v_a_l.html#ga9db9849fff78faa60392827aabf7e529">opj_procedure_list_clear</a></div><div class="ttdeci">void opj_procedure_list_clear(opj_procedure_list_t *p_validation_list)</div><div class="ttdoc">Clears the list of validation procedures. </div><div class="ttdef"><b>Definition:</b> function_list.c:114</div></div>
 125 <div class="ttc" id="openjpeg_8h_html_abb5dad6294f4611f1925388e919b16f4"><div class="ttname"><a href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a></div><div class="ttdeci">int OPJ_BOOL</div><div class="ttdef"><b>Definition:</b> openjpeg.h:110</div></div>
 126 <div class="ttc" id="group___v_a_l_html_ga504334e4d2e64b16372e70f6c7a9d3e2"><div class="ttname"><a href="group___v_a_l.html#ga504334e4d2e64b16372e70f6c7a9d3e2">opj_procedure_list_add_procedure</a></div><div class="ttdeci">OPJ_BOOL opj_procedure_list_add_procedure(opj_procedure_list_t *p_validation_list, opj_procedure p_procedure, opj_event_mgr_t *p_manager)</div><div class="ttdoc">Adds a new validation procedure. </div><div class="ttdef"><b>Definition:</b> function_list.c:70</div></div>
 127 <div class="ttc" id="structopj__procedure__list_html"><div class="ttname"><a href="structopj__procedure__list.html">opj_procedure_list</a></div><div class="ttdoc">A list of procedures. </div><div class="ttdef"><b>Definition:</b> function_list.h:57</div></div>
 128 <div class="ttc" id="group___v_a_l_html_ga641b452ff3c3c8b7ba21cf4db6016cbd"><div class="ttname"><a href="group___v_a_l.html#ga641b452ff3c3c8b7ba21cf4db6016cbd">opj_procedure_list_t</a></div><div class="ttdeci">struct opj_procedure_list opj_procedure_list_t</div><div class="ttdoc">A list of procedures. </div></div>
 129 <div class="ttc" id="group___v_a_l_html_ga5058f9c3fdf2ff44f72c315e571cd153"><div class="ttname"><a href="group___v_a_l.html#ga5058f9c3fdf2ff44f72c315e571cd153">opj_procedure_list_create</a></div><div class="ttdeci">opj_procedure_list_t * opj_procedure_list_create(void)</div><div class="ttdoc">Creates a validation list. </div><div class="ttdef"><b>Definition:</b> function_list.c:39</div></div>
 130 <div class="ttc" id="structopj__procedure__list_html_af7aae9f4ec9402a74049bbc439019742"><div class="ttname"><a href="structopj__procedure__list.html#af7aae9f4ec9402a74049bbc439019742">opj_procedure_list::m_nb_procedures</a></div><div class="ttdeci">OPJ_UINT32 m_nb_procedures</div><div class="ttdoc">The number of validation procedures. </div><div class="ttdef"><b>Definition:</b> function_list.h:61</div></div>
 131 <div class="ttc" id="group___v_a_l_html_ga24cf23916e23907db588b420f870dbf4"><div class="ttname"><a href="group___v_a_l.html#ga24cf23916e23907db588b420f870dbf4">opj_procedure_list_get_nb_procedures</a></div><div class="ttdeci">OPJ_UINT32 opj_procedure_list_get_nb_procedures(opj_procedure_list_t *p_validation_list)</div><div class="ttdoc">Gets the number of validation procedures. </div><div class="ttdef"><b>Definition:</b> function_list.c:102</div></div>
 132 <div class="ttc" id="structopj__procedure__list_html_a289f86770cadb567af4ccf3156fca8c7"><div class="ttname"><a href="structopj__procedure__list.html#a289f86770cadb567af4ccf3156fca8c7">opj_procedure_list::m_procedures</a></div><div class="ttdeci">opj_procedure * m_procedures</div><div class="ttdoc">The array of procedures. </div><div class="ttdef"><b>Definition:</b> function_list.h:69</div></div>
 133 <div class="ttc" id="openjpeg_8h_html_a4cb1e6e6b6ef2df499d5c02f7df54cbb"><div class="ttname"><a href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a></div><div class="ttdeci">uint32_t OPJ_UINT32</div><div class="ttdef"><b>Definition:</b> openjpeg.h:126</div></div>
 134 <div class="ttc" id="group___v_a_l_html_ga0fbe67e6c1863704ac826cd33de8f91b"><div class="ttname"><a href="group___v_a_l.html#ga0fbe67e6c1863704ac826cd33de8f91b">opj_procedure_list_get_first_procedure</a></div><div class="ttdeci">opj_procedure * opj_procedure_list_get_first_procedure(opj_procedure_list_t *p_validation_list)</div><div class="ttdoc">Gets the pointer on the first validation procedure. </div><div class="ttdef"><b>Definition:</b> function_list.c:108</div></div>
 135 <div class="ttc" id="structopj__procedure__list_html_ac64b1b06188f14c9f6f0b5136c200ad0"><div class="ttname"><a href="structopj__procedure__list.html#ac64b1b06188f14c9f6f0b5136c200ad0">opj_procedure_list::m_nb_max_procedures</a></div><div class="ttdeci">OPJ_UINT32 m_nb_max_procedures</div><div class="ttdoc">The number of the array of validation procedures. </div><div class="ttdef"><b>Definition:</b> function_list.h:65</div></div>
 136 <div class="ttc" id="group___v_a_l_html_gae39a4783cf450cc32e8d7bea251a6f90"><div class="ttname"><a href="group___v_a_l.html#gae39a4783cf450cc32e8d7bea251a6f90">opj_procedure_list_destroy</a></div><div class="ttdeci">void opj_procedure_list_destroy(opj_procedure_list_t *p_list)</div><div class="ttdoc">Destroys a validation list. </div><div class="ttdef"><b>Definition:</b> function_list.c:58</div></div>
 137 </div><!-- fragment --></div><!-- contents -->
 138 <!-- start footer part -->
 139 <hr class="footer"/><address class="footer"><small>
 140 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 141 <img class="footer" src="doxygen.png" alt="doxygen"/>
 142 </a> 1.8.10
 143 </small></address>
 144 </body>
 145 </html>