add hdr valgrind test via go

Author: salarkhan

.github/workflows/ci.yaml

@@ -84,3 +84,26 @@ jobs:
             wc -l | grep -q "2" || \
             (echo "Valgrind output:" && echo "$VALGRIND_OUT" && false)
           done
+
+      - name: Run HDR Tone Mapping Valgrind Tests
+        run: |
+          cd examples
+          hdr_test_cases=(
+            "100 100 ../data/hdr-ohmama.png out-hdr-1.webp"
+            "200 200 ../data/hdr-ohmama.png out-hdr-2.png"
+            "150 150 ../data/hdr-ohmama.png out-hdr-3.webp"
+          )
+
+          for test_case in "${hdr_test_cases[@]}"; do
+            read -r height width input output <<< "$test_case"
+            echo "Testing HDR tone mapping with height=$height width=$width input=$input output=$output"
+            VALGRIND_OUT=$(valgrind --leak-check=full ./example \
+              -height "$height" \
+              -width "$width" \
+              -input "$input" \
+              -output "$output" \
+              -force-sdr 2>&1) && \
+            echo "$VALGRIND_OUT" | grep -E "definitely lost: 0 bytes in 0 blocks|indirectly lost: 0 bytes in 0 blocks" | \
+            wc -l | grep -q "2" || \
+            (echo "Valgrind output:" && echo "$VALGRIND_OUT" && false)
+          done

data/hdr-ohmama.png

