CommonImageActions.Pdf 1.0.9

Common Image Actions

Summary

A tuned image conversion library to add common image actions like resize and mask to your .Net and Asp.net core projects. This library is highly performant both in execution time and in memory use since it extends Microsoft libraries. This library should continue to increase in performance as Microsoft further improves their libraries.

Features

✅ Resize images
✅ Convert images to be circle or rounded rectangle
✅ PDF support
✅ Fast and memory efficient
✅ Create user profile placeholders where background auto changes based on name <img src="https://raw.githubusercontent.com/dustout/CommonImageActions/master/CommonImageActions.SampleAspnetCoreProject/wwwroot/test/ProfilePictureStrip.png" alt="Example of user profile placeholders" style="height: 18px;">
✅ Resize through url in asp.net core (.jpg?w=50&m=zoom)
✅ Works with any project that supports .net standard
✅ Fluent interface

Getting Started (Asp.Net Core)

Install the NuGet Package

    Install-Package CommonImageActions.AspNetCore

Add UseCommonImageActions Middleware

Add the middleware to your startup file. Make sure that it is above app.UseStaticFiles(). The default implementation will watch for all supported image files based on the file extension.

app.UseCommonImageActions();

You can watch a specific directory by setting the PathToWatch property in the CommonImageActionSettings object.

app.UseCommonImageActions(
    new CommonImageActionSettings()
    {
        PathToWatch = "/test",
    }
);

Getting Started

Install the NuGet Package

    Install-Package CommonImageActions.Core

Pass image bytes to the ImageProcessor.Process

Get the image bytes[] and pass those bytes to the ImageProcessor.Process function

byte[] testJpg = File.ReadAllBytes("test.jpg");
var result = await ImageProcessor.Process(testJpg)
               .Width(100)
               .Height(100)
               .Mode(ImageMode.Zoom)
               .Shape(ImageShape.Circle)
               .ToImageAsync();

Code Examples (Asp.net core)

Watch all images in all directories

app.UseCommonImageActions()

Set all images to be 50x50 png images for the /logos directory

app.UseCommonImageActions(
    new CommonImageActionSettings()
    {
        PathToWatch = "/logos",
        DefaultImageActions = new CommonImageActions.Core.ImageActions()
        {
            Height = 50,
            Width = 50,
            Format = SkiaSharp.SKEncodedImageFormat.Png
        }
    }
);

Generate user placeholders and cache the response to the disk

//the ChooseImageColorFromTextValue ensures that the following will have a different background color
//https://localhost:44302/profilepicture/profile.png?t=DustinGa
//https://localhost:44302/profilepicture/profile.png?t=DustinG
app.UseCommonImageActions(
    new CommonImageActionSettings()
    {
        PathToWatch = "/profilepicture",
        IsVirtual = true,
        UseDiskCache = true,
        DefaultImageActions = new ImageActions()
        {
            Height = 50,
            Width = 50,
            Format = SkiaSharp.SKEncodedImageFormat.Png,
            Shape = ImageShape.Circle,
            AsInitials = true,
            ChooseImageColorFromTextValue = true
        }
    }
);

Add to Asp.net Core and route to an external blob storage

Like AzureBlob or Amazon S3 or any other remote server

app.UseCommonImageActions(
    new CommonImageActionSettings()
    {
        PathToWatch = "/remote",
        RemoteFileServerUrl = "https://dustingamester.com/img/"
    }
);

Code Examples

Process an image using the fluent API

byte[] testJpg = File.ReadAllBytes("test.jpg");
var result = await ImageProcessor.Process(testJpg)
               .Width(100)
               .Height(100)
               .Mode(ImageMode.Zoom)
               .Shape(ImageShape.Circle)
               .ToImageAsync();

Process a pdf using the fluent API

byte[] testPdf = File.ReadAllBytes("test.pdf");
var result = await PdfProcessor.Process(testPdf)
               .Width(100)
               .Height(100)
               .Mode(ImageMode.Zoom)
               .Shape(ImageShape.Circle)
               .ToImageAsync();

URL Parameters (Asp.net Core)

Modes Visualized

CommonImageActionSettings (Asp.net Core)

Benchmarking

Use BenchmarkDotNet to compare the performance between Common Image Actions, ImageSharp, and ImageFlowDotNet. The benchmark files can be found in the /Benchmark directory if you wish to run the same test.

Single Image

When converting a single image we can see the AllocatedBytes is half of ImageSharp, and the performance is faster than ImageFlow.

Multiple Images

When converting multiple images we can see where CommonImageActions really shines. What takes 547ms in CommonImageActions takes 4,400ms in ImageSharp and 11,430ms in ImageFlow. We can also see that the allocated memory is significantly less than ImageSharp.