Class: RiffBitmapInfoHeader

March 10, 2023 · View on GitHub

node-taglib-sharp / Exports / RiffBitmapInfoHeader

Class: RiffBitmapInfoHeader

This class provides a representation of a Microsoft BitmapInfoHeader structure which provides information about the dimensions and color format of a device-independent bitmap.

Link

https://docs.microsoft.com/en-us/windows/win32/api/wingdi/ns-wingdi-bitmapinfoheader

Constructors

constructor

• new RiffBitmapInfoHeader(data, offset)

Constructs and initializes a new instance by reading the raw structure from a specified position in the provided ByteVector.

Parameters

Name	Type	Description
`data`	`ByteVector`	ByteVector containing the raw data structure
`offset`	`number`	Index into `data` where the raw bitmap info header begins. Must be a positive, 32-bit integer.

Properties

FOURCC_CODES

▪ Static Readonly FOURCC_CODES: Map<number, string>

List of well known FOURCC codes and what they correspond to.

Remarks

This list was cobbled together using * The original .NET source * https://omiod.com/codec/list.php * https://www.fourcc.org/ * http://abcavi.kibi.ru/fourcc.php If any FOURCCs are missing or wrong, submit a PR and include a link to some source saying this FOURCC exists.

Accessors

bitCount

• get bitCount(): number

Gets the number of bits per pixel (bpp). For uncompressed formats, this value is the average number of bits per pixel. For compressed formats, this value is the implied bit depth of the uncompressed image, after the image has been decoded.

Returns

number

colorsUsed

• get colorsUsed(): number

Gets the number of color indices in the color table that are actually used by the bitmap.

Returns

number

compressionId

• get compressionId(): number

Gets the compression ID for the image.

Remarks

For compressed video and YUV formats, this is a FOURCC code, specified as a DWORD in little-endian order. For more information, see https://docs.microsoft.com/en-us/windows/win32/directshow/fourcc-codes and https://www.fourcc.org/fourcc.php. For uncompressed RGB formats, the following values are possible: * BI_RGB = 0x00000000 => Uncompressed RGB * BI_BITFIELDS = 0x00000003 => Uncompressed RGB with color masks, valid for 16 and 32 bpp bitmaps.

[description](RiffBitmapInfoHeader.md#description) makes a best-guess attempt to determine the name of the compression
codec used.

Remarks

The duration is not known from the video codec in a RIFF format file.

Returns

number

Implementation of

IVideoCodec.durationMilliseconds

imageSize

• get imageSize(): number

Gets the size, in bytes, of the image. This can be set to 0 for uncompressed RGB bitmaps.

Returns

number

importantColors

• get importantColors(): number

Gets the number of color indices that are considered important for displaying the bitmap. If this value is 0, all colors are important.

Returns

number

mediaTypes

• get mediaTypes(): MediaTypes

Types of media represented by the current instance, bitwise combined.

Returns

MediaTypes

Implementation of

IVideoCodec.mediaTypes

planes

• get planes(): number

Gets the number of planes in the image. This value is pretty much universally set to 1.

Returns

number

videoHeight

• get videoHeight(): number

Height of the video in pixels represented by the current instance.

Returns

number

Implementation of

IVideoCodec.videoHeight

videoWidth

• get videoWidth(): number

Width of the video in pixels represented by the current instance.

Returns

number

Implementation of

IVideoCodec.videoWidth

xPixelsPerMeter

• get xPixelsPerMeter(): number

Gets the horizontal resolution, in pixels per meter, of the target device for the bitmap.

Returns

number

yPixelsPerMeter

• get yPixelsPerMeter(): number

Gets the vertical resolution, in pixels per meter, of the target device for the bitmap.

Returns

number