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

183 lines
22 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: event.h 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 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 class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<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>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">event.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Implementation of a event callback system.
<a href="#details">More...</a></p>
<p><a href="event_8h_source.html">Go to the source code of this file.</a></p>
<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__event__mgr.html">opj_event_mgr</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Message handler object used for. <a href="structopj__event__mgr.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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a7323671f4df0a721ae02d610b1269ab9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event_8h.html#a7323671f4df0a721ae02d610b1269ab9">EVT_ERROR</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:a7323671f4df0a721ae02d610b1269ab9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error event type. <a href="#a7323671f4df0a721ae02d610b1269ab9">More...</a><br /></td></tr>
<tr class="separator:a7323671f4df0a721ae02d610b1269ab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abefbcb0bea7916739b3adccb2d4e9417"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event_8h.html#abefbcb0bea7916739b3adccb2d4e9417">EVT_WARNING</a>&#160;&#160;&#160;2</td></tr>
<tr class="memdesc:abefbcb0bea7916739b3adccb2d4e9417"><td class="mdescLeft">&#160;</td><td class="mdescRight">Warning event type. <a href="#abefbcb0bea7916739b3adccb2d4e9417">More...</a><br /></td></tr>
<tr class="separator:abefbcb0bea7916739b3adccb2d4e9417"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a220921068c5e3c97c8f2ad4db0c60726"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event_8h.html#a220921068c5e3c97c8f2ad4db0c60726">EVT_INFO</a>&#160;&#160;&#160;4</td></tr>
<tr class="memdesc:a220921068c5e3c97c8f2ad4db0c60726"><td class="mdescLeft">&#160;</td><td class="mdescRight">Debug event type. <a href="#a220921068c5e3c97c8f2ad4db0c60726">More...</a><br /></td></tr>
<tr class="separator:a220921068c5e3c97c8f2ad4db0c60726"><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:a4cba85f9ee037b1f2c6bceb903051d96"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structopj__event__mgr.html">opj_event_mgr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event_8h.html#a4cba85f9ee037b1f2c6bceb903051d96">opj_event_mgr_t</a></td></tr>
<tr class="memdesc:a4cba85f9ee037b1f2c6bceb903051d96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Message handler object used for. <a href="#a4cba85f9ee037b1f2c6bceb903051d96">More...</a><br /></td></tr>
<tr class="separator:a4cba85f9ee037b1f2c6bceb903051d96"><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><td colspan="2"><div class="groupHeader">Exported functions (see also openjpeg.h)</div></td></tr>
<tr class="memitem:ga87d9d4bdfd203ccd8a7522d6f197a3b7"><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___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">opj_event_msg</a> (<a class="el" href="event_8h.html#a4cba85f9ee037b1f2c6bceb903051d96">opj_event_mgr_t</a> *event_mgr, <a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a> event_type, const char *fmt,...)</td></tr>
<tr class="memdesc:ga87d9d4bdfd203ccd8a7522d6f197a3b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write formatted data to a string and send the string to a user callback. <a href="group___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">More...</a><br /></td></tr>
<tr class="separator:ga87d9d4bdfd203ccd8a7522d6f197a3b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8584de0db0bbc62b70d5cf5089165ef2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_v_e_n_t.html#ga8584de0db0bbc62b70d5cf5089165ef2">opj_set_default_event_handler</a> (<a class="el" href="event_8h.html#a4cba85f9ee037b1f2c6bceb903051d96">opj_event_mgr_t</a> *p_manager)</td></tr>
<tr class="memdesc:ga8584de0db0bbc62b70d5cf5089165ef2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the event manager with the default callback function for the 3 levels. <a href="group___e_v_e_n_t.html#ga8584de0db0bbc62b70d5cf5089165ef2">More...</a><br /></td></tr>
<tr class="separator:ga8584de0db0bbc62b70d5cf5089165ef2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implementation of a event callback system. </p>
<p>The functions in <a class="el" href="event_8c.html">EVENT.C</a> have for goal to send output messages (errors, warnings, debug) to the user. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a7323671f4df0a721ae02d610b1269ab9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define EVT_ERROR&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Error event type. </p>
<p>Referenced by <a class="el" href="group___j2_k.html#ga8ac7f0b9bc4281eb997aa24ef0f73edc">j2k_read_ppm_v3()</a>, <a class="el" href="group___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">opj_event_msg()</a>, <a class="el" href="group___j2_k.html#ga6eccbed87871df1973e7abbce54d4c3a">opj_j2k_check_poc_val()</a>, <a class="el" href="group___j2_k.html#gadaffc1a68a7cbfe82eca1f66e557d78d">opj_j2k_copy_default_tcp_and_create_tcd()</a>, <a class="el" href="group___j2_k.html#ga9e5d9046fb1e8a88af9a8787a551f00b">opj_j2k_create_tcd()</a>, <a class="el" href="j2k_8c.html#ae310be1158fc90d77b9f4bd2711069d2">opj_j2k_decode_one_tile()</a>, <a class="el" href="j2k_8h.html#a589edf58bf96de0a09b6104b6f5c13e8">opj_j2k_decode_tile()</a>, <a class="el" href="group___j2_k.html#ga1d061114982564d4b3e6670eb970744a">opj_j2k_decode_tiles()</a>, <a class="el" href="j2k_8h.html#af05dd7eedf751beb0033ac42de564fcc">opj_j2k_encode()</a>, <a class="el" href="group___j2_k.html#gab0e56426564c996f0ecab34a54391dcd">opj_j2k_encoding_validation()</a>, <a class="el" href="group___j2_k.html#ga01ad31cdc9b2d7478221f55f2aedf7f7">opj_j2k_get_sot_values()</a>, <a class="el" href="j2k_8h.html#a60371d3609364bf033e8c244599abf6f">opj_j2k_get_tile()</a>, <a class="el" href="group___j2_k.html#gab826458121cf85e37db0f19ba5d38551">opj_j2k_need_nb_tile_parts_correction()</a>, <a class="el" href="group___j2_k.html#gaf40fd184b6807439a992f4025890965d">opj_j2k_pre_write_tile()</a>, <a class="el" href="group___j2_k.html#gaf9452f058867874a2545ba57182ccded">opj_j2k_read_cbd()</a>, <a class="el" href="group___j2_k.html#gaf6e255d43d68436d57606f619980bf21">opj_j2k_read_coc()</a>, <a class="el" href="group___j2_k.html#gae37490bb6b2eb9a851e24c4a53aa6da0">opj_j2k_read_cod()</a>, <a class="el" href="group___j2_k.html#ga022938ad2bf4ddd1c3383a5f37841fad">opj_j2k_read_crg()</a>, <a class="el" href="group___j2_k.html#ga2f5300cfbe2bfc38a6250b24e48bd92d">opj_j2k_read_header_procedure()</a>, <a class="el" href="group___j2_k.html#ga461707ade3696cbfe5e0fe974995da82">opj_j2k_read_mcc()</a>, <a class="el" href="group___j2_k.html#gaf48ac7c1ee2fe7d1dcfafedf24dba699">opj_j2k_read_mco()</a>, <a class="el" href="group___j2_k.html#ga191850876c179e6f0ce484888df823ad">opj_j2k_read_mct()</a>, <a class="el" href="group___j2_k.html#gaea6560fe7ff48535d1f61eeaa0291728">opj_j2k_read_plm()</a>, <a class="el" href="group___j2_k.html#ga47f7cf1ce731b80ee0fb78545c761c59">opj_j2k_read_plt()</a>, <a class="el" href="group___j2_k.html#ga094ffbf4a7e4ab181717cfe32f95427b">opj_j2k_read_poc()</a>, <a class="el" href="group___j2_k.html#ga7715f2d96c40992acf9fd7739179b7ca">opj_j2k_read_ppt()</a>, <a class="el" href="group___j2_k.html#gae4bf5d4a61a9c7e8d5c4d4792becff28">opj_j2k_read_qcc()</a>, <a class="el" href="group___j2_k.html#gaf4edcf1840e794d3d3105bbd91c44c7b">opj_j2k_read_qcd()</a>, <a class="el" href="group___j2_k.html#ga2fcbe4a501bc0095f599de812323d62f">opj_j2k_read_rgn()</a>, <a class="el" href="group___j2_k.html#gaa91c21b73fc17028a77ba44d3987f17a">opj_j2k_read_siz()</a>, <a class="el" href="group___j2_k.html#ga4a8ad30a3df7afe15c5377a6f673f911">opj_j2k_read_soc()</a>, <a class="el" href="group___j2_k.html#gad5dccf955ddb9a446ed0132580dc1202">opj_j2k_read_sod()</a>, <a class="el" href="group___j2_k.html#gaa8746ccbc2a143739bc8f9eb2053d62d">opj_j2k_read_sot()</a>, <a class="el" href="group___j2_k.html#ga9c72aff84fb2321514f94a73a6ead932">opj_j2k_read_SPCod_SPCoc()</a>, <a class="el" href="group___j2_k.html#ga9c11b5d76c566db9a7fc2febbb19f1a8">opj_j2k_read_SQcd_SQcc()</a>, <a class="el" href="j2k_8h.html#a25b7b51949ceea33515984f1db2f594d">opj_j2k_read_tile_header()</a>, <a class="el" href="group___j2_k.html#gac4e1d91229956572f9a37707fddc69f6">opj_j2k_read_tlm()</a>, <a class="el" href="group___j2_k.html#gaacb9fc3e804ffdeff2b36f18754811ba">opj_j2k_read_unk()</a>, <a class="el" href="j2k_8h.html#ab4cb6916a495309faab2dd7cb587ccb8">opj_j2k_set_decode_area()</a>, <a class="el" href="j2k_8h.html#ad2c05f29bca659d072a13133993312f9">opj_j2k_set_decoded_resolution_factor()</a>, <a class="el" href="group___j2_k.html#ga4a6561d0899d91b38
</div>
</div>
<a class="anchor" id="a220921068c5e3c97c8f2ad4db0c60726"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define EVT_INFO&#160;&#160;&#160;4</td>
</tr>
</table>
</div><div class="memdoc">
<p>Debug event type. </p>
<p>Referenced by <a class="el" href="group___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">opj_event_msg()</a>, <a class="el" href="j2k_8c.html#ae310be1158fc90d77b9f4bd2711069d2">opj_j2k_decode_one_tile()</a>, <a class="el" href="group___j2_k.html#ga1d061114982564d4b3e6670eb970744a">opj_j2k_decode_tiles()</a>, <a class="el" href="group___j2_k.html#gaf40fd184b6807439a992f4025890965d">opj_j2k_pre_write_tile()</a>, <a class="el" href="group___j2_k.html#ga2f5300cfbe2bfc38a6250b24e48bd92d">opj_j2k_read_header_procedure()</a>, <a class="el" href="group___j2_k.html#ga4a8ad30a3df7afe15c5377a6f673f911">opj_j2k_read_soc()</a>, <a class="el" href="group___j2_k.html#gaa8746ccbc2a143739bc8f9eb2053d62d">opj_j2k_read_sot()</a>, <a class="el" href="j2k_8h.html#a25b7b51949ceea33515984f1db2f594d">opj_j2k_read_tile_header()</a>, <a class="el" href="j2k_8h.html#ab4cb6916a495309faab2dd7cb587ccb8">opj_j2k_set_decode_area()</a>, <a class="el" href="group___j_p2.html#gafa36e8ab92a1f64401ac805505480bff">opj_jp2_read_colr()</a>, <a class="el" href="group___j_p2.html#gab773a8e8abdae7b5745c6d787def2c79">opj_jp2_read_ihdr()</a>, <a class="el" href="group___c_i_o.html#ga3cb2e53726d5dde5a5f97f64a9e5f42d">opj_stream_flush()</a>, <a class="el" href="group___c_i_o.html#ga6102b5a73d4a0235e9cfa65d92a623dc">opj_stream_read_data()</a>, <a class="el" href="group___c_i_o.html#ga092c8153f29a4137728c6d79165c7e51">opj_stream_read_skip()</a>, and <a class="el" href="group___c_i_o.html#ga9e71a30be5af724e31c50066b7ff1128">opj_stream_write_skip()</a>.</p>
</div>
</div>
<a class="anchor" id="abefbcb0bea7916739b3adccb2d4e9417"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define EVT_WARNING&#160;&#160;&#160;2</td>
</tr>
</table>
</div><div class="memdoc">
<p>Warning event type. </p>
<p>Referenced by <a class="el" href="group___j2_k.html#ga8ac7f0b9bc4281eb997aa24ef0f73edc">j2k_read_ppm_v3()</a>, <a class="el" href="group___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">opj_event_msg()</a>, <a class="el" href="j2k_8c.html#ae310be1158fc90d77b9f4bd2711069d2">opj_j2k_decode_one_tile()</a>, <a class="el" href="j2k_8h.html#a589edf58bf96de0a09b6104b6f5c13e8">opj_j2k_decode_tile()</a>, <a class="el" href="group___j2_k.html#gade62a4b359f67adb04ac6203b01377fc">opj_j2k_is_cinema_compliant()</a>, <a class="el" href="group___j2_k.html#ga461707ade3696cbfe5e0fe974995da82">opj_j2k_read_mcc()</a>, <a class="el" href="group___j2_k.html#gaf48ac7c1ee2fe7d1dcfafedf24dba699">opj_j2k_read_mco()</a>, <a class="el" href="group___j2_k.html#ga191850876c179e6f0ce484888df823ad">opj_j2k_read_mct()</a>, <a class="el" href="group___j2_k.html#gae4bf5d4a61a9c7e8d5c4d4792becff28">opj_j2k_read_qcc()</a>, <a class="el" href="group___j2_k.html#gaa91c21b73fc17028a77ba44d3987f17a">opj_j2k_read_siz()</a>, <a class="el" href="group___j2_k.html#gaa8746ccbc2a143739bc8f9eb2053d62d">opj_j2k_read_sot()</a>, <a class="el" href="group___j2_k.html#ga9c11b5d76c566db9a7fc2febbb19f1a8">opj_j2k_read_SQcd_SQcc()</a>, <a class="el" href="j2k_8h.html#a25b7b51949ceea33515984f1db2f594d">opj_j2k_read_tile_header()</a>, <a class="el" href="group___j2_k.html#gaacb9fc3e804ffdeff2b36f18754811ba">opj_j2k_read_unk()</a>, <a class="el" href="group___j2_k.html#gad1b537156693dd455fd2daa002df6f4c">opj_j2k_set_cinema_parameters()</a>, <a class="el" href="j2k_8h.html#ab4cb6916a495309faab2dd7cb587ccb8">opj_j2k_set_decode_area()</a>, <a class="el" href="group___j2_k.html#ga4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>, <a class="el" href="group___j_p2.html#ga69b73f68c750cf70dc3b9836ed6ccfdc">opj_jp2_get_tile()</a>, <a class="el" href="group___j_p2.html#ga1afa753b2d1cbb745e0d844cc83eca42">opj_jp2_read_bpcc()</a>, <a class="el" href="group___j_p2.html#gafa36e8ab92a1f64401ac805505480bff">opj_jp2_read_colr()</a>, <a class="el" href="group___j_p2.html#ga94441c4e15ce0c7adfc3610152e630f2">opj_jp2_setup_encoder()</a>, <a class="el" href="group___t2.html#gaa8eb742f45bc236e6a76e6234b979b4e">opj_t2_read_packet_data()</a>, and <a class="el" href="group___t2.html#ga026199c0196bc54450e1d7bbef864e04">opj_t2_skip_packet_data()</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a4cba85f9ee037b1f2c6bceb903051d96"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structopj__event__mgr.html">opj_event_mgr</a> <a class="el" href="event_8h.html#a4cba85f9ee037b1f2c6bceb903051d96">opj_event_mgr_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Message handler object used for. </p>
<ul>
<li>
Error messages </li>
<li>
Warning messages </li>
<li>
Debugging messages </li>
</ul>
</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>