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

208 lines
19 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: image.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 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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">image.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="opj__includes_8h_source.html">opj_includes.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga83035109ca4e81f9d90451adf6d975b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___i_m_a_g_e.html#ga83035109ca4e81f9d90451adf6d975b4">opj_image_create0</a> (void)</td></tr>
<tr class="memdesc:ga83035109ca4e81f9d90451adf6d975b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an empty image. <a href="group___i_m_a_g_e.html#ga83035109ca4e81f9d90451adf6d975b4">More...</a><br /></td></tr>
<tr class="separator:ga83035109ca4e81f9d90451adf6d975b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a439566326ad0df2db2c9aef54098335e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *<a class="el" href="openjpeg_8h.html#aedc1e23ea6654d0cc416bc390687458b">OPJ_CALLCONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="image_8c.html#a439566326ad0df2db2c9aef54098335e">opj_image_create</a> (<a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> numcmpts, <a class="el" href="openjpeg_8h.html#ab25b37d58849efaebba4902660d7b4cc">opj_image_cmptparm_t</a> *cmptparms, <a class="el" href="openjpeg_8h.html#afc1dbd6789c60bcf6ebd32cc07575ac6">OPJ_COLOR_SPACE</a> clrspc)</td></tr>
<tr class="memdesc:a439566326ad0df2db2c9aef54098335e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an image. <a href="#a439566326ad0df2db2c9aef54098335e">More...</a><br /></td></tr>
<tr class="separator:a439566326ad0df2db2c9aef54098335e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a193f6a609b0a3c4aa4912be9c987cd14"><td class="memItemLeft" align="right" valign="top">void <a class="el" href="openjpeg_8h.html#aedc1e23ea6654d0cc416bc390687458b">OPJ_CALLCONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="image_8c.html#a193f6a609b0a3c4aa4912be9c987cd14">opj_image_destroy</a> (<a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *image)</td></tr>
<tr class="memdesc:a193f6a609b0a3c4aa4912be9c987cd14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deallocate any resources associated with an image. <a href="#a193f6a609b0a3c4aa4912be9c987cd14">More...</a><br /></td></tr>
<tr class="separator:a193f6a609b0a3c4aa4912be9c987cd14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa7b8e2985cd630021497528669063b7c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___i_m_a_g_e.html#gaa7b8e2985cd630021497528669063b7c">opj_image_comp_header_update</a> (<a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *p_image_header, const struct <a class="el" href="structopj__cp.html">opj_cp</a> *p_cp)</td></tr>
<tr class="memdesc:gaa7b8e2985cd630021497528669063b7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the components characteristics of the image from the coding parameters. <a href="group___i_m_a_g_e.html#gaa7b8e2985cd630021497528669063b7c">More...</a><br /></td></tr>
<tr class="separator:gaa7b8e2985cd630021497528669063b7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3802de36855e5331f4d6c04bc1b732a3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___i_m_a_g_e.html#ga3802de36855e5331f4d6c04bc1b732a3">opj_copy_image_header</a> (const <a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *p_image_src, <a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *p_image_dest)</td></tr>
<tr class="memdesc:ga3802de36855e5331f4d6c04bc1b732a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy only header of image and its component header (no data are copied) if dest image have data, they will be freed. <a href="group___i_m_a_g_e.html#ga3802de36855e5331f4d6c04bc1b732a3">More...</a><br /></td></tr>
<tr class="separator:ga3802de36855e5331f4d6c04bc1b732a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac70fc16e896c56053c1385b2d3e8e47"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *<a class="el" href="openjpeg_8h.html#aedc1e23ea6654d0cc416bc390687458b">OPJ_CALLCONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="image_8c.html#aac70fc16e896c56053c1385b2d3e8e47">opj_image_tile_create</a> (<a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> numcmpts, <a class="el" href="openjpeg_8h.html#ab25b37d58849efaebba4902660d7b4cc">opj_image_cmptparm_t</a> *cmptparms, <a class="el" href="openjpeg_8h.html#afc1dbd6789c60bcf6ebd32cc07575ac6">OPJ_COLOR_SPACE</a> clrspc)</td></tr>
<tr class="memdesc:aac70fc16e896c56053c1385b2d3e8e47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an image without allocating memory for the image (used in the new version of the library). <a href="#aac70fc16e896c56053c1385b2d3e8e47">More...</a><br /></td></tr>
<tr class="separator:aac70fc16e896c56053c1385b2d3e8e47"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a439566326ad0df2db2c9aef54098335e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a>* <a class="el" href="openjpeg_8h.html#aedc1e23ea6654d0cc416bc390687458b">OPJ_CALLCONV</a> opj_image_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
<td class="paramname"><em>numcmpts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#ab25b37d58849efaebba4902660d7b4cc">opj_image_cmptparm_t</a> *&#160;</td>
<td class="paramname"><em>cmptparms</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#afc1dbd6789c60bcf6ebd32cc07575ac6">OPJ_COLOR_SPACE</a>&#160;</td>
<td class="paramname"><em>clrspc</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an image. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">numcmpts</td><td>number of components </td></tr>
<tr><td class="paramname">cmptparms</td><td>components parameters </td></tr>
<tr><td class="paramname">clrspc</td><td>image color space </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>returns a new image structure if successful, returns NULL otherwise </dd></dl>
<p>References <a class="el" href="structopj__image__comp.html#a29e1e27c76fda74371c495e0cdfccd1d">opj_image_comp::bpp</a>, <a class="el" href="structopj__image__comptparm.html#abc64ebc6d3d148ad72171ae58b6b8c6b">opj_image_comptparm::bpp</a>, <a class="el" href="structopj__image.html#a0a905c725270c4a7085fbe1edea994c2">opj_image::color_space</a>, <a class="el" href="structopj__image.html#a6b52b100c934697a29446af5c3e0fa00">opj_image::comps</a>, <a class="el" href="structopj__image__comp.html#ad676bf364b0c8fc889e97cc684ce95d0">opj_image_comp::data</a>, <a class="el" href="structopj__image__comp.html#a0805d2f69bb770ff022c164aeda22685">opj_image_comp::dx</a>, <a class="el" href="structopj__image__comptparm.html#a709dcaed22eaba4f946e9ca3938b41b5">opj_image_comptparm::dx</a>, <a class="el" href="structopj__image__comp.html#af9d6fd62a2b8bdd9fd162ce403eb0f10">opj_image_comp::dy</a>, <a class="el" href="structopj__image__comptparm.html#aca10e7f31cbd3ebee3601532d19333de">opj_image_comptparm::dy</a>, <a class="el" href="structopj__image__comp.html#a11ecb361a0c49b482c90573a868cc8dc">opj_image_comp::h</a>, <a class="el" href="structopj__image__comptparm.html#a9a262042a9c180f5b236145ef7f52553">opj_image_comptparm::h</a>, <a class="el" href="structopj__image.html#ac63093741ed0c70b9c0a8ee3070cbce6">opj_image::numcomps</a>, <a class="el" href="group___m_i_s_c.html#ga1fb8ed2c030462ba457fbaaf182f4809">opj_calloc</a>, <a class="el" href="image_8c.html#a193f6a609b0a3c4aa4912be9c987cd14">opj_image_destroy()</a>, <a class="el" href="structopj__image__comp.html#ab7210ddbf12e6d9998d24034a579cea1">opj_image_comp::prec</a>, <a class="el" href="structopj__image__comptparm.html#ac9a9f971df431df4ae59b94ad15f7ecf">opj_image_comptparm::prec</a>, <a class="el" href="structopj__image__comp.html#a2d2337d15fd837252fe250386bac7fb9">opj_image_comp::sgnd</a>, <a class="el" href="structopj__image__comptparm.html#ab04dc3080a225270b23417b1d591ff38">opj_image_comptparm::sgnd</a>, <a class="el" href="structopj__image__comp.html#a59225121158d5bc911838e5b05779cdb">opj_image_comp::w</a>, <a class="el" href="structopj__image__comptparm.html#af83b657b54cb33fe3021656d27a76002">opj_image_comptparm::w</a>, <a class="el" href="structopj__image__comp.html#a1f897a8932374ca64cd4d7a256008ea3">opj_image_comp::x0</a>, <a class="el" href="structopj__image__comptparm.html#a384f4f3280e19b98e5fc0b67cd4fc02a">opj_image_comptparm::x0</a>, <a class="el" href="structopj__image__comp.html#aa8dff1eb1f11e9f21b0ddefe14ad3fc6">opj_image_comp::y0</a>, and <a class="el" href="structopj__image__comptparm.html#a8789a74e9825d51a1aa99021c2273746">opj_image_comptparm::y0</a>.</p>
</div>
</div>
<a class="anchor" id="a193f6a609b0a3c4aa4912be9c987cd14"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="openjpeg_8h.html#aedc1e23ea6654d0cc416bc390687458b">OPJ_CALLCONV</a> opj_image_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *&#160;</td>
<td class="paramname"><em>image</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deallocate any resources associated with an image. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>image to be destroyed </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="structopj__image.html#a6b52b100c934697a29446af5c3e0fa00">opj_image::comps</a>, <a class="el" href="structopj__image__comp.html#ad676bf364b0c8fc889e97cc684ce95d0">opj_image_comp::data</a>, <a class="el" href="structopj__image.html#a1b62a25bd7603c6747aa3edd036401c1">opj_image::icc_profile_buf</a>, <a class="el" href="structopj__image.html#ac63093741ed0c70b9c0a8ee3070cbce6">opj_image::numcomps</a>, and <a class="el" href="group___m_i_s_c.html#ga700b1aef6148bd6c3edde626610ffe2f">opj_free</a>.</p>
<p>Referenced by <a class="el" href="jp2k__decoder_8h.html#a261799e8487d1b77fc04948abe701e5f">j2k_to_pnm()</a>, <a class="el" href="openjpeg_8h.html#af168cf4a4295433c8c33610bac614553">opj_image_create()</a>, <a class="el" href="openjpeg_8h.html#a2b29bd52d3b2bcc2d3e0d95db66fbd5f">opj_image_tile_create()</a>, <a class="el" href="j2k_8h.html#a09f2c6c83d8066e1db9ab66fed58d9c8">opj_j2k_decode()</a>, <a class="el" href="j2k_8h.html#a5c4508543b134e726107308b6463528e">opj_j2k_destroy()</a>, <a class="el" href="j2k_8h.html#a60371d3609364bf033e8c244599abf6f">opj_j2k_get_tile()</a>, and <a class="el" href="j2k_8h.html#a34c49b256edcdbf036492dfa635284d7">opj_j2k_read_header()</a>.</p>
</div>
</div>
<a class="anchor" id="aac70fc16e896c56053c1385b2d3e8e47"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a>* <a class="el" href="openjpeg_8h.html#aedc1e23ea6654d0cc416bc390687458b">OPJ_CALLCONV</a> opj_image_tile_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
<td class="paramname"><em>numcmpts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#ab25b37d58849efaebba4902660d7b4cc">opj_image_cmptparm_t</a> *&#160;</td>
<td class="paramname"><em>cmptparms</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#afc1dbd6789c60bcf6ebd32cc07575ac6">OPJ_COLOR_SPACE</a>&#160;</td>
<td class="paramname"><em>clrspc</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an image without allocating memory for the image (used in the new version of the library). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">numcmpts</td><td>the number of components </td></tr>
<tr><td class="paramname">cmptparms</td><td>the components parameters </td></tr>
<tr><td class="paramname">clrspc</td><td>the image color space</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a new image structure if successful, NULL otherwise. </dd></dl>
<p>References <a class="el" href="structopj__image.html#a0a905c725270c4a7085fbe1edea994c2">opj_image::color_space</a>, <a class="el" href="structopj__image.html#a6b52b100c934697a29446af5c3e0fa00">opj_image::comps</a>, <a class="el" href="structopj__image__comp.html#ad676bf364b0c8fc889e97cc684ce95d0">opj_image_comp::data</a>, <a class="el" href="structopj__image__comp.html#a0805d2f69bb770ff022c164aeda22685">opj_image_comp::dx</a>, <a class="el" href="structopj__image__comptparm.html#a709dcaed22eaba4f946e9ca3938b41b5">opj_image_comptparm::dx</a>, <a class="el" href="structopj__image__comp.html#af9d6fd62a2b8bdd9fd162ce403eb0f10">opj_image_comp::dy</a>, <a class="el" href="structopj__image__comptparm.html#aca10e7f31cbd3ebee3601532d19333de">opj_image_comptparm::dy</a>, <a class="el" href="structopj__image__comp.html#a11ecb361a0c49b482c90573a868cc8dc">opj_image_comp::h</a>, <a class="el" href="structopj__image__comptparm.html#a9a262042a9c180f5b236145ef7f52553">opj_image_comptparm::h</a>, <a class="el" href="structopj__image.html#ac63093741ed0c70b9c0a8ee3070cbce6">opj_image::numcomps</a>, <a class="el" href="group___m_i_s_c.html#ga1fb8ed2c030462ba457fbaaf182f4809">opj_calloc</a>, <a class="el" href="image_8c.html#a193f6a609b0a3c4aa4912be9c987cd14">opj_image_destroy()</a>, <a class="el" href="structopj__image__comp.html#ab7210ddbf12e6d9998d24034a579cea1">opj_image_comp::prec</a>, <a class="el" href="structopj__image__comptparm.html#ac9a9f971df431df4ae59b94ad15f7ecf">opj_image_comptparm::prec</a>, <a class="el" href="structopj__image__comp.html#a2d2337d15fd837252fe250386bac7fb9">opj_image_comp::sgnd</a>, <a class="el" href="structopj__image__comptparm.html#ab04dc3080a225270b23417b1d591ff38">opj_image_comptparm::sgnd</a>, <a class="el" href="structopj__image__comp.html#a59225121158d5bc911838e5b05779cdb">opj_image_comp::w</a>, <a class="el" href="structopj__image__comptparm.html#af83b657b54cb33fe3021656d27a76002">opj_image_comptparm::w</a>, <a class="el" href="structopj__image__comp.html#a1f897a8932374ca64cd4d7a256008ea3">opj_image_comp::x0</a>, <a class="el" href="structopj__image__comptparm.html#a384f4f3280e19b98e5fc0b67cd4fc02a">opj_image_comptparm::x0</a>, <a class="el" href="structopj__image__comp.html#aa8dff1eb1f11e9f21b0ddefe14ad3fc6">opj_image_comp::y0</a>, and <a class="el" href="structopj__image__comptparm.html#a8789a74e9825d51a1aa99021c2273746">opj_image_comptparm::y0</a>.</p>
</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>