// ***************************************************************** -*- C++ -*-

/*

 * Copyright (C) 2004-2018 Exiv2 authors

 * This program is part of the Exiv2 distribution.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, 5th Floor, Boston, MA 02110-1301 USA.

 */

/*!

  @file    rafimage.hpp

  @brief   Fujifilm RAW image

  @author  Andreas Huggel (ahu)

           ahuggel@gmx.net

  @date    05-Feb-07, ahu: created

 */

#ifndef RAFIMAGE_HPP_

#define RAFIMAGE_HPP_

// *****************************************************************************

#include "exiv2lib_export.h"

// included header files

#include "image.hpp"

#include "basicio.hpp"

#include "types.hpp"

// + standard includes

#include <string>

// *****************************************************************************

// namespace extensions

namespace Exiv2 {

// *****************************************************************************

// class definitions

    // Add RAF to the supported image formats

    namespace ImageType {

        const int raf = 8;          //!< RAF image type (see class RafImage)

    }

    /*!

      @brief Class to access raw Fujifilm RAF images. Exif metadata is

          supported directly, IPTC is read from the Exif data, if present.

     */

    class EXIV2API RafImage : public Image {

    public:

        //! @name Creators

        //@{

        /*!

          @brief Constructor that can either open an existing RAF image or create

              a new image from scratch. If a new image is to be created, any

              existing data is overwritten. Since the constructor can not return

              a result, callers should check the good() method after object

              construction to determine success or failure.

          @param io An auto-pointer that owns a BasicIo instance used for

              reading and writing image metadata. \b Important: The constructor

              takes ownership of the passed in BasicIo instance through the

              auto-pointer. Callers should not continue to use the BasicIo

              instance after it is passed to this method.  Use the Image::io()

              method to get a temporary reference.

          @param create Specifies if an existing image should be read (false)

              or if a new file should be created (true).

         */

        RafImage(BasicIo::AutoPtr io, bool create);

        //@}

        //! @name Manipulators

        //@{

        void printStructure(std::ostream& out, PrintStructureOption option,int depth);

        void readMetadata();

        /*!

          @brief Todo: Write metadata back to the image. This method is not

              yet implemented. Calling it will throw an Error(kerWritingImageFormatUnsupported).

         */

        void writeMetadata();

        /*!

          @brief Todo: Not supported yet, requires writeMetadata(). Calling

              this function will throw an Error(kerInvalidSettingForImage).

         */

        void setExifData(const ExifData& exifData);

        /*!

          @brief Todo: Not supported yet, requires writeMetadata(). Calling

              this function will throw an Error(kerInvalidSettingForImage).

         */

        void setIptcData(const IptcData& iptcData);

        /*!

          @brief Not supported. RAF format does not contain a comment.

              Calling this function will throw an Error(kerInvalidSettingForImage).

         */

        void setComment(const std::string& comment);

        //@}

        //! @name Accessors

        //@{

        std::string mimeType() const;

        int pixelWidth() const;

        int pixelHeight() const;

        //@}

    private:

        //! @name NOT implemented

        //@{

        //! Copy constructor

        RafImage(const RafImage& rhs);

        //! Assignment operator

        RafImage& operator=(const RafImage& rhs);

        //@}

    }; // class RafImage

// *****************************************************************************

// template, inline and free functions

    // These could be static private functions on Image subclasses but then

    // ImageFactory needs to be made a friend.

    /*!

      @brief Create a new RafImage instance and return an auto-pointer to it.

             Caller owns the returned object and the auto-pointer ensures that

             it will be deleted.

     */

    EXIV2API Image::AutoPtr newRafInstance(BasicIo::AutoPtr io, bool create);

    //! Check if the file iIo is a RAF image.

    EXIV2API bool isRafType(BasicIo& iIo, bool advance);

}                                       // namespace Exiv2

#endif                                  // #ifndef RAFIMAGE_HPP_