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
✅ 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(). 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)

Parameter	Possible Values	Description
width, w	Integer	Set the width of the image
height, h	Integer	Set the height of the image
mode, m	Max, Fit, Zoom, Stretch	Max: If both width and height are present then the image will be resized to the max of whatever parameter, and the width will scale accordingly. Fit: When both width and height are present fit the image into the container without adjusting the ratio. Zoom: When both width and height are present zoom the image in to fill the space. Stretch (default): When both width and height are present stretch the image to fit the container.
shape, s	Circle, Ellipse, RoundedRectangle	Mask out the image to be of a certain shape.
corner, cr	Integer	The corner radius when shape is RoundedRectangle. Default is 10.
text, t	String	The text to display on the image
initials, in	Boolean	When true will only display initials of text. For example DustinG is displayed as DG.
color, c	String (ffccff or blue)	Set a color for the image
textColor, tc	String (ffccff or blue)	Set the color of the text
colorFromText, ft	Boolean	When true a color will be generated based on a hash of the text. The list of colors can be updated in `ImageProcessor.BackgroundColours`.
format, f	Bmp, Gif, Ico, Jpeg, Png, Wbmp, Webp, Pkm, Ktx, Astc, Dng, Heif, Avif	What format to export the resulting image as. Default is png.
password, pw	String	(pdf only) password to open pdf
page, p	Integer	(pdf only) what page to render. First page is 1.

Modes Visualized