@@ -25,13 +25,15 @@ func main() {
 	var outputFilename string
 	var stretch bool
 	var encodeTimeoutOption string
+	var forceSdr bool
 
 	flag.StringVar(&inputFilename, "input", "", "name of input file to resize/transcode")
 	flag.StringVar(&outputFilename, "output", "", "name of output file, also determines output type")
 	flag.IntVar(&outputWidth, "width", 0, "width of output file")
 	flag.IntVar(&outputHeight, "height", 0, "height of output file")
 	flag.BoolVar(&stretch, "stretch", false, "perform stretching resize instead of cropping")
 	flag.StringVar(&encodeTimeoutOption, "timeout", "60s", "encode timeout for videos")
+	flag.BoolVar(&forceSdr, "force-sdr", false, "enable HDR to SDR tone mapping for images with PQ profiles")
 	flag.Parse()
 
 	if inputFilename == "" {
@@ -120,6 +122,7 @@ func main() {
 		NormalizeOrientation: true,
 		EncodeOptions:        EncodeOptions[outputType],
 		EncodeTimeout:        encodeTimeout,
+		ForceSdr:             forceSdr,
 	}
 
 	transformStartTime := time.Now()

examples/example

@@ -170,13 +170,13 @@ func NewDecoderWithOptionalToneMapping(buf []byte, toneMappingEnabled bool) (Dec
 // into compressed image data. ext should be a string like ".jpeg" or
 // ".png". decodedBy is optional and can be the Decoder used to make
 // the Framebuffer. dst is where an encoded image will be written.
-func NewEncoder(ext string, decodedBy Decoder, dst []byte) (Encoder, error) {
+func NewEncoder(ext string, decodedBy Decoder, dst []byte, forceSdr bool) (Encoder, error) {
 	if strings.ToLower(ext) == ".gif" {
 		return newGifEncoder(decodedBy, dst)
 	}
 
 	if strings.ToLower(ext) == ".webp" {
-		return newWebpEncoder(decodedBy, dst)
+		return newWebpEncoder(decodedBy, dst, forceSdr)
 	}
 
 	if strings.ToLower(ext) == ".avif" {
@@ -191,5 +191,5 @@ func NewEncoder(ext string, decodedBy Decoder, dst []byte) (Encoder, error) {
 		return newThumbhashEncoder(decodedBy, dst)
 	}
 
-	return newOpenCVEncoder(ext, decodedBy, dst)
+	return newOpenCVEncoder(ext, decodedBy, dst, forceSdr)
 }

examples/main.go

@@ -138,9 +138,11 @@ type openCVDecoder struct {
 
 // openCVEncoder implements the Encoder interface for images supported by OpenCV.
 type openCVEncoder struct {
-	encoder C.opencv_encoder // Native OpenCV encoder
-	dst     C.opencv_mat     // Destination OpenCV matrix
-	dstBuf  []byte           // Destination buffer for encoded data
+	encoder  C.opencv_encoder // Native OpenCV encoder
+	dst      C.opencv_mat     // Destination OpenCV matrix
+	dstBuf   []byte           // Destination buffer for encoded data
+	icc      []byte           // ICC color profile from source image
+	forceSdr bool             // Enable HDR to SDR tone mapping
 }
 
 // Depth returns the number of bits in the PixelType.
@@ -762,7 +764,7 @@ func (d *openCVDecoder) SkipFrame() error {
 	return ErrSkipNotSupported
 }
 
-func newOpenCVEncoder(ext string, decodedBy Decoder, dstBuf []byte) (*openCVEncoder, error) {
+func newOpenCVEncoder(ext string, decodedBy Decoder, dstBuf []byte, forceSdr bool) (*openCVEncoder, error) {
 	dstBuf = dstBuf[:1]
 	dst := C.opencv_mat_create_empty_from_data(C.int(cap(dstBuf)), unsafe.Pointer(&dstBuf[0]))
 
@@ -777,10 +779,14 @@ func newOpenCVEncoder(ext string, decodedBy Decoder, dstBuf []byte) (*openCVEnco
 		return nil, ErrInvalidImage
 	}
 
+	icc := decodedBy.ICC()
+
 	return &openCVEncoder{
-		encoder: enc,
-		dst:     dst,
-		dstBuf:  dstBuf,
+		encoder:  enc,
+		dst:      dst,
+		dstBuf:   dstBuf,
+		icc:      icc,
+		forceSdr: forceSdr,
 	}, nil
 }
 
@@ -797,7 +803,21 @@ func (e *openCVEncoder) Encode(f *Framebuffer, opt map[int]int) ([]byte, error)
 	if len(optList) > 0 {
 		firstOpt = (*C.int)(unsafe.Pointer(&optList[0]))
 	}
-	if !C.opencv_encoder_write(e.encoder, f.mat, firstOpt, C.size_t(len(optList))) {
+
+	var success bool
+	if e.forceSdr && len(e.icc) > 0 {
+		var iccPtr unsafe.Pointer
+		if len(e.icc) > 0 {
+			iccPtr = unsafe.Pointer(&e.icc[0])
+		}
+		success = bool(C.opencv_encoder_write_with_tone_mapping(
+			e.encoder, f.mat, firstOpt, C.size_t(len(optList)),
+			(*C.uint8_t)(iccPtr), C.size_t(len(e.icc)), C.bool(true)))
+	} else {
+		success = bool(C.opencv_encoder_write(e.encoder, f.mat, firstOpt, C.size_t(len(optList))))
+	}
+
+	if !success {
 		return nil, ErrInvalidImage
 	}
 

lilliput.go

@@ -269,7 +269,7 @@ func TestICC(t *testing.T) {
 
 			// try encoding a WebP image, including ICC profile data when available
 			dstBuf := make([]byte, destinationBufferSize)
-			encoder, err := newWebpEncoder(decoder, dstBuf)
+			encoder, err := newWebpEncoder(decoder, dstBuf, false)
 			if err != nil {
 				t.Fatalf("Failed to create a new webp encoder: %v", err)
 			}

opencv.go

@@ -57,6 +57,11 @@ type ImageOptions struct {
 	// If set to 0, only the first frame will be extracted (default behavior).
 	// This option only applies to video formats (MP4, MOV, WEBM).
 	VideoFrameSampleIntervalMs int
+
+	// ForceSdr enables HDR to SDR tone mapping for images with PQ (Perceptual Quantizer) profiles.
+	// When enabled, images with HDR color profiles will be tone-mapped to SDR for better compatibility.
+	// Only applies to WebP and PNG output formats.
+	ForceSdr bool
 }
 
 // ImageOps is a reusable object that can resize and encode images.
@@ -418,7 +423,7 @@ func (o *ImageOps) initializeTransform(d Decoder, opt *ImageOptions, dst []byte)
 		return nil, nil, err
 	}
 
-	enc, err := NewEncoder(opt.FileType, d, dst)
+	enc, err := NewEncoder(opt.FileType, d, dst, opt.ForceSdr)
 	if err != nil {
 		return nil, nil, err
 	}

opencv_test.go

@@ -21,6 +21,7 @@ type webpEncoder struct {
 	encoder    C.webp_encoder
 	dstBuf     []byte
 	icc        []byte
+	forceSdr   bool // Enable HDR to SDR tone mapping
 	frameIndex int
 	hasFlushed bool
 }
@@ -173,7 +174,7 @@ func (d *webpDecoder) SkipFrame() error {
 
 // newWebpEncoder creates a new WebP encoder using the provided decoder for metadata
 // and destination buffer for the encoded output.
-func newWebpEncoder(decodedBy Decoder, dstBuf []byte) (*webpEncoder, error) {
+func newWebpEncoder(decodedBy Decoder, dstBuf []byte, forceSdr bool) (*webpEncoder, error) {
 	dstBuf = dstBuf[:1]
 	icc := decodedBy.ICC()
 	bgColor := decodedBy.BackgroundColor()
@@ -190,9 +191,10 @@ func newWebpEncoder(decodedBy Decoder, dstBuf []byte) (*webpEncoder, error) {
 	}
 
 	return &webpEncoder{
-		encoder: enc,
-		dstBuf:  dstBuf,
-		icc:     icc,
+		encoder:  enc,
+		dstBuf:   dstBuf,
+		icc:      icc,
+		forceSdr: forceSdr,
 	}, nil
 }
 
@@ -228,7 +230,22 @@ func (e *webpEncoder) Encode(f *Framebuffer, opt map[int]int) ([]byte, error) {
 
 	// Encode the current frame
 	frameDelay := int(f.duration.Milliseconds())
-	length := C.webp_encoder_write(e.encoder, f.mat, firstOpt, C.size_t(len(optList)), C.int(frameDelay), C.int(f.blend), C.int(f.dispose), 0, 0)
+
+	var length C.size_t
+	if e.forceSdr && len(e.icc) > 0 {
+		var iccPtr unsafe.Pointer
+		if len(e.icc) > 0 {
+			iccPtr = unsafe.Pointer(&e.icc[0])
+		}
+		length = C.webp_encoder_write_with_tone_mapping(
+			e.encoder, f.mat, firstOpt, C.size_t(len(optList)),
+			C.int(frameDelay), C.int(f.blend), C.int(f.dispose), 0, 0,
+			(*C.uint8_t)(iccPtr), C.size_t(len(e.icc)), C.bool(true))
+	} else {
+		length = C.webp_encoder_write(e.encoder, f.mat, firstOpt, C.size_t(len(optList)),
+			C.int(frameDelay), C.int(f.blend), C.int(f.dispose), 0, 0)
+	}
+
 	if length == 0 {
 		return nil, ErrInvalidImage
 	}

ops.go

@@ -75,7 +75,7 @@ func testNewWebpEncoder(t *testing.T) {
 			defer decoder.Close()
 
 			dstBuf := make([]byte, destinationBufferSize)
-			encoder, err := newWebpEncoder(decoder, dstBuf)
+			encoder, err := newWebpEncoder(decoder, dstBuf, false)
 			if err != nil {
 				t.Fatalf("Unexpected error: %v", err)
 			}
@@ -161,7 +161,7 @@ func testWebpEncoderEncode(t *testing.T) {
 			}
 
 			dstBuf := make([]byte, destinationBufferSize)
-			encoder, err := newWebpEncoder(decoder, dstBuf)
+			encoder, err := newWebpEncoder(decoder, dstBuf, false)
 			if err != nil {
 				t.Fatalf("Failed to create a new webp encoder: %v", err)
 			}
@@ -195,7 +195,7 @@ func testWebpEncoderEncode(t *testing.T) {
 		defer decoder.Close()
 
 		dstBuf := make([]byte, destinationBufferSize)
-		encoder, err := newWebpEncoder(decoder, dstBuf)
+		encoder, err := newWebpEncoder(decoder, dstBuf, false)
 		if err != nil {
 			t.Fatalf("Failed to create a new webp encoder: %v", err)
 		}