@ -2,19 +2,21 @@
// Licensed under the Apache License, Version 2.0.
using System ;
using System.Buffers ;
using System.Buffers.Binary ;
using System.IO ;
using System.Numerics ;
using System.Runtime.CompilerServices ;
using SixLabors.ImageSharp.Common.Helpers ;
using SixLabors.ImageSharp.Memory ;
using SixLabors.ImageSharp.MetaD ata ;
using SixLabors.ImageSharp.Metad ata ;
using SixLabors.ImageSharp.PixelFormats ;
using SixLabors.Memory ;
namespace SixLabors.ImageSharp.Formats.Bmp
{
/// <summary>
/// Performs the bmp decoding operation.
/// Performs the bit ma p decoding operation.
/// </summary>
/// <remarks>
/// A useful decoding source example can be found at <see href="https://dxr.mozilla.org/mozilla-central/source/image/decoders/nsBMPDecoder.cpp"/>
@ -22,19 +24,19 @@ namespace SixLabors.ImageSharp.Formats.Bmp
internal sealed class BmpDecoderCore
{
/// <summary>
/// The mask for the red part of the color for 16 bit rgb bitmaps.
/// The default mask for the red part of the color for 16 bit rgb bitmaps.
/// </summary>
private const int Rgb16RMask = 0x7C00 ;
private const int Default Rgb16RMask= 0x7C00 ;
/// <summary>
/// The mask for the green part of the color for 16 bit rgb bitmaps.
/// The default mask for the green part of the color for 16 bit rgb bitmaps.
/// </summary>
private const int Rgb16GMask = 0x3E0 ;
private const int Default Rgb16GMask= 0x3E0 ;
/// <summary>
/// The mask for the blue part of the color for 16 bit rgb bitmaps.
/// The default mask for the blue part of the color for 16 bit rgb bitmaps.
/// </summary>
private const int Rgb16BMask = 0x1F ;
private const int Default Rgb16BMask= 0x1F ;
/// <summary>
/// RLE8 flag value that indicates following byte has special meaning.
@ -62,13 +64,17 @@ namespace SixLabors.ImageSharp.Formats.Bmp
private Stream stream ;
/// <summary>
/// The metadata
/// The metadata.
/// </summary>
private ImageMetaData metaData ;
private ImageMetadata metadata ;
/// <summary>
/// The bmp specific metadata.
/// </summary>
private BmpMetadata bmpMetadata ;
/// <summary>
/// The file header containing general information.
/// TODO: Why is this not used? We advance the stream but do not use the values parsed.
/// </summary>
private BmpFileHeader fileHeader ;
@ -85,7 +91,7 @@ namespace SixLabors.ImageSharp.Formats.Bmp
/// Initializes a new instance of the <see cref="BmpDecoderCore"/> class.
/// </summary>
/// <param name="configuration">The configuration.</param>
/// <param name="options">The options</param>
/// <param name="options">The options. </param>
public BmpDecoderCore ( Configuration configuration , IBmpDecoderOptions options )
{
this . configuration = configuration ;
@ -108,9 +114,9 @@ namespace SixLabors.ImageSharp.Formats.Bmp
{
try
{
this . ReadImageHeaders ( stream , out bool inverted , out byte [ ] palette ) ;
int bytesPerColorMapEntry = this . ReadImageHeaders ( stream , out bool inverted , out byte [ ] palette ) ;
var image = new Image < TPixel > ( this . configuration , this . infoHeader . Width , this . infoHeader . Height , this . metaD ata ) ;
var image = new Image < TPixel > ( this . configuration , this . infoHeader . Width , this . infoHeader . Height , this . metad ata ) ;
Buffer2D < TPixel > pixels = image . GetRootFramePixelBuffer ( ) ;
@ -119,7 +125,14 @@ namespace SixLabors.ImageSharp.Formats.Bmp
case BmpCompression . RGB :
if ( this . infoHeader . BitsPerPixel = = 3 2 )
{
this . ReadRgb32 ( pixels , this . infoHeader . Width , this . infoHeader . Height , inverted ) ;
if ( this . bmpMetadata . InfoHeaderType = = BmpInfoHeaderType . WinVersion3 )
{
this . ReadRgb32Slow ( pixels , this . infoHeader . Width , this . infoHeader . Height , inverted ) ;
}
else
{
this . ReadRgb32Fast ( pixels , this . infoHeader . Width , this . infoHeader . Height , inverted ) ;
}
}
else if ( this . infoHeader . BitsPerPixel = = 2 4 )
{
@ -137,16 +150,27 @@ namespace SixLabors.ImageSharp.Formats.Bmp
this . infoHeader . Width ,
this . infoHeader . Height ,
this . infoHeader . BitsPerPixel ,
bytesPerColorMapEntry ,
inverted ) ;
}
break ;
case BmpCompression . RLE8 :
this . ReadRle8 ( pixels , palette , this . infoHeader . Width , this . infoHeader . Height , inverted ) ;
case BmpCompression . RLE4 :
this . ReadRle ( this . infoHeader . Compression , pixels , palette , this . infoHeader . Width , this . infoHeader . Height , inverted ) ;
break ;
case BmpCompression . BitFields :
case BmpCompression . BI_ALPHABITFIELDS :
this . ReadBitFields ( pixels , inverted ) ;
break ;
default :
throw new NotSupportedException ( "Does not support this kind of bitmap files." ) ;
BmpThrowHelper . ThrowNotSupportedException ( "Does not support this kind of bitmap files." ) ;
break ;
}
return image ;
@ -164,7 +188,7 @@ namespace SixLabors.ImageSharp.Formats.Bmp
public IImageInfo Identify ( Stream stream )
{
this . ReadImageHeaders ( stream , out _ , out _ ) ;
return new ImageInfo ( new PixelTypeInfo ( this . infoHeader . BitsPerPixel ) , this . infoHeader . Width , this . infoHeader . Height , this . metaD ata ) ;
return new ImageInfo ( new PixelTypeInfo ( this . infoHeader . BitsPerPixel ) , this . infoHeader . Width , this . infoHeader . Height , this . metad ata ) ;
}
/// <summary>
@ -198,30 +222,66 @@ namespace SixLabors.ImageSharp.Formats.Bmp
}
/// <summary>
/// Performs final shifting from a 5bit value to an 8bit one.
/// Decodes a bitmap containing BITFIELDS Compression type. For each color channel, there will be bitmask
/// which will be used to determine which bits belong to that channel.
/// </summary>
/// <param name="value">The masked and shifted value</param>
/// <returns>The <see cref="byte"/></returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private static byte GetBytesFrom5BitValue ( int value ) = > ( byte ) ( ( value < < 3 ) | ( value > > 2 ) ) ;
/// <typeparam name="TPixel">The pixel format.</typeparam>
/// <param name="pixels">The output pixel buffer containing the decoded image.</param>
/// <param name="inverted">Whether the bitmap is inverted.</param>
private void ReadBitFields < TPixel > ( Buffer2D < TPixel > pixels , bool inverted )
where TPixel : struct , IPixel < TPixel >
{
if ( this . infoHeader . BitsPerPixel = = 1 6 )
{
this . ReadRgb16 (
pixels ,
this . infoHeader . Width ,
this . infoHeader . Height ,
inverted ,
this . infoHeader . RedMask ,
this . infoHeader . GreenMask ,
this . infoHeader . BlueMask ) ;
}
else
{
this . ReadRgb32BitFields (
pixels ,
this . infoHeader . Width ,
this . infoHeader . Height ,
inverted ,
this . infoHeader . RedMask ,
this . infoHeader . GreenMask ,
this . infoHeader . BlueMask ,
this . infoHeader . AlphaMask ) ;
}
}
/// <summary>
/// Looks up color values and builds the image from de-compressed RLE8 data.
/// Compresssed RLE8 stream is uncompressed by <see cref="UncompressRle8(int, Span{byte})"/>
/// Looks up color values and builds the image from de-compressed RLE8 or RLE4 data.
/// Compressed RLE8 stream is uncompressed by <see cref="UncompressRle8(int, Span{byte})"/>
/// Compressed RLE4 stream is uncompressed by <see cref="UncompressRle4(int, Span{byte})"/>
/// </summary>
/// <typeparam name="TPixel">The pixel format.</typeparam>
/// <param name="compression">The compression type. Either RLE4 or RLE8.</param>
/// <param name="pixels">The <see cref="Buffer2D{TPixel}"/> to assign the palette to.</param>
/// <param name="colors">The <see cref="T:byte[]"/> containing the colors.</param>
/// <param name="width">The width of the bitmap.</param>
/// <param name="height">The height of the bitmap.</param>
/// <param name="inverted">Whether the bitmap is inverted.</param>
private void ReadRle8 < TPixel > ( Buffer2D < TPixel > pixels , byte [ ] colors , int width , int height , bool inverted )
private void ReadRle < TPixel > ( BmpCompression compression , Buffer2D < TPixel > pixels , byte [ ] colors , int width , int height , bool inverted )
where TPixel : struct , IPixel < TPixel >
{
TPixel color = default ;
using ( Buffer2D < byte > buffer = this . memoryAllocator . Allocate2D < byte > ( width , height , AllocationOptions . Clean ) )
{
this . UncompressRle8 ( width , buffer . GetSpan ( ) ) ;
if ( compression = = BmpCompression . RLE8 )
{
this . UncompressRle8 ( width , buffer . GetSpan ( ) ) ;
}
else
{
this . UncompressRle4 ( width , buffer . GetSpan ( ) ) ;
}
for ( int y = 0 ; y < height ; y + + )
{
@ -239,12 +299,122 @@ namespace SixLabors.ImageSharp.Formats.Bmp
}
/// <summary>
/// Produce uncompressed bitmap data from RLE8 stream
/// Produce uncompressed bitmap data from a RLE4 stream.
/// </summary>
/// <remarks>
/// RLE8 is a 2-byte run-length encoding
/// <br/>If first byte is 0, the second byte may have special meaning
/// <br/>Otherwise, first byte is the length of the run and second byte is the color for the run
/// RLE4 is a 2-byte run-length encoding.
/// <br/>If first byte is 0, the second byte may have special meaning.
/// <br/>Otherwise, the first byte is the length of the run and second byte contains two color indexes.
/// </remarks>
/// <param name="w">The width of the bitmap.</param>
/// <param name="buffer">Buffer for uncompressed data.</param>
private void UncompressRle4 ( int w , Span < byte > buffer )
{
#if NETCOREAPP2_1
Span < byte > cmd = stackalloc byte [ 2 ] ;
#else
byte [ ] cmd = new byte [ 2 ] ;
#endif
int count = 0 ;
while ( count < buffer . Length )
{
if ( this . stream . Read ( cmd , 0 , cmd . Length ) ! = 2 )
{
BmpThrowHelper . ThrowImageFormatException ( "Failed to read 2 bytes from the stream while uncompressing RLE4 bitmap." ) ;
}
if ( cmd [ 0 ] = = RleCommand )
{
switch ( cmd [ 1 ] )
{
case RleEndOfBitmap :
return ;
case RleEndOfLine :
int extra = count % w ;
if ( extra > 0 )
{
count + = w - extra ;
}
break ;
case RleDelta :
int dx = this . stream . ReadByte ( ) ;
int dy = this . stream . ReadByte ( ) ;
count + = ( w * dy ) + dx ;
break ;
default :
// If the second byte > 2, we are in 'absolute mode'.
// The second byte contains the number of color indexes that follow.
int max = cmd [ 1 ] ;
int bytesToRead = ( max + 1 ) / 2 ;
byte [ ] run = new byte [ bytesToRead ] ;
this . stream . Read ( run , 0 , run . Length ) ;
int idx = 0 ;
for ( int i = 0 ; i < max ; i + + )
{
byte twoPixels = run [ idx ] ;
if ( i % 2 = = 0 )
{
byte leftPixel = ( byte ) ( ( twoPixels > > 4 ) & 0xF ) ;
buffer [ count + + ] = leftPixel ;
}
else
{
byte rightPixel = ( byte ) ( twoPixels & 0xF ) ;
buffer [ count + + ] = rightPixel ;
idx + + ;
}
}
// Absolute mode data is aligned to two-byte word-boundary
int padding = bytesToRead & 1 ;
this . stream . Skip ( padding ) ;
break ;
}
}
else
{
int max = cmd [ 0 ] ;
// The second byte contains two color indexes, one in its high-order 4 bits and one in its low-order 4 bits.
byte twoPixels = cmd [ 1 ] ;
byte rightPixel = ( byte ) ( twoPixels & 0xF ) ;
byte leftPixel = ( byte ) ( ( twoPixels > > 4 ) & 0xF ) ;
for ( int idx = 0 ; idx < max ; idx + + )
{
if ( idx % 2 = = 0 )
{
buffer [ count ] = leftPixel ;
}
else
{
buffer [ count ] = rightPixel ;
}
count + + ;
}
}
}
}
/// <summary>
/// Produce uncompressed bitmap data from a RLE8 stream.
/// </summary>
/// <remarks>
/// RLE8 is a 2-byte run-length encoding.
/// <br/>If first byte is 0, the second byte may have special meaning.
/// <br/>Otherwise, the first byte is the length of the run and second byte is the color for the run.
/// </remarks>
/// <param name="w">The width of the bitmap.</param>
/// <param name="buffer">Buffer for uncompressed data.</param>
@ -261,7 +431,7 @@ namespace SixLabors.ImageSharp.Formats.Bmp
{
if ( this . stream . Read ( cmd , 0 , cmd . Length ) ! = 2 )
{
throw new Exception ( "Failed to read 2 bytes from stream" ) ;
BmpThrowHelper . ThrowImageFormat Exception( "Failed to read 2 bytes from stream while uncompressing RLE8 bitmap. " ) ;
}
if ( cmd [ 0 ] = = RleCommand )
@ -310,9 +480,12 @@ namespace SixLabors.ImageSharp.Formats.Bmp
}
else
{
for ( int i = 0 ; i < cmd [ 0 ] ; i + + )
int max = count + cmd [ 0 ] ; // as we start at the current count in the following loop, max is count + cmd[0]
byte cmd1 = cmd [ 1 ] ; // store the value to avoid the repeated indexer access inside the loop
for ( ; count < max ; count + + )
{
buffer [ count + + ] = cmd [ 1 ] ;
buffer [ count ] = cmd1 ;
}
}
}
@ -326,18 +499,20 @@ namespace SixLabors.ImageSharp.Formats.Bmp
/// <param name="colors">The <see cref="T:byte[]"/> containing the colors.</param>
/// <param name="width">The width of the bitmap.</param>
/// <param name="height">The height of the bitmap.</param>
/// <param name="bits">The number of bits per pixel.</param>
/// <param name="bitsPerPixel">The number of bits per pixel.</param>
/// <param name="bytesPerColorMapEntry">Usually 4 bytes, but in case of Windows 2.x bitmaps or OS/2 1.x bitmaps
/// the bytes per color palette entry's can be 3 bytes instead of 4.</param>
/// <param name="inverted">Whether the bitmap is inverted.</param>
private void ReadRgbPalette < TPixel > ( Buffer2D < TPixel > pixels , byte [ ] colors , int width , int height , int bits , bool inverted )
private void ReadRgbPalette < TPixel > ( Buffer2D < TPixel > pixels , byte [ ] colors , int width , int height , int bitsPerPixel , int bytesPerColorMapEntry , bool inverted )
where TPixel : struct , IPixel < TPixel >
{
// Pixels per byte (bits per pixel)
int ppb = 8 / bits ;
int ppb = 8 / bitsPerPixel ;
int arrayWidth = ( width + ppb - 1 ) / ppb ;
// Bit mask
int mask = 0xFF > > ( 8 - bits ) ;
int mask = 0xFF > > ( 8 - bitsPerPixel ) ;
// Rows are aligned on 4 byte boundaries
int padding = arrayWidth % 4 ;
@ -363,7 +538,7 @@ namespace SixLabors.ImageSharp.Formats.Bmp
int colOffset = x * ppb ;
for ( int shift = 0 , newX = colOffset ; shift < ppb & & newX < width ; shift + + , newX + + )
{
int colorIndex = ( ( rowSpan [ offset ] > > ( 8 - bits - ( shift * bits ) ) ) & mask ) * 4 ;
int colorIndex = ( ( rowSpan [ offset ] > > ( 8 - bitsPerPixel - ( shift * bitsPerPixel ) ) ) & mask ) * bytesPerColorMapEntry ;
color . FromBgr24 ( Unsafe . As < byte , Bgr24 > ( ref colors [ colorIndex ] ) ) ;
pixelRow [ newX ] = color ;
@ -376,20 +551,32 @@ namespace SixLabors.ImageSharp.Formats.Bmp
}
/// <summary>
/// Reads the 16 bit color palette from the stream
/// Reads the 16 bit color palette from the stream.
/// </summary>
/// <typeparam name="TPixel">The pixel format.</typeparam>
/// <param name="pixels">The <see cref="Buffer2D{TPixel}"/> to assign the palette to.</param>
/// <param name="width">The width of the bitmap.</param>
/// <param name="height">The height of the bitmap.</param>
/// <param name="inverted">Whether the bitmap is inverted.</param>
private void ReadRgb16 < TPixel > ( Buffer2D < TPixel > pixels , int width , int height , bool inverted )
/// <param name="redMask">The bitmask for the red channel.</param>
/// <param name="greenMask">The bitmask for the green channel.</param>
/// <param name="blueMask">The bitmask for the blue channel.</param>
private void ReadRgb16 < TPixel > ( Buffer2D < TPixel > pixels , int width , int height , bool inverted , int redMask = DefaultRgb16RMask , int greenMask = DefaultRgb16GMask , int blueMask = DefaultRgb16BMask )
where TPixel : struct , IPixel < TPixel >
{
int padding = CalculatePadding ( width , 2 ) ;
int stride = ( width * 2 ) + padding ;
TPixel color = default ;
int rightShiftRedMask = CalculateRightShift ( ( uint ) redMask ) ;
int rightShiftGreenMask = CalculateRightShift ( ( uint ) greenMask ) ;
int rightShiftBlueMask = CalculateRightShift ( ( uint ) blueMask ) ;
// Each color channel contains either 5 or 6 Bits values.
int redMaskBits = CountBits ( ( uint ) redMask ) ;
int greenMaskBits = CountBits ( ( uint ) greenMask ) ;
int blueMaskBits = CountBits ( ( uint ) blueMask ) ;
using ( IManagedByteBuffer buffer = this . memoryAllocator . AllocateManagedByteBuffer ( stride ) )
{
for ( int y = 0 ; y < height ; y + + )
@ -403,10 +590,11 @@ namespace SixLabors.ImageSharp.Formats.Bmp
{
short temp = BitConverter . ToInt16 ( buffer . Array , offset ) ;
var rgb = new Rgb24 (
GetBytesFrom5BitValue ( ( temp & Rgb16RMask ) > > 1 0 ) ,
GetBytesFrom5BitValue ( ( temp & Rgb16GMask ) > > 5 ) ,
GetBytesFrom5BitValue ( temp & Rgb16BMask ) ) ;
// Rescale values, so the values range from 0 to 255.
int r = ( redMaskBits = = 5 ) ? GetBytesFrom5BitValue ( ( temp & redMask ) > > rightShiftRedMask ) : GetBytesFrom6BitValue ( ( temp & redMask ) > > rightShiftRedMask ) ;
int g = ( greenMaskBits = = 5 ) ? GetBytesFrom5BitValue ( ( temp & greenMask ) > > rightShiftGreenMask ) : GetBytesFrom6BitValue ( ( temp & greenMask ) > > rightShiftGreenMask ) ;
int b = ( blueMaskBits = = 5 ) ? GetBytesFrom5BitValue ( ( temp & blueMask ) > > rightShiftBlueMask ) : GetBytesFrom6BitValue ( ( temp & blueMask ) > > rightShiftBlueMask ) ;
var rgb = new Rgb24 ( ( byte ) r , ( byte ) g , ( byte ) b ) ;
color . FromRgb24 ( rgb ) ;
pixelRow [ x ] = color ;
@ -417,7 +605,23 @@ namespace SixLabors.ImageSharp.Formats.Bmp
}
/// <summary>
/// Reads the 24 bit color palette from the stream
/// Performs final shifting from a 5bit value to an 8bit one.
/// </summary>
/// <param name="value">The masked and shifted value.</param>
/// <returns>The <see cref="byte"/></returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private static byte GetBytesFrom5BitValue ( int value ) = > ( byte ) ( ( value < < 3 ) | ( value > > 2 ) ) ;
/// <summary>
/// Performs final shifting from a 6bit value to an 8bit one.
/// </summary>
/// <param name="value">The masked and shifted value.</param>
/// <returns>The <see cref="byte"/></returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private static byte GetBytesFrom6BitValue ( int value ) = > ( byte ) ( ( value < < 2 ) | ( value > > 4 ) ) ;
/// <summary>
/// Reads the 24 bit color palette from the stream.
/// </summary>
/// <typeparam name="TPixel">The pixel format.</typeparam>
/// <param name="pixels">The <see cref="Buffer2D{TPixel}"/> to assign the palette to.</param>
@ -436,36 +640,266 @@ namespace SixLabors.ImageSharp.Formats.Bmp
this . stream . Read ( row ) ;
int newY = Invert ( y , height , inverted ) ;
Span < TPixel > pixelSpan = pixels . GetRowSpan ( newY ) ;
PixelOperations < TPixel > . Instance . FromBgr24Bytes ( row . GetSpan ( ) , pixelSpan , width ) ;
PixelOperations < TPixel > . Instance . FromBgr24Bytes (
this . configuration ,
row . GetSpan ( ) ,
pixelSpan ,
width ) ;
}
}
}
/// <summary>
/// Reads the 32 bit color palette from the stream.
/// </summary>
/// <typeparam name="TPixel">The pixel format.</typeparam>
/// <param name="pixels">The <see cref="Buffer2D{TPixel}"/> to assign the palette to.</param>
/// <param name="width">The width of the bitmap.</param>
/// <param name="height">The height of the bitmap.</param>
/// <param name="inverted">Whether the bitmap is inverted.</param>
private void ReadRgb32Fast < TPixel > ( Buffer2D < TPixel > pixels , int width , int height , bool inverted )
where TPixel : struct , IPixel < TPixel >
{
int padding = CalculatePadding ( width , 4 ) ;
using ( IManagedByteBuffer row = this . memoryAllocator . AllocatePaddedPixelRowBuffer ( width , 4 , padding ) )
{
for ( int y = 0 ; y < height ; y + + )
{
this . stream . Read ( row ) ;
int newY = Invert ( y , height , inverted ) ;
Span < TPixel > pixelSpan = pixels . GetRowSpan ( newY ) ;
PixelOperations < TPixel > . Instance . FromBgra32Bytes (
this . configuration ,
row . GetSpan ( ) ,
pixelSpan ,
width ) ;
}
}
}
/// <summary>
/// Reads the 32 bit color palette from the stream
/// Reads the 32 bit color palette from the stream, checking the alpha component of each pixel.
/// This is a special case only used for 32bpp WinBMPv3 files, which could be in either BGR0 or BGRA format.
/// </summary>
/// <typeparam name="TPixel">The pixel format.</typeparam>
/// <param name="pixels">The <see cref="Buffer2D{TPixel}"/> to assign the palette to.</param>
/// <param name="width">The width of the bitmap.</param>
/// <param name="height">The height of the bitmap.</param>
/// <param name="inverted">Whether the bitmap is inverted.</param>
private void ReadRgb32 < TPixel > ( Buffer2D < TPixel > pixels , int width , int height , bool inverted )
private void ReadRgb32Slow < TPixel > ( Buffer2D < TPixel > pixels , int width , int height , bool inverted )
where TPixel : struct , IPixel < TPixel >
{
int padding = CalculatePadding ( width , 4 ) ;
using ( IManagedByteBuffer row = this . memoryAllocator . AllocatePaddedPixelRowBuffer ( width , 4 , padding ) )
using ( IMemoryOwner < Bgra32 > bgraRow = this . memoryAllocator . Allocate < Bgra32 > ( width ) )
{
Span < Bgra32 > bgraRowSpan = bgraRow . GetSpan ( ) ;
long currentPosition = this . stream . Position ;
bool hasAlpha = false ;
// Loop though the rows checking each pixel. We start by assuming it's
// an BGR0 image. If we hit a non-zero alpha value, then we know it's
// actually a BGRA image, and change tactics accordingly.
for ( int y = 0 ; y < height ; y + + )
{
this . stream . Read ( row ) ;
PixelOperations < Bgra32 > . Instance . FromBgra32Bytes (
this . configuration ,
row . GetSpan ( ) ,
bgraRowSpan ,
width ) ;
// Check each pixel in the row to see if it has an alpha value.
for ( int x = 0 ; x < width ; x + + )
{
Bgra32 bgra = bgraRowSpan [ x ] ;
if ( bgra . A > 0 )
{
hasAlpha = true ;
break ;
}
}
if ( hasAlpha )
{
break ;
}
}
// Reset our stream for a second pass.
this . stream . Position = currentPosition ;
// Process the pixels in bulk taking the raw alpha component value.
if ( hasAlpha )
{
for ( int y = 0 ; y < height ; y + + )
{
this . stream . Read ( row ) ;
int newY = Invert ( y , height , inverted ) ;
Span < TPixel > pixelSpan = pixels . GetRowSpan ( newY ) ;
PixelOperations < TPixel > . Instance . FromBgra32Bytes (
this . configuration ,
row . GetSpan ( ) ,
pixelSpan ,
width ) ;
}
return ;
}
// Slow path. We need to set each alpha component value to fully opaque.
for ( int y = 0 ; y < height ; y + + )
{
this . stream . Read ( row ) ;
PixelOperations < Bgra32 > . Instance . FromBgra32Bytes (
this . configuration ,
row . GetSpan ( ) ,
bgraRowSpan ,
width ) ;
int newY = Invert ( y , height , inverted ) ;
Span < TPixel > pixelSpan = pixels . GetRowSpan ( newY ) ;
PixelOperations < TPixel > . Instance . FromBgra32Bytes ( row . GetSpan ( ) , pixelSpan , width ) ;
for ( int x = 0 ; x < width ; x + + )
{
Bgra32 bgra = bgraRowSpan [ x ] ;
bgra . A = byte . MaxValue ;
ref TPixel pixel = ref pixelSpan [ x ] ;
pixel . FromBgra32 ( bgra ) ;
}
}
}
}
/// <summary>
/// Decode an 32 Bit Bitmap containing a bitmask for each color channel.
/// </summary>
/// <typeparam name="TPixel">The pixel format.</typeparam>
/// <param name="pixels">The output pixel buffer containing the decoded image.</param>
/// <param name="width">The width of the image.</param>
/// <param name="height">The height of the image.</param>
/// <param name="inverted">Whether the bitmap is inverted.</param>
/// <param name="redMask">The bitmask for the red channel.</param>
/// <param name="greenMask">The bitmask for the green channel.</param>
/// <param name="blueMask">The bitmask for the blue channel.</param>
/// <param name="alphaMask">The bitmask for the alpha channel.</param>
private void ReadRgb32BitFields < TPixel > ( Buffer2D < TPixel > pixels , int width , int height , bool inverted , int redMask , int greenMask , int blueMask , int alphaMask )
where TPixel : struct , IPixel < TPixel >
{
TPixel color = default ;
int padding = CalculatePadding ( width , 4 ) ;
int stride = ( width * 4 ) + padding ;
int rightShiftRedMask = CalculateRightShift ( ( uint ) redMask ) ;
int rightShiftGreenMask = CalculateRightShift ( ( uint ) greenMask ) ;
int rightShiftBlueMask = CalculateRightShift ( ( uint ) blueMask ) ;
int rightShiftAlphaMask = CalculateRightShift ( ( uint ) alphaMask ) ;
int bitsRedMask = CountBits ( ( uint ) redMask ) ;
int bitsGreenMask = CountBits ( ( uint ) greenMask ) ;
int bitsBlueMask = CountBits ( ( uint ) blueMask ) ;
int bitsAlphaMask = CountBits ( ( uint ) alphaMask ) ;
float invMaxValueRed = 1.0f / ( 0xFFFFFFFF > > ( 3 2 - bitsRedMask ) ) ;
float invMaxValueGreen = 1.0f / ( 0xFFFFFFFF > > ( 3 2 - bitsGreenMask ) ) ;
float invMaxValueBlue = 1.0f / ( 0xFFFFFFFF > > ( 3 2 - bitsBlueMask ) ) ;
uint maxValueAlpha = 0xFFFFFFFF > > ( 3 2 - bitsAlphaMask ) ;
float invMaxValueAlpha = 1.0f / maxValueAlpha ;
bool unusualBitMask = false ;
if ( bitsRedMask > 8 | | bitsGreenMask > 8 | | bitsBlueMask > 8 | | invMaxValueAlpha > 8 )
{
unusualBitMask = true ;
}
using ( IManagedByteBuffer buffer = this . memoryAllocator . AllocateManagedByteBuffer ( stride ) )
{
for ( int y = 0 ; y < height ; y + + )
{
this . stream . Read ( buffer . Array , 0 , stride ) ;
int newY = Invert ( y , height , inverted ) ;
Span < TPixel > pixelRow = pixels . GetRowSpan ( newY ) ;
int offset = 0 ;
for ( int x = 0 ; x < width ; x + + )
{
uint temp = BitConverter . ToUInt32 ( buffer . Array , offset ) ;
if ( unusualBitMask )
{
uint r = ( uint ) ( temp & redMask ) > > rightShiftRedMask ;
uint g = ( uint ) ( temp & greenMask ) > > rightShiftGreenMask ;
uint b = ( uint ) ( temp & blueMask ) > > rightShiftBlueMask ;
float alpha = alphaMask ! = 0 ? invMaxValueAlpha * ( ( uint ) ( temp & alphaMask ) > > rightShiftAlphaMask ) : 1.0f ;
var vector4 = new Vector4 (
r * invMaxValueRed ,
g * invMaxValueGreen ,
b * invMaxValueBlue ,
alpha ) ;
color . FromVector4 ( vector4 ) ;
}
else
{
byte r = ( byte ) ( ( temp & redMask ) > > rightShiftRedMask ) ;
byte g = ( byte ) ( ( temp & greenMask ) > > rightShiftGreenMask ) ;
byte b = ( byte ) ( ( temp & blueMask ) > > rightShiftBlueMask ) ;
byte a = alphaMask ! = 0 ? ( byte ) ( ( temp & alphaMask ) > > rightShiftAlphaMask ) : ( byte ) 2 5 5 ;
color . FromRgba32 ( new Rgba32 ( r , g , b , a ) ) ;
}
pixelRow [ x ] = color ;
offset + = 4 ;
}
}
}
}
/// <summary>
/// Calculates the necessary right shifts for a given color bitmask (the 0 bits to the right).
/// </summary>
/// <param name="n">The color bit mask.</param>
/// <returns>Number of bits to shift right.</returns>
private static int CalculateRightShift ( uint n )
{
int count = 0 ;
while ( n > 0 )
{
if ( ( 1 & n ) = = 0 )
{
count + + ;
}
else
{
break ;
}
n > > = 1 ;
}
return count ;
}
/// <summary>
/// Counts none zero bits.
/// </summary>
/// <param name="n">A color mask.</param>
/// <returns>The none zero bits.</returns>
private static int CountBits ( uint n )
{
int count = 0 ;
while ( n ! = 0 )
{
count + + ;
n & = n - 1 ;
}
return count ;
}
/// <summary>
/// Reads the <see cref="BmpInfoHeader"/> from the stream.
/// </summary>
@ -481,7 +915,7 @@ namespace SixLabors.ImageSharp.Formats.Bmp
int headerSize = BinaryPrimitives . ReadInt32LittleEndian ( buffer ) ;
if ( headerSize < BmpInfoHeader . CoreSize )
{
throw new NotSupportedException ( $"ImageSharp does not support this BMP file. HeaderSize: {headerSize} ." ) ;
BmpThrowHelper . Throw NotSupportedException( $"ImageSharp does not support this BMP file. HeaderSize is '{headerSize}' ." ) ;
}
int skipAmount = 0 ;
@ -494,23 +928,78 @@ namespace SixLabors.ImageSharp.Formats.Bmp
// read the rest of the header
this . stream . Read ( buffer , BmpInfoHeader . HeaderSizeSize , headerSize - BmpInfoHeader . HeaderSizeSize ) ;
BmpInfoHeaderType infoHeaderType = BmpInfoHeaderType . WinVersion2 ;
if ( headerSize = = BmpInfoHeader . CoreSize )
{
// 12 bytes
infoHeaderType = BmpInfoHeaderType . WinVersion2 ;
this . infoHeader = BmpInfoHeader . ParseCore ( buffer ) ;
}
else if ( headerSize > = BmpInfoHeader . Size )
else if ( headerSize = = BmpInfoHeader . Os22ShortSize )
{
// 16 bytes
infoHeaderType = BmpInfoHeaderType . Os2Version2Short ;
this . infoHeader = BmpInfoHeader . ParseOs22Short ( buffer ) ;
}
else if ( headerSize = = BmpInfoHeader . SizeV3 )
{
// == 40 bytes
infoHeaderType = BmpInfoHeaderType . WinVersion3 ;
this . infoHeader = BmpInfoHeader . ParseV3 ( buffer ) ;
// If the info header is BMP version 3 and the compression type is BITFIELDS,
// color masks for each color channel follow the info header.
if ( this . infoHeader . Compression = = BmpCompression . BitFields )
{
byte [ ] bitfieldsBuffer = new byte [ 1 2 ] ;
this . stream . Read ( bitfieldsBuffer , 0 , 1 2 ) ;
Span < byte > data = bitfieldsBuffer . AsSpan < byte > ( ) ;
this . infoHeader . RedMask = BinaryPrimitives . ReadInt32LittleEndian ( data . Slice ( 0 , 4 ) ) ;
this . infoHeader . GreenMask = BinaryPrimitives . ReadInt32LittleEndian ( data . Slice ( 4 , 4 ) ) ;
this . infoHeader . BlueMask = BinaryPrimitives . ReadInt32LittleEndian ( data . Slice ( 8 , 4 ) ) ;
}
else if ( this . infoHeader . Compression = = BmpCompression . BI_ALPHABITFIELDS )
{
byte [ ] bitfieldsBuffer = new byte [ 1 6 ] ;
this . stream . Read ( bitfieldsBuffer , 0 , 1 6 ) ;
Span < byte > data = bitfieldsBuffer . AsSpan < byte > ( ) ;
this . infoHeader . RedMask = BinaryPrimitives . ReadInt32LittleEndian ( data . Slice ( 0 , 4 ) ) ;
this . infoHeader . GreenMask = BinaryPrimitives . ReadInt32LittleEndian ( data . Slice ( 4 , 4 ) ) ;
this . infoHeader . BlueMask = BinaryPrimitives . ReadInt32LittleEndian ( data . Slice ( 8 , 4 ) ) ;
this . infoHeader . AlphaMask = BinaryPrimitives . ReadInt32LittleEndian ( data . Slice ( 1 2 , 4 ) ) ;
}
}
else if ( headerSize = = BmpInfoHeader . AdobeV3Size )
{
// == 52 bytes
infoHeaderType = BmpInfoHeaderType . AdobeVersion3 ;
this . infoHeader = BmpInfoHeader . ParseAdobeV3 ( buffer , withAlpha : false ) ;
}
else if ( headerSize = = BmpInfoHeader . AdobeV3WithAlphaSize )
{
// == 56 bytes
infoHeaderType = BmpInfoHeaderType . AdobeVersion3WithAlpha ;
this . infoHeader = BmpInfoHeader . ParseAdobeV3 ( buffer , withAlpha : true ) ;
}
else if ( headerSize = = BmpInfoHeader . Os2v2Size )
{
// == 64 bytes
infoHeaderType = BmpInfoHeaderType . Os2Version2 ;
this . infoHeader = BmpInfoHeader . ParseOs2Version2 ( buffer ) ;
}
else if ( headerSize > = BmpInfoHeader . SizeV4 )
{
// >= 40 bytes
this . infoHeader = BmpInfoHeader . Parse ( buffer ) ;
// >= 108 bytes
infoHeaderType = headerSize = = BmpInfoHeader . SizeV4 ? BmpInfoHeaderType . WinVersion4 : BmpInfoHeaderType . WinVersion5 ;
this . infoHeader = BmpInfoHeader . ParseV4 ( buffer ) ;
}
else
{
throw new NotSupportedException ( $"ImageSharp does not support this BMP file. HeaderSize: {headerSize}." ) ;
BmpThrowHelper . Throw NotSupportedException( $"ImageSharp does not support this BMP file. HeaderSize ' {headerSize}' ." ) ;
}
// Resolution is stored in PPM.
var meta = new ImageMetaData
var meta = new ImageMetad ata
{
ResolutionUnits = PixelResolutionUnit . PixelsPerMeter
} ;
@ -522,20 +1011,21 @@ namespace SixLabors.ImageSharp.Formats.Bmp
else
{
// Convert default metadata values to PPM.
meta . HorizontalResolution = Math . Round ( UnitConverter . InchToMeter ( ImageMetaD ata . DefaultHorizontalResolution ) ) ;
meta . VerticalResolution = Math . Round ( UnitConverter . InchToMeter ( ImageMetaD ata . DefaultVerticalResolution ) ) ;
meta . HorizontalResolution = Math . Round ( UnitConverter . InchToMeter ( ImageMetad ata . DefaultHorizontalResolution ) ) ;
meta . VerticalResolution = Math . Round ( UnitConverter . InchToMeter ( ImageMetad ata . DefaultVerticalResolution ) ) ;
}
this . metaD ata = meta ;
this . metad ata = meta ;
short bitsPerPixel = this . infoHeader . BitsPerPixel ;
BmpMetaData bmpMetaData = this . metaData . GetFormatMetaData ( BmpFormat . Instance ) ;
this . bmpMetadata = this . metadata . GetFormatMetadata ( BmpFormat . Instance ) ;
this . bmpMetadata . InfoHeaderType = infoHeaderType ;
// We can only encode at these bit rates so far.
if ( bitsPerPixel . Equals ( ( short ) BmpBitsPerPixel . Pixel24 )
| | bitsPerPixel . Equals ( ( short ) BmpBitsPerPixel . Pixel32 ) )
{
bmpMetaD ata. BitsPerPixel = ( BmpBitsPerPixel ) bitsPerPixel ;
this . bmpMetad ata. BitsPerPixel = ( BmpBitsPerPixel ) bitsPerPixel ;
}
// skip the remaining header because we can't read those parts
@ -555,12 +1045,19 @@ namespace SixLabors.ImageSharp.Formats.Bmp
this . stream . Read ( buffer , 0 , BmpFileHeader . Size ) ;
this . fileHeader = BmpFileHeader . Parse ( buffer ) ;
if ( this . fileHeader . Type ! = BmpConstants . TypeMarkers . Bitmap )
{
BmpThrowHelper . ThrowNotSupportedException ( $"ImageSharp does not support this BMP file. File header bitmap type marker '{this.fileHeader.Type}'." ) ;
}
}
/// <summary>
/// Reads the <see cref="BmpFileHeader"/> and <see cref="BmpInfoHeader"/> from the stream and sets the corresponding fields.
/// </summary>
private void ReadImageHeaders ( Stream stream , out bool inverted , out byte [ ] palette )
/// <returns>Bytes per color palette entry. Usually 4 bytes, but in case of Windows 2.x bitmaps or OS/2 1.x bitmaps
/// the bytes per color palette entry's can be 3 bytes instead of 4.</returns>
private int ReadImageHeaders ( Stream stream , out bool inverted , out byte [ ] palette )
{
this . stream = stream ;
@ -580,6 +1077,7 @@ namespace SixLabors.ImageSharp.Formats.Bmp
}
int colorMapSize = - 1 ;
int bytesPerColorMapEntry = 4 ;
if ( this . infoHeader . ClrUsed = = 0 )
{
@ -587,12 +1085,18 @@ namespace SixLabors.ImageSharp.Formats.Bmp
| | this . infoHeader . BitsPerPixel = = 4
| | this . infoHeader . BitsPerPixel = = 8 )
{
colorMapSize = ImageMaths . GetColorCountForBitDepth ( this . infoHeader . BitsPerPixel ) * 4 ;
int colorMapSizeBytes = this . fileHeader . Offset - BmpFileHeader . Size - this . infoHeader . HeaderSize ;
int colorCountForBitDepth = ImageMaths . GetColorCountForBitDepth ( this . infoHeader . BitsPerPixel ) ;
bytesPerColorMapEntry = colorMapSizeBytes / colorCountForBitDepth ;
// Edge case for less-than-full-sized palette: bytesPerColorMapEntry should be at least 3.
bytesPerColorMapEntry = Math . Max ( bytesPerColorMapEntry , 3 ) ;
colorMapSize = colorMapSizeBytes ;
}
}
else
{
colorMapSize = this . infoHeader . ClrUsed * 4 ;
colorMapSize = this . infoHeader . ClrUsed * bytesPerColorMapEntry ;
}
palette = null ;
@ -602,7 +1106,7 @@ namespace SixLabors.ImageSharp.Formats.Bmp
// 256 * 4
if ( colorMapSize > 1 0 2 4 )
{
throw new ImageFormatException ( $"Invalid bmp colormap size '{colorMapSize}'" ) ;
BmpThrowHelper . Throw ImageFormatException( $"Invalid bmp colormap size '{colorMapSize}'" ) ;
}
palette = new byte [ colorMapSize ] ;
@ -611,6 +1115,19 @@ namespace SixLabors.ImageSharp.Formats.Bmp
}
this . infoHeader . VerifyDimensions ( ) ;
int skipAmount = this . fileHeader . Offset - ( int ) this . stream . Position ;
if ( ( skipAmount + ( int ) this . stream . Position ) > this . stream . Length )
{
BmpThrowHelper . ThrowImageFormatException ( $"Invalid fileheader offset found. Offset is greater than the stream length." ) ;
}
if ( skipAmount > 0 )
{
this . stream . Skip ( skipAmount ) ;
}
return bytesPerColorMapEntry ;
}
}
}
SimantoR
7 years ago