TiffEntry.h

Go to the documentation of this file.

/*
    RawSpeed - RAW file decoder.
 
    Copyright (C) 2009-2014 Klaus Post
    Copyright (C) 2015 Pedro Côrte-Real
    Copyright (C) 2017 Axel Waggershauser
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library 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
    Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
 
#pragma once
 
#include "rawspeedconfig.h"
#include "adt/NotARational.h"
#include "io/ByteStream.h"
#include "tiff/TiffTag.h"
#include <array>
#include <cstdint>
#include <string>
#include <vector>
 
namespace rawspeed {
 
class DataBuffer;
class TiffIFD;
class Buffer;
 
/*
 * Tag data type information.
 *
 * Note: RATIONALs are the ratio of two 32-bit integer values.
 */
enum class TiffDataType : uint8_t {
  NOTYPE = 0,     /* placeholder */
  BYTE = 1,       /* 8-bit unsigned integer */
  ASCII = 2,      /* 8-bit bytes w/ last byte null */
  SHORT = 3,      /* 16-bit unsigned integer */
  LONG = 4,       /* 32-bit unsigned integer */
  RATIONAL = 5,   /* 2x32-bit unsigned fraction */
  SBYTE = 6,      /* !8-bit signed integer */
  UNDEFINED = 7,  /* !8-bit untyped data */
  SSHORT = 8,     /* !16-bit signed integer */
  SLONG = 9,      /* !32-bit signed integer */
  SRATIONAL = 10, /* !2x32-bit signed fraction */
  FLOAT = 11,     /* !32-bit IEEE floating point */
  DOUBLE = 12,    /* !64-bit IEEE floating point */
  OFFSET = 13,    /* 32-bit unsigned offset used for IFD and other offsets */
};
 
class TiffEntry {
  TiffIFD* parent;
  ByteStream data;
 
  virtual void anchor() const;
 
  friend class TiffIFD;
 
  template <typename T, T (TiffEntry::*getter)(uint32_t index) const>
  [[nodiscard]] std::vector<T> getArray(uint32_t count_) const {
    std::vector<T> res(count_);
    for (uint32_t i = 0; i < count_; ++i)
      res[i] = (this->*getter)(i);
    return res;
  }
 
protected:
  void setData(ByteStream data_);
 
public:
  TiffTag tag;
  TiffDataType type;
  uint32_t count;
 
  TiffEntry(TiffIFD* parent, TiffTag tag, TiffDataType type, uint32_t count,
            ByteStream data);
  TiffEntry(TiffIFD* parent, ByteStream& bs);
 
  virtual ~TiffEntry() = default;
 
  [[nodiscard]] bool RAWSPEED_READONLY isFloat() const;
  [[nodiscard]] bool RAWSPEED_READONLY isRational() const;
  [[nodiscard]] bool RAWSPEED_READONLY isSRational() const;
  [[nodiscard]] bool RAWSPEED_READONLY isInt() const;
  [[nodiscard]] bool RAWSPEED_READONLY isString() const;
  [[nodiscard]] uint8_t getByte(uint32_t index = 0) const;
  [[nodiscard]] uint32_t getU32(uint32_t index = 0) const;
  [[nodiscard]] int32_t getI32(uint32_t index = 0) const;
  [[nodiscard]] uint16_t getU16(uint32_t index = 0) const;
  [[nodiscard]] int16_t getI16(uint32_t index = 0) const;
  [[nodiscard]] NotARational<uint32_t> getRational(uint32_t index = 0) const;
  [[nodiscard]] NotARational<int32_t> getSRational(uint32_t index = 0) const;
  [[nodiscard]] float getFloat(uint32_t index = 0) const;
  [[nodiscard]] std::string getString() const;
 
  [[nodiscard]] std::vector<uint16_t> getU16Array(uint32_t count_) const {
    return getArray<uint16_t, &TiffEntry::getU16>(count_);
  }
 
  [[nodiscard]] std::vector<uint32_t> getU32Array(uint32_t count_) const {
    return getArray<uint32_t, &TiffEntry::getU32>(count_);
  }
 
  [[nodiscard]] std::vector<float> getFloatArray(uint32_t count_) const {
    return getArray<float, &TiffEntry::getFloat>(count_);
  }
 
  [[nodiscard]] std::vector<NotARational<uint32_t>>
  getRationalArray(uint32_t count_) const {
    return getArray<NotARational<uint32_t>, &TiffEntry::getRational>(count_);
  }
 
  [[nodiscard]] std::vector<NotARational<int32_t>>
  getSRationalArray(uint32_t count_) const {
    return getArray<NotARational<int>, &TiffEntry::getSRational>(count_);
  }
 
  [[nodiscard]] ByteStream getData() const { return data; }
 
  [[nodiscard]] DataBuffer getRootIfdData() const;
 
protected:
  static const std::array<uint32_t, 14> datashifts;
};
 
class TiffEntryWithData final : public TiffEntry {
  const std::vector<uint8_t> data;
 
  void anchor() const override;
 
public:
  TiffEntryWithData(TiffIFD* parent, TiffTag tag, TiffDataType type,
                    uint32_t count, Buffer mirror);
};
 
} // namespace rawspeed