Skip to content

Remove Nullable disable from Png Code #3024

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Remove Nullable disable from Png Code #3024

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/ImageSharp/Formats/Png/Chunks/PngHeader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
// Copyright (c) Six Labors.
// Licensed under the Six Labors Split License.
#nullable disable

using System.Buffers.Binary;

Expand Down Expand Up @@ -88,7 +87,7 @@ public PngHeader(
/// </exception>
public void Validate()
{
if (!PngConstants.ColorTypes.TryGetValue(this.ColorType, out byte[] supportedBitDepths))
if (!PngConstants.ColorTypes.TryGetValue(this.ColorType, out byte[]? supportedBitDepths))
{
throw new NotSupportedException($"Invalid or unsupported color type. Was '{this.ColorType}'.");
}
Expand Down
15 changes: 12 additions & 3 deletions src/ImageSharp/Formats/Png/PngChunk.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// Copyright (c) Six Labors.
// Licensed under the Six Labors Split License.
#nullable disable

using System.Buffers;
using SixLabors.ImageSharp.Memory;

namespace SixLabors.ImageSharp.Formats.Png;

Expand All @@ -11,7 +11,7 @@ namespace SixLabors.ImageSharp.Formats.Png;
/// </summary>
internal readonly struct PngChunk
{
public PngChunk(int length, PngChunkType type, IMemoryOwner<byte> data = null)
public PngChunk(int length, PngChunkType type, IMemoryOwner<byte>? data = null)
{
this.Length = length;
this.Type = type;
Expand All @@ -36,7 +36,16 @@ public PngChunk(int length, PngChunkType type, IMemoryOwner<byte> data = null)
/// Gets the data bytes appropriate to the chunk type, if any.
/// This field can be of zero length or null.
/// </summary>
public IMemoryOwner<byte> Data { get; }
public IMemoryOwner<byte>? Data { get; }

public ReadOnlySpan<byte> DataSpan
Copy link
Contributor Author

@stefannikolei stefannikolei Nov 22, 2025

Choose a reason for hiding this comment

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

Do you have a better idea to to this? Or should I check for null at all consuming places?

{
get
{
DebugGuard.NotNull(this.Data);
return this.Data.GetSpan();
}
}

/// <summary>
/// Gets a value indicating whether the given chunk is critical to decoding
Expand Down
52 changes: 26 additions & 26 deletions src/ImageSharp/Formats/Png/PngDecoderCore.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,24 +192,24 @@ protected override Image<TPixel> Decode<TPixel>(BufferedReadStream stream, Cance
PngThrowHelper.ThrowInvalidHeader();
}

this.ReadHeaderChunk(pngMetadata, chunk.Data.GetSpan());
this.ReadHeaderChunk(pngMetadata, chunk.DataSpan);
break;
case PngChunkType.AnimationControl:
this.ReadAnimationControlChunk(pngMetadata, chunk.Data.GetSpan());
this.ReadAnimationControlChunk(pngMetadata, chunk.DataSpan);
break;
case PngChunkType.Physical:
ReadPhysicalChunk(metadata, chunk.Data.GetSpan());
ReadPhysicalChunk(metadata, chunk.DataSpan);
break;
case PngChunkType.Gamma:
ReadGammaChunk(pngMetadata, chunk.Data.GetSpan());
ReadGammaChunk(pngMetadata, chunk.DataSpan);
break;
case PngChunkType.Cicp:
ReadCicpChunk(metadata, chunk.Data.GetSpan());
ReadCicpChunk(metadata, chunk.DataSpan);
break;
case PngChunkType.FrameControl:
frameCount++;
currentFrame = null;
currentFrameControl = this.ReadFrameControlChunk(chunk.Data.GetSpan());
currentFrameControl = this.ReadFrameControlChunk(chunk.DataSpan);
break;
case PngChunkType.FrameData:
if (frameCount >= this.maxFrames)
Expand Down Expand Up @@ -277,32 +277,32 @@ protected override Image<TPixel> Decode<TPixel>(BufferedReadStream stream, Cance

break;
case PngChunkType.Palette:
this.palette = chunk.Data.GetSpan().ToArray();
this.palette = chunk.DataSpan.ToArray();
break;
case PngChunkType.Transparency:
this.paletteAlpha = chunk.Data.GetSpan().ToArray();
this.paletteAlpha = chunk.DataSpan.ToArray();
this.AssignTransparentMarkers(this.paletteAlpha, pngMetadata);
break;
case PngChunkType.Text:
this.ReadTextChunk(metadata, pngMetadata, chunk.Data.GetSpan());
this.ReadTextChunk(metadata, pngMetadata, chunk.DataSpan);
break;
case PngChunkType.CompressedText:
this.ReadCompressedTextChunk(metadata, pngMetadata, chunk.Data.GetSpan());
this.ReadCompressedTextChunk(metadata, pngMetadata, chunk.DataSpan);
break;
case PngChunkType.InternationalText:
this.ReadInternationalTextChunk(metadata, chunk.Data.GetSpan());
this.ReadInternationalTextChunk(metadata, chunk.DataSpan);
break;
case PngChunkType.Exif:
if (!this.skipMetadata)
{
byte[] exifData = new byte[chunk.Length];
chunk.Data.GetSpan().CopyTo(exifData);
chunk.DataSpan.CopyTo(exifData);
MergeOrSetExifProfile(metadata, new ExifProfile(exifData), replaceExistingKeys: true);
}

break;
case PngChunkType.EmbeddedColorProfile:
this.ReadColorProfileChunk(metadata, chunk.Data.GetSpan());
this.ReadColorProfileChunk(metadata, chunk.DataSpan);
break;
case PngChunkType.End:
goto EOF;
Expand Down Expand Up @@ -360,10 +360,10 @@ protected override ImageInfo Identify(BufferedReadStream stream, CancellationTok
switch (chunk.Type)
{
case PngChunkType.Header:
this.ReadHeaderChunk(pngMetadata, chunk.Data.GetSpan());
this.ReadHeaderChunk(pngMetadata, chunk.DataSpan);
break;
case PngChunkType.AnimationControl:
this.ReadAnimationControlChunk(pngMetadata, chunk.Data.GetSpan());
this.ReadAnimationControlChunk(pngMetadata, chunk.DataSpan);
break;
case PngChunkType.Physical:
if (this.colorMetadataOnly)
Expand All @@ -372,7 +372,7 @@ protected override ImageInfo Identify(BufferedReadStream stream, CancellationTok
break;
}

ReadPhysicalChunk(metadata, chunk.Data.GetSpan());
ReadPhysicalChunk(metadata, chunk.DataSpan);
break;
case PngChunkType.Gamma:
if (this.colorMetadataOnly)
Expand All @@ -381,7 +381,7 @@ protected override ImageInfo Identify(BufferedReadStream stream, CancellationTok
break;
}

ReadGammaChunk(pngMetadata, chunk.Data.GetSpan());
ReadGammaChunk(pngMetadata, chunk.DataSpan);
break;
case PngChunkType.Cicp:
if (this.colorMetadataOnly)
Expand All @@ -390,7 +390,7 @@ protected override ImageInfo Identify(BufferedReadStream stream, CancellationTok
break;
}

ReadCicpChunk(metadata, chunk.Data.GetSpan());
ReadCicpChunk(metadata, chunk.DataSpan);
break;
case PngChunkType.FrameControl:
++frameCount;
Expand All @@ -399,7 +399,7 @@ protected override ImageInfo Identify(BufferedReadStream stream, CancellationTok
break;
}

currentFrameControl = this.ReadFrameControlChunk(chunk.Data.GetSpan());
currentFrameControl = this.ReadFrameControlChunk(chunk.DataSpan);

break;
case PngChunkType.FrameData:
Expand Down Expand Up @@ -445,11 +445,11 @@ protected override ImageInfo Identify(BufferedReadStream stream, CancellationTok
this.SkipChunkDataAndCrc(chunk);
break;
case PngChunkType.Palette:
this.palette = chunk.Data.GetSpan().ToArray();
this.palette = chunk.DataSpan.ToArray();
break;

case PngChunkType.Transparency:
this.paletteAlpha = chunk.Data.GetSpan().ToArray();
this.paletteAlpha = chunk.DataSpan.ToArray();
this.AssignTransparentMarkers(this.paletteAlpha, pngMetadata);

// Spec says tRNS must be after PLTE so safe to exit.
Expand All @@ -466,7 +466,7 @@ protected override ImageInfo Identify(BufferedReadStream stream, CancellationTok
break;
}

this.ReadTextChunk(metadata, pngMetadata, chunk.Data.GetSpan());
this.ReadTextChunk(metadata, pngMetadata, chunk.DataSpan);
break;
case PngChunkType.CompressedText:
if (this.colorMetadataOnly)
Expand All @@ -475,7 +475,7 @@ protected override ImageInfo Identify(BufferedReadStream stream, CancellationTok
break;
}

this.ReadCompressedTextChunk(metadata, pngMetadata, chunk.Data.GetSpan());
this.ReadCompressedTextChunk(metadata, pngMetadata, chunk.DataSpan);
break;
case PngChunkType.InternationalText:
if (this.colorMetadataOnly)
Expand All @@ -484,7 +484,7 @@ protected override ImageInfo Identify(BufferedReadStream stream, CancellationTok
break;
}

this.ReadInternationalTextChunk(metadata, chunk.Data.GetSpan());
this.ReadInternationalTextChunk(metadata, chunk.DataSpan);
break;
case PngChunkType.Exif:
if (this.colorMetadataOnly)
Expand All @@ -496,7 +496,7 @@ protected override ImageInfo Identify(BufferedReadStream stream, CancellationTok
if (!this.skipMetadata)
{
byte[] exifData = new byte[chunk.Length];
chunk.Data.GetSpan().CopyTo(exifData);
chunk.DataSpan.CopyTo(exifData);
MergeOrSetExifProfile(metadata, new ExifProfile(exifData), replaceExistingKeys: true);
}

Expand Down Expand Up @@ -2015,7 +2015,7 @@ private void ValidateChunk(in PngChunk chunk, Span<byte> buffer)

this.crc32.Reset();
this.crc32.Append(chunkType);
this.crc32.Append(chunk.Data.GetSpan());
this.crc32.Append(chunk.DataSpan);

if (this.crc32.GetCurrentHashAsUInt32() != inputCrc)
{
Expand Down
Loading