IFD.h

/*
 * #%L
 * OME-FILES C++ library for image IO.
 * Copyright © 2006 - 2015 Open Microscopy Environment:
 *   - Massachusetts Institute of Technology
 *   - National Institutes of Health
 *   - University of Dundee
 *   - Board of Regents of the University of Wisconsin-Madison
 *   - Glencoe Software, Inc.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. 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.
 *
 * 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 OR 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.
 *
 * The views and conclusions contained in the software and documentation are
 * those of the authors and should not be interpreted as representing official
 * policies, either expressed or implied, of any organization.
 * #L%
 */

#ifndef OME_FILES_TIFF_IFD_H
#define OME_FILES_TIFF_IFD_H

#include <memory>
#include <string>

#include <ome/files/CoreMetadata.h>
#include <ome/files/TileCoverage.h>
#include <ome/files/tiff/TileInfo.h>
#include <ome/files/tiff/Types.h>
#include <ome/files/VariantPixelBuffer.h>

#include <ome/xml/model/enums/PixelType.h>

namespace ome
{
  namespace files
  {
    namespace tiff
    {

      class TIFF;

      template<typename Tag>
      class Field;

      class IFD : public std::enable_shared_from_this<IFD>
      {
      private:
        class Impl;
        std::shared_ptr<Impl> impl;

      protected:
        IFD(std::shared_ptr<TIFF>& tiff,
            offset_type            offset);

        IFD(std::shared_ptr<TIFF>& tiff);

        IFD (const IFD&) = delete;

        IFD&
        operator= (const IFD&) = delete;

      public:
        virtual ~IFD();

        static std::shared_ptr<IFD>
        openIndex(std::shared_ptr<TIFF>& tiff,
                  directory_index_type   index);

        static std::shared_ptr<IFD>
        openOffset(std::shared_ptr<TIFF>& tiff,
                   offset_type            offset);

        static std::shared_ptr<IFD>
        current(std::shared_ptr<TIFF>& tiff);

        std::shared_ptr<TIFF>&
        getTIFF() const;

        void
        makeCurrent() const;

        offset_type
        getOffset() const;

        void
        getRawField(tag_type tag,
                    ...) const;

        void
        getRawFieldDefaulted(tag_type tag,
                             ...) const;

        void
        setRawField(tag_type tag,
                    ...);

        template<typename TagCategory>
        Field<TagCategory>
        getField(TagCategory tag)
        {
          return Field<TagCategory>(this->shared_from_this(), tag);
        }

        template<typename TagCategory>
        const Field<TagCategory>
        getField(TagCategory tag) const
        {
          return Field<TagCategory>(const_cast<IFD *>(this)->shared_from_this(), tag);
        }

        TileType
        getTileType() const;

        void
        setTileType(TileType type);

        dimension_size_type
        getCurrentTile() const;

        void
        setCurrentTile(dimension_size_type tile);

        TileInfo
        getTileInfo();

        const TileInfo
        getTileInfo() const;

        std::vector<TileCoverage>&
        getTileCoverage();

        const std::vector<TileCoverage>&
        getTileCoverage() const;

        uint32_t
        getImageWidth() const;

        void
        setImageWidth(uint32_t width);

        uint32_t
        getImageHeight() const;

        void
        setImageHeight(uint32_t height);

        uint32_t
        getTileWidth() const;

        void
        setTileWidth(uint32_t width);

        uint32_t
        getTileHeight() const;

        void
        setTileHeight(uint32_t height);

        ::ome::xml::model::enums::PixelType
        getPixelType() const;

        void
        setPixelType(::ome::xml::model::enums::PixelType type);

        uint16_t
        getBitsPerSample() const;

        void
        setBitsPerSample(uint16_t samples);

        uint16_t
        getSamplesPerPixel() const;

        void
        setSamplesPerPixel(uint16_t samples);

        PlanarConfiguration
        getPlanarConfiguration() const;

        void
        setPlanarConfiguration(PlanarConfiguration planarconfig);

        PhotometricInterpretation
        getPhotometricInterpretation() const;

        void
        setPhotometricInterpretation(PhotometricInterpretation photometric);

        Compression
        getCompression() const;

        void
        setCompression(Compression compression);

        void
        readImage(VariantPixelBuffer& buf) const;

        void
        readImage(VariantPixelBuffer& buf,
                  dimension_size_type subC) const;

        void
        readImage(VariantPixelBuffer& dest,
                  dimension_size_type x,
                  dimension_size_type y,
                  dimension_size_type w,
                  dimension_size_type h) const;

        void
        readImage(VariantPixelBuffer& dest,
                  dimension_size_type x,
                  dimension_size_type y,
                  dimension_size_type w,
                  dimension_size_type h,
                  dimension_size_type subC) const;

        void
        readLookupTable(VariantPixelBuffer& buf) const;

        void
        writeImage(const VariantPixelBuffer& buf);

        void
        writeImage(const VariantPixelBuffer& buf,
                   dimension_size_type       subC);

        void
        writeImage(const VariantPixelBuffer& source,
                   dimension_size_type       x,
                   dimension_size_type       y,
                   dimension_size_type       w,
                   dimension_size_type       h);

        void
        writeImage(const VariantPixelBuffer& source,
                   dimension_size_type       x,
                   dimension_size_type       y,
                   dimension_size_type       w,
                   dimension_size_type       h,
                   dimension_size_type       subC);

        std::shared_ptr<IFD>
        next() const;

        bool
        last() const;
      };

    }
  }
}

#endif // OME_FILES_TIFF_IFD_H

/*
 * Local Variables:
 * mode:C++
 * End:
 */