// After editing this file, run "go generate" in the parent directory. // Copyright 2017 The Wuffs Authors. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // https://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. #ifdef __cplusplus extern "C" { #endif // ---------------- Images // wuffs_base__color_u32argb is an 8 bit per channel Alpha, Red, Green, Blue // color, as a uint32_t value. It is in word order, not byte order: its value // is always 0xAARRGGBB, regardless of endianness. It uses premultiplied alpha. typedef uint32_t wuffs_base__color_u32argb; // -------- // wuffs_base__pixel_format encodes the format of the bytes that constitute an // image frame's pixel data. Its bits: // - bit 31 is reserved. // - bits 30 .. 28 encodes color (and channel order, in terms of memory). // - bits 27 .. 26 are reserved. // - bits 25 .. 24 encodes transparency. // - bit 23 indicates big-endian/MSB-first (as opposed to little/LSB). // - bit 22 indicates floating point (as opposed to integer). // - bits 21 .. 20 are the number of planes, minus 1. Zero means packed. // - bits 19 .. 16 encodes the number of bits (depth) in an index value. // Zero means direct, not palette-indexed. // - bits 15 .. 12 encodes the number of bits (depth) in the 3rd channel. // - bits 11 .. 8 encodes the number of bits (depth) in the 2nd channel. // - bits 7 .. 4 encodes the number of bits (depth) in the 1st channel. // - bits 3 .. 0 encodes the number of bits (depth) in the 0th channel. // // The bit fields of a wuffs_base__pixel_format are not independent. For // example, the number of planes should not be greater than the number of // channels. Similarly, bits 15..4 are unused (and should be zero) if bits // 31..24 (color and transparency) together imply only 1 channel (gray, no // alpha) and floating point samples should mean a bit depth of 16, 32 or 64. // // Formats hold between 1 and 4 channels. For example: Y (1 channel: gray), YA // (2 channels: gray and alpha), BGR (3 channels: blue, green, red) or CMYK (4 // channels: cyan, magenta, yellow, black). // // For direct formats with N > 1 channels, those channels can be laid out in // either 1 (packed) or N (planar) planes. For example, RGBA data is usually // packed, but YUV data is usually planar, due to chroma subsampling (for // details, see the wuffs_base__pixel_subsampling type). For indexed formats, // the palette (always 256 × 4 bytes) holds up to 4 packed bytes of color data // per index value, and there is only 1 plane (for the index). The distance // between successive palette elements is always 4 bytes. // // The color field is encoded in 3 bits: // - 0 means A (Alpha). // - 1 means Y or YA (Gray, Alpha). // - 2 means BGR, BGRX or BGRA (Blue, Green, Red, X-padding or Alpha). // - 3 means RGB, RGBX or RGBA (Red, Green, Blue, X-padding or Alpha). // - 4 means YUV or YUVA (Luma, Chroma-blue, Chroma-red, Alpha). // - 5 means CMY or CMYK (Cyan, Magenta, Yellow, Black). // - all other values are reserved. // // In Wuffs, channels are given in memory order (also known as byte order), // regardless of endianness, since the C type for the pixel data is an array of // bytes, not an array of uint32_t. For example, packed BGRA with 8 bits per // channel means that the bytes in memory are always Blue, Green, Red then // Alpha. On big-endian systems, that is the uint32_t 0xBBGGRRAA. On // little-endian, 0xAARRGGBB. // // When the color field (3 bits) encodes multiple options, the transparency // field (2 bits) distinguishes them: // - 0 means fully opaque, no extra channels // - 1 means fully opaque, one extra channel (X or K, padding or black). // - 2 means one extra alpha channel, other channels are non-premultiplied. // - 3 means one extra alpha channel, other channels are premultiplied. // // The zero wuffs_base__pixel_format value is an invalid pixel format, as it is // invalid to combine the zero color (alpha only) with the zero transparency. // // Bit depth is encoded in 4 bits: // - 0 means the channel or index is unused. // - x means a bit depth of x, for x in the range 1..8. // - 9 means a bit depth of 10. // - 10 means a bit depth of 12. // - 11 means a bit depth of 16. // - 12 means a bit depth of 24. // - 13 means a bit depth of 32. // - 14 means a bit depth of 48. // - 15 means a bit depth of 64. // // For example, wuffs_base__pixel_format 0x3280BBBB is a natural format for // decoding a PNG image - network byte order (also known as big-endian), // packed, non-premultiplied alpha - that happens to be 16-bit-depth truecolor // with alpha (RGBA). In memory order: // // ptr+0 ptr+1 ptr+2 ptr+3 ptr+4 ptr+5 ptr+6 ptr+7 // Rhi Rlo Ghi Glo Bhi Blo Ahi Alo // // For example, the value wuffs_base__pixel_format 0x20000565 means BGR with no // alpha or padding, 5/6/5 bits for blue/green/red, packed 2 bytes per pixel, // laid out LSB-first in memory order: // // ptr+0........... ptr+1........... // MSB LSB MSB LSB // G₂G₁G₀B₄B₃B₂B₁B₀ R₄R₃R₂R₁R₀G₅G₄G₃ // // On little-endian systems (but not big-endian), this Wuffs pixel format value // (0x20000565) corresponds to the Cairo library's CAIRO_FORMAT_RGB16_565, the // SDL2 (Simple DirectMedia Layer 2) library's SDL_PIXELFORMAT_RGB565 and the // Skia library's kRGB_565_SkColorType. Note BGR in Wuffs versus RGB in the // other libraries. // // Regardless of endianness, this Wuffs pixel format value (0x20000565) // corresponds to the V4L2 (Video For Linux 2) library's V4L2_PIX_FMT_RGB565 // and the Wayland-DRM library's WL_DRM_FORMAT_RGB565. // // Different software libraries name their pixel formats (and especially their // channel order) either according to memory layout or as bits of a native // integer type like uint32_t. The two conventions differ because of a system's // endianness. As mentioned earlier, Wuffs pixel formats are always in memory // order. More detail of other software libraries' naming conventions is in the // Pixel Format Guide at https://afrantzis.github.io/pixel-format-guide/ // // Do not manipulate these bits directly; they are private implementation // details. Use methods such as wuffs_base__pixel_format__num_planes instead. typedef uint32_t wuffs_base__pixel_format; // Common 8-bit-depth pixel formats. This list is not exhaustive; not all valid // wuffs_base__pixel_format values are present. #define WUFFS_BASE__PIXEL_FORMAT__INVALID ((wuffs_base__pixel_format)0x00000000) #define WUFFS_BASE__PIXEL_FORMAT__A ((wuffs_base__pixel_format)0x02000008) #define WUFFS_BASE__PIXEL_FORMAT__Y ((wuffs_base__pixel_format)0x10000008) #define WUFFS_BASE__PIXEL_FORMAT__YA_NONPREMUL \ ((wuffs_base__pixel_format)0x12000008) #define WUFFS_BASE__PIXEL_FORMAT__YA_PREMUL \ ((wuffs_base__pixel_format)0x13000008) #define WUFFS_BASE__PIXEL_FORMAT__BGR ((wuffs_base__pixel_format)0x20000888) #define WUFFS_BASE__PIXEL_FORMAT__BGRX ((wuffs_base__pixel_format)0x21008888) #define WUFFS_BASE__PIXEL_FORMAT__BGRX_INDEXED \ ((wuffs_base__pixel_format)0x21088888) #define WUFFS_BASE__PIXEL_FORMAT__BGRA_NONPREMUL \ ((wuffs_base__pixel_format)0x22008888) #define WUFFS_BASE__PIXEL_FORMAT__BGRA_NONPREMUL_INDEXED \ ((wuffs_base__pixel_format)0x22088888) #define WUFFS_BASE__PIXEL_FORMAT__BGRA_PREMUL \ ((wuffs_base__pixel_format)0x23008888) #define WUFFS_BASE__PIXEL_FORMAT__RGB ((wuffs_base__pixel_format)0x30000888) #define WUFFS_BASE__PIXEL_FORMAT__RGBX ((wuffs_base__pixel_format)0x31008888) #define WUFFS_BASE__PIXEL_FORMAT__RGBX_INDEXED \ ((wuffs_base__pixel_format)0x31088888) #define WUFFS_BASE__PIXEL_FORMAT__RGBA_NONPREMUL \ ((wuffs_base__pixel_format)0x32008888) #define WUFFS_BASE__PIXEL_FORMAT__RGBA_NONPREMUL_INDEXED \ ((wuffs_base__pixel_format)0x32088888) #define WUFFS_BASE__PIXEL_FORMAT__RGBA_PREMUL \ ((wuffs_base__pixel_format)0x33008888) #define WUFFS_BASE__PIXEL_FORMAT__YUV ((wuffs_base__pixel_format)0x40200888) #define WUFFS_BASE__PIXEL_FORMAT__YUVK ((wuffs_base__pixel_format)0x41308888) #define WUFFS_BASE__PIXEL_FORMAT__YUVA_NONPREMUL \ ((wuffs_base__pixel_format)0x42308888) #define WUFFS_BASE__PIXEL_FORMAT__CMY ((wuffs_base__pixel_format)0x50200888) #define WUFFS_BASE__PIXEL_FORMAT__CMYK ((wuffs_base__pixel_format)0x51308888) static inline bool // wuffs_base__pixel_format__is_valid(wuffs_base__pixel_format f) { return f != 0; } static inline bool // wuffs_base__pixel_format__is_indexed(wuffs_base__pixel_format f) { return ((f >> 16) & 0x0F) != 0; } #define WUFFS_BASE__PIXEL_FORMAT__NUM_PLANES_MAX 4 static inline uint32_t // wuffs_base__pixel_format__num_planes(wuffs_base__pixel_format f) { return f ? (((f >> 20) & 0x03) + 1) : 0; } // -------- // wuffs_base__pixel_subsampling encodes the mapping of pixel space coordinates // (x, y) to pixel buffer indices (i, j). That mapping can differ for each // plane p. For a depth of 8 bits (1 byte), the p'th plane's sample starts at // (planes[p].ptr + (j * planes[p].stride) + i). // // For packed pixel formats, the mapping is trivial: i = x and j = y. For // planar pixel formats, the mapping can differ due to chroma subsampling. For // example, consider a three plane YUV pixel format with 4:2:2 subsampling. For // the luma (Y) channel, there is one sample for every pixel, but for the // chroma (U, V) channels, there is one sample for every two pixels: pairs of // horizontally adjacent pixels form one macropixel, i = x / 2 and j == y. In // general, for a given p: // - i = (x + bias_x) >> shift_x. // - j = (y + bias_y) >> shift_y. // where biases and shifts are in the range 0..3 and 0..2 respectively. // // In general, the biases will be zero after decoding an image. However, making // a sub-image may change the bias, since the (x, y) coordinates are relative // to the sub-image's top-left origin, but the backing pixel buffers were // created relative to the original image's origin. // // For each plane p, each of those four numbers (biases and shifts) are encoded // in two bits, which combine to form an 8 bit unsigned integer: // // e_p = (bias_x << 6) | (shift_x << 4) | (bias_y << 2) | (shift_y << 0) // // Those e_p values (e_0 for the first plane, e_1 for the second plane, etc) // combine to form a wuffs_base__pixel_subsampling value: // // pixsub = (e_3 << 24) | (e_2 << 16) | (e_1 << 8) | (e_0 << 0) // // Do not manipulate these bits directly; they are private implementation // details. Use methods such as wuffs_base__pixel_subsampling__bias_x instead. typedef uint32_t wuffs_base__pixel_subsampling; #define WUFFS_BASE__PIXEL_SUBSAMPLING__NONE ((wuffs_base__pixel_subsampling)0) #define WUFFS_BASE__PIXEL_SUBSAMPLING__444 \ ((wuffs_base__pixel_subsampling)0x000000) #define WUFFS_BASE__PIXEL_SUBSAMPLING__440 \ ((wuffs_base__pixel_subsampling)0x010100) #define WUFFS_BASE__PIXEL_SUBSAMPLING__422 \ ((wuffs_base__pixel_subsampling)0x101000) #define WUFFS_BASE__PIXEL_SUBSAMPLING__420 \ ((wuffs_base__pixel_subsampling)0x111100) #define WUFFS_BASE__PIXEL_SUBSAMPLING__411 \ ((wuffs_base__pixel_subsampling)0x202000) #define WUFFS_BASE__PIXEL_SUBSAMPLING__410 \ ((wuffs_base__pixel_subsampling)0x212100) static inline uint32_t // wuffs_base__pixel_subsampling__bias_x(wuffs_base__pixel_subsampling s, uint32_t plane) { uint32_t shift = ((plane & 0x03) * 8) + 6; return (s >> shift) & 0x03; } static inline uint32_t // wuffs_base__pixel_subsampling__shift_x(wuffs_base__pixel_subsampling s, uint32_t plane) { uint32_t shift = ((plane & 0x03) * 8) + 4; return (s >> shift) & 0x03; } static inline uint32_t // wuffs_base__pixel_subsampling__bias_y(wuffs_base__pixel_subsampling s, uint32_t plane) { uint32_t shift = ((plane & 0x03) * 8) + 2; return (s >> shift) & 0x03; } static inline uint32_t // wuffs_base__pixel_subsampling__shift_y(wuffs_base__pixel_subsampling s, uint32_t plane) { uint32_t shift = ((plane & 0x03) * 8) + 0; return (s >> shift) & 0x03; } // -------- typedef struct { // Do not access the private_impl's fields directly. There is no API/ABI // compatibility or safety guarantee if you do so. struct { wuffs_base__pixel_format pixfmt; wuffs_base__pixel_subsampling pixsub; uint32_t width; uint32_t height; } private_impl; #ifdef __cplusplus inline void initialize(wuffs_base__pixel_format pixfmt, wuffs_base__pixel_subsampling pixsub, uint32_t width, uint32_t height); inline void invalidate(); inline bool is_valid(); inline wuffs_base__pixel_format pixel_format(); inline wuffs_base__pixel_subsampling pixel_subsampling(); inline wuffs_base__rect_ie_u32 bounds(); inline uint32_t width(); inline uint32_t height(); inline size_t pixbuf_size(); #endif // __cplusplus } wuffs_base__pixel_config; // TODO: Should this function return bool? An error type? static inline void // wuffs_base__pixel_config__initialize(wuffs_base__pixel_config* c, wuffs_base__pixel_format pixfmt, wuffs_base__pixel_subsampling pixsub, uint32_t width, uint32_t height) { if (!c) { return; } if (pixfmt) { uint64_t wh = ((uint64_t)width) * ((uint64_t)height); // TODO: handle things other than 1 byte per pixel. if (wh <= ((uint64_t)SIZE_MAX)) { c->private_impl.pixfmt = pixfmt; c->private_impl.pixsub = pixsub; c->private_impl.width = width; c->private_impl.height = height; return; } } *c = ((wuffs_base__pixel_config){}); } static inline void // wuffs_base__pixel_config__invalidate(wuffs_base__pixel_config* c) { if (c) { *c = ((wuffs_base__pixel_config){}); } } static inline bool // wuffs_base__pixel_config__is_valid(wuffs_base__pixel_config* c) { return c && c->private_impl.pixfmt; } static inline wuffs_base__pixel_format // wuffs_base__pixel_config__pixel_format(wuffs_base__pixel_config* c) { return c ? c->private_impl.pixfmt : 0; } static inline wuffs_base__pixel_subsampling // wuffs_base__pixel_config__pixel_subsampling(wuffs_base__pixel_config* c) { return c ? c->private_impl.pixsub : 0; } static inline wuffs_base__rect_ie_u32 // wuffs_base__pixel_config__bounds(wuffs_base__pixel_config* c) { return c ? ((wuffs_base__rect_ie_u32){ .min_incl_x = 0, .min_incl_y = 0, .max_excl_x = c->private_impl.width, .max_excl_y = c->private_impl.height, }) : ((wuffs_base__rect_ie_u32){}); } static inline uint32_t // wuffs_base__pixel_config__width(wuffs_base__pixel_config* c) { return c ? c->private_impl.width : 0; } static inline uint32_t // wuffs_base__pixel_config__height(wuffs_base__pixel_config* c) { return c ? c->private_impl.height : 0; } // TODO: this is the right API for planar (not packed) pixbufs? Should it allow // decoding into a color model different from the format's intrinsic one? For // example, decoding a JPEG image straight to RGBA instead of to YCbCr? static inline size_t // wuffs_base__pixel_config__pixbuf_size(wuffs_base__pixel_config* c) { if (c) { uint64_t wh = ((uint64_t)c->private_impl.width) * ((uint64_t)c->private_impl.height); // TODO: handle things other than 1 byte per pixel. return (size_t)wh; } return 0; } #ifdef __cplusplus inline void // wuffs_base__pixel_config::initialize(wuffs_base__pixel_format pixfmt, wuffs_base__pixel_subsampling pixsub, uint32_t width, uint32_t height) { wuffs_base__pixel_config__initialize(this, pixfmt, pixsub, width, height); } inline void // wuffs_base__pixel_config::invalidate() { wuffs_base__pixel_config__invalidate(this); } inline bool // wuffs_base__pixel_config::is_valid() { return wuffs_base__pixel_config__is_valid(this); } inline wuffs_base__pixel_format // wuffs_base__pixel_config::pixel_format() { return wuffs_base__pixel_config__pixel_format(this); } inline wuffs_base__pixel_subsampling // wuffs_base__pixel_config::pixel_subsampling() { return wuffs_base__pixel_config__pixel_subsampling(this); } inline wuffs_base__rect_ie_u32 // wuffs_base__pixel_config::bounds() { return wuffs_base__pixel_config__bounds(this); } inline uint32_t // wuffs_base__pixel_config::width() { return wuffs_base__pixel_config__width(this); } inline uint32_t // wuffs_base__pixel_config::height() { return wuffs_base__pixel_config__height(this); } inline size_t // wuffs_base__pixel_config::pixbuf_size() { return wuffs_base__pixel_config__pixbuf_size(this); } #endif // __cplusplus // -------- typedef struct { // Do not access the private_impl's fields directly. There is no API/ABI // compatibility or safety guarantee if you do so. struct { wuffs_base__pixel_config pixcfg; uint32_t num_loops; bool first_frame_is_opaque; } private_impl; #ifdef __cplusplus inline void initialize(wuffs_base__pixel_format pixfmt, wuffs_base__pixel_subsampling pixsub, uint32_t width, uint32_t height, uint32_t num_loops, bool first_frame_is_opaque); inline void invalidate(); inline bool is_valid(); inline wuffs_base__pixel_config* pixel_config(); inline wuffs_base__pixel_format pixel_format(); inline wuffs_base__pixel_subsampling pixel_subsampling(); inline wuffs_base__rect_ie_u32 bounds(); inline uint32_t width(); inline uint32_t height(); inline uint32_t num_loops(); inline uint32_t first_frame_is_opaque(); #endif // __cplusplus } wuffs_base__image_config; // TODO: Should this function return bool? An error type? static inline void // wuffs_base__image_config__initialize(wuffs_base__image_config* c, wuffs_base__pixel_format pixfmt, wuffs_base__pixel_subsampling pixsub, uint32_t width, uint32_t height, uint32_t num_loops, bool first_frame_is_opaque) { if (!c) { return; } if (wuffs_base__pixel_format__is_valid(pixfmt)) { c->private_impl.pixcfg.private_impl.pixfmt = pixfmt; c->private_impl.pixcfg.private_impl.pixsub = pixsub; c->private_impl.pixcfg.private_impl.width = width; c->private_impl.pixcfg.private_impl.height = height; c->private_impl.num_loops = num_loops; c->private_impl.first_frame_is_opaque = first_frame_is_opaque; return; } *c = ((wuffs_base__image_config){}); } static inline void // wuffs_base__image_config__invalidate(wuffs_base__image_config* c) { if (c) { *c = ((wuffs_base__image_config){}); } } static inline bool // wuffs_base__image_config__is_valid(wuffs_base__image_config* c) { return c && wuffs_base__pixel_config__is_valid(&(c->private_impl.pixcfg)); } static inline wuffs_base__pixel_config* // wuffs_base__image_config__pixel_config(wuffs_base__image_config* c) { return c ? &c->private_impl.pixcfg : NULL; } static inline wuffs_base__pixel_format // wuffs_base__image_config__pixel_format(wuffs_base__image_config* c) { return c ? c->private_impl.pixcfg.private_impl.pixfmt : 0; } static inline wuffs_base__pixel_subsampling // wuffs_base__image_config__pixel_subsampling(wuffs_base__image_config* c) { return c ? c->private_impl.pixcfg.private_impl.pixsub : 0; } static inline wuffs_base__rect_ie_u32 // wuffs_base__image_config__bounds(wuffs_base__image_config* c) { return c ? ((wuffs_base__rect_ie_u32){ .min_incl_x = 0, .min_incl_y = 0, .max_excl_x = c->private_impl.pixcfg.private_impl.width, .max_excl_y = c->private_impl.pixcfg.private_impl.height, }) : ((wuffs_base__rect_ie_u32){}); } static inline uint32_t // wuffs_base__image_config__width(wuffs_base__image_config* c) { return c ? c->private_impl.pixcfg.private_impl.width : 0; } static inline uint32_t // wuffs_base__image_config__height(wuffs_base__image_config* c) { return c ? c->private_impl.pixcfg.private_impl.height : 0; } static inline uint32_t // wuffs_base__image_config__num_loops(wuffs_base__image_config* c) { return c ? c->private_impl.num_loops : 0; } static inline uint32_t // wuffs_base__image_config__first_frame_is_opaque(wuffs_base__image_config* c) { return c ? c->private_impl.first_frame_is_opaque : false; } #ifdef __cplusplus inline void // wuffs_base__image_config::initialize(wuffs_base__pixel_format pixfmt, wuffs_base__pixel_subsampling pixsub, uint32_t width, uint32_t height, uint32_t num_loops, bool first_frame_is_opaque) { wuffs_base__image_config__initialize(this, pixfmt, pixsub, width, height, num_loops, first_frame_is_opaque); } inline void // wuffs_base__image_config::invalidate() { wuffs_base__image_config__invalidate(this); } inline bool // wuffs_base__image_config::is_valid() { return wuffs_base__image_config__is_valid(this); } inline wuffs_base__pixel_config* // wuffs_base__image_config::pixel_config() { return wuffs_base__image_config__pixel_config(this); } inline wuffs_base__pixel_format // wuffs_base__image_config::pixel_format() { return wuffs_base__image_config__pixel_format(this); } inline wuffs_base__pixel_subsampling // wuffs_base__image_config::pixel_subsampling() { return wuffs_base__image_config__pixel_subsampling(this); } inline wuffs_base__rect_ie_u32 // wuffs_base__image_config::bounds() { return wuffs_base__image_config__bounds(this); } inline uint32_t // wuffs_base__image_config::width() { return wuffs_base__image_config__width(this); } inline uint32_t // wuffs_base__image_config::height() { return wuffs_base__image_config__height(this); } inline uint32_t // wuffs_base__image_config::num_loops() { return wuffs_base__image_config__num_loops(this); } inline uint32_t // wuffs_base__image_config::first_frame_is_opaque() { return wuffs_base__image_config__first_frame_is_opaque(this); } #endif // __cplusplus // -------- // wuffs_base__animation_disposal encodes, for an animated image, how to // dispose of a frame after displaying it: // - None means to draw the next frame on top of this one. // - Restore Background means to clear the frame's dirty rectangle to "the // background color" (in practice, this means transparent black) before // drawing the next frame. // - Restore Previous means to undo the current frame, so that the next frame // is drawn on top of the previous one. typedef uint8_t wuffs_base__animation_disposal; #define WUFFS_BASE__ANIMATION_DISPOSAL__NONE ((wuffs_base__animation_disposal)0) #define WUFFS_BASE__ANIMATION_DISPOSAL__RESTORE_BACKGROUND \ ((wuffs_base__animation_disposal)1) #define WUFFS_BASE__ANIMATION_DISPOSAL__RESTORE_PREVIOUS \ ((wuffs_base__animation_disposal)2) // -------- typedef struct { // Do not access the private_impl's fields directly. There is no API/ABI // compatibility or safety guarantee if you do so. struct { wuffs_base__rect_ie_u32 bounds; wuffs_base__flicks duration; bool blend; wuffs_base__animation_disposal disposal; bool palette_changed; } private_impl; #ifdef __cplusplus inline void update(wuffs_base__rect_ie_u32 bounds, wuffs_base__flicks duration, bool blend, wuffs_base__animation_disposal disposal, bool palette_changed); inline wuffs_base__rect_ie_u32 bounds(); inline uint32_t width(); inline uint32_t height(); inline wuffs_base__flicks duration(); inline bool blend(); inline wuffs_base__animation_disposal disposal(); inline bool palette_changed(); #endif // __cplusplus } wuffs_base__frame_config; static inline void // wuffs_base__frame_config__update(wuffs_base__frame_config* c, wuffs_base__rect_ie_u32 bounds, wuffs_base__flicks duration, bool blend, wuffs_base__animation_disposal disposal, bool palette_changed) { if (!c) { return; } c->private_impl.bounds = bounds; c->private_impl.duration = duration; c->private_impl.blend = blend; c->private_impl.disposal = disposal; c->private_impl.palette_changed = palette_changed; } static inline wuffs_base__rect_ie_u32 // wuffs_base__frame_config__bounds(wuffs_base__frame_config* c) { return c ? c->private_impl.bounds : ((wuffs_base__rect_ie_u32){}); } static inline uint32_t // wuffs_base__frame_config__width(wuffs_base__frame_config* c) { return c ? wuffs_base__rect_ie_u32__width(&c->private_impl.bounds) : 0; } static inline uint32_t // wuffs_base__frame_config__height(wuffs_base__frame_config* c) { return c ? wuffs_base__rect_ie_u32__height(&c->private_impl.bounds) : 0; } // wuffs_base__frame_config__duration returns the amount of time to display // this frame. Zero means to display forever - a still (non-animated) image. static inline wuffs_base__flicks // wuffs_base__frame_config__duration(wuffs_base__frame_config* c) { return c ? c->private_impl.duration : 0; } // wuffs_base__frame_config__blend returns, for a transparent image, whether to // blend this frame with the existing canvas. // // In Porter-Duff compositing operator terminology, false means "src" and true // means "src over dst". static inline bool // wuffs_base__frame_config__blend(wuffs_base__frame_config* c) { return c && c->private_impl.blend; } // wuffs_base__frame_config__disposal returns, for an animated image, how to // dispose of this frame after displaying it. static inline wuffs_base__animation_disposal // wuffs_base__frame_config__disposal(wuffs_base__frame_config* c) { return c ? c->private_impl.disposal : 0; } // wuffs_base__frame_config__palette_changed returns whether this frame's // palette differs from the previous frame. It is conservative and may return // false positives (but never false negatives). static inline bool // wuffs_base__frame_config__palette_changed(wuffs_base__frame_config* c) { return c && c->private_impl.palette_changed; } #ifdef __cplusplus inline void // wuffs_base__frame_config::update(wuffs_base__rect_ie_u32 bounds, wuffs_base__flicks duration, bool blend, wuffs_base__animation_disposal disposal, bool palette_changed) { wuffs_base__frame_config__update(this, bounds, duration, blend, disposal, palette_changed); } inline wuffs_base__rect_ie_u32 // wuffs_base__frame_config::bounds() { return wuffs_base__frame_config__bounds(this); } inline uint32_t // wuffs_base__frame_config::width() { return wuffs_base__frame_config__width(this); } inline uint32_t // wuffs_base__frame_config::height() { return wuffs_base__frame_config__height(this); } inline wuffs_base__flicks // wuffs_base__frame_config::duration() { return wuffs_base__frame_config__duration(this); } inline bool // wuffs_base__frame_config::blend() { return wuffs_base__frame_config__blend(this); } inline wuffs_base__animation_disposal // wuffs_base__frame_config::disposal() { return wuffs_base__frame_config__disposal(this); } inline bool // wuffs_base__frame_config::palette_changed() { return wuffs_base__frame_config__palette_changed(this); } #endif // __cplusplus // -------- typedef struct { // Do not access the private_impl's fields directly. There is no API/ABI // compatibility or safety guarantee if you do so. struct { wuffs_base__pixel_config pixcfg; wuffs_base__table_u8 planes[WUFFS_BASE__PIXEL_FORMAT__NUM_PLANES_MAX]; uint8_t palette[1024]; // TODO: color spaces. } private_impl; #ifdef __cplusplus inline wuffs_base__status set_from_slice(wuffs_base__pixel_config* pixcfg, wuffs_base__slice_u8 pixbuf_memory); inline void set_palette(wuffs_base__slice_u8 palette); inline wuffs_base__pixel_config* pixel_config(); inline wuffs_base__rect_ie_u32 bounds(); inline uint32_t width(); inline uint32_t height(); inline wuffs_base__table_u8 plane(uint32_t p); inline wuffs_base__slice_u8 palette(); #endif // __cplusplus } wuffs_base__pixel_buffer; static inline wuffs_base__status // wuffs_base__pixel_buffer__set_from_slice(wuffs_base__pixel_buffer* b, wuffs_base__pixel_config* pixcfg, wuffs_base__slice_u8 pixbuf_memory) { if (!b) { return wuffs_base__error__bad_receiver; } *b = ((wuffs_base__pixel_buffer){}); if (!pixcfg) { return wuffs_base__error__bad_argument; } // TODO: don't assume 1 byte per pixel. Don't assume packed. uint64_t wh = ((uint64_t)pixcfg->private_impl.width) * ((uint64_t)pixcfg->private_impl.height); if (wh > pixbuf_memory.len) { return wuffs_base__error__bad_argument_length_too_short; } b->private_impl.pixcfg = *pixcfg; wuffs_base__table_u8* tab = &b->private_impl.planes[0]; tab->ptr = pixbuf_memory.ptr; tab->width = pixcfg->private_impl.width; tab->height = pixcfg->private_impl.height; tab->stride = pixcfg->private_impl.width; return NULL; } // The palette argument is ignored unless its length is exactly 1024. static inline void // wuffs_base__pixel_buffer__set_palette(wuffs_base__pixel_buffer* b, wuffs_base__slice_u8 palette) { if (b && palette.ptr && (palette.len == 1024)) { memmove(b->private_impl.palette, palette.ptr, 1024); } } // wuffs_base__pixel_config returns the overall configuration for this frame. static inline wuffs_base__pixel_config* // wuffs_base__pixel_buffer__pixel_config(wuffs_base__pixel_buffer* b) { return b ? &b->private_impl.pixcfg : NULL; } static inline wuffs_base__rect_ie_u32 // wuffs_base__pixel_buffer__bounds(wuffs_base__pixel_buffer* b) { return b ? wuffs_base__pixel_config__bounds(&b->private_impl.pixcfg) : ((wuffs_base__rect_ie_u32){}); } static inline uint32_t // wuffs_base__pixel_buffer__width(wuffs_base__pixel_buffer* b) { return b ? wuffs_base__pixel_config__width(&b->private_impl.pixcfg) : 0; } static inline uint32_t // wuffs_base__pixel_buffer__height(wuffs_base__pixel_buffer* b) { return b ? wuffs_base__pixel_config__height(&b->private_impl.pixcfg) : 0; } static inline wuffs_base__table_u8 // wuffs_base__pixel_buffer__plane(wuffs_base__pixel_buffer* b, uint32_t p) { return (b && (p < WUFFS_BASE__PIXEL_FORMAT__NUM_PLANES_MAX)) ? b->private_impl.planes[p] : ((wuffs_base__table_u8){}); } // wuffs_base__pixel_buffer__palette returns the palette that the pixel data // can index. The backing array is inside b and has length 1024. static inline wuffs_base__slice_u8 // wuffs_base__pixel_buffer__palette(wuffs_base__pixel_buffer* b) { return b ? ((wuffs_base__slice_u8){.ptr = b->private_impl.palette, .len = 1024}) : ((wuffs_base__slice_u8){}); } #ifdef __cplusplus inline wuffs_base__status // wuffs_base__pixel_buffer::set_from_slice(wuffs_base__pixel_config* pixcfg, wuffs_base__slice_u8 pixbuf_memory) { return wuffs_base__pixel_buffer__set_from_slice(this, pixcfg, pixbuf_memory); } inline void // wuffs_base__pixel_buffer::set_palette(wuffs_base__slice_u8 palette) { wuffs_base__pixel_buffer__set_palette(this, palette); } inline wuffs_base__pixel_config* // wuffs_base__pixel_buffer::pixel_config() { return wuffs_base__pixel_buffer__pixel_config(this); } inline wuffs_base__rect_ie_u32 // wuffs_base__pixel_buffer::bounds() { return wuffs_base__pixel_buffer__bounds(this); } inline uint32_t // wuffs_base__pixel_buffer::width() { return wuffs_base__pixel_buffer__width(this); } inline uint32_t // wuffs_base__pixel_buffer::height() { return wuffs_base__pixel_buffer__height(this); } inline wuffs_base__table_u8 // wuffs_base__pixel_buffer::plane(uint32_t p) { return wuffs_base__pixel_buffer__plane(this, p); } inline wuffs_base__slice_u8 // wuffs_base__pixel_buffer::palette() { return wuffs_base__pixel_buffer__palette(this); } #endif // __cplusplus #ifdef __cplusplus } // extern "C" #endif