Skip to content

Commit

Permalink
[WiP] Add ReadOnlySpan<byte> / ReadOnlyMemory<T> overloads
Browse files Browse the repository at this point in the history
Implements:
- `Source.NewFromMemory`, `Image.FindLoadBuffer` and
  `Image.NewFromBuffer` for `ReadOnlySpan<byte>`.
- `Image.NewFromMemory` for `ReadOnlyMemory<T>`.
  • Loading branch information
kleisauke committed Jan 11, 2024
1 parent 19316bc commit c7ff09c
Show file tree
Hide file tree
Showing 5 changed files with 202 additions and 1 deletion.
20 changes: 20 additions & 0 deletions src/NetVips/Internal/Vips.cs
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,10 @@ internal static class VipsBlob
[SuppressUnmanagedCodeSecurity]
[DllImport(Libraries.Vips, CallingConvention = CallingConvention.Cdecl, EntryPoint = "vips_blob_get")]
internal static extern IntPtr Get(VipsBlobManaged blob, out UIntPtr length);

[SuppressUnmanagedCodeSecurity]
[DllImport(Libraries.Vips, CallingConvention = CallingConvention.Cdecl, EntryPoint = "vips_blob_copy")]
internal static extern unsafe VipsBlobManaged Copy(void* data, UIntPtr length);
}

internal static class VipsArea
Expand Down Expand Up @@ -422,6 +426,12 @@ internal static class VipsImage
internal static extern IntPtr NewFromMemory(IntPtr data, UIntPtr size, int width, int height,
int bands, BandFormat format);

[SuppressUnmanagedCodeSecurity]
[DllImport(Libraries.Vips, CallingConvention = CallingConvention.Cdecl,
EntryPoint = "vips_image_new_from_memory")]
internal static extern unsafe IntPtr NewFromMemory(void* data, UIntPtr size, int width, int height,
int bands, BandFormat format);

[SuppressUnmanagedCodeSecurity]
[DllImport(Libraries.Vips, CallingConvention = CallingConvention.Cdecl,
EntryPoint = "vips_image_new_from_memory_copy")]
Expand Down Expand Up @@ -582,6 +592,11 @@ internal static class VipsForeign
EntryPoint = "vips_foreign_find_load_buffer")]
internal static extern IntPtr FindLoadBuffer(IntPtr data, ulong size);

[SuppressUnmanagedCodeSecurity]
[DllImport(Libraries.Vips, CallingConvention = CallingConvention.Cdecl,
EntryPoint = "vips_foreign_find_load_buffer")]
internal static extern unsafe IntPtr FindLoadBuffer(void* data, ulong size);

[SuppressUnmanagedCodeSecurity]
[DllImport(Libraries.Vips, CallingConvention = CallingConvention.Cdecl,
EntryPoint = "vips_foreign_find_load_source")]
Expand Down Expand Up @@ -637,6 +652,11 @@ internal static class VipsSource
EntryPoint = "vips_source_new_from_file")]
internal static extern IntPtr NewFromFile(byte[] filename);

[SuppressUnmanagedCodeSecurity]
[DllImport(Libraries.Vips, CallingConvention = CallingConvention.Cdecl,
EntryPoint = "vips_source_new_from_blob")]
internal static extern IntPtr NewFromBlob(VipsBlobManaged blob);

