Skip to content

armgit / Filee

Public Imported from GitHub
0

Free, open-source file converter. Convert 263 formats offline by drag & drop — images, PDF, Word, Excel, PowerPoint, HWP/HWPX, video, audio, e-books and archives. No upload, no Office needed.

Add "Trim transparent borders" for images (#332)

cre8ive-marketing32a56693d5d6
diff --git a/src/Filee.App/Assets/i18n/ar.json b/src/Filee.App/Assets/i18n/ar.json
index 7ee866f4..105438aa 100644
--- a/src/Filee.App/Assets/i18n/ar.json
+++ b/src/Filee.App/Assets/i18n/ar.json
@@ -183,6 +183,7 @@
"preset.half_size": "نصف الحجم",
"preset.grayscale": "تدرّج رمادي",
"preset.remove_background": "إزالة الخلفية",
+ "preset.trim_transparent": "قص الحواف الشفافة",
"preset.group_rotate": "تدوير",
"preset.rotate_left": "تدوير لليسار",
"preset.rotate_left.short": "يسار",
diff --git a/src/Filee.App/Assets/i18n/en.json b/src/Filee.App/Assets/i18n/en.json
index d6024c30..527d61b3 100644
--- a/src/Filee.App/Assets/i18n/en.json
+++ b/src/Filee.App/Assets/i18n/en.json
@@ -193,6 +193,7 @@
"preset.half_size": "Half size",
"preset.grayscale": "Grayscale",
"preset.remove_background": "Remove background",
+ "preset.trim_transparent": "Trim transparent borders",
"preset.group_rotate": "Rotate",
"preset.rotate_left": "Rotate left",
"preset.rotate_left.short": "Left",
diff --git a/src/Filee.App/Assets/i18n/es.json b/src/Filee.App/Assets/i18n/es.json
index 89007a3e..12c29b7e 100644
--- a/src/Filee.App/Assets/i18n/es.json
+++ b/src/Filee.App/Assets/i18n/es.json
@@ -183,6 +183,7 @@
"preset.half_size": "Reducir 50 %",
"preset.grayscale": "Grises",
"preset.remove_background": "Quitar fondo",
+ "preset.trim_transparent": "Recortar bordes transparentes",
"preset.group_rotate": "Rotar",
"preset.rotate_left": "Girar izquierda",
"preset.rotate_left.short": "Izquierda",
diff --git a/src/Filee.App/Assets/i18n/hi.json b/src/Filee.App/Assets/i18n/hi.json
index dde78607..aa618b6d 100644
--- a/src/Filee.App/Assets/i18n/hi.json
+++ b/src/Filee.App/Assets/i18n/hi.json
@@ -183,6 +183,7 @@
"preset.half_size": "आधा आकार",
"preset.grayscale": "ग्रेस्केल",
"preset.remove_background": "बैकग्राउंड हटाएँ",
+ "preset.trim_transparent": "पारदर्शी किनारे काटें",
"preset.group_rotate": "घुमाएँ",
"preset.rotate_left": "बाएँ घुमाएँ",
"preset.rotate_left.short": "बाएँ",
diff --git a/src/Filee.App/Assets/i18n/ja.json b/src/Filee.App/Assets/i18n/ja.json
index afc5f5d3..c4cc75d9 100644
--- a/src/Filee.App/Assets/i18n/ja.json
+++ b/src/Filee.App/Assets/i18n/ja.json
@@ -183,6 +183,7 @@
"preset.half_size": "縮小 50%",
"preset.grayscale": "グレースケール",
"preset.remove_background": "背景を削除",
+ "preset.trim_transparent": "透明な余白を切り取る",
"preset.group_rotate": "回転",
"preset.rotate_left": "左に回転",
"preset.rotate_left.short": "左",
diff --git a/src/Filee.App/Assets/i18n/ko.json b/src/Filee.App/Assets/i18n/ko.json
index 115bfc7e..f72ac043 100644
--- a/src/Filee.App/Assets/i18n/ko.json
+++ b/src/Filee.App/Assets/i18n/ko.json
@@ -193,6 +193,7 @@
"preset.half_size": "50% 축소",
"preset.grayscale": "흑백",
"preset.remove_background": "배경 제거",
+ "preset.trim_transparent": "투명 여백 자르기",
"preset.group_rotate": "회전",
"preset.rotate_left": "왼쪽으로 회전",
"preset.rotate_left.short": "왼쪽",
diff --git a/src/Filee.App/Assets/i18n/pl.json b/src/Filee.App/Assets/i18n/pl.json
index 2e2da36b..9f0aadfb 100644
--- a/src/Filee.App/Assets/i18n/pl.json
+++ b/src/Filee.App/Assets/i18n/pl.json
@@ -193,6 +193,7 @@
"preset.half_size": "Połowa rozmiaru",
"preset.grayscale": "Skala szarości",
"preset.remove_background": "Usuń tło",
+ "preset.trim_transparent": "Przytnij przezroczyste brzegi",
"preset.group_rotate": "Obróć",
"preset.rotate_left": "Obróć w lewo",
"preset.rotate_left.short": "W lewo",
diff --git a/src/Filee.App/Assets/i18n/pt-BR.json b/src/Filee.App/Assets/i18n/pt-BR.json
index 0b7cd7cd..4d8dafe4 100644
--- a/src/Filee.App/Assets/i18n/pt-BR.json
+++ b/src/Filee.App/Assets/i18n/pt-BR.json
@@ -193,6 +193,7 @@
"preset.half_size": "Reduzir 50%",
"preset.grayscale": "Tons de cinza",
"preset.remove_background": "Remover fundo",
+ "preset.trim_transparent": "Cortar bordas transparentes",
"preset.group_rotate": "Girar",
"preset.rotate_left": "Girar à esquerda",
"preset.rotate_left.short": "Esquerda",
diff --git a/src/Filee.App/Assets/i18n/ru.json b/src/Filee.App/Assets/i18n/ru.json
index 3eb526c7..ef2222e1 100644
--- a/src/Filee.App/Assets/i18n/ru.json
+++ b/src/Filee.App/Assets/i18n/ru.json
@@ -193,6 +193,7 @@
"preset.half_size": "Вдвое меньше",
"preset.grayscale": "Оттенки серого",
"preset.remove_background": "Убрать фон",
+ "preset.trim_transparent": "Обрезать прозрачные края",
"preset.group_rotate": "Повернуть",
"preset.rotate_left": "Повернуть влево",
"preset.rotate_left.short": "Влево",
diff --git a/src/Filee.App/Assets/i18n/zh-CN.json b/src/Filee.App/Assets/i18n/zh-CN.json
index 6247a2b0..ca82ca6c 100644
--- a/src/Filee.App/Assets/i18n/zh-CN.json
+++ b/src/Filee.App/Assets/i18n/zh-CN.json
@@ -193,6 +193,7 @@
"preset.half_size": "缩小 50%",
"preset.grayscale": "灰度",
"preset.remove_background": "去除背景",
+ "preset.trim_transparent": "裁掉透明边框",
"preset.group_rotate": "旋转",
"preset.rotate_left": "向左旋转",
"preset.rotate_left.short": "向左",
diff --git a/src/Filee.Core/Presets/BuiltInData.cs b/src/Filee.Core/Presets/BuiltInData.cs
index 4a3c96c0..11d5a54a 100644
--- a/src/Filee.Core/Presets/BuiltInData.cs
+++ b/src/Filee.Core/Presets/BuiltInData.cs
@@ -43,6 +43,7 @@ public static class BuiltInData
Id = "remove-background", NameKey = "preset.remove_background", TargetFormat = "png",
Image = { RemoveBackground = true }, Output = { FileNamePattern = "{name}_transparent" },
},
+ .. TrimPresets(),
new()
{
Id = "tool-crop", NameKey = "preset.crop", TargetFormat = SameAsSource,
@@ -111,6 +112,19 @@ public static class BuiltInData
new() { Id = "motion-photo-android", NameKey = "preset.motion_photo_android", TargetFormat = "jpg", Media = { LivePhoto = LivePhotoKind.Android } },
];
+ /// <summary>
+ /// "Trim transparent borders" (issue #332, added in settings schema 33): a copy cropped to the visible pixels, in the
+ /// same format. On the images donut's back face after "Remove background".
+ /// </summary>
+ public static List<Preset> TrimPresets() =>
+ [
+ new()
+ {
+ Id = "trim-transparent", NameKey = "preset.trim_transparent", TargetFormat = SameAsSource,
+ Image = { TrimTransparent = true }, Output = { FileNamePattern = "{name}_trimmed" },
+ },
+ ];
+
/// <summary>
/// "Compress PDF": pictures at 150 dpi, the rest compressed losslessly (added in settings schema 20). On no default
/// donut, the PDF donut is full: users add it in Settings → Toolbar.
@@ -363,7 +377,8 @@ public static class BuiltInData
Id = "images", NameKey = "profile.images",
Extensions = ExtensionsOf(FormatCategory.Image),
PresetIds = ["to-png", "to-jpg", "to-webp", "to-pdf", "trace-svg", "trace-line-art", "to-tiff", "to-bmp", "to-ico", "half-size"],
- BackPresetIds = ["tool-crop", "rotate", "flip", "remove-background", "grayscale", "extract-motion", "to-avif", "to-gif", "merge-pdf", "zip-all"],
+ BackPresetIds = ["tool-crop", "rotate", "flip", "remove-background", "trim-transparent", "grayscale", "extract-motion", "to-avif", "to-gif",
+ "merge-pdf", "zip-all"],
},
new()
{
diff --git a/src/Filee.Core/Presets/Preset.cs b/src/Filee.Core/Presets/Preset.cs
index ed631510..cae156fc 100644
--- a/src/Filee.Core/Presets/Preset.cs
+++ b/src/Filee.Core/Presets/Preset.cs
@@ -276,6 +276,12 @@ public sealed class ImageOptions
/// <summary>Convert to grayscale.</summary>
public bool Grayscale { get; set; }
+ /// <summary>
+ /// Crop away the fully transparent padding around a picture's visible pixels (PNGs exported with a margin, sprites,
+ /// icons). Pictures without transparency, and animations, stay as they are.
+ /// </summary>
+ public bool TrimTransparent { get; set; }
+
/// <summary>
/// Make a plain background (paper behind a signature or stamp, the backdrop of a logo) transparent. Targets without
/// an alpha channel get <see cref="Background"/> instead, so this also replaces the backdrop colour.
diff --git a/src/Filee.Core/Settings/UserDataStore.cs b/src/Filee.Core/Settings/UserDataStore.cs
index b390b330..faad6cfe 100644
--- a/src/Filee.Core/Settings/UserDataStore.cs
+++ b/src/Filee.Core/Settings/UserDataStore.cs
@@ -750,10 +750,28 @@ internal static class SettingsMigrations
// v32: logs and script source, Video CD DAT and Workbench archives learn their donuts; custom claims stay put.
if (from < 32)
changed |= LearnExtensions(profiles, out _, ["log", "py", "pac", "bat", "command", "dat", "wbpz"]);
- // v33: HAR network logs (read as JSON) and raw H.265 / H.264 camera streams learn their donuts; custom claims
- // stay put.
+ // v33: HAR network logs and raw H.265 / H.264 camera streams learn their donuts (custom claims stay put), and
+ // "Trim transparent borders" comes in after "Remove background".
if (from < 33)
+ {
changed |= LearnExtensions(profiles, out _, ["har", "h265", "265", "hevc", "h264", "264"]);
+ // "Trim transparent borders" after "Remove background", in the library and on the images donut's back face
+ // when it has room and the user hasn't put it there.
+ if (BuiltInData.TrimPresets().Single() is var trim && presets.All(p => p.Id != trim.Id))
+ {
+ var at = presets.FindIndex(p => p.Id == "remove-background");
+ presets.Insert(at < 0 ? presets.Count : at + 1, trim);
+ changed = true;
+ }
+ if (profiles.FirstOrDefault(p => p.Id == "images") is { BackPresetIds: { } back } images
+ && !back.Contains("trim-transparent") && !images.PresetIds.Contains("trim-transparent")
+ && back.Count < ToolbarProfile.MaxSlices)
+ {
+ var after = back.IndexOf("remove-background");
+ back.Insert(after < 0 ? back.Count(id => id != "zip-all") : after + 1, "trim-transparent");
+ changed = true;
+ }
+ }
return changed;
}
diff --git a/src/Filee.Engines/Magick/ImageEncoder.cs b/src/Filee.Engines/Magick/ImageEncoder.cs
index 1679e1a9..6d844214 100644
--- a/src/Filee.Engines/Magick/ImageEncoder.cs
+++ b/src/Filee.Engines/Magick/ImageEncoder.cs
@@ -225,6 +225,36 @@ internal static class ImageEncoder
image.Flip();
}
+ /// <summary>
+ /// Crops <paramref name="image"/> to the box around its pixels that aren't fully transparent (issue #332). Unlike
+ /// ImageMagick's Trim, which trims whatever colour the corners have, only transparency counts: a picture whose content
+ /// touches a corner keeps its solid border. Nothing changes without transparency, or when every pixel is transparent.
+ /// </summary>
+ public static void TrimTransparentBorders(IMagickImage<byte> image)
+ {
+ if (!image.HasAlpha)
+ return;
+ int width = (int)image.Width, height = (int)image.Height;
+ var rgba = image.GetPixels().ToByteArray(PixelMapping.RGBA)!;
+ int left = width, top = height, right = -1, bottom = -1;
+ for (var y = 0; y < height; y++)
+ {
+ for (var x = 0; x < width; x++)
+ {
+ if (rgba[(y * width + x) * 4 + 3] == 0)
+ continue;
+ left = Math.Min(left, x);
+ right = Math.Max(right, x);
+ top = Math.Min(top, y);
+ bottom = Math.Max(bottom, y);
+ }
+ }
+ if (right < 0 || (left == 0 && top == 0 && right == width - 1 && bottom == height - 1))
+ return;
+ image.Crop(new MagickGeometry(left, top, (uint)(right - left + 1), (uint)(bottom - top + 1)));
+ image.ResetPage();
+ }
+
/// <summary>Applies resize / colour / metadata options to one frame.</summary>
public static void ApplyOptions(IMagickImage<byte> image, ImageOptions options, string targetFormat)
{
diff --git a/src/Filee.Engines/Magick/MagickImageConverter.cs b/src/Filee.Engines/Magick/MagickImageConverter.cs
index 2623b59a..48d2f20f 100644
--- a/src/Filee.Engines/Magick/MagickImageConverter.cs
+++ b/src/Filee.Engines/Magick/MagickImageConverter.cs
@@ -95,6 +95,9 @@ public sealed class MagickImageConverter : IConverter, ITiffMerger, IImageTransf
{
cancellationToken.ThrowIfCancellationRequested();
ImageEncoder.ApplyOptions(frame, step.Preset.Image, step.To);
+ // shortcut: animations aren't trimmed (each frame alone would shift), trim all frames to one box when asked.
+ if (step.Preset.Image.TrimTransparent && !(animation && frames.Count > 1))
+ ImageEncoder.TrimTransparentBorders(frame);
}
progress?.Report(0.7);
diff --git a/tests/Filee.Core.Tests/NewExtensionsTests.cs b/tests/Filee.Core.Tests/NewExtensionsTests.cs
index 2fee3afc..a1a3b0c3 100644
--- a/tests/Filee.Core.Tests/NewExtensionsTests.cs
+++ b/tests/Filee.Core.Tests/NewExtensionsTests.cs
@@ -2,6 +2,7 @@
// streams (issue #301).
using Filee.Core.Formats;
+using Filee.Core.Presets;
using Filee.Core.Profiles;
using Filee.Core.Settings;
@@ -54,4 +55,20 @@ public class NewExtensionsTests
Assert.DoesNotContain("h264", video); // the user's own donut has it
Assert.Equal(AppSettings.CurrentSchemaVersion, upgraded.Settings.SchemaVersion);
}
+
+ [Fact]
+ public void Version_32_libraries_get_trim_transparent_borders_after_remove_background()
+ {
+ var presets = BuiltInData.CreatePresets().Where(p => p.Id != "trim-transparent").ToList();
+ var profiles = BuiltInData.CreateProfiles();
+ var back = profiles.Single(p => p.Id == "images").BackPresetIds!;
+ back.Remove("trim-transparent");
+
+ Assert.True(SettingsMigrations.ApplyToLibrary(32, presets, profiles));
+
+ Assert.Equal("trim-transparent", presets[presets.FindIndex(p => p.Id == "remove-background") + 1].Id);
+ Assert.Equal("trim-transparent", back[back.IndexOf("remove-background") + 1]);
+ Assert.Equal(BuiltInData.CreateProfiles().Single(p => p.Id == "images").BackPresetIds, back);
+ Assert.False(SettingsMigrations.ApplyToLibrary(32, presets, profiles)); // once only
+ }
}
diff --git a/tests/Filee.Engines.Tests/TrimTransparentTests.cs b/tests/Filee.Engines.Tests/TrimTransparentTests.cs
new file mode 100644
index 00000000..f264fe17
--- /dev/null
+++ b/tests/Filee.Engines.Tests/TrimTransparentTests.cs
@@ -0,0 +1,92 @@
+// "Trim transparent borders" (issue #332): a copy cropped to the visible pixels, run through the real image engine.
+
+using Filee.Core.Conversion;
+using Filee.Core.Presets;
+using ImageMagick;
+
+namespace Filee.Engines.Tests;
+
+public class TrimTransparentTests(EngineFixture fx) : IClassFixture<EngineFixture>
+{
+ private static Preset Trim => BuiltInData.CreatePresets().Single(p => p.Id == "trim-transparent");
+
+ private async Task<string> RunAsync(string input)
+ {
+ var job = await fx.ConvertAsync([input], Trim);
+ Assert.True(job.State == JobState.Completed, string.Join("; ", job.Files.Select(f => $"{f.ErrorKey} {f.ErrorDetail}")));
+ return Assert.Single(job.Outputs);
+ }
+
+ /// <summary>A transparent <paramref name="width"/> × <paramref name="height"/> picture with an opaque box.</summary>
+ private static string MakePicture(string folder, string name, MagickFormat format, uint width, uint height, int x, int y, uint w, uint h)
+ {
+ using var image = new MagickImage(MagickColors.Transparent, width, height);
+ image.Draw(new ImageMagick.Drawing.Drawables().FillColor(MagickColors.Coral).Rectangle(x, y, x + w - 1, y + h - 1));
+ var path = Path.Combine(folder, name);
+ image.Write(path, format);
+ return path;
+ }
+
+ [Theory]
+ [InlineData("logo.png", MagickFormat.Png)]
+ [InlineData("logo.webp", MagickFormat.WebP)]
+ public async Task The_transparent_padding_goes_and_the_format_stays(string name, MagickFormat format)
+ {
+ var folder = fx.NewFolder();
+ var source = MakePicture(folder, name, format, 200, 150, 30, 20, 50, 40);
+
+ var output = await RunAsync(source);
+
+ Assert.Equal(Path.Combine(folder, Path.GetFileNameWithoutExtension(name) + "_trimmed" + Path.GetExtension(name)), output);
+ using var trimmed = new MagickImage(output);
+ Assert.Equal((50u, 40u), (trimmed.Width, trimmed.Height));
+ Assert.Equal((0, 0), (trimmed.Page.X, trimmed.Page.Y)); // no leftover offset
+ Assert.True(File.Exists(source)); // the source is never overwritten
+ }
+
+ [Fact]
+ public async Task Content_touching_a_corner_keeps_what_isnt_transparent()
+ {
+ // ImageMagick's own Trim would treat the coral corner as the border colour and cut the coral away.
+ var folder = fx.NewFolder();
+ var source = MakePicture(folder, "corner.png", MagickFormat.Png, 120, 80, 0, 0, 60, 30);
+
+ using var trimmed = new MagickImage(await RunAsync(source));
+
+ Assert.Equal((60u, 30u), (trimmed.Width, trimmed.Height));
+ }
+
+ [Fact]
+ public async Task An_animation_keeps_its_frames_aligned()
+ {
+ var folder = fx.NewFolder();
+ var path = Path.Combine(folder, "spinner.gif");
+ using (var frames = new MagickImageCollection())
+ {
+ foreach (var x in new[] { 10, 60 })
+ {
+ var frame = new MagickImage(MagickColors.Transparent, 100, 50) { AnimationDelay = 20 };
+ frame.Draw(new ImageMagick.Drawing.Drawables().FillColor(MagickColors.Coral).Rectangle(x, 10, x + 20, 30));
+ frames.Add(frame);
+ }
+ frames.Write(path, MagickFormat.Gif);
+ }
+
+ using var output = new MagickImageCollection(await RunAsync(path));
+
+ Assert.Equal(2, output.Count);
+ Assert.All(output, f => Assert.Equal((100u, 50u), (f.Page.Width, f.Page.Height)));
+ }
+
+ [Fact]
+ public void A_picture_without_transparency_or_fully_transparent_is_left_alone()
+ {
+ using var opaque = new MagickImage(MagickColors.Teal, 40, 30);
+ Filee.Engines.Magick.ImageEncoder.TrimTransparentBorders(opaque);
+ Assert.Equal((40u, 30u), (opaque.Width, opaque.Height));
+
+ using var empty = new MagickImage(MagickColors.Transparent, 40, 30);
+ Filee.Engines.Magick.ImageEncoder.TrimTransparentBorders(empty);
+ Assert.Equal((40u, 30u), (empty.Width, empty.Height));
+ }
+}