Image.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2016 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef IGNITION_COMMON_IMAGE_HH_
#define IGNITION_COMMON_IMAGE_HH_

#include <memory>
#include <string>
#include <vector>
#include <ignition/math/Color.hh>
#include <ignition/common/graphics/Export.hh>
#include <ignition/common/SuppressWarning.hh>

namespace ignition
{
  namespace common
  {
    class ImagePrivate;

    static std::string PixelFormatNames[] =
    {
      "UNKNOWN_PIXEL_FORMAT",
      "L_INT8",
      "L_INT16",
      "RGB_INT8",
      "RGBA_INT8",
      "BGRA_INT8",
      "RGB_INT16",
      "RGB_INT32",
      "BGR_INT8",
      "BGR_INT16",
      "BGR_INT32",
      "R_FLOAT16",
      "RGB_FLOAT16",
      "R_FLOAT32",
      "RGB_FLOAT32",
      "BAYER_RGGB8",
      "BAYER_RGGR8",
      "BAYER_GBRG8",
      "BAYER_GRBG8",
      "BAYER_BGGR8"
    };

    class IGNITION_COMMON_GRAPHICS_VISIBLE Image
    {
      public: enum PixelFormatType
              {
                UNKNOWN_PIXEL_FORMAT = 0,
                L_INT8,
                L_INT16,
                RGB_INT8,
                RGBA_INT8,
                BGRA_INT8,
                RGB_INT16,
                RGB_INT32,
                BGR_INT8,
                BGR_INT16,
                BGR_INT32,
                R_FLOAT16,
                RGB_FLOAT16,
                R_FLOAT32,
                RGB_FLOAT32,
                BAYER_RGGB8,
                BAYER_RGGR8,
                BAYER_GBRG8,
                BAYER_GRBG8,
                PIXEL_FORMAT_COUNT,
                BAYER_BGGR8
              };


      public: static Image::PixelFormatType ConvertPixelFormat(
                  const std::string &_format);

      public: explicit Image(const std::string &_filename = "");

      public: virtual ~Image();

      public: int Load(const std::string &_filename);

      public: void SavePNG(const std::string &_filename);

      public: void SavePNGToBuffer(std::vector<unsigned char> &_buffer);

      public: void SetFromData(const unsigned char *_data,
                               unsigned int _width,
                               unsigned int _height,
                               Image::PixelFormatType _format);

      public: void Data(unsigned char **_data,
                        unsigned int &_count) const;

      public: void RGBData(unsigned char **_data,
                           unsigned int &_count) const;

      public: unsigned int Width() const;

      public: unsigned int Height() const;

      public: unsigned int BPP() const;

      // \brief Get the size of a row of pixel
      public: int Pitch() const;

      public: std::string Filename() const;

      public: PixelFormatType PixelFormat() const;

      public: math::Color Pixel(const unsigned int _x,
                  const unsigned int _y) const;

      public: math::Color AvgColor();

      public: math::Color MaxColor() const;

      public: void Rescale(const int _width, const int _height);

      public: bool Valid() const;

      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<ImagePrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };
  }
}
#endif