DCommon.h

/*
 * Copyright (c) 2011-2016, Matthieu FAESSEL and ARMINES
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Matthieu FAESSEL, or ARMINES nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef _DCOMMON_H
#define _DCOMMON_H
 
#include <cstring>
#include <memory>
#include <limits>
#include <vector>
#include <map>
#include <cmath>
#include <cstdarg>
#include <iostream>
 
#include "private/DTypes.hpp"
 
using namespace std;
 
namespace smil
{
#define VERBOSE 1
 
#if VERBOSE > 1
#define MESSAGE(msg) cout << msg << endl;
#else // VERBOSE
#define MESSAGE(msg)
#endif // VERBOSE
 
#if defined __GNUC__ || defined __clang__
#define SMIL_UNUSED __attribute__((__unused__))
#else // MSVC et al.
#define SMIL_UNUSED
#endif
 
#define INLINE inline
 
  // Generate template specializations (or instanciations?) for
  // ImageHandler subclasses (in IO/DImageIO_{BMP,JPG,PBM,PNG,TIFF})
#define IMAGEFILEHANDLER_TEMP_SPEC(FORMAT, PIXELTYPE)                          \
  template <>                                                                  \
  class FORMAT##ImageFileHandler<PIXELTYPE>                                    \
      : public ImageFileHandler<PIXELTYPE>                                     \
  {                                                                            \
  public:                                                                      \
    FORMAT##ImageFileHandler() : ImageFileHandler<PIXELTYPE>(#FORMAT)          \
    {                                                                          \
    }                                                                          \
    RES_T read(const char *filename, Image<PIXELTYPE> &image);                 \
    RES_T write(const Image<PIXELTYPE> &image, const char *filename);          \
  };
 
#define SMART_POINTER(T) boost::shared_ptr<T>
#define SMART_IMAGE(T) SMART_POINTER(D_Image<T>)
 
#define D_DEFAULT_IMAGE_WIDTH 512
#define D_DEFAULT_IMAGE_HEIGHT 512
#define D_DEFAULT_IMAGE_DEPTH 1
 
#define D_DEFAULT_OUT_PIXEL_VAL 0
 
#ifndef PI
#define PI 3.141592653589793
#endif // PI
 
#ifndef MIN
#define MIN(a, b) ((a) < (b) ? (a) : (b))
#endif // MIN
#ifndef MAX
#define MAX(a, b) ((a) > (b) ? (a) : (b))
#endif // MAX
#ifndef ABS
#define ABS(a) ((a) >= 0 ? (a) : -(a))
#endif // ABS
 
#ifndef SWIG
  struct map_comp_value_less {
    template <typename Lhs, typename Rhs>
    bool operator()(const Lhs &lhs, const Rhs &rhs) const
    {
      return lhs.second < rhs.second;
    }
  };
#endif // SWIG
 
  template <class T=int>
  class Point
  {
  public:
    T x;
    T y;
    T z;
  public:
    Point() : x(0), y(0), z(0)
    {
    }
 
    Point(const Point &pt) : x(pt.x), y(pt.y), z(pt.z)
    {
    }
 
    Point(T _x, T _y, T _z) : x(_x), y(_y), z(_z)
    {
    }
 
    Point(T _x, T _y) : x(_x), y(_y), z(0)
    {
    }
 
    bool operator==(const Point &p2)
    {
      return (x == p2.x && y == p2.y && z == p2.z);
    }
 
    Point operator-(const Point &p2)
    {
      return Point(x - p2.x, y - p2.y, z - p2.z);
    }
 
    Point operator+(const Point &p2)
    {
      return Point(x + p2.x, y + p2.y, z + p2.z);
    }
 
    void printSelf(string indent = "")
    {
      cout << indent << " " << x << "\t" << y << "\t" << z << endl;
    }
  };
 
  typedef Point<double> DoublePoint;
 
  typedef Point<int> IntPoint;
 
  typedef Point<UINT> UintPoint;
 
  typedef vector<double> Vector_double;
 
  typedef vector<Vector_double> Matrix_double;
 
  typedef vector<UINT> Vector_UINT;
 
  typedef vector<size_t> Vector_size_t;
 
  typedef vector<off_t> Vector_off_t;
 
  struct Rectangle {
    UINT x0, y0;
    UINT xSize, ySize;
  };
 
  class ImageBox {
  public:
    IntPoint pt;
    off_t    reference;
    size_t   width, height, depth;
 
  public:
    ImageBox(size_t Size[3])
    {
      width  = Size[0];
      height = Size[1];
      depth  = Size[2];
      pt.x = pt.y = pt.z = 0;
      reference = 0;
    }
 
    ImageBox(const ImageBox &box)
    {
      *this     = box;
    }
 
    ImageBox(size_t width, size_t height, size_t depth = 1)
    {
      this->width  = width;
      this->height = height;
      this->depth  = depth;
      pt.x = pt.y = pt.z = 0;
      reference = 0;
    }
 
    void setReference(off_t x, off_t y, off_t z = 0)
    {
      this->pt.x = x;
      this->pt.y = y;
      this->pt.z = z;
 
      this->reference = x + y * width + z * width * height;
    }
 
    void setReference(IntPoint pt)
    {
      this->pt        = pt;
      this->reference = pt.x + (pt.y + pt.z * width) * height;
    }
 
    void setReference(off_t offset)
    {
      this->reference = offset;
 
      this->pt.x = offset % width;
      offset     = (offset - this->pt.x) / width;
      this->pt.y = offset % height;
      this->pt.z = (offset - this->pt.y) / height;
    }
 
    IntPoint getPoint()
    {
      return pt;
    }
 
    off_t getOffset()
    {
      return reference;
    }
 
    void shift(off_t dx, off_t dy, off_t dz = 0)
    {
      pt.x += dx;
      pt.y += dy;
      pt.z += dz;
      this->reference = pt.x + (pt.y * width + pt.z * height) * width;
    }
 
    void shift(IntPoint dp)
    {
      pt.x += dp.x;
      pt.y += dp.y;
      pt.z += dp.z;
      this->reference = pt.x + (pt.y + pt.z * height) * width;
    }
 
 
    bool inImage()
    {
      return inImage(pt.x, pt.y, pt.z);
    }
 
#if 0
    bool inImage(off_t x, off_t y, off_t z = 0)
    {
      return (x >= 0 && x < width && y >= 0 && y < height && z >= 0 &&
              z < depth);
    }
#else
    bool inImage(size_t x, size_t y, size_t z = 0)
    {
      return (x < width && y < height && z < depth);
    }
#endif
 
    bool inImage(IntPoint p)
    {
      return inImage(p.x, p.y, p.z);
    }
 
    off_t getOffset(IntPoint p)
    {
      return p.x + width * (p.y + p.z * height);
    }
 
    IntPoint getCoords(off_t off)
    {
      IntPoint p;
      p.x = off % width;
      off = (off - p.x) / width;
      p.y = off % height;
      p.z = (off - p.y) / height;
 
      return p;
    }
 
    double getDistance(off_t pa, off_t pb)
    {
      IntPoint a = getCoords(pa);
      IntPoint b = getCoords(pb);
 
      return getDistance(a, b);
    }
 
    double getDistance(off_t p)
    {
      return getDistance(reference, p);
    }
 
    double getDistance(IntPoint p)
    {
      return getDistance(pt, p);
    }
 
    double getDistance(IntPoint a, IntPoint b)
    {
      return sqrt(pow(a.x - b.x, 2) + pow(a.y - b.y, 2) + pow(a.z - b.z, 2));
    }
 
    void printSelf()
    {
      cout << "ImageBox :" << endl;
      cout << "  Width :\t" << width << endl;
      cout << "  Height:\t" << height << endl;
      cout << "  Depth :\t" << depth << endl;
    }
  };
 
  // Misc Macros
#ifdef _MSC_VER
 
#define __FUNC__ __FUNCTION__
 
// Work-around to MSVC __VA_ARGS__ expanded as a single argument, instead of
// being broken down to multiple ones
#define EXPAND(...) __VA_ARGS__
 
#define _GET_1ST_ARG(arg1, ...) arg1
#define _GET_2ND_ARG(arg1, arg2, ...) arg2
#define _GET_3RD_ARG(arg1, arg2, arg3, ...) arg3
#define _GET_4TH_ARG(arg1, arg2, arg3, arg4, ...) arg4
#define _GET_5TH_ARG(arg1, arg2, arg3, arg4, arg5, ...) arg5
#define _GET_6TH_ARG(arg1, arg2, arg3, arg4, arg5, arg6, ...) arg6
#define _GET_7TH_ARG(arg1, arg2, arg3, arg4, arg5, arg6, arg7, ...) arg7
#define _GET_8TH_ARG(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, ...) arg8
#define GET_1ST_ARG(...) EXPAND(_GET_1ST_ARG(__VA_ARGS__))
#define GET_2ND_ARG(...) EXPAND(_GET_2ND_ARG(__VA_ARGS__))
#define GET_3RD_ARG(...) EXPAND(_GET_3RD_ARG(__VA_ARGS__))
#define GET_4TH_ARG(...) EXPAND(_GET_4TH_ARG(__VA_ARGS__))
#define GET_5TH_ARG(...) EXPAND(_GET_5TH_ARG(__VA_ARGS__))
#define GET_6TH_ARG(...) EXPAND(_GET_6TH_ARG(__VA_ARGS__))
#define GET_7TH_ARG(...) EXPAND(_GET_7TH_ARG(__VA_ARGS__))
#define GET_8TH_ARG(...) EXPAND(_GET_8TH_ARG(__VA_ARGS__))
 
#define _xPP_NARGS_IMPL(x1, x2, x3, x4, x5, x6, x7, x8, x9, x10, x11, x12,     \
                        x13, x14, x15, N, ...)                                 \
  N
#define PP_NARGS(...)                                                          \
  EXPAND(_xPP_NARGS_IMPL(__VA_ARGS__, 15, 14, 13, 12, 11, 10, 9, 8, 7, 6, 5,   \
                         4, 3, 2, 1, 0))
 
#else // _MSC_VER
 
#define __FUNC__ __func__
 
#define GET_1ST_ARG(arg1, ...) arg1
#define GET_2ND_ARG(arg1, arg2, ...) arg2
#define GET_3RD_ARG(arg1, arg2, arg3, ...) arg3
#define GET_4TH_ARG(arg1, arg2, arg3, arg4, ...) arg4
#define GET_5TH_ARG(arg1, arg2, arg3, arg4, arg5, ...) arg5
#define GET_6TH_ARG(arg1, arg2, arg3, arg4, arg5, arg6, ...) arg6
#define GET_7TH_ARG(arg1, arg2, arg3, arg4, arg5, arg6, arg7, ...) arg7
#define GET_8TH_ARG(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, ...) arg8
 
#define _xPP_NARGS_IMPL(x1, x2, x3, x4, x5, x6, x7, x8, x9, x10, x11, x12,     \
                        x13, x14, x15, N, ...)                                 \
  N
#define PP_NARGS(...)                                                          \
  _xPP_NARGS_IMPL(__VA_ARGS__, 15, 14, 13, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, \
                  1, 0)
 
#endif // _MSC_VER
} // namespace smil
 
#endif // _DCOMMON_H