bmffimage.hpp

// SPDX-License-Identifier: GPL-2.0-or-later
 
#pragma once
 
// *****************************************************************************
#include "exiv2lib_export.h"
 
// included header files
#include "image.hpp"
 
#include <set>
 
// *****************************************************************************
// namespace extensions
namespace Exiv2 {
[[deprecated]] EXIV2API bool enableBMFF(bool enable = true);
}  // namespace Exiv2
 
#ifdef EXV_ENABLE_BMFF
namespace Exiv2 {
struct Iloc {
  explicit Iloc(uint32_t ID = 0, uint32_t start = 0, uint32_t length = 0) : ID_(ID), start_(start), length_(length) {
  }
  virtual ~Iloc() = default;
  Iloc(const Iloc&) = default;
  Iloc& operator=(const Iloc&) = default;
 
  uint32_t ID_;
  uint32_t start_;
  uint32_t length_;
 
  [[nodiscard]] std::string toString() const;
};  // class Iloc
 
// *****************************************************************************
// class definitions
 
class EXIV2API BmffImage : public Image {
 public:
 
 
  BmffImage(BasicIo::UniquePtr io, bool create, size_t max_box_depth = 1000);
 
  void parseTiff(uint32_t root_tag, uint64_t length);
  void parseTiff(uint32_t root_tag, uint64_t length, uint64_t start);
 
 
  void parseXmp(uint64_t length, uint64_t start);
 
 
  void parseCr3Preview(const DataBuf& data, std::ostream& out, bool bTrace, uint8_t version, size_t width_offset,
                       size_t height_offset, size_t size_offset, size_t relative_position);
 
 
  void readMetadata() override;
  void writeMetadata() override;
  void setExifData(const ExifData&) override;
  void setIptcData(const IptcData&) override;
  void setXmpData(const XmpData&) override;
  void setComment(const std::string& comment) override;
  void printStructure(std::ostream& out, Exiv2::PrintStructureOption option, size_t depth) override;
 
 
  [[nodiscard]] std::string mimeType() const override;
  [[nodiscard]] uint32_t pixelWidth() const override;
  [[nodiscard]] uint32_t pixelHeight() const override;
 
  static constexpr Exiv2::ByteOrder endian_{Exiv2::bigEndian};
 
 private:
  void openOrThrow() const;
  uint64_t boxHandler(std::ostream& out, Exiv2::PrintStructureOption option, uint64_t pbox_end, size_t depth);
 
  uint32_t fileType_{0};
  std::set<size_t> visits_;
  uint64_t visits_max_{0};
  uint16_t unknownID_{0xffff};
  uint16_t exifID_{0xffff};
  uint16_t xmpID_{0};
  std::map<uint32_t, Iloc> ilocs_;
  bool bReadMetadata_{false};
  const size_t max_box_depth_;
 
  static std::string toAscii(uint32_t n);
  std::string boxName(uint32_t box);
  static bool superBox(uint32_t box);
  static bool fullBox(uint32_t box);
  static std::string uuidName(const Exiv2::DataBuf& uuid);
 
#ifdef EXV_HAVE_BROTLI
  static void brotliUncompress(const byte* compressedBuf, size_t compressedBufSize, DataBuf& arr);
#endif
 
};  // class BmffImage
 
// *****************************************************************************
// template, inline and free functions
 
// These could be static private functions on Image subclasses but then
// ImageFactory needs to be made a friend.
EXIV2API Image::UniquePtr newBmffInstance(BasicIo::UniquePtr io, bool create);
 
EXIV2API bool isBmffType(BasicIo& iIo, bool advance);
}  // namespace Exiv2
#endif  // EXV_ENABLE_BMFF