[SuppressUnmanagedCodeSecurity]
[DllImport(Libraries.Vips, CallingConvention = CallingConvention.Cdecl,
EntryPoint = "vips_source_new_from_memory")]
Expand Down
1 change: 1 addition & 0 deletions src/NetVips/NetVips.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
<StartupObject />
<Platforms>x64;x86;ARM64;ARM32</Platforms>
<Optimize>true</Optimize>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<AppendRuntimeIdentifierToOutputPath>false</AppendRuntimeIdentifierToOutputPath>
<IsTrimmable Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net6.0'))">true</IsTrimmable>
<IsAotCompatible Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net8.0'))">true</IsAotCompatible>
Expand Down
2 changes: 1 addition & 1 deletion src/NetVips/Source.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace NetVips
/// <summary>
/// An input connection.
/// </summary>
public class Source : Connection
public partial class Source : Connection
{
// private static Logger logger = LogManager.GetCurrentClassLogger();

Expand Down
137 changes: 137 additions & 0 deletions src/NetVips/net6.0/Image.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
#if NET6_0_OR_GREATER

namespace NetVips
{
using System;
using System.Runtime.InteropServices;
using Internal;

/// <summary>
/// Wrap a <see cref="VipsImage"/> object.
/// </summary>
public partial class Image
{
#region helpers

/// <summary>
/// Find the name of the load operation vips will use to load a buffer.
/// </summary>
/// <remarks>
/// For example "VipsForeignLoadJpegBuffer". You can use this to work out what
/// options to pass to <see cref="NewFromBuffer(ReadOnlySpan{byte}, string, Enums.Access?, Enums.FailOn?, VOption)"/>.
/// </remarks>
/// <param name="data">The buffer to test.</param>
/// <param name="size">Length of the buffer.</param>
/// <returns>The name of the load operation, or <see langword="null"/>.</returns>
internal static unsafe string FindLoadBuffer(void* data, ulong size) =>
Marshal.PtrToStringAnsi(VipsForeign.FindLoadBuffer(data, size));

/// <summary>
/// Find the name of the load operation vips will use to load a buffer.
/// </summary>
/// <remarks>
/// For example "VipsForeignLoadJpegBuffer". You can use this to work out what
/// options to pass to <see cref="NewFromBuffer(ReadOnlySpan{byte}, string, Enums.Access?, Enums.FailOn?, VOption)"/>.
/// </remarks>
/// <param name="data">The buffer to test.</param>
/// <returns>The name of the load operation, or <see langword="null"/>.</returns>
public static unsafe string FindLoadBuffer(ReadOnlySpan<byte> data)
{
fixed (byte* dataFixed = data)
{
return FindLoadBuffer(dataFixed, (ulong)data.Length);
}
}

#endregion

#region constructors

/// <summary>
/// Load a formatted image from memory.
/// </summary>
/// <remarks>
/// This behaves exactly as <see cref="NewFromFile"/>, but the image is
/// loaded from the memory object rather than from a file. The memory
/// object can be a string or buffer.
/// </remarks>
/// <param name="data">The memory object to load the image from.</param>
/// <param name="strOptions">Load options as a string. Use <see cref="string.Empty"/> for no options.</param>
/// <param name="access">Hint the expected access pattern for the image.</param>
/// <param name="failOn">The type of error that will cause load to fail. By
/// default, loaders are permissive, that is, <see cref="Enums.FailOn.None"/>.</param>
/// <param name="kwargs">Optional options that depend on the load operation.</param>
/// <returns>A new <see cref="Image"/>.</returns>
/// <exception cref="VipsException">If unable to load from <paramref name="data"/>.</exception>
public static unsafe Image NewFromBuffer(
ReadOnlySpan<byte> data,
string strOptions = "",
Enums.Access? access = null,
Enums.FailOn? failOn = null,
VOption kwargs = null)
{
fixed (byte* dataFixed = data)
{
var operationName = FindLoadBuffer(dataFixed, (ulong)data.Length);
if (operationName == null)
{
throw new VipsException("unable to load from buffer");
}

var options = new VOption();
if (kwargs != null)
{
options.Merge(kwargs);
}

options.AddIfPresent(nameof(access), access);
options.AddFailOn(failOn);

options.Add("string_options", strOptions);

using var blob = Internal.VipsBlob.Copy(dataFixed, (UIntPtr)data.Length);
return Operation.Call(operationName, options, blob) as Image;
}
}

/// <summary>
/// Wrap an image around a memory array.
/// </summary>
/// <param name="data">A <see cref="ReadOnlyMemory{T}"/>.</param>
/// <param name="width">Image width in pixels.</param>
/// <param name="height">Image height in pixels.</param>
/// <param name="bands">Number of bands.</param>
/// <param name="format">Band format.</param>
/// <returns>A new <see cref="Image"/>.</returns>
/// <exception cref="VipsException">If unable to make image from <paramref name="data"/>.</exception>
public static unsafe Image NewFromMemory<T>(
ReadOnlyMemory<T> data,
int width,
int height,
int bands,
Enums.BandFormat format) where T : unmanaged
{
var handle = data.Pin();
var vi = VipsImage.NewFromMemory(handle.Pointer, (UIntPtr)data.Length, width, height, bands,
format);

if (vi == IntPtr.Zero)
{
handle.Dispose();

throw new VipsException("unable to make image from memory");
}

var image = new Image(vi) { MemoryPressure = data.Length };

// Need to release the pinned MemoryHandle when the image is closed.
image.OnPostClose += () => handle.Dispose();

return image;
}

#endregion
}
}

#endif
43 changes: 43 additions & 0 deletions src/NetVips/net6.0/Source.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
#if NET6_0_OR_GREATER

namespace NetVips
{
using System;

/// <summary>
/// An input connection.
/// </summary>
public partial class Source
{
/// <summary>
/// Make a new source from a memory object.
/// </summary>
/// <remarks>
/// Make a new source that is attached to the memory object. For example:
/// <code language="lang-csharp">
/// using var source = Source.NewFromMemory(data);
/// </code>
/// You can pass this source to (for example) <see cref="Image.NewFromSource"/>.
/// </remarks>
/// <param name="data">The memory object.</param>
/// <returns>A new <see cref="Source"/>.</returns>
/// <exception cref="VipsException">If unable to create a new <see cref="Source"/> from <paramref name="data"/>.</exception>
public static unsafe Source NewFromMemory(ReadOnlySpan<byte> data)
{
fixed (byte* dataFixed = data)
{
using var blob = Internal.VipsBlob.Copy(dataFixed, (UIntPtr)data.Length);
var pointer = Internal.VipsSource.NewFromBlob(blob);

if (pointer == IntPtr.Zero)
{
throw new VipsException("can't create input source from memory");
}

return new Source(pointer);
}
}
}
}

#endif

0 comments on commit c7ff09c

Please sign in to comment.