doxygen/event_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: event.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.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="headertitle">
  52 <div class="title">event.h</div>  </div>
  53 </div><!--header-->
  54 <div class="contents">
  55 <a href="event_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) 2005, Herve Drolon, FreeImage Team</span></div>
  62 <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * Copyright (c) 2008, 2011-2012, Centre National d&#39;Etudes Spatiales (CNES), FR</span></div>
  63 <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * Copyright (c) 2012, CS Systemes d&#39;Information, France</span></div>
  64 <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * All rights reserved.</span></div>
  65 <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> *</span></div>
  66 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
  67 <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * modification, are permitted provided that the following conditions</span></div>
  68 <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * are met:</span></div>
  69 <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * 1. Redistributions of source code must retain 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.</span></div>
  71 <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span></div>
  72 <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> *    notice, this list of conditions and the following disclaimer in the</span></div>
  73 <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> *    documentation and/or other materials provided with the distribution.</span></div>
  74 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> *</span></div>
  75 <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS&#39;</span></div>
  76 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
  77 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
  78 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span></div>
  79 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span></div>
  80 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div>
  81 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div>
  82 <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div>
  83 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div>
  84 <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span></div>
  85 <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span></div>
  86 <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment"> */</span></div>
  87 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#ifndef OPJ_EVENT_H</span></div>
  88 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#define OPJ_EVENT_H</span></div>
  89 <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div>
  90 <div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structopj__event__mgr.html">   50</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structopj__event__mgr.html">opj_event_mgr</a> {</div>
  91 <div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structopj__event__mgr.html#a551021914bcf2da3a212f1fd128da7d7">   52</a></span>&#160;    <span class="keywordtype">void</span> *          <a class="code" href="structopj__event__mgr.html#a551021914bcf2da3a212f1fd128da7d7">m_error_data</a>;</div>
  92 <div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structopj__event__mgr.html#ae86cf70e19e00750bdf4df2fdae4f4b3">   54</a></span>&#160;    <span class="keywordtype">void</span> *          <a class="code" href="structopj__event__mgr.html#ae86cf70e19e00750bdf4df2fdae4f4b3">m_warning_data</a>;</div>
  93 <div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structopj__event__mgr.html#a914c15d0e74ed08bc54a93664df4402c">   56</a></span>&#160;    <span class="keywordtype">void</span> *          <a class="code" href="structopj__event__mgr.html#a914c15d0e74ed08bc54a93664df4402c">m_info_data</a>;</div>
  94 <div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structopj__event__mgr.html#a9ee0c627fefd37d56e3487af6fc250b6">   58</a></span>&#160;    <a class="code" href="openjpeg_8h.html#aeb2e489c5b4386fed6eae3123217c7f0">opj_msg_callback</a> <a class="code" href="structopj__event__mgr.html#a9ee0c627fefd37d56e3487af6fc250b6">error_handler</a>;</div>
  95 <div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structopj__event__mgr.html#af0954e95dec628614f22a501f2b6ce9b">   60</a></span>&#160;    <a class="code" href="openjpeg_8h.html#aeb2e489c5b4386fed6eae3123217c7f0">opj_msg_callback</a> <a class="code" href="structopj__event__mgr.html#af0954e95dec628614f22a501f2b6ce9b">warning_handler</a>;</div>
  96 <div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structopj__event__mgr.html#ad60a40bbc655af631ec15f84ee45a708">   62</a></span>&#160;    <a class="code" href="openjpeg_8h.html#aeb2e489c5b4386fed6eae3123217c7f0">opj_msg_callback</a> <a class="code" href="structopj__event__mgr.html#ad60a40bbc655af631ec15f84ee45a708">info_handler</a>;</div>
  97 <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;} <a class="code" href="event_8h.html#a4cba85f9ee037b1f2c6bceb903051d96">opj_event_mgr_t</a>;</div>
  98 <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div>
  99 <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;</div>
 100 <div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="event_8h.html#a7323671f4df0a721ae02d610b1269ab9">   66</a></span>&#160;<span class="preprocessor">#define EVT_ERROR   1   </span></div>
 101 <div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="event_8h.html#abefbcb0bea7916739b3adccb2d4e9417">   67</a></span>&#160;<span class="preprocessor">#define EVT_WARNING 2   </span></div>
 102 <div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="event_8h.html#a220921068c5e3c97c8f2ad4db0c60726">   68</a></span>&#160;<span class="preprocessor">#define EVT_INFO    4   </span></div>
 103 <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="preprocessor"></span></div>
 104 <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;</div>
 105 <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment">/* ----------------------------------------------------------------------- */</span></div>
 106 <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div>
 107 <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div>
 108 <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment">/* ----------------------------------------------------------------------- */</span></div>
 109 <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;</div>
 110 <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<a class="code" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> <a class="code" href="group___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">opj_event_msg</a>(<a class="code" href="structopj__event__mgr.html">opj_event_mgr_t</a>* event_mgr, <a class="code" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a> event_type,</div>
 111 <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;                       <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...);</div>
 112 <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment">/* ----------------------------------------------------------------------- */</span></div>
 113 <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div>
 114 <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group___e_v_e_n_t.html#ga8584de0db0bbc62b70d5cf5089165ef2">opj_set_default_event_handler</a>(<a class="code" href="structopj__event__mgr.html">opj_event_mgr_t</a> * p_manager);</div>
 115 <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;</div>
 116 <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment">/*</span></div>
 117 <div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment">#ifdef __GNUC__</span></div>
 118 <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment">#pragma GCC poison printf fprintf</span></div>
 119 <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment">#endif</span></div>
 120 <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment">*/</span></div>
 121 <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;</div>
 122 <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;</div>
 123 <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* OPJ_EVENT_H */</span><span class="preprocessor"></span></div>
 124 <div class="ttc" id="structopj__event__mgr_html_ad60a40bbc655af631ec15f84ee45a708"><div class="ttname"><a href="structopj__event__mgr.html#ad60a40bbc655af631ec15f84ee45a708">opj_event_mgr::info_handler</a></div><div class="ttdeci">opj_msg_callback info_handler</div><div class="ttdoc">Debug message callback if available, NULL otherwise. </div><div class="ttdef"><b>Definition:</b> event.h:62</div></div>
 125 <div class="ttc" id="structopj__event__mgr_html_a551021914bcf2da3a212f1fd128da7d7"><div class="ttname"><a href="structopj__event__mgr.html#a551021914bcf2da3a212f1fd128da7d7">opj_event_mgr::m_error_data</a></div><div class="ttdeci">void * m_error_data</div><div class="ttdoc">Data to call the event manager upon. </div><div class="ttdef"><b>Definition:</b> event.h:52</div></div>
 126 <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>
 127 <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>
 128 <div class="ttc" id="openjpeg_8h_html_a3cec91ef9e73677f0dbd60d4e42401b9"><div class="ttname"><a href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a></div><div class="ttdeci">int32_t OPJ_INT32</div><div class="ttdef"><b>Definition:</b> openjpeg.h:125</div></div>
 129 <div class="ttc" id="openjpeg_8h_html_aeb2e489c5b4386fed6eae3123217c7f0"><div class="ttname"><a href="openjpeg_8h.html#aeb2e489c5b4386fed6eae3123217c7f0">opj_msg_callback</a></div><div class="ttdeci">void(* opj_msg_callback)(const char *msg, void *client_data)</div><div class="ttdoc">Callback function prototype for events. </div><div class="ttdef"><b>Definition:</b> openjpeg.h:313</div></div>
 130 <div class="ttc" id="group___e_v_e_n_t_html_ga87d9d4bdfd203ccd8a7522d6f197a3b7"><div class="ttname"><a href="group___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">opj_event_msg</a></div><div class="ttdeci">OPJ_BOOL opj_event_msg(opj_event_mgr_t *event_mgr, OPJ_INT32 event_type, const char *fmt,...)</div><div class="ttdoc">Write formatted data to a string and send the string to a user callback. </div><div class="ttdef"><b>Definition:</b> event.c:91</div></div>
 131 <div class="ttc" id="structopj__event__mgr_html_af0954e95dec628614f22a501f2b6ce9b"><div class="ttname"><a href="structopj__event__mgr.html#af0954e95dec628614f22a501f2b6ce9b">opj_event_mgr::warning_handler</a></div><div class="ttdeci">opj_msg_callback warning_handler</div><div class="ttdoc">Warning message callback if available, NULL otherwise. </div><div class="ttdef"><b>Definition:</b> event.h:60</div></div>
 132 <div class="ttc" id="structopj__event__mgr_html_ae86cf70e19e00750bdf4df2fdae4f4b3"><div class="ttname"><a href="structopj__event__mgr.html#ae86cf70e19e00750bdf4df2fdae4f4b3">opj_event_mgr::m_warning_data</a></div><div class="ttdeci">void * m_warning_data</div><div class="ttdoc">Data to call the event manager upon. </div><div class="ttdef"><b>Definition:</b> event.h:54</div></div>
 133 <div class="ttc" id="structopj__event__mgr_html_a9ee0c627fefd37d56e3487af6fc250b6"><div class="ttname"><a href="structopj__event__mgr.html#a9ee0c627fefd37d56e3487af6fc250b6">opj_event_mgr::error_handler</a></div><div class="ttdeci">opj_msg_callback error_handler</div><div class="ttdoc">Error message callback if available, NULL otherwise. </div><div class="ttdef"><b>Definition:</b> event.h:58</div></div>
 134 <div class="ttc" id="event_8h_html_a4cba85f9ee037b1f2c6bceb903051d96"><div class="ttname"><a href="event_8h.html#a4cba85f9ee037b1f2c6bceb903051d96">opj_event_mgr_t</a></div><div class="ttdeci">struct opj_event_mgr opj_event_mgr_t</div><div class="ttdoc">Message handler object used for. </div></div>
 135 <div class="ttc" id="group___e_v_e_n_t_html_ga8584de0db0bbc62b70d5cf5089165ef2"><div class="ttname"><a href="group___e_v_e_n_t.html#ga8584de0db0bbc62b70d5cf5089165ef2">opj_set_default_event_handler</a></div><div class="ttdeci">void opj_set_default_event_handler(opj_event_mgr_t *p_manager)</div><div class="ttdoc">Set the event manager with the default callback function for the 3 levels. </div><div class="ttdef"><b>Definition:</b> event.c:142</div></div>
 136 <div class="ttc" id="structopj__event__mgr_html_a914c15d0e74ed08bc54a93664df4402c"><div class="ttname"><a href="structopj__event__mgr.html#a914c15d0e74ed08bc54a93664df4402c">opj_event_mgr::m_info_data</a></div><div class="ttdeci">void * m_info_data</div><div class="ttdoc">Data to call the event manager upon. </div><div class="ttdef"><b>Definition:</b> event.h:56</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>