Open source and universal binnary file format for mSLA/DLP (.osla)

This file format aims for simplicity, versatility, cleanest as possible and universal format for low-end printers that can't handle a ZIP + PNG slices approach due the incapacity of CPU to process such data schemes.

File extensions

This file format share and reserve the following file extensions:

.osla (Open SLA)
.odlp (Open DLP)
.omsla (Open mSLA)

Implementation requesites

Open-source file format
Document the changes and revisions, as well the reserved table if any
Universal: the file and revisions should always be compatible with any firmware that take this file
No encrypted files: The data should be plain and easy to access
No property or changed variant of the file format should exists!
Machine follows sequential gcode commands
Endianness: Little-Endian (LE)

Printer firmware checks (can print this file?)

Marker == "OSLATiCo" - This is a double check if file is really a .osla beside it extension, case sensitive compare.
Compare machine resolution with file resoltuion.
Can use ImageDataType? For example, if processor is unable to process PNG images, trigger an error and dont allow to continue.
Parse gcode and check for problems, such as, print on a position out of printer Z range.

Printer firmware layer data adquisiton

Machine firmware detects M6054 i gcode command.
Goes to the layer definition table at the i index given by the M6054 command.
Gets the image address and jumps to it.
Start to read and buffer the image to the LCD.
Jump back to the resume position and continue to execute the gcode.

Note: Printer only continue to execute the next gcode command after the image is displayed/buffered. When using a sencond board to display the image, it must send a OK back in order to resume the gcode execution. But a custom flag or M code command should exist to buffer the image in the background, eg: M6055.

Software data adquisiton

For slicers and other programs, data and per layer settings should be parsed from gcode.
For example, take UVtools GCodeBuilder.cs as example and search for ParseLayersFromGCode method

In file optimizations

When generating the file, layers that share the same image data, may reuse that data instead of duplicate the image. This allow to spare a good amount of data when file contains multiple layers that share same image over and over, for example, functional parts. See example on file sample bellow at [Layer 3].
While this is optional and either way it must be valid to print, is highly recommended to hash the layers.

Image data type

This file format allows common and custom image data types, such as:
- BITMAP
- PNG
- JPG/JPEG
- SVG/Vector
- LINE-XXY
- LINE-XYY
- RLE-XXXX
- Custom
Having different data types for previews and layers are allowed. eg: PreviewDataType=RGB16 and LayerDataType=PNG
The only requesite is to correct define the type of image data on the [Header] and respect that.
Custom image data types are possible, you must take a unique non conflicting ID but the documentation how to read and write are required in order to use a custom type.
If you want to apply and register your data type ID to be globaly used on firmwares, you must send us the draft for approval and get that ID reserved for the applied data scheme.

Previews

Able to save 0 or more previews
Previews must all use same image data type
Previews must be sorted from bigger to smaller

Offsets

Preview n = sizeof(File) + sizeof(Header) + sizeof(CustomTable) + n * PreviewTableSize + SUM(sizeof(..n PreviewDataSize))
Layer n = LayerDefinitionsAddress + n * LayerTableSize

Draft 1

Structure

[File] (150 bytes)
[Header] (68 bytes + sizeof(machine name))
[Custom table] (0 or more bytes)
[Previews] (0 or more)
- Preview 1 (8 bytes + sizeof(preview image data))
- Preview 2 (8 bytes + sizeof(preview image data))
- Preview n (8 bytes + sizeof(preview image data))
[Layer definitions]
- Layer 0 (4 bytes)
- Layer 1 (4 bytes)
[Layer image data]
- Layer 0 data (n bytes)
- Layer 1 data (n bytes)
[GCode] (4 bytes + sizeof(gcode text))

