add decode_next_image() to plugin API, passing the security limits

Author: farindk

libheif/api/libheif/heif_plugin.h

@@ -109,6 +109,9 @@ struct heif_decoder_plugin
   const char* id_name;
 
   // --- version 4 functions will follow below ... ---
+
+  struct heif_error (* decode_next_image)(void* decoder, struct heif_image** out_img,
+                                          const struct heif_security_limits* limits);
 };
 
 

libheif/codecs/decoder.cc

@@ -243,7 +243,8 @@ Result<std::vector<uint8_t>> Decoder::get_compressed_data() const
 
 
 Result<std::shared_ptr<HeifPixelImage>>
-Decoder::decode_single_frame_from_compressed_data(const struct heif_decoding_options& options)
+Decoder::decode_single_frame_from_compressed_data(const struct heif_decoding_options& options,
+                                                  const struct heif_security_limits* limits)
 {
   const struct heif_decoder_plugin* decoder_plugin = get_decoder(get_compression_format(), options.decoder_id);
   if (!decoder_plugin) {
@@ -285,9 +286,19 @@ Decoder::decode_single_frame_from_compressed_data(const struct heif_decoding_opt
 
   heif_image* decoded_img = nullptr;
 
-  err = decoder_plugin->decode_image(decoder, &decoded_img);
-  if (err.code != heif_error_Ok) {
-    return Error(err.code, err.subcode, err.message);
+  if (decoder_plugin->plugin_api_version >= 4 &&
+      decoder_plugin->decode_next_image != nullptr) {
+
+    err = decoder_plugin->decode_next_image(decoder, &decoded_img, limits);
+    if (err.code != heif_error_Ok) {
+      return Error(err.code, err.subcode, err.message);
+    }
+  }
+  else {
+    err = decoder_plugin->decode_image(decoder, &decoded_img);
+    if (err.code != heif_error_Ok) {
+      return Error(err.code, err.subcode, err.message);
+    }
   }
 
   if (!decoded_img) {

libheif/codecs/decoder.h

@@ -94,7 +94,8 @@ class Decoder
   // --- decoding
 
   virtual Result<std::shared_ptr<HeifPixelImage>>
-  decode_single_frame_from_compressed_data(const struct heif_decoding_options& options);
+  decode_single_frame_from_compressed_data(const struct heif_decoding_options& options,
+                                           const struct heif_security_limits* limits);
 
 private:
   DataExtent m_data_extent;

libheif/codecs/uncompressed/unc_dec.cc

@@ -164,7 +164,8 @@ bool Decoder_uncompressed::has_alpha_component() const
 
 
 Result<std::shared_ptr<HeifPixelImage>>
-Decoder_uncompressed::decode_single_frame_from_compressed_data(const struct heif_decoding_options& options)
+Decoder_uncompressed::decode_single_frame_from_compressed_data(const struct heif_decoding_options& options,
+                                                               const struct heif_security_limits* limits)
 {
   UncompressedImageCodec::unci_properties properties;
   properties.uncC = m_uncC;
@@ -173,7 +174,7 @@ Decoder_uncompressed::decode_single_frame_from_compressed_data(const struct heif
 
   auto decodeResult = UncompressedImageCodec::decode_uncompressed_image(properties,
                                                           get_data_extent(),
-                                                          heif_get_global_security_limits()); // TODO: use correct security limits
+                                                          limits);
 
   if (decodeResult.error) {
     return decodeResult.error;

libheif/codecs/uncompressed/unc_dec.h

@@ -53,7 +53,8 @@ class Decoder_uncompressed : public Decoder
   Result<std::vector<uint8_t>> read_bitstream_configuration_data() const override;
 
   Result<std::shared_ptr<HeifPixelImage>>
-  decode_single_frame_from_compressed_data(const struct heif_decoding_options& options) override;
+  decode_single_frame_from_compressed_data(const struct heif_decoding_options& options,
+                                           const struct heif_security_limits* limits) override;
 
 private:
   const std::shared_ptr<const Box_uncC> m_uncC;

libheif/image-items/image_item.cc

@@ -899,7 +899,8 @@ Result<std::shared_ptr<HeifPixelImage>> ImageItem::decode_compressed_image(const
 
   decoder->set_data_extent(std::move(extent));
 
-  return decoder->decode_single_frame_from_compressed_data(options);
+  return decoder->decode_single_frame_from_compressed_data(options,
+                                                           get_context()->get_security_limits());
 }
 
 

libheif/image-items/tiled.cc

@@ -831,7 +831,8 @@ ImageItem_Tiled::decode_grid_tile(const heif_decoding_options& options, uint32_t
 
   m_tile_decoder->set_data_extent(std::move(*extentResult));
 
-  return m_tile_decoder->decode_single_frame_from_compressed_data(options);
+  return m_tile_decoder->decode_single_frame_from_compressed_data(options,
+                                                                  get_context()->get_security_limits());
 }
 
 

libheif/sequences/track_visual.cc

@@ -95,7 +95,8 @@ Result<std::shared_ptr<HeifPixelImage>> Track_Visual::decode_next_image_sample(c
 
   decoder->set_data_extent(chunk->get_data_extent_for_sample(m_next_sample_to_be_processed));
 
-  Result<std::shared_ptr<HeifPixelImage>> decodingResult = decoder->decode_single_frame_from_compressed_data(options);
+  Result<std::shared_ptr<HeifPixelImage>> decodingResult = decoder->decode_single_frame_from_compressed_data(options,
+                                                                                                             m_heif_context->get_security_limits());
   if (decodingResult.error) {
     m_next_sample_to_be_processed++;
     return decodingResult.error;