Files
UVtools/UVtools.Core/FileFormats/UVJFile.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

575 lines
19 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.ComponentModel;
using System.IO;
using System.IO.Compression;
using System.Text.Json;
using UVtools.Core.Extensions;
using UVtools.Core.Layers;
using UVtools.Core.Operations;
namespace UVtools.Core.FileFormats;
public class UVJFile : FileFormat
{
#region Constants
private const string FileConfigName = "config.json";
private const string FolderImageName = "slice";
private const string FolderPreviewName = "preview";
private const string FilePreviewHugeName = "preview/huge.png";
private const string FilePreviewTinyName = "preview/tiny.png";
#endregion
#region Sub Classes
public class Millimeter
{
public float X { get; set; }
public float Y { get; set; }
}
public class Size
{
public ushort X { get; set; }
public ushort Y { get; set; }
public Millimeter Millimeter { get; set; } = new();
public uint Layers { get; set; }
public float LayerHeight { get; set; }
public override string ToString()
{
return $"{nameof(X)}: {X}, {nameof(Y)}: {Y}, {nameof(Millimeter)}: {Millimeter}, {nameof(Layers)}: {Layers}, {nameof(LayerHeight)}: {LayerHeight}";
}
}
public class Exposure
{
public float LightOnTime { get; set; }
public float LightOffTime { get; set; }
public byte LightPWM { get; set; } = DefaultLightPWM;
public float LiftHeight { get; set; } = DefaultLiftHeight;
public float LiftSpeed { get; set; } = DefaultLiftSpeed;
public float LiftHeight2 { get; set; } = DefaultLiftHeight2;
public float LiftSpeed2 { get; set; } = DefaultLiftSpeed2;
public float RetractHeight { get; set; }
public float RetractSpeed { get; set; } = DefaultRetractSpeed;
public float RetractHeight2 { get; set; }
public float RetractSpeed2 { get; set; } = DefaultRetractSpeed2;
public override string ToString()
{
return $"{nameof(LightOnTime)}: {LightOnTime}, {nameof(LightOffTime)}: {LightOffTime}, {nameof(LightPWM)}: {LightPWM}, {nameof(LiftHeight)}: {LiftHeight}, {nameof(LiftSpeed)}: {LiftSpeed}, {nameof(LiftHeight2)}: {LiftHeight2}, {nameof(LiftSpeed2)}: {LiftSpeed2}, {nameof(RetractHeight)}: {RetractHeight}, {nameof(RetractSpeed)}: {RetractSpeed}, {nameof(RetractHeight2)}: {RetractHeight2}, {nameof(RetractSpeed2)}: {RetractSpeed2}";
}
}
public class Bottom
{
public float LightOffTime { get; set; }
public float LightOnTime { get; set; }
public byte LightPWM { get; set; } = DefaultBottomLightPWM;
public float LiftHeight { get; set; } = DefaultBottomLiftHeight;
public float LiftSpeed { get; set; } = DefaultBottomLiftSpeed;
public float LiftHeight2 { get; set; } = DefaultBottomLiftHeight2;
public float LiftSpeed2 { get; set; } = DefaultBottomLiftSpeed2;
public float RetractHeight { get; set; }
public float RetractSpeed { get; set; } = DefaultBottomRetractSpeed;
public float RetractHeight2 { get; set; }
public float RetractSpeed2 { get; set; } = DefaultBottomRetractSpeed2;
public ushort Count { get; set; }
public override string ToString()
{
return $"{nameof(LightOffTime)}: {LightOffTime}, {nameof(LightOnTime)}: {LightOnTime}, {nameof(LightPWM)}: {LightPWM}, {nameof(LiftHeight)}: {LiftHeight}, {nameof(LiftSpeed)}: {LiftSpeed}, {nameof(LiftHeight2)}: {LiftHeight2}, {nameof(LiftSpeed2)}: {LiftSpeed2}, {nameof(RetractHeight)}: {RetractHeight}, {nameof(RetractSpeed)}: {RetractSpeed}, {nameof(RetractHeight2)}: {RetractHeight2}, {nameof(RetractSpeed2)}: {RetractSpeed2}, {nameof(Count)}: {Count}";
}
}
public class LayerDef
{
public float Z { get; set; }
public Exposure Exposure { get; set; } = new();
public LayerDef() { }
public LayerDef(Layer layer)
{
SetFrom(layer);
}
public override string ToString()
{
return $"{nameof(Z)}: {Z}, {nameof(Exposure)}: {Exposure}";
}
public void SetFrom(Layer layer)
{
Z = layer.PositionZ;
Exposure.LightOffTime = layer.LightOffDelay;
Exposure.LightOnTime = layer.ExposureTime;
Exposure.LiftHeight = layer.LiftHeight;
Exposure.LiftSpeed = layer.LiftSpeed;
Exposure.LiftHeight2 = layer.LiftHeight2;
Exposure.LiftSpeed2 = layer.LiftSpeed2;
Exposure.RetractHeight = layer.RetractHeight;
Exposure.RetractSpeed = layer.RetractSpeed;
Exposure.RetractHeight2 = layer.RetractHeight2;
Exposure.RetractSpeed2 = layer.RetractSpeed2;
Exposure.LightPWM = layer.LightPWM;
}
public void CopyTo(Layer layer)
{
layer.PositionZ = Z;
layer.LightOffDelay = Exposure.LightOffTime;
layer.ExposureTime = Exposure.LightOnTime;
layer.LiftHeight = Exposure.LiftHeight;
layer.LiftSpeed = Exposure.LiftSpeed;
layer.LiftHeight2 = Exposure.LiftHeight2;
layer.LiftSpeed2 = Exposure.LiftSpeed2;
layer.RetractSpeed = Exposure.RetractSpeed;
layer.RetractHeight2 = Exposure.RetractHeight2;
layer.RetractSpeed2 = Exposure.RetractSpeed2;
layer.LightPWM = Exposure.LightPWM;
}
}
public class Properties
{
public Size Size { get; set; } = new ();
public Exposure Exposure { get; set; } = new ();
public Bottom Bottom { get; set; } = new ();
public byte AntiAliasLevel { get; set; } = 1;
public override string ToString()
{
return $"{nameof(Size)}: {Size}, {nameof(Exposure)}: {Exposure}, {nameof(Bottom)}: {Bottom}, {nameof(AntiAliasLevel)}: {AntiAliasLevel}";
}
}
public class Settings
{
public Properties Properties { get; set; } = new();
public List<LayerDef>? Layers { get; set; } = new();
public override string ToString()
{
return $"{nameof(Properties)}: {Properties}, {nameof(Layers)}: {Layers?.Count}";
}
}
#endregion
#region Properties
public Settings JsonSettings { get; set; } = new();
public override FileFormatType FileType => FileFormatType.Archive;
public override FileExtension[] FileExtensions { get; } = {
new(typeof(UVJFile), "uvj", "UVJ")
};
public override PrintParameterModifier[]? PrintParameterModifiers { get; } = {
PrintParameterModifier.BottomLayerCount,
PrintParameterModifier.BottomLightOffDelay,
PrintParameterModifier.LightOffDelay,
PrintParameterModifier.BottomExposureTime,
PrintParameterModifier.ExposureTime,
PrintParameterModifier.BottomLiftHeight,
PrintParameterModifier.BottomLiftSpeed,
PrintParameterModifier.LiftHeight,
PrintParameterModifier.LiftSpeed,
PrintParameterModifier.BottomLiftHeight2,
PrintParameterModifier.BottomLiftSpeed2,
PrintParameterModifier.LiftHeight2,
PrintParameterModifier.LiftSpeed2,
PrintParameterModifier.BottomRetractSpeed,
PrintParameterModifier.RetractSpeed,
PrintParameterModifier.BottomRetractHeight2,
PrintParameterModifier.RetractHeight2,
PrintParameterModifier.BottomRetractSpeed2,
PrintParameterModifier.RetractSpeed2,
PrintParameterModifier.BottomLightPWM,
PrintParameterModifier.LightPWM,
};
public override PrintParameterModifier[]? PrintParameterPerLayerModifiers { get; } = {
PrintParameterModifier.PositionZ,
PrintParameterModifier.LightOffDelay,
PrintParameterModifier.ExposureTime,
PrintParameterModifier.LiftHeight,
PrintParameterModifier.LiftSpeed,
PrintParameterModifier.LiftHeight2,
PrintParameterModifier.LiftSpeed2,
PrintParameterModifier.RetractSpeed,
PrintParameterModifier.RetractHeight2,
PrintParameterModifier.RetractSpeed2,
PrintParameterModifier.BottomLightPWM,
PrintParameterModifier.LightPWM,
};
public override System.Drawing.Size[]? ThumbnailsOriginalSize { get; } =
{
new(400, 400),
new(800, 480)
};
public override uint ResolutionX
{
get => JsonSettings.Properties.Size.X;
set
{
JsonSettings.Properties.Size.X = (ushort) value;
RaisePropertyChanged();
}
}
public override uint ResolutionY
{
get => JsonSettings.Properties.Size.Y;
set
{
JsonSettings.Properties.Size.Y = (ushort) value;
RaisePropertyChanged();
}
}
public override float DisplayWidth
{
get => JsonSettings.Properties.Size.Millimeter.X;
set
{
JsonSettings.Properties.Size.Millimeter.X = (float) Math.Round(value, 2);
RaisePropertyChanged();
}
}
public override float DisplayHeight
{
get => JsonSettings.Properties.Size.Millimeter.Y;
set
{
JsonSettings.Properties.Size.Millimeter.Y = (float)Math.Round(value, 2);
RaisePropertyChanged();
}
}
public override Enumerations.FlipDirection DisplayMirror { get; set; }
public override byte AntiAliasing
{
get => JsonSettings.Properties.AntiAliasLevel;
set => base.AntiAliasing = JsonSettings.Properties.AntiAliasLevel = value.Clamp(1, 16);
}
public override float LayerHeight
{
get => JsonSettings.Properties.Size.LayerHeight;
set
{
JsonSettings.Properties.Size.LayerHeight = Layer.RoundHeight(value);
RaisePropertyChanged();
}
}
public override uint LayerCount
{
get => base.LayerCount;
set => base.LayerCount = JsonSettings.Properties.Size.Layers = base.LayerCount;
}
public override ushort BottomLayerCount
{
get => JsonSettings.Properties.Bottom.Count;
set => base.BottomLayerCount = JsonSettings.Properties.Bottom.Count = value;
}
public override float BottomLightOffDelay
{
get => JsonSettings.Properties.Bottom.LightOffTime;
set => base.BottomLightOffDelay = JsonSettings.Properties.Bottom.LightOffTime = (float)Math.Round(value, 2);
}
public override float LightOffDelay
{
get => JsonSettings.Properties.Exposure.LightOffTime;
set => base.LightOffDelay = JsonSettings.Properties.Exposure.LightOffTime = (float)Math.Round(value, 2);
}
public override float BottomWaitTimeBeforeCure
{
get => base.BottomWaitTimeBeforeCure;
set
{
SetBottomLightOffDelay(value);
base.BottomWaitTimeBeforeCure = value;
}
}
public override float WaitTimeBeforeCure
{
get => base.WaitTimeBeforeCure;
set
{
SetNormalLightOffDelay(value);
base.WaitTimeBeforeCure = value;
}
}
public override float BottomExposureTime
{
get => JsonSettings.Properties.Bottom.LightOnTime;
set => base.BottomExposureTime = JsonSettings.Properties.Bottom.LightOnTime = (float)Math.Round(value, 2);
}
public override float ExposureTime
{
get => JsonSettings.Properties.Exposure.LightOnTime;
set => base.ExposureTime = JsonSettings.Properties.Exposure.LightOnTime = (float)Math.Round(value, 2);
}
public override float BottomLiftHeight
{
get => JsonSettings.Properties.Bottom.LiftHeight;
set => base.BottomLiftHeight = JsonSettings.Properties.Bottom.LiftHeight = (float)Math.Round(value, 2);
}
public override float BottomLiftSpeed
{
get => JsonSettings.Properties.Bottom.LiftSpeed;
set => base.BottomLiftSpeed = JsonSettings.Properties.Bottom.LiftSpeed = (float)Math.Round(value, 2);
}
public override float LiftHeight
{
get => JsonSettings.Properties.Exposure.LiftHeight;
set => base.LiftHeight = JsonSettings.Properties.Exposure.LiftHeight = (float)Math.Round(value, 2);
}
public override float LiftSpeed
{
get => JsonSettings.Properties.Exposure.LiftSpeed;
set => base.LiftSpeed = JsonSettings.Properties.Exposure.LiftSpeed = (float)Math.Round(value, 2);
}
public override float BottomLiftHeight2
{
get => JsonSettings.Properties.Bottom.LiftHeight2;
set => base.BottomLiftHeight2 = JsonSettings.Properties.Bottom.LiftHeight2 = (float)Math.Round(value, 2);
}
public override float BottomLiftSpeed2
{
get => JsonSettings.Properties.Bottom.LiftSpeed2;
set => base.BottomLiftSpeed2 = JsonSettings.Properties.Bottom.LiftSpeed2 = (float)Math.Round(value, 2);
}
public override float LiftHeight2
{
get => JsonSettings.Properties.Exposure.LiftHeight2;
set => base.LiftHeight2 = JsonSettings.Properties.Exposure.LiftHeight2 = (float)Math.Round(value, 2);
}
public override float LiftSpeed2
{
get => JsonSettings.Properties.Exposure.LiftSpeed2;
set => base.LiftSpeed2 = JsonSettings.Properties.Exposure.LiftSpeed2 = (float)Math.Round(value, 2);
}
public override float BottomRetractSpeed
{
get => JsonSettings.Properties.Bottom.RetractSpeed;
set => base.BottomRetractSpeed = JsonSettings.Properties.Bottom.RetractSpeed = (float)Math.Round(value, 2);
}
public override float RetractSpeed
{
get => JsonSettings.Properties.Exposure.RetractSpeed;
set => base.RetractSpeed = JsonSettings.Properties.Exposure.RetractSpeed = (float)Math.Round(value, 2);
}
public override float BottomRetractHeight2
{
get => JsonSettings.Properties.Bottom.RetractHeight2;
set => base.BottomRetractHeight2 = JsonSettings.Properties.Bottom.RetractHeight2 = (float)Math.Round(value, 2);
}
public override float BottomRetractSpeed2
{
get => JsonSettings.Properties.Bottom.RetractSpeed2;
set => base.BottomRetractSpeed2 = JsonSettings.Properties.Bottom.RetractSpeed2 = (float)Math.Round(value, 2);
}
public override float RetractHeight2
{
get => JsonSettings.Properties.Exposure.RetractHeight2;
set => base.RetractHeight2 = JsonSettings.Properties.Exposure.RetractHeight2 = (float)Math.Round(value, 2);
}
public override float RetractSpeed2
{
get => JsonSettings.Properties.Exposure.RetractSpeed2;
set => base.RetractSpeed2 = JsonSettings.Properties.Exposure.RetractSpeed2 = (float)Math.Round(value, 2);
}
public override byte BottomLightPWM
{
get => JsonSettings.Properties.Bottom.LightPWM;
set => base.BottomLightPWM = JsonSettings.Properties.Bottom.LightPWM = value;
}
public override byte LightPWM
{
get => JsonSettings.Properties.Exposure.LightPWM;
set => base.LightPWM = JsonSettings.Properties.Exposure.LightPWM = value;
}
public override object[] Configs => new[] {(object) JsonSettings.Properties.Size, JsonSettings.Properties.Size.Millimeter, JsonSettings.Properties.Bottom, JsonSettings.Properties.Exposure};
#endregion
#region Methods
protected override void OnPropertyChanged(PropertyChangedEventArgs e)
{
if (e.PropertyName == nameof(BottomRetractHeight)) JsonSettings.Properties.Bottom.RetractHeight = BottomRetractHeight;
else if (e.PropertyName == nameof(RetractHeight)) JsonSettings.Properties.Exposure.RetractHeight = RetractHeight;
base.OnPropertyChanged(e);
}
public override void Clear()
{
base.Clear();
JsonSettings.Layers = new List<LayerDef>();
}
protected override void EncodeInternally(OperationProgress progress)
{
// Redo layer data
if (JsonSettings.Layers is null)
{
JsonSettings.Layers = new List<LayerDef>();
}
else
{
JsonSettings.Layers.Clear();
}
for (uint layerIndex = 0; layerIndex < LayerCount; layerIndex++)
{
JsonSettings.Layers.Add(new LayerDef(this[layerIndex]));
}
using var outputFile = ZipFile.Open(FileFullPath!, ZipArchiveMode.Create);
outputFile.PutFileContent(FileConfigName, JsonSerializer.SerializeToUtf8Bytes(JsonSettings, JsonExtensions.SettingsIndent), ZipArchiveMode.Create);
if (CreatedThumbnailsCount > 0)
{
using var stream = outputFile.CreateEntry(FilePreviewTinyName).Open();
stream.WriteBytes(Thumbnails[0]!.GetPngByes());
stream.Close();
}
if (CreatedThumbnailsCount > 1)
{
using var stream = outputFile.CreateEntry(FilePreviewHugeName).Open();
stream.WriteBytes(Thumbnails[1]!.GetPngByes());
stream.Close();
}
EncodeLayersInZip(outputFile, 8, Enumerations.IndexStartNumber.Zero, progress, FolderImageName);
}
protected override void DecodeInternally(OperationProgress progress)
{
using var inputFile = ZipFile.Open(FileFullPath!, ZipArchiveMode.Read);
var entry = inputFile.GetEntry(FileConfigName);
if (entry is null)
{
Clear();
throw new FileLoadException($"{FileConfigName} not found", FileFullPath);
}
JsonSettings = JsonSerializer.Deserialize<Settings>(entry.Open())!;
Init(JsonSettings.Properties.Size.Layers, DecodeType == FileDecodeType.Partial);
entry = inputFile.GetEntry(FilePreviewTinyName);
if (entry is not null)
{
using var stream = entry.Open();
Mat image = new();
CvInvoke.Imdecode(stream.ToArray(), ImreadModes.AnyColor, image);
Thumbnails[0] = image;
stream.Close();
}
entry = inputFile.GetEntry(FilePreviewHugeName);
if (entry is not null)
{
using var stream = entry.Open();
Mat image = new();
CvInvoke.Imdecode(stream.ToArray(), ImreadModes.AnyColor, image);
Thumbnails[1] = image;
stream.Close();
}
DecodeLayersFromZip(inputFile, progress);
for (uint layerIndex = 0; layerIndex < LayerCount; layerIndex++)
{
if (JsonSettings.Layers?.Count > layerIndex)
{
JsonSettings.Layers[(int)layerIndex].CopyTo(this[layerIndex]);
}
}
}
protected override void PartialSaveInternally(OperationProgress progress)
{
if (JsonSettings.Layers is null)
{
JsonSettings.Layers = new List<LayerDef>();
}
else
{
JsonSettings.Layers.Clear();
}
for (uint layerIndex = 0; layerIndex < LayerCount; layerIndex++)
{
JsonSettings.Layers.Add(new LayerDef(this[layerIndex]));
}
using var outputFile = ZipFile.Open(FileFullPath!, ZipArchiveMode.Update);
outputFile.PutFileContent(FileConfigName, JsonSerializer.SerializeToUtf8Bytes(JsonSettings, JsonExtensions.SettingsIndent), ZipArchiveMode.Update);
//Decode(FileFullPath, progress);
}
#endregion
}