Skip to content

Lightpanda: the headless browser designed for AI and automation

webapi: add an ImageData overload

Karl Seguin89449fdc8625
diff --git a/src/browser/tests/image_data.html b/src/browser/tests/image_data.html
index 94f3af1c2..327be0edb 100644
--- a/src/browser/tests/image_data.html
+++ b/src/browser/tests/image_data.html
@@ -86,3 +86,39 @@
<script id=too-large>
testing.expectError("IndexSizeError", () => new ImageData(2_147_483_648, 2_147_483_648));
</script>
+
+<script id=constructor-with-data>
+ {
+ const arr = new Uint8ClampedArray(3 * 2 * 4);
+ const img = new ImageData(arr, 3, 2);
+ testing.expectEqual(3, img.width);
+ testing.expectEqual(2, img.height);
+ // wraps the caller's array, not a copy
+ testing.expectEqual(true, img.data === arr);
+ img.data[0] = 7;
+ testing.expectEqual(7, arr[0]);
+
+ // height is derived when omitted
+ const derived = new ImageData(arr, 3);
+ testing.expectEqual(2, derived.height);
+ testing.expectEqual(2, new ImageData(arr, 3, undefined, { colorSpace: "srgb" }).height);
+
+ testing.expectEqual(2, ImageData.length);
+ }
+</script>
+
+<script id=constructor-with-data-errors>
+ {
+ const arr = new Uint8ClampedArray(3 * 2 * 4);
+ const expectError = (name, fn) => testing.withError((err) => testing.expectEqual(name, err.name), fn);
+
+ expectError('IndexSizeError', () => new ImageData(arr, 3, 3));
+ expectError('IndexSizeError', () => new ImageData(arr, 4));
+ expectError('IndexSizeError', () => new ImageData(arr, 0));
+ expectError('InvalidStateError', () => new ImageData(new Uint8ClampedArray(0), 1));
+ expectError('InvalidStateError', () => new ImageData(new Uint8ClampedArray(5), 1));
+ expectError('TypeError', () => new ImageData(new Uint8Array(4), 1));
+ expectError('TypeError', () => new ImageData(arr, 3, 2, { colorSpace: "nope" }));
+ expectError('TypeError', () => new ImageData(10));
+ }
+</script>
diff --git a/src/browser/webapi/ImageData.zig b/src/browser/webapi/ImageData.zig
index f6a3f134d..8101b5632 100644
--- a/src/browser/webapi/ImageData.zig
+++ b/src/browser/webapi/ImageData.zig
@@ -42,38 +42,10 @@ pub const ConstructorSettings = struct {
pixelFormat: String = .wrap("rgba-unorm8"),
};
-/// This has many constructors:
-///
-/// ```js
-/// new ImageData(width, height)
-/// new ImageData(width, height, settings)
-///
-/// new ImageData(dataArray, width)
-/// new ImageData(dataArray, width, height)
-/// new ImageData(dataArray, width, height, settings)
-/// ```
-///
-/// We currently support only the first 2.
-pub fn init(
- width: u32,
- height: u32,
- maybe_settings: ?ConstructorSettings,
- exec: *Execution,
-) !*ImageData {
- // Though arguments are unsigned long, these are capped to max. i32 on Chrome.
- // https://github.com/chromium/chromium/blob/main/third_party/blink/renderer/core/html/canvas/image_data.cc#L61
- const max_i32 = std.math.maxInt(i32);
- if (width == 0 or width > max_i32 or height == 0 or height > max_i32) {
- return error.IndexSizeError;
- }
-
- const settings: ConstructorSettings = maybe_settings orelse .{};
- if (settings.colorSpace.eql(comptime .wrap("srgb")) == false) {
- return error.TypeError;
- }
- if (settings.pixelFormat.eql(comptime .wrap("rgba-unorm8")) == false) {
- return error.TypeError;
- }
+pub fn init( width: u32, height: u32, maybe_settings: ?ConstructorSettings, exec: *Execution) !*ImageData {
+ try validateDimension(width);
+ try validateDimension(height);
+ try validateSettings(maybe_settings);
var size, var overflown = @mulWithOverflow(width, height);
if (overflown == 1) {
@@ -92,6 +64,61 @@ pub fn init(
});
}
+// The ImageData wraps the caller's array, not a copy: `imageData.data`
+// is the same object that was passed in.
+fn initWithData(
+ data: js.Value,
+ width: u32,
+ height_: ?js.Value,
+ settings: ?ConstructorSettings,
+ exec: *Execution,
+) !*ImageData {
+ try validateSettings(settings);
+
+ const array = js.ArrayBufferRef(.uint8_clamped){ .local = data.local, .handle = data.handle };
+ const length = array.slice().len;
+ if (length == 0 or length % 4 != 0) {
+ return error.InvalidStateError;
+ }
+ try validateDimension(width);
+
+ const pixels = length / 4;
+ if (pixels % width != 0) {
+ return error.IndexSizeError;
+ }
+ const height = pixels / width;
+ if (height_) |v| {
+ if (!v.isUndefined() and try v.toU32() != height) {
+ return error.IndexSizeError;
+ }
+ }
+ try validateDimension(height);
+
+ return exec._factory.create(ImageData{
+ ._width = width,
+ ._height = @intCast(height),
+ ._data = try array.persist(),
+ });
+}
+
+fn validateSettings(settings_: ?ConstructorSettings) !void {
+ const settings = settings_ orelse return;
+ if (settings.colorSpace.eql(comptime .wrap("srgb")) == false) {
+ return error.TypeError;
+ }
+ if (settings.pixelFormat.eql(comptime .wrap("rgba-unorm8")) == false) {
+ return error.TypeError;
+ }
+}
+
+fn validateDimension(value: usize) !void {
+ // Though arguments are unsigned long, these are capped to max. i32 on Chrome.
+ // https://github.com/chromium/chromium/blob/main/third_party/blink/renderer/core/html/canvas/image_data.cc#L61
+ if (value == 0 or value > std.math.maxInt(i32)) {
+ return error.IndexSizeError;
+ }
+}
+
pub fn deinit(self: *ImageData, page: *Page) void {
self._data.release();
page.factory.destroy(self);
@@ -146,7 +173,36 @@ pub const JsApi = struct {
pub var class_id: bridge.ClassId = undefined;
};
- pub const constructor = bridge.constructor(ImageData.init, .{});
+ /// This has many constructors:
+ ///
+ /// ```js
+ /// new ImageData(width, height)
+ /// new ImageData(width, height, settings)
+ ///
+ /// new ImageData(dataArray, width)
+ /// new ImageData(dataArray, width, height)
+ /// new ImageData(dataArray, width, height, settings)
+ /// ```
+ ///
+ /// We currently support only the first 2.
+ pub const constructor = bridge.constructor(struct {
+ fn wrap(first: js.Value,second: u32,third: ?js.Value,fourth: ?ConstructorSettings,exec: *Execution) !*ImageData {
+ if (first.isUint8ClampedArray()) {
+ return initWithData(first, second, third, fourth, exec);
+ }
+ if (first.isTypedArray()) {
+ // Float16Array data needs the "rgba-float16" pixel format, which
+ // we don't support.
+ return error.TypeError;
+ }
+
+ const settings: ?ConstructorSettings = if (third) |v| blk: {
+ if (v.isNullOrUndefined()) break :blk null;
+ break :blk try v.toZig(ConstructorSettings);
+ } else null;
+ return init(try first.toU32(), second, settings, exec);
+ }
+ }.wrap, .{});
pub const colorSpace = bridge.property("srgb", .{ .template = false, .readonly = true });
pub const pixelFormat = bridge.property("rgba-unorm8", .{ .template = false, .readonly = true });