Fix heif_image_handle_get_depth_image_representation_info() parameter (…

…strukturag#422)
pphh77 · Feb 1, 2021 · cdcb3a6 · cdcb3a6
1 parent b7caef9
commit cdcb3a6
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 3 deletions.
diff --git a/examples/heif_info.cc b/examples/heif_info.cc
@@ -290,7 +290,7 @@ int main(int argc, char** argv)
              heif_image_handle_get_height(depth_handle));
 
       const struct heif_depth_representation_info* depth_info;
-      if (heif_image_handle_get_depth_image_representation_info(depth_handle, depth_id, &depth_info)) {
+      if (heif_image_handle_get_depth_image_representation_info(handle, depth_id, &depth_info)) {
 
         printf("    z-near: ");
         if (depth_info->has_z_near) printf("%f\n", depth_info->z_near); else printf("undefined\n");

diff --git a/libheif/heif.cc b/libheif/heif.cc
@@ -785,10 +785,20 @@ int heif_image_handle_get_depth_image_representation_info(const struct heif_imag
                                                           heif_item_id depth_image_id,
                                                           const struct heif_depth_representation_info** out)
 {
+  std::shared_ptr<HeifContext::Image> depth_image;
+
   if (out) {
-    if (handle->image->has_depth_representation_info()) {
+    if (handle->image->is_depth_channel()) {
+      // Because of an API bug before v1.11.0, the input handle may be the depth image (#422).
+      depth_image = handle->image;
+    }
+    else {
+      depth_image = handle->image->get_depth_channel();
+    }
+
+    if (depth_image->has_depth_representation_info()) {
       auto info = new heif_depth_representation_info;
-      *info = handle->image->get_depth_representation_info();
+      *info = depth_image->get_depth_representation_info();
       *out = info;
       return true;
     }

diff --git a/libheif/heif.h b/libheif/heif.h
@@ -596,6 +596,10 @@ LIBHEIF_API
 void heif_depth_representation_info_free(const struct heif_depth_representation_info* info);
 
 // Returns true when there is depth_representation_info available
+// Note 1: depth_image_id is currently unused because we support only one depth channel per image, but
+// you should still provide the correct ID for future compatibility.
+// Note 2: Because of an API bug before v1.11.0, the function also works when 'handle' is the handle of the depth image.
+// However, you should pass the handle of the main image. Please adapt your code if needed.
 LIBHEIF_API
 int heif_image_handle_get_depth_image_representation_info(const struct heif_image_handle* handle,
                                                           heif_item_id depth_image_id,