Skip to content

Spanify various things and use UTF-8 literals #361

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

Merged
merged 2 commits into from
Jan 19, 2024
Merged

Spanify various things and use UTF-8 literals #361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63aef85
Convert various byte[] arrays to use statically initialized memory
iamcarbon Jan 18, 2024
c240e7c
Use UTF-8 literals
iamcarbon Jan 18, 2024
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
8 changes: 4 additions & 4 deletions MetadataExtractor/Formats/Apple/BplistReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,21 @@ public sealed class BplistReader
// https://opensource.apple.com/source/CF/CF-550/CFBinaryPList.c
// https://synalysis.com/how-to-decode-apple-binary-property-list-files/

private static readonly byte[] _bplistHeader = [(byte)'b', (byte)'p', (byte)'l', (byte)'i', (byte)'s', (byte)'t', (byte)'0', (byte)'0'];
private static ReadOnlySpan<byte> BplistHeader => "bplist00"u8;

/// <summary>
/// Gets whether <paramref name="bplist"/> starts with the expected header bytes.
/// </summary>
public static bool IsValid(byte[] bplist)
{
if (bplist.Length < _bplistHeader.Length)
if (bplist.Length < BplistHeader.Length)
{
return false;
}

for (int i = 0; i < _bplistHeader.Length; i++)
for (int i = 0; i < BplistHeader.Length; i++)
{
if (bplist[i] != _bplistHeader[i])
if (bplist[i] != BplistHeader[i])
{
return false;
}
Expand Down
4 changes: 2 additions & 2 deletions MetadataExtractor/Formats/Eps/EpsReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,15 +254,15 @@ private static void ExtractIccData(List<Directory> directories, SequentialReader
/// </summary>
private static void ExtractXmpData(List<Directory> directories, SequentialReader reader)
{
byte[] xmp = ReadUntil(reader, Encoding.UTF8.GetBytes("<?xpacket end=\"w\"?>"));
byte[] xmp = ReadUntil(reader, "<?xpacket end=\"w\"?>"u8);
directories.Add(new XmpReader().Extract(xmp));
}

/// <summary>
/// Reads all bytes until the given sentinel is observed.
/// The sentinel will be included in the returned bytes.
/// </summary>
private static byte[] ReadUntil(SequentialReader reader, byte[] sentinel)
private static byte[] ReadUntil(SequentialReader reader, ReadOnlySpan<byte> sentinel)
{
var bytes = new MemoryStream();

Expand Down
10 changes: 5 additions & 5 deletions MetadataExtractor/Formats/Exif/ExifReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,16 @@ public sealed class ExifReader : JpegSegmentWithPreambleMetadataReader
{
public const string JpegSegmentPreamble = "Exif\x0\x0";

private static readonly byte[] _preambleBytes = Encoding.ASCII.GetBytes(JpegSegmentPreamble);
private static ReadOnlySpan<byte> ExifPreamble => "Exif\x0\x0"u8;

public static bool StartsWithJpegExifPreamble(byte[] bytes) => bytes.StartsWith(_preambleBytes);
public static bool StartsWithJpegExifPreamble(byte[] bytes) => bytes.AsSpan().StartsWith(ExifPreamble);

public static int JpegSegmentPreambleLength => _preambleBytes.Length;
public static int JpegSegmentPreambleLength => ExifPreamble.Length;

/// <summary>Exif data stored in JPEG files' APP1 segment are preceded by this six character preamble "Exif\0\0".</summary>
protected override byte[] PreambleBytes => _preambleBytes;
protected override ReadOnlySpan<byte> PreambleBytes => ExifPreamble;

public override ICollection<JpegSegmentType> SegmentTypes { get; } = new[] { JpegSegmentType.App1 };
public override ICollection<JpegSegmentType> SegmentTypes { get; } = [JpegSegmentType.App1];

protected override IEnumerable<Directory> Extract(byte[] segmentBytes, int preambleLength)
{
Expand Down
6 changes: 3 additions & 3 deletions MetadataExtractor/Formats/Icc/IccReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@ namespace MetadataExtractor.Formats.Icc
public sealed class IccReader : IJpegSegmentMetadataReader
{
public const string JpegSegmentPreamble = "ICC_PROFILE"; // TODO what are the extra three bytes here? are they always the same?
private static readonly byte[] _jpegSegmentPreambleBytes = Encoding.UTF8.GetBytes(JpegSegmentPreamble);
private static ReadOnlySpan<byte> JpegSegmentPreambleBytes => "ICC_PROFILE"u8;

// NOTE the header is 14 bytes, while "ICC_PROFILE" is 11
private const int JpegSegmentPreambleLength = 14;

ICollection<JpegSegmentType> IJpegSegmentMetadataReader.SegmentTypes { get; } = new[] { JpegSegmentType.App2 };
ICollection<JpegSegmentType> IJpegSegmentMetadataReader.SegmentTypes { get; } = [JpegSegmentType.App2];

public IEnumerable<Directory> ReadJpegSegments(IEnumerable<JpegSegment> segments)
{
// ICC data can be spread across multiple JPEG segments.

// Skip any segments that do not contain the required preamble
var iccSegments = segments.Where(segment => segment.Bytes.Length > JpegSegmentPreambleLength && segment.Bytes.StartsWith(_jpegSegmentPreambleBytes)).ToList();
var iccSegments = segments.Where(segment => segment.Bytes.Length > JpegSegmentPreambleLength && segment.Bytes.AsSpan().StartsWith(JpegSegmentPreambleBytes)).ToList();

if (iccSegments.Count == 0)
return Enumerable.Empty<Directory>();
Expand Down
6 changes: 2 additions & 4 deletions MetadataExtractor/Formats/Iso14496/Boxes/ColorInformationBox.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ namespace MetadataExtractor.Formats.Iso14496.Boxes
{
internal sealed class ColorInformationBox : Box
{
private static readonly byte[] _emptyByteArray = [];

public const uint NclxTag = 0x6E636C78; // nclx
public const uint RICCTag = 0x72494343; // rICC
public const uint ProfTag = 0x70726F66; // prof
Expand All @@ -30,7 +28,7 @@ public ColorInformationBox(BoxLocation location, SequentialReader sr)
TransferCharacteristics = sr.GetUInt16();
MatrixCharacteristics = sr.GetUInt16();
FullRangeFlag = (sr.GetByte() & 128) == 128;
IccProfile = _emptyByteArray;
IccProfile = [];
break;
}
case RICCTag:
Expand All @@ -41,7 +39,7 @@ public ColorInformationBox(BoxLocation location, SequentialReader sr)
}
default:
{
IccProfile = _emptyByteArray;
IccProfile = [];
break;
}
}
Expand Down
4 changes: 2 additions & 2 deletions MetadataExtractor/Formats/Jfif/JfifReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ public sealed class JfifReader : JpegSegmentWithPreambleMetadataReader
{
public const string JpegSegmentPreamble = "JFIF";

protected override byte[] PreambleBytes { get; } = Encoding.ASCII.GetBytes(JpegSegmentPreamble);
protected override ReadOnlySpan<byte> PreambleBytes => "JFIF"u8;

public override ICollection<JpegSegmentType> SegmentTypes { get; } = new[] { JpegSegmentType.App0 };
public override ICollection<JpegSegmentType> SegmentTypes { get; } = [JpegSegmentType.App0];

protected override IEnumerable<Directory> Extract(byte[] segmentBytes, int preambleLength)
{
Expand Down
4 changes: 2 additions & 2 deletions MetadataExtractor/Formats/Jfxx/JfxxReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ public sealed class JfxxReader : JpegSegmentWithPreambleMetadataReader
{
public const string JpegSegmentPreamble = "JFXX";

protected override byte[] PreambleBytes { get; } = Encoding.ASCII.GetBytes(JpegSegmentPreamble);
protected override ReadOnlySpan<byte> PreambleBytes => "JFXX"u8;

public override ICollection<JpegSegmentType> SegmentTypes { get; } = new[] { JpegSegmentType.App0 };
public override ICollection<JpegSegmentType> SegmentTypes { get; } = [JpegSegmentType.App0];

protected override IEnumerable<Directory> Extract(byte[] segmentBytes, int preambleLength)
{
Expand Down
8 changes: 3 additions & 5 deletions MetadataExtractor/Formats/Jpeg/JpegSegmentWithPreambleMetadataReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,16 @@ namespace MetadataExtractor.Formats.Jpeg
{
public abstract class JpegSegmentWithPreambleMetadataReader : IJpegSegmentMetadataReader
{
protected abstract byte[] PreambleBytes { get; }
protected abstract ReadOnlySpan<byte> PreambleBytes { get; }

public abstract ICollection<JpegSegmentType> SegmentTypes { get; }

public IEnumerable<Directory> ReadJpegSegments(IEnumerable<JpegSegment> segments)
{
var preamble = PreambleBytes;

// Skip segments not starting with the required preamble
return segments
.Where(segment => segment.Bytes.StartsWith(preamble))
.SelectMany(segment => Extract(segment.Bytes, preambleLength: preamble.Length));
.Where(segment => segment.Bytes.AsSpan().StartsWith(PreambleBytes))
.SelectMany(segment => Extract(segment.Bytes, preambleLength: PreambleBytes.Length));
}

protected abstract IEnumerable<Directory> Extract(byte[] segmentBytes, int preambleLength);
Expand Down
4 changes: 2 additions & 2 deletions MetadataExtractor/Formats/Photoshop/PhotoshopReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ public sealed class PhotoshopReader : JpegSegmentWithPreambleMetadataReader
{
public const string JpegSegmentPreamble = "Photoshop 3.0";

protected override byte[] PreambleBytes { get; } = Encoding.ASCII.GetBytes(JpegSegmentPreamble);
protected override ReadOnlySpan<byte> PreambleBytes => "Photoshop 3.0"u8;

public override ICollection<JpegSegmentType> SegmentTypes { get; } = new[] { JpegSegmentType.AppD };
public override ICollection<JpegSegmentType> SegmentTypes { get; } = [JpegSegmentType.AppD];

protected override IEnumerable<Directory> Extract(byte[] segmentBytes, int preambleLength)
{
Expand Down
4 changes: 2 additions & 2 deletions MetadataExtractor/Formats/Png/PngChunkReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ namespace MetadataExtractor.Formats.Png
/// <author>Drew Noakes https://drewnoakes.com</author>
public sealed class PngChunkReader
{
private static readonly byte[] _pngSignatureBytes = [0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A];
private static ReadOnlySpan<byte> PngSignatureBytes => [0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A];

/// <exception cref="PngProcessingException"/>
/// <exception cref="IOException"/>
Expand Down Expand Up @@ -54,7 +54,7 @@ public IEnumerable<PngChunk> Extract(SequentialReader reader, ICollection<PngChu
// network byte order
reader = reader.WithByteOrder(isMotorolaByteOrder: true);

if (!_pngSignatureBytes.SequenceEqual(reader.GetBytes(_pngSignatureBytes.Length)))
if (!PngSignatureBytes.SequenceEqual(reader.GetBytes(PngSignatureBytes.Length)))
throw new PngProcessingException("PNG signature mismatch");

var seenImageHeader = false;
Expand Down
84 changes: 42 additions & 42 deletions MetadataExtractor/Formats/QuickTime/QuickTimeTypeChecker.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,61 +10,61 @@ internal sealed class QuickTimeTypeChecker : ITypeChecker
// http://www.ftyps.com

// QuickTime Mov
{ Util.FileType.QuickTime, Encoding.UTF8.GetBytes("moov") },
{ Util.FileType.QuickTime, Encoding.UTF8.GetBytes("wide") },
{ Util.FileType.QuickTime, Encoding.UTF8.GetBytes("mdat") },
{ Util.FileType.QuickTime, Encoding.UTF8.GetBytes("free") },
{ Util.FileType.QuickTime, Encoding.UTF8.GetBytes("qt ") },
{ Util.FileType.QuickTime, Encoding.UTF8.GetBytes("3g2a") },
{ Util.FileType.QuickTime, "moov"u8 },
{ Util.FileType.QuickTime, "wide"u8 },
{ Util.FileType.QuickTime, "mdat"u8 },
{ Util.FileType.QuickTime, "free"u8 },
{ Util.FileType.QuickTime, "qt "u8 },
{ Util.FileType.QuickTime, "3g2a"u8 },

// MP4
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("3gp5") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("avc1") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("iso2") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("isom") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("M4A ") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("M4B ") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("M4P ") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("M4V ") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("M4VH") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("M4VP") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("mmp4") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("mp41") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("mp42") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("mp71") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("MSNV") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("NDAS") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("NDSC") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("NDSH") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("NDSM") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("NDSP") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("NDSS") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("NDXC") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("NDXH") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("NDXM") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("NDXP") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("NDXS") },
{ Util.FileType.Mp4, Encoding.UTF8.GetBytes("nvr1") },
{ Util.FileType.Mp4, "3gp5"u8 },
{ Util.FileType.Mp4, "avc1"u8 },
{ Util.FileType.Mp4, "iso2"u8 },
{ Util.FileType.Mp4, "isom"u8 },
{ Util.FileType.Mp4, "M4A "u8 },
{ Util.FileType.Mp4, "M4B "u8 },
{ Util.FileType.Mp4, "M4P "u8 },
{ Util.FileType.Mp4, "M4V "u8 },
{ Util.FileType.Mp4, "M4VH"u8 },
{ Util.FileType.Mp4, "M4VP"u8 },
{ Util.FileType.Mp4, "mmp4"u8 },
{ Util.FileType.Mp4, "mp41"u8 },
{ Util.FileType.Mp4, "mp42"u8 },
{ Util.FileType.Mp4, "mp71"u8 },
{ Util.FileType.Mp4, "MSNV"u8 },
{ Util.FileType.Mp4, "NDAS"u8 },
{ Util.FileType.Mp4, "NDSC"u8 },
{ Util.FileType.Mp4, "NDSH"u8 },
{ Util.FileType.Mp4, "NDSM"u8 },
{ Util.FileType.Mp4, "NDSP"u8 },
{ Util.FileType.Mp4, "NDSS"u8 },
{ Util.FileType.Mp4, "NDXC"u8 },
{ Util.FileType.Mp4, "NDXH"u8 },
{ Util.FileType.Mp4, "NDXM"u8 },
{ Util.FileType.Mp4, "NDXP"u8 },
{ Util.FileType.Mp4, "NDXS"u8 },
{ Util.FileType.Mp4, "nvr1"u8 },

// HEIF
{ Util.FileType.Heif, Encoding.UTF8.GetBytes("mif1") },
{ Util.FileType.Heif, Encoding.UTF8.GetBytes("msf1") },
{ Util.FileType.Heif, Encoding.UTF8.GetBytes("heic") },
{ Util.FileType.Heif, Encoding.UTF8.GetBytes("heix") },
{ Util.FileType.Heif, Encoding.UTF8.GetBytes("hevc") },
{ Util.FileType.Heif, Encoding.UTF8.GetBytes("hevx") },
{ Util.FileType.Heif, "mif1"u8 },
{ Util.FileType.Heif, "msf1"u8 },
{ Util.FileType.Heif, "heic"u8 },
{ Util.FileType.Heif, "heix"u8 },
{ Util.FileType.Heif, "hevc"u8 },
{ Util.FileType.Heif, "hevx"u8 },

// CRX
{ Util.FileType.Crx, Encoding.UTF8.GetBytes("crx ") }
{ Util.FileType.Crx, "crx "u8 }
};

private static readonly byte[] _ftypBytes = Encoding.UTF8.GetBytes("ftyp");
private static ReadOnlySpan<byte> FtypBytes => "ftyp"u8;

public int ByteCount => 12;

public Util.FileType CheckType(byte[] bytes)
{
return bytes.RegionEquals(4, 4, _ftypBytes)
return bytes.RegionEquals(4, 4, FtypBytes)
? _ftypTrie.Find(bytes, 8, 4)
: Util.FileType.Unknown;
}
Expand Down
2 changes: 1 addition & 1 deletion MetadataExtractor/Formats/Riff/RiffTypeChecker.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ internal sealed class RiffTypeChecker : ITypeChecker

public Util.FileType CheckType(byte[] bytes)
{
if (!bytes.RegionEquals(0, 4, Encoding.UTF8.GetBytes("RIFF")))
if (!bytes.RegionEquals(0, 4, "RIFF"u8))
return Util.FileType.Unknown;
var fourCC = Encoding.UTF8.GetString(bytes, index: 8, count: 4);
return fourCC switch
Expand Down
21 changes: 7 additions & 14 deletions MetadataExtractor/Formats/Tga/TgaFooterReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,11 @@

namespace MetadataExtractor.Formats.Tga
{
internal readonly struct TgaFooter
internal readonly struct TgaFooter(int extOffset, int devOffset, byte[] signature)
{
public int ExtOffset { get; }
public int DevOffset { get; }
public byte[] Signature { get; }

public TgaFooter(int extOffset, int devOffset, byte[] signature)
{
ExtOffset = extOffset;
DevOffset = devOffset;
Signature = signature;
}
public int ExtOffset { get; } = extOffset;
public int DevOffset { get; } = devOffset;
public byte[] Signature { get; } = signature;
}

/// <summary>Reads TGA image file footer.</summary>
Expand All @@ -22,12 +15,12 @@ internal sealed class TgaFooterReader : TgaReader<TgaFooter>
{
private const int FooterSize = 26;

private static readonly byte[] _footerSignature = Encoding.ASCII.GetBytes("TRUEVISION-XFILE.\0");
private static ReadOnlySpan<byte> FooterSignature => "TRUEVISION-XFILE.\0"u8;

public bool TryGetOffsets(Stream stream, out int extOffset, out int devOffset)
{
var footer = Extract(stream, -FooterSize, SeekOrigin.End);
if (footer.Signature.RegionEquals(0, _footerSignature.Length, _footerSignature))
if (footer.Signature.RegionEquals(0, FooterSignature.Length, FooterSignature))
{
extOffset = footer.ExtOffset;
devOffset = footer.DevOffset;
Expand All @@ -45,7 +38,7 @@ protected override TgaFooter Extract(Stream stream, int offset)
return new TgaFooter(
extOffset: reader.GetInt32(),
devOffset: reader.GetInt32(),
signature: reader.GetBytes(_footerSignature.Length));
signature: reader.GetBytes(FooterSignature.Length));
}
}
}
2 changes: 1 addition & 1 deletion MetadataExtractor/Util/ByteArrayExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ namespace MetadataExtractor.Util
{
internal static class ByteArrayExtensions
{
public static bool RegionEquals(this byte[] bytes, int offset, int count, byte[] comparand)
public static bool RegionEquals(this byte[] bytes, int offset, int count, ReadOnlySpan<byte> comparand)
{
if (offset < 0 || // invalid arg
count < 0 || // invalid arg
Expand Down
21 changes: 21 additions & 0 deletions MetadataExtractor/Util/ByteTrie.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,27 @@ public void Add(T value, params byte[][] parts)
MaxDepth = Math.Max(MaxDepth, depth);
}

/// <summary>Store the given value at the specified path.</summary>
internal void Add(T value, ReadOnlySpan<byte> part)
{
var depth = 0;
var node = _root;

foreach (var b in part)
{
if (!node.Children.TryGetValue(b, out ByteTrieNode? child))
{
child = new ByteTrieNode();
node.Children[b] = child;
}
node = child;
depth++;
}

node.SetValue(value);
MaxDepth = Math.Max(MaxDepth, depth);
}

IEnumerator<T> IEnumerable<T>.GetEnumerator() => throw new NotSupportedException();

IEnumerator IEnumerable.GetEnumerator() => throw new NotSupportedException();
Expand Down
Loading