vpImageIo.h

/****************************************************************************
 *
 * This file is part of the ViSP software.
 * Copyright (C) 2005 - 2015 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * ("GPL") version 2 as published by the Free Software Foundation.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See http://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * Read/write images.
 *
 * Authors:
 * Eric Marchand
 *
 *****************************************************************************/


#ifndef vpIMAGEIO_H
#define vpIMAGEIO_H

#include <visp3/core/vpImage.h>
#include <visp3/core/vpDebug.h>
#include <visp3/core/vpRGBa.h>
#include <visp3/core/vpImageConvert.h>

#include <stdio.h>
#include <iostream>

#if defined(_WIN32)
#  include <windows.h>
#endif

#if defined(VISP_HAVE_JPEG)
#include <jpeglib.h>
#include <jerror.h>
#endif

#if defined(VISP_HAVE_PNG)
#include <png.h>
#endif


class VISP_EXPORT vpImageIo
{

private:
  
  typedef enum
  {
    FORMAT_PGM,
    FORMAT_PPM,
    FORMAT_JPEG,
    FORMAT_PNG,
    // Formats supported by opencv
    FORMAT_TIFF,
    FORMAT_BMP,
    FORMAT_DIB,
    FORMAT_PBM,
    FORMAT_RASTER,
    FORMAT_JPEG2000,
    FORMAT_UNKNOWN
  } vpImageFormatType;
  
  static const int vpMAX_LEN;

  static FILE * openFileRead(const char *filename) ;
  static FILE * openFileWrite(const char *filename, const char *mode="w") ;

  static FILE * openFileRead(const std::string filename) ;
  static FILE * openFileWrite(const std::string filename, 
                  const std::string mode="w") ;

  static vpImageFormatType getFormat(const char *filename) ;
  static std::string getExtension(const std::string &filename);

public:

  static
  void read(vpImage<unsigned char> &I, const char *filename) ;
  static
  void read(vpImage<unsigned char> &I, const std::string filename) ;
  static
  void read(vpImage<vpRGBa> &I, const char *filename) ;
  static
  void read(vpImage<vpRGBa> &I, const std::string filename) ;
  
  static
  void write(const vpImage<unsigned char> &I, const char *filename) ;
  static
  void write(const vpImage<unsigned char> &I, const std::string filename) ;
  static
  void write(const vpImage<vpRGBa> &I, const char *filename) ;
  static
  void write(const vpImage<vpRGBa> &I, const std::string filename) ;

 static
  void readPFM(vpImage<float> &I, const char *filename) ;


  static
  void readPGM(vpImage<unsigned char> &I, const char *filename) ;
  static
  void readPGM(vpImage<unsigned char> &I, const std::string filename) ;
  static
  void readPGM(vpImage<vpRGBa> &I, const char *filename) ;
  static
  void readPGM(vpImage<vpRGBa> &I, const std::string filename) ;

  static
  void readPPM(vpImage<unsigned char> &I, const char *filename) ;
  static
  void readPPM(vpImage<unsigned char> &I, const std::string filename) ;
  static
  void readPPM(vpImage<vpRGBa> &I, const char *filename) ;
  static
  void readPPM(vpImage<vpRGBa> &I, const std::string filename) ;

#if (defined(VISP_HAVE_JPEG) || defined(VISP_HAVE_OPENCV))
  static
  void readJPEG(vpImage<unsigned char> &I, const char *filename) ;
  static
  void readJPEG(vpImage<unsigned char> &I, const std::string filename) ;
  static
  void readJPEG(vpImage<vpRGBa> &I, const char *filename) ;
  static
  void readJPEG(vpImage<vpRGBa> &I, const std::string filename) ;
#endif

#if (defined(VISP_HAVE_PNG) || defined(VISP_HAVE_OPENCV))
  static
  void readPNG(vpImage<unsigned char> &I, const char *filename) ;
  static
  void readPNG(vpImage<unsigned char> &I, const std::string filename) ;
  static
  void readPNG(vpImage<vpRGBa> &I, const char *filename) ;
  static
  void readPNG(vpImage<vpRGBa> &I, const std::string filename) ;
#endif

  static
  void writePFM(const vpImage<float> &I, const char *filename) ;
 


  static
  void writePGM(const vpImage<unsigned char> &I, const char *filename) ;
  static
  void writePGM(const vpImage<unsigned char> &I, const std::string filename) ;
  static
  void writePGM(const vpImage<short> &I, const char *filename) ;
  static
  void writePGM(const vpImage<short> &I, const std::string filename) ;
  static
  void writePGM(const vpImage<vpRGBa> &I, const char *filename) ;
  static
  void writePGM(const vpImage<vpRGBa> &I, const std::string filename) ;

  static
  void writePPM(const vpImage<unsigned char> &I, const char *filename) ;
  static
  void writePPM(const vpImage<unsigned char> &I, const std::string filename) ;
  static
  void writePPM(const vpImage<vpRGBa> &I, const char *filename) ;
  static
  void writePPM(const vpImage<vpRGBa> &I, const std::string filename) ;

#if (defined(VISP_HAVE_JPEG) || defined(VISP_HAVE_OPENCV))
  static
  void writeJPEG(const vpImage<unsigned char> &I, const char *filename) ;
  static
  void writeJPEG(const vpImage<unsigned char> &I, const std::string filename) ;
  static
  void writeJPEG(const vpImage<vpRGBa> &I, const char *filename) ;
  static
  void writeJPEG(const vpImage<vpRGBa> &I, const std::string filename) ;
#endif

#if (defined(VISP_HAVE_PNG) || defined(VISP_HAVE_OPENCV))
  static
  void writePNG(const vpImage<unsigned char> &I, const char *filename) ;
  static
  void writePNG(const vpImage<unsigned char> &I, const std::string filename) ;
  static
  void writePNG(const vpImage<vpRGBa> &I, const char *filename) ;
  static
  void writePNG(const vpImage<vpRGBa> &I, const std::string filename) ;
#endif

  } ;
#endif