Chris@16: /*
Chris@16:     Copyright 2005-2007 Adobe Systems Incorporated
Chris@16:    
Chris@16:     Use, modification and distribution are subject to the Boost Software License,
Chris@16:     Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
Chris@16:     http://www.boost.org/LICENSE_1_0.txt).
Chris@16: 
Chris@16:     See http://opensource.adobe.com/gil for most recent version including documentation.
Chris@16: */
Chris@16: 
Chris@16: /*************************************************************************************************/
Chris@16: 
Chris@16: #ifndef GIL_METAFUNCTIONS_HPP
Chris@16: #define GIL_METAFUNCTIONS_HPP
Chris@16: 
Chris@16: ////////////////////////////////////////////////////////////////////////////////////////
Chris@16: /// \file               
Chris@16: /// \brief metafunctions that construct types or return type properties
Chris@16: /// \author Lubomir Bourdev and Hailin Jin \n
Chris@16: ///         Adobe Systems Incorporated
Chris@16: ///
Chris@16: /// \date 2005-2007 \n Last updated on February 6, 2007
Chris@16: ///
Chris@16: ////////////////////////////////////////////////////////////////////////////////////////
Chris@16: 
Chris@16: #include <iterator>
Chris@16: #include <boost/mpl/accumulate.hpp>
Chris@16: #include <boost/mpl/back.hpp>
Chris@16: #include <boost/mpl/bool.hpp>
Chris@16: #include <boost/mpl/if.hpp>
Chris@16: #include <boost/mpl/pop_back.hpp>
Chris@16: #include <boost/mpl/push_back.hpp>
Chris@16: #include <boost/mpl/transform.hpp>
Chris@16: #include <boost/mpl/vector.hpp>
Chris@16: #include <boost/type_traits.hpp>
Chris@16: #include "gil_config.hpp"
Chris@16: #include "gil_concept.hpp"
Chris@16: #include "channel.hpp"
Chris@16: 
Chris@16: namespace boost { namespace gil {
Chris@16: 
Chris@16: // forward declarations
Chris@16: template <typename T, typename L> struct pixel;
Chris@16: template <typename BitField,typename ChannelRefVec,typename Layout> struct packed_pixel;
Chris@16: template <typename T, typename C> struct planar_pixel_reference;
Chris@16: template <typename IC, typename C> struct planar_pixel_iterator;
Chris@16: template <typename I> class memory_based_step_iterator;
Chris@16: template <typename I> class memory_based_2d_locator;
Chris@16: template <typename L> class image_view;
Chris@16: template <typename Pixel, bool IsPlanar, typename Alloc> class image;
Chris@16: template <typename T> struct channel_type;
Chris@16: template <typename T> struct color_space_type;
Chris@16: template <typename T> struct channel_mapping_type;
Chris@16: template <typename It> struct is_iterator_adaptor;
Chris@16: template <typename It> struct iterator_adaptor_get_base;
Chris@16: template <typename BitField, typename ChannelBitSizes, typename Layout, bool IsMutable> struct bit_aligned_pixel_reference;
Chris@16: 
Chris@16: //////////////////////////////////////////////////
Chris@16: ///
Chris@16: ///  TYPE ANALYSIS METAFUNCTIONS
Chris@16: ///  Predicate metafunctions determining properties of GIL types
Chris@16: ///
Chris@16: //////////////////////////////////////////////////
Chris@16: 
Chris@16: 
Chris@16: /// \defgroup GILIsBasic xxx_is_basic
Chris@16: /// \ingroup TypeAnalysis
Chris@16: /// \brief Determines if GIL constructs are basic. 
Chris@16: ///    Basic constructs are the ones that can be generated with the type 
Chris@16: ///    factory methods pixel_reference_type, iterator_type, locator_type, view_type and image_type
Chris@16: ///    They can be mutable/immutable, planar/interleaved, step/nonstep. They must use GIL-provided models.
Chris@16: 
Chris@16: /// \brief Determines if a given pixel reference is basic
Chris@16: ///    Basic references must use gil::pixel& (if interleaved), gil::planar_pixel_reference (if planar). They must use the standard constness rules. 
Chris@16: /// \ingroup GILIsBasic
Chris@16: template <typename PixelRef>        struct pixel_reference_is_basic                     : public mpl::false_ {};
Chris@16: template <typename T,  typename L>  struct pixel_reference_is_basic<      pixel<T,L>&>  : public mpl::true_ {};
Chris@16: template <typename T,  typename L>  struct pixel_reference_is_basic<const pixel<T,L>&>  : public mpl::true_ {};
Chris@16: template <typename TR, typename Cs> struct pixel_reference_is_basic<planar_pixel_reference<TR,Cs> > : public mpl::true_ {};
Chris@16: template <typename TR, typename Cs> struct pixel_reference_is_basic<const planar_pixel_reference<TR,Cs> > : public mpl::true_ {};
Chris@16: 
Chris@16: 
Chris@16: /// \brief Determines if a given pixel iterator is basic
Chris@16: ///    Basic iterators must use gil::pixel (if interleaved), gil::planar_pixel_iterator (if planar) and gil::memory_based_step_iterator (if step). They must use the standard constness rules. 
Chris@16: /// \ingroup GILIsBasic
Chris@16: template <typename Iterator>
Chris@16: struct iterator_is_basic : public mpl::false_ {};
Chris@16: template <typename T, typename L>  // mutable   interleaved
Chris@16: struct iterator_is_basic<      pixel<T,L>*      > : public mpl::true_ {};
Chris@16: template <typename T, typename L>  // immutable interleaved
Chris@16: struct iterator_is_basic<const pixel<T,L>*      > : public mpl::true_ {};
Chris@16: template <typename T, typename Cs>  // mutable   planar
Chris@16: struct iterator_is_basic<planar_pixel_iterator<      T*,Cs> > : public mpl::true_ {};
Chris@16: template <typename T, typename Cs>    // immutable planar
Chris@16: struct iterator_is_basic<planar_pixel_iterator<const T*,Cs> > : public mpl::true_ {};
Chris@16: template <typename T, typename L>  // mutable   interleaved step
Chris@16: struct iterator_is_basic<memory_based_step_iterator<      pixel<T,L>*> > : public mpl::true_ {};
Chris@16: template <typename T, typename L>  // immutable interleaved step
Chris@16: struct iterator_is_basic<memory_based_step_iterator<const pixel<T,L>*> > : public mpl::true_ {};
Chris@16: template <typename T, typename Cs>  // mutable   planar step
Chris@16: struct iterator_is_basic<memory_based_step_iterator<planar_pixel_iterator<      T*,Cs> > > : public mpl::true_ {};
Chris@16: template <typename T, typename Cs>    // immutable planar step
Chris@16: struct iterator_is_basic<memory_based_step_iterator<planar_pixel_iterator<const T*,Cs> > > : public mpl::true_ {};
Chris@16: 
Chris@16: 
Chris@16: /// \ingroup GILIsBasic
Chris@16: /// \brief Determines if a given locator is basic. A basic locator is memory-based and has basic x_iterator and y_iterator
Chris@16: template <typename Loc> struct locator_is_basic : public mpl::false_ {};
Chris@16: template <typename Iterator> struct locator_is_basic<memory_based_2d_locator<memory_based_step_iterator<Iterator> > > : public iterator_is_basic<Iterator> {};
Chris@16: 
Chris@16: /// \ingroup GILIsBasic
Chris@16: /// \brief Basic views must be over basic locators
Chris@16: template <typename View> struct view_is_basic : public mpl::false_ {};
Chris@16: template <typename Loc> struct view_is_basic<image_view<Loc> > : public locator_is_basic<Loc> {};
Chris@16: 
Chris@16: /// \ingroup GILIsBasic
Chris@16: /// \brief Basic images must use basic views and std::allocator of char
Chris@16: template <typename Img> struct image_is_basic : public mpl::false_ {};
Chris@16: template <typename Pixel, bool IsPlanar, typename Alloc> struct image_is_basic<image<Pixel,IsPlanar,Alloc> > : public mpl::true_ {};
Chris@16: 
Chris@16: 
Chris@16: /// \defgroup GILIsStep xxx_is_step
Chris@16: /// \ingroup TypeAnalysis
Chris@16: /// \brief Determines if the given iterator/locator/view has a step that could be set dynamically
Chris@16: 
Chris@16: template <typename I> struct iterator_is_step;
Chris@16: namespace detail {
Chris@16:     template <typename It, bool IsBase, bool EqualsStepType> struct iterator_is_step_impl;
Chris@16:     // iterator that has the same type as its dynamic_x_step_type must be a step iterator
Chris@16:     template <typename It, bool IsBase> struct iterator_is_step_impl<It,IsBase,true> : public mpl::true_{};
Chris@16: 
Chris@16:     // base iterator can never be a step iterator
Chris@16:     template <typename It> struct iterator_is_step_impl<It,true,false> : public mpl::false_{};
Chris@16: 
Chris@16:     // for an iterator adaptor, see if its base is step
Chris@16:     template <typename It> struct iterator_is_step_impl<It,false,false> 
Chris@16:         : public iterator_is_step<typename iterator_adaptor_get_base<It>::type>{};
Chris@16: }
Chris@16: 
Chris@16: /// \ingroup GILIsStep
Chris@16: /// \brief Determines if the given iterator has a step that could be set dynamically
Chris@16: template <typename I> struct iterator_is_step 
Chris@16:     : public detail::iterator_is_step_impl<I, 
Chris@16:         !is_iterator_adaptor<I>::type::value,
Chris@16:         is_same<I,typename dynamic_x_step_type<I>::type>::value >{};
Chris@16: 
Chris@16: /// \ingroup GILIsStep
Chris@16: /// \brief Determines if the given locator has a horizontal step that could be set dynamically
Chris@16: template <typename L> struct locator_is_step_in_x : public iterator_is_step<typename L::x_iterator> {}; 
Chris@16: 
Chris@16: /// \ingroup GILIsStep
Chris@16: /// \brief Determines if the given locator has a vertical step that could be set dynamically
Chris@16: template <typename L> struct locator_is_step_in_y : public iterator_is_step<typename L::y_iterator> {}; 
Chris@16: 
Chris@16: /// \ingroup GILIsStep
Chris@16: /// \brief Determines if the given view has a horizontal step that could be set dynamically
Chris@16: template <typename V> struct view_is_step_in_x : public locator_is_step_in_x<typename V::xy_locator> {}; 
Chris@16: 
Chris@16: /// \ingroup GILIsStep
Chris@16: /// \brief Determines if the given view has a vertical step that could be set dynamically
Chris@16: template <typename V> struct view_is_step_in_y : public locator_is_step_in_y<typename V::xy_locator> {}; 
Chris@16: 
Chris@16: /// \brief Determines whether the given pixel reference is a proxy class or a native C++ reference
Chris@16: /// \ingroup TypeAnalysis
Chris@16: template <typename PixelReference>
Chris@16: struct pixel_reference_is_proxy
Chris@16:     : public mpl::not_<is_same<typename remove_const_and_reference<PixelReference>::type,
Chris@16:                                typename remove_const_and_reference<PixelReference>::type::value_type> > {};
Chris@16: 
Chris@16: /// \brief Given a model of a pixel, determines whether the model represents a pixel reference (as opposed to pixel value)
Chris@16: /// \ingroup TypeAnalysis
Chris@16: template <typename Pixel>
Chris@16: struct pixel_is_reference : public mpl::or_<is_reference<Pixel>, pixel_reference_is_proxy<Pixel> > {};
Chris@16: 
Chris@16: /// \defgroup GILIsMutable xxx_is_mutable
Chris@16: /// \ingroup TypeAnalysis
Chris@16: /// \brief Determines if the given pixel reference/iterator/locator/view is mutable (i.e. its pixels can be changed)
Chris@16: 
Chris@16: /// \ingroup GILIsMutable
Chris@16: /// \brief Determines if the given pixel reference is mutable (i.e. its channels can be changed)
Chris@16: ///
Chris@16: /// Note that built-in C++ references obey the const qualifier but reference proxy classes do not.
Chris@16: template <typename R> struct pixel_reference_is_mutable : public mpl::bool_<remove_reference<R>::type::is_mutable> {};
Chris@16: template <typename R> struct pixel_reference_is_mutable<const R&>
Chris@16:     : public mpl::and_<pixel_reference_is_proxy<R>, pixel_reference_is_mutable<R> > {};
Chris@16: 
Chris@16: /// \ingroup GILIsMutable
Chris@16: /// \brief Determines if the given locator is mutable (i.e. its pixels can be changed)
Chris@16: template <typename L> struct locator_is_mutable : public iterator_is_mutable<typename L::x_iterator> {};
Chris@16: /// \ingroup GILIsMutable
Chris@16: /// \brief Determines if the given view is mutable (i.e. its pixels can be changed)
Chris@16: template <typename V> struct view_is_mutable : public iterator_is_mutable<typename V::x_iterator> {};
Chris@16: 
Chris@16: 
Chris@16: //////////////////////////////////////////////////
Chris@16: ///
Chris@16: ///  TYPE FACTORY METAFUNCTIONS
Chris@16: ///  Metafunctions returning GIL types from other GIL types
Chris@16: ///
Chris@16: //////////////////////////////////////////////////
Chris@16: 
Chris@16: /// \defgroup TypeFactoryFromElements xxx_type
Chris@16: /// \ingroup TypeFactory
Chris@16: /// \brief Returns the type of a homogeneous GIL construct given its elements (channel, layout, whether it is planar, step, mutable, etc.)
Chris@16: 
Chris@16: /// \defgroup TypeFactoryFromPixel xxx_type_from_pixel
Chris@16: /// \ingroup TypeFactory
Chris@16: /// \brief Returns the type of a GIL construct given its pixel type, whether it is planar, step, mutable, etc.
Chris@16: 
Chris@16: /// \defgroup TypeFactoryDerived derived_xxx_type
Chris@16: /// \ingroup TypeFactory
Chris@16: /// \brief Returns the type of a homogeneous GIL construct given a related construct by changing some of its properties
Chris@16: 
Chris@16: /// \ingroup TypeFactoryFromElements
Chris@16: /// \brief Returns the type of a homogeneous pixel reference given the channel type, layout, whether it operates on planar data and whether it is mutable
Chris@16: template <typename T, typename L, bool IsPlanar=false, bool IsMutable=true> struct pixel_reference_type{};
Chris@16: template <typename T, typename L> struct pixel_reference_type<T,L,false,true > { typedef pixel<T,L>& type; };
Chris@16: template <typename T, typename L> struct pixel_reference_type<T,L,false,false> { typedef const pixel<T,L>& type; };
Chris@16: template <typename T, typename L> struct pixel_reference_type<T,L,true,true> { typedef const planar_pixel_reference<typename channel_traits<T>::reference,typename color_space_type<L>::type> type; };       // TODO: Assert M=identity
Chris@16: template <typename T, typename L> struct pixel_reference_type<T,L,true,false> { typedef const planar_pixel_reference<typename channel_traits<T>::const_reference,typename color_space_type<L>::type> type; };// TODO: Assert M=identity
Chris@16: 
Chris@16: /// \ingroup TypeFactoryFromPixel
Chris@16: /// \brief Returns the type of a pixel iterator given the pixel type, whether it operates on planar data, whether it is a step iterator, and whether it is mutable
Chris@16: template <typename Pixel, bool IsPlanar=false, bool IsStep=false, bool IsMutable=true> struct iterator_type_from_pixel{};
Chris@16: template <typename Pixel> struct iterator_type_from_pixel<Pixel,false,false,true > { typedef Pixel* type; };
Chris@16: template <typename Pixel> struct iterator_type_from_pixel<Pixel,false,false,false> { typedef const Pixel* type; };
Chris@16: template <typename Pixel> struct iterator_type_from_pixel<Pixel,true,false,true> { 
Chris@16:     typedef planar_pixel_iterator<typename channel_traits<typename channel_type<Pixel>::type>::pointer,typename color_space_type<Pixel>::type> type; 
Chris@16: };
Chris@16: template <typename Pixel> struct iterator_type_from_pixel<Pixel,true,false,false> { 
Chris@16:     typedef planar_pixel_iterator<typename channel_traits<typename channel_type<Pixel>::type>::const_pointer,typename color_space_type<Pixel>::type> type; 
Chris@16: };
Chris@16: template <typename Pixel, bool IsPlanar, bool IsMutable> struct iterator_type_from_pixel<Pixel,IsPlanar,true,IsMutable> { 
Chris@16:     typedef memory_based_step_iterator<typename iterator_type_from_pixel<Pixel,IsPlanar,false,IsMutable>::type> type; 
Chris@16: };
Chris@16: 
Chris@16: /// \ingroup TypeFactoryFromElements
Chris@16: /// \brief Returns the type of a homogeneous iterator given the channel type, layout, whether it operates on planar data, whether it is a step iterator, and whether it is mutable
Chris@16: template <typename T, typename L, bool IsPlanar=false, bool IsStep=false, bool IsMutable=true> struct iterator_type{};
Chris@16: template <typename T, typename L> struct iterator_type<T,L,false,false,true > { typedef pixel<T,L>* type; };
Chris@16: template <typename T, typename L> struct iterator_type<T,L,false,false,false> { typedef const pixel<T,L>* type; };
Chris@16: template <typename T, typename L> struct iterator_type<T,L,true,false,true> { typedef planar_pixel_iterator<T*,typename L::color_space_t> type; };               // TODO: Assert M=identity
Chris@16: template <typename T, typename L> struct iterator_type<T,L,true,false,false> { typedef planar_pixel_iterator<const T*,typename L::color_space_t> type; };        // TODO: Assert M=identity
Chris@16: template <typename T, typename L, bool IsPlanar, bool IsMutable> struct iterator_type<T,L,IsPlanar,true,IsMutable> { 
Chris@16:     typedef memory_based_step_iterator<typename iterator_type<T,L,IsPlanar,false,IsMutable>::type> type; 
Chris@16: };
Chris@16: 
Chris@16: /// \brief Given a pixel iterator defining access to pixels along a row, returns the types of the corresponding built-in step_iterator, xy_locator, image_view
Chris@16: /// \ingroup TypeFactory
Chris@16: template <typename XIterator> 
Chris@16: struct type_from_x_iterator {
Chris@16:     typedef memory_based_step_iterator<XIterator>    step_iterator_t;
Chris@16:     typedef memory_based_2d_locator<step_iterator_t> xy_locator_t;
Chris@16:     typedef image_view<xy_locator_t>                     view_t;
Chris@16: };
Chris@16: 
Chris@16: namespace detail {
Chris@16:     template <typename BitField, typename FirstBit, typename NumBits>
Chris@16:     struct packed_channel_reference_type {
Chris@16:         typedef const packed_channel_reference<BitField,FirstBit::value,NumBits::value,true> type;
Chris@16:     };
Chris@16: 
Chris@16:     template <typename BitField, typename ChannelBitSizesVector>
Chris@16:     class packed_channel_references_vector_type {
Chris@16:         // If ChannelBitSizesVector is mpl::vector<int,7,7,2>
Chris@16:         // Then first_bits_vector will be mpl::vector<int,0,7,14,16>
Chris@16:         typedef typename mpl::accumulate<ChannelBitSizesVector, mpl::vector1<mpl::int_<0> >, 
Chris@16:             mpl::push_back<mpl::_1, mpl::plus<mpl::back<mpl::_1>, mpl::_2> > >::type first_bits_vector;
Chris@16:     public:
Chris@16:         typedef typename mpl::transform<typename mpl::pop_back<first_bits_vector>::type, ChannelBitSizesVector,
Chris@16:                packed_channel_reference_type<BitField, mpl::_1,mpl::_2> >::type type;
Chris@16:     };
Chris@16: 
Chris@16: }
Chris@16: 
Chris@16: /// \ingroup TypeFactoryFromElements
Chris@16: /// \brief Returns the type of a packed pixel given its bitfield type, the bit size of its channels and its layout.
Chris@16: ///
Chris@16: /// A packed pixel has channels that cover bit ranges but itself is byte aligned. RGB565 pixel is an example.
Chris@16: ///
Chris@16: /// The size of ChannelBitSizeVector must equal the number of channels in the given layout
Chris@16: /// The sum of bit sizes for all channels must be less than or equal to the number of bits in BitField (and cannot exceed 64).
Chris@16: ///  If it is less than the number of bits in BitField, the last bits will be unused.
Chris@16: template <typename BitField, typename ChannelBitSizeVector, typename Layout>
Chris@16: struct packed_pixel_type {
Chris@16:     typedef packed_pixel<BitField, typename detail::packed_channel_references_vector_type<BitField,ChannelBitSizeVector>::type, Layout> type;
Chris@16: };
Chris@16: 
Chris@16: /// \defgroup TypeFactoryPacked packed_image_type,bit_aligned_image_type
Chris@16: /// \ingroup TypeFactoryFromElements
Chris@16: /// \brief Returns the type of an image whose channels are not byte-aligned. 
Chris@16: /// 
Chris@16: /// A packed image is an image whose pixels are byte aligned, such as "rgb565". <br>
Chris@16: /// A bit-aligned image is an image whose pixels are not byte aligned, such as "rgb222". <br>
Chris@16: /// 
Chris@16: /// The sum of the bit sizes of all channels cannot exceed 64.
Chris@16: 
Chris@16: /// \ingroup TypeFactoryPacked
Chris@16: /// \brief Returns the type of an interleaved packed image: an image whose channels may not be byte-aligned, but whose pixels are byte aligned.
Chris@16: template <typename BitField, typename ChannelBitSizeVector, typename Layout, typename Alloc=std::allocator<unsigned char> >
Chris@16: struct packed_image_type {
Chris@16:     typedef image<typename packed_pixel_type<BitField,ChannelBitSizeVector,Layout>::type,false,Alloc> type;
Chris@16: };
Chris@16: 
Chris@16: /// \ingroup TypeFactoryPacked
Chris@16: /// \brief Returns the type of a single-channel image given its bitfield type, the bit size of its channel and its layout
Chris@16: template <typename BitField, unsigned Size1, typename Layout, typename Alloc=std::allocator<unsigned char> >
Chris@16: struct packed_image1_type : public packed_image_type<BitField, mpl::vector1_c<unsigned, Size1>, Layout, Alloc> {};
Chris@16: 
Chris@16: /// \ingroup TypeFactoryPacked
Chris@16: /// \brief Returns the type of a two channel image given its bitfield type, the bit size of its channels and its layout
Chris@16: template <typename BitField, unsigned Size1, unsigned Size2, typename Layout, typename Alloc=std::allocator<unsigned char> >
Chris@16: struct packed_image2_type : public packed_image_type<BitField, mpl::vector2_c<unsigned, Size1, Size2>, Layout, Alloc> {};
Chris@16: 
Chris@16: /// \ingroup TypeFactoryPacked
Chris@16: /// \brief Returns the type of a three channel image given its bitfield type, the bit size of its channels and its layout
Chris@16: template <typename BitField, unsigned Size1, unsigned Size2, unsigned Size3, typename Layout, typename Alloc=std::allocator<unsigned char> >
Chris@16: struct packed_image3_type : public packed_image_type<BitField, mpl::vector3_c<unsigned, Size1, Size2, Size3>, Layout, Alloc> {};
Chris@16: 
Chris@16: /// \ingroup TypeFactoryPacked
Chris@16: /// \brief Returns the type of a four channel image given its bitfield type, the bit size of its channels and its layout
Chris@16: template <typename BitField, unsigned Size1, unsigned Size2, unsigned Size3, unsigned Size4, typename Layout, typename Alloc=std::allocator<unsigned char> >
Chris@16: struct packed_image4_type : public packed_image_type<BitField, mpl::vector4_c<unsigned, Size1, Size2, Size3, Size4>, Layout, Alloc> {};
Chris@16: 
Chris@16: /// \ingroup TypeFactoryPacked
Chris@16: /// \brief Returns the type of a five channel image given its bitfield type, the bit size of its channels and its layout
Chris@16: template <typename BitField, unsigned Size1, unsigned Size2, unsigned Size3, unsigned Size4, unsigned Size5, typename Layout, typename Alloc=std::allocator<unsigned char> >
Chris@16: struct packed_image5_type : public packed_image_type<BitField, mpl::vector5_c<unsigned, Size1, Size2, Size3, Size4, Size5>, Layout, Alloc> {};
Chris@16: 
Chris@16: 
Chris@16: /// \ingroup TypeFactoryPacked
Chris@16: /// \brief Returns the type of a packed image whose pixels may not be byte aligned. For example, an "rgb222" image is bit-aligned because its pixel spans six bits.
Chris@16: ///
Chris@16: /// Note that the alignment parameter in the constructor of bit-aligned images is in bit units. For example, if you want to construct a bit-aligned
Chris@16: /// image whose rows are byte-aligned, use 8 as the alignment parameter, not 1.
Chris@16: 
Chris@16: template <typename ChannelBitSizeVector, typename Layout, typename Alloc=std::allocator<unsigned char> >
Chris@16: struct bit_aligned_image_type {
Chris@16: private:
Chris@16:     BOOST_STATIC_CONSTANT(int, bit_size = (mpl::accumulate<ChannelBitSizeVector, mpl::int_<0>, mpl::plus<mpl::_1, mpl::_2> >::type::value));
Chris@16:     typedef typename detail::min_fast_uint<bit_size+7>::type                        bitfield_t;  
Chris@16:     typedef const bit_aligned_pixel_reference<bitfield_t, ChannelBitSizeVector, Layout, true> bit_alignedref_t;
Chris@16: public:
Chris@16:     typedef image<bit_alignedref_t,false,Alloc> type;
Chris@16: };
Chris@16: 
Chris@16: /// \ingroup TypeFactoryPacked
Chris@16: /// \brief Returns the type of a single-channel bit-aligned image given the bit size of its channel and its layout
Chris@16: template <unsigned Size1, typename Layout, typename Alloc=std::allocator<unsigned char> >
Chris@16: struct bit_aligned_image1_type : public bit_aligned_image_type<mpl::vector1_c<unsigned, Size1>, Layout, Alloc> {};
Chris@16: 
Chris@16: /// \ingroup TypeFactoryPacked
Chris@16: /// \brief Returns the type of a two channel bit-aligned image given the bit size of its channels and its layout
Chris@16: template <unsigned Size1, unsigned Size2, typename Layout, typename Alloc=std::allocator<unsigned char> >
Chris@16: struct bit_aligned_image2_type : public bit_aligned_image_type<mpl::vector2_c<unsigned, Size1, Size2>, Layout, Alloc> {};
Chris@16: 
Chris@16: /// \ingroup TypeFactoryPacked
Chris@16: /// \brief Returns the type of a three channel bit-aligned image given the bit size of its channels and its layout
Chris@16: template <unsigned Size1, unsigned Size2, unsigned Size3, typename Layout, typename Alloc=std::allocator<unsigned char> >
Chris@16: struct bit_aligned_image3_type : public bit_aligned_image_type<mpl::vector3_c<unsigned, Size1, Size2, Size3>, Layout, Alloc> {};
Chris@16: 
Chris@16: /// \ingroup TypeFactoryPacked
Chris@16: /// \brief Returns the type of a four channel bit-aligned image given the bit size of its channels and its layout
Chris@16: template <unsigned Size1, unsigned Size2, unsigned Size3, unsigned Size4, typename Layout, typename Alloc=std::allocator<unsigned char> >
Chris@16: struct bit_aligned_image4_type : public bit_aligned_image_type<mpl::vector4_c<unsigned, Size1, Size2, Size3, Size4>, Layout, Alloc> {};
Chris@16: 
Chris@16: /// \ingroup TypeFactoryPacked
Chris@16: /// \brief Returns the type of a five channel bit-aligned image given the bit size of its channels and its layout
Chris@16: template <unsigned Size1, unsigned Size2, unsigned Size3, unsigned Size4, unsigned Size5, typename Layout, typename Alloc=std::allocator<unsigned char> >
Chris@16: struct bit_aligned_image5_type : public bit_aligned_image_type<mpl::vector5_c<unsigned, Size1, Size2, Size3, Size4, Size5>, Layout, Alloc> {};
Chris@16: 
Chris@16: 
Chris@16: 
Chris@16: /// \ingroup TypeFactoryFromElements
Chris@16: /// \brief Returns the type of a homogeneous pixel given the channel type and layout
Chris@16: template <typename Channel, typename Layout> 
Chris@16: struct pixel_value_type {
Chris@16:     typedef pixel<Channel,Layout> type;     // by default use gil::pixel. Specializations are provided for 
Chris@16: };
Chris@16: 
Chris@16: // Specializations for packed channels
Chris@16: template <typename BitField, int NumBits, bool IsMutable, typename Layout> 
Chris@16: struct pixel_value_type<      packed_dynamic_channel_reference<BitField,NumBits,IsMutable>,Layout> :
Chris@16:     public packed_pixel_type<BitField, mpl::vector1_c<unsigned,NumBits>, Layout> {};
Chris@16: template <typename BitField, int NumBits, bool IsMutable, typename Layout> 
Chris@16: struct pixel_value_type<const packed_dynamic_channel_reference<BitField,NumBits,IsMutable>,Layout> :
Chris@16:     public packed_pixel_type<BitField, mpl::vector1_c<unsigned,NumBits>, Layout> {};
Chris@16: 
Chris@16: template <typename BitField, int FirstBit, int NumBits, bool IsMutable, typename Layout> 
Chris@16: struct pixel_value_type<      packed_channel_reference<BitField,FirstBit,NumBits,IsMutable>,Layout> :
Chris@16:     public packed_pixel_type<BitField, mpl::vector1_c<unsigned,NumBits>, Layout> {};
Chris@16: template <typename BitField, int FirstBit, int NumBits, bool IsMutable, typename Layout> 
Chris@16: struct pixel_value_type<const packed_channel_reference<BitField,FirstBit,NumBits,IsMutable>,Layout> :
Chris@16:     public packed_pixel_type<BitField, mpl::vector1_c<unsigned,NumBits>, Layout> {};
Chris@16: 
Chris@16: template <int NumBits, typename Layout> 
Chris@16: struct pixel_value_type<packed_channel_value<NumBits>,Layout> :
Chris@16:     public packed_pixel_type<typename detail::min_fast_uint<NumBits>::type, mpl::vector1_c<unsigned,NumBits>, Layout> {};
Chris@16: 
Chris@16: 
Chris@16: /// \ingroup TypeFactoryFromElements
Chris@16: /// \brief Returns the type of a homogeneous locator given the channel type, layout, whether it operates on planar data and whether it has a step horizontally
Chris@16: template <typename T, typename L, bool IsPlanar=false, bool IsStepX=false, bool IsMutable=true> 
Chris@16: struct locator_type {
Chris@16:     typedef typename type_from_x_iterator<typename iterator_type<T,L,IsPlanar,IsStepX,IsMutable>::type>::xy_locator_type type;
Chris@16: };
Chris@16: 
Chris@16: /// \ingroup TypeFactoryFromElements
Chris@16: /// \brief Returns the type of a homogeneous view given the channel type, layout, whether it operates on planar data and whether it has a step horizontally
Chris@16: template <typename T, typename L, bool IsPlanar=false, bool IsStepX=false, bool IsMutable=true> 
Chris@16: struct view_type {
Chris@16:     typedef typename type_from_x_iterator<typename iterator_type<T,L,IsPlanar,IsStepX,IsMutable>::type>::view_t type;
Chris@16: };
Chris@16: 
Chris@16: /// \ingroup TypeFactoryFromElements
Chris@16: /// \brief Returns the type of a homogeneous image given the channel type, layout, and whether it operates on planar data
Chris@16: template <typename T, typename L, bool IsPlanar=false, typename Alloc=std::allocator<unsigned char> > 
Chris@16: struct image_type {
Chris@16:     typedef image<pixel<T,L>, IsPlanar, Alloc> type;
Chris@16: };
Chris@16: 
Chris@16: /// \ingroup TypeFactoryFromPixel
Chris@16: /// \brief Returns the type of a view the pixel type, whether it operates on planar data and whether it has a step horizontally
Chris@16: template <typename Pixel, bool IsPlanar=false, bool IsStepX=false, bool IsMutable=true> 
Chris@16: struct view_type_from_pixel {
Chris@16:     typedef typename type_from_x_iterator<typename iterator_type_from_pixel<Pixel,IsPlanar,IsStepX,IsMutable>::type>::view_t type;
Chris@16: };
Chris@16: 
Chris@16: 
Chris@16: /// \brief Constructs a pixel reference type from a source pixel reference type by changing some of the properties.
Chris@16: /// \ingroup TypeFactoryDerived
Chris@16: ///  Use use_default for the properties of the source view that you want to keep
Chris@16: template <typename Ref, typename T=use_default, typename L=use_default, typename IsPlanar=use_default, typename IsMutable=use_default>
Chris@16: class derived_pixel_reference_type {
Chris@16:     typedef typename remove_reference<Ref>::type pixel_t;
Chris@16:     typedef typename  mpl::if_<is_same<T, use_default>, typename channel_type<pixel_t>::type,     T >::type channel_t;
Chris@16:     typedef typename  mpl::if_<is_same<L, use_default>, 
Chris@16:         layout<typename color_space_type<pixel_t>::type, typename channel_mapping_type<pixel_t>::type>, L>::type           layout_t;
Chris@16:     static const bool mut   =mpl::if_<is_same<IsMutable,use_default>, pixel_reference_is_mutable<Ref>, IsMutable>::type::value;
Chris@16:     static const bool planar=mpl::if_<is_same<IsPlanar,use_default>,  is_planar<pixel_t>,  IsPlanar>::type::value;
Chris@16: public:
Chris@16:     typedef typename pixel_reference_type<channel_t, layout_t, planar, mut>::type type;
Chris@16: };
Chris@16: 
Chris@16: /// \brief Constructs a pixel iterator type from a source pixel iterator type by changing some of the properties.
Chris@16: /// \ingroup TypeFactoryDerived
Chris@16: ///  Use use_default for the properties of the source view that you want to keep
Chris@16: template <typename Iterator, typename T=use_default, typename L=use_default, typename IsPlanar=use_default, typename IsStep=use_default, typename IsMutable=use_default>
Chris@16: class derived_iterator_type {
Chris@16:     typedef typename  mpl::if_<is_same<T ,use_default>, typename channel_type<Iterator>::type,     T >::type channel_t;
Chris@16:     typedef typename  mpl::if_<is_same<L,use_default>, 
Chris@16:         layout<typename color_space_type<Iterator>::type, typename channel_mapping_type<Iterator>::type>, L>::type layout_t;
Chris@16: 
Chris@16:     static const bool mut   =mpl::if_<is_same<IsMutable,use_default>, iterator_is_mutable<Iterator>, IsMutable>::type::value;
Chris@16:     static const bool planar=mpl::if_<is_same<IsPlanar,use_default>,         is_planar<Iterator>,  IsPlanar>::type::value;
Chris@16:     static const bool step  =mpl::if_<is_same<IsStep  ,use_default>,  iterator_is_step<Iterator>,    IsStep>::type::value;
Chris@16: public:
Chris@16:     typedef typename iterator_type<channel_t, layout_t, planar, step, mut>::type type;
Chris@16: };
Chris@16: 
Chris@16: /// \brief Constructs an image view type from a source view type by changing some of the properties.
Chris@16: /// \ingroup TypeFactoryDerived
Chris@16: ///  Use use_default for the properties of the source view that you want to keep
Chris@16: template <typename View, typename T=use_default, typename L=use_default, typename IsPlanar=use_default, typename StepX=use_default, typename IsMutable=use_default>
Chris@16: class derived_view_type {
Chris@16:     typedef typename  mpl::if_<is_same<T ,use_default>, typename channel_type<View>::type, T>::type channel_t;
Chris@16:     typedef typename  mpl::if_<is_same<L,use_default>, 
Chris@16:         layout<typename color_space_type<View>::type, typename channel_mapping_type<View>::type>, L>::type layout_t;
Chris@16:     static const bool mut   =mpl::if_<is_same<IsMutable,use_default>, view_is_mutable<View>, IsMutable>::type::value;
Chris@16:     static const bool planar=mpl::if_<is_same<IsPlanar,use_default>,  is_planar<View>,  IsPlanar>::type::value;
Chris@16:     static const bool step  =mpl::if_<is_same<StepX ,use_default>,  view_is_step_in_x<View>,StepX>::type::value;
Chris@16: public:
Chris@16:     typedef typename view_type<channel_t, layout_t, planar, step, mut>::type type;
Chris@16: };
Chris@16: 
Chris@16: /// \brief Constructs a homogeneous image type from a source image type by changing some of the properties.
Chris@16: /// \ingroup TypeFactoryDerived
Chris@16: ///  Use use_default for the properties of the source image that you want to keep
Chris@16: template <typename Image, typename T=use_default, typename L=use_default, typename IsPlanar=use_default>
Chris@16: class derived_image_type {
Chris@16:     typedef typename  mpl::if_<is_same<T ,use_default>, typename channel_type<Image>::type,     T >::type channel_t;
Chris@16:     typedef typename  mpl::if_<is_same<L,use_default>, 
Chris@16:         layout<typename color_space_type<Image>::type, typename channel_mapping_type<Image>::type>, L>::type layout_t;
Chris@16:     static const bool planar=mpl::if_<is_same<IsPlanar,use_default>,  is_planar<Image>,  IsPlanar>::type::value;
Chris@16: public:
Chris@16:     typedef typename image_type<channel_t, layout_t, planar>::type type;
Chris@16: };
Chris@16: 
Chris@16: 
Chris@16: 
Chris@16: 
Chris@16: } }  // namespace boost::gil
Chris@16: 
Chris@16: #endif