openjpeg/doxygen/group___e_v_e_n_t.html

141 lines
20 KiB
HTML
Raw Normal View History

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"/>
2020-12-28 22:12:25 +01:00
<meta name="generator" content="Doxygen 1.8.11"/>
2015-07-10 18:06:19 +02:00
<title>OpenJPEG: EVENT - Implementation of a event callback system</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;">
2016-09-29 22:38:29 +02:00
<td id="projectalign" style="padding-left: 0.5em;">
2015-07-10 18:06:19 +02:00
<div id="projectname">OpenJPEG
2020-12-28 22:12:25 +01:00
&#160;<span id="projectnumber">2.4.0</span>
2015-07-10 18:06:19 +02:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2020-12-28 22:12:25 +01:00
<!-- Generated by Doxygen 1.8.11 -->
<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 class="current"><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>
2015-07-10 18:06:19 +02:00
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">EVENT - Implementation of a event callback system</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Exported functions (see also openjpeg.h)</h2></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="#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="#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>
<h2 class="groupheader">Function Documentation</h2>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="ga87d9d4bdfd203ccd8a7522d6f197a3b7"></a>
2015-07-10 18:06:19 +02:00
<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_event_msg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="event_8h.html#a4cba85f9ee037b1f2c6bceb903051d96">opj_event_mgr_t</a> *&#160;</td>
<td class="paramname"><em>event_mgr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a>&#160;</td>
<td class="paramname"><em>event_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write formatted data to a string and send the string to a user callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">event_mgr</td><td>Event handler </td></tr>
<tr><td class="paramname">event_type</td><td>Event type or callback to use to send the message </td></tr>
<tr><td class="paramname">fmt</td><td>Format-control string (plus optional arguments)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if successful, returns false otherwise </dd></dl>
2020-12-28 22:12:25 +01:00
<p>References <a class="el" href="structopj__event__mgr.html#a9ee0c627fefd37d56e3487af6fc250b6">opj_event_mgr::error_handler</a>, <a class="el" href="event_8h.html#a7323671f4df0a721ae02d610b1269ab9">EVT_ERROR</a>, <a class="el" href="event_8h.html#a220921068c5e3c97c8f2ad4db0c60726">EVT_INFO</a>, <a class="el" href="event_8h.html#abefbcb0bea7916739b3adccb2d4e9417">EVT_WARNING</a>, <a class="el" href="structopj__event__mgr.html#ad60a40bbc655af631ec15f84ee45a708">opj_event_mgr::info_handler</a>, <a class="el" href="structopj__event__mgr.html#a551021914bcf2da3a212f1fd128da7d7">opj_event_mgr::m_error_data</a>, <a class="el" href="structopj__event__mgr.html#a914c15d0e74ed08bc54a93664df4402c">opj_event_mgr::m_info_data</a>, <a class="el" href="structopj__event__mgr.html#ae86cf70e19e00750bdf4df2fdae4f4b3">opj_event_mgr::m_warning_data</a>, <a class="el" href="openjpeg_8h.html#ac672bfd7db39c609e828acb07a321964">OPJ_FALSE</a>, <a class="el" href="event_8c.html#a04bd3229f3d8b05834a288b47949483e">OPJ_MSG_SIZE</a>, <a class="el" href="openjpeg_8h.html#a04830036d767cba56cbf5ae5bdc481d3">OPJ_TRUE</a>, and <a class="el" href="structopj__event__mgr.html#af0954e95dec628614f22a501f2b6ce9b">opj_event_mgr::warning_handler</a>.</p>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<p>Referenced by <a class="el" href="j2k_8c.html#a86642f524f2b96bb957e35f36760544d">opj_j2k_are_all_used_components_decoded()</a>, <a class="el" href="group___j2_k.html#ga3e22494d687c124eeeb079cc0b10edd1">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#ga7b5ed63aa196941746a348042a55dda3">opj_j2k_decode_tiles()</a>, <a class="el" href="j2k_8h.html#af05dd7eedf751beb0033ac42de564fcc">opj_j2k_encode()</a>, <a class="el" href="j2k_8h.html#a6b288ad7b1891bc2cdf593e8fa05cba6">opj_j2k_encoder_set_extra_options()</a>, <a class="el" href="group___j2_k.html#ga2ef076b003198ded3337ed8d5a641cf2">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#gacd8c13c7f20ddaca4fbb0aa886d40f18">opj_j2k_is_cinema_compliant()</a>, <a class="el" href="group___j2_k.html#ga0fc624268e8a9fb705da1f9b4cd47583">opj_j2k_is_imf_compliant()</a>, <a class="el" href="group___j2_k.html#ga5c7aed6778ebe582455869c5df435c5f">opj_j2k_merge_ppm()</a>, <a class="el" href="group___j2_k.html#gaffae175b58a2b960f035136d58bbaaf1">opj_j2k_merge_ppt()</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#ga0101959e0886beb63a1ff0c92742190d">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#ga445c467bde1da70f07c2cdcd3ffbc25c">opj_j2k_read_header_procedure()</a>, <a class="el" href="group___j2_k.html#ga0f83c1c3390f6368061b89b0e4dad91b">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#ga49665d853cbf934ca7ad0f83f4185a90">opj_j2k_read_ppm()</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#gaf1ac6b62e18b03816163369ec3a81eff">opj_j2k_read_sod()</a>, <a class="el" href="group___j2_k.html#ga935e4014c63e07bf19ad99584f6de430">opj_j2k_read_sot()</a>, <a class="el" href="group___j2_k.html#ga302098a94dfdd7406da50abc633720d8">opj_j2k_read_SPCod_SPCoc()</a>, <a class="el" href="group___j2_k.html#gad38da30797d61e64273836160152e557">opj_j2k_read_SQcd_SQcc()</a>, <a class="el" href="j2k_8h
2015-07-10 18:06:19 +02:00
</div>
</div>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="ga8584de0db0bbc62b70d5cf5089165ef2"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void opj_set_default_event_handler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="event_8h.html#a4cba85f9ee037b1f2c6bceb903051d96">opj_event_mgr_t</a> *&#160;</td>
<td class="paramname"><em>p_manager</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the event manager with the default callback function for the 3 levels. </p>
2020-12-28 22:12:25 +01:00
<p>References <a class="el" href="structopj__event__mgr.html#a9ee0c627fefd37d56e3487af6fc250b6">opj_event_mgr::error_handler</a>, <a class="el" href="structopj__event__mgr.html#ad60a40bbc655af631ec15f84ee45a708">opj_event_mgr::info_handler</a>, <a class="el" href="structopj__event__mgr.html#a551021914bcf2da3a212f1fd128da7d7">opj_event_mgr::m_error_data</a>, <a class="el" href="structopj__event__mgr.html#a914c15d0e74ed08bc54a93664df4402c">opj_event_mgr::m_info_data</a>, <a class="el" href="structopj__event__mgr.html#ae86cf70e19e00750bdf4df2fdae4f4b3">opj_event_mgr::m_warning_data</a>, <a class="el" href="event_8c.html#adf1fd54a14d1011ee5b9c5f0a3e99ac0">opj_default_callback()</a>, and <a class="el" href="structopj__event__mgr.html#af0954e95dec628614f22a501f2b6ce9b">opj_event_mgr::warning_handler</a>.</p>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<p>Referenced by <a class="el" href="openjpeg_8h.html#a990851329975143ee0ad6d9fdf461f06">opj_create_compress()</a>, and <a class="el" href="openjpeg_8h.html#a411e8a7a5ea89724038fd143a48a6892">opj_create_decompress()</a>.</p>
2015-07-10 18:06:19 +02:00
</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"/>
2020-12-28 22:12:25 +01:00
</a> 1.8.11
2015-07-10 18:06:19 +02:00
</small></address>
</body>
</html>