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_BIT_ALIGNED_PIXEL_ITERATOR_HPP
Chris@16: #define GIL_BIT_ALIGNED_PIXEL_ITERATOR_HPP
Chris@16: 
Chris@16: ////////////////////////////////////////////////////////////////////////////////////////
Chris@16: /// \file               
Chris@16: /// \brief A model of a heterogeneous pixel that is not byte aligned. Examples are bitmap (1-bit pixels) or 6-bit RGB (222)
Chris@16: /// \author Lubomir Bourdev and Hailin Jin \n
Chris@16: ///         Adobe Systems Incorporated
Chris@16: /// \date   2005-2007 \n Last updated on September 28, 2006
Chris@16: ///
Chris@16: ////////////////////////////////////////////////////////////////////////////////////////
Chris@16: 
Chris@16: #include <functional>
Chris@16: #include <boost/iterator/iterator_facade.hpp>
Chris@16: #include "gil_config.hpp"
Chris@16: #include "bit_aligned_pixel_reference.hpp"
Chris@16: #include "pixel_iterator.hpp"
Chris@16: 
Chris@16: namespace boost { namespace gil {
Chris@16: 
Chris@16: /// \defgroup PixelIteratorNonAlignedPixelIterator bit_aligned_pixel_iterator
Chris@16: /// \ingroup PixelIteratorModel
Chris@16: /// \brief An iterator over non-byte-aligned pixels. Models PixelIteratorConcept, PixelBasedConcept, MemoryBasedIteratorConcept, HasDynamicXStepTypeConcept
Chris@16: 
Chris@16: ////////////////////////////////////////////////////////////////////////////////////////
Chris@16: /// \brief An iterator over non-byte-aligned pixels. Models PixelIteratorConcept, PixelBasedConcept, MemoryBasedIteratorConcept, HasDynamicXStepTypeConcept
Chris@16: ///
Chris@16: /// An iterator over pixels that correspond to non-byte-aligned bit ranges. Examples of such pixels are single bit grayscale pixel, or a 6-bit RGB 222 pixel.
Chris@16: /// 
Chris@16: /// \ingroup PixelIteratorNonAlignedPixelIterator PixelBasedModel
Chris@16: 
Chris@16: template <typename NonAlignedPixelReference>
Chris@16: struct bit_aligned_pixel_iterator : public iterator_facade<bit_aligned_pixel_iterator<NonAlignedPixelReference>,
Chris@16:                                                   typename NonAlignedPixelReference::value_type,
Chris@16:                                                   std::random_access_iterator_tag,
Chris@16:                                                   const NonAlignedPixelReference,
Chris@16:                                                   typename NonAlignedPixelReference::bit_range_t::difference_type> {
Chris@16: private:
Chris@16:     typedef iterator_facade<bit_aligned_pixel_iterator<NonAlignedPixelReference>,
Chris@16:                             typename NonAlignedPixelReference::value_type,
Chris@16:                             std::random_access_iterator_tag,
Chris@16:                             const NonAlignedPixelReference,
Chris@16:                             typename NonAlignedPixelReference::bit_range_t::difference_type> parent_t;
Chris@16:     template <typename Ref> friend struct bit_aligned_pixel_iterator;
Chris@16: 
Chris@16:     typedef typename NonAlignedPixelReference::bit_range_t bit_range_t;
Chris@16: public:
Chris@16:     typedef typename parent_t::difference_type             difference_type;
Chris@16:     typedef typename parent_t::reference                   reference;
Chris@16: 
Chris@16:     bit_aligned_pixel_iterator() {}
Chris@16:     bit_aligned_pixel_iterator(const bit_aligned_pixel_iterator& p) : _bit_range(p._bit_range) {}
Chris@16:     bit_aligned_pixel_iterator& operator=(const bit_aligned_pixel_iterator& p) { _bit_range=p._bit_range; return *this; }
Chris@16: 
Chris@16:     template <typename Ref> bit_aligned_pixel_iterator(const bit_aligned_pixel_iterator<Ref>& p) : _bit_range(p._bit_range) {}
Chris@16: 
Chris@16:     bit_aligned_pixel_iterator(reference* ref) : _bit_range(ref->bit_range()) {}
Chris@16:     explicit bit_aligned_pixel_iterator(typename bit_range_t::byte_t* data, int bit_offset=0) : _bit_range(data,bit_offset) {}
Chris@16: 
Chris@16:     /// For some reason operator[] provided by iterator_adaptor returns a custom class that is convertible to reference
Chris@16:     /// We require our own reference because it is registered in iterator_traits
Chris@16:     reference operator[](difference_type d) const { bit_aligned_pixel_iterator it=*this; it.advance(d); return *it; }
Chris@16: 
Chris@16:     reference operator->()         const { return **this; }
Chris@16:     const bit_range_t& bit_range() const { return _bit_range; }
Chris@16:           bit_range_t& bit_range()       { return _bit_range; }
Chris@16: private:
Chris@16:     bit_range_t _bit_range;
Chris@16:     BOOST_STATIC_CONSTANT(int, bit_size = NonAlignedPixelReference::bit_size);
Chris@16: 
Chris@16:     friend class boost::iterator_core_access;
Chris@16:     reference dereference()     const { return NonAlignedPixelReference(_bit_range); }
Chris@16:     void increment()                  { ++_bit_range; }
Chris@16:     void decrement()                  { --_bit_range; }
Chris@16:     void advance(difference_type d)   { _bit_range.bit_advance(d*bit_size); }
Chris@16: 
Chris@16:     difference_type distance_to(const bit_aligned_pixel_iterator& it) const { return _bit_range.bit_distance_to(it._bit_range) / bit_size; }
Chris@16:     bool equal(const bit_aligned_pixel_iterator& it) const { return _bit_range==it._bit_range; }
Chris@16: };
Chris@16: 
Chris@16: template <typename NonAlignedPixelReference> 
Chris@16: struct const_iterator_type<bit_aligned_pixel_iterator<NonAlignedPixelReference> > { 
Chris@16:     typedef bit_aligned_pixel_iterator<typename NonAlignedPixelReference::const_reference> type; 
Chris@16: };
Chris@16: 
Chris@16: template <typename NonAlignedPixelReference> 
Chris@16: struct iterator_is_mutable<bit_aligned_pixel_iterator<NonAlignedPixelReference> > : public mpl::bool_<NonAlignedPixelReference::is_mutable> {};
Chris@16: 
Chris@16: template <typename NonAlignedPixelReference> 
Chris@16: struct is_iterator_adaptor<bit_aligned_pixel_iterator<NonAlignedPixelReference> > : public mpl::false_ {};
Chris@16: 
Chris@16: /////////////////////////////
Chris@16: //  PixelBasedConcept
Chris@16: /////////////////////////////
Chris@16: 
Chris@16: template <typename NonAlignedPixelReference>
Chris@16: struct color_space_type<bit_aligned_pixel_iterator<NonAlignedPixelReference> > : public color_space_type<NonAlignedPixelReference> {};
Chris@16: 
Chris@16: template <typename NonAlignedPixelReference>
Chris@16: struct channel_mapping_type<bit_aligned_pixel_iterator<NonAlignedPixelReference> > : public channel_mapping_type<NonAlignedPixelReference> {};
Chris@16: 
Chris@16: template <typename NonAlignedPixelReference>
Chris@16: struct is_planar<bit_aligned_pixel_iterator<NonAlignedPixelReference> > : public is_planar<NonAlignedPixelReference> {}; // == false
Chris@16: 
Chris@16: /////////////////////////////
Chris@16: //  MemoryBasedIteratorConcept
Chris@16: /////////////////////////////
Chris@16: 
Chris@16: template <typename NonAlignedPixelReference>
Chris@16: struct byte_to_memunit<bit_aligned_pixel_iterator<NonAlignedPixelReference> > : public mpl::int_<8> {};
Chris@16: 
Chris@16: template <typename NonAlignedPixelReference>
Chris@16: inline std::ptrdiff_t memunit_step(const bit_aligned_pixel_iterator<NonAlignedPixelReference>&) { 
Chris@16:     return NonAlignedPixelReference::bit_size; 
Chris@16: }
Chris@16: 
Chris@16: template <typename NonAlignedPixelReference>
Chris@16: inline std::ptrdiff_t memunit_distance(const bit_aligned_pixel_iterator<NonAlignedPixelReference>& p1, const bit_aligned_pixel_iterator<NonAlignedPixelReference>& p2) { 
Chris@16:     return (p2.bit_range().current_byte() - p1.bit_range().current_byte())*8 + p2.bit_range().bit_offset() - p1.bit_range().bit_offset(); 
Chris@16: }
Chris@16: 
Chris@16: template <typename NonAlignedPixelReference>
Chris@16: inline void memunit_advance(bit_aligned_pixel_iterator<NonAlignedPixelReference>& p, std::ptrdiff_t diff) { 
Chris@16:     p.bit_range().bit_advance(diff);
Chris@16: }
Chris@16: 
Chris@16: template <typename NonAlignedPixelReference>
Chris@16: inline bit_aligned_pixel_iterator<NonAlignedPixelReference> memunit_advanced(const bit_aligned_pixel_iterator<NonAlignedPixelReference>& p, std::ptrdiff_t diff) {
Chris@16:     bit_aligned_pixel_iterator<NonAlignedPixelReference> ret=p;
Chris@16:     memunit_advance(ret, diff);
Chris@16:     return ret;
Chris@16: }
Chris@16: 
Chris@16: template <typename NonAlignedPixelReference> inline
Chris@16: NonAlignedPixelReference memunit_advanced_ref(bit_aligned_pixel_iterator<NonAlignedPixelReference> it, std::ptrdiff_t diff) {
Chris@16:     return *memunit_advanced(it,diff);
Chris@16: }
Chris@16: /////////////////////////////
Chris@16: //  HasDynamicXStepTypeConcept
Chris@16: /////////////////////////////
Chris@16: 
Chris@16: template <typename NonAlignedPixelReference>
Chris@16: struct dynamic_x_step_type<bit_aligned_pixel_iterator<NonAlignedPixelReference> > {
Chris@16:     typedef memory_based_step_iterator<bit_aligned_pixel_iterator<NonAlignedPixelReference> > type;
Chris@16: };
Chris@16: 
Chris@16: /////////////////////////////
Chris@16: //  iterator_type_from_pixel
Chris@16: /////////////////////////////
Chris@16: 
Chris@16: template <typename B, typename C, typename L, bool M>
Chris@16: struct iterator_type_from_pixel<const bit_aligned_pixel_reference<B,C,L,M>,false,false,false> {
Chris@16:     typedef bit_aligned_pixel_iterator<bit_aligned_pixel_reference<B,C,L,false> > type;
Chris@16: };
Chris@16: 
Chris@16: template <typename B, typename C, typename L, bool M>
Chris@16: struct iterator_type_from_pixel<const bit_aligned_pixel_reference<B,C,L,M>,false,false,true> {
Chris@16:     typedef bit_aligned_pixel_iterator<bit_aligned_pixel_reference<B,C,L,true> > type;
Chris@16: };
Chris@16: 
Chris@16: template <typename B, typename C, typename L, bool M, bool IsPlanar, bool IsStep, bool IsMutable>
Chris@16: struct iterator_type_from_pixel<bit_aligned_pixel_reference<B,C,L,M>,IsPlanar,IsStep,IsMutable>
Chris@16:     : public iterator_type_from_pixel<const bit_aligned_pixel_reference<B,C,L,M>,IsPlanar,IsStep,IsMutable> {};
Chris@16: 
Chris@16: } }  // namespace boost::gil
Chris@16: 
Chris@16: namespace std {
Chris@16: 
Chris@16: // It is important to provide an overload of uninitialized_copy for bit_aligned_pixel_iterator. The default STL implementation calls placement new,
Chris@16: // which is not defined for bit_aligned_pixel_iterator. 
Chris@16: template <typename NonAlignedPixelReference>
Chris@16: boost::gil::bit_aligned_pixel_iterator<NonAlignedPixelReference> uninitialized_copy(boost::gil::bit_aligned_pixel_iterator<NonAlignedPixelReference> first, 
Chris@16:                                                                                    boost::gil::bit_aligned_pixel_iterator<NonAlignedPixelReference> last,
Chris@16:                                                                                    boost::gil::bit_aligned_pixel_iterator<NonAlignedPixelReference> dst) {
Chris@16:     return std::copy(first,last,dst);
Chris@16: }
Chris@16: 
Chris@16: }   // namespace std
Chris@16: #endif