[File]
Marker=OSLATiCo (char[8]) Extra validation beside file extension, constant
Version=1 (ushort) File format revision
CreatedDateTime=2021-07-10 10:00:00Z (char[20] / DateTime) Universal sortable date and time string, as defined by ISO 8601 (yyyy-MM-dd HH:mm:ssZ)
CreatedBy=UVtools v2.14.0\0\0\0\0\0\0\0.. (char[50] fixed!) program/slicer who created the file (Set once)
ModifiedDateTime=2021-08-10 12:00:00Z (char[20] / DateTime) Universal sortable date and time string, as defined by ISO 8601 (yyyy-MM-dd HH:mm:ssZ)
ModifiedBy=UVtools v2.15.0\0\0\0\0\0\0\0.. (char[50] fixed!) program/slicer who last modified the file

[Header]
HeaderTableSize=sizeof(header) (uint), excluding this field
ResolutionX=1080 (uint)
ResolutionY=1080 (uint)
MachineZ=130.00 (float)
DisplayWidth=68.04 (float)
DisplayHeight=120.96 (float)
DisplayMirror=0 (byte) 0 = No mirror | 1 = Horizontally | 2 = Vertically | 3 = Horizontally+Vertically | >3 = No mirror
PreviewDataType=RGB16\0\0\0\0\0 (char[10]) compressed image data type, eg: RLE-XXX or RGB16 or PNG or JPG or BITMAP OR other?
LayerDataType=PNG\0\0\0\0\0\0\0 (char[10]) compressed image data type, eg: RLE-XXX or PNG or JPG or BITMAP OR other?
PreviewTableSize=8 (uint), Size of each preview table
NumberOfPreviews=2 (byte) Number of previews/thumbnails on this file
LayerCount=1000 (uint) Total number of layers
LayerTableSize=4 (uint), Size of each layer table
LayerDefinitionsAddress=00000 (uint) Address for layer definition start
GCodeAddress=000000 (uint) Address for gcode definition start
# Dynamic text fields
MachineNameSize=sizeof(MachineName) (ushort)
MachineName=Phrozen Sonic Mini (string)
# HEADER ends here

[CustomTable]
CustomTableSize=4 (uint) Number reserved of bytes for a custom table, this can be used for custom use of each brand, but not important for general file format
# This can be used to store slicer specific settings or additional information
# Still both printer and software must not depend on this
ExampleOfCustomField=1001 (uint)

[Preview 1]
ResolutionX=400 (ushort)
ResolutionY=400 (ushort)
PreviewDataSize=sizeof(DATA) (uint)
RLE/RGB16/PNG/JPG/BITMAP

[Preview 2]
ResolutionX=400 (ushort)
ResolutionY=800 (ushort)
PreviewDataSize=sizeof(DATA) (uint)
RLE/RGB16/PNG/JPG/BITMAP

[LayerDefinitions]
[Layer 1]
DataAddress=0000 (uint)
[Layer 2]
DataAddress=1111 (uint)
[Layer 3]
DataAddress=1111 (uint) (Identical layers can point to the same data if they share the same image, sparing space on file)

DataSize=sizeof(RLE) (uint)
RLE/PNG/JPG/BITMAP of layer 1
DataSize=sizeof(RLE) (uint)
RLE/PNG/JPG/BITMAP of layer 2

[GCode]
GCodeSize=sizeof(gcode) (uint) gcode text length
# Following by raw text
;START_GCODE_BEGIN
G21;Set units to be mm
G90;Absolute positioning
M106 S0;Turn LED OFF
M17;Enable motors
;<Slice> Blank
G28 Z0;Home Z
;END_GCODE_BEGIN

;LAYER_START:0
;PositionZ:0.05mm
M6054 0;Show image by layer index, to lookup on layer definition
G0 Z5.05 F60;Z Lift
G0 Z0.05 F150;Retract to layer height
G4 P10000;Stabilization delay
M106 S255;Turn LED ON
G4 P80000;Cure time/delay
M106 S0;Turn LED OFF
;<Slice> Blank
;LAYER_END

;START_GCODE_END
M106 S0;Turn LED OFF
G0 Z180 F150;Move Z
M18;Disable motors
;END_GCODE_END
;<Completed>

7.4 KiB Raw Blame History