Difference between revisions of "LazPaint LZP Format"

From Lazarus wiki
Jump to navigationJump to search
(→‎Thumbnail: single image)
(→‎Flat image: caption)
Line 72: Line 72:
 
=== Flat image ===
 
=== Flat image ===
  
The file always include a flattened image to make it easier for image viewers. It is in the [[LazPaint LZP Format Single Image|LZP single image format]].
+
The file always include a flattened image to make it easier for image viewers. It is in the [[LazPaint LZP Format Single Image|LZP single image format]]. If there is no layer structure, the caption of this image is the name of the unique layer. If there is a layer structure, then the caption of this image is discarded.

Revision as of 01:37, 17 March 2015

LZP File format specification

The default encoding for numbers is little endian. So the hexadecimal number $12345678 would be stored as the sequence of bytes 78 56 34 12.

Pascal convention is used in this document for hexadecimal numbers, so for example $10 means 16.

Global structure

The file is composed of:

Offset  Content
------  --------------------
0       File header
?       Thumbnail (optional)
?       Flat image
?       Layer structure (optional)

Note: some old formats do not have a header and start directly with the flat image. Image readers may discard those files. However for your information, in this case, images are always stored with ZStream compression and the size of the image is deduced from the size of the flat image.

File header

Offset  Size  Name                Content
------  ----  ------------------  ------------------------
0       8     magic               Always contains the string 'LazPaint'
8       4     zero1               Contains the number 0
12      4     headerSize          Size of this header

16      4     width               Width of the image canvas
20      4     height              Height of the image canvas
24      4     nbLayers            Number of layers
28      4     previewOffset       Offset (from the beginning of the file) of the flattened image

32      4     zero2               Contains the number 0
36      4     compressionMode     Contains flags indicating the compression and the presence of a thumbnail
40      4     reserved1           Reserved for future use. Set to 0.
44      4     layersOffset        Offset (from the beginning of the file) of the layer structure

headerSize contains the size of this header. An image reader must read this to know which fields are available. It must be greater or equal to 48.

width and height are the dimension of the canvas. There is no real limitation for these numbers however it is recommended to keep it under or equal to 8192.

nbLayers is the number of layers. The minimum is 1. There is no real limitation however it is recommended to keep it under or equal to 99.

layersOffset can be 0, in which case the image is flat and that there is no layer description.

Compression

compressionMode contains flags indicating the compression and the presence of a thumbnail.

The low order byte indicates the compression of the image. It is the value (compressionMode and $ff):

- $01 indicates ZStream compression

- $02 indicates RLE compression

The following flags can be defined:

- $100 indicates that there is thumbnail in PNG format; check with (compressionMode and $100) <> 0

If there is a thumbnail, it is directly after the header. The reader should read headerSize to have the correct location.

Thumbnail

Its presence is recommended however optional. Its presence is specified by the flag $100 of compressionMode.

Currently, it is a PNG file embedded directly after the header. It is provided as a way to facilitate quick preview.

PNG format is widespread so it is easy to implement a browser that would display the thumbnail. To do so, check that the header contains magic and that the flag for the thumbnail is set in compressionMode. Then jump to the end of the header using headerSize. Then read the PNG file.

There is no real limitation but the recommended size for the thumbnail is 128 along the largest dimension. The other dimension may be smaller if the image is not a square. Of course if the image is smaller than 128 then the thumbnail will be smaller than 128.

Flat image

The file always include a flattened image to make it easier for image viewers. It is in the LZP single image format. If there is no layer structure, the caption of this image is the name of the unique layer. If there is a layer structure, then the caption of this image is discarded.