Skip to content

V3 Backport : Reduce the number of memory allocations in lossless WebP encoder #2947

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 13, 2025

Conversation

JimBobSquarePants
Copy link
Member

Prerequisites

  • I have written a descriptive pull-request title
  • I have verified that there are no overlapping pull-requests open
  • I have verified that I am following the existing coding patterns and practice as demonstrated in the repository. These follow strict Stylecop rules 👮.
  • I have provided test coverage for my change (where applicable)

Description

Backport of #2940 for V3.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR backports performance improvements for the lossless WebP encoder by reducing memory allocations and optimizing backward reference handling. Key changes include:

  • Updating test and production code to use the new MemoryAllocator-based constructors for Vp8LBackwardRefs.
  • Converting PixOrCopy from a class to a readonly struct and updating its creation methods.
  • Refactoring loops to use foreach and in/ref semantics, as well as streamlining histogram and backward reference operations.

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
tests/ImageSharp.Tests/Formats/WebP/Vp8LHistogramTests.cs Updated instantiation of Vp8LBackwardRefs and literal token creation.
src/ImageSharp/Formats/Webp/Lossless/Vp8LHistogram.cs Changed iteration in StoreRefs and updated AddSinglePixOrCopy to use in parameters.
src/ImageSharp/Formats/Webp/Lossless/Vp8LEncoder.cs Removed block size calculation and updated references disposal.
src/ImageSharp/Formats/Webp/Lossless/Vp8LBackwardRefs.cs Migrated from List to MemoryAllocator-based storage and added a Clear method.
src/ImageSharp/Formats/Webp/Lossless/PixOrCopy.cs Converted to a readonly struct with updated factory methods for immutability.
src/ImageSharp/Formats/Webp/Lossless/HistogramEncoder.cs Refactored iteration logic and updated HistoListUpdateHead to require an index parameter.
src/ImageSharp/Formats/Webp/Lossless/CostModel.cs Replaced loop constructs with foreach for direct reference iteration.
src/ImageSharp/Formats/Webp/Lossless/BackwardReferenceEncoder.cs Updated loops to use ref iteration and replaced clear methods for consistency.
Comments suppressed due to low confidence (2)

src/ImageSharp/Formats/Webp/Lossless/BackwardReferenceEncoder.cs:782

  • [nitpick] Ensure that using ref iteration to mutate elements of a readonly struct is intended and safe in this context.
foreach (ref PixOrCopy v in refs)

src/ImageSharp/Formats/Webp/Lossless/HistogramEncoder.cs:467

  • [nitpick] Verify that passing the index 'j' to HistoListUpdateHead correctly maintains the intended order of histogram pairs.
HistoListUpdateHead(histoPriorityList, p, j);

this.count = 0;
}

public void Add(PixOrCopy pixOrCopy) => this.refs.Memory.Span[this.count++] = pixOrCopy;
Copy link
Preview

Copilot AI Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding a boundary check to ensure 'this.count' does not exceed the allocated memory length to prevent potential overflows.

Suggested change
public void Add(PixOrCopy pixOrCopy) => this.refs.Memory.Span[this.count++] = pixOrCopy;
public void Add(PixOrCopy pixOrCopy)
{
if (this.count >= this.refs.Memory.Length)
{
throw new InvalidOperationException("Cannot add more elements. Memory limit exceeded.");
}
this.refs.Memory.Span[this.count++] = pixOrCopy;
}

Copilot uses AI. Check for mistakes.

@JimBobSquarePants JimBobSquarePants merged commit f7d1a9e into release/3.1.x Jun 13, 2025
22 checks passed
@JimBobSquarePants JimBobSquarePants deleted the js/v3-backport-2940 branch June 13, 2025 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant