13 #ifndef GIL_CHANNEL_HPP
14 #define GIL_CHANNEL_HPP
31 #include <boost/config.hpp>
32 #include <boost/integer/integer_mask.hpp>
33 #include <boost/type_traits/remove_cv.hpp>
39 namespace boost {
namespace gil {
58 template <
typename T,
bool is_
class>
struct channel_traits_impl;
62 struct channel_traits_impl<T, true> {
63 typedef typename T::value_type value_type;
64 typedef typename T::reference reference;
65 typedef typename T::pointer pointer;
66 typedef typename T::const_reference const_reference;
67 typedef typename T::const_pointer const_pointer;
68 BOOST_STATIC_CONSTANT(
bool, is_mutable=T::is_mutable);
69 static value_type min_value() {
return T::min_value(); }
70 static value_type max_value() {
return T::max_value(); }
75 struct channel_traits_impl<T, false> {
79 typedef const T& const_reference;
80 typedef T
const* const_pointer;
81 BOOST_STATIC_CONSTANT(
bool, is_mutable=
true);
82 static value_type min_value() {
return (std::numeric_limits<T>::min)(); }
83 static value_type max_value() {
return (std::numeric_limits<T>::max)(); }
88 struct channel_traits_impl<const T, false> :
public channel_traits_impl<T, false> {
89 typedef const T& reference;
90 typedef const T* pointer;
91 BOOST_STATIC_CONSTANT(
bool, is_mutable=
false);
113 template <
typename T>
114 struct channel_traits :
public detail::channel_traits_impl<T, is_class<T>::value> {};
120 template <
typename T>
struct channel_traits<const T&> :
public channel_traits<T> {
121 typedef typename channel_traits<T>::const_reference reference;
122 typedef typename channel_traits<T>::const_pointer pointer;
123 BOOST_STATIC_CONSTANT(
bool, is_mutable=
false);
152 template <
typename BaseChannelValue,
155 typename MinVal,
typename MaxVal>
164 typedef BaseChannelValue base_channel_t;
166 static value_type min_value() {
return MinVal::apply(); }
167 static value_type max_value() {
return MaxVal::apply(); }
179 template <
typename Scalar2>
scoped_channel_value& operator+=(Scalar2 v) { _value+=v;
return *
this; }
180 template <
typename Scalar2>
scoped_channel_value& operator-=(Scalar2 v) { _value-=v;
return *
this; }
181 template <
typename Scalar2>
scoped_channel_value& operator*=(Scalar2 v) { _value*=v;
return *
this; }
182 template <
typename Scalar2>
scoped_channel_value& operator/=(Scalar2 v) { _value/=v;
return *
this; }
185 operator BaseChannelValue()
const {
return _value; }
187 BaseChannelValue _value;
190 template <
typename T>
191 struct float_point_zero
193 static constexpr T apply() {
return 0.0f; }
196 template <
typename T>
197 struct float_point_one
199 static constexpr T apply() {
return 1.0f; }
214 template <
int NumBits>
215 struct min_fast_uint :
public mpl::if_c< (NumBits<=8),
217 typename mpl::if_c< (NumBits<=16),
219 typename mpl::if_c< (NumBits<=32),
226 template <int NumBits>
227 struct num_value_fn : public mpl::if_c< ( NumBits < 32 )
232 template <int NumBits>
233 struct max_value_fn : public mpl::if_c< ( NumBits <= 32 )
255 template <int NumBits>
258 class packed_channel_value {
261 typedef typename detail::min_fast_uint<NumBits>::type integer_t;
264 typedef packed_channel_value value_type;
265 typedef value_type& reference;
266 typedef const value_type& const_reference;
267 typedef value_type* pointer;
268 typedef const value_type* const_pointer;
270 static value_type min_value() { return 0; }
271 static value_type max_value() { return low_bits_mask_t< NumBits >::sig_bits; }
273 BOOST_STATIC_CONSTANT(bool, is_mutable=true);
275 packed_channel_value() {}
277 packed_channel_value(integer_t v) { _value = static_cast< integer_t >( v & low_bits_mask_t<NumBits>::sig_bits_fast ); }
278 template <typename Scalar> packed_channel_value(Scalar v) { _value = packed_channel_value( static_cast< integer_t >( v ) ); }
280 static unsigned int num_bits() { return NumBits; }
282 operator integer_t() const { return _value; }
289 template <std::size_t K>
290 struct static_copy_bytes {
291 void operator()(const unsigned char* from, unsigned char* to) const {
293 static_copy_bytes<K-1>()(++from,++to);
298 struct static_copy_bytes<0> {
299 void operator()(const unsigned char* , unsigned char*) const {}
302 template <typename Derived, typename BitField, int NumBits, bool Mutable>
303 class packed_channel_reference_base {
305 typedef typename mpl::if_c<Mutable,void*,const void*>::type data_ptr_t;
307 data_ptr_t _data_ptr;
309 typedef packed_channel_value<NumBits> value_type;
310 typedef const Derived reference;
311 typedef value_type* pointer;
312 typedef const value_type* const_pointer;
313 BOOST_STATIC_CONSTANT(int, num_bits=NumBits);
314 BOOST_STATIC_CONSTANT(bool, is_mutable=Mutable);
316 static value_type min_value() { return channel_traits<value_type>::min_value(); }
317 static value_type max_value() { return channel_traits<value_type>::max_value(); }
319 typedef BitField bitfield_t;
320 typedef typename value_type::integer_t integer_t;
322 packed_channel_reference_base(data_ptr_t data_ptr) : _data_ptr(data_ptr) {}
323 packed_channel_reference_base(const packed_channel_reference_base& ref) : _data_ptr(ref._data_ptr) {}
324 const Derived& operator=(integer_t v) const { set(v); return derived(); }
326 const Derived& operator++() const { set(get()+1); return derived(); }
327 const Derived& operator--() const { set(get()-1); return derived(); }
329 Derived operator++(int) const { Derived tmp=derived(); this->operator++(); return tmp; }
330 Derived operator--(int) const { Derived tmp=derived(); this->operator--(); return tmp; }
332 template <typename Scalar2> const Derived& operator+=(Scalar2 v) const { set( static_cast<integer_t>( get() + v )); return derived(); }
333 template <typename Scalar2> const Derived& operator-=(Scalar2 v) const { set( static_cast<integer_t>( get() - v )); return derived(); }
334 template <typename Scalar2> const Derived& operator*=(Scalar2 v) const { set( static_cast<integer_t>( get() * v )); return derived(); }
335 template <typename Scalar2> const Derived& operator/=(Scalar2 v) const { set( static_cast<integer_t>( get() / v )); return derived(); }
337 operator integer_t() const { return get(); }
338 data_ptr_t operator &() const {return _data_ptr;}
341 typedef typename detail::num_value_fn< NumBits >::type num_value_t;
342 typedef typename detail::max_value_fn< NumBits >::type max_value_t;
344 static const num_value_t num_values = static_cast< num_value_t >( 1 ) << NumBits ;
345 static const max_value_t max_val = static_cast< max_value_t >( num_values - 1 );
347 #if defined(BOOST_GIL_CONFIG_HAS_UNALIGNED_ACCESS)
348 const bitfield_t& get_data() const { return *static_cast<const bitfield_t*>(_data_ptr); }
349 void set_data(const bitfield_t& val) const { *static_cast< bitfield_t*>(_data_ptr) = val; }
351 bitfield_t get_data() const {
353 static_copy_bytes<sizeof(bitfield_t) >()(gil_reinterpret_cast_c<const unsigned char*>(_data_ptr),gil_reinterpret_cast<unsigned char*>(&ret));
356 void set_data(const bitfield_t& val) const {
357 static_copy_bytes<sizeof(bitfield_t) >()(gil_reinterpret_cast_c<const unsigned char*>(&val),gil_reinterpret_cast<unsigned char*>(_data_ptr));
362 void set(integer_t value) const {
363 this->derived().set_unsafe(((value % num_values) + num_values) % num_values);
365 integer_t get() const { return derived().get(); }
366 const Derived& derived() const { return static_cast<const Derived&>(*this); }
386 template <typename BitField,
387 int FirstBit, int NumBits,
389 class packed_channel_reference;
391 template <typename BitField,
394 class packed_dynamic_channel_reference;
398 template <typename BitField, int FirstBit, int NumBits>
399 class packed_channel_reference<BitField,FirstBit,NumBits,false>
400 : public detail::packed_channel_reference_base<packed_channel_reference<BitField,FirstBit,NumBits,false>,BitField,NumBits,false> {
401 typedef detail::packed_channel_reference_base<packed_channel_reference<BitField,FirstBit,NumBits,false>,BitField,NumBits,false> parent_t;
402 friend class packed_channel_reference<BitField,FirstBit,NumBits,true>;
404 static const BitField channel_mask = static_cast< BitField >( parent_t::max_val ) << FirstBit;
406 void operator=(const packed_channel_reference&);
408 typedef const packed_channel_reference<BitField,FirstBit,NumBits,false> const_reference;
409 typedef const packed_channel_reference<BitField,FirstBit,NumBits,true> mutable_reference;
410 typedef typename parent_t::integer_t integer_t;
412 explicit packed_channel_reference(const void* data_ptr) : parent_t(data_ptr) {}
413 packed_channel_reference(const packed_channel_reference& ref) : parent_t(ref._data_ptr) {}
414 packed_channel_reference(const mutable_reference& ref) : parent_t(ref._data_ptr) {}
416 unsigned first_bit() const { return FirstBit; }
418 integer_t get() const { return integer_t((this->get_data()&channel_mask) >> FirstBit); }
423 template <typename BitField, int FirstBit, int NumBits>
424 class packed_channel_reference<BitField,FirstBit,NumBits,true>
425 : public detail::packed_channel_reference_base<packed_channel_reference<BitField,FirstBit,NumBits,true>,BitField,NumBits,true> {
426 typedef detail::packed_channel_reference_base<packed_channel_reference<BitField,FirstBit,NumBits,true>,BitField,NumBits,true> parent_t;
427 friend class packed_channel_reference<BitField,FirstBit,NumBits,false>;
429 static const BitField channel_mask = static_cast< BitField >( parent_t::max_val ) << FirstBit;
432 typedef const packed_channel_reference<BitField,FirstBit,NumBits,false> const_reference;
433 typedef const packed_channel_reference<BitField,FirstBit,NumBits,true> mutable_reference;
434 typedef typename parent_t::integer_t integer_t;
436 explicit packed_channel_reference(void* data_ptr) : parent_t(data_ptr) {}
437 packed_channel_reference(const packed_channel_reference& ref) : parent_t(ref._data_ptr) {}
439 const packed_channel_reference& operator=(integer_t value) const { assert(value<=parent_t::max_val); set_unsafe(value); return *this; }
440 const packed_channel_reference& operator=(const mutable_reference& ref) const { set_from_reference(ref.get_data()); return *this; }
441 const packed_channel_reference& operator=(const const_reference& ref) const { set_from_reference(ref.get_data()); return *this; }
443 template <bool Mutable1>
444 const packed_channel_reference& operator=(const packed_dynamic_channel_reference<BitField,NumBits,Mutable1>& ref) const { set_unsafe(ref.get()); return *this; }
446 unsigned first_bit() const { return FirstBit; }
448 integer_t get() const { return integer_t((this->get_data()&channel_mask) >> FirstBit); }
449 void set_unsafe(integer_t value) const { this->set_data((this->get_data() & ~channel_mask) | (( static_cast< BitField >( value )<<FirstBit))); }
451 void set_from_reference(const BitField& other_bits) const { this->set_data((this->get_data() & ~channel_mask) | (other_bits & channel_mask)); }
465 template <typename BF, int FB, int NB, bool M, typename R> inline
466 void swap(const boost::gil::packed_channel_reference<BF,FB,NB,M> x, R& y) {
467 boost::gil::swap_proxy<typename boost::gil::packed_channel_reference<BF,FB,NB,M>::value_type>(x,y);
473 template <typename BF, int FB, int NB, bool M> inline
474 void swap(typename boost::gil::packed_channel_reference<BF,FB,NB,M>::value_type& x, const boost::gil::packed_channel_reference<BF,FB,NB,M> y) {
475 boost::gil::swap_proxy<typename boost::gil::packed_channel_reference<BF,FB,NB,M>::value_type>(x,y);
481 template <typename BF, int FB, int NB, bool M> inline
482 void swap(const boost::gil::packed_channel_reference<BF,FB,NB,M> x, const boost::gil::packed_channel_reference<BF,FB,NB,M> y) {
483 boost::gil::swap_proxy<typename boost::gil::packed_channel_reference<BF,FB,NB,M>::value_type>(x,y);
487 namespace boost { namespace gil {
506 template <typename BitField, int NumBits>
510 class packed_dynamic_channel_reference<BitField,NumBits,false>
511 : public detail::packed_channel_reference_base<packed_dynamic_channel_reference<BitField,NumBits,false>,BitField,NumBits,false> {
512 typedef detail::packed_channel_reference_base<packed_dynamic_channel_reference<BitField,NumBits,false>,BitField,NumBits,false> parent_t;
513 friend class packed_dynamic_channel_reference<BitField,NumBits,true>;
517 void operator=(const packed_dynamic_channel_reference&);
519 typedef const packed_dynamic_channel_reference<BitField,NumBits,false> const_reference;
520 typedef const packed_dynamic_channel_reference<BitField,NumBits,true> mutable_reference;
521 typedef typename parent_t::integer_t integer_t;
523 packed_dynamic_channel_reference(const void* data_ptr, unsigned first_bit) : parent_t(data_ptr), _first_bit(first_bit) {}
524 packed_dynamic_channel_reference(const const_reference& ref) : parent_t(ref._data_ptr), _first_bit(ref._first_bit) {}
525 packed_dynamic_channel_reference(const mutable_reference& ref) : parent_t(ref._data_ptr), _first_bit(ref._first_bit) {}
527 unsigned first_bit() const { return _first_bit; }
529 integer_t get() const {
530 const BitField channel_mask = static_cast< integer_t >( parent_t::max_val ) <<_first_bit;
531 return static_cast< integer_t >(( this->get_data()&channel_mask ) >> _first_bit );
538 template <typename BitField, int NumBits>
539 class packed_dynamic_channel_reference<BitField,NumBits,true>
540 :
public detail::packed_channel_reference_base<packed_dynamic_channel_reference<BitField,NumBits,true>,BitField,NumBits,true> {
541 typedef detail::packed_channel_reference_base<packed_dynamic_channel_reference<BitField,NumBits,true>,BitField,NumBits,
true> parent_t;
542 friend class packed_dynamic_channel_reference<BitField,NumBits,false>;
549 typedef typename parent_t::integer_t integer_t;
551 packed_dynamic_channel_reference(
void* data_ptr,
unsigned first_bit) : parent_t(data_ptr), _first_bit(first_bit) {}
552 packed_dynamic_channel_reference(
const packed_dynamic_channel_reference& ref) : parent_t(ref._data_ptr), _first_bit(ref._first_bit) {}
554 const packed_dynamic_channel_reference& operator=(integer_t value)
const { assert(value<=parent_t::max_val); set_unsafe(value);
return *
this; }
555 const packed_dynamic_channel_reference& operator=(
const mutable_reference& ref)
const { set_unsafe(ref.get());
return *
this; }
556 const packed_dynamic_channel_reference& operator=(
const const_reference& ref)
const { set_unsafe(ref.get());
return *
this; }
558 template <
typename BitField1,
int FirstBit1,
bool Mutable1>
559 const packed_dynamic_channel_reference& operator=(
const packed_channel_reference<BitField1, FirstBit1, NumBits, Mutable1>& ref)
const
560 { set_unsafe(ref.get());
return *
this; }
562 unsigned first_bit()
const {
return _first_bit; }
564 integer_t
get()
const {
565 const BitField channel_mask =
static_cast< integer_t
>( parent_t::max_val ) << _first_bit;
566 return static_cast< integer_t
>(( this->get_data()&channel_mask ) >> _first_bit );
569 void set_unsafe(integer_t value)
const {
570 const BitField channel_mask =
static_cast< integer_t
>( parent_t::max_val ) << _first_bit;
571 this->set_data((this->get_data() & ~channel_mask) | value<<_first_bit);
586 template <
typename BF,
int NB,
bool M,
typename R>
inline
587 void swap(
const boost::gil::packed_dynamic_channel_reference<BF,NB,M> x, R& y) {
588 boost::gil::swap_proxy<typename boost::gil::packed_dynamic_channel_reference<BF,NB,M>::value_type>(x,y);
594 template <
typename BF,
int NB,
bool M>
inline
595 void swap(
typename boost::gil::packed_dynamic_channel_reference<BF,NB,M>::value_type& x,
const boost::gil::packed_dynamic_channel_reference<BF,NB,M> y) {
596 boost::gil::swap_proxy<typename boost::gil::packed_dynamic_channel_reference<BF,NB,M>::value_type>(x,y);
602 template <
typename BF,
int NB,
bool M>
inline
603 void swap(
const boost::gil::packed_dynamic_channel_reference<BF,NB,M> x,
const boost::gil::packed_dynamic_channel_reference<BF,NB,M> y) {
604 boost::gil::swap_proxy<typename boost::gil::packed_dynamic_channel_reference<BF,NB,M>::value_type>(x,y);
610 template <
int NumBits>
611 struct is_integral<gil::packed_channel_value<NumBits> > :
public mpl::true_ {};
613 template <
typename BitField,
int FirstBit,
int NumBits,
bool IsMutable>
614 struct is_integral<gil::packed_channel_reference<BitField,FirstBit,NumBits,IsMutable> > :
public mpl::true_ {};
616 template <
typename BitField,
int NumBits,
bool IsMutable>
617 struct is_integral<gil::packed_dynamic_channel_reference<BitField,NumBits,IsMutable> > :
public mpl::true_ {};
619 template <
typename BaseChannelValue,
typename MinVal,
typename MaxVal>
620 struct is_integral<gil::scoped_channel_value<BaseChannelValue,MinVal,MaxVal> > :
public is_integral<BaseChannelValue> {};
625 namespace boost {
namespace gil {
626 template <
typename T>
627 struct base_channel_type_impl {
typedef T type; };
630 struct base_channel_type_impl<packed_channel_value<N> >
631 {
typedef typename packed_channel_value<N>::integer_t type; };
633 template <
typename B,
int F,
int N,
bool M>
634 struct base_channel_type_impl<packed_channel_reference<B, F, N, M> >
635 {
typedef typename packed_channel_reference<B,F,N,M>::integer_t type; };
637 template <
typename B,
int N,
bool M>
638 struct base_channel_type_impl<packed_dynamic_channel_reference<B, N, M> >
639 {
typedef typename packed_dynamic_channel_reference<B,N,M>::integer_t type; };
641 template <
typename ChannelValue,
typename MinV,
typename MaxV>
642 struct base_channel_type_impl<scoped_channel_value<ChannelValue, MinV, MaxV> >
643 {
typedef ChannelValue type; };
645 template <
typename T>
646 struct base_channel_type : base_channel_type_impl<typename remove_cv<T>::type > {};
void swap(const boost::gil::packed_dynamic_channel_reference< BF, NB, M > x, const boost::gil::packed_dynamic_channel_reference< BF, NB, M > y)
swap for packed_dynamic_channel_reference
Definition: channel.hpp:603
A channel adaptor that modifies the range of the source channel. Models: ChannelValueConcept.
Definition: channel.hpp:156
Models a constant subbyte channel reference whose bit offset is a runtime parameter. Models ChannelConcept Same as packed_channel_reference, except that the offset is a runtime parameter.
Definition: channel.hpp:510
Traits for channels. Contains the following members:
Definition: channel.hpp:114
Models a mutable subbyte channel reference whose bit offset is a runtime parameter. Models ChannelConcept Same as packed_channel_reference, except that the offset is a runtime parameter.
Definition: channel.hpp:539
Various utilities not specific to the image library. Some are non-standard STL extensions or generic ...