remove heif_encoding_options from heif_track_encode_sequence_image()

Author: farindk

examples/heif_enc.cc

@@ -1814,7 +1814,6 @@ int do_encode_sequence(heif_context* context, heif_encoder* encoder, heif_encodi
                                              image_width, image_height,
                                              heif_track_type_video,
                                              nullptr,
-                                             nullptr,
                                              &track);
 
       heif_track_options_release(track_options);
@@ -1841,7 +1840,7 @@ int do_encode_sequence(heif_context* context, heif_encoder* encoder, heif_encodi
 
     heif_image_set_duration(image.get(), sequence_durations);
 
-    error = heif_track_encode_sequence_image(track, image.get(), encoder, nullptr, nullptr);
+    error = heif_track_encode_sequence_image(track, image.get(), encoder, nullptr);
     if (error.code) {
       std::cerr << "Cannot encode sequence image: " << error.message << "\n";
       return 5;

libheif/api/libheif/heif_sequences.cc

@@ -345,11 +345,32 @@ void heif_track_options_set_gimi_track_id(struct heif_track_options* options,
 }
 
 
+heif_sequence_encoding_options* heif_sequence_encoding_options_alloc()
+{
+  heif_sequence_encoding_options* options = new heif_sequence_encoding_options();
+
+  options->version = 1;
+  options->output_nclx_profile = nullptr;
+
+  options->color_conversion_options.version = 1;
+  options->color_conversion_options.preferred_chroma_downsampling_algorithm = heif_chroma_downsampling_average;
+  options->color_conversion_options.preferred_chroma_upsampling_algorithm = heif_chroma_upsampling_bilinear;
+  options->color_conversion_options.only_use_preferred_chroma_algorithm = false;
+
+  return options;
+}
+
+
+void heif_sequence_encoding_options_release(heif_sequence_encoding_options* options)
+{
+  delete options;
+}
+
+
 struct heif_error heif_context_add_visual_sequence_track(heif_context* ctx,
                                                          struct heif_track_options* track_options,
                                                          uint16_t width, uint16_t height,
                                                          heif_track_type track_type,
-                                                         const struct heif_encoding_options* options,
                                                          const struct heif_sequence_encoding_options* seq_options,
                                                          heif_track** out_track)
 {
@@ -392,13 +413,30 @@ void heif_image_set_duration(heif_image* img, uint32_t duration)
 struct heif_error heif_track_encode_sequence_image(struct heif_track* track,
                                                    const struct heif_image* input_image,
                                                    struct heif_encoder* encoder,
-                                                   const struct heif_encoding_options* input_options,
-                                                   const struct heif_sequence_encoding_options* seq_input_options)
+                                                   const struct heif_sequence_encoding_options* sequence_options)
 {
+  // the input track must be a visual track
+
+  auto visual_track = std::dynamic_pointer_cast<Track_Visual>(track->track);
+  if (!visual_track) {
+    return {heif_error_Usage_error,
+            heif_suberror_Invalid_parameter_value,
+            "Cannot encode image for non-visual track."};
+  }
+
+
+  // convert heif_sequence_encoding_options to heif_encoding_options that is used by track->encode_image()
+
   heif_encoding_options* options = heif_encoding_options_alloc();
   heif_color_profile_nclx nclx;
-  if (input_options) {
-    heif_encoding_options_copy(options, input_options);
+  if (sequence_options) {
+    if (sequence_options->version >= 4) {
+      options->output_nclx_profile = sequence_options->output_nclx_profile;
+    }
+
+    if (sequence_options->version >= 6) {
+      options->color_conversion_options = sequence_options->color_conversion_options;
+    }
 
     if (options->output_nclx_profile == nullptr) {
       auto input_nclx = input_image->image->get_color_profile_nclx();
@@ -413,14 +451,7 @@ struct heif_error heif_track_encode_sequence_image(struct heif_track* track,
     }
   }
 
-  auto visual_track = std::dynamic_pointer_cast<Track_Visual>(track->track);
-  if (!visual_track) {
-    heif_encoding_options_free(options);
-
-    return {heif_error_Usage_error,
-            heif_suberror_Invalid_parameter_value,
-            "Cannot encode image for non-visual track."};
-  }
+  // encode the image
 
   auto error = visual_track->encode_image(input_image->image,
                                           encoder,

libheif/api/libheif/heif_sequences.h

@@ -305,7 +305,22 @@ void heif_track_options_set_gimi_track_id(struct heif_track_options*,
 // --- writing visual tracks
 
 // This structure is for future use. It is not defined yet.
-struct heif_sequence_encoding_options;
+struct heif_sequence_encoding_options
+{
+  uint8_t version;
+
+  // version 1 options
+
+  // Set this to the NCLX parameters to be used in the output images or set to NULL
+  // when the same parameters as in the input images should be used.
+  struct heif_color_profile_nclx* output_nclx_profile;
+
+  struct heif_color_conversion_options color_conversion_options;
+};
+
+heif_sequence_encoding_options* heif_sequence_encoding_options_alloc();
+
+void heif_sequence_encoding_options_release(heif_sequence_encoding_options*);
 
 /**
  * Add a visual track to the sequence.
@@ -325,7 +340,6 @@ struct heif_error heif_context_add_visual_sequence_track(heif_context*,
                                                          struct heif_track_options* track_options,
                                                          uint16_t width, uint16_t height,
                                                          heif_track_type track_type,
-                                                         const struct heif_encoding_options* encoding_options,
                                                          const struct heif_sequence_encoding_options* seq_encoding_options,
                                                          heif_track** out_track);
 
@@ -339,14 +353,13 @@ void heif_image_set_duration(heif_image*, uint32_t duration);
  * Encode the image into a visual track.
  * If the passed track is no visual track, an error will be returned.
  *
- * Currently, pass NULL as seq_options.
+ * Currently, pass NULL as sequence_options.
  */
 LIBHEIF_API
 struct heif_error heif_track_encode_sequence_image(struct heif_track*,
                                                    const struct heif_image* image,
                                                    struct heif_encoder* encoder,
-                                                   const struct heif_encoding_options* options,
-                                                   const struct heif_sequence_encoding_options* seq_options);
+                                                   const struct heif_sequence_encoding_options* sequence_options);
 
 // --- metadata tracks