/src/libheif/libheif/file.cc

Source
/*
 * HEIF codec.
 * Copyright (c) 2017 Dirk Farin <dirk.farin@gmail.com>
 *
 * This file is part of libheif.
 *
 * libheif 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 3 of
 * the License, or (at your option) any later version.
 *
 * libheif 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 libheif.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "file.h"
#include "box.h"
#include "libheif/heif.h"
#include "libheif/heif_properties.h"
#include "compression.h"
#include "image-items/grid.h"
#include "image-items/jpeg2000.h"
#include "image-items/jpeg.h"
#include "image-items/overlay.h"
#include "image-items/vvc.h"
#include "codecs/avif_boxes.h"
#include "codecs/hevc_boxes.h"
#include "sequences/seq_boxes.h"
#include "mini.h"

#include <cstdint>
#include <fstream>
#include <limits>
#include <sstream>
#include <utility>
#include <cstring>
#include <cassert>
#include <algorithm>

#include "libheif/heif_cxx.h"

#if defined(__MINGW32__) || defined(__MINGW64__) || defined(_MSC_VER)

#ifndef NOMINMAX
#define NOMINMAX 1
#endif

#include <windows.h>
#endif


#if WITH_UNCOMPRESSED_CODEC
#include "image-items/unc_image.h"
#endif

// TODO: make this a decoder option
#define STRICT_PARSING false

static const char* const too_many_properties_error = "Too many item properties in file to add another one";


HeifFile::HeifFile()
{
  m_file_layout = std::make_shared<FileLayout>();
}

HeifFile::~HeifFile() = default;

std::vector<heif_item_id> HeifFile::get_item_IDs() const
{
  std::vector<heif_item_id> IDs;

  IDs.reserve(m_infe_boxes.size());
  for (const auto& infe : m_infe_boxes) {
    IDs.push_back(infe.second->get_item_ID());
  }

  return IDs;
}


std::shared_ptr<const Box_infe> HeifFile::get_infe_box(heif_item_id ID) const
{
  auto iter = m_infe_boxes.find(ID);
  if (iter == m_infe_boxes.end()) {
    return nullptr;
  }

  return iter->second;
}


std::shared_ptr<Box_infe> HeifFile::get_infe_box(heif_item_id ID)
{
  auto iter = m_infe_boxes.find(ID);
  if (iter == m_infe_boxes.end()) {
    return nullptr;
  }

  return iter->second;
}


Error HeifFile::read_from_file(const char* input_filename)
{
#if defined(__MINGW32__) || defined(__MINGW64__) || defined(_MSC_VER)
  auto input_stream_istr = std::unique_ptr<std::istream>(new std::ifstream(convert_utf8_path_to_utf16(input_filename).c_str(), std::ios_base::binary));
#else
  auto input_stream_istr = std::unique_ptr<std::istream>(new std::ifstream(input_filename, std::ios_base::binary));
#endif
  if (!input_stream_istr->good()) {
    std::stringstream sstr;
    sstr << "Error opening file: " << strerror(errno) << " (" << errno << ")\n";
    return Error(heif_error_Input_does_not_exist, heif_suberror_Unspecified, sstr.str());
  }

  auto input_stream = std::make_shared<StreamReader_istream>(std::move(input_stream_istr));
  return read(input_stream);
}


Error HeifFile::read_from_memory(const void* data, size_t size, bool copy)
{
  auto input_stream = std::make_shared<StreamReader_memory>((const uint8_t*) data, size, copy);

  return read(input_stream);
}


Error HeifFile::read(const std::shared_ptr<StreamReader>& reader)
{
  assert(m_limits);

  m_input_stream = reader;

  Error err;
  err = m_file_layout->read(reader, m_limits);
  if (err) {
    return err;
  }

  Error error = parse_heif_file();
  if (error) {
    return error;
  }

  seed_id_creator();

  return Error::Ok;
}


bool HeifFile::has_images() const
{
  if (!m_meta_box) {
    return false;
  }

  return m_hdlr_box && m_hdlr_box->get_handler_type() == fourcc("pict");
}


void HeifFile::new_empty_file()
{
  //m_input_stream.reset();
  m_top_level_boxes.clear();

  m_ftyp_box = std::make_shared<Box_ftyp>();
  m_top_level_boxes.push_back(m_ftyp_box);
}


void HeifFile::init_for_meta_item()
{
  if (!m_meta_box) {
    m_meta_box = std::make_shared<Box_meta>();
    m_top_level_boxes.push_back(m_meta_box);
  }

  if (!m_hdlr_box) {
    m_hdlr_box = std::make_shared<Box_hdlr>();
    m_hdlr_box->set_handler_type(fourcc("null"));
    m_meta_box->append_child_box(m_hdlr_box);
  }

  if (!m_iloc_box) {
    m_iloc_box = std::make_shared<Box_iloc>();
    m_meta_box->append_child_box(m_iloc_box);
  }

  if (!m_iinf_box) {
    m_iinf_box = std::make_shared<Box_iinf>();
    m_meta_box->append_child_box(m_iinf_box);
  }
}


void HeifFile::init_for_image()
{
  init_for_meta_item();

  // Upgrade handler from "null" to "pict" if needed
  if (m_hdlr_box->get_handler_type() == fourcc("null")) {
    m_hdlr_box->set_handler_type(fourcc("pict"));
  }

  if (!m_pitm_box) {
    m_pitm_box = std::make_shared<Box_pitm>();
    m_meta_box->append_child_box(m_pitm_box);
  }

  init_for_item_properties();
}


void HeifFile::init_for_item_properties()
{
  init_for_meta_item();

  if (!m_iprp_box) {
    m_iprp_box = std::make_shared<Box_iprp>();
    m_meta_box->append_child_box(m_iprp_box);
  }

  if (!m_ipco_box) {
    m_ipco_box = std::make_shared<Box_ipco>();
    m_iprp_box->append_child_box(m_ipco_box);
  }

  if (!m_ipma_box) {
    m_ipma_box = std::make_shared<Box_ipma>();
    m_iprp_box->append_child_box(m_ipma_box);
  }
}


void HeifFile::init_for_sequence()
{
  if (m_moov_box) {
    return;
  }

  m_moov_box = std::make_shared<Box_moov>();
  m_top_level_boxes.push_back(m_moov_box);

  m_mvhd_box = std::make_shared<Box_mvhd>();
  m_moov_box->append_child_box(m_mvhd_box);
}


size_t HeifFile::append_mdat_data(const std::vector<uint8_t>& data)
{
  if (!m_mdat_data) {
    m_mdat_data = std::make_unique<MdatData_Memory>();
  }

  return m_mdat_data->append_data(data);
}


void HeifFile::derive_box_versions()
{
  for (auto& box : m_top_level_boxes) {
    box->derive_box_version_recursive();
  }
}


void HeifFile::write(StreamWriter& writer)
{
  if (m_write_mini_format) {
    std::string reason;
    if (Box_mini::can_convert_to_mini(this, reason)) {
      auto mini = Box_mini::create_from_heif_file(this);
      if (mini) {
        // Adjust ftyp for mini format
        auto ftyp = get_ftyp_box();

        // Determine codec brand from primary item type
        uint32_t item_type = get_item_type_4cc(get_primary_image_ID());
        heif_brand2 codec_brand = 0;
        if (item_type == fourcc("av01")) {
          codec_brand = heif_brand2_avif;
        }
        else if (item_type == fourcc("hvc1")) {
          codec_brand = heif_brand2_heic;
        }

        ftyp->set_major_brand(fourcc("mif3"));
        ftyp->set_minor_version(codec_brand);
        ftyp->clear_compatible_brands();

        // Write ftyp + mini (no mdat needed)
        ftyp->write(writer);
        mini->write(writer);
        return;
      }
    }
    // Fall through to normal write if conversion fails
  }

  for (auto& box : m_top_level_boxes) {
    if (box == nullptr) {
      // Either mini or meta will be null, just ignore that one
      continue;
    }
    Error err = box->write(writer);
    (void)err; // TODO: error ?
  }

  if (m_iloc_box) {
    // TODO: rewrite to use MdatData class
    Error err = m_iloc_box->write_mdat_after_iloc(writer);
    (void)err; // TODO: error ?
  }

  if (m_mdat_data) {
    Result<size_t> mdatResult = write_mdat(writer);
    if (!mdatResult) {
      return; // TODO: error ?
    }

    for (auto& box : m_top_level_boxes) {
      box->patch_file_pointers_recursively(writer, *mdatResult);
    }
  }
}


std::string HeifFile::debug_dump_boxes() const
{
  std::stringstream sstr;

  bool first = true;

  for (const auto& box : m_top_level_boxes) {
    if (box == nullptr) {
      // Either mini or meta will be null, just ignore that one
      continue;
    }
    // dump box content for debugging

    if (first) {
      first = false;
    }
    else {
      sstr << "\n";
    }

    Indent indent;
    sstr << box->dump(indent);
  }

  return sstr.str();
}


std::string HeifFile::debug_dump_item_data() const
{
  std::stringstream sstr;
  bool has_output = false;

  sstr << "=== Item Data ===\n";

  for (const auto& [id, infe] : m_infe_boxes) {
    uint32_t item_type = infe->get_item_type_4cc();

    if (item_type == fourcc("grid")) {
      auto dataResult = get_uncompressed_item_data(id);
      if (!dataResult) {
        continue;
      }

      ImageGrid grid;
      Error err = grid.parse(*dataResult);
      if (err) {
        continue;
      }

      has_output = true;
      sstr << "\nitem ID " << id << " (grid):\n";

      std::istringstream lines(grid.dump());
      std::string line;
      while (std::getline(lines, line)) {
        sstr << "  " << line << "\n";
      }
    }
    else if (item_type == fourcc("iovl")) {
      if (!m_iref_box) {
        continue;
      }

      auto refs = m_iref_box->get_references(id, fourcc("dimg"));

      auto dataResult = get_uncompressed_item_data(id);
      if (!dataResult) {
        continue;
      }

      ImageOverlay overlay;
      Error err = overlay.parse(refs.size(), *dataResult);
      if (err) {
        continue;
      }

      has_output = true;
      sstr << "\nitem ID " << id << " (iovl):\n";

      std::istringstream lines(overlay.dump());
      std::string line;
      while (std::getline(lines, line)) {
        sstr << "  " << line << "\n";
      }
    }
  }

  if (has_output) {
    return sstr.str();
  }

  return {};
}


Error HeifFile::parse_heif_file()
{
  // --- read all top-level boxes

#if 0
  for (;;) {
    std::shared_ptr<Box> box;
    Error error = Box::read(range, &box);

    if (range.error() || range.eof()) {
      break;
    }

    // When an EOF error is returned, this is not really a fatal exception,
    // but simply the indication that we reached the end of the file.
    // TODO: this design should be cleaned up
    if (error.error_code == heif_error_Invalid_input && error.sub_error_code == heif_suberror_End_of_data) {
      break;
    }

    if (error != Error::Ok) {
      return error;
    }

    m_top_level_boxes.push_back(box);


    // extract relevant boxes (ftyp, meta)

    if (box->get_short_type() == fourcc("meta")) {
      m_meta_box = std::dynamic_pointer_cast<Box_meta>(box);
    }

    if (box->get_short_type() == fourcc("ftyp")) {
      m_ftyp_box = std::dynamic_pointer_cast<Box_ftyp>(box);
    }
  }
#endif

  m_ftyp_box = m_file_layout->get_ftyp_box();
  if (!m_ftyp_box) {
    return Error(heif_error_Invalid_input,
                 heif_suberror_No_ftyp_box);
  }

  m_top_level_boxes.push_back(m_ftyp_box);

  bool is_sequence_brand = (m_ftyp_box->has_compatible_brand(heif_brand2_msf1) ||
                            m_ftyp_box->has_compatible_brand(heif_brand2_isom) ||
                            m_ftyp_box->has_compatible_brand(heif_brand2_mp41) ||
                            m_ftyp_box->has_compatible_brand(heif_brand2_mp42));

  // --- check whether this is a HEIF file and its structural format

  if (!m_ftyp_box->has_compatible_brand(heif_brand2_heic) &&
      !m_ftyp_box->has_compatible_brand(heif_brand2_heix) &&
      !m_ftyp_box->has_compatible_brand(heif_brand2_mif1) &&
      !m_ftyp_box->has_compatible_brand(heif_brand2_avif) &&
      !m_ftyp_box->has_compatible_brand(heif_brand2_1pic) &&
      !(m_ftyp_box->get_major_brand() == heif_brand2_mif3) &&
      !m_ftyp_box->has_compatible_brand(heif_brand2_jpeg) &&
      !m_ftyp_box->has_compatible_brand(heif_brand2_isom) &&
      !m_ftyp_box->has_compatible_brand(heif_brand2_mp42) &&
      !m_ftyp_box->has_compatible_brand(heif_brand2_mp41) &&
      !m_ftyp_box->has_compatible_brand(heif_brand2_msf1)) {
    std::stringstream sstr;
    sstr << "File does not include any supported brands.\n";

    return Error(heif_error_Unsupported_filetype,
                 heif_suberror_Unspecified,
                 sstr.str());
      }

  m_mini_box = m_file_layout->get_mini_box();

  if (m_mini_box) {
    m_top_level_boxes.push_back(m_mini_box);

    Error err = m_mini_box->create_expanded_boxes(this);
    if (err) {
      return err;
    }
    return Error::Ok;
  }

  m_meta_box = m_file_layout->get_meta_box();
  if (m_meta_box) {
    m_top_level_boxes.push_back(m_meta_box);
  }

  // TODO: we are missing 'mdat' top level boxes

  m_moov_box = m_file_layout->get_moov_box();
  if (m_moov_box) {
    m_top_level_boxes.push_back(m_moov_box);
  }

  // if we didn't find the mini box, meta is required

  if (!m_meta_box && !is_sequence_brand) {
    return Error(heif_error_Invalid_input,
                 heif_suberror_No_meta_box);
  }

  if (!m_moov_box && is_sequence_brand) {
    return Error(heif_error_Invalid_input,
                 heif_suberror_No_moov_box);
  }

  if (m_meta_box) {
    auto err = parse_heif_images();
    if (err) {
      return err;
    }
  }

  if (m_moov_box) {
    auto err = parse_heif_sequences();
    if (err) {
      return err;
    }
  }

  return Error::Ok;
}


Error HeifFile::parse_heif_images()
{
  m_hdlr_box = m_meta_box->get_child_box<Box_hdlr>();
  if (STRICT_PARSING && !m_hdlr_box) {
    return Error(heif_error_Invalid_input,
                 heif_suberror_No_hdlr_box);
  }

  // --- assign item boxes

  m_iinf_box = m_meta_box->get_child_box<Box_iinf>();
  if (!m_iinf_box) {
    return Error(heif_error_Invalid_input,
                 heif_suberror_No_iinf_box);
  }

  std::vector<std::shared_ptr<Box_infe>> infe_boxes = m_iinf_box->get_child_boxes<Box_infe>();

  for (auto& infe_box : infe_boxes) {
    if (!infe_box) {
      return Error(heif_error_Invalid_input,
                   heif_suberror_No_infe_box);
    }

    m_infe_boxes.insert(std::make_pair(infe_box->get_item_ID(), infe_box));
  }


  if (has_images()) {
    // --- find mandatory boxes needed for image decoding

    m_pitm_box = m_meta_box->get_child_box<Box_pitm>();
    if (!m_pitm_box) {
      return Error(heif_error_Invalid_input,
                   heif_suberror_No_pitm_box);
    }

    m_iprp_box = m_meta_box->get_child_box<Box_iprp>();
    if (!m_iprp_box) {
      return Error(heif_error_Invalid_input,
                   heif_suberror_No_iprp_box);
    }

    m_ipco_box = m_iprp_box->get_child_box<Box_ipco>();
    if (!m_ipco_box) {
      return Error(heif_error_Invalid_input,
                   heif_suberror_No_ipco_box);
    }

    auto ipma_boxes = m_iprp_box->get_child_boxes<Box_ipma>();
    if (ipma_boxes.empty()) {
      return Error(heif_error_Invalid_input,
                   heif_suberror_No_ipma_box);
    }
    for (size_t i=1;i<ipma_boxes.size();i++) {
      ipma_boxes[0]->insert_entries_from_other_ipma_box(*ipma_boxes[i]);
    }
    m_ipma_box = ipma_boxes[0];
  }

  m_iloc_box = m_meta_box->get_child_box<Box_iloc>();
  if (!m_iloc_box) {
    return Error(heif_error_Invalid_input,
                 heif_suberror_No_iloc_box);
  }

  m_idat_box = m_meta_box->get_child_box<Box_idat>();

  m_iref_box = m_meta_box->get_child_box<Box_iref>();

  // Note: reference cycles are not rejected at load. A cycle only matters when
  // it is decoded, and it is caught there per item by ImageItem::verify_decodable()
  // (following both 'dimg' and 'auxl' edges). Rejecting the whole file at load
  // would also make its unaffected, independently valid items undecodable.

  m_grpl_box = m_meta_box->get_child_box<Box_grpl>();


  return Error::Ok;
}


Error HeifFile::parse_heif_sequences()
{
  m_mvhd_box = m_moov_box->get_child_box<Box_mvhd>();
  if (!m_mvhd_box) {
    return {heif_error_Invalid_input,
            heif_suberror_Unspecified,
            "No mvhd box in image sequence."};
  }

  return Error::Ok;
}


bool HeifFile::item_exists(heif_item_id ID) const
{
  auto image_iter = m_infe_boxes.find(ID);
  return image_iter != m_infe_boxes.end();
}


bool HeifFile::has_item_with_id(heif_item_id ID) const
{
  auto infe_box = get_infe_box(ID);
  return infe_box != nullptr;
}


uint32_t HeifFile::get_item_type_4cc(heif_item_id ID) const
{
  auto infe_box = get_infe_box(ID);
  if (!infe_box) {
    return 0;
  }

  return infe_box->get_item_type_4cc();
}


std::string HeifFile::get_content_type(heif_item_id ID) const
{
  auto infe_box = get_infe_box(ID);
  if (!infe_box) {
    return "";
  }

  return infe_box->get_content_type();
}

std::string HeifFile::get_item_uri_type(heif_item_id ID) const
{
  auto infe_box = get_infe_box(ID);
  if (!infe_box) {
    return "";
  }

  return infe_box->get_item_uri_type();
}


Error HeifFile::get_properties(heif_item_id imageID,
                               std::vector<std::shared_ptr<Box>>& properties) const
{
  if (!m_ipco_box) {
    return Error(heif_error_Invalid_input,
                 heif_suberror_No_ipco_box);
  }
  else if (!m_ipma_box) {
    return Error(heif_error_Invalid_input,
                 heif_suberror_No_ipma_box);
  }

  return m_ipco_box->get_properties_for_item_ID(imageID, m_ipma_box, properties);
}


Result<std::vector<uint8_t>> HeifFile::get_uncompressed_item_data(heif_item_id ID) const
{
  assert(m_limits);

#if ENABLE_PARALLEL_TILE_DECODING
  // std::lock_guard<std::mutex> guard(m_read_mutex);   // TODO: I think that this is not needed anymore because this function is not used for image data anymore.
#endif

  if (!m_iloc_box) {
    return Error(heif_error_Invalid_input, heif_suberror_No_iloc_box);
  }

  if (!item_exists(ID)) {
    return Error(heif_error_Usage_error,
                 heif_suberror_Nonexisting_item_referenced);
  }

  auto infe_box = get_infe_box(ID);
  if (!infe_box) {
    return Error(heif_error_Usage_error,
                 heif_suberror_Nonexisting_item_referenced);
  }


  uint32_t item_type = infe_box->get_item_type_4cc();
  std::string content_type = infe_box->get_content_type();

  // --- decompress data

  Error error;

  if (item_type == fourcc("mime")) {
    std::string encoding = infe_box->get_content_encoding();
    // Skip the encoding comparisons when no encoding is set; falling through
    // to the raw read below is the right behaviour for the uncompressed case.
    // Skipping is also necessary to avoid libstdc++'s _S_compare(0, N) which
    // computes unsigned `0 - N` and trips UBSan even though the cast result
    // is benign.
    if (!encoding.empty() && encoding != "identity") {
      if (encoding == "compress_zlib") {
#if HAVE_ZLIB
        std::vector<uint8_t> compressed_data;
        error = m_iloc_box->read_data(ID, m_input_stream, m_idat_box, &compressed_data, m_limits);
        if (error) {
          return error;
        }

        return decompress_zlib(compressed_data, m_limits);
#else
        return Error(heif_error_Unsupported_feature,
                     heif_suberror_Unsupported_header_compression_method,
                     encoding);
#endif
      }
      else if (encoding == "deflate") {
#if HAVE_ZLIB
        std::vector<uint8_t> compressed_data;
        error = m_iloc_box->read_data(ID, m_input_stream, m_idat_box, &compressed_data, m_limits);
        if (error) {
          return error;
        }
        return decompress_deflate(compressed_data, m_limits);
#else
        return Error(heif_error_Unsupported_feature,
                     heif_suberror_Unsupported_header_compression_method,
                     encoding);
#endif
      }
      else if (encoding == "br") {
#if HAVE_BROTLI
        std::vector<uint8_t> compressed_data;
        error = m_iloc_box->read_data(ID, m_input_stream, m_idat_box, &compressed_data, m_limits);
        if (error) {
          return error;
        }
        return decompress_brotli(compressed_data, m_limits);
#else
        return Error(heif_error_Unsupported_feature,
                     heif_suberror_Unsupported_header_compression_method,
                     encoding);
#endif
      }
      else {
        return Error(heif_error_Unsupported_feature, heif_suberror_Unsupported_codec);
      }
    }
  }


  // --- read uncompressed

  std::vector<uint8_t> data;
  error = m_iloc_box->read_data(ID, m_input_stream, m_idat_box, &data, m_limits);
  if (error) {
    return error;
  }
  else {
    return data;
  }
}


Error HeifFile::append_data_from_file_range(std::vector<uint8_t>& out_data, uint64_t offset, uint32_t size) const
{
  auto old_size = out_data.size();

  // --- check that the requested range does not exceed the file size

  uint64_t end_pos = offset + size;
  if (m_input_stream->wait_for_file_size(end_pos) != StreamReader::grow_status::size_reached) {
    std::stringstream sstr;
    sstr << "File range " << offset << ".." << end_pos << " is beyond end of file.";
    return {heif_error_Invalid_input,
            heif_suberror_End_of_data,
            sstr.str()};
  }

  // --- check security limit on resulting buffer size

  if (m_limits) {
    auto max_memory_block_size = m_limits->max_memory_block_size;
    if (max_memory_block_size && max_memory_block_size - old_size < size) {
      std::stringstream sstr;
      sstr << "Sample data of " << size << " bytes would grow total buffer to "
           << (old_size + size) << " bytes, exceeding the security limit of "
           << max_memory_block_size << " bytes.";
      return {heif_error_Memory_allocation_error,
              heif_suberror_Security_limit_exceeded,
              sstr.str()};
    }
  }

  if (!m_input_stream->seek(offset)) {
    return {heif_error_Invalid_input,
            heif_suberror_End_of_data,
            "Cannot seek to sample data offset."};
  }

  out_data.resize(old_size + size);

  if (!m_input_stream->read(out_data.data() + old_size, size)) {
    out_data.resize(old_size);
    return {heif_error_Invalid_input,
            heif_suberror_End_of_data,
            "Failed to read sample data from file."};
  }

  return {};
}


Error HeifFile::append_data_from_iloc(heif_item_id ID, std::vector<uint8_t>& out_data, uint64_t offset, uint64_t size) const
{
  if (!m_iloc_box) {
    return Error(heif_error_Invalid_input, heif_suberror_No_iloc_box);
  }

  const auto& items = m_iloc_box->get_items();
  const Box_iloc::Item* item = nullptr;
  for (const auto& i : items) {
    if (i.item_ID == ID) {
      item = &i;
      break;
    }
  }
  if (!item) {
    std::stringstream sstr;
    sstr << "Item with ID " << ID << " has no compressed data";

    return {heif_error_Invalid_input,
            heif_suberror_No_item_data,
            sstr.str()};
  }

  return m_iloc_box->read_data(ID, m_input_stream, m_idat_box, &out_data, offset, size, m_limits);
}


Result<std::vector<uint8_t>> HeifFile::get_item_data(heif_item_id ID, heif_metadata_compression* out_compression) const
{
  Error error;

  assert(m_limits);

  if (!m_iloc_box) {
    return Error(heif_error_Invalid_input, heif_suberror_No_iloc_box);
  }

  auto infe_box = get_infe_box(ID);
  if (!infe_box) {
    return Error{heif_error_Usage_error,
                 heif_suberror_Nonexisting_item_referenced};
  }

  uint32_t item_type = infe_box->get_item_type_4cc();
  std::string content_type = infe_box->get_content_type();

  // --- non 'mime' data (uncompressed)

  if (item_type != fourcc("mime")) {
    if (out_compression) {
      *out_compression = heif_metadata_compression_off;
    }

    std::vector<uint8_t> out_data;
    Error err = m_iloc_box->read_data(ID, m_input_stream, m_idat_box, &out_data, m_limits);
    if (err) {
      return err;
    }
    else {
      return out_data;
    }
  }


  // --- mime data

  std::string encoding = infe_box->get_content_encoding();

  heif_metadata_compression compression;

  if (encoding.empty() || encoding == "identity") {
    // shortcut for case of uncompressed mime data ("identity" is the RFC 2616 no-op coding)

    if (out_compression) {
      *out_compression = heif_metadata_compression_off;
    }

    std::vector<uint8_t> out_data;
    Error err = m_iloc_box->read_data(ID, m_input_stream, m_idat_box, &out_data, m_limits);
    if (err) {
      return err;
    }
    else {
      return out_data;
    }
  }
  else if (encoding == "compress_zlib") {
    compression = heif_metadata_compression_zlib;
  }
  else if (encoding == "deflate") {
    compression = heif_metadata_compression_deflate;
  }
  else if (encoding == "br") {
    compression = heif_metadata_compression_brotli;
  }
  else {
    compression = heif_metadata_compression_unknown;
  }

  // read compressed data

  std::vector<uint8_t> compressed_data;
  error = m_iloc_box->read_data(ID, m_input_stream, m_idat_box, &compressed_data, m_limits);
  if (error) {
    return error;
  }

  // return compressed data, if we do not want to have it uncompressed

  const bool return_compressed = (out_compression != nullptr);
  if (return_compressed) {
    *out_compression = compression;
    return compressed_data;
  }

  // decompress the data

  switch (compression) {
#if HAVE_ZLIB
    case heif_metadata_compression_zlib:
      return decompress_zlib(compressed_data, m_limits);
    case heif_metadata_compression_deflate:
      return decompress_deflate(compressed_data, m_limits);
#endif
#if HAVE_BROTLI
    case heif_metadata_compression_brotli:
      return decompress_brotli(compressed_data, m_limits);
#endif
    default:
      return Error{heif_error_Unsupported_filetype, heif_suberror_Unsupported_header_compression_method};
  }
}


Result<heif_item_id> HeifFile::get_unused_item_id()
{
  return m_id_creator.get_new_id(IDCreator::Namespace::item);
}


void HeifFile::seed_id_creator()
{
  // A file with the 'unif' brand uses one ID space for items, tracks and entity groups.
  // Keep it that way for everything we add to the file.
  if (m_ftyp_box && m_ftyp_box->has_compatible_brand(heif_brand2_unif)) {
    m_id_creator.set_unif(true);
  }

  for (const auto& infe : m_infe_boxes) {
    m_id_creator.mark_id_used(IDCreator::Namespace::item, infe.first);
  }

  if (m_grpl_box) {
    for (const auto& box : m_grpl_box->get_all_child_boxes()) {
      if (auto group = std::dynamic_pointer_cast<Box_EntityToGroup>(box)) {
        m_id_creator.mark_id_used(IDCreator::Namespace::entity_group, group->get_group_id());
      }
    }
  }

  if (m_moov_box) {
    for (const auto& trak : m_moov_box->get_child_boxes<Box_trak>()) {
      if (auto tkhd = trak->get_child_box<Box_tkhd>()) {
        m_id_creator.mark_id_used(IDCreator::Namespace::track, tkhd->get_track_id());
      }
    }
  }
}


void HeifFile::remove_infe_box(const std::shared_ptr<Box_infe>& infe)
{
  m_infe_boxes.erase(infe->get_item_ID());

  if (m_iinf_box) {
    m_iinf_box->remove_child_box(infe);
  }
}


Result<heif_item_id> HeifFile::add_new_image(uint32_t item_type)
{
  auto result = add_new_infe_box(item_type);
  if (!result) {
    return result.error();
  }
  return (*result)->get_item_ID();
}


Result<std::shared_ptr<Box_infe>> HeifFile::add_new_infe_box(uint32_t item_type)
{
  init_for_image();

  auto idResult = get_unused_item_id();
  if (!idResult) {
    return idResult.error();
  }
  heif_item_id id = *idResult;

  auto infe = std::make_shared<Box_infe>();
  infe->set_item_ID(id);
  infe->set_hidden_item(false);
  infe->set_item_type_4cc(item_type);

  m_infe_boxes[id] = infe;
  m_iinf_box->append_child_box(infe);

  return infe;
}


Result<std::shared_ptr<Box_infe>> HeifFile::add_new_meta_infe_box(uint32_t item_type)
{
  init_for_meta_item();

  auto idResult = get_unused_item_id();
  if (!idResult) {
    return idResult.error();
  }
  heif_item_id id = *idResult;

  auto infe = std::make_shared<Box_infe>();
  infe->set_item_ID(id);
  infe->set_hidden_item(false);
  infe->set_item_type_4cc(item_type);

  m_infe_boxes[id] = infe;
  m_iinf_box->append_child_box(infe);

  return infe;
}


Error HeifFile::add_ispe_property(heif_item_id id, uint32_t width, uint32_t height, bool essential)
{
  init_for_item_properties();

  auto ispe = std::make_shared<Box_ispe>();
  ispe->set_size(width, height);

  uint32_t index = m_ipco_box->find_or_append_child_box(ispe);

  // 'ipma' stores the property index as a 16 bit value. Rather than truncating it and writing a
  // wrong association, refuse to add the property.
  if (index + 1 > 0xFFFF) {
    return {heif_error_Encoding_error,
            heif_suberror_Unspecified,
            too_many_properties_error};
  }

  m_ipma_box->add_property_for_item_ID(id, Box_ipma::PropertyAssociation{essential, uint16_t(index + 1)});

  return Error::Ok;
}



heif_property_id HeifFile::add_property(heif_item_id id, const std::shared_ptr<Box>& property, bool essential)
{
  init_for_item_properties();

  uint32_t index = m_ipco_box->find_or_append_child_box(property);

  // 'ipma' stores the property index as a 16 bit value. Rather than truncating it and writing a
  // wrong association, refuse to add the property.
  if (index + 1 > 0xFFFF) {
    return 0;
  }

  // Note that we have to return the position within the item's property list and not 'index',
  // as 'index' is the position in the file-wide 'ipco' box, which is shared by all items.
  return m_ipma_box->add_property_for_item_ID(id, Box_ipma::PropertyAssociation{essential, uint16_t(index + 1)});
}


heif_property_id HeifFile::add_property_without_deduplication(heif_item_id id, const std::shared_ptr<Box>& property, bool essential)
{
  init_for_item_properties();

  uint32_t index = m_ipco_box->append_child_box(property);
  if (index + 1 > 0xFFFF) {
    return 0;
  }

  return m_ipma_box->add_property_for_item_ID(id, Box_ipma::PropertyAssociation{essential, uint16_t(index + 1)});
}


Error HeifFile::add_orientation_properties(heif_item_id id, heif_orientation orientation)
{
  init_for_item_properties();

  // Note: ISO/IEC 23000-22:2019(E) (MIAF) 7.3.6.7 requires the following order:
  // clean aperture first, then rotation, then mirror

  int rotation_ccw = 0;
  heif_transform_mirror_direction mirror;
  bool has_mirror = false;

  switch (orientation) {
    case heif_orientation_normal:
      break;
    case heif_orientation_flip_horizontally:
      mirror = heif_transform_mirror_direction_horizontal;
      has_mirror = true;
      break;
    case heif_orientation_rotate_180:
      rotation_ccw = 180;
      break;
    case heif_orientation_flip_vertically:
      mirror = heif_transform_mirror_direction_vertical;
      has_mirror = true;
      break;
    case heif_orientation_rotate_90_cw_then_flip_horizontally:
      rotation_ccw = 270;
      mirror = heif_transform_mirror_direction_horizontal;
      has_mirror = true;
      break;
    case heif_orientation_rotate_90_cw:
      rotation_ccw = 270;
      break;
    case heif_orientation_rotate_90_cw_then_flip_vertically:
      rotation_ccw = 270;
      mirror = heif_transform_mirror_direction_vertical;
      has_mirror = true;
      break;
    case heif_orientation_rotate_270_cw:
      rotation_ccw = 90;
      break;
  }

  // omit rotation when angle is 0
  if (rotation_ccw!=0) {
    auto irot = std::make_shared<Box_irot>();
    irot->set_rotation_ccw(rotation_ccw);

    uint32_t index = m_ipco_box->find_or_append_child_box(irot);
    if (index + 1 > 0xFFFF) {
      return {heif_error_Encoding_error, heif_suberror_Unspecified, too_many_properties_error};
    }

    m_ipma_box->add_property_for_item_ID(id, Box_ipma::PropertyAssociation{true, uint16_t(index + 1)});
  }

  if (has_mirror) {
    auto imir = std::make_shared<Box_imir>();
    imir->set_mirror_direction(mirror);

    uint32_t index = m_ipco_box->find_or_append_child_box(imir);
    if (index + 1 > 0xFFFF) {
      return {heif_error_Encoding_error, heif_suberror_Unspecified, too_many_properties_error};
    }

    m_ipma_box->add_property_for_item_ID(id, Box_ipma::PropertyAssociation{true, uint16_t(index + 1)});
  }

  return Error::Ok;
}


Result<heif_item_id> HeifFile::add_infe(uint32_t item_type, const uint8_t* data, size_t size)
{
  // create an infe box describing what kind of data we are storing (this also creates a new ID)

  auto infe_result = add_new_meta_infe_box(item_type);
  if (!infe_result) {
    return infe_result.error();
  }
  auto infe_box = *infe_result;
  infe_box->set_hidden_item(true);

  heif_item_id metadata_id = infe_box->get_item_ID();

  if (Error err = set_item_data(infe_box, data, size, heif_metadata_compression_off)) {
    remove_infe_box(infe_box);
    return err;
  }

  return metadata_id;
}


void HeifFile::add_infe_box(heif_item_id id, std::shared_ptr<Box_infe> infe)
{
  m_infe_boxes.insert(std::make_pair(id, std::move(infe)));
}


Result<heif_item_id> HeifFile::add_infe_mime(const char* content_type, heif_metadata_compression content_encoding, const uint8_t* data, size_t size)
{
  // create an infe box describing what kind of data we are storing (this also creates a new ID)

  auto infe_result = add_new_meta_infe_box(fourcc("mime"));
  if (!infe_result) {
    return infe_result.error();
  }
  auto infe_box = *infe_result;
  infe_box->set_hidden_item(true);
  infe_box->set_content_type(content_type);

  heif_item_id metadata_id = infe_box->get_item_ID();

  if (Error err = set_item_data(infe_box, data, size, content_encoding)) {
    remove_infe_box(infe_box);
    return err;
  }

  return metadata_id;
}


Result<heif_item_id> HeifFile::add_precompressed_infe_mime(const char* content_type, const std::string& content_encoding, const uint8_t* data, size_t size)
{
  // create an infe box describing what kind of data we are storing (this also creates a new ID)

  auto infe_result = add_new_meta_infe_box(fourcc("mime"));
  if (!infe_result) {
    return infe_result.error();
  }
  auto infe_box = *infe_result;
  infe_box->set_hidden_item(true);
  infe_box->set_content_type(content_type);

  heif_item_id metadata_id = infe_box->get_item_ID();

  if (Error err = set_precompressed_item_data(infe_box, data, size, content_encoding)) {
    remove_infe_box(infe_box);
    return err;
  }

  return metadata_id;
}


Result<heif_item_id> HeifFile::add_infe_uri(const char* item_uri_type, const uint8_t* data, size_t size)
{
  // create an infe box describing what kind of data we are storing (this also creates a new ID)

  auto infe_result = add_new_meta_infe_box(fourcc("uri "));
  if (!infe_result) {
    return infe_result.error();
  }
  auto infe_box = *infe_result;
  infe_box->set_hidden_item(true);
  infe_box->set_item_uri_type(item_uri_type);

  heif_item_id metadata_id = infe_box->get_item_ID();

  if (Error err = set_item_data(infe_box, data, size, heif_metadata_compression_off)) {
    remove_infe_box(infe_box);
    return err;
  }

  return metadata_id;
}


Error HeifFile::set_item_data(const std::shared_ptr<Box_infe>& item, const uint8_t* data, size_t size, heif_metadata_compression compression)
{
  // --- metadata compression

  if (compression == heif_metadata_compression_auto) {
    compression = heif_metadata_compression_off; // currently, we don't use header compression by default
  }

  // only set metadata compression for MIME type data which has 'content_encoding' field
  if (compression != heif_metadata_compression_off &&
      item->get_item_type_4cc() != fourcc("mime")) {
    return Error(heif_error_Usage_error,
                 heif_suberror_Invalid_parameter_value,
                 "Item data compression is only supported for 'mime' items");
  }


  std::vector<uint8_t> data_array;
  if (compression == heif_metadata_compression_zlib) {
#if HAVE_ZLIB
    data_array = compress_zlib((const uint8_t*) data, size);
    item->set_content_encoding("compress_zlib");
#else
    return Error(heif_error_Unsupported_feature,
                 heif_suberror_Unsupported_header_compression_method);
#endif
  }
  else if (compression == heif_metadata_compression_deflate) {
#if HAVE_ZLIB
    data_array = compress_deflate((const uint8_t*) data, size);
    item->set_content_encoding("deflate");
#else
    return Error(heif_error_Unsupported_feature,
                 heif_suberror_Unsupported_header_compression_method);
#endif
  }
  else if (compression == heif_metadata_compression_brotli) {
#if HAVE_BROTLI
    data_array = compress_brotli((const uint8_t*)data, size);
    item->set_content_encoding("br");
#else
    return Error(heif_error_Unsupported_feature,
                 heif_suberror_Unsupported_header_compression_method);
#endif
  }
  else {
    // uncompressed data, plain copy

    if (size > 0) { // Note: this 'if' is not necessary, but a workaround to a compiler bug (https://github.com/strukturag/libheif/issues/1421)
      data_array.resize(size);
      memcpy(data_array.data(), data, size);
    }
  }

  // copy the data into the file, store the pointer to it in an iloc box entry

  append_iloc_data(item->get_item_ID(), data_array, 0);

  return Error::Ok;
}


Error HeifFile::set_precompressed_item_data(const std::shared_ptr<Box_infe>& item, const uint8_t* data, size_t size, const std::string& content_encoding)
{
  // only set metadata compression for MIME type data which has 'content_encoding' field
  if (!content_encoding.empty() &&
      item->get_item_type_4cc() != fourcc("mime")) {
    return Error(heif_error_Usage_error,
                 heif_suberror_Invalid_parameter_value,
                 "A content_encoding can only be set for 'mime' items");
  }


  std::vector<uint8_t> data_array;
  if (size > 0) { // do not memcpy() from a NULL pointer when there is no data
    data_array.resize(size);
    memcpy(data_array.data(), data, size);
  }

  item->set_content_encoding(content_encoding);

  // copy the data into the file, store the pointer to it in an iloc box entry

  append_iloc_data(item->get_item_ID(), data_array, 0);

  return Error::Ok;
}


void HeifFile::append_iloc_data(heif_item_id id, const std::vector<uint8_t>& nal_packets, uint8_t construction_method)
{
  m_iloc_box->append_data(id, nal_packets, construction_method);
}


void HeifFile::replace_iloc_data(heif_item_id id, uint64_t offset, const std::vector<uint8_t>& data, uint8_t construction_method)
{
  m_iloc_box->replace_data(id, offset, data, construction_method);
}


void HeifFile::set_primary_item_id(heif_item_id id)
{
  if (!m_pitm_box) {
    m_pitm_box = std::make_shared<Box_pitm>();
    m_meta_box->replace_child_box(m_pitm_box);
  }

  m_pitm_box->set_item_ID(id);
}


void HeifFile::set_ipco_box(const std::shared_ptr<Box_ipco>& ipco)
{
  m_ipco_box = ipco;
  m_meta_box->replace_child_box(ipco);
}


void HeifFile::set_ipma_box(const std::shared_ptr<Box_ipma>& ipma)
{
  m_ipma_box = ipma;
  m_meta_box->replace_child_box(ipma);
}


void HeifFile::set_iloc_box(const std::shared_ptr<Box_iloc>& iloc)
{
  m_iloc_box = iloc;
  m_meta_box->replace_child_box(iloc);
}


void HeifFile::set_iref_box(const std::shared_ptr<Box_iref>& iref)
{
  m_iref_box = iref;
  m_meta_box->replace_child_box(iref);
}


void HeifFile::add_iref_reference(heif_item_id from, uint32_t type,
                                  const std::vector<heif_item_id>& to)
{
  if (!m_iref_box) {
    m_iref_box = std::make_shared<Box_iref>();
    m_meta_box->append_child_box(m_iref_box);
  }

  m_iref_box->add_references(from, type, to);
}


void HeifFile::set_iref_reference(heif_item_id from, uint32_t type, int reference_idx, heif_item_id to_item)
{
  assert(m_iref_box);
  m_iref_box->overwrite_reference(from, type, reference_idx, to_item);
}


void HeifFile::add_entity_group_box(const std::shared_ptr<Box>& entity_group_box)
{
  if (!m_grpl_box) {
    m_grpl_box = std::make_shared<Box_grpl>();
    m_meta_box->append_child_box(m_grpl_box);
  }

  m_grpl_box->append_child_box(entity_group_box);
}


std::shared_ptr<Box_EntityToGroup> HeifFile::get_entity_group(heif_entity_group_id id)
{
  if (!m_grpl_box) {
    return nullptr;
  }

  const auto& entityGroups = m_grpl_box->get_all_child_boxes();
  for (auto& groupBase : entityGroups) {
    auto group = std::dynamic_pointer_cast<Box_EntityToGroup>(groupBase);
    assert(group);

    if (group->get_group_id() == id) {
      return group;
    }
  }

  return nullptr;
}


Error HeifFile::set_auxC_property(heif_item_id id, const std::string& type)
{
  init_for_item_properties();

  auto auxC = std::make_shared<Box_auxC>();
  auxC->set_aux_type(type);

  uint32_t index = m_ipco_box->find_or_append_child_box(auxC);
  if (index + 1 > 0xFFFF) {
    return {heif_error_Encoding_error, heif_suberror_Unspecified, too_many_properties_error};
  }

  m_ipma_box->add_property_for_item_ID(id, Box_ipma::PropertyAssociation{true, uint16_t(index + 1)});

  return Error::Ok;
}

#if defined(__MINGW32__) || defined(__MINGW64__) || defined(_MSC_VER)
std::wstring HeifFile::convert_utf8_path_to_utf16(std::string str)
{
  std::wstring ret;
  int len = MultiByteToWideChar(CP_UTF8, 0, str.c_str(), (int)str.length(), NULL, 0);
  if (len > 0)
  {
    ret.resize(len);
    MultiByteToWideChar(CP_UTF8, 0, str.c_str(), (int)str.length(), &ret[0], len);
  }
  return ret;
}
#endif


Result<size_t> HeifFile::write_mdat(StreamWriter& writer)
{
  // --- write mdat box

  size_t mdatSize = m_mdat_data->get_data_size();

  if (mdatSize <= 0xFFFFFFFF - 8) {
    writer.write32((uint32_t) (mdatSize + 8));
    writer.write32(fourcc("mdat"));
  }
  else {
    // box size > 4 GB

    writer.write32(1);
    writer.write32(fourcc("mdat"));
    writer.write64(mdatSize+8+8);
  }

  size_t dataStartPos = writer.get_position();

  m_mdat_data->write(writer);

  return dataStartPos;
}

Coverage Report

Created: 2026-09-14 06:38