<!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.8"/> <title>Exiv2: Exiv2::Internal::PngChunk Class 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="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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">Exiv2 </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.8 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceExiv2.html">Exiv2</a></li><li class="navelem"><a class="el" href="namespaceExiv2_1_1Internal.html">Internal</a></li><li class="navelem"><a class="el" href="classExiv2_1_1Internal_1_1PngChunk.html">PngChunk</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="classExiv2_1_1Internal_1_1PngChunk-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Exiv2::Internal::PngChunk Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>Stateless parser class for data in PNG chunk format. Images use this class to decode and encode PNG-based data. <a href="classExiv2_1_1Internal_1_1PngChunk.html#details">More...</a></p> <p><code>#include <pngchunk_int.hpp></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:a9a05f1f7d1b88f8e869813f6b318fd35"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a05f1f7d1b88f8e869813f6b318fd35"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Internal_1_1PngChunk.html#a9a05f1f7d1b88f8e869813f6b318fd35">TxtChunkType</a> { <b>tEXt_Chunk</b> = 0, <b>zTXt_Chunk</b> = 1, <b>iTXt_Chunk</b> = 2 }</td></tr> <tr class="memdesc:a9a05f1f7d1b88f8e869813f6b318fd35"><td class="mdescLeft"> </td><td class="mdescRight">Text Chunk types. <br /></td></tr> <tr class="separator:a9a05f1f7d1b88f8e869813f6b318fd35"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:a95c8bcca87e7e7b73466a024d36abdc2"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Internal_1_1PngChunk.html#a95c8bcca87e7e7b73466a024d36abdc2">decodeIHDRChunk</a> (const <a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> &data, int *outWidth, int *outHeight)</td></tr> <tr class="memdesc:a95c8bcca87e7e7b73466a024d36abdc2"><td class="mdescLeft"> </td><td class="mdescRight">Decode PNG IHDR chunk data from a data buffer <em>data</em> and return image size to <em>outWidth</em> and <em>outHeight</em>. <a href="#a95c8bcca87e7e7b73466a024d36abdc2">More...</a><br /></td></tr> <tr class="separator:a95c8bcca87e7e7b73466a024d36abdc2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa0d25553b739b31d23f3c63f89f84dc7"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Internal_1_1PngChunk.html#aa0d25553b739b31d23f3c63f89f84dc7">decodeTXTChunk</a> (<a class="el" href="classExiv2_1_1Image.html">Image</a> *pImage, const <a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> &data, <a class="el" href="classExiv2_1_1Internal_1_1PngChunk.html#a9a05f1f7d1b88f8e869813f6b318fd35">TxtChunkType</a> type)</td></tr> <tr class="memdesc:aa0d25553b739b31d23f3c63f89f84dc7"><td class="mdescLeft"> </td><td class="mdescRight">Decode PNG tEXt, zTXt, or iTXt chunk data from <em>pImage</em> passed by data buffer <em>data</em> and extract Comment, Exif, Iptc, Xmp metadata accordingly. <a href="#aa0d25553b739b31d23f3c63f89f84dc7">More...</a><br /></td></tr> <tr class="separator:aa0d25553b739b31d23f3c63f89f84dc7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a03608e8b2950d894bc52c8c0bca3df77"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Internal_1_1PngChunk.html#a03608e8b2950d894bc52c8c0bca3df77">keyTXTChunk</a> (const <a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> &data, bool stripHeader=false)</td></tr> <tr class="memdesc:a03608e8b2950d894bc52c8c0bca3df77"><td class="mdescLeft"> </td><td class="mdescRight">Return PNG TXT chunk key as data buffer. <a href="#a03608e8b2950d894bc52c8c0bca3df77">More...</a><br /></td></tr> <tr class="separator:a03608e8b2950d894bc52c8c0bca3df77"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af11fcb9508b26ea787bfb539fc69d350"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Internal_1_1PngChunk.html#af11fcb9508b26ea787bfb539fc69d350">makeMetadataChunk</a> (const std::string &metadata, <a class="el" href="namespaceExiv2.html#acca494c8cf80f3ac8a804e1b54afffca">MetadataId</a> type)</td></tr> <tr class="memdesc:af11fcb9508b26ea787bfb539fc69d350"><td class="mdescLeft"> </td><td class="mdescRight">Return a complete PNG chunk data compressed or not as buffer. Data returned is formated accordingly with metadata <em>type</em> to host passed by <em>metadata</em>. <a href="#af11fcb9508b26ea787bfb539fc69d350">More...</a><br /></td></tr> <tr class="separator:af11fcb9508b26ea787bfb539fc69d350"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Stateless parser class for data in PNG chunk format. Images use this class to decode and encode PNG-based data. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a95c8bcca87e7e7b73466a024d36abdc2"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void Exiv2::Internal::PngChunk::decodeIHDRChunk </td> <td>(</td> <td class="paramtype">const <a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> & </td> <td class="paramname"><em>data</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int * </td> <td class="paramname"><em>outWidth</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int * </td> <td class="paramname"><em>outHeight</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Decode PNG IHDR chunk data from a data buffer <em>data</em> and return image size to <em>outWidth</em> and <em>outHeight</em>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">data</td><td>PNG Chunk data buffer. </td></tr> <tr><td class="paramname">outWidth</td><td>Integer pointer to be set to the width of the image. </td></tr> <tr><td class="paramname">outHeight</td><td>Integer pointer to be set to the height of the image. </td></tr> </table> </dd> </dl> <p>References <a class="el" href="namespaceExiv2.html#aaaa13407701ef70800058a760e8be52e">Exiv2::getLong()</a>, and <a class="el" href="classExiv2_1_1DataBuf.html#a9a00173081c913d3add58854d9ad2c39">Exiv2::DataBuf::pData_</a>.</p> <p>Referenced by <a class="el" href="classExiv2_1_1PngImage.html#a2a0f0ed945a729104c01a851094150e7">Exiv2::PngImage::readMetadata()</a>.</p> </div> </div> <a class="anchor" id="aa0d25553b739b31d23f3c63f89f84dc7"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void Exiv2::Internal::PngChunk::decodeTXTChunk </td> <td>(</td> <td class="paramtype"><a class="el" href="classExiv2_1_1Image.html">Image</a> * </td> <td class="paramname"><em>pImage</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> & </td> <td class="paramname"><em>data</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classExiv2_1_1Internal_1_1PngChunk.html#a9a05f1f7d1b88f8e869813f6b318fd35">TxtChunkType</a> </td> <td class="paramname"><em>type</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Decode PNG tEXt, zTXt, or iTXt chunk data from <em>pImage</em> passed by data buffer <em>data</em> and extract Comment, Exif, Iptc, Xmp metadata accordingly. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pImage</td><td>Pointer to the image to hold the metadata </td></tr> <tr><td class="paramname">data</td><td>PNG Chunk data buffer. </td></tr> <tr><td class="paramname">type</td><td>PNG Chunk TXT type. </td></tr> </table> </dd> </dl> <p>References <a class="el" href="classExiv2_1_1Internal_1_1PngChunk.html#a03608e8b2950d894bc52c8c0bca3df77">keyTXTChunk()</a>, <a class="el" href="classExiv2_1_1DataBuf.html#a9a00173081c913d3add58854d9ad2c39">Exiv2::DataBuf::pData_</a>, <a class="el" href="classExiv2_1_1DataBuf.html#a5e6028d5cdae2e149749667cf66c3e91">Exiv2::DataBuf::size_</a>, and <a class="el" href="namespaceExiv2.html#a5153319711f35fe81cbc13f4b852450ca2d79fb07c9ec891f281968dad43c1e25">Exiv2::string</a>.</p> <p>Referenced by <a class="el" href="classExiv2_1_1PngImage.html#a2a0f0ed945a729104c01a851094150e7">Exiv2::PngImage::readMetadata()</a>.</p> </div> </div> <a class="anchor" id="a03608e8b2950d894bc52c8c0bca3df77"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> Exiv2::Internal::PngChunk::keyTXTChunk </td> <td>(</td> <td class="paramtype">const <a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> & </td> <td class="paramname"><em>data</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>stripHeader</em> = <code>false</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return PNG TXT chunk key as data buffer. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">data</td><td>PNG Chunk data buffer. </td></tr> <tr><td class="paramname">stripHeader</td><td>Set true if chunk data start with header bytes, else false (default). </td></tr> </table> </dd> </dl> <p>References <a class="el" href="classExiv2_1_1DataBuf.html#a9a00173081c913d3add58854d9ad2c39">Exiv2::DataBuf::pData_</a>, and <a class="el" href="classExiv2_1_1DataBuf.html#a5e6028d5cdae2e149749667cf66c3e91">Exiv2::DataBuf::size_</a>.</p> <p>Referenced by <a class="el" href="classExiv2_1_1Internal_1_1PngChunk.html#aa0d25553b739b31d23f3c63f89f84dc7">decodeTXTChunk()</a>.</p> </div> </div> <a class="anchor" id="af11fcb9508b26ea787bfb539fc69d350"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">std::string Exiv2::Internal::PngChunk::makeMetadataChunk </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>metadata</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="namespaceExiv2.html#acca494c8cf80f3ac8a804e1b54afffca">MetadataId</a> </td> <td class="paramname"><em>type</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return a complete PNG chunk data compressed or not as buffer. Data returned is formated accordingly with metadata <em>type</em> to host passed by <em>metadata</em>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">metadata</td><td>metadata buffer. </td></tr> <tr><td class="paramname">type</td><td>metadata type. </td></tr> </table> </dd> </dl> <p>References <a class="el" href="namespaceExiv2.html#a5153319711f35fe81cbc13f4b852450ca2d79fb07c9ec891f281968dad43c1e25">Exiv2::string</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="pngchunk__int_8hpp.html">pngchunk_int.hpp</a></li> <li>pngchunk.cpp</li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Thu Oct 26 2017 16:50:15 for Exiv2 by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.8 </small></address> </body> </html>