X-Ray.Psd

X-Ray.Psd reads Photoshop documents (PSD and PSB), renders them to PNG or JPEG, and extracts their text. The core package has no dependencies outside the .NET base class library, and its hot paths use System.Numerics.Vector<T> SIMD. It is a port of the PSD engine in Patchy, a C++ image editor, whose renders are checked against Photoshop's own.

curiosity-ai/x-ray-others X-Ray.Psd on NuGet

Packages

dotnet add package X-Ray.Psd
dotnet add package X-Ray.Psd.Skia   # optional
dotnet add package X-Ray.Psd.Text   # optional

What it reads

• PSD and PSB, 1/8/16/32 bits per channel, in RGB, grayscale, bitmap, indexed, CMYK, Lab, duotone and multichannel modes.
• Raw, RLE, ZIP and ZIP-with-prediction channel data.
• The layer tree with groups, blend modes, opacity, fill, clipping, raster masks and vector masks; layer effects; adjustment layers; solid, gradient and pattern fills.
• Text: layer and group names, type-layer content with fonts and style runs, channel and path names, slices, XMP and IPTC metadata, and text inside embedded PSD/PSB smart objects.
• Typed views of common image resources: resolution, guides and grid, thumbnail, slices, layer comps, version info, ICC profile.

Pixel data stays compressed until rendering asks for it, so text extraction and inspection do not decode pixels.

Quick start

using XRay.Psd;
using XRay.Psd.Rendering;

var document = PsdDocument.Load("poster.psd");

// Render and save. RenderSource.Auto (the default) uses the merged image Photoshop
// saved when there is one, and the layer compositor otherwise.
document.Render().SavePng("poster.png");
document.Render(new RenderOptions { Background = PsdColor.White }).SaveJpeg("poster.jpg", quality: 85);

// All text, in Layers panel order.
foreach (var item in document.ExtractText().Items)
{
    Console.WriteLine($"{item.Kind}: {item.Source}: {item.Text}");
}

// Walk the layer tree.
foreach (var layer in document.EnumerateLayersTopDown())
{
    Console.WriteLine($"{layer.Path} {layer.Kind} {layer.BlendMode} {layer.Bounds}");
    if (layer.Text is { } text)
    {
        Console.WriteLine($"  \"{text.Text}\" in {string.Join(", ", text.Fonts)}");
    }
}

Hide layers while rendering, for example every type layer:

using XRay.Psd;
using XRay.Psd.Rendering;

var document = PsdDocument.Load("poster.psd");
var withoutText = document.Render(new RenderOptions
{
    LayerVisibility = layer => layer.IsVisible && layer.Kind != PsdLayerKind.Text,
});

Re-rendering type layers

X-Ray.Psd.Text draws type layers from their text model, for files that store no pixels for them or when the text should be drawn with other fonts:

using XRay.Psd;
using XRay.Psd.Rendering;
using XRay.Psd.Text;

var document = PsdDocument.Load("poster.psd");

var fonts = new FontCollection();
fonts.AddFile("fonts/LiberationSans-Regular.ttf");

using var rasterizer = new TextLayerRasterizer(new TextRenderSettings
{
    FontResolver = new CompositeFontResolver(fonts, SystemFontResolver.Default),
});

document.Render(new RenderOptions { TextRasterizer = rasterizer }).SavePng("filled-in.png");

Rendering coverage

The layer compositor follows Photoshop's blending rules for groups, clipping, knockout, masks, fills, layer effects, vector strokes and adjustments. A document saved with "Maximize Compatibility" renders exactly through the merged image Photoshop stored. The rendering page lists what is rendered, how it was checked and what is not.

Beyond rendering

Streams, cancellation and large files covers CancellationToken overloads, rendering straight into a stream, band rendering for documents that do not fit in one canvas, memory-mapped loading and asynchronous loading.

License

MIT.