76 lines
8.0 KiB
HTML
76 lines
8.0 KiB
HTML
<!-- HTML header for doxygen 1.8.13-->
|
|
<!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.15"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Generic Image Library: Adding a new io backend</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" />
|
|
<link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div class="boost-header">
|
|
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
|
|
<tr>
|
|
<td valign="top" width="300">
|
|
<h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
|
|
</td>
|
|
<td ><h1 align="center"><a href="../index.html"></a></h1></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<hr/>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search');
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div class="PageDoc"><div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Adding a new io backend </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><h1><a class="anchor" id="Overview"></a>
|
|
of backend requirements</h1>
|
|
<p>To add support for a new IO backend the following is required:</p><ul>
|
|
<li>a format tag, to identify the image format, derived from boost::gil::format_tag</li>
|
|
<li>boolean meta function is_supported<PixelType,FormatTag> must be implemented for the new format tag</li>
|
|
<li>explicit specialisation of image_read_info<FormatTag> must be provided, containing runtime information available before/at reading the image</li>
|
|
<li>explicit specialisation of image_write_info<FormatTag> must be provided, containing runtime encoding parameters for writing an image</li>
|
|
<li>An image reader must be specialized: <div class="fragment"><div class="line"><span class="keyword">template</span><<span class="keyword">typename</span> IODevice, <span class="keyword">typename</span> ConversionPolicy></div><div class="line"><span class="keyword">struct </span>boost::gil::reader<IODevice,FormatTag,ConversionPolicy></div><div class="line">{</div><div class="line"> reader( IODevice & device )</div><div class="line"> reader( IODevice & device, <span class="keyword">typename</span> ConversionPolicy::color_converter_type <span class="keyword">const</span>& cc )</div><div class="line"> image_read_info<FormatTag> get_info();</div><div class="line"> <span class="keyword">template</span><<span class="keyword">typename</span> Image></div><div class="line"> <span class="keywordtype">void</span> <a class="code" href="group___i_o.html#gac1e65b2ad8cd28fe8d694f1663df0d78">read_image</a>( Image &, point_t <span class="keyword">const</span>& top_left );</div><div class="line"> <span class="keyword">template</span><<span class="keyword">typename</span> View></div><div class="line"> <span class="keywordtype">void</span> <a class="code" href="group___i_o.html#ga9b5ae3d12c73aa1d81245fd5f8772847">read_view</a>( View &, point_t <span class="keyword">const</span>& top_left );</div><div class="line">};</div></div><!-- fragment --></li>
|
|
<li>An image writer must be specialized: <div class="fragment"><div class="line">\template <typename IODevice></div><div class="line"><span class="keyword">struct </span>boost::gil::writer<IODevice,FormatTag></div><div class="line">{</div><div class="line"> writer( IODevice & device )</div><div class="line"> <span class="keyword">template</span><<span class="keyword">typename</span> View></div><div class="line"> <span class="keywordtype">void</span> apply( View <span class="keyword">const</span>&, point_t <span class="keyword">const</span>& top_left );</div><div class="line"> <span class="keyword">template</span><<span class="keyword">typename</span> View></div><div class="line"> <span class="keywordtype">void</span> apply( View <span class="keyword">const</span>&, point_t <span class="keyword">const</span>& top_left, image_write_info<FormatTag> <span class="keyword">const</span>& );</div><div class="line">};</div></div><!-- fragment --></li>
|
|
</ul>
|
|
<p>Or instead of the items above implement overloads of read_view, read_and_convert_view, read_image, read_and_convert_image, write_view and read_image_info.</p>
|
|
<h1><a class="anchor" id="ConversionPolicy"></a>
|
|
Interface of the ConversionPolicy</h1>
|
|
<p>There are two different conversion policies in use, when reading images: read_and_convert<ColorConverter> and read_and_no_convert. ColorConverter can be a user defined color converter.</p>
|
|
<div class="fragment"><div class="line"><span class="keyword">struct </span>ConversionPolicy</div><div class="line">{</div><div class="line"> <span class="keyword">template</span><<span class="keyword">typename</span> InputIterator,<span class="keyword">typename</span> OutputIterator></div><div class="line"> <span class="keywordtype">void</span> read( InputIterator in_begin, InputIterator in_end,</div><div class="line"> OutputIterator out_end );</div><div class="line">};</div></div><!-- fragment --><p>Methods like read_view and read_image are supposed to bail out with an exception instead of converting the image</p>
|
|
<h1><a class="anchor" id="IODevice"></a>
|
|
Concept of IO Device</h1>
|
|
<p>A Device is simply an object used to read and write data to and from a stream. The IODevice was added as a template paramter to be able to replace the file_name access functionality. This is only an interim solution, as soon as boost provides a good IO library, interfaces/constraints provided by that library could be used.</p>
|
|
<div class="fragment"><div class="line">concept IODevice</div><div class="line">{</div><div class="line"> <span class="keywordtype">void</span> IODevice::read( <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* data, <span class="keywordtype">int</span> count );</div><div class="line"> <span class="keywordtype">void</span> IODevice::write( <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* data, <span class="keywordtype">int</span> count );</div><div class="line"> <span class="keywordtype">void</span> IODevice::seek(<span class="keywordtype">long</span> count, <span class="keywordtype">int</span> whence);</div><div class="line"> <span class="keywordtype">void</span> IODevice::flush();</div><div class="line">};</div></div><!-- fragment --><p>For the time being a boolean meta function must be specialized: </p><div class="fragment"><div class="line"><span class="keyword">namespace </span>boost{<span class="keyword">namespace </span>gil{<span class="keyword">namespace </span>detail{</div><div class="line"> <span class="keyword">template</span><<span class="keyword">typename</span> Device></div><div class="line"> <span class="keyword">struct </span>detail::is_input_device;</div><div class="line">}}}</div></div><!-- fragment --> </div></div><!-- PageDoc -->
|
|
</div><!-- contents -->
|
|
<!-- HTML footer for doxygen 1.8.13-->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/>
|
|
<address class="footer">
|
|
<small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
|
|
</small>
|
|
</address>
|
|
</body>
|
|
</html>
|