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: #ifndef GIL_IMAGE_H
Chris@16: #define GIL_IMAGE_H
Chris@16: 
Chris@16: ////////////////////////////////////////////////////////////////////////////////////////
Chris@16: /// \file               
Chris@16: /// \brief Templated image
Chris@16: /// \author Lubomir Bourdev and Hailin Jin \n
Chris@16: ///         Adobe Systems Incorporated
Chris@16: /// \date 2005-2007 \n Last updated on February 12, 2007
Chris@16: ///
Chris@16: ////////////////////////////////////////////////////////////////////////////////////////
Chris@16: 
Chris@16: #include <cstddef>
Chris@16: #include <memory>
Chris@16: #include "gil_config.hpp"
Chris@16: #include "image_view.hpp"
Chris@16: #include "metafunctions.hpp"
Chris@16: #include "algorithm.hpp"
Chris@16: 
Chris@16: namespace boost { namespace gil {
Chris@16: 
Chris@16: //#ifdef _MSC_VER
Chris@16: //#pragma warning(push)
Chris@16: //#pragma warning(disable : 4244)     // conversion from 'gil::image<V,Alloc>::coord_t' to 'int', possible loss of data (visual studio compiler doesn't realize that the two types are the same)
Chris@16: //#endif
Chris@16: 
Chris@16: ////////////////////////////////////////////////////////////////////////////////////////
Chris@16: /// \ingroup ImageModel PixelBasedModel
Chris@16: /// \brief container interface over image view. Models ImageConcept, PixelBasedConcept
Chris@16: /// 
Chris@16: /// A 2D container whose elements are pixels. It is templated over the pixel type, a boolean
Chris@16: /// indicating whether it should be planar, and an optional allocator.
Chris@16: ///
Chris@16: /// Note that its element type does not have to be a pixel. \p image can be instantiated with any Regular element, 
Chris@16: /// in which case it models the weaker RandomAccess2DImageConcept and does not model PixelBasedConcept
Chris@16: ///
Chris@16: ////////////////////////////////////////////////////////////////////////////////////////
Chris@16: 
Chris@16: template< typename Pixel, bool IsPlanar = false, typename Alloc=std::allocator<unsigned char> >    
Chris@16: class image {
Chris@16: public:
Chris@16:     typedef typename Alloc::template rebind<unsigned char>::other allocator_type;
Chris@16:     typedef typename view_type_from_pixel<Pixel, IsPlanar>::type view_t;
Chris@16:     typedef typename view_t::const_t                 const_view_t;
Chris@16:     typedef typename view_t::point_t                 point_t;
Chris@16:     typedef typename view_t::coord_t                 coord_t;
Chris@16:     typedef typename view_t::value_type              value_type;
Chris@16:     typedef coord_t                                  x_coord_t;
Chris@16:     typedef coord_t                                  y_coord_t;
Chris@16: 
Chris@16:     const point_t&          dimensions()            const { return _view.dimensions(); }
Chris@16:     x_coord_t               width()                 const { return _view.width(); }
Chris@16:     y_coord_t               height()                const { return _view.height(); }
Chris@16: 
Chris@16:     explicit image(std::size_t alignment=0,
Chris@16:                    const Alloc alloc_in = Alloc()) : 
Chris@16:         _memory(0), _align_in_bytes(alignment), _alloc(alloc_in) {}
Chris@16: 
Chris@16:     // Create with dimensions and optional initial value and alignment
Chris@16:     image(const point_t& dimensions,
Chris@16:           std::size_t alignment=0,
Chris@16:           const Alloc alloc_in = Alloc()) : _memory(0), _align_in_bytes(alignment), _alloc(alloc_in) {
Chris@16:         allocate_and_default_construct(dimensions);
Chris@16:     }
Chris@16:     image(x_coord_t width, y_coord_t height,
Chris@16:           std::size_t alignment=0,
Chris@16:           const Alloc alloc_in = Alloc()) : _memory(0), _align_in_bytes(alignment), _alloc(alloc_in) {
Chris@16:         allocate_and_default_construct(point_t(width,height));
Chris@16:     }
Chris@16:     image(const point_t& dimensions, 
Chris@16:           const Pixel& p_in,
Chris@16:           std::size_t alignment,
Chris@16:           const Alloc alloc_in = Alloc())  :
Chris@16:         _memory(0), _align_in_bytes(alignment), _alloc(alloc_in) {
Chris@16:         allocate_and_fill(dimensions, p_in);
Chris@16:     }
Chris@16:     image(x_coord_t width, y_coord_t height,
Chris@16:           const Pixel& p_in,
Chris@16:           std::size_t alignment,
Chris@16:           const Alloc alloc_in = Alloc())  :
Chris@16:         _memory(0), _align_in_bytes(alignment), _alloc(alloc_in) {
Chris@16:         allocate_and_fill(point_t(width,height),p_in);
Chris@16:     }
Chris@16: 
Chris@16:     image(const image& img) :
Chris@16:         _memory(0), _align_in_bytes(img._align_in_bytes), _alloc(img._alloc) {
Chris@16:         allocate_and_copy(img.dimensions(),img._view);
Chris@16:     }
Chris@16: 
Chris@16:     template <typename P2, bool IP2, typename Alloc2>
Chris@16:     image(const image<P2,IP2,Alloc2>& img) : 
Chris@16:         _memory(0), _align_in_bytes(img._align_in_bytes), _alloc(img._alloc) {
Chris@16:        allocate_and_copy(img.dimensions(),img._view);
Chris@16:     }
Chris@16:     image& operator=(const image& img) {
Chris@16:         if (dimensions() == img.dimensions())
Chris@16:             copy_pixels(img._view,_view);
Chris@16:         else {
Chris@16:             image tmp(img);
Chris@16:             swap(tmp);
Chris@16:         }
Chris@16:         return *this;
Chris@16:     }
Chris@16: 
Chris@16:     template <typename Img>
Chris@16:     image& operator=(const Img& img) {
Chris@16:         if (dimensions() == img.dimensions())
Chris@16:             copy_pixels(img._view,_view);
Chris@16:         else {
Chris@16:             image tmp(img);
Chris@16:             swap(tmp);
Chris@16:         }
Chris@16:         return *this;
Chris@16:     }
Chris@16: 
Chris@16:     ~image() {
Chris@16:         destruct_pixels(_view);
Chris@16:         deallocate(_view.dimensions());
Chris@16:     }
Chris@16: 
Chris@16:     Alloc&       allocator() { return _alloc; }
Chris@16:     Alloc const& allocator() const { return _alloc; }
Chris@16: 
Chris@16:     void swap(image& img) { // required by MutableContainerConcept
Chris@16:         using std::swap;
Chris@16:         swap(_align_in_bytes, img._align_in_bytes);
Chris@16:         swap(_memory,         img._memory);
Chris@16:         swap(_view,           img._view); 
Chris@16:         swap(_alloc,          img._alloc);
Chris@16:     }    
Chris@16: 
Chris@16:     void recreate(const point_t& dims, std::size_t alignment=0, const Alloc alloc_in = Alloc()) {
Chris@16:         if (dims!=_view.dimensions() || _align_in_bytes!=alignment || alloc_in!=_alloc) {
Chris@16:             image tmp(dims, alignment, alloc_in);
Chris@16:             swap(tmp);
Chris@16:         }
Chris@16:     }
Chris@16:     void recreate(x_coord_t width, y_coord_t height, std::size_t alignment=0, const Alloc alloc_in = Alloc()) {
Chris@16:         recreate(point_t(width,height),alignment,alloc_in);
Chris@16:     }
Chris@16:     void recreate(const point_t& dims, 
Chris@16:                   const Pixel& p_in, std::size_t alignment, const Alloc alloc_in = Alloc()) {
Chris@16:         if (dims!=_view.dimensions() || _align_in_bytes!=alignment || alloc_in!=_alloc) {
Chris@16:             image tmp(dims, p_in, alignment, alloc_in);
Chris@16:             swap(tmp);
Chris@16:         }
Chris@16:     }
Chris@16:     void recreate(x_coord_t width, y_coord_t height, 
Chris@16:                   const Pixel& p_in, std::size_t alignment, const Alloc alloc_in = Alloc()) {
Chris@16:         recreate(point_t(width,height),p_in,alignment,alloc_in);
Chris@16:     }
Chris@16: 
Chris@16:     view_t       _view;      // contains pointer to the pixels, the image size and ways to navigate pixels
Chris@16: private:
Chris@16:     unsigned char* _memory;
Chris@16:     std::size_t    _align_in_bytes;
Chris@16:     allocator_type _alloc;
Chris@16: 
Chris@16:     void allocate_and_default_construct(const point_t& dimensions) { 
Chris@16:         try {
Chris@16:             allocate_(dimensions,mpl::bool_<IsPlanar>());
Chris@16:             default_construct_pixels(_view);
Chris@16:         } catch(...) { deallocate(dimensions); throw; }
Chris@16:     }
Chris@16: 
Chris@16:     void allocate_and_fill(const point_t& dimensions, const Pixel& p_in) { 
Chris@16:         try {
Chris@16:             allocate_(dimensions,mpl::bool_<IsPlanar>());
Chris@16:             uninitialized_fill_pixels(_view, p_in);
Chris@16:         } catch(...) { deallocate(dimensions); throw; }
Chris@16:     }
Chris@16: 
Chris@16:     template <typename View>
Chris@16:     void allocate_and_copy(const point_t& dimensions, const View& v) { 
Chris@16:         try {
Chris@16:             allocate_(dimensions,mpl::bool_<IsPlanar>());
Chris@16:             uninitialized_copy_pixels(v,_view);
Chris@16:         } catch(...) { deallocate(dimensions); throw; }
Chris@16:     }
Chris@16: 
Chris@16:     void deallocate(const point_t& dimensions) { 
Chris@16:         if (_memory) _alloc.deallocate(_memory, total_allocated_size_in_bytes(dimensions));
Chris@16:     }
Chris@16: 
Chris@16:     std::size_t total_allocated_size_in_bytes(const point_t& dimensions) const {
Chris@16: 
Chris@16:         typedef typename view_t::x_iterator x_iterator; 
Chris@16: 
Chris@16:         // when value_type is a non-pixel, like int or float, num_channels< ... > doesn't work.
Chris@16:         const std::size_t _channels_in_image = mpl::eval_if< is_pixel< value_type >
Chris@16:                                                            , num_channels< view_t >
Chris@16:                                                            , mpl::int_< 1 > 
Chris@16: 														   >::type::value;
Chris@16: 
Chris@16:         std::size_t size_in_units = get_row_size_in_memunits(dimensions.x)*dimensions.y;
Chris@16: 
Chris@16:         if (IsPlanar)
Chris@16:             size_in_units = size_in_units * _channels_in_image ;
Chris@16: 
Chris@16:         // return the size rounded up to the nearest byte
Chris@16:         return ( size_in_units + byte_to_memunit< x_iterator >::value - 1 ) 
Chris@16:             / byte_to_memunit<x_iterator>::value 
Chris@16:             + ( _align_in_bytes > 0 ? _align_in_bytes - 1 : 0 ); // add extra padding in case we need to align the first image pixel
Chris@16:     }
Chris@16: 
Chris@16:     std::size_t get_row_size_in_memunits(x_coord_t width) const {   // number of units per row
Chris@16:         std::size_t size_in_memunits = width*memunit_step(typename view_t::x_iterator());
Chris@16:         if (_align_in_bytes>0) {
Chris@16:             std::size_t alignment_in_memunits=_align_in_bytes*byte_to_memunit<typename view_t::x_iterator>::value;
Chris@16:             return align(size_in_memunits, alignment_in_memunits);
Chris@16:         }
Chris@16:         return size_in_memunits;
Chris@16:     }
Chris@16:     
Chris@16:     void allocate_(const point_t& dimensions, mpl::false_) {  // if it throws and _memory!=0 the client must deallocate _memory
Chris@16:         _memory=_alloc.allocate(total_allocated_size_in_bytes(dimensions));
Chris@16:         unsigned char* tmp=(_align_in_bytes>0) ? (unsigned char*)align((std::size_t)_memory,_align_in_bytes) : _memory;
Chris@16:         _view=view_t(dimensions,typename view_t::locator(typename view_t::x_iterator(tmp),get_row_size_in_memunits(dimensions.x)));
Chris@16:     }
Chris@16: 
Chris@16:     void allocate_(const point_t& dimensions, mpl::true_) {   // if it throws and _memory!=0 the client must deallocate _memory
Chris@16:         std::size_t row_size=get_row_size_in_memunits(dimensions.x);
Chris@16:         std::size_t plane_size=row_size*dimensions.y;
Chris@16:         _memory=_alloc.allocate(total_allocated_size_in_bytes(dimensions));
Chris@16:         unsigned char* tmp=(_align_in_bytes>0) ? (unsigned char*)align((std::size_t)_memory,_align_in_bytes) : _memory;
Chris@16:         typename view_t::x_iterator first; 
Chris@16:         for (int i=0; i<num_channels<view_t>::value; ++i) {
Chris@16:             dynamic_at_c(first,i) = (typename channel_type<view_t>::type*)tmp;
Chris@16:             memunit_advance(dynamic_at_c(first,i), plane_size*i);
Chris@16:         }
Chris@16:         _view=view_t(dimensions, typename view_t::locator(first, row_size));
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@16: template <typename Pixel, bool IsPlanar, typename Alloc>
Chris@16: void swap(image<Pixel, IsPlanar, Alloc>& im1,image<Pixel, IsPlanar, Alloc>& im2) {
Chris@16:     im1.swap(im2); 
Chris@16: }
Chris@16: 
Chris@16: template <typename Pixel1, bool IsPlanar1, typename Alloc1, typename Pixel2, bool IsPlanar2, typename Alloc2>
Chris@16: bool operator==(const image<Pixel1,IsPlanar1,Alloc1>& im1,const image<Pixel2,IsPlanar2,Alloc2>& im2) {
Chris@16:     if ((void*)(&im1)==(void*)(&im2)) return true;
Chris@16:     if (const_view(im1).dimensions()!=const_view(im2).dimensions()) return false;
Chris@16:     return equal_pixels(const_view(im1),const_view(im2));
Chris@16: }
Chris@16: template <typename Pixel1, bool IsPlanar1, typename Alloc1, typename Pixel2, bool IsPlanar2, typename Alloc2>
Chris@16: bool operator!=(const image<Pixel1,IsPlanar1,Alloc1>& im1,const image<Pixel2,IsPlanar2,Alloc2>& im2) {return !(im1==im2);}
Chris@16: 
Chris@16: ///@{
Chris@16: /// \name view, const_view
Chris@16: /// \brief Get an image view from an image
Chris@16: 
Chris@16: /// \ingroup ImageModel
Chris@16: 
Chris@16: /// \brief Returns the non-constant-pixel view of an image
Chris@16: template <typename Pixel, bool IsPlanar, typename Alloc> inline 
Chris@16: const typename image<Pixel,IsPlanar,Alloc>::view_t& view(image<Pixel,IsPlanar,Alloc>& img) { return img._view; }
Chris@16: 
Chris@16: /// \brief Returns the constant-pixel view of an image
Chris@16: template <typename Pixel, bool IsPlanar, typename Alloc> inline 
Chris@16: const typename image<Pixel,IsPlanar,Alloc>::const_view_t const_view(const image<Pixel,IsPlanar,Alloc>& img) { 
Chris@16:     return static_cast<const typename image<Pixel,IsPlanar,Alloc>::const_view_t>(img._view); 
Chris@16: }
Chris@16: ///@}
Chris@16: 
Chris@16: /////////////////////////////
Chris@16: //  PixelBasedConcept
Chris@16: /////////////////////////////
Chris@16: 
Chris@16: template <typename Pixel, bool IsPlanar, typename Alloc>
Chris@16: struct channel_type<image<Pixel,IsPlanar,Alloc> > : public channel_type<Pixel> {}; 
Chris@16: 
Chris@16: template <typename Pixel, bool IsPlanar, typename Alloc>
Chris@16: struct color_space_type<image<Pixel,IsPlanar,Alloc> >  : public color_space_type<Pixel> {};
Chris@16: 
Chris@16: template <typename Pixel, bool IsPlanar, typename Alloc>
Chris@16: struct channel_mapping_type<image<Pixel,IsPlanar,Alloc> > : public channel_mapping_type<Pixel> {};
Chris@16: 
Chris@16: template <typename Pixel, bool IsPlanar, typename Alloc>
Chris@16: struct is_planar<image<Pixel,IsPlanar,Alloc> > : public mpl::bool_<IsPlanar> {};
Chris@16: 
Chris@16: //#ifdef _MSC_VER
Chris@16: //#pragma warning(pop)
Chris@16: //#endif
Chris@16: 
Chris@16: } }  // namespace boost::gil
Chris@16: 
Chris@16: #endif