gil/io/base.hpp

0001 //
0002 // Copyright 2007-2008 Christian Henning, Andreas Pokorny, Lubomir Bourdev
0003 //
0004 // Distributed under the Boost Software License, Version 1.0
0005 // See accompanying file LICENSE_1_0.txt or copy at
0006 // http://www.boost.org/LICENSE_1_0.txt
0007 //
0008 #ifndef BOOST_GIL_IO_BASE_HPP
0009 #define BOOST_GIL_IO_BASE_HPP
0010
0011 #include <boost/gil/extension/toolbox/toolbox.hpp>
0012
0013 #include <boost/gil/bit_aligned_pixel_reference.hpp>
0014 #include <boost/gil/bit_aligned_pixel_iterator.hpp>
0015 #include <boost/gil/color_convert.hpp>
0016 #include <boost/gil/utilities.hpp>
0017 #include <boost/gil/io/error.hpp>
0018 #include <boost/gil/io/typedefs.hpp>
0019
0020 #include <istream>
0021 #include <ostream>
0022 #include <type_traits>
0023 #include <vector>
0024
0025 namespace boost { namespace gil {
0026
0027 struct format_tag {};
0028
0029 template< typename Property >
0030 struct property_base
0031 {
0032     using type = Property;
0033 };
0034
0035 template<typename FormatTag>
0036 struct is_format_tag : std::is_base_of<format_tag, FormatTag> {};
0037
0038 struct image_read_settings_base
0039 {
0040 protected:
0041
0042     image_read_settings_base()
0043     : _top_left( 0, 0 )
0044     , _dim     ( 0, 0 )
0045     {}
0046
0047     image_read_settings_base( point_t const& top_left
0048                             , point_t const& dim
0049                             )
0050     : _top_left( top_left )
0051     , _dim     ( dim      )
0052     {}
0053
0054
0055 public:
0056
0057     void set( point_t const& top_left
0058             , point_t const& dim
0059             )
0060     {
0061         _top_left = top_left;
0062         _dim      = dim;
0063     }
0064
0065 public:
0066
0067     point_t _top_left;
0068     point_t _dim;
0069 };
0070
0071 /**
0072  * Boolean meta function, std::true_type if the pixel type \a PixelType is supported
0073  * by the image format identified with \a FormatTag.
0074  * \todo the name is_supported is to generic, pick something more IO realted.
0075  */
0076 // Depending on image type the parameter Pixel can be a reference type
0077 // for bit_aligned images or a pixel for byte images.
0078 template< typename Pixel, typename FormatTag > struct is_read_supported {};
0079 template< typename Pixel, typename FormatTag > struct is_write_supported {};
0080
0081
0082 namespace detail {
0083
0084 template< typename Property >
0085 struct property_base
0086 {
0087     using type = Property;
0088 };
0089
0090 } // namespace detail
0091
0092 struct read_support_true  { static constexpr bool is_supported = true; };
0093 struct read_support_false { static constexpr bool is_supported = false; };
0094 struct write_support_true { static constexpr bool is_supported = true; };
0095 struct write_support_false{ static constexpr bool is_supported = false; };
0096
0097 class no_log {};
0098
0099 template< typename Device, typename FormatTag > struct reader_backend;
0100 template< typename Device, typename FormatTag > struct writer_backend;
0101
0102 template< typename FormatTag > struct image_read_info;
0103 template< typename FormatTag > struct image_read_settings;
0104 template< typename FormatTag, typename Log = no_log > struct image_write_info;
0105
0106 } // namespace gil
0107 } // namespace boost
0108
0109 #endif