Files
UVtools/UVtools.Core/FileFormats/ZCodexFile.cs
T
Tiago Conceição 22897ea389 v3.1.0
- **Benchmark:**
   - (Add) PNG, GZip, Deflate and LZ4 compress tests
   - (Change) Test against a known image instead of random noise
   - (Change) Single-thread tests from 100 to 200 and multi-thread tests from 1000 to 5000
   - (Improvement) Same image instance is shared between tests instead of create new per test
   - (Fix) Encode typo
- **Core:**
   - (Add) Layer compression method: Allow to choose the compression method for layer image
      - **PNG:** Compression=High Speed=Slow (Use with low RAM)
      - **GZip:** Compression=Medium Speed=Medium (Optimal)
      - **Deflate:** Compression=Medium Speed=Medium (Optimal)
      - **LZ4:** Compression=Low Speed=Fast (Use with high RAM)
   - (Improvement) Better handling on cancel operations and more immediate response
   - (Fix) Extract: Zip Slip Vulnerability (CWE-22)
- **File formats:**
   - (Improvement) Better handling of encode/decoding layers from zip files
   - (Fix) ZCode: Canceling the file load can trigger an error
   - (Fix) VDA: Unable to open vda zip files
- **Tools:**
   - (Improvement) Allow operations to be aware of ROI and Masks before execution (#436)
   - (Improvement) Scripting: Allow save and load profiles (#436)
   - (Fix) Adjust layer height: When using the Offset type the last layer in the range was not taken in account (#435)
- **UI:**
   - (Improvement) Allow layer zoom levels of 0.1x and 64x but constrain minimum zoom to the level of image fit
   - (Improvement) Update change log now shows with markdown style and more readable
   - (Fix) Windows MSI upgrade to this version (#432)
   - (Fix) Auto-updater for Mac ARM, was downloading x64 instead
2022-03-17 23:50:47 +00:00

626 lines
23 KiB
C#

/*
* GNU AFFERO GENERAL PUBLIC LICENSE
* Version 3, 19 November 2007
* Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
* Everyone is permitted to copy and distribute verbatim copies
* of this license document, but changing it is not allowed.
*/
using Emgu.CV;
using Emgu.CV.CvEnum;
using System;
using System.Collections.Generic;
using System.Drawing;
using System.Globalization;
using System.IO;
using System.IO.Compression;
using System.Text.Json;
using System.Text.RegularExpressions;
using UVtools.Core.Extensions;
using UVtools.Core.GCode;
using UVtools.Core.Layers;
using UVtools.Core.Operations;
namespace UVtools.Core.FileFormats;
public class ZCodexFile : FileFormat
{
#region Constants
private const string GCodeStart = "G28\nG21\nG91\nM17\n";
private const string GCodeKeywordSlice = "<Slice>";
private const string GCodeKeywordDelayBlank = "<Delay_blank>";
private const string GCodeKeywordDelayModel = "<Delay_model>";
private const string GCodeKeywordDelaySupportPart = "<Delay_support_part>";
private const string GCodeKeywordDelaySupportFull = "<Delay_support_full>";
private const string FolderImages = "ResinSlicesData";
private const string FolderImageName = "Slice";
#endregion
#region Sub Classes
public class ResinMetadata
{
public class LayerData
{
public uint Layer { get; set; }
public float UsedMaterialVolume { get; set; }
}
public string Guid { get; set; } = "07452AC2-7494-4576-BA60-BFEA8815F917";
public string? Material { get; set; }
public string? MaterialId { get; set; }
public float LayerThickness { get; set; }
public uint PrintTime { get; set; }
public uint LayerTime { get; set; }
public uint BottomLayersTime { get; set; }
public uint AdditionalSupportLayerTime { get; set; }
public ushort BottomLayersNumber { get; set; }
public uint BlankingLayerTime { get; set; }
public float TotalMaterialVolumeUsed { get; set; }
public float TotalMaterialWeightUsed { get; set; }
public uint TotalLayersCount { get; set; }
public bool DisableSettingsChanges { get; set; }
public List<LayerData> Layers { get; set; } = new();
}
public class UserSettingsdata
{
public uint MaxLayer { get; set; }
public string? PrintTime { get; set; }
public float MaterialVolume { get; set; }
public byte IsAdvanced { get; set; }
public string Printer { get; set; } = "Zortrax Inkspire";
public string? MaterialType { get; set; }
public uint MaterialId { get; set; }
public string? LayerThickness { get; set; }
public byte RaftEnabled { get; set; }
public float RaftHeight { get; set; }
public float RaftOffset { get; set; }
public byte ModelLiftEnabled { get; set; }
public float ModelLiftHeight { get; set; }
public byte CrossSupportEnabled { get; set; }
public uint LayerExposureTime { get; set; }
//public uint LayerThicknessesDisplayTime { get; set; } arr
public uint ExposureOffTime { get; set; } = 5;
public uint BottomLayerExposureTime { get; set; }
public ushort BottomLayersCount { get; set; }
public byte SupportAdditionalExposureEnabled { get; set; }
public uint SupportAdditionalExposureTime { get; set; }
public float ZLiftDistance { get; set; } = 5;
public float ZLiftRetractRate { get; set; } = 100;
public float ZLiftFeedRate { get; set; } = 100;
public byte AntiAliasing { get; set; } = 0;
public float XCorrection { get; set; }
public float YCorrection { get; set; }
public byte HollowEnabled { get; set; }
public float HollowThickness { get; set; }
public byte InfillDensity { get; set; }
}
public class ZCodeMetadata
{
public class MaterialsData
{
public string? ExtruderType { get; set; }
public uint Id { get; set; }
public string? Name { get; set; }
public uint Usage { get; set; }
public uint Temperature { get; set; }
}
public string ZCodexVersion { get; set; } = "2.0.0.0";
public string SoftwareVersion { get; set; } = "2.12.2.0";
public string MinFirmwareVersion { get; set; } = "20013";
public uint PrinterModelEnumId { get; set; } = 40;
public string PrinterName { get; set; } = "Inkspire";
public List<MaterialsData> Materials { get; set; } = new()
{
new MaterialsData
{
Name = "",
ExtruderType = "MAIN",
Id = 0,
Usage = 0,
Temperature = 0
}
};
public byte HeatbedTemperature { get; set; }
public byte ChamberTemperature { get; set; }
public uint CommandCount { get; set; }
public uint PrintTime { get; set; }
public float NozzleDiameter { get; set; }
public string? PrintBoundingBox { get; set; }
public string? Pauses { get; set; }
public string? MaterialUsages { get; set; }
}
public class LayerData
{
public int SupportLayerFileIndex { get; set; } = -1;
public int LayerFileIndex { get; set; } = -1;
public ZipArchiveEntry? SupportLayerEntry { get; set; }
public ZipArchiveEntry? LayerEntry { get; set; }
public bool HaveSupportLayer => SupportLayerEntry is not null;
}
#endregion
#region Properties
public ResinMetadata ResinMetadataSettings { get; set; } = new();
public UserSettingsdata UserSettings { get; set; } = new();
public ZCodeMetadata ZCodeMetadataSettings { get; set; } = new();
public List<LayerData> LayersSettings { get; } = new();
public override FileFormatType FileType => FileFormatType.Archive;
public override FileExtension[] FileExtensions { get; } = {
new(typeof(ZCodexFile), "zcodex", "Z-Suite ZCodex")
};
public override PrintParameterModifier[]? PrintParameterModifiers { get; } = {
PrintParameterModifier.BottomLayerCount,
PrintParameterModifier.WaitTimeBeforeCure,
PrintParameterModifier.BottomExposureTime,
PrintParameterModifier.ExposureTime,
PrintParameterModifier.LiftHeight,
PrintParameterModifier.LiftSpeed,
PrintParameterModifier.BottomRetractSpeed,
PrintParameterModifier.RetractSpeed,
};
public override PrintParameterModifier[]? PrintParameterPerLayerModifiers { get; } = {
PrintParameterModifier.PositionZ,
PrintParameterModifier.LiftHeight,
PrintParameterModifier.LiftSpeed,
PrintParameterModifier.RetractSpeed,
PrintParameterModifier.LightPWM,
};
public override Size[]? ThumbnailsOriginalSize { get; } = {new(320, 180)};
public override uint ResolutionX
{
get => 1440;
set { }
}
public override uint ResolutionY
{
get => 2560;
set { }
}
public override float DisplayWidth
{
get => 74.67f;
set {}
}
public override float DisplayHeight
{
get => 132.88f;
set { }
}
public override Enumerations.FlipDirection DisplayMirror
{
get => Enumerations.FlipDirection.Horizontally;
set { }
}
public override byte AntiAliasing
{
get => UserSettings.AntiAliasing;
set => base.AntiAliasing = UserSettings.AntiAliasing = value.Clamp(1, 16);
}
public override float LayerHeight
{
get => ResinMetadataSettings.LayerThickness;
set
{
ResinMetadataSettings.LayerThickness = Layer.RoundHeight(value);
UserSettings.LayerThickness = $"{ResinMetadataSettings.LayerThickness} mm";
RaisePropertyChanged();
}
}
public override uint LayerCount
{
get => base.LayerCount;
set
{
base.LayerCount = ResinMetadataSettings.TotalLayersCount = base.LayerCount;
UserSettings.MaxLayer = LastLayerIndex;
}
}
public override ushort BottomLayerCount
{
get => ResinMetadataSettings.BottomLayersNumber;
set => base.BottomLayerCount = ResinMetadataSettings.BottomLayersNumber = UserSettings.BottomLayersCount = value;
}
public override float BottomLightOffDelay => BottomWaitTimeBeforeCure;
public override float LightOffDelay => WaitTimeBeforeCure;
public override float BottomWaitTimeBeforeCure => WaitTimeBeforeCure;
public override float WaitTimeBeforeCure
{
get => TimeExtensions.MillisecondsToSeconds(ResinMetadataSettings.BlankingLayerTime);
set
{
UserSettings.ExposureOffTime = ResinMetadataSettings.BlankingLayerTime = TimeExtensions.SecondsToMillisecondsUint(value);
base.WaitTimeBeforeCure = base.LightOffDelay = value;
}
}
public override float BottomExposureTime
{
get => TimeExtensions.MillisecondsToSeconds(UserSettings.BottomLayerExposureTime);
set
{
ResinMetadataSettings.BottomLayersTime = UserSettings.BottomLayerExposureTime = TimeExtensions.SecondsToMillisecondsUint(value);
base.BottomExposureTime = value;
}
}
public override float ExposureTime
{
get => TimeExtensions.MillisecondsToSeconds(UserSettings.LayerExposureTime);
set
{
ResinMetadataSettings.LayerTime = UserSettings.LayerExposureTime = TimeExtensions.SecondsToMillisecondsUint(value);
base.ExposureTime = value;
}
}
public override float BottomLiftHeight => LiftHeight;
public override float LiftHeight
{
get => UserSettings.ZLiftDistance;
set => base.LiftHeight = UserSettings.ZLiftDistance = (float)Math.Round(value, 2);
}
public override float BottomLiftSpeed => LiftSpeed;
public override float LiftSpeed
{
get => UserSettings.ZLiftFeedRate;
set => base.LiftSpeed = UserSettings.ZLiftFeedRate = (float)Math.Round(value, 2);
}
public override float RetractSpeed
{
get => UserSettings.ZLiftRetractRate;
set => base.RetractSpeed = UserSettings.ZLiftRetractRate = (float)Math.Round(value, 2);
}
public override float PrintTime
{
get => ResinMetadataSettings.PrintTime;
set
{
base.PrintTime = value;
ResinMetadataSettings.PrintTime = (uint)base.PrintTime;
TimeSpan ts = new(0, 0, (int)base.PrintTime);
UserSettings.PrintTime = $"{ts.Hours}h {ts.Minutes}m";
}
}
public override float MaterialMilliliters
{
get => base.MaterialMilliliters;
set
{
base.MaterialMilliliters = value;
ResinMetadataSettings.TotalMaterialVolumeUsed = base.MaterialMilliliters;
}
}
public override float MaterialGrams
{
get => (float) Math.Round(ResinMetadataSettings.TotalMaterialWeightUsed, 3);
set => base.MaterialGrams = ResinMetadataSettings.TotalMaterialWeightUsed = (float) Math.Round(value, 3);
}
public override string? MaterialName
{
get => ResinMetadataSettings.Material;
set => base.MaterialName = ResinMetadataSettings.Material = value;
}
public override string MachineName
{
get => ZCodeMetadataSettings.PrinterName;
set => base.MachineName = ZCodeMetadataSettings.PrinterName = value;
}
public override object[] Configs => new[] {(object) ResinMetadataSettings, UserSettings, ZCodeMetadataSettings};
#endregion
#region Constructor
public ZCodexFile()
{
GCode = new()
{
UseComments = true,
GCodePositioningType = GCodeBuilder.GCodePositioningTypes.Partial,
GCodeSpeedUnit = GCodeBuilder.GCodeSpeedUnits.MillimetersPerMinute,
GCodeTimeUnit = GCodeBuilder.GCodeTimeUnits.Milliseconds,
GCodeShowImageType = GCodeBuilder.GCodeShowImageTypes.LayerIndex0Started,
LayerMoveCommand = GCodeBuilder.GCodeMoveCommands.G1,
EndGCodeMoveCommand = GCodeBuilder.GCodeMoveCommands.G1
};
}
#endregion
#region Methods
public override void Clear()
{
base.Clear();
LayersSettings.Clear();
}
protected override void EncodeInternally(OperationProgress progress)
{
float usedMaterial = MaterialMilliliters / LayerCount;
ResinMetadataSettings.Layers.Clear();
for (uint layerIndex = 0; layerIndex < LayerCount; layerIndex++)
{
ResinMetadataSettings.Layers.Add(new ResinMetadata.LayerData
{
Layer = layerIndex,
UsedMaterialVolume = usedMaterial
});
}
using var outputFile = ZipFile.Open(FileFullPath!, ZipArchiveMode.Create);
outputFile.PutFileContent("ResinMetadata", JsonSerializer.SerializeToUtf8Bytes(ResinMetadataSettings, JsonExtensions.SettingsIndent), ZipArchiveMode.Create);
outputFile.PutFileContent("UserSettingsData", JsonSerializer.SerializeToUtf8Bytes(UserSettings, JsonExtensions.SettingsIndent), ZipArchiveMode.Create);
outputFile.PutFileContent("ZCodeMetadata", JsonSerializer.SerializeToUtf8Bytes(ZCodeMetadataSettings, JsonExtensions.SettingsIndent), ZipArchiveMode.Create);
if (CreatedThumbnailsCount > 0)
{
using var stream = outputFile.CreateEntry("Preview.png").Open();
stream.WriteBytes(Thumbnails[0]!.GetPngByes());
stream.Close();
}
EncodeLayersInZip(outputFile, FolderImageName, 5, Enumerations.IndexStartNumber.Zero, progress, FolderImages);
GCode!.Clear();
float lastZPosition = 0;
for (uint layerIndex = 0; layerIndex < LayerCount; layerIndex++)
{
progress.ThrowIfCancellationRequested();
var layer = this[layerIndex];
GCode.AppendLine($"{GCodeKeywordSlice} {layerIndex}");
if (lastZPosition != layer.PositionZ)
{
if (layer.LiftHeight > 0)
{
GCode.AppendLine($"G1 Z{layer.LiftHeight} F{layer.LiftSpeed}");
GCode.AppendLine($"G1 Z-{Layer.RoundHeight(layer.LiftHeight - layer.PositionZ + lastZPosition)} F{layer.RetractSpeed}");
}
else
{
GCode.AppendLine($"G1 Z{Layer.RoundHeight(layer.PositionZ- lastZPosition)} F{layer.LiftSpeed}");
}
}
/*else
{
//GCode.AppendLine($";G1 Z{LiftHeight} F{LiftSpeed}; Already here");
//GCode.AppendLine($";G1 Z-{LiftHeight - layer.PositionZ + lastZPosition} F{RetractSpeed}; Already here");
}*/
//GCode.AppendLine($"G1 Z{LiftHeight} F{LiftSpeed}");
//GCode.AppendLine($"G1 Z-{LiftHeight - LayerHeight} F{RetractSpeed}");
GCode.AppendLine(GCodeKeywordDelayBlank);
GCode.AppendLine("M106 S255");
GCode.AppendLine(GCodeKeywordDelayModel);
GCode.AppendLine("M106 S0");
lastZPosition = layer.PositionZ;
}
GCode.AppendLine($"G1 Z40.0 F{UserSettings.ZLiftFeedRate}");
GCode.AppendLine("M18");
outputFile.PutFileContent("ResinGCodeData", GCode.ToString(), ZipArchiveMode.Create);
}
protected override void DecodeInternally(OperationProgress progress)
{
using (var inputFile = ZipFile.Open(FileFullPath!, ZipArchiveMode.Read))
{
var entry = inputFile.GetEntry("ResinMetadata");
if (entry is null)
{
Clear();
throw new FileLoadException("ResinMetadata not found", FileFullPath);
}
ResinMetadataSettings = JsonSerializer.Deserialize<ResinMetadata>(entry.Open())!;
entry = inputFile.GetEntry("UserSettingsData");
if (entry is null)
{
Clear();
throw new FileLoadException("UserSettingsData not found", FileFullPath);
}
UserSettings = JsonSerializer.Deserialize<UserSettingsdata>(entry.Open())!;
entry = inputFile.GetEntry("ZCodeMetadata");
if (entry is null)
{
Clear();
throw new FileLoadException("ZCodeMetadata not found", FileFullPath);
}
ZCodeMetadataSettings = JsonSerializer.Deserialize<ZCodeMetadata>(entry.Open())!;
entry = inputFile.GetEntry("ResinGCodeData");
if (entry is null)
{
Clear();
throw new FileLoadException("ResinGCodeData not found", FileFullPath);
}
Init(ResinMetadataSettings.TotalLayersCount, DecodeType == FileDecodeType.Partial);
DecodeLayersFromZip(inputFile, FolderImageName, Enumerations.IndexStartNumber.Zero, progress);
GCode!.Clear();
using (TextReader tr = new StreamReader(entry.Open()))
{
string? line;
int layerIndex = 0;
int layerFileIndex = 0;
string layerimagePath = null!;
float currentHeight = 0;
while ((line = tr.ReadLine()) is not null)
{
GCode.AppendLine(line);
if (line.StartsWith(GCodeKeywordSlice))
{
layerFileIndex = int.Parse(line[GCodeKeywordSlice.Length..]);
layerimagePath = $"{FolderImages}/{FolderImageName}{layerFileIndex:D5}.png";
if (LayersSettings.Count - 1 < layerIndex) LayersSettings.Add(new LayerData());
continue;
}
if (line.StartsWith(GCodeKeywordDelaySupportPart))
{
LayersSettings[layerIndex].SupportLayerFileIndex = layerFileIndex;
LayersSettings[layerIndex].SupportLayerEntry = inputFile.GetEntry(layerimagePath);
continue;
}
/*
*
<Slice> 0
G1 Z5.0 F100.0
G1 Z-4.9 F100.0
<Delay_blank>
M106 S255
<Delay_support_full>
M106 S0
*/
var gcode = GCodeStr!;
if (line.StartsWith(GCodeKeywordDelaySupportFull) || line.StartsWith(GCodeKeywordDelayModel))
{
var startStr = $"{GCodeKeywordSlice} {layerIndex}";
var stripGcode = gcode[(gcode.IndexOf(startStr, StringComparison.InvariantCultureIgnoreCase) + startStr.Length)..].Trim(' ', '\n', '\r', '\t');
float liftHeight = 0;
float liftSpeed = GetBottomOrNormalValue((uint)layerIndex, BottomLiftSpeed, LiftSpeed);
float retractSpeed = RetractSpeed;
byte pwm = GetBottomOrNormalValue((uint)layerIndex, BottomLightPWM, LightPWM); ;
//var currPos = Regex.Match(stripGcode, "G1 Z([+-]?([0-9]*[.])?[0-9]+)", RegexOptions.IgnoreCase);
var moveG1Regex = Regex.Match(stripGcode, @"G1 Z([+-]?([0-9]*[.])?[0-9]+) F(\d+)", RegexOptions.IgnoreCase);
var pwmM106Regex = Regex.Match(stripGcode, @"M106 S(\d+)", RegexOptions.IgnoreCase);
if (moveG1Regex.Success)
{
var liftHeightTemp = float.Parse(moveG1Regex.Groups[1].Value, CultureInfo.InvariantCulture);
var liftSpeedTemp = float.Parse(moveG1Regex.Groups[3].Value, CultureInfo.InvariantCulture);
moveG1Regex = moveG1Regex.NextMatch();
if (moveG1Regex.Success)
{
liftHeight = liftHeightTemp;
liftSpeed = liftSpeedTemp;
var retractHeight = float.Parse(moveG1Regex.Groups[1].Value, CultureInfo.InvariantCulture);
retractSpeed = float.Parse(moveG1Regex.Groups[3].Value, CultureInfo.InvariantCulture);
currentHeight = Layer.RoundHeight(currentHeight + liftHeightTemp + retractHeight);
}
else
{
currentHeight = Layer.RoundHeight(currentHeight + liftHeightTemp);
}
}
if (pwmM106Regex.Success)
{
pwm = byte.Parse(pwmM106Regex.Groups[1].Value);
}
LayersSettings[layerIndex].LayerFileIndex = layerFileIndex;
LayersSettings[layerIndex].LayerEntry = inputFile.GetEntry(layerimagePath);
/*if (DecodeType == FileDecodeType.Full)
{
using var stream = LayersSettings[layerIndex].LayerEntry!.Open();
this[layerIndex] = new Layer((uint)layerIndex, stream, this);
}*/
this[layerIndex].PositionZ = currentHeight;
this[layerIndex].LiftHeight = liftHeight;
this[layerIndex].LiftSpeed = liftSpeed;
this[layerIndex].RetractSpeed = retractSpeed;
this[layerIndex].LightPWM = pwm;
layerIndex++;
}
}
tr.Close();
}
entry = inputFile.GetEntry("Preview.png");
if (entry is not null)
{
using var stream = entry.Open();
CvInvoke.Imdecode(stream.ToArray(), ImreadModes.AnyColor, Thumbnails[0]);
stream.Close();
}
}
BottomRetractSpeed = RetractSpeed; // Compability
}
public override void RebuildGCode()
{
var gcode = GCodeStr!;
gcode = Regex.Replace(gcode, @"Z[+]?([0-9]*\.[0-9]+|[0-9]+) F[+]?([0-9]*\.[0-9]+|[0-9]+)",
$"Z{UserSettings.ZLiftDistance} F{UserSettings.ZLiftFeedRate}");
gcode = Regex.Replace(gcode, @"Z-[-]?([0-9]*\.[0-9]+|[0-9]+) F[+]?([0-9]*\.[0-9]+|[0-9]+)",
$"Z-{UserSettings.ZLiftDistance - LayerHeight} F{UserSettings.ZLiftRetractRate}");
GCode!.Clear();
GCode.Append(gcode);
RaisePropertyChanged(nameof(GCodeStr));
}
protected override void PartialSaveInternally(OperationProgress progress)
{
using var outputFile = ZipFile.Open(FileFullPath!, ZipArchiveMode.Update);
outputFile.PutFileContent("ResinMetadata", JsonSerializer.SerializeToUtf8Bytes(ResinMetadataSettings, JsonExtensions.SettingsIndent), ZipArchiveMode.Update);
outputFile.PutFileContent("UserSettingsData", JsonSerializer.SerializeToUtf8Bytes(UserSettings, JsonExtensions.SettingsIndent), ZipArchiveMode.Update);
outputFile.PutFileContent("ZCodeMetadata", JsonSerializer.SerializeToUtf8Bytes(ZCodeMetadataSettings, JsonExtensions.SettingsIndent), ZipArchiveMode.Update);
outputFile.PutFileContent("ResinGCodeData", GCodeStr, ZipArchiveMode.Update);
}
#endregion
}