Add support for decoding jpeg's with arithmetic coding by brianpopow · Pull Request #2073 · SixLabors/ImageSharp

brianpopow · 2022-03-24T16:30:43Z

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

This PR adds support for decoding jpeg's with arithmetic coding.

gfoidl

I always enjoy reading such fine code.
At the same time I'm sorry for so much comments.

gfoidl · 2022-03-25T09:17:37Z

+ return;
+ }
+
+ int blockCol = (mcuCol * h) + x;


You could hoist mcuCol * h before the loop for (int x ..., as it's invariant for this loop and I don't expect JIT to hoist it for us (especially on older runtimes).

gfoidl · 2022-03-25T09:19:58Z

+
+ this.DecodeBlockBaseline(
+ component,
+ ref Unsafe.Add(ref blockRef, blockCol),


Suggested change
refUnsafe.Add(refblockRef,blockCol),
refUnsafe.Add(refblockRef,(uint)blockCol),
to avoid the sign-extending move.

@gfoidl I dont understand the suggestion: How can I use uint here, when Unsafe.Add expects int?

Here it's for the overload Unsafe.Add<T>(ref T source, nuint elementOffset) and uses the implicit conversion from uint -> nuint.
So the long form of the suggestion is
Suggested change
refUnsafe.Add(refblockRef,blockCol),
refUnsafe.Add(refblockRef,(nuint)(uint)blockCol),
but as the compiler does the second conversion for us, I've shortened it to
Suggested change
refUnsafe.Add(refblockRef,blockCol),
refUnsafe.Add(refblockRef,(uint)blockCol),
In essence, and to avoid the movsxd (the sign extending move), we need to convert the int to any of IntPtr / nint or UIntPtr / nuint. As first step here is to prove to the JIT that there's only positive numbers by the uint-cast, which elides the movsxd emitting.
The actual target type (nint or nuint respectively there IntPtr base variants) doesn't really matter then.

Thank you for the explanation. Now I see why it does not work: The uint overload is only available on .net6.0, so cant use that here.

Ah, sorry, didn't check that. The use (nint)(uint) for the cast.

gfoidl · 2022-03-25T09:56:19Z

+ v = -v;
+ }
+
+ Unsafe.Add(ref destinationRef, ZigZag.TransposingOrder[k]) = (short)v;


Suggested change
Unsafe.Add(refdestinationRef,ZigZag.TransposingOrder[k])=(short)v;
Unsafe.Add(refdestinationRef,(uint)ZigZag.TransposingOrder[k])=(short)v;

gfoidl · 2022-03-25T10:12:51Z

+
+namespace SixLabors.ImageSharp.Formats.Jpeg.Components.Decoder
+{
+ internal class ArithmeticStatistics


Can this be written as
usingSystem.Diagnostics;usingSystem.Runtime.CompilerServices;internalunsafestructArithmeticStatistics{privatefixedbytestatistics[256];publicArithmeticStatistics(booldc,intidentifier){this.IsDcStatistics=dc;this.Identifier=identifier;}publicboolIsDcStatistics{get;privateset;}publicintIdentifier{get;privateset;}publicrefbyteGetReference()=>refthis.statistics[0];publicrefbyteGetReference(intoffset){Debug.Assert(offset<256);returnrefthis.statistics[(uint)offset];}publicvoidReset(){Unsafe.InitBlockUnaligned(refthis.GetReference(),0x00,(uint)(this.IsDcStatistics?64:256));}}
?
avoids the additional allocation for each stats-object
downside: size is fixed to 256, so potentially the list will be larger
codegen is better than with the class especially for GetReference and Reset (which are the hottest methods here?)

gfoidl · 2022-03-25T10:15:26Z

+ /// <summary>
+ /// Gets the component id.
+ /// </summary>
+ public byte Id { get; }


The existing interface members don't have the access modifier specified.
It's not strictly needed, but C# allows this (since C# 8 I think).
At least it should be consistent withing this file.

gfoidl · 2022-03-25T10:24:45Z


- // Validate: width/height > 0 (they are upper-bounded by 2 byte max value so no need to check that)
+ // Validate: width/height > 0 (they are upper-bounded by 2 byte max value so no need to check that).
 if (frameHeight == 0 || frameWidth == 0)


Suggested change
if(frameHeight==0||frameWidth==0)
if((frameHeight|frameWidth)==0)
produces less code and avoids a branch.
Note: current JIT will do this optimizaiton for use, but older runtimes miss that optimization.

br3aker · 2022-03-25T11:50:03Z

I know that I'm asking for too much but can we postpone this PR from merging for a bit?
There's so much virtual types existing in current jpeg decoder and new ones from this PR which already led to explicit downcasting. I'm working on the downscaling decoding for jpeg which would also need some sort of a virtuality for both the huffman decoder and component post processing which combined can cause a mess IMO.

I'll push some fixes on your branch if you don't mind.

EDIT:
There's actually a lot of other fixes I've planned to do during refactoring PR so I'll fix everything later, sorry for interfering.

brianpopow · 2022-03-25T18:05:08Z

@gfoidl thanks for your review, its always appreciated!

@br3aker:

I know that I'm asking for too much but can we postpone this PR from merging for a bit?

Its not a problem, there is no need to rush this PR.

I'll push some fixes on your branch if you don't mind.

I would not mind, if you push directly to this branch, your help is very welcome, but I dont think you have permission to do so.
I am pretty sure its somehow possible to give you those write access to this branch, but I did not see how at the moment.
You will have to create a regular PR with this branch as the target branch instead of main.

br3aker · 2022-03-25T18:22:45Z

Code itself is very good, it's just those tiny little spots I'd want to fix but they do not block merging so it's okay. I will create a PR with general refactoring of the decoder part.

Co-authored-by: Günther Foidl <gue@korporal.at>

…ated in LoadTables

# Conflicts: # src/ImageSharp/Formats/Jpeg/JpegDecoderCore.cs

br3aker

Looks good overall but please revert component type to JpegComponent in JpegDecoderCore.

br3aker · 2022-04-21T21:41:34Z

+ /// <summary>
+ /// The arithmetic decoding tables.
+ /// </summary>
+ private List<ArithmeticDecodingTable> arithmeticDecodingTables;
+
+ /// <summary>
+ /// The restart interval.
+ /// </summary>
+ private int? resetInterval;


I don't like that this arithmetic coding specific property is leaked in the 'master' class, same goes for reset interval which should only be used inside scanDecoder but it's a broad question for some further refactoring - I'll work on it right after scaled decoding PR.

br3aker · 2022-04-21T21:48:43Z

 /// Gets or sets the frame component collection.
 /// </summary>
- public JpegComponent[] Components { get; set; }
+ public IJpegComponent[] Components { get; set; }


As far as I remember, IJpegComponent interface is used in tests for libjpeg output comparison but I think we shouldn't use this interface everywhere - this leads to virtual calls for every component field getter .

br3aker · 2022-05-01T08:08:52Z

@brianpopow hi! Anything blocking this PR from being merged?

brianpopow · 2022-05-01T10:44:00Z

@brianpopow hi! Anything blocking this PR from being merged?

@br3aker: I think this can be merged now.
@JimBobSquarePants do you have any objection on merging this?

JimBobSquarePants · 2022-05-01T10:54:07Z

Nope. Rock on

brianpopow added 2 commits March 24, 2022 14:57

Add support for decoding jpeg's with arithmetic coding
2c4b4cf

Add tests for arithmetic coding
c988208

brianpopow added the formats:jpeg label Mar 24, 2022

Merge branch 'main' into bp/arithmeticcoding
7e0540f

gfoidl reviewed Mar 25, 2022
View reviewed changes

JimBobSquarePants added this to the 3.0.0 milestone Mar 27, 2022

brianpopowand others added 6 commits March 30, 2022 13:18

Apply suggestions from code review
6a281b6
Co-authored-by: Günther Foidl <gue@korporal.at>

Fix build issue
0154e4e

Fix issue with jpeg's embedded in tiff's: scan decoder is already cre…
52c1f20
…ated in LoadTables

Additional review changes
0bc0cd8

Revert fixedBin back to byte[]
7371ed0

Merge remote-tracking branch 'origin/main' into bp/arithmeticcoding
af70b1d
# Conflicts: # src/ImageSharp/Formats/Jpeg/JpegDecoderCore.cs

brianpopow requested a review from a teamApril 21, 2022 10:17

br3aker suggested changes Apr 21, 2022
View reviewed changes

IJpegComponent -> JpegComponent
0a08940

br3aker approved these changes Apr 22, 2022
View reviewed changes

Merge branch 'main' into bp/arithmeticcoding
1d37679

br3aker mentioned this pull request May 1, 2022
Jpeg downscaling decoding #2076
Merged
9 tasks

Merge branch 'main' into bp/arithmeticcoding
5ed690d

brianpopow merged commit 3e7b2c9 into mainMay 1, 2022

brianpopow deleted the bp/arithmeticcoding branch May 1, 2022 10:54

This was referenced Sep 29, 2025
Bump SixLabors.ImageSharp from 2.1.11 to 3.1.11 EvotecIT/OfficeIMO#1283
Closed
Bump SixLabors.ImageSharp from 2.1.11 to 3.1.11 EvotecIT/OfficeIMO#1296
Closed

dependabotBot mentioned this pull request Oct 13, 2025
Bump SixLabors.ImageSharp from 2.1.11 to 3.1.11 EvotecIT/OfficeIMO#1314
Closed

dependabotBot mentioned this pull request Nov 3, 2025
Bump SixLabors.ImageSharp from 2.1.11 to 3.1.12 EvotecIT/OfficeIMO#1339
Closed

This was referenced Nov 17, 2025
Bump SixLabors.ImageSharp from 2.1.11 to 3.1.12 EvotecIT/OfficeIMO#1362
Closed
Bump SixLabors.ImageSharp from 2.1.11 to 3.1.12 yildirim-mehmet/onlineOfiice#8
Closed

dependabotBot mentioned this pull request Dec 18, 2025
Bump SixLabors.ImageSharp from 2.1.9 to 3.1.12 Infarh/MathCore.DSP#211
Closed

dependabotBot mentioned this pull request Feb 3, 2026
Bump SixLabors.ImageSharp from 2.1.11 to 3.1.12 mariacayres/reallife-law-assist#46
Merged

dependabotBot mentioned this pull request Mar 1, 2026
Bump SixLabors.ImageSharp from 2.1.11 to 3.1.12 MjrTom/PDF2MD#82
Merged

This was referenced Mar 23, 2026
Bump SixLabors.ImageSharp from 2.1.13 to 3.1.12 TownSuite/TownSuite.Web.ImageGen#24
Closed
Bump SixLabors.ImageSharp and SixLabors.ImageSharp.Drawing TownSuite/TownSuite.Web.ImageGen#25
Open

This was referenced Apr 26, 2026
Bump SixLabors.ImageSharp from 2.1.13 to 3.1.12 AndrewMcLachlan/ASM#369
Closed
Bump SixLabors.ImageSharp from 2.1.11 to 3.1.12 MjrTom/PDF2MD#103
Closed

This was referenced Jun 2, 2026
Bump SixLabors.ImageSharp from 2.1.13 to 4.0.0 fo-dicom/fo-dicom#2144
Closed
Bump SixLabors.ImageSharp from 2.1.11 to 4.0.0 MjrTom/PDF2MD#113
Open

This was referenced Jun 24, 2026
chore(deps): Bump SixLabors.ImageSharp from 2.1.12 to 4.0.0 art-of-v/fuel-flow-dn#15
Closed
Bump SixLabors.ImageSharp from 2.1.13 to 4.0.0 lopezautosales/Blazor_LopezAutoSales#25
Open

dependabotBot mentioned this pull request Jul 21, 2026
Bump SixLabors.ImageSharp from 2.1.12 to 4.0.0 mahathirmuh/trilingual-checker#7
Open

dependabotBot mentioned this pull request Aug 7, 2026
Bump SixLabors.ImageSharp from 2.1.13 to 4.0.0 DevBetterCom/DevBetterWeb#1442
Closed

dependabotBot mentioned this pull request Aug 18, 2026
Bump SixLabors.ImageSharp from 2.1.13 to 4.1.0 Wixely/Stashographer#10
Open

	refUnsafe.Add(refblockRef,blockCol),
	refUnsafe.Add(refblockRef,(uint)blockCol),

	refUnsafe.Add(refblockRef,blockCol),
	refUnsafe.Add(refblockRef,(nuint)(uint)blockCol),

	Unsafe.Add(refdestinationRef,ZigZag.TransposingOrder[k])=(short)v;
	Unsafe.Add(refdestinationRef,(uint)ZigZag.TransposingOrder[k])=(short)v;

	if(frameHeight==0\|\|frameWidth==0)
	if((frameHeight\|frameWidth)==0)

Uh oh!

Uh oh!

Conversation

brianpopow commented Mar 24, 2022

Prerequisites

Description

Uh oh!

gfoidl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gfoidlMar 25, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

br3aker commented Mar 25, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brianpopow commented Mar 25, 2022

Uh oh!

br3aker commented Mar 25, 2022

Uh oh!

br3aker left a comment

Choose a reason for hiding this comment

Uh oh!

br3akerApr 21, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

br3aker commented May 1, 2022

Uh oh!

brianpopow commented May 1, 2022

Uh oh!

JimBobSquarePants commented May 1, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

gfoidlMar 25, 2022•
edited
Loading

br3aker commented Mar 25, 2022•
edited
Loading

br3akerApr 21, 2022•
edited
